FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

fix: make MCPError subclasses pickle-safe by mturac · Pull Request #3407 · modelcontextprotocol/python-sdk · GitHub

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .py  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
14 changes: 14 additions & 0 deletions src/mcp/shared/exceptions.py
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
Expand Up @@ -70,6 +70,10 @@ def __init__(self, method: str):
)
self.method = method

def __reduce__(self) -> tuple[Any, ...]:
"""Return a pickling recipe that preserves the original method argument."""
return (self.__class__, (self.method,))


class UrlElicitationRequiredError(MCPError):
"""Specialized error for when a tool requires URL mode elicitation(s) before proceeding.
Expand Down Expand Up @@ -117,3 +121,13 @@ def from_error(cls, error: ErrorData) -> UrlElicitationRequiredError:
raw_elicitations = cast(list[dict[str, Any]], data.get("elicitations", []))
elicitations = [ElicitRequestURLParams.model_validate(e) for e in raw_elicitations]
return cls(elicitations, error.message)

def __reduce__(self) -> tuple[Any, ...]:
"""Return a pickling recipe that uses the existing wire-roundtrip constructor.

Without this, unpickling tries ``UrlElicitationRequiredError(*self.args)``,
where ``args`` contains ``(code, message, data)`` from ``MCPError``. That
does not match this class's ``(elicitations, message)`` signature and
raises ``TypeError``.
"""
return (self.from_error, (self.error,))
78 changes: 77 additions & 1 deletion tests/shared/test_exceptions.py
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
@@ -1,9 +1,11 @@
"""Tests for MCP exception classes."""

import pickle

import pytest
from mcp_types import URL_ELICITATION_REQUIRED, ElicitRequestURLParams, ErrorData, JSONRPCError

from mcp.shared.exceptions import MCPError, UrlElicitationRequiredError
from mcp.shared.exceptions import MCPError, NoBackChannelError, UrlElicitationRequiredError


def test_url_elicitation_required_error_create_with_single_elicitation() -> None:
Expand Down Expand Up @@ -173,3 +175,77 @@ def test_from_jsonrpc_error_preserves_code_message_and_data() -> None:
)
error = MCPError.from_jsonrpc_error(wire)
assert error.error == ErrorData(code=URL_ELICITATION_REQUIRED, message="go elsewhere", data={"hint": "y"})


def test_mcp_error_pickle_roundtrip() -> None:
"""MCPError survives a pickle.dumps/loads round-trip with its ErrorData intact."""
original = MCPError.from_error_data(
ErrorData(code=-32600, message="Authentication Required", data={"hint": "x"})
)

restored = pickle.loads(pickle.dumps(original))

assert isinstance(restored, MCPError)
assert restored.error == original.error
assert str(restored) == str(original)


@pytest.mark.parametrize(
"elicitations,message",
[
(
[
ElicitRequestURLParams(
mode="url",
message="Auth required",
url="https://example.com/auth",
elicitation_id="test-123",
)
],
None,
),
(
[
ElicitRequestURLParams(
mode="url",
message="Auth 1",
url="https://example.com/auth1",
elicitation_id="test-1",
),
ElicitRequestURLParams(
mode="url",
message="Auth 2",
url="https://example.com/auth2",
elicitation_id="test-2",
),
],
"Custom message",
),
],
)
def test_url_elicitation_required_error_pickle_roundtrip(
elicitations: list[ElicitRequestURLParams], message: str | None
) -> None:
"""UrlElicitationRequiredError round-trips through pickle without constructor mismatch."""
original = UrlElicitationRequiredError(elicitations, message=message)

restored = pickle.loads(pickle.dumps(original))

assert isinstance(restored, UrlElicitationRequiredError)
assert restored.error == original.error
assert str(restored) == str(original)
assert [e.elicitation_id for e in restored.elicitations] == [
e.elicitation_id for e in original.elicitations
]


def test_no_back_channel_error_pickle_roundtrip() -> None:
"""NoBackChannelError round-trips through pickle with the method intact."""
original = NoBackChannelError("test/method")

restored = pickle.loads(pickle.dumps(original))

assert isinstance(restored, NoBackChannelError)
assert restored.method == original.method
assert restored.error == original.error
assert str(restored) == str(original)
Loading

Back | FazBrowse Home | New Git URL