Skip to content

docs: mcp tools page refactor - #3134

Merged
asoorm merged 2 commits into
mainfrom
docs/mcp-tools-page-refactor
Aug 3, 2026
Merged

docs: mcp tools page refactor#3134
asoorm merged 2 commits into
mainfrom
docs/mcp-tools-page-refactor

Conversation

@asoorm

@asoorm asoorm commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Rename the MCP Operations page to Tools and reframe it around the outcome: defining tools for AI models, with GraphQL operations as the mechanism
  • Document the two kinds of tools: built-in (get_operation_info, get_schema, execute_graphql) and user-created
  • Restructure into top-level sections: Built-in Tools, Creating Tools, Tool Naming, Tool Descriptions, Tool Schema, Best Practices
  • Document variable descriptions (September 2025 GraphQL spec, router 0.316.0+) and schema field description propagation in Tool Schema, with engine-verified JSON schema examples
  • Add a redirect from /router/mcp/operations to /router/mcp/tools and update all inbound links

Summary by CodeRabbit

  • Documentation
    • Reorganized MCP documentation around a new Tools guide.
    • Added comprehensive guidance for built-in and GraphQL-defined tools, including validation, naming, schemas, descriptions, and mutation safety.
    • Updated quickstart, configuration, and navigation links to reference the Tools guide.
    • Added a redirect from the former Operations page to the new Tools page.
    • Clarified the distinction between built-in tools and tools defined through GraphQL operations.

@asoorm
asoorm requested review from a team as code owners August 3, 2026 09:43
@mintlify

mintlify Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
wundergraphinc 🟢 Ready View Preview Aug 3, 2026, 9:44 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: 3916d025-d423-4218-ab18-b1d9b31d6c4a

📥 Commits

Reviewing files that changed from the base of the PR and between d606127 and 3a13323.

📒 Files selected for processing (2)
  • docs-website/router/mcp.mdx
  • docs-website/router/mcp/tools.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs-website/router/mcp.mdx
  • docs-website/router/mcp/tools.mdx

Walkthrough

The 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.

Changes

MCP Tools documentation

Layer / File(s) Summary
Navigation and legacy redirect
docs-website/docs.json
The MCP navigation points to the Tools page. The former Operations path redirects to Tools.
MCP page link updates
docs-website/router/mcp.mdx, docs-website/router/mcp/configuration.mdx, docs-website/router/mcp/quickstart.mdx
MCP overview, configuration, and quickstart links now reference Tools and describe tool creation.
Tools reference content
docs-website/router/mcp/tools.mdx, docs-website/router/mcp/operations.mdx
A comprehensive Tools reference replaces the Operations page. It documents built-in tools, GraphQL-defined tools, naming, validation, schemas, descriptions, and design practices.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

🚥 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 identifies the documentation refactor for the MCP tools page, which matches the main changes.
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.

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between e6c2b07 and d606127.

📒 Files selected for processing (6)
  • docs-website/docs.json
  • docs-website/router/mcp.mdx
  • docs-website/router/mcp/configuration.mdx
  • docs-website/router/mcp/operations.mdx
  • docs-website/router/mcp/quickstart.mdx
  • docs-website/router/mcp/tools.mdx
💤 Files with no reviewable changes (1)
  • docs-website/router/mcp/operations.mdx

Comment thread docs-website/router/mcp.mdx Outdated
Comment thread docs-website/router/mcp/tools.mdx Outdated
Comment thread docs-website/router/mcp/tools.mdx Outdated
Comment thread docs-website/router/mcp/tools.mdx
@asoorm
asoorm merged commit bbf752b into main Aug 3, 2026
8 checks passed
@asoorm
asoorm deleted the docs/mcp-tools-page-refactor branch August 3, 2026 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants