docs: mcp tools page refactor - #3134
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
There was a problem hiding this comment.
Claude Code Review
Claude Code Review is paused for this repository. To reconnect it, an admin of this repository's GitHub organization (or the account owner, for personal repositories) who can also manage your Claude organization's Code Review settings needs to re-link GitHub in Code Review settings. This is a one-time step.
Tip: disable this comment in your organization's Code Review settings.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
WalkthroughThe MCP documentation now uses a Tools page as the primary reference. Navigation and internal links point to it, while the former Operations path redirects to Tools. ChangesMCP Tools documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs-website/router/mcp.mdx`:
- Line 179: Update the “Built-in tools” description in the MCP documentation to
describe get_operation_info as returning direct HTTP execution and integration
instructions, matching its definition in the get_operation_info documentation,
and remove the inaccurate “for tool discovery” wording.
In `@docs-website/router/mcp/tools.mdx`:
- Line 66: Update the introductory sentence before the project directory example
to use the direct reference-documentation wording “Use this directory
structure:”.
- Around line 257-280: Update the JSON example so the employee search text is
represented as the top-level tool description, separate from the input schema.
Wrap the existing schema under an inputSchema field and place the description
alongside it, or remove the root description from this schema-only example;
preserve the criteria properties and validation definitions unchanged.
- Line 57: Update the MCP mutation-tools documentation to describe the
non-read-only and non-idempotent annotations the server sets, replacing the
claim that it emits a warning. Do not document a warning field.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 7a5e355b-39fd-4541-a950-6046628b5193
📒 Files selected for processing (6)
docs-website/docs.jsondocs-website/router/mcp.mdxdocs-website/router/mcp/configuration.mdxdocs-website/router/mcp/operations.mdxdocs-website/router/mcp/quickstart.mdxdocs-website/router/mcp/tools.mdx
💤 Files with no reviewable changes (1)
- docs-website/router/mcp/operations.mdx
Summary
Summary by CodeRabbit