Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.
agent: Sanitize MCP tool names for stricter provider naming rules (#60154)
Bennet Bo Fenner03125da54441
diff --git a/crates/agent/src/tests/mod.rs b/crates/agent/src/tests/mod.rsindex 11f542ee8e6..55e492c3b3f 100644--- a/crates/agent/src/tests/mod.rs+++ b/crates/agent/src/tests/mod.rs@@ -1633,6 +1633,97 @@ async fn test_mcp_tools(cx: &mut TestAppContext) {events.collect::<Vec<_>>().await;}+#[gpui::test]+async fn test_mcp_tool_names_are_sanitized_for_providers(cx: &mut TestAppContext) {+ let ThreadTest {+ model,+ thread,+ context_server_store,+ fs,+ ..+ } = setup(cx, TestModel::Fake).await;+ let fake_model = model.as_fake();++ fs.insert_file(+ paths::settings_file(),+ json!({+ "agent": {+ "tool_permissions": { "default": "allow" },+ "profiles": {+ "test": {+ "name": "Test Profile",+ "enable_all_context_servers": true,+ },+ }+ }+ })+ .to_string()+ .into_bytes(),+ )+ .await;+ cx.run_until_parked();+ thread.update(cx, |thread, cx| {+ thread.set_profile(AgentProfileId("test".into()), cx)+ });++ let mut mcp_tool_calls = setup_context_server(+ "Superluminal",+ vec![context_server::types::Tool {+ name: "snake_case.PascalCase".into(),+ title: None,+ description: None,+ input_schema: json!({"type": "object", "properties": {}}),+ output_schema: None,+ annotations: None,+ }],+ &context_server_store,+ cx,+ );++ let events = thread.update(cx, |thread, cx| {+ thread+ .send(ClientUserMessageId::new(), ["Use the MCP tool"], cx)+ .unwrap()+ });+ cx.run_until_parked();++ let completion = fake_model.pending_completions().pop().unwrap();+ assert_eq!(+ tool_names_for_completion(&completion),+ vec!["snake_case_PascalCase"]+ );+ fake_model.send_last_completion_stream_event(LanguageModelCompletionEvent::ToolUse(+ LanguageModelToolUse {+ id: "tool_1".into(),+ name: "snake_case_PascalCase".into(),+ raw_input: json!({}).to_string(),+ input: json!({}),+ is_input_complete: true,+ thought_signature: None,+ },+ ));+ fake_model.end_last_completion_stream();+ cx.run_until_parked();++ let (tool_call_params, tool_call_response) = mcp_tool_calls.next().await.unwrap();+ assert_eq!(tool_call_params.name, "snake_case.PascalCase");+ tool_call_response+ .send(context_server::types::CallToolResponse {+ content: vec![context_server::types::ToolResponseContent::Text {+ text: "done".into(),+ }],+ is_error: None,+ meta: None,+ structured_content: None,+ })+ .unwrap();+ cx.run_until_parked();++ fake_model.send_last_completion_stream_text_chunk("Done!");+ fake_model.end_last_completion_stream();+ events.collect::<Vec<_>>().await;+}+#[gpui::test]async fn test_mcp_tool_multi_content_response(cx: &mut TestAppContext) {let ThreadTest {diff --git a/crates/agent/src/thread.rs b/crates/agent/src/thread.rsindex 980ed067a38..6bc2715dd7e 100644--- a/crates/agent/src/thread.rs+++ b/crates/agent/src/thread.rs@@ -72,6 +72,27 @@ const TOOL_CANCELED_MESSAGE: &str = "Tool canceled by user";pub const MAX_TOOL_NAME_LENGTH: usize = 64;pub const MAX_SUBAGENT_DEPTH: u8 = 1;+pub(crate) fn provider_compatible_tool_name(tool_name: &str) -> String {+ let mut sanitized = String::new();+ for character in tool_name.chars() {+ if sanitized.len() >= MAX_TOOL_NAME_LENGTH {+ break;+ }++ if character.is_ascii_alphanumeric() || character == '_' || character == '-' {+ sanitized.push(character);+ } else {+ sanitized.push('_');+ }+ }++ if sanitized.is_empty() {+ sanitized.push_str("tool");+ }++ sanitized+}+#[derive(Clone, Debug, Eq, PartialEq)]pub struct SandboxStatusKey {pub settings_sandbox: ThreadSandbox,@@ -3986,16 +4007,6 @@ impl Thread {let Some(profile) = AgentSettings::get_global(cx).profiles.get(&self.profile_id) else {return BTreeMap::new();};- fn truncate(tool_name: &SharedString) -> SharedString {- if tool_name.len() > MAX_TOOL_NAME_LENGTH {- let mut truncated = tool_name.to_string();- truncated.truncate(MAX_TOOL_NAME_LENGTH);- truncated.into()- } else {- tool_name.clone()- }- }-// Terminal variants are configured by users under the canonical// `terminal` name. Expose the one matching the current sandbox state// to the model under that name.@@ -4030,7 +4041,10 @@ impl Thread {Some((SharedString::from(TerminalTool::NAME), tool.clone()))}(TerminalTool::NAME | SandboxedTerminalTool::NAME, _) => None,- _ => Some((truncate(tool_name), tool.clone())),+ _ => Some((+ provider_compatible_tool_name(tool_name.as_ref()).into(),+ tool.clone(),+ )),}} else {None@@ -4045,7 +4059,8 @@ impl Thread {for (server_id, server_tools) in self.context_server_registry.read(cx).servers() {for (tool_name, tool) in server_tools {if profile.is_context_server_tool_enabled(&server_id.0, &tool_name) {- let tool_name = truncate(tool_name);+ let tool_name: SharedString =+ provider_compatible_tool_name(tool_name.as_ref()).into();if !seen_tools.insert(tool_name.clone()) {duplicate_tool_names.insert(tool_name.clone());}@@ -4062,7 +4077,8 @@ impl Thread {if duplicate_tool_names.contains(&tool_name) {let available = MAX_TOOL_NAME_LENGTH.saturating_sub(tool_name.len());if available >= 2 {- let mut disambiguated = server_id.0.to_snake_case();+ let mut disambiguated =+ provider_compatible_tool_name(&server_id.0.to_snake_case()).to_string();disambiguated.truncate(available - 1);disambiguated.push('_');disambiguated.push_str(&tool_name);