-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Merged
Merged
Add FastMCPToolset #2784
Changes from all commits
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
cffc38f
Add FastMCP Toolset w/o tests
strawgate 456900e
Adding tests
strawgate 9bac437
PR Clean-up and coverage
strawgate 1cf320e
Merge branch 'main' into fastmcp-toolset
strawgate edd89f2
Fix import
strawgate 9c4fe38
Fix module import error
strawgate a46222f
Merge branch 'main' into fastmcp-toolset
strawgate 27592c7
Trying to fix tests
strawgate 0362fd7
Lint
strawgate eaa45c8
Merge branch 'main' into fastmcp-toolset
strawgate 4bd0334
Address most PR Feedback
strawgate 533e879
Merge branch 'main' into fastmcp-toolset
strawgate f2be96d
Address PR Feedback
strawgate 0fd6929
Merge branch 'main' into fastmcp-toolset
strawgate 881f306
Merge branch 'main' into fastmcp-toolset
strawgate dfcad61
Address PR Feedback
strawgate 8776a67
add't updates
strawgate a171272
Add transport tests
strawgate 6ea1dd3
Simplify init creation
strawgate 81d004d
Update lock
strawgate 880f355
Merge remote-tracking branch 'origin/main' into fastmcp-toolset
strawgate aade6d5
Remove accidental test file commit
strawgate 8baad2d
Merge branch 'main' into fastmcp-toolset
strawgate 31a3179
Updates to docs and tests
strawgate 1c3b9e2
Merge branch 'main' into fastmcp-toolset
strawgate cc559d7
Fix test when package is not installed
strawgate 623524b
lint
strawgate 3766ba8
fix coverage test
strawgate e46bafc
Merge branch 'main' into fastmcp-toolset
strawgate 71ab5ad
Merge branch 'main' into fastmcp-toolset
strawgate 99c5042
Merge branch 'main' into fastmcp-toolset
DouweM 34d36b9
Merge branch 'main' into pr/strawgate/2784
DouweM 1b3e0fe
simplification
DouweM File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,3 +14,5 @@ | |
| - PreparedToolset | ||
| - WrapperToolset | ||
| - ToolsetFunc | ||
|
|
||
| ::: pydantic_ai.toolsets.fastmcp | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| # FastMCP Client | ||
|
|
||
| [FastMCP](https://gofastmcp.com/) is a higher-level MCP framework that bills itself as "The fast, Pythonic way to build MCP servers and clients." It supports additional capabilities on top of the MCP specification like [Tool Transformation](https://gofastmcp.com/patterns/tool-transformation), [OAuth](https://gofastmcp.com/clients/auth/oauth), and more. | ||
|
|
||
| As an alternative to Pydantic AI's standard [`MCPServer` MCP client](client.md) built on the [MCP SDK](https://github.com/modelcontextprotocol/python-sdk), you can use the [`FastMCPToolset`][pydantic_ai.toolsets.fastmcp.FastMCPToolset] [toolset](../toolsets.md) that leverages the [FastMCP Client](https://gofastmcp.com/clients/) to connect to local and remote MCP servers, whether or not they're built using [FastMCP Server](https://gofastmcp.com/servers/). | ||
|
|
||
| Note that it does not yet support integration elicitation or sampling, which are supported by the [standard `MCPServer` client](client.md). | ||
|
|
||
| ## Install | ||
|
|
||
| To use the `FastMCPToolset`, you will need to install [`pydantic-ai-slim`](../install.md#slim-install) with the `fastmcp` optional group: | ||
|
|
||
| ```bash | ||
| pip/uv-add "pydantic-ai-slim[fastmcp]" | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| A `FastMCPToolset` can then be created from: | ||
|
|
||
| - A FastMCP Server: `#!python FastMCPToolset(fastmcp.FastMCP('my_server'))` | ||
| - A FastMCP Client: `#!python FastMCPToolset(fastmcp.Client(...))` | ||
| - A FastMCP Transport: `#!python FastMCPToolset(fastmcp.StdioTransport(command='uvx', args=['mcp-run-python', 'stdio']))` | ||
| - A Streamable HTTP URL: `#!python FastMCPToolset('http://localhost:8000/mcp')` | ||
| - An HTTP SSE URL: `#!python FastMCPToolset('http://localhost:8000/sse')` | ||
| - A Python Script: `#!python FastMCPToolset('my_server.py')` | ||
| - A Node.js Script: `#!python FastMCPToolset('my_server.js')` | ||
| - A JSON MCP Configuration: `#!python FastMCPToolset({'mcpServers': {'my_server': {'command': 'uvx', 'args': ['mcp-run-python', 'stdio']}}})` | ||
|
|
||
| If you already have a [FastMCP Server](https://gofastmcp.com/servers) in the same codebase as your Pydantic AI agent, you can create a `FastMCPToolset` directly from it and save agent a network round trip: | ||
|
|
||
| ```python | ||
| from fastmcp import FastMCP | ||
|
|
||
| from pydantic_ai import Agent | ||
| from pydantic_ai.toolsets.fastmcp import FastMCPToolset | ||
|
|
||
| fastmcp_server = FastMCP('my_server') | ||
| @fastmcp_server.tool() | ||
| async def add(a: int, b: int) -> int: | ||
| return a + b | ||
|
|
||
| toolset = FastMCPToolset(fastmcp_server) | ||
|
|
||
| agent = Agent('openai:gpt-5', toolsets=[toolset]) | ||
|
|
||
| async def main(): | ||
| result = await agent.run('What is 7 plus 5?') | ||
| print(result.output) | ||
| #> The answer is 12. | ||
| ``` | ||
|
|
||
| _(This example is complete, it can be run "as is" — you'll need to add `asyncio.run(main())` to run `main`)_ | ||
|
|
||
| Connecting your agent to a Streamable HTTP MCP Server is as simple as: | ||
|
|
||
| ```python | ||
| from pydantic_ai import Agent | ||
| from pydantic_ai.toolsets.fastmcp import FastMCPToolset | ||
|
|
||
| toolset = FastMCPToolset('http://localhost:8000/mcp') | ||
|
|
||
| agent = Agent('openai:gpt-5', toolsets=[toolset]) | ||
| ``` | ||
|
|
||
| _(This example is complete, it can be run "as is" — you'll need to add `asyncio.run(main())` to run `main`)_ | ||
|
|
||
| You can also create a `FastMCPToolset` from a JSON MCP Configuration: | ||
|
|
||
| ```python | ||
| from pydantic_ai import Agent | ||
| from pydantic_ai.toolsets.fastmcp import FastMCPToolset | ||
|
|
||
| mcp_config = { | ||
| 'mcpServers': { | ||
| 'time_mcp_server': { | ||
| 'command': 'uvx', | ||
| 'args': ['mcp-run-python', 'stdio'] | ||
| } | ||
| } | ||
| } | ||
|
|
||
| toolset = FastMCPToolset(mcp_config) | ||
|
|
||
| agent = Agent('openai:gpt-5', toolsets=[toolset]) | ||
| ``` | ||
|
|
||
| _(This example is complete, it can be run "as is" — you'll need to add `asyncio.run(main())` to run `main`)_ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,215 @@ | ||
| from __future__ import annotations | ||
|
|
||
| import base64 | ||
| from asyncio import Lock | ||
| from contextlib import AsyncExitStack | ||
| from dataclasses import KW_ONLY, dataclass | ||
| from pathlib import Path | ||
| from typing import TYPE_CHECKING, Any, Literal | ||
|
|
||
| from pydantic import AnyUrl | ||
| from typing_extensions import Self, assert_never | ||
|
|
||
| from pydantic_ai import messages | ||
| from pydantic_ai.exceptions import ModelRetry | ||
| 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 ClientTransport | ||
| from fastmcp.exceptions import ToolError | ||
| from fastmcp.mcp_config import MCPConfig | ||
| from fastmcp.server import FastMCP | ||
| from mcp.server.fastmcp import FastMCP as FastMCP1Server | ||
| from mcp.types import ( | ||
| AudioContent, | ||
| BlobResourceContents, | ||
| ContentBlock, | ||
| EmbeddedResource, | ||
| ImageContent, | ||
| ResourceLink, | ||
| TextContent, | ||
| TextResourceContents, | ||
| Tool as MCPTool, | ||
| ) | ||
|
|
||
| from pydantic_ai.mcp import TOOL_SCHEMA_VALIDATOR | ||
|
|
||
| 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.client.client import CallToolResult | ||
|
|
||
|
|
||
| FastMCPToolResult = messages.BinaryContent | dict[str, Any] | str | None | ||
|
|
||
| ToolErrorBehavior = Literal['model_retry', 'error'] | ||
|
|
||
| UNKNOWN_BINARY_MEDIA_TYPE = 'application/octet-stream' | ||
|
|
||
|
|
||
| @dataclass(init=False) | ||
| class FastMCPToolset(AbstractToolset[AgentDepsT]): | ||
| """A FastMCP Toolset that uses the FastMCP Client to call tools from a local or remote MCP Server. | ||
|
|
||
| The Toolset can accept a FastMCP Client, a FastMCP Transport, or any other object which a FastMCP Transport can be created from. | ||
|
|
||
| See https://gofastmcp.com/clients/transports for a full list of transports available. | ||
| """ | ||
|
|
||
| client: Client[Any] | ||
| """The FastMCP client to use.""" | ||
|
|
||
| _: KW_ONLY | ||
|
|
||
| tool_error_behavior: Literal['model_retry', 'error'] | ||
| """The behavior to take when a tool error occurs.""" | ||
|
|
||
| max_retries: int | ||
| """The maximum number of retries to attempt if a tool call fails.""" | ||
|
|
||
| _id: str | None | ||
|
|
||
| def __init__( | ||
| self, | ||
| client: Client[Any] | ||
| | ClientTransport | ||
| | FastMCP | ||
| | FastMCP1Server | ||
| | AnyUrl | ||
| | Path | ||
| | MCPConfig | ||
| | dict[str, Any] | ||
| | str, | ||
| *, | ||
| max_retries: int = 1, | ||
| tool_error_behavior: Literal['model_retry', 'error'] = 'model_retry', | ||
| id: str | None = None, | ||
| ) -> None: | ||
| if isinstance(client, Client): | ||
| self.client = client | ||
| else: | ||
| self.client = Client[Any](transport=client) | ||
|
|
||
| self._id = id | ||
| self.max_retries = max_retries | ||
| self.tool_error_behavior = tool_error_behavior | ||
|
|
||
| self._enter_lock: Lock = Lock() | ||
| self._running_count: int = 0 | ||
| self._exit_stack: AsyncExitStack | None = None | ||
|
|
||
| @property | ||
| def id(self) -> str | None: | ||
DouweM marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return self._id | ||
|
|
||
| async def __aenter__(self) -> Self: | ||
| async with self._enter_lock: | ||
| if self._running_count == 0: | ||
| self._exit_stack = AsyncExitStack() | ||
| await self._exit_stack.enter_async_context(self.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.client.list_tools() | ||
|
|
||
| return { | ||
| tool.name: _convert_mcp_tool_to_toolset_tool(toolset=self, mcp_tool=tool, retries=self.max_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.client.call_tool(name=name, arguments=tool_args) | ||
| except ToolError as e: | ||
| if self.tool_error_behavior == 'model_retry': | ||
| raise ModelRetry(message=str(e)) from e | ||
| else: | ||
| raise e | ||
|
|
||
| # 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 | ||
|
|
||
| # Otherwise, return the content | ||
| return _map_fastmcp_tool_results(parts=call_tool_result.content) | ||
|
|
||
|
|
||
| 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, | ||
| metadata={ | ||
| 'meta': mcp_tool.meta, | ||
| 'annotations': mcp_tool.annotations.model_dump() if mcp_tool.annotations else None, | ||
| 'output_schema': mcp_tool.outputSchema or None, | ||
| }, | ||
| ), | ||
| 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 | ||
| elif isinstance(part, ImageContent | AudioContent): | ||
| return messages.BinaryContent(data=base64.b64decode(part.data), media_type=part.mimeType) | ||
| elif isinstance(part, EmbeddedResource): | ||
| if isinstance(part.resource, BlobResourceContents): | ||
| return messages.BinaryContent( | ||
| data=base64.b64decode(part.resource.blob), | ||
| media_type=part.resource.mimeType or UNKNOWN_BINARY_MEDIA_TYPE, | ||
| ) | ||
| elif isinstance(part.resource, TextResourceContents): | ||
| return part.resource.text | ||
| else: | ||
| assert_never(part.resource) | ||
| elif isinstance(part, ResourceLink): | ||
| # ResourceLink is not yet supported by the FastMCP toolset as reading resources is not yet supported. | ||
| raise NotImplementedError( | ||
| 'ResourceLink is not supported by the FastMCP toolset as reading resources is not yet supported.' | ||
| ) | ||
| else: | ||
| assert_never(part) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.