Message wrapper with metadata support.
This module defines a wrapper type that combines JSONRPCMessage with metadata
to support transport-specific features like resumability.
Metadata specific to client messages.
Source code in src/mcp/shared/message.py
| @dataclass
class ClientMessageMetadata:
"""Metadata specific to client messages."""
resumption_token: ResumptionToken | None = None
on_resumption_token_update: Callable[[ResumptionToken], Awaitable[None]] | None = None
# Per-message HTTP headers (e.g. MCP-Protocol-Version, Mcp-Method) the transport should set.
headers: dict[str, str] | None = None
|
Metadata specific to server messages.
Source code in src/mcp/shared/message.py
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47 | @dataclass
class ServerMessageMetadata:
"""Metadata specific to server messages."""
related_request_id: RequestId | None = None
# Transport-specific request context (e.g. starlette Request for HTTP
# transports, None for stdio). Typed as Any because the server layer is
# transport-agnostic.
request_context: Any = None
# Callback to close SSE stream for the current request without terminating
close_sse_stream: CloseSSEStreamCallback | None = None
# Callback to close the standalone GET SSE stream (for unsolicited notifications)
close_standalone_sse_stream: CloseSSEStreamCallback | None = None
# Callback the dispatcher runs when this request settles without a response
# (e.g. it was cancelled), for a transport whose wire must still end the
# request even though no response is written.
on_request_unanswered: Callable[[], Awaitable[None]] | None = None
|
SessionMessage
dataclass
A message with specific metadata for transport-specific features.
Source code in src/mcp/shared/message.py
| @dataclass
class SessionMessage:
"""A message with specific metadata for transport-specific features."""
message: JSONRPCMessage
metadata: MessageMetadata = None
|