-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Add FastMCPToolset #2784
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add FastMCPToolset #2784
Changes from 10 commits
cffc38f
456900e
9bac437
1cf320e
edd89f2
9c4fe38
a46222f
27592c7
0362fd7
eaa45c8
4bd0334
533e879
f2be96d
0fd6929
881f306
dfcad61
8776a67
a171272
6ea1dd3
81d004d
880f355
aade6d5
8baad2d
31a3179
1c3b9e2
cc559d7
623524b
3766ba8
e46bafc
71ab5ad
99c5042
34d36b9
1b3e0fe
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,264 @@ | ||
| from __future__ import annotations | ||
|
|
||
| import base64 | ||
| from asyncio import Lock | ||
| from contextlib import AsyncExitStack | ||
| from enum import Enum | ||
| from typing import TYPE_CHECKING, Any | ||
|
|
||
| from typing_extensions import Self | ||
|
|
||
| from pydantic_ai.exceptions import ModelRetry | ||
| from pydantic_ai.mcp import TOOL_SCHEMA_VALIDATOR, messages | ||
strawgate marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| from pydantic_ai.tools import AgentDepsT, RunContext, ToolDefinition | ||
| from pydantic_ai.toolsets import AbstractToolset | ||
| from pydantic_ai.toolsets.abstract import ToolsetTool | ||
|
|
||
| try: | ||
| from fastmcp.client import Client | ||
| from fastmcp.client.transports import FastMCPTransport, MCPConfigTransport | ||
| from fastmcp.exceptions import ToolError | ||
| from fastmcp.mcp_config import MCPConfig | ||
| from fastmcp.server.server import FastMCP | ||
| from mcp.types import ( | ||
| AudioContent, | ||
| ContentBlock, | ||
| ImageContent, | ||
| TextContent, | ||
| Tool as MCPTool, | ||
| ) | ||
|
|
||
| except ImportError as _import_error: | ||
| raise ImportError( | ||
| 'Please install the `fastmcp` package to use the FastMCP server, ' | ||
| 'you can use the `fastmcp` optional group — `pip install "pydantic-ai-slim[fastmcp]"`' | ||
| ) from _import_error | ||
|
|
||
|
|
||
| if TYPE_CHECKING: | ||
| from fastmcp import FastMCP | ||
| from fastmcp.client.client import CallToolResult | ||
| from fastmcp.client.transports import FastMCPTransport | ||
| from fastmcp.mcp_config import MCPServerTypes | ||
|
|
||
|
|
||
| FastMCPToolResult = messages.BinaryContent | dict[str, Any] | str | None | ||
|
|
||
| FastMCPToolResults = list[FastMCPToolResult] | FastMCPToolResult | ||
|
||
|
|
||
|
|
||
| class ToolErrorBehavior(str, Enum): | ||
|
||
| """The behavior to take when a tool error occurs.""" | ||
|
|
||
| MODEL_RETRY = 'model-retry' | ||
| """Raise a `ModelRetry` containing the tool error message.""" | ||
|
|
||
| ERROR = 'raise' | ||
| """Raise the tool error as an exception.""" | ||
|
|
||
|
|
||
| class FastMCPToolset(AbstractToolset[AgentDepsT]): | ||
strawgate marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| """A toolset that uses a FastMCP client as the underlying toolset.""" | ||
|
|
||
| _fastmcp_client: Client[Any] | ||
| _tool_error_behavior: ToolErrorBehavior | ||
|
||
|
|
||
| _tool_retries: int | ||
|
||
|
|
||
| _enter_lock: Lock | ||
| _running_count: int | ||
| _exit_stack: AsyncExitStack | None | ||
|
|
||
| def __init__( | ||
| self, fastmcp_client: Client[Any], tool_retries: int = 2, tool_error_behavior: ToolErrorBehavior | None = None | ||
|
||
| ): | ||
| """Build a new FastMCPToolset. | ||
| Args: | ||
| fastmcp_client: The FastMCP client to use. | ||
| tool_retries: The number of times to retry a tool call. | ||
| tool_error_behavior: The behavior to take when a tool error occurs. | ||
| """ | ||
| self._tool_retries = tool_retries | ||
| self._fastmcp_client = fastmcp_client | ||
| self._enter_lock = Lock() | ||
| self._running_count = 0 | ||
|
|
||
| self._tool_error_behavior = tool_error_behavior or ToolErrorBehavior.ERROR | ||
|
|
||
| super().__init__() | ||
|
|
||
| @property | ||
| def id(self) -> str | None: | ||
DouweM marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return None | ||
|
|
||
| async def __aenter__(self) -> Self: | ||
| async with self._enter_lock: | ||
| if self._running_count == 0 and self._fastmcp_client: | ||
| self._exit_stack = AsyncExitStack() | ||
| await self._exit_stack.enter_async_context(self._fastmcp_client) | ||
|
|
||
| self._running_count += 1 | ||
|
|
||
| return self | ||
|
|
||
| async def __aexit__(self, *args: Any) -> bool | None: | ||
| async with self._enter_lock: | ||
| self._running_count -= 1 | ||
| if self._running_count == 0 and self._exit_stack: | ||
| await self._exit_stack.aclose() | ||
| self._exit_stack = None | ||
|
|
||
| return None | ||
|
|
||
| async def get_tools(self, ctx: RunContext[AgentDepsT]) -> dict[str, ToolsetTool[AgentDepsT]]: | ||
| async with self: | ||
| mcp_tools: list[MCPTool] = await self._fastmcp_client.list_tools() | ||
|
|
||
| return { | ||
| tool.name: convert_mcp_tool_to_toolset_tool(toolset=self, mcp_tool=tool, retries=self._tool_retries) | ||
|
||
| for tool in mcp_tools | ||
| } | ||
|
|
||
| async def call_tool( | ||
| self, name: str, tool_args: dict[str, Any], ctx: RunContext[AgentDepsT], tool: ToolsetTool[AgentDepsT] | ||
| ) -> Any: | ||
| async with self: | ||
| try: | ||
| call_tool_result: CallToolResult = await self._fastmcp_client.call_tool(name=name, arguments=tool_args) | ||
| except ToolError as e: | ||
| if self._tool_error_behavior == ToolErrorBehavior.MODEL_RETRY: | ||
| raise ModelRetry(message=str(object=e)) from e | ||
strawgate marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| else: | ||
| raise e | ||
|
|
||
| # If any of the results are not text content, let's map them to Pydantic AI binary message parts | ||
| if any(not isinstance(part, TextContent) for part in call_tool_result.content): | ||
| return _map_fastmcp_tool_results(parts=call_tool_result.content) | ||
|
|
||
| # Otherwise, if we have structured content, return that | ||
| if call_tool_result.structured_content: | ||
strawgate marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return call_tool_result.structured_content | ||
|
|
||
| return _map_fastmcp_tool_results(parts=call_tool_result.content) | ||
strawgate marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| @classmethod | ||
| def from_fastmcp_server( | ||
| cls, fastmcp_server: FastMCP[Any], tool_error_behavior: ToolErrorBehavior | None = None | ||
|
||
| ) -> Self: | ||
| """Build a FastMCPToolset from a FastMCP server. | ||
| Example: | ||
| ```python | ||
| from fastmcp import FastMCP | ||
| from pydantic_ai.toolsets.fastmcp import FastMCPToolset | ||
| fastmcp_server = FastMCP('my_server') | ||
| @fastmcp_server.tool() | ||
| async def my_tool(a: int, b: int) -> int: | ||
| return a + b | ||
| FastMCPToolset.from_fastmcp_server(fastmcp_server=fastmcp_server) | ||
| ``` | ||
| """ | ||
| transport = FastMCPTransport(fastmcp_server) | ||
| fastmcp_client: Client[FastMCPTransport] = Client[FastMCPTransport](transport=transport) | ||
| return cls(fastmcp_client=fastmcp_client, tool_retries=2, tool_error_behavior=tool_error_behavior) | ||
strawgate marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| @classmethod | ||
| def from_mcp_server( | ||
| cls, | ||
| name: str, | ||
| mcp_server: MCPServerTypes | dict[str, Any], | ||
| tool_error_behavior: ToolErrorBehavior | None = None, | ||
strawgate marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ) -> Self: | ||
| """Build a FastMCPToolset from an individual MCP server configuration. | ||
| Example: | ||
| ```python | ||
| from pydantic_ai.toolsets.fastmcp import FastMCPToolset | ||
| time_mcp_server = { | ||
| 'command': 'uv', | ||
| 'args': ['run', 'mcp-run-python', 'stdio'], | ||
| } | ||
| FastMCPToolset.from_mcp_server(name='time_server', mcp_server=time_mcp_server) | ||
| ``` | ||
| """ | ||
| mcp_config: MCPConfig = MCPConfig.from_dict(config={name: mcp_server}) | ||
|
|
||
| return cls.from_mcp_config(mcp_config=mcp_config, tool_error_behavior=tool_error_behavior) | ||
|
|
||
| @classmethod | ||
| def from_mcp_config( | ||
| cls, mcp_config: MCPConfig | dict[str, Any], tool_error_behavior: ToolErrorBehavior | None = None | ||
strawgate marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ) -> Self: | ||
| """Build a FastMCPToolset from an MCP json-derived / dictionary configuration object. | ||
| Example: | ||
| ```python | ||
| from pydantic_ai.toolsets.fastmcp import FastMCPToolset | ||
| mcp_config = { | ||
| 'mcpServers': { | ||
| 'first_server': { | ||
| 'command': 'uv', | ||
| 'args': ['run', 'mcp-run-python', 'stdio'], | ||
| }, | ||
| 'second_server': { | ||
| 'command': 'uv', | ||
| 'args': ['run', 'mcp-run-python', 'stdio'], | ||
| } | ||
| } | ||
| } | ||
| FastMCPToolset.from_mcp_config(mcp_config) | ||
| ``` | ||
| """ | ||
| transport: MCPConfigTransport = MCPConfigTransport(config=mcp_config) | ||
| fastmcp_client: Client[MCPConfigTransport] = Client[MCPConfigTransport](transport=transport) | ||
| return cls(fastmcp_client=fastmcp_client, tool_retries=2, tool_error_behavior=tool_error_behavior) | ||
|
|
||
|
|
||
| def convert_mcp_tool_to_toolset_tool( | ||
| toolset: FastMCPToolset[AgentDepsT], | ||
| mcp_tool: MCPTool, | ||
| retries: int, | ||
| ) -> ToolsetTool[AgentDepsT]: | ||
| """Convert an MCP tool to a toolset tool.""" | ||
| return ToolsetTool[AgentDepsT]( | ||
| tool_def=ToolDefinition( | ||
strawgate marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| name=mcp_tool.name, | ||
| description=mcp_tool.description, | ||
| parameters_json_schema=mcp_tool.inputSchema, | ||
| ), | ||
| toolset=toolset, | ||
| max_retries=retries, | ||
| args_validator=TOOL_SCHEMA_VALIDATOR, | ||
| ) | ||
|
|
||
|
|
||
| def _map_fastmcp_tool_results(parts: list[ContentBlock]) -> list[FastMCPToolResult] | FastMCPToolResult: | ||
| """Map FastMCP tool results to toolset tool results.""" | ||
| mapped_results = [_map_fastmcp_tool_result(part) for part in parts] | ||
|
|
||
| if len(mapped_results) == 1: | ||
| return mapped_results[0] | ||
|
|
||
| return mapped_results | ||
|
|
||
|
|
||
| def _map_fastmcp_tool_result(part: ContentBlock) -> FastMCPToolResult: | ||
| if isinstance(part, TextContent): | ||
| return part.text | ||
|
|
||
| if isinstance(part, ImageContent): | ||
| return messages.BinaryContent(data=base64.b64decode(part.data), media_type=part.mimeType) | ||
|
|
||
| if isinstance(part, AudioContent): | ||
strawgate marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| return messages.BinaryContent(data=base64.b64decode(part.data), media_type=part.mimeType) | ||
|
|
||
| msg = f'Unsupported/Unknown content block type: {type(part)}' # pragma: no cover | ||
DouweM marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| raise ValueError(msg) # pragma: no cover | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note to self: before merging this, see if it makes sense to move this to a separate doc that can be listed in the "MCP" section in the sidebar.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I made some changes in this direction