Build and run agents you can see, understand and trust.
Python agentchatbotlarge-language-modelsllmllm-agentmcpmulti-agentmulti-modalreact-agentrealtime-agentvoice-agentvoice-assistant
refactor(mcp): rename the MCP tools when registered into the toolkit (#1552)
DavdGao5ca2e0220ffc
diff --git a/docs/tutorial/en/src/task_mcp.py b/docs/tutorial/en/src/task_mcp.pyindex 58e51e601..d44320032 100644--- a/docs/tutorial/en/src/task_mcp.py+++ b/docs/tutorial/en/src/task_mcp.py@@ -102,7 +102,7 @@ toolkit = Toolkit()async def example_register_stateless_mcp() -> None:"""Example of registering MCP tools from a stateless client."""# Register all tools from the MCP server- await toolkit.register_mcp_client(+ await toolkit.register_mcp(stateless_client,# group_name="map_services", # Optional group name)diff --git a/docs/tutorial/zh_CN/src/task_mcp.py b/docs/tutorial/zh_CN/src/task_mcp.pyindex 2a5d3c3d5..33122f47d 100644--- a/docs/tutorial/zh_CN/src/task_mcp.py+++ b/docs/tutorial/zh_CN/src/task_mcp.py@@ -104,7 +104,7 @@ toolkit = Toolkit()async def example_register_stateless_mcp() -> None:"""注册无状态客户端 MCP 工具的示例。"""# 从 MCP 服务器注册所有工具- await toolkit.register_mcp_client(+ await toolkit.register_mcp(stateless_client,# group_name="map_services", # 可选的组名)diff --git a/src/agentscope/mcp/_client_base.py b/src/agentscope/mcp/_client_base.pyindex b38d9ad84..3005699cf 100644--- a/src/agentscope/mcp/_client_base.py+++ b/src/agentscope/mcp/_client_base.py@@ -1,7 +1,9 @@# -*- coding: utf-8 -*-"""The base class for MCP clients in AgentScope."""from abc import abstractmethod-from typing import Any, TYPE_CHECKING+from typing import Any, TYPE_CHECKING, List++import mcpif TYPE_CHECKING:from ..tool import MCPTool@@ -37,3 +39,7 @@ class MCPClientBase:`MCPTool`:A tool object that implements ToolProtocol."""++ @abstractmethod+ async def list_tools(self) -> List[mcp.types.Tool]:+ """List the MCP tools."""diff --git a/src/agentscope/tool/_adapters.py b/src/agentscope/tool/_adapters.pyindex e447047b2..c2dc51c97 100644--- a/src/agentscope/tool/_adapters.py+++ b/src/agentscope/tool/_adapters.py@@ -17,7 +17,13 @@ from ..permission import (from ._response import ToolChunkfrom ._utils import _extract_func_description, _extract_input_schemafrom .._logging import logger-from ..message import TextBlock, DataBlock, Base64Source, URLSource+from ..message import (+ TextBlock,+ DataBlock,+ Base64Source,+ URLSource,+ ToolResultState,+)class _FunctionTool(ToolBase):@@ -128,7 +134,7 @@ class MCPTool(ToolBase):def __init__(self,mcp_name: str,- tool: Any,+ tool: mcp.types.Tool,client_gen: Callable[..., _AsyncGeneratorContextManager[Any]]| None = None,session: Any | None = None,@@ -152,7 +158,7 @@ class MCPTool(ToolBase):The timeout in seconds for tool execution."""self.mcp_name = mcp_name- self.name = tool.name+ self.name = f"mcp__{self.mcp_name}__{tool.name}"self.description = tool.description or ""# Extract input schema@@ -162,6 +168,7 @@ class MCPTool(ToolBase):"required": tool.inputSchema.get("required", []),}+ # By defaultself.is_concurrency_safe = Falseself.is_external_tool = False@@ -232,14 +239,14 @@ class MCPTool(ToolBase):async with ClientSession(read_stream, write_stream) as session:await session.initialize()result = await session.call_tool(- self.name,+ self._tool.name,arguments=kwargs,read_timeout_seconds=self._timeout,)else:# Stateful client: use existing sessionresult = await self._session.call_tool(- self.name,+ self._tool.name,arguments=kwargs,read_timeout_seconds=self._timeout,)@@ -247,7 +254,9 @@ class MCPTool(ToolBase):# Convert MCP result to AgentScope blocksreturn ToolChunk(content=self._convert_mcp_content_to_blocks(result.content),- state="error" if result.isError else "running",+ state=ToolResultState.ERROR+ if result.isError+ else ToolResultState.RUNNING,)@staticmethoddiff --git a/src/agentscope/tool/_toolkit.py b/src/agentscope/tool/_toolkit.pyindex 266a60191..30990fa2e 100644--- a/src/agentscope/tool/_toolkit.py+++ b/src/agentscope/tool/_toolkit.py@@ -112,7 +112,6 @@ class Toolkit:tools: list[ToolBase] | None = None,skills: list[str | SkillLoaderBase] | None = None,meta_tool_response_template: str = DEFAULT_META_TOOL_RESPONSE_TEMPLATE,- mcp_tool_name: str = "mcp__{server}__{tool}",skill_viewer_enabled: bool = True,skill_instruction_template: str = DEFAULT_SKILL_INSTRUCTION,) -> None:@@ -125,8 +124,6 @@ class Toolkit:The agent skill directories to be registered.meta_tool_response_template (`str`, optional):The template for meta tool responses.- mcp_tool_name (`str`, optional):- The naming pattern for MCP tools.skill_viewer_enabled (`bool`, defaults to `True`):Whether enable the built-in skill viewer tool function.skill_instruction_template (`str`):@@ -165,7 +162,6 @@ class Toolkit:)self.meta_tool_response_template = meta_tool_response_template- self.mcp_tool_name = mcp_tool_nameself.skill_instruction_template = skill_instruction_templateself.skill_viewer_enabled = skill_viewer_enabled@@ -616,14 +612,18 @@ class Toolkit:# Finally, yield the complete tool responseyield tool_response- async def register_mcp_client(+ async def register_mcp(self,mcp_client: MCPClientBase,group_name: str = "basic",enable_funcs: list[str] | None = None,disable_funcs: list[str] | None = None,) -> None:- """Register tool functions from an MCP client.+ """Register tools from an MCP client.++ .. note:: When registering tools from an MCP client, the tool will+ be renamed by template `mcp__{server_name}__{tool_name}` to avoid+ name conflicts.Args:mcp_client (`MCPClientBase`):@@ -646,8 +646,8 @@ class Toolkit:"`connect()` method first.",)- # Check arguments for enable_funcs and disabled_funcs- if enable_funcs is not None and disable_funcs is not None:+ # Check arguments for enable_funcs and disable_funcs+ if enable_funcs is not None:assert isinstance(enable_funcs, list) and all(isinstance(_, str) for _ in enable_funcs), (@@ -655,12 +655,15 @@ class Toolkit:f"{enable_funcs}.")+ if disable_funcs is not None:assert isinstance(disable_funcs, list) and all(isinstance(_, str) for _ in disable_funcs), ("Disable functions should be a list of strings, but got "f"{disable_funcs}.")++ if enable_funcs is not None and disable_funcs is not None:intersection = set(enable_funcs).intersection(set(disable_funcs),)@@ -691,6 +694,7 @@ class Toolkit:registered = RegisteredTool(tool=tool_obj,group=group_name,+ original_name=mcp_tool.name,)self.tools[tool_obj.name] = registereddiff --git a/tests/mcp_sse_client_test.py b/tests/mcp_sse_client_test.pyindex d2de36898..b0dc8d3fd 100644--- a/tests/mcp_sse_client_test.py+++ b/tests/mcp_sse_client_test.py@@ -55,7 +55,7 @@ class SseMCPClientTest(IsolatedAsyncioTestCase):{"type": "function","function": {- "name": "tool_1",+ "name": "mcp__test_sse_client__tool_1","description": "A test tool function.","parameters": {"type": "object",@@ -120,7 +120,7 @@ class SseMCPClientTest(IsolatedAsyncioTestCase):ToolCallBlock(id="xx",type="tool_call",- name="tool_1",+ name="mcp__test_sse_client__tool_1",input=json.dumps({"arg1": "789",@@ -148,7 +148,7 @@ class SseMCPClientTest(IsolatedAsyncioTestCase):self.assertDictEqual(self.toolkit.tools, {})# Try to add the mcp client- await self.toolkit.register_mcp_client(stateless_client)+ await self.toolkit.register_mcp(stateless_client)self.assertListEqual(self.toolkit.get_function_schemas(),self.schemas,@@ -161,7 +161,7 @@ class SseMCPClientTest(IsolatedAsyncioTestCase):# Test stateful clientstateful_client = HttpStatefulClient(- name="test_sse_client_stateful",+ name="test_sse_client",transport="sse",url=f"http://127.0.0.1:{self.port}/sse",)@@ -203,7 +203,7 @@ class SseMCPClientTest(IsolatedAsyncioTestCase):ToolCallBlock(id="xx",type="tool_call",- name="tool_1",+ name="mcp__test_sse_client__tool_1",input=json.dumps({"arg1": "56",@@ -231,7 +231,7 @@ class SseMCPClientTest(IsolatedAsyncioTestCase):self.toolkit.clear()self.assertDictEqual(self.toolkit.tools, {})- await self.toolkit.register_mcp_client(stateful_client)+ await self.toolkit.register_mcp(stateful_client)self.assertListEqual(self.toolkit.get_function_schemas(),self.schemas,