🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org
Python agentai-societiesartificial-intelligencecommunicative-aicooperative-aideep-learninglarge-language-modelsmulti-agent-systemsnatural-language-processing
feat: Support one command line to connect to MCP (#2061)
koch309292e8526bf5ad
diff --git a/camel/toolkits/mcp_toolkit.py b/camel/toolkits/mcp_toolkit.pyindex ba7905b9d..3c68c631a 100644--- a/camel/toolkits/mcp_toolkit.py+++ b/camel/toolkits/mcp_toolkit.py@@ -14,6 +14,7 @@import inspectimport jsonimport os+import shlexfrom contextlib import AsyncExitStack, asynccontextmanagerfrom typing import (TYPE_CHECKING,@@ -38,7 +39,7 @@ from camel.toolkits import BaseToolkit, FunctionToollogger = get_logger(__name__)-class _MCPServer(BaseToolkit):+class MCPClient(BaseToolkit):r"""Internal class that provides an abstraction layer to interact withexternal tools using the Model Context Protocol (MCP). It supports twomodes of connection:@@ -87,7 +88,7 @@ class _MCPServer(BaseToolkit):r"""Explicitly connect to the MCP server.Returns:- _MCPServer: The connected server instance+ MCPClient: The client used to connect to the server."""from mcp.client.session import ClientSessionfrom mcp.client.sse import sse_client@@ -110,11 +111,20 @@ class _MCPServer(BaseToolkit):)else:command = self.command_or_url+ arguments = self.args+ if not self.args:+ argv = shlex.split(command)+ if not argv:+ raise ValueError("Command is empty")++ command = argv[0]+ arguments = argv[1:]+if os.name == "nt" and command.lower() == "npx":command = "npx.cmd"server_parameters = StdioServerParameters(- command=command, args=self.args, env=self.env+ command=command, args=arguments, env=self.env)(read_stream,@@ -149,7 +159,7 @@ class _MCPServer(BaseToolkit):on the provided `command_or_url`.Yields:- _MCPServer: Instance with active connection ready for tool+ MCPClient: Instance with active connection ready for toolinteraction."""try:@@ -345,7 +355,7 @@ class MCPToolkit(BaseToolkit):MCP services.Args:- servers (Optional[List[_MCPServer]]): List of _MCPServer+ servers (Optional[List[MCPClient]]): List of MCPClientinstances to manage.config_path (Optional[str]): Path to a JSON configuration filedefining MCP servers.@@ -376,12 +386,12 @@ class MCPToolkit(BaseToolkit):}Attributes:- servers (List[_MCPServer]): List of _MCPServer instances being managed.+ servers (List[MCPClient]): List of MCPClient instances being managed."""def __init__(self,- servers: Optional[List[_MCPServer]] = None,+ servers: Optional[List[MCPClient]] = None,config_path: Optional[str] = None,):super().__init__()@@ -392,7 +402,7 @@ class MCPToolkit(BaseToolkit):"Servers from both sources will be combined.")- self.servers: List[_MCPServer] = servers or []+ self.servers: List[MCPClient] = servers or []if config_path:self.servers.extend(self._load_servers_from_config(config_path))@@ -400,14 +410,14 @@ class MCPToolkit(BaseToolkit):self._exit_stack = AsyncExitStack()self._connected = False- def _load_servers_from_config(self, config_path: str) -> List[_MCPServer]:+ def _load_servers_from_config(self, config_path: str) -> List[MCPClient]:r"""Loads MCP server configurations from a JSON file.Args:config_path (str): Path to the JSON configuration file.Returns:- List[_MCPServer]: List of configured _MCPServer instances.+ List[MCPClient]: List of configured MCPClient instances."""try:with open(config_path, "r", encoding="utf-8") as f:@@ -443,7 +453,7 @@ class MCPToolkit(BaseToolkit):)continue- server = _MCPServer(+ server = MCPClient(command_or_url=cast(str, cfg.get("command") or cfg.get("url")),args=cfg.get("args", []),env={**os.environ, **cfg.get("env", {})},diff --git a/docs/key_modules/tools.md b/docs/key_modules/tools.mdindex d65c43a3b..cf403c625 100644--- a/docs/key_modules/tools.md+++ b/docs/key_modules/tools.md@@ -267,7 +267,7 @@ You can connect to MCP servers and use their tools from a client application:```pythonimport asynciofrom mcp.types import CallToolResult-from camel.toolkits.mcp_toolkit import MCPToolkit, _MCPServer+from camel.toolkits.mcp_toolkit import MCPToolkit, MCPClientasync def run_example():# Initialize the MCPToolkit with your configuration file@@ -277,7 +277,7 @@ async def run_example():await mcp_toolkit.connect()# Get the first MCP server- mcp_client: _MCPServer = mcp_toolkit.servers[0]+ mcp_client: MCPClient = mcp_toolkit.servers[0]# List available tools from the serverres = await mcp_client.list_mcp_tools()diff --git a/examples/mcp_arxiv_toolkit/client.py b/examples/mcp_arxiv_toolkit/client.pyindex d93665649..8a999226e 100644--- a/examples/mcp_arxiv_toolkit/client.py+++ b/examples/mcp_arxiv_toolkit/client.py@@ -15,7 +15,7 @@ import asynciofrom mcp.types import CallToolResult-from camel.toolkits.mcp_toolkit import MCPToolkit, _MCPServer+from camel.toolkits.mcp_toolkit import MCPClient, MCPToolkitasync def run_example():@@ -26,7 +26,7 @@ async def run_example():await mcp_toolkit.connect()# call the server to list the available tools- mcp_client: _MCPServer = mcp_toolkit.servers[0]+ mcp_client: MCPClient = mcp_toolkit.servers[0]res = await mcp_client.list_mcp_tools()if isinstance(res, str):raise Exception(res)diff --git a/test/toolkits/test_mcp_toolkit.py b/test/toolkits/test_mcp_toolkit.pyindex 63e020b89..47e3e04a9 100644--- a/test/toolkits/test_mcp_toolkit.py+++ b/test/toolkits/test_mcp_toolkit.py@@ -19,17 +19,17 @@ from unittest.mock import AsyncMock, MagicMock, patchimport pytest-from camel.toolkits.mcp_toolkit import MCPToolkit, _MCPServer+from camel.toolkits.mcp_toolkit import MCPClient, MCPToolkit-class Test_MCPServer:- r"""Test _MCPServer class."""+class TestMCPClient:+ r"""Test MCPClient class."""@pytest.mark.asyncioasync def test_init(self):- r"""Test initialization of _MCPServer."""+ r"""Test initialization of MCPClient."""# Test with default parameters- server = _MCPServer("test_command")+ server = MCPClient("test_command")assert server.command_or_url == "test_command"assert server.args == []assert server.env == {}@@ -38,7 +38,7 @@ class Test_MCPServer:assert server._is_connected is False# Test with custom parameters- server = _MCPServer(+ server = MCPClient("test_url",args=["--arg1", "--arg2"],env={"ENV_VAR": "value"},@@ -77,7 +77,7 @@ class Test_MCPServer:mock_session_instance.list_tools.return_value = list_tools_result# Test HTTP connection- server = _MCPServer("https://example.com/api")+ server = MCPClient("https://example.com/api")async with server.connection() as connected_server:assert connected_server._is_connected is Trueassert connected_server._mcp_tools == ["tool1", "tool2"]@@ -116,7 +116,7 @@ class Test_MCPServer:mock_session_instance.list_tools.return_value = list_tools_result# Test stdio connection- server = _MCPServer(+ server = MCPClient("local_command", args=["--arg1"], env={"ENV_VAR": "value"})async with server.connection() as connected_server:@@ -132,7 +132,7 @@ class Test_MCPServer:@pytest.mark.asyncioasync def test_list_mcp_tools_not_connected(self):r"""Test list_mcp_tools when not connected."""- server = _MCPServer("test_command")+ server = MCPClient("test_command")result = await server.list_mcp_tools()assert isinstance(result, str)assert "not connected" in result@@ -140,7 +140,7 @@ class Test_MCPServer:@pytest.mark.asyncioasync def test_list_mcp_tools_connected(self):r"""Test list_mcp_tools when connected."""- server = _MCPServer("test_command")+ server = MCPClient("test_command")server._session = AsyncMock()# Mock successful response@@ -160,7 +160,7 @@ class Test_MCPServer:@pytest.mark.asyncioasync def test_generate_function_from_mcp_tool(self):r"""Test generate_function_from_mcp_tool."""- server = _MCPServer("test_command")+ server = MCPClient("test_command")server._session = AsyncMock()# Create mock MCP tool@@ -246,7 +246,7 @@ class Test_MCPServer:@pytest.mark.asyncioasync def test_build_tool_schema(self):r"""Test build_tool_schema method."""- server = _MCPServer("test_command")+ server = MCPClient("test_command")mock_tool = MagicMock()mock_tool.name = "test_function"mock_tool.description = "Test function description"@@ -297,11 +297,11 @@ class Test_MCPServer:@pytest.mark.asyncioasync def test_get_tools(self):- r"""Test get_tools method for _MCPServer."""+ r"""Test get_tools method for MCPClient."""with patch("camel.toolkits.mcp_toolkit.FunctionTool") as mock_function_tool:- server = _MCPServer("test_command")+ server = MCPClient("test_command")# Mock toolsmock_tool1 = MagicMock()@@ -361,7 +361,7 @@ class Test_MCPServer:mock_session_instance.list_tools.return_value = list_tools_result# Test HTTP connection- server = _MCPServer("https://example.com/api")+ server = MCPClient("https://example.com/api")result = await server.connect()# Verify results@@ -396,7 +396,7 @@ class Test_MCPServer:)# Create server- server = _MCPServer("https://example.com/api")+ server = MCPClient("https://example.com/api")# Mock disconnect to verify it's called on failureserver.disconnect = AsyncMock()@@ -416,7 +416,7 @@ class Test_MCPServer:async def test_disconnect_explicit(self):r"""Test explicit disconnect method."""# Create server- server = _MCPServer("test_command")+ server = MCPClient("test_command")# Setup connected stateserver._is_connected = True@@ -452,8 +452,8 @@ class TestMCPToolkit:def test_init(self):r"""Test initialization of MCPToolkit."""# Test with servers list- server1 = _MCPServer("test_command1")- server2 = _MCPServer("test_command2")+ server1 = MCPClient("test_command1")+ server2 = MCPClient("test_command2")toolkit = MCPToolkit(servers=[server1, server2])assert toolkit.servers == [server1, server2]@@ -576,8 +576,8 @@ class TestMCPToolkit:@pytest.mark.asyncioasync def test_connection(self):r"""Test connection context manager."""- server1 = _MCPServer("test_command1")- server2 = _MCPServer("test_command2")+ server1 = MCPClient("test_command1")+ server2 = MCPClient("test_command2")toolkit = MCPToolkit(servers=[server1, server2])# Mock the connection context managers of both servers@@ -600,7 +600,7 @@ class TestMCPToolkit:def test_is_connected(self):r"""Test is_connected method."""- toolkit = MCPToolkit(servers=[_MCPServer("test_command")])+ toolkit = MCPToolkit(servers=[MCPClient("test_command")])assert toolkit.is_connected() is Falsetoolkit._connected = Trueassert toolkit.is_connected() is True@@ -608,8 +608,8 @@ class TestMCPToolkit:@pytest.mark.asyncioasync def test_get_tools(self):r"""Test get_tools method."""- server1 = _MCPServer("test_command1")- server2 = _MCPServer("test_command2")+ server1 = MCPClient("test_command1")+ server2 = MCPClient("test_command2")toolkit = MCPToolkit(servers=[server1, server2])# Mock get_tools for both servers@@ -631,8 +631,8 @@ class TestMCPToolkit:async def test_connect(self):r"""Test explicit connect method."""# Create mock servers- server1 = _MCPServer("test_command1")- server2 = _MCPServer("test_command2")+ server1 = MCPClient("test_command1")+ server2 = MCPClient("test_command2")# Mock connect methodsserver1.connect = AsyncMock(return_value=server1)@@ -664,8 +664,8 @@ class TestMCPToolkit:async def test_connect_failure(self):r"""Test connect method with failure."""# Create mock servers- server1 = _MCPServer("test_command1")- server2 = _MCPServer("test_command2")+ server1 = MCPClient("test_command1")+ server2 = MCPClient("test_command2")# First server connects successfully, second failsserver1.connect = AsyncMock(return_value=server1)@@ -694,8 +694,8 @@ class TestMCPToolkit:async def test_disconnect(self):r"""Test explicit disconnect method."""# Create mock servers- server1 = _MCPServer("test_command1")- server2 = _MCPServer("test_command2")+ server1 = MCPClient("test_command1")+ server2 = MCPClient("test_command2")# Mock disconnect methodsserver1.disconnect = AsyncMock()diff --git a/test/utils/test_mcp_server.py b/test/utils/test_mcp_server.pyindex 445ad0e07..907861f6c 100644--- a/test/utils/test_mcp_server.py+++ b/test/utils/test_mcp_server.py@@ -18,7 +18,7 @@ from typing import TYPE_CHECKINGimport pytestfrom mcp.server import FastMCP-from camel.toolkits.mcp_toolkit import _MCPServer+from camel.toolkits.mcp_toolkit import MCPClientfrom camel.utils import MCPServerif TYPE_CHECKING:@@ -83,7 +83,7 @@ def test_tool_schema():@pytest.mark.asyncioasync def test_async_word_count():processor = TextProcessorForMCP()- server = _MCPServer(+ server = MCPClient(command_or_url=sys.executable,args=[__file__, "--server"],)