Skip to content

docs: add dedicated MCP section - #19

Merged
yohamta0 merged 1 commit into
mainfrom
docs/mcp-section
May 22, 2026
Merged

docs: add dedicated MCP section#19
yohamta0 merged 1 commit into
mainfrom
docs/mcp-section

Conversation

@yohamta0

@yohamta0 yohamta0 commented May 22, 2026

Copy link
Copy Markdown
Contributor

Summary

  • split MCP documentation into a dedicated top-level section with overview, quickstart, clients, architecture, authentication, tools, resources, and auditability pages
  • keep the old Getting Started MCP page as a short on-ramp to the new section
  • update VitePress navigation and related API key / AI tool cross-links

Testing

  • pnpm build

Summary by CodeRabbit

Documentation

  • Reorganized MCP documentation into a dedicated section with comprehensive architecture and auditability guides
  • Added complete guides for configuring MCP clients, including step-by-step authentication setup
  • Expanded documentation covering MCP tools, resources, prompts, and their integration with Dagu
  • Enhanced API key documentation with new surface scoping and attribution class options for improved access control

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 22, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cc417289-94ad-46c7-96be-a19038aed6d6

📥 Commits

Reviewing files that changed from the base of the PR and between 2fab459 and f14b08d.

📒 Files selected for processing (17)
  • .vitepress/config.js
  • [page].md
  • getting-started/ai-agent.md
  • getting-started/cli.md
  • getting-started/installation/index.md
  • getting-started/mcp.md
  • getting-started/quickstart.md
  • mcp/architecture.md
  • mcp/auditability.md
  • mcp/authentication.md
  • mcp/clients.md
  • mcp/index.md
  • mcp/quickstart.md
  • mcp/resources.md
  • mcp/tools.md
  • overview/cli.md
  • server-admin/authentication/api-keys.md

📝 Walkthrough

Walkthrough

This PR reorganizes MCP documentation into a dedicated /mcp/ section with comprehensive guides covering authentication, client setup, tools, resources, and auditability, updates site-wide navigation and internal links, and extends API key documentation to support MCP-specific surface scoping and key attribution.

Changes

MCP Documentation Reorganization

Layer / File(s) Summary
Navigation structure and route mapping
.vitepress/config.js, getting-started/mcp.md
VitePress config adds "MCP" top-level nav item and nested /mcp/ sidebar group with submenu links; getting-started/mcp.md becomes a redirect pointer to the new section.
Internal link migration across documentation
[page].md, getting-started/ai-agent.md, getting-started/cli.md, getting-started/installation/index.md, getting-started/quickstart.md, overview/cli.md
All internal references to MCP documentation are updated from /getting-started/mcp to /mcp/, including homepage cards, integration sections, and quickstart flows.
MCP foundational documentation
mcp/index.md, mcp/architecture.md, mcp/authentication.md
New overview page explains MCP endpoints and exposed surfaces; architecture page documents routing, auth stack, and tool/resource boundaries; authentication guide covers auth modes, API key surface scoping, and role/workspace alignment.
MCP implementation guides
mcp/quickstart.md, mcp/clients.md
Quickstart covers Dagu startup, environment variables, and initial tool usage; clients guide documents end-to-end setup for Codex and Claude Code with configuration snippets and verification steps.
MCP technical reference documentation
mcp/tools.md, mcp/resources.md
Tools page defines dagu_read, dagu_change, and dagu_execute with JSON examples; resources page documents URI patterns, content types, subscriptions, and built-in MCP prompts.
MCP auditability and operations documentation
mcp/auditability.md
Documents MCP audit event schema (category, source, surface, correlation_id fields), tool call lifecycle events (received/started/succeeded/failed/denied), and recommended filter fields for tracing MCP actions to downstream DAG events.
API key documentation for MCP surface scoping and attribution
server-admin/authentication/api-keys.md
Extends API key management with accepted surfaces (scoping to REST API vs MCP), attribution classes (user_owned vs service_account), expanded API example with new fields, and updated best practices for MCP key scoping.

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding a dedicated MCP documentation section with new pages and reorganized navigation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/mcp-section

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@cloudflare-workers-and-pages

Copy link
Copy Markdown
Contributor

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
dagu-sh-docs f14b08d May 22 2026, 10:32 AM

@yohamta0
yohamta0 merged commit f14b08d into main May 22, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant