-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Add MCP proxy helper #2388
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
Draft
Kludex
wants to merge
4
commits into
main
Choose a base branch
from
fix/mcp-proxy-review-comments
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Add MCP proxy helper #2388
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| """Provide utilities for proxying messages between two MCP transports.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import inspect | ||
| from collections.abc import AsyncGenerator, Awaitable, Callable | ||
| from contextlib import asynccontextmanager | ||
|
|
||
| import anyio | ||
|
|
||
| from mcp.shared._stream_protocols import ReadStream, WriteStream | ||
| from mcp.shared.message import SessionMessage | ||
|
|
||
| MessageStream = tuple[ReadStream[SessionMessage | Exception], WriteStream[SessionMessage]] | ||
| ErrorHandler = Callable[[Exception], None | Awaitable[None]] | ||
|
|
||
|
|
||
| @asynccontextmanager | ||
| async def mcp_proxy( | ||
| transport_to_client: MessageStream, | ||
| transport_to_server: MessageStream, | ||
| on_error: ErrorHandler | None = None, | ||
| ) -> AsyncGenerator[None]: | ||
| """Proxy messages bidirectionally between two MCP transports.""" | ||
| client_read, client_write = transport_to_client | ||
| server_read, server_write = transport_to_server | ||
|
|
||
| async with anyio.create_task_group() as task_group: | ||
| task_group.start_soon(_forward_messages, client_read, server_write, on_error) | ||
| task_group.start_soon(_forward_messages, server_read, client_write, on_error) | ||
| try: | ||
| yield | ||
| finally: | ||
| task_group.cancel_scope.cancel() | ||
|
|
||
|
|
||
| async def _forward_messages( | ||
| read_stream: ReadStream[SessionMessage | Exception], | ||
| write_stream: WriteStream[SessionMessage], | ||
| on_error: ErrorHandler | None, | ||
| ) -> None: | ||
| try: | ||
| async with write_stream: | ||
| async with read_stream: | ||
| async for item in read_stream: | ||
| if isinstance(item, Exception): | ||
| await _run_error_handler(item, on_error) | ||
| continue | ||
|
|
||
| try: | ||
| await write_stream.send(item) | ||
| except anyio.ClosedResourceError: | ||
| break | ||
| except anyio.ClosedResourceError: | ||
| return | ||
|
|
||
|
|
||
| async def _run_error_handler(error: Exception, on_error: ErrorHandler | None) -> None: | ||
| if on_error is None: | ||
| return | ||
|
|
||
| try: | ||
| result = on_error(error) | ||
| if inspect.isawaitable(result): | ||
| await result | ||
| except Exception: | ||
| return | ||
|
Comment on lines
+93
to
+99
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we have an internal function somewhere to see if it's coroutine or awaitable. Please use that, and we should use |
||
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,298 @@ | ||
| from __future__ import annotations | ||
|
|
||
| from types import TracebackType | ||
|
|
||
| import anyio | ||
| import pytest | ||
|
|
||
| from mcp.proxy import mcp_proxy | ||
| from mcp.shared.message import SessionMessage | ||
| from mcp.types import JSONRPCRequest | ||
|
|
||
|
|
||
| def make_message(request_id: str, method: str) -> SessionMessage: | ||
| return SessionMessage(JSONRPCRequest(jsonrpc="2.0", id=request_id, method=method, params={})) | ||
|
|
||
|
|
||
| def assert_request(message: SessionMessage, request_id: str, method: str) -> None: | ||
| assert isinstance(message.message, JSONRPCRequest) | ||
| assert message.message.id == request_id | ||
| assert message.message.method == method | ||
|
|
||
|
|
||
| class StaticReadStream: | ||
| def __init__(self, *items: SessionMessage | Exception, error: Exception | None = None) -> None: | ||
| self._items = list(items) | ||
| self._error = error | ||
| self.closed = False | ||
|
|
||
| async def receive(self) -> SessionMessage | Exception: | ||
| try: | ||
| return await self.__anext__() | ||
| except StopAsyncIteration as exc: | ||
| raise anyio.EndOfStream from exc | ||
|
|
||
| async def aclose(self) -> None: | ||
| self.closed = True | ||
|
|
||
| def __aiter__(self) -> StaticReadStream: | ||
| return self | ||
|
|
||
| async def __anext__(self) -> SessionMessage | Exception: | ||
| if self._items: | ||
| return self._items.pop(0) | ||
| if self._error is not None: | ||
| error = self._error | ||
| self._error = None | ||
| raise error | ||
| raise StopAsyncIteration | ||
|
|
||
| async def __aenter__(self) -> StaticReadStream: | ||
| return self | ||
|
|
||
| async def __aexit__( | ||
| self, | ||
| exc_type: type[BaseException] | None, | ||
| exc_val: BaseException | None, | ||
| exc_tb: TracebackType | None, | ||
| ) -> bool | None: | ||
| await self.aclose() | ||
| return None | ||
|
|
||
|
|
||
| class TrackingWriteStream: | ||
| def __init__(self, error: Exception | None = None) -> None: | ||
| self.items: list[SessionMessage] = [] | ||
| self.error = error | ||
| self.closed = anyio.Event() | ||
|
|
||
| async def send(self, item: SessionMessage, /) -> None: | ||
| if self.error is not None: | ||
| raise self.error | ||
| self.items.append(item) | ||
|
|
||
| async def aclose(self) -> None: | ||
| self.closed.set() | ||
|
|
||
| async def __aenter__(self) -> TrackingWriteStream: | ||
| return self | ||
|
|
||
| async def __aexit__( | ||
| self, | ||
| exc_type: type[BaseException] | None, | ||
| exc_val: BaseException | None, | ||
| exc_tb: TracebackType | None, | ||
| ) -> bool | None: | ||
| await self.aclose() | ||
| return None | ||
|
|
||
|
|
||
| @pytest.mark.anyio | ||
| async def test_proxy_forwards_messages_bidirectionally() -> None: | ||
| client_read_send, client_read = anyio.create_memory_object_stream[SessionMessage | Exception](1) | ||
| client_write, client_write_read = anyio.create_memory_object_stream[SessionMessage](1) | ||
| server_read_send, server_read = anyio.create_memory_object_stream[SessionMessage | Exception](1) | ||
| server_write, server_write_read = anyio.create_memory_object_stream[SessionMessage](1) | ||
|
|
||
| async with ( | ||
| client_read_send, | ||
| client_read, | ||
| client_write, | ||
| client_write_read, | ||
| server_read_send, | ||
| server_read, | ||
| server_write, | ||
| server_write_read, | ||
| ): | ||
| async with mcp_proxy((client_read, client_write), (server_read, server_write)): | ||
| await client_read_send.send(make_message("client", "client/method")) | ||
| await server_read_send.send(make_message("server", "server/method")) | ||
|
|
||
| assert_request(await server_write_read.receive(), "client", "client/method") | ||
| assert_request(await client_write_read.receive(), "server", "server/method") | ||
|
|
||
|
|
||
| @pytest.mark.anyio | ||
| async def test_proxy_calls_sync_error_handler_and_continues() -> None: | ||
| errors: list[Exception] = [] | ||
| handled = anyio.Event() | ||
|
|
||
| def on_error(error: Exception) -> None: | ||
| errors.append(error) | ||
| handled.set() | ||
|
|
||
| client_read_send, client_read = anyio.create_memory_object_stream[SessionMessage | Exception](1) | ||
| client_write, _client_write_read = anyio.create_memory_object_stream[SessionMessage](1) | ||
| server_read_send, server_read = anyio.create_memory_object_stream[SessionMessage | Exception](1) | ||
| server_write, server_write_read = anyio.create_memory_object_stream[SessionMessage](1) | ||
|
|
||
| async with ( | ||
| client_read_send, | ||
| client_read, | ||
| client_write, | ||
| _client_write_read, | ||
| server_read_send, | ||
| server_read, | ||
| server_write, | ||
| server_write_read, | ||
| ): | ||
| async with mcp_proxy((client_read, client_write), (server_read, server_write), on_error=on_error): | ||
| await client_read_send.send(ValueError("boom")) | ||
| await handled.wait() | ||
| await client_read_send.send(make_message("after-error", "client/method")) | ||
|
|
||
| assert len(errors) == 1 | ||
| assert isinstance(errors[0], ValueError) | ||
| assert str(errors[0]) == "boom" | ||
| assert_request(await server_write_read.receive(), "after-error", "client/method") | ||
|
|
||
|
|
||
| @pytest.mark.anyio | ||
| async def test_proxy_calls_async_error_handler() -> None: | ||
| errors: list[Exception] = [] | ||
| handled = anyio.Event() | ||
|
|
||
| async def on_error(error: Exception) -> None: | ||
| errors.append(error) | ||
| handled.set() | ||
|
|
||
| client_read_send, client_read = anyio.create_memory_object_stream[SessionMessage | Exception](1) | ||
| client_write, _client_write_read = anyio.create_memory_object_stream[SessionMessage](1) | ||
| server_read_send, server_read = anyio.create_memory_object_stream[SessionMessage | Exception](1) | ||
| server_write, _server_write_read = anyio.create_memory_object_stream[SessionMessage](1) | ||
|
|
||
| async with ( | ||
| client_read_send, | ||
| client_read, | ||
| client_write, | ||
| _client_write_read, | ||
| server_read_send, | ||
| server_read, | ||
| server_write, | ||
| _server_write_read, | ||
| ): | ||
| async with mcp_proxy((client_read, client_write), (server_read, server_write), on_error=on_error): | ||
| await client_read_send.send(ValueError("async-boom")) | ||
| await handled.wait() | ||
|
|
||
| assert len(errors) == 1 | ||
| assert isinstance(errors[0], ValueError) | ||
| assert str(errors[0]) == "async-boom" | ||
|
|
||
|
|
||
| @pytest.mark.anyio | ||
| async def test_proxy_ignores_sync_error_handler_failures() -> None: | ||
| def on_error(error: Exception) -> None: | ||
| raise RuntimeError(f"handler failed for {error}") | ||
|
|
||
| client_read_send, client_read = anyio.create_memory_object_stream[SessionMessage | Exception](1) | ||
| client_write, _client_write_read = anyio.create_memory_object_stream[SessionMessage](1) | ||
| server_read_send, server_read = anyio.create_memory_object_stream[SessionMessage | Exception](1) | ||
| server_write, server_write_read = anyio.create_memory_object_stream[SessionMessage](1) | ||
|
|
||
| async with ( | ||
| client_read_send, | ||
| client_read, | ||
| client_write, | ||
| _client_write_read, | ||
| server_read_send, | ||
| server_read, | ||
| server_write, | ||
| server_write_read, | ||
| ): | ||
| async with mcp_proxy((client_read, client_write), (server_read, server_write), on_error=on_error): | ||
| await client_read_send.send(ValueError("boom")) | ||
| await client_read_send.send(make_message("after-sync-handler-error", "client/method")) | ||
| assert_request(await server_write_read.receive(), "after-sync-handler-error", "client/method") | ||
|
|
||
|
|
||
| @pytest.mark.anyio | ||
| async def test_proxy_ignores_async_error_handler_failures() -> None: | ||
| async def on_error(error: Exception) -> None: | ||
| raise RuntimeError(f"handler failed for {error}") | ||
|
|
||
| client_read_send, client_read = anyio.create_memory_object_stream[SessionMessage | Exception](1) | ||
| client_write, _client_write_read = anyio.create_memory_object_stream[SessionMessage](1) | ||
| server_read_send, server_read = anyio.create_memory_object_stream[SessionMessage | Exception](1) | ||
| server_write, server_write_read = anyio.create_memory_object_stream[SessionMessage](1) | ||
|
|
||
| async with ( | ||
| client_read_send, | ||
| client_read, | ||
| client_write, | ||
| _client_write_read, | ||
| server_read_send, | ||
| server_read, | ||
| server_write, | ||
| server_write_read, | ||
| ): | ||
| async with mcp_proxy((client_read, client_write), (server_read, server_write), on_error=on_error): | ||
| await client_read_send.send(ValueError("boom")) | ||
| await client_read_send.send(make_message("after-async-handler-error", "client/method")) | ||
| assert_request(await server_write_read.receive(), "after-async-handler-error", "client/method") | ||
|
|
||
|
|
||
| @pytest.mark.anyio | ||
| async def test_proxy_continues_without_error_handler() -> None: | ||
| client_read_send, client_read = anyio.create_memory_object_stream[SessionMessage | Exception](1) | ||
| client_write, _client_write_read = anyio.create_memory_object_stream[SessionMessage](1) | ||
| server_read_send, server_read = anyio.create_memory_object_stream[SessionMessage | Exception](1) | ||
| server_write, server_write_read = anyio.create_memory_object_stream[SessionMessage](1) | ||
|
|
||
| async with ( | ||
| client_read_send, | ||
| client_read, | ||
| client_write, | ||
| _client_write_read, | ||
| server_read_send, | ||
| server_read, | ||
| server_write, | ||
| server_write_read, | ||
| ): | ||
| async with mcp_proxy((client_read, client_write), (server_read, server_write)): | ||
| await client_read_send.send(ValueError("boom")) | ||
| await client_read_send.send(make_message("after-no-handler", "client/method")) | ||
| assert_request(await server_write_read.receive(), "after-no-handler", "client/method") | ||
|
|
||
|
|
||
| @pytest.mark.anyio | ||
| async def test_proxy_stops_forwarding_when_target_stream_is_closed() -> None: | ||
| server_write = TrackingWriteStream(anyio.ClosedResourceError()) | ||
| client_write = TrackingWriteStream() | ||
|
|
||
| async with mcp_proxy( | ||
| (StaticReadStream(make_message("client", "client/method")), server_write), | ||
| (StaticReadStream(), client_write), | ||
| ): | ||
| await server_write.closed.wait() | ||
|
|
||
| assert server_write.items == [] | ||
| assert server_write.closed.is_set() | ||
| assert client_write.closed.is_set() | ||
|
|
||
|
|
||
| @pytest.mark.anyio | ||
| async def test_proxy_closes_target_stream_when_source_stream_is_closed() -> None: | ||
| server_write = TrackingWriteStream() | ||
| client_write = TrackingWriteStream() | ||
|
|
||
| async with mcp_proxy((StaticReadStream(), server_write), (StaticReadStream(), client_write)): | ||
| await server_write.closed.wait() | ||
| await client_write.closed.wait() | ||
|
|
||
| assert server_write.items == [] | ||
| assert client_write.items == [] | ||
|
|
||
|
|
||
| @pytest.mark.anyio | ||
| async def test_proxy_handles_closed_resource_error_from_source_stream() -> None: | ||
| server_write = TrackingWriteStream() | ||
| client_write = TrackingWriteStream() | ||
|
|
||
| async with mcp_proxy( | ||
| (StaticReadStream(error=anyio.ClosedResourceError()), server_write), | ||
| (StaticReadStream(), client_write), | ||
| ): | ||
| await server_write.closed.wait() | ||
|
|
||
| assert server_write.items == [] |
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.
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.