Jminnetian/sanitize tool names#1423
Open
jsourcebot wants to merge 3 commits into
Open
Conversation
Contributor
WalkthroughIntroduces sanitization of MCP tool names for model-facing use while preserving raw tool names for UI display. Adds ChangesMCP Tool Name Sanitization and Display
Estimated code review effort: 3 (Moderate) | ~25 minutes Sequence Diagram(s)sequenceDiagram
participant Agent as createAgentStream
participant McpToolSets as getMcpTools
participant UIStream as createUIMessageStream
participant ChatThread as chatThread.tsx
participant ToolComponent as McpToolComponent / ToolApprovalItem
Agent->>McpToolSets: getMcpTools(clients)
McpToolSets-->>Agent: tools, toolDisplayNames (model->raw)
loop for each discovered tool
Agent->>Agent: onMcpToolDiscovered(modelToolName, rawToolName)
Agent->>UIStream: write data-mcp-tool part
end
UIStream-->>ChatThread: stream data-mcp-tool part
ChatThread->>ChatThread: update mcpToolNameMap via onData
ChatThread->>ToolComponent: provide McpToolNameContext (mcpToolNameMap)
ToolComponent->>ToolComponent: getMcpToolDisplayParts(modelToolName, rawToolNames)
ToolComponent-->>ChatThread: render displayName (raw tool/server name)
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
packages/web/src/ee/features/chat/mcp/mcpToolSets.test.ts (1)
117-236: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick winAdd a test for punctuation-collision sanitization.
The new "keeps valid hyphenated tool names distinct from underscored names" test (Lines 220-235) only exercises a non-colliding case (
-is preserved). Consider adding a test with two raw tool names that both sanitize to the same string (e.g.foo.barandfoo_bar) to lock in the intended collision-handling behavior once it's implemented — see the related comment inmcpToolSets.ts.🤖 Prompt for 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. In `@packages/web/src/ee/features/chat/mcp/mcpToolSets.test.ts` around lines 117 - 236, Add a collision-focused test in sanitizeMcpToolNameForModel/getMcpTools coverage: the current hyphen-vs-underscore case only proves distinct valid names stay distinct. Create a test with two raw MCP tool names that sanitize to the same model-facing key (for example punctuation vs underscore), and assert the intended collision-handling behavior in getMcpTools, including the resulting tools map and any disambiguation strategy referenced by mcpToolSets.ts.
🤖 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 `@CHANGELOG.md`:
- Line 35: The new CHANGELOG.md entry under [Unreleased] is missing the required
pull request link. Update the entry so the single-sentence description is
followed by the matching
[#<id>](https://github.com/sourcebot-dev/sourcebot/pull/<id>) link, consistent
with the surrounding CHANGELOG entries and the project’s CHANGELOG formatting
rules.
In `@packages/web/src/ee/features/chat/mcp/mcpToolSets.ts`:
- Around line 118-127: Sanitized MCP tool names can collide, causing later
entries to overwrite earlier ones in both allTools and toolDisplayNames. Update
the MCP tool registration flow in mcpToolSets.ts where qualifiedName is passed
through sanitizeMcpToolNameForModel so collisions are detected and handled
instead of silently overwriting; if two raw names sanitize to the same key,
disambiguate the generated key (or otherwise preserve uniqueness) before storing
into allTools and toolDisplayNames. Make sure the fix is applied consistently in
the tool-building logic around the qualifiedName handling so each MCP tool keeps
its own execute function and display name.
---
Nitpick comments:
In `@packages/web/src/ee/features/chat/mcp/mcpToolSets.test.ts`:
- Around line 117-236: Add a collision-focused test in
sanitizeMcpToolNameForModel/getMcpTools coverage: the current
hyphen-vs-underscore case only proves distinct valid names stay distinct. Create
a test with two raw MCP tool names that sanitize to the same model-facing key
(for example punctuation vs underscore), and assert the intended
collision-handling behavior in getMcpTools, including the resulting tools map
and any disambiguation strategy referenced by mcpToolSets.ts.
🪄 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: f74ea55e-abc3-42fc-b22a-fb331728c6f4
📒 Files selected for processing (13)
CHANGELOG.mdpackages/web/src/ee/features/chat/agent.test.tspackages/web/src/ee/features/chat/agent.tspackages/web/src/ee/features/chat/components/chatThread/chatThread.tsxpackages/web/src/ee/features/chat/components/chatThread/detailsCard.tsxpackages/web/src/ee/features/chat/components/chatThread/toolApprovalBanner.tsxpackages/web/src/ee/features/chat/components/chatThread/tools/mcpToolComponent.test.tsxpackages/web/src/ee/features/chat/components/chatThread/tools/mcpToolComponent.tsxpackages/web/src/ee/features/chat/components/chatThread/tools/toolSearchToolComponent.tsxpackages/web/src/ee/features/chat/mcp/mcpToolSets.test.tspackages/web/src/ee/features/chat/mcp/mcpToolSets.tspackages/web/src/ee/features/chat/mcpServerIconContext.tsxpackages/web/src/features/chat/types.ts
| - Upgraded `nodemailer` to `^9.0.1`. [#1356](https://github.com/sourcebot-dev/sourcebot/pull/1356) | ||
| - Upgraded `@opentelemetry/core` to `^2.8.0`. [#1413](https://github.com/sourcebot-dev/sourcebot/pull/1413) | ||
| - [EE] Fixed connector setup dialogs to add scrolling when connector setup content goes out of view. | ||
| - [EE] Fixed Ask connector MCP tools with provider-invalid names failing to run by sanitizing model-facing tool names while preserving raw names in the UI. |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Missing PR link in CHANGELOG entry.
Unlike the surrounding entries, this new line has no trailing [#<id>](url) link. As per coding guidelines, "Update CHANGELOG.md with an entry under [Unreleased] linking to the new PR" and "CHANGELOG.md entries must follow the format: single sentence description followed by a link in the format [#<id>](https://github.com/sourcebot-dev/sourcebot/pull/<id>)."
📝 Proposed fix
-- [EE] Fixed Ask connector MCP tools with provider-invalid names failing to run by sanitizing model-facing tool names while preserving raw names in the UI.
+- [EE] Fixed Ask connector MCP tools with provider-invalid names failing to run by sanitizing model-facing tool names while preserving raw names in the UI. [`#1423`](https://github.com/sourcebot-dev/sourcebot/pull/1423)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - [EE] Fixed Ask connector MCP tools with provider-invalid names failing to run by sanitizing model-facing tool names while preserving raw names in the UI. | |
| - [EE] Fixed Ask connector MCP tools with provider-invalid names failing to run by sanitizing model-facing tool names while preserving raw names in the UI. [`#1423`](https://github.com/sourcebot-dev/sourcebot/pull/1423) |
🤖 Prompt for 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.
In `@CHANGELOG.md` at line 35, The new CHANGELOG.md entry under [Unreleased] is
missing the required pull request link. Update the entry so the single-sentence
description is followed by the matching
[#<id>](https://github.com/sourcebot-dev/sourcebot/pull/<id>) link, consistent
with the surrounding CHANGELOG entries and the project’s CHANGELOG formatting
rules.
Source: Coding guidelines
Comment on lines
+118
to
+127
| /** | ||
| * Provider APIs such as OpenAI Responses enforce tight charset and length | ||
| * limits for tool names. MCP tool names are server-controlled, so normalize the | ||
| * fully qualified name before exposing it to the model. | ||
| */ | ||
| export function sanitizeMcpToolNameForModel(name: string): string { | ||
| const sanitized = name.replace(/[^A-Za-z0-9_-]/g, '_') || '_'; | ||
| return sanitized.slice(0, MODEL_TOOL_NAME_MAX_LENGTH); | ||
| } | ||
|
|
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Sanitized tool names are not collision-free.
sanitizeMcpToolNameForModel replaces every disallowed character with _, so two distinct raw tool names can map to the same sanitized key — e.g. catalog.query and catalog_query both become catalog_query. Truncation to 64 chars can also collide names sharing a long common prefix. Since qualifiedName is used to key both allTools (Line 330) and toolDisplayNames (Line 277), a collision silently overwrites the earlier tool's execute function and permission wiring with the later one's — the earlier tool becomes unreachable and its display name is lost, with no error or log.
Given MCP tool names are server-controlled and can contain arbitrary punctuation, this isn't a purely theoretical edge case.
🛠️ Proposed fix: detect and disambiguate collisions at the call site
const originalExecute = tool.execute;
const rawQualifiedName = `${prefix}__${toolName}`;
- const qualifiedName = sanitizeMcpToolNameForModel(rawQualifiedName);
+ let qualifiedName = sanitizeMcpToolNameForModel(rawQualifiedName);
+ if (qualifiedName in allTools) {
+ let suffix = 1;
+ let candidate = qualifiedName;
+ do {
+ const suffixStr = `_${suffix++}`;
+ candidate = `${qualifiedName.slice(0, MODEL_TOOL_NAME_MAX_LENGTH - suffixStr.length)}${suffixStr}`;
+ } while (candidate in allTools);
+ qualifiedName = candidate;
+ }
const timeoutMs = env.SOURCEBOT_MCP_TOOL_CALL_TIMEOUT_MS;
toolDisplayNames[qualifiedName] = toolName;Also applies to: 274-277
🤖 Prompt for 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.
In `@packages/web/src/ee/features/chat/mcp/mcpToolSets.ts` around lines 118 - 127,
Sanitized MCP tool names can collide, causing later entries to overwrite earlier
ones in both allTools and toolDisplayNames. Update the MCP tool registration
flow in mcpToolSets.ts where qualifiedName is passed through
sanitizeMcpToolNameForModel so collisions are detected and handled instead of
silently overwriting; if two raw names sanitize to the same key, disambiguate
the generated key (or otherwise preserve uniqueness) before storing into
allTools and toolDisplayNames. Make sure the fix is applied consistently in the
tool-building logic around the qualifiedName handling so each MCP tool keeps its
own execute function and display name.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
MCP server tool names with certain characters (e.g " . ") would break the tool names open AI was expecting with their models. We now sanitize the names to avoid running into this issue.
Summary by CodeRabbit
New Features
Bug Fixes