docs(mcp): standardize mcp tool fqn documentation#21664
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request refines the documentation related to Model-Context Protocol (MCP) tools, ensuring that all references and examples accurately reflect the current implementation. The core change clarifies that MCP tools are consistently assigned a Fully Qualified Name (FQN) upon discovery, rather than only in cases of naming conflicts. This update aims to provide clearer and more accurate guidance for users configuring and interacting with MCP tools and policies. Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request updates documentation to standardize the naming convention for MCP tools to a fully qualified name (FQN). The changes are generally correct and improve clarity. However, the updated documentation contains two issues that could lead to significant user confusion and incorrect behavior, particularly with security policies. One is a critical omission regarding how server names with underscores are parsed, which can cause policies to fail silently. The other is a minor inaccuracy in the description of character sanitization.
Note: Security Review has been skipped due to the limited scope of the PR.
|
Size Change: -4 B (0%) Total Size: 26 MB ℹ️ View Unchanged
|
9c25b60 to
f3468fc
Compare
f3468fc to
341aa45
Compare
Summary
Updates documentation across the repository to correctly reflect that MCP tools are unconditionally converted to Fully Qualified Names (FQNs) using the format
mcp_serverName_toolName.Details
Previously, the documentation stated that MCP tools received unprefixed names and were only prefixed (
serverName__toolName) upon conflicts. The actual tool discovery mechanism now unconditionally applies the strictmcp_serverName_toolNameFQN. This PR updates all examples and explanations in the docs to match the actual implementation. It also updates TOML policy examples to use themcpNamefield instead of FQNs, which is the recommended approach.Related Issues
N/A
How to Validate
Review the markdown changes in:
docs/tools/mcp-server.mddocs/reference/configuration.mddocs/reference/policy-engine.mddocs/extensions/reference.mddocs/hooks/reference.mddocs/cli/tutorials/mcp-setup.mdPre-Merge Checklist