Skip to content

docs(router): document omit_tool_name_prefix config for MCP tool names#238

Open
endigma wants to merge 9 commits intomainfrom
mike/docs-omit-operation-prefix
Open

docs(router): document omit_tool_name_prefix config for MCP tool names#238
endigma wants to merge 9 commits intomainfrom
mike/docs-omit-operation-prefix

Conversation

@endigma
Copy link
Member

@endigma endigma commented Jan 26, 2026

Supercedes #221


Summary

Documents the new omit_tool_name_prefix configuration option for MCP tool names.

Replaces #216 (directive-based approach was superseded by config-based approach)

Related implementation: wundergraph/cosmo#2441

Changes

  • Added omit_tool_name_prefix to config example with inline comment
  • Added new row to Configuration Options table (includes env var MCP_OMIT_TOOL_NAME_PREFIX)
  • Added "Omitting the Tool Name Prefix" subsection with examples and breaking change warning
  • Added Info note about automatic collision detection with built-in tools

Summary by CodeRabbit

  • New Features

    • Added MCP_OMIT_TOOL_NAME_PREFIX configuration option to simplify MCP tool names by omitting the execute_operation_ prefix when enabled (e.g., GetUser becomes get_user). Configurable via YAML configuration or environment variable, defaulting to false.
  • Documentation

    • Updated configuration documentation with comprehensive guidance, examples, warnings, and usage information for the new tool name prefix configuration option.

shamashel and others added 7 commits January 5, 2026 10:24
Add documentation for the new omit_operation_prefix configuration option
that allows cleaner MCP tool names without the execute_operation_ prefix.

Related: wundergraph/cosmo#2441
Updated the description of the 'strip_tool_name_prefix' option to clarify its effect on tool name length and its optional nature.
- Remove 'cleaner' language from subsection
- Add examples for default (disabled) behavior
- Replace arrow character with 'becomes'
Copy link
Contributor

@Noroth Noroth left a comment

Choose a reason for hiding this comment

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

I think this also has to be documented in docs/router/configuration.mdx

@coderabbitai
Copy link

coderabbitai bot commented Feb 17, 2026

Walkthrough

Two documentation files were updated to introduce a new MCP configuration option omit_tool_name_prefix that controls whether tool names omit the execute_operation_ prefix. The option defaults to false and can be set via the MCP_OMIT_TOOL_NAME_PREFIX environment variable. No code entities were altered.

Changes

Cohort / File(s) Summary
MCP Configuration Documentation
docs/router/configuration.mdx, docs/router/mcp.mdx
Added new omit_tool_name_prefix configuration option (environment variable: MCP_OMIT_TOOL_NAME_PREFIX) with default value false. Updated configuration table, added usage examples, and included informational notes about tool name prefix behavior and potential naming conflicts.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(router): document omit_tool_name_prefix config for MCP tool names' directly and clearly describes the main change: documentation of a new MCP configuration option.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
docs/router/mcp.mdx (1)

241-241: Minor: Consider rephrasing for grammatical completeness.

The sentence "Can also be set via MCP_OMIT_TOOL_NAME_PREFIX environment variable." lacks a subject. Consider rephrasing to: "This option can also be set via the MCP_OMIT_TOOL_NAME_PREFIX environment variable."

However, this style is common in table descriptions for brevity, so this is optional.

📝 Suggested fix
-| `omit_tool_name_prefix`      | When enabled, MCP tool names generated from GraphQL operations omit the `execute_operation_` prefix. For example, the GraphQL operation `GetUser` results in a tool named `get_user` instead of `execute_operation_get_user`. This produces shorter tool names and is entirely optional. Can also be set via `MCP_OMIT_TOOL_NAME_PREFIX` environment variable. | `false`          |
+| `omit_tool_name_prefix`      | When enabled, MCP tool names generated from GraphQL operations omit the `execute_operation_` prefix. For example, the GraphQL operation `GetUser` results in a tool named `get_user` instead of `execute_operation_get_user`. This produces shorter tool names and is entirely optional. This option can also be set via the `MCP_OMIT_TOOL_NAME_PREFIX` environment variable. | `false`          |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/router/mcp.mdx` at line 241, Rephrase the fragment describing
omit_tool_name_prefix so the sentence is grammatically complete; change "Can
also be set via `MCP_OMIT_TOOL_NAME_PREFIX` environment variable." to something
like "This option can also be set via the `MCP_OMIT_TOOL_NAME_PREFIX`
environment variable." Ensure references to the option name
`omit_tool_name_prefix` and the env var `MCP_OMIT_TOOL_NAME_PREFIX` remain
unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/router/mcp.mdx`:
- Line 241: Rephrase the fragment describing omit_tool_name_prefix so the
sentence is grammatically complete; change "Can also be set via
`MCP_OMIT_TOOL_NAME_PREFIX` environment variable." to something like "This
option can also be set via the `MCP_OMIT_TOOL_NAME_PREFIX` environment
variable." Ensure references to the option name `omit_tool_name_prefix` and the
env var `MCP_OMIT_TOOL_NAME_PREFIX` remain unchanged.

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.

3 participants

Comments