File size: 16,088 Bytes
5374a2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 |
"""
This tool is inspired / modified from MCP Python SDK and mcpadapt projects, now enhanced with FastMCP 2.0.
You may find more information about by visiting the following links:
- https://github.com/modelcontextprotocol/python-sdk
- https://github.com/grll/mcpadapt
- https://gofastmcp.com/clients/client
FastMCP 2.0 Integration Notes:
- Replaced official MCP SDK with FastMCP for better performance and reliability
- Maintains the same synchronous API with internal async handling via threading
- Auto-infers transport types (stdio/HTTP) based on configuration
- Enhanced error handling with FastMCP's exception hierarchy
- Backwards compatible with existing MCP server configurations
"""
import threading
import asyncio
from functools import partial
from typing import Optional, Any, List, Dict, Callable, Union
from evoagentx.tools.tool import Tool,Toolkit
from evoagentx.core.logging import logger
from contextlib import AsyncExitStack, asynccontextmanager
# FastMCP 2.0 imports - replacing official MCP SDK
from fastmcp import Client
from fastmcp.exceptions import ClientError, McpError
import json
class MCPTool(Tool):
name: str = "MCPTool"
description: str = "MCP tool wrapper"
inputs: Dict[str, Dict[str, Any]] = {}
required: Optional[List[str]] = None
function: Callable = None
def __init__(self, name: str, description: str, inputs: Dict[str, Dict[str, str]], required: Optional[List[str]] = None, function: Callable = None):
super().__init__(name=name, description=description, inputs=inputs, required=required)
self.function = function
@property
def __name__(self):
return self.name
def __call__(self, **kwargs):
if not self.function:
raise ValueError("Function not set for MCPTool")
result = self.function(**kwargs)
return self._convert_result(result)
def _convert_result(self, result: Any) -> Any:
"""
Convert MCP tool results to JSON-serializable format.
Handles complex objects like Anthropic's TextContent, ImageContent, etc.
"""
if result is None:
return None
# Handle primitive types
if isinstance(result, (str, int, float, bool)):
return result
# Handle lists
if isinstance(result, list):
return [self._convert_result(item) for item in result]
# Handle dictionaries
if isinstance(result, dict):
return {key: self._convert_result(value) for key, value in result.items()}
# Handle Anthropic content types by name (avoid import dependencies)
obj_type = type(result).__name__
if obj_type == "TextContent":
if hasattr(result, 'text'):
return result.text
elif hasattr(result, 'content'):
return result.content
else:
return str(result)
elif obj_type in ["ImageContent", "ToolUseContent", "ToolResultContent"]:
# For these types, return a structured representation
if hasattr(result, '__dict__'):
return self._convert_result(result.__dict__)
else:
return str(result)
# Handle other objects with text/content attributes
if hasattr(result, 'text'):
return result.text
elif hasattr(result, 'content'):
return result.content
# Handle objects with __dict__ (convert to dictionary)
if hasattr(result, '__dict__'):
return self._convert_result(result.__dict__)
# Fallback to string representation
return str(result)
@classmethod
def validate_attributes(cls):
required_attributes = {
"name": str,
"description": str,
"inputs": dict
}
for attr, attr_type in required_attributes.items():
if not hasattr(cls, attr):
raise ValueError(f"Attribute {attr} is required")
if not isinstance(getattr(cls, attr), attr_type):
raise ValueError(f"Attribute {attr} must be of type {attr_type}")
if cls.required:
for required_input in cls.required:
if required_input not in cls.inputs:
raise ValueError(f"Required input '{required_input}' is not found in inputs")
class MCPClient:
def __init__(
self,
server_configs: Union[Dict[str, Any], List[Dict[str, Any]]],
connect_timeout: float = 120.0,
):
if isinstance(server_configs, dict):
self.server_configs = [server_configs]
else:
self.server_configs = server_configs
self.event_loop = asyncio.new_event_loop()
self.sessions: list[Client] = []
self.mcp_tools: list[list[Any]] = []
self.task = None
self.thread_running = threading.Event()
self.working_thread = threading.Thread(target=self._run_event, daemon=True)
self.connect_timeout = connect_timeout
self.tools = None
self.tool_schemas = None
self.tool_descriptions = None
def _disconnect(self):
# Signal shutdown to the event loop
if hasattr(self, 'shutdown_event') and self.shutdown_event:
self.event_loop.call_soon_threadsafe(self.shutdown_event.set)
# Cancel the main task
if self.task and not self.task.done():
self.event_loop.call_soon_threadsafe(self.task.cancel)
# Wait for thread to finish with timeout
if hasattr(self, 'working_thread') and self.working_thread.is_alive():
self.working_thread.join(timeout=5) # Add timeout to prevent hanging
# Close the event loop
if hasattr(self, 'event_loop') and not self.event_loop.is_closed():
self.event_loop.close()
def _connect(self):
self.working_thread.start()
if not self.thread_running.wait(timeout=self.connect_timeout):
# Clean up if connection times out
self._disconnect()
raise TimeoutError(
f"Couldn't connect to the MCP server after {self.connect_timeout} seconds"
)
def __enter__(self):
self._connect()
return self.get_toolkits()
def __del__(self):
try:
self._disconnect()
except Exception:
# Ignore errors during cleanup in destructor
pass
def __exit__(self, exc_type, exc_value, traceback):
self._disconnect()
def _run_event(self):
"""Runs the event loop in a separate thread (for synchronous usage)."""
print("Running event loop")
asyncio.set_event_loop(self.event_loop)
async def setup():
try:
async with AsyncExitStack() as stack:
connections = [
await stack.enter_async_context(self._start_server(config))
for config in self.server_configs
]
self.sessions, self.mcp_tools = [list(c) for c in zip(*connections)]
self.thread_running.set()
# Instead of waiting indefinitely, wait for shutdown signal
self.shutdown_event = asyncio.Event()
await self.shutdown_event.wait()
except Exception as e:
logger.error(f"Error in MCP event loop: {str(e)}")
self.thread_running.set()
raise
self.task = self.event_loop.create_task(setup())
try:
self.event_loop.run_until_complete(self.task)
except asyncio.CancelledError:
logger.info("MCP client event loop was cancelled")
except Exception as e:
logger.error(f"Error in MCP event loop: {str(e)}")
finally:
# Ensure the event loop is properly closed
if not self.event_loop.is_closed():
self.event_loop.close()
@asynccontextmanager
async def _start_server(self, config: Dict[str, Any]):
client = Client(config)
async with client:
tools = await client.list_tools()
yield client, tools
def create_tool(
self,
session: Client,
mcp_tools: List[Any], # List of FastMCP tool objects for a single server
config: Dict[str, Any],
) ->Toolkit:
# Define the sync call function once
def _sync_call_tool(name: str, **kwargs) -> Any:
try:
if "arguments" in kwargs and len(kwargs) == 1:
arguments = kwargs["arguments"]
else:
arguments = kwargs
logger.info(f"Calling MCP tool: {name} with arguments: {arguments}")
future = asyncio.run_coroutine_threadsafe(
session.call_tool(name, arguments), self.event_loop
)
result = future.result(timeout=30) # Reduced timeout to 30 seconds
logger.info(f"MCP tool {name} call completed successfully")
return result
except (TimeoutError, ClientError, McpError) as e:
logger.error(f"Error calling MCP tool {name}: {str(e)}")
raise
except Exception as e:
logger.error(f"Unexpected error calling MCP tool {name}: {str(e)}")
raise
# Collect all schemas and descriptions
all_tools = []
for mcp_tool in mcp_tools:
input_schema = getattr(mcp_tool, 'inputSchema', {})
if not input_schema and hasattr(mcp_tool, 'input_schema'):
input_schema = mcp_tool.input_schema
properties = input_schema.get("properties", {})
required = input_schema.get("required", [])
# Convert MCP properties to Tool.inputs format
# Tool.inputs expects Dict[str, Dict[str, str]] format
inputs = properties
# Create the partial function and add __name__ attribute
partial_func = partial(_sync_call_tool, mcp_tool.name)
partial_func.__name__ = mcp_tool.name
tool = MCPTool(
name=mcp_tool.name,
description=getattr(mcp_tool, 'description', None) or "",
inputs=inputs,
required=required,
function=partial_func
)
all_tools.append(tool)
tool_collection =Toolkit(name=next(iter(config.get("mcpServers").keys())), tools=all_tools)
return tool_collection
def get_toolkits(self) -> List[Toolkit]:
"""Return a list ofToolkits, one per server."""
if not self.sessions:
raise RuntimeError("Session not initialized")
return [
self.create_tool(session, tools, config)
for session, tools, config in zip(self.sessions, self.mcp_tools, self.server_configs)
]
class MCPToolkit:
def __init__(self, servers: Optional[list[MCPClient]] = None, config_path: Optional[str] = None, config: Optional[dict[str, Any]] = None):
parameters = []
if config_path:
parameters += self._from_config_file(config_path)
if config:
parameters += self._from_config(config)
# Initialize servers list
self.servers = []
# Only create MCPClient if we have parameters
if parameters:
self.servers.append(MCPClient(parameters))
# Add additional servers if provided
if servers:
self.servers.extend(servers)
# Connect to all servers
failed_servers = []
for server in self.servers:
try:
server._connect()
logger.info("Successfully connected to MCP servers")
except TimeoutError as e:
logger.warning(f"Timeout connecting to MCP servers: {str(e)}. Some tools may not be available.")
failed_servers.append(server)
except Exception as e:
logger.error(f"Error connecting to MCP servers: {str(e)}")
failed_servers.append(server)
# Remove failed servers
for failed_server in failed_servers:
if failed_server in self.servers:
self.servers.remove(failed_server)
def _from_config_file(self, config_path: str):
try:
with open(config_path, "r") as f:
server_configs = json.load(f)
return self._from_config(server_configs)
except FileNotFoundError:
logger.error(f"Config file not found: {config_path}")
return []
except json.JSONDecodeError:
logger.error(f"Invalid JSON in config file: {config_path}")
return []
def _from_config(self, server_configs: dict[str, Any]):
if not isinstance(server_configs, dict):
logger.error("Server configuration must be a dictionary")
return []
# If there's no mcpServers key, treat it as a single server config
if "mcpServers" not in server_configs:
raise ValueError("Server configuration must contain 'mcpServers' key")
# Separate each server into its own config with the same format
server_list = []
for server_name, server_config in server_configs["mcpServers"].items():
individual_config = {
"mcpServers": {
server_name: server_config
}
}
server_list.append(individual_config)
return server_list
def disconnect(self):
for server in self.servers:
try:
server._disconnect()
except Exception as e:
logger.warning(f"Error disconnecting from MCP server: {str(e)}")
# Clear the servers list
self.servers.clear()
def get_toolkits(self) -> List[Toolkit]:
"""Return a flattened list of all tools across all servers"""
all_tools = []
if not self.servers:
logger.info("No MCP servers configured, returning empty toolkit list")
return all_tools
for server in self.servers:
try:
# Add timeout to prevent hanging
import threading
import queue
result_queue = queue.Queue()
exception_queue = queue.Queue()
def get_tools_with_timeout():
try:
tools = server.get_toolkits()
result_queue.put(tools)
except Exception as e:
exception_queue.put(e)
# Start tool retrieval in a separate thread with timeout
thread = threading.Thread(target=get_tools_with_timeout)
thread.daemon = True
thread.start()
thread.join(timeout=30) # 30 second timeout
if thread.is_alive():
logger.warning("Timeout getting tools from MCP server after 30 seconds")
continue
if not exception_queue.empty():
raise exception_queue.get()
tools = result_queue.get()
all_tools.extend(tools)
logger.info(f"Added {len(tools)} tools from MCP server")
except Exception as e:
logger.error(f"Error getting tools from MCP server: {str(e)}")
return all_tools |