-
Notifications
You must be signed in to change notification settings - Fork 3k
Add ergonomic Client class for testing MCP servers #1870
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
Changes from all commits
Commits
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
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
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,9 @@ | ||
| """MCP Client module.""" | ||
|
|
||
| from mcp.client.client import Client | ||
| from mcp.client.session import ClientSession | ||
|
|
||
| __all__ = [ | ||
| "Client", | ||
| "ClientSession", | ||
| ] |
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,97 @@ | ||
| """In-memory transport for testing MCP servers without network overhead.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from collections.abc import AsyncGenerator | ||
| from contextlib import asynccontextmanager | ||
| from typing import Any | ||
|
|
||
| import anyio | ||
| from anyio.streams.memory import MemoryObjectReceiveStream, MemoryObjectSendStream | ||
|
|
||
| from mcp.server import Server | ||
| from mcp.server.fastmcp import FastMCP | ||
| from mcp.shared.memory import create_client_server_memory_streams | ||
| from mcp.shared.message import SessionMessage | ||
|
|
||
|
|
||
| class InMemoryTransport: | ||
| """ | ||
| In-memory transport for testing MCP servers without network overhead. | ||
|
|
||
| This transport starts the server in a background task and provides | ||
| streams for client-side communication. The server is automatically | ||
| stopped when the context manager exits. | ||
|
|
||
| Example: | ||
| server = FastMCP("test") | ||
| transport = InMemoryTransport(server) | ||
|
|
||
| async with transport.connect() as (read_stream, write_stream): | ||
| async with ClientSession(read_stream, write_stream) as session: | ||
| await session.initialize() | ||
| # Use the session... | ||
|
|
||
| Or more commonly, use with Client: | ||
| async with Client(server) as client: | ||
| result = await client.call_tool("my_tool", {...}) | ||
| """ | ||
|
|
||
| def __init__( | ||
| self, | ||
| server: Server[Any] | FastMCP, | ||
| *, | ||
| raise_exceptions: bool = False, | ||
| ) -> None: | ||
| """ | ||
| Initialize the in-memory transport. | ||
|
|
||
| Args: | ||
| server: The MCP server to connect to (Server or FastMCP instance) | ||
| raise_exceptions: Whether to raise exceptions from the server | ||
| """ | ||
| self._server = server | ||
| self._raise_exceptions = raise_exceptions | ||
|
|
||
| @asynccontextmanager | ||
| async def connect( | ||
| self, | ||
| ) -> AsyncGenerator[ | ||
| tuple[ | ||
| MemoryObjectReceiveStream[SessionMessage | Exception], | ||
| MemoryObjectSendStream[SessionMessage], | ||
| ], | ||
| None, | ||
| ]: | ||
| """ | ||
| Connect to the server and return streams for communication. | ||
|
|
||
| Yields: | ||
| A tuple of (read_stream, write_stream) for bidirectional communication | ||
| """ | ||
| # Unwrap FastMCP to get underlying Server | ||
| actual_server: Server[Any] | ||
| if isinstance(self._server, FastMCP): | ||
| actual_server = self._server._mcp_server # type: ignore[reportPrivateUsage] | ||
| else: | ||
| actual_server = self._server | ||
|
|
||
| async with create_client_server_memory_streams() as (client_streams, server_streams): | ||
| client_read, client_write = client_streams | ||
| server_read, server_write = server_streams | ||
|
|
||
| async with anyio.create_task_group() as tg: | ||
| # Start server in background | ||
| tg.start_soon( | ||
| lambda: actual_server.run( | ||
| server_read, | ||
| server_write, | ||
| actual_server.create_initialization_options(), | ||
| raise_exceptions=self._raise_exceptions, | ||
| ) | ||
| ) | ||
|
|
||
| try: | ||
| yield client_read, client_write | ||
| finally: | ||
| tg.cancel_scope.cancel() | ||
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.