"""Tests for the MCP (Model Context Protocol) client support. All tests use mocks -- no real MCP servers or subprocesses are started. """ import asyncio import json from types import SimpleNamespace from unittest.mock import AsyncMock, MagicMock, patch import pytest # --------------------------------------------------------------------------- # Helpers # --------------------------------------------------------------------------- def _make_mcp_tool(name="read_file", description="Read a file", input_schema=None): """Create a fake MCP Tool object matching the SDK interface.""" tool = SimpleNamespace() tool.name = name tool.description = description tool.inputSchema = input_schema or { "type": "object", "properties": { "path": {"type": "string", "description": "File path"}, }, "required": ["path"], } return tool def _make_call_result(text="file contents here", is_error=False): """Create a fake MCP CallToolResult.""" block = SimpleNamespace(text=text) return SimpleNamespace(content=[block], isError=is_error) def _make_mock_server(name, session=None, tools=None): """Create an MCPServerTask with mock attributes for testing.""" from tools.mcp_tool import MCPServerTask server = MCPServerTask(name) server.session = session server._tools = tools or [] return server # --------------------------------------------------------------------------- # Config loading # --------------------------------------------------------------------------- class TestLoadMCPConfig: def test_no_config_returns_empty(self): """No mcp_servers key in config -> empty dict.""" with patch("hermes_cli.config.load_config", return_value={"model": "test"}): from tools.mcp_tool import _load_mcp_config result = _load_mcp_config() assert result == {} def test_valid_config_parsed(self): """Valid mcp_servers config is returned as-is.""" servers = { "filesystem": { "command": "npx", "args": ["-y", "@modelcontextprotocol/server-filesystem", "/tmp"], "env": {}, } } with patch("hermes_cli.config.load_config", return_value={"mcp_servers": servers}): from tools.mcp_tool import _load_mcp_config result = _load_mcp_config() assert "filesystem" in result assert result["filesystem"]["command"] == "npx" def test_mcp_servers_not_dict_returns_empty(self): """mcp_servers set to non-dict value -> empty dict.""" with patch("hermes_cli.config.load_config", return_value={"mcp_servers": "invalid"}): from tools.mcp_tool import _load_mcp_config result = _load_mcp_config() assert result == {} # --------------------------------------------------------------------------- # Schema conversion # --------------------------------------------------------------------------- class TestSchemaConversion: def test_converts_mcp_tool_to_hermes_schema(self): from tools.mcp_tool import _convert_mcp_schema mcp_tool = _make_mcp_tool(name="read_file", description="Read a file") schema = _convert_mcp_schema("filesystem", mcp_tool) assert schema["name"] == "mcp_filesystem_read_file" assert schema["description"] == "Read a file" assert "properties" in schema["parameters"] def test_empty_input_schema_gets_default(self): from tools.mcp_tool import _convert_mcp_schema mcp_tool = _make_mcp_tool(name="ping", description="Ping", input_schema=None) mcp_tool.inputSchema = None schema = _convert_mcp_schema("test", mcp_tool) assert schema["parameters"]["type"] == "object" assert schema["parameters"]["properties"] == {} def test_tool_name_prefix_format(self): from tools.mcp_tool import _convert_mcp_schema mcp_tool = _make_mcp_tool(name="list_dir") schema = _convert_mcp_schema("my_server", mcp_tool) assert schema["name"] == "mcp_my_server_list_dir" def test_hyphens_sanitized_to_underscores(self): """Hyphens in tool/server names are replaced with underscores for LLM compat.""" from tools.mcp_tool import _convert_mcp_schema mcp_tool = _make_mcp_tool(name="get-sum") schema = _convert_mcp_schema("my-server", mcp_tool) assert schema["name"] == "mcp_my_server_get_sum" assert "-" not in schema["name"] # --------------------------------------------------------------------------- # Check function # --------------------------------------------------------------------------- class TestCheckFunction: def test_disconnected_returns_false(self): from tools.mcp_tool import _make_check_fn, _servers _servers.pop("test_server", None) check = _make_check_fn("test_server") assert check() is False def test_connected_returns_true(self): from tools.mcp_tool import _make_check_fn, _servers server = _make_mock_server("test_server", session=MagicMock()) _servers["test_server"] = server try: check = _make_check_fn("test_server") assert check() is True finally: _servers.pop("test_server", None) def test_session_none_returns_false(self): from tools.mcp_tool import _make_check_fn, _servers server = _make_mock_server("test_server", session=None) _servers["test_server"] = server try: check = _make_check_fn("test_server") assert check() is False finally: _servers.pop("test_server", None) # --------------------------------------------------------------------------- # Tool handler # --------------------------------------------------------------------------- class TestToolHandler: """Tool handlers are sync functions that schedule work on the MCP loop.""" def _patch_mcp_loop(self, coro_side_effect=None): """Return a patch for _run_on_mcp_loop that runs the coroutine directly.""" def fake_run(coro, timeout=30): loop = asyncio.new_event_loop() try: return loop.run_until_complete(coro) finally: loop.close() if coro_side_effect: return patch("tools.mcp_tool._run_on_mcp_loop", side_effect=coro_side_effect) return patch("tools.mcp_tool._run_on_mcp_loop", side_effect=fake_run) def test_successful_call(self): from tools.mcp_tool import _make_tool_handler, _servers mock_session = MagicMock() mock_session.call_tool = AsyncMock( return_value=_make_call_result("hello world", is_error=False) ) server = _make_mock_server("test_srv", session=mock_session) _servers["test_srv"] = server try: handler = _make_tool_handler("test_srv", "greet") with self._patch_mcp_loop(): result = json.loads(handler({"name": "world"})) assert result["result"] == "hello world" mock_session.call_tool.assert_called_once_with("greet", arguments={"name": "world"}) finally: _servers.pop("test_srv", None) def test_mcp_error_result(self): from tools.mcp_tool import _make_tool_handler, _servers mock_session = MagicMock() mock_session.call_tool = AsyncMock( return_value=_make_call_result("something went wrong", is_error=True) ) server = _make_mock_server("test_srv", session=mock_session) _servers["test_srv"] = server try: handler = _make_tool_handler("test_srv", "fail_tool") with self._patch_mcp_loop(): result = json.loads(handler({})) assert "error" in result assert "something went wrong" in result["error"] finally: _servers.pop("test_srv", None) def test_disconnected_server(self): from tools.mcp_tool import _make_tool_handler, _servers _servers.pop("ghost", None) handler = _make_tool_handler("ghost", "any_tool") result = json.loads(handler({})) assert "error" in result assert "not connected" in result["error"] def test_exception_during_call(self): from tools.mcp_tool import _make_tool_handler, _servers mock_session = MagicMock() mock_session.call_tool = AsyncMock(side_effect=RuntimeError("connection lost")) server = _make_mock_server("test_srv", session=mock_session) _servers["test_srv"] = server try: handler = _make_tool_handler("test_srv", "broken_tool") with self._patch_mcp_loop(): result = json.loads(handler({})) assert "error" in result assert "connection lost" in result["error"] finally: _servers.pop("test_srv", None) # --------------------------------------------------------------------------- # Tool registration (discovery + register) # --------------------------------------------------------------------------- class TestDiscoverAndRegister: def test_tools_registered_in_registry(self): """_discover_and_register_server registers tools with correct names.""" from tools.registry import ToolRegistry from tools.mcp_tool import _discover_and_register_server, _servers, MCPServerTask mock_registry = ToolRegistry() mock_tools = [ _make_mcp_tool("read_file", "Read a file"), _make_mcp_tool("write_file", "Write a file"), ] mock_session = MagicMock() async def fake_connect(name, config): server = MCPServerTask(name) server.session = mock_session server._tools = mock_tools return server with patch("tools.mcp_tool._connect_server", side_effect=fake_connect), \ patch("tools.registry.registry", mock_registry): registered = asyncio.run( _discover_and_register_server("fs", {"command": "npx", "args": []}) ) assert "mcp_fs_read_file" in registered assert "mcp_fs_write_file" in registered assert "mcp_fs_read_file" in mock_registry.get_all_tool_names() assert "mcp_fs_write_file" in mock_registry.get_all_tool_names() _servers.pop("fs", None) def test_toolset_created(self): """A custom toolset is created for the MCP server.""" from tools.mcp_tool import _discover_and_register_server, _servers, MCPServerTask mock_tools = [_make_mcp_tool("ping", "Ping")] mock_session = MagicMock() async def fake_connect(name, config): server = MCPServerTask(name) server.session = mock_session server._tools = mock_tools return server mock_create = MagicMock() with patch("tools.mcp_tool._connect_server", side_effect=fake_connect), \ patch("toolsets.create_custom_toolset", mock_create): asyncio.run( _discover_and_register_server("myserver", {"command": "test"}) ) mock_create.assert_called_once() call_kwargs = mock_create.call_args assert call_kwargs[1]["name"] == "mcp-myserver" or call_kwargs[0][0] == "mcp-myserver" _servers.pop("myserver", None) def test_schema_format_correct(self): """Registered schemas have the correct format.""" from tools.registry import ToolRegistry from tools.mcp_tool import _discover_and_register_server, _servers, MCPServerTask mock_registry = ToolRegistry() mock_tools = [_make_mcp_tool("do_thing", "Do something")] mock_session = MagicMock() async def fake_connect(name, config): server = MCPServerTask(name) server.session = mock_session server._tools = mock_tools return server with patch("tools.mcp_tool._connect_server", side_effect=fake_connect), \ patch("tools.registry.registry", mock_registry): asyncio.run( _discover_and_register_server("srv", {"command": "test"}) ) entry = mock_registry._tools.get("mcp_srv_do_thing") assert entry is not None assert entry.schema["name"] == "mcp_srv_do_thing" assert "parameters" in entry.schema assert entry.is_async is False assert entry.toolset == "mcp-srv" _servers.pop("srv", None) # --------------------------------------------------------------------------- # MCPServerTask (run / start / shutdown) # --------------------------------------------------------------------------- class TestMCPServerTask: """Test the MCPServerTask lifecycle with mocked MCP SDK.""" def _mock_stdio_and_session(self, session): """Return patches for stdio_client and ClientSession as async CMs.""" mock_read, mock_write = MagicMock(), MagicMock() mock_stdio_cm = MagicMock() mock_stdio_cm.__aenter__ = AsyncMock(return_value=(mock_read, mock_write)) mock_stdio_cm.__aexit__ = AsyncMock(return_value=False) mock_cs_cm = MagicMock() mock_cs_cm.__aenter__ = AsyncMock(return_value=session) mock_cs_cm.__aexit__ = AsyncMock(return_value=False) return ( patch("tools.mcp_tool.stdio_client", return_value=mock_stdio_cm), patch("tools.mcp_tool.ClientSession", return_value=mock_cs_cm), mock_read, mock_write, ) def test_start_connects_and_discovers_tools(self): """start() creates a Task that connects, discovers tools, and waits.""" from tools.mcp_tool import MCPServerTask mock_tools = [_make_mcp_tool("echo")] mock_session = MagicMock() mock_session.initialize = AsyncMock() mock_session.list_tools = AsyncMock( return_value=SimpleNamespace(tools=mock_tools) ) p_stdio, p_cs, _, _ = self._mock_stdio_and_session(mock_session) async def _test(): with patch("tools.mcp_tool.StdioServerParameters"), p_stdio, p_cs: server = MCPServerTask("test_srv") await server.start({"command": "npx", "args": ["-y", "test"]}) assert server.session is mock_session assert len(server._tools) == 1 assert server._tools[0].name == "echo" mock_session.initialize.assert_called_once() await server.shutdown() assert server.session is None asyncio.run(_test()) def test_no_command_raises(self): """Missing 'command' in config raises ValueError.""" from tools.mcp_tool import MCPServerTask async def _test(): server = MCPServerTask("bad") with pytest.raises(ValueError, match="no 'command'"): await server.start({"args": []}) asyncio.run(_test()) def test_empty_env_passed_as_none(self): """Empty env dict is passed as None to StdioServerParameters.""" from tools.mcp_tool import MCPServerTask mock_session = MagicMock() mock_session.initialize = AsyncMock() mock_session.list_tools = AsyncMock( return_value=SimpleNamespace(tools=[]) ) p_stdio, p_cs, _, _ = self._mock_stdio_and_session(mock_session) async def _test(): with patch("tools.mcp_tool.StdioServerParameters") as mock_params, \ p_stdio, p_cs: server = MCPServerTask("srv") await server.start({"command": "node", "env": {}}) # Empty dict -> None call_kwargs = mock_params.call_args assert call_kwargs.kwargs.get("env") is None await server.shutdown() asyncio.run(_test()) def test_shutdown_signals_task_exit(self): """shutdown() signals the event and waits for task completion.""" from tools.mcp_tool import MCPServerTask mock_session = MagicMock() mock_session.initialize = AsyncMock() mock_session.list_tools = AsyncMock( return_value=SimpleNamespace(tools=[]) ) p_stdio, p_cs, _, _ = self._mock_stdio_and_session(mock_session) async def _test(): with patch("tools.mcp_tool.StdioServerParameters"), p_stdio, p_cs: server = MCPServerTask("srv") await server.start({"command": "npx"}) assert server.session is not None assert not server._task.done() await server.shutdown() assert server.session is None assert server._task.done() asyncio.run(_test()) # --------------------------------------------------------------------------- # discover_mcp_tools toolset injection # --------------------------------------------------------------------------- class TestToolsetInjection: def test_mcp_tools_added_to_platform_toolsets(self): """Discovered MCP tools are injected into hermes-cli and platform toolsets.""" from tools.mcp_tool import _servers, MCPServerTask mock_tools = [_make_mcp_tool("list_files", "List files")] mock_session = MagicMock() async def fake_connect(name, config): server = MCPServerTask(name) server.session = mock_session server._tools = mock_tools return server fake_toolsets = { "hermes-cli": {"tools": ["terminal", "web_search"], "description": "CLI", "includes": []}, "hermes-telegram": {"tools": ["terminal"], "description": "Telegram", "includes": []}, } fake_config = { "fs": {"command": "npx", "args": []}, } with patch("tools.mcp_tool._MCP_AVAILABLE", True), \ patch("tools.mcp_tool._load_mcp_config", return_value=fake_config), \ patch("tools.mcp_tool._connect_server", side_effect=fake_connect), \ patch("toolsets.TOOLSETS", fake_toolsets): from tools.mcp_tool import discover_mcp_tools result = discover_mcp_tools() assert "mcp_fs_list_files" in result assert "mcp_fs_list_files" in fake_toolsets["hermes-cli"]["tools"] assert "mcp_fs_list_files" in fake_toolsets["hermes-telegram"]["tools"] # Original tools preserved assert "terminal" in fake_toolsets["hermes-cli"]["tools"] _servers.pop("fs", None) def test_server_connection_failure_skipped(self): """If one server fails to connect, others still proceed.""" from tools.mcp_tool import _servers, MCPServerTask mock_tools = [_make_mcp_tool("ping", "Ping")] mock_session = MagicMock() call_count = 0 async def flaky_connect(name, config): nonlocal call_count call_count += 1 if name == "broken": raise ConnectionError("cannot reach server") server = MCPServerTask(name) server.session = mock_session server._tools = mock_tools return server fake_config = { "broken": {"command": "bad"}, "good": {"command": "npx", "args": []}, } fake_toolsets = { "hermes-cli": {"tools": [], "description": "CLI", "includes": []}, } with patch("tools.mcp_tool._MCP_AVAILABLE", True), \ patch("tools.mcp_tool._load_mcp_config", return_value=fake_config), \ patch("tools.mcp_tool._connect_server", side_effect=flaky_connect), \ patch("toolsets.TOOLSETS", fake_toolsets): from tools.mcp_tool import discover_mcp_tools result = discover_mcp_tools() # Only good server's tool registered assert "mcp_good_ping" in result assert "mcp_broken_ping" not in result assert call_count == 2 # Both were attempted _servers.pop("good", None) # --------------------------------------------------------------------------- # Graceful fallback # --------------------------------------------------------------------------- class TestGracefulFallback: def test_mcp_unavailable_returns_empty(self): """When _MCP_AVAILABLE is False, discover_mcp_tools is a no-op.""" with patch("tools.mcp_tool._MCP_AVAILABLE", False): from tools.mcp_tool import discover_mcp_tools result = discover_mcp_tools() assert result == [] def test_no_servers_returns_empty(self): """No MCP servers configured -> empty list.""" with patch("tools.mcp_tool._MCP_AVAILABLE", True), \ patch("tools.mcp_tool._load_mcp_config", return_value={}): from tools.mcp_tool import discover_mcp_tools result = discover_mcp_tools() assert result == [] # --------------------------------------------------------------------------- # Shutdown (public API) # --------------------------------------------------------------------------- class TestShutdown: def test_no_servers_safe(self): """shutdown_mcp_servers with no servers does nothing.""" from tools.mcp_tool import shutdown_mcp_servers, _servers _servers.clear() shutdown_mcp_servers() # Should not raise def test_shutdown_clears_servers(self): """shutdown_mcp_servers calls shutdown() on each server and clears dict.""" import tools.mcp_tool as mcp_mod from tools.mcp_tool import shutdown_mcp_servers, _servers _servers.clear() mock_server = MagicMock() mock_server.shutdown = AsyncMock() _servers["test"] = mock_server mcp_mod._ensure_mcp_loop() try: shutdown_mcp_servers() finally: mcp_mod._mcp_loop = None mcp_mod._mcp_thread = None assert len(_servers) == 0 mock_server.shutdown.assert_called_once() def test_shutdown_handles_errors(self): """shutdown_mcp_servers handles errors during close gracefully.""" import tools.mcp_tool as mcp_mod from tools.mcp_tool import shutdown_mcp_servers, _servers _servers.clear() mock_server = MagicMock() mock_server.shutdown = AsyncMock(side_effect=RuntimeError("close failed")) _servers["broken"] = mock_server mcp_mod._ensure_mcp_loop() try: shutdown_mcp_servers() # Should not raise finally: mcp_mod._mcp_loop = None mcp_mod._mcp_thread = None assert len(_servers) == 0