forked from modelcontextprotocol/python-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpeer.py
More file actions
216 lines (189 loc) · 8.25 KB
/
peer.py
File metadata and controls
216 lines (189 loc) · 8.25 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
"""Typed MCP request sugar over an `Outbound`.
`ClientPeer` wraps any `Outbound` (anything with `send_raw_request` and
`notify`) and exposes the server-to-client request methods (sampling,
elicitation, roots, ping) as typed methods.
`ClientPeer` does no capability gating: it builds the params, calls
`send_raw_request(method, params)`, and parses the result into the typed
model. Gating (and `NoBackChannelError`) is the wrapped `Outbound`'s job.
"""
from collections.abc import Mapping
from typing import Any, cast, overload
from pydantic import BaseModel
from mcp.shared.dispatcher import CallOptions, Outbound
from mcp.types import (
CreateMessageRequestParams,
CreateMessageResult,
CreateMessageResultWithTools,
ElicitRequestedSchema,
ElicitRequestFormParams,
ElicitRequestURLParams,
ElicitResult,
IncludeContext,
ListRootsResult,
ModelPreferences,
RequestParams,
RequestParamsMeta,
SamplingMessage,
Tool,
ToolChoice,
)
__all__ = ["ClientPeer", "Meta"]
Meta = dict[str, Any]
"""Type alias for the `_meta` field carried on request/notification params."""
def dump_params(model: BaseModel | None, meta: Meta | None = None) -> dict[str, Any] | None:
"""Serialize a params model to a wire dict, merging `meta` into `_meta`.
Shared by `ClientPeer` and `Connection` so every typed convenience method
gets the same `_meta` handling. `meta` keys take precedence over any
`_meta` already present on the model.
`meta` is serialized through `RequestParams` so Python field names emit
their wire aliases: an inbound `ctx.meta` carries `progress_token` (the
key `_extract_meta` validation produces), and forwarding it outbound via
`meta=ctx.meta` must put `progressToken` back on the wire. Keys not
declared on `RequestParamsMeta` pass through unchanged.
"""
out = model.model_dump(by_alias=True, mode="json", exclude_none=True) if model is not None else None
if meta:
wire_meta = RequestParams(_meta=cast(RequestParamsMeta, meta)).model_dump(by_alias=True, mode="json")["_meta"]
out = dict(out or {})
out["_meta"] = {**out.get("_meta", {}), **wire_meta}
return out
class ClientPeer:
"""Typed server-to-client request methods over a wrapped `Outbound`.
Use this when you have a bare dispatcher (or any `Outbound`) and want the
typed methods (`sample`, `elicit_form`, `elicit_url`, `list_roots`,
`ping`) without writing your own host class.
"""
def __init__(self, outbound: Outbound) -> None:
self._outbound = outbound
async def send_raw_request(
self,
method: str,
params: Mapping[str, Any] | None,
opts: CallOptions | None = None,
) -> dict[str, Any]:
return await self._outbound.send_raw_request(method, params, opts)
async def notify(self, method: str, params: Mapping[str, Any] | None) -> None:
await self._outbound.notify(method, params)
@overload
async def sample(
self,
messages: list[SamplingMessage],
*,
max_tokens: int,
system_prompt: str | None = None,
include_context: IncludeContext | None = None,
temperature: float | None = None,
stop_sequences: list[str] | None = None,
metadata: dict[str, Any] | None = None,
model_preferences: ModelPreferences | None = None,
tools: None = None,
tool_choice: ToolChoice | None = None,
meta: Meta | None = None,
opts: CallOptions | None = None,
) -> CreateMessageResult: ...
@overload
async def sample(
self,
messages: list[SamplingMessage],
*,
max_tokens: int,
system_prompt: str | None = None,
include_context: IncludeContext | None = None,
temperature: float | None = None,
stop_sequences: list[str] | None = None,
metadata: dict[str, Any] | None = None,
model_preferences: ModelPreferences | None = None,
tools: list[Tool],
tool_choice: ToolChoice | None = None,
meta: Meta | None = None,
opts: CallOptions | None = None,
) -> CreateMessageResultWithTools: ...
async def sample(
self,
messages: list[SamplingMessage],
*,
max_tokens: int,
system_prompt: str | None = None,
include_context: IncludeContext | None = None,
temperature: float | None = None,
stop_sequences: list[str] | None = None,
metadata: dict[str, Any] | None = None,
model_preferences: ModelPreferences | None = None,
tools: list[Tool] | None = None,
tool_choice: ToolChoice | None = None,
meta: Meta | None = None,
opts: CallOptions | None = None,
) -> CreateMessageResult | CreateMessageResultWithTools:
"""Send a `sampling/createMessage` request to the peer.
Raises:
MCPError: The peer responded with an error.
NoBackChannelError: No back-channel for server-initiated requests.
pydantic.ValidationError: The peer's result does not match the expected result type.
"""
params = CreateMessageRequestParams(
messages=messages,
system_prompt=system_prompt,
include_context=include_context,
temperature=temperature,
max_tokens=max_tokens,
stop_sequences=stop_sequences,
metadata=metadata,
model_preferences=model_preferences,
tools=tools,
tool_choice=tool_choice,
)
result = await self.send_raw_request("sampling/createMessage", dump_params(params, meta), opts)
if tools is not None:
return CreateMessageResultWithTools.model_validate(result, by_name=False)
return CreateMessageResult.model_validate(result, by_name=False)
async def elicit_form(
self,
message: str,
requested_schema: ElicitRequestedSchema,
*,
meta: Meta | None = None,
opts: CallOptions | None = None,
) -> ElicitResult:
"""Send a form-mode `elicitation/create` request.
Raises:
MCPError: The peer responded with an error.
NoBackChannelError: No back-channel for server-initiated requests.
pydantic.ValidationError: The peer's result does not match the expected result type.
"""
params = ElicitRequestFormParams(message=message, requested_schema=requested_schema)
result = await self.send_raw_request("elicitation/create", dump_params(params, meta), opts)
return ElicitResult.model_validate(result, by_name=False)
async def elicit_url(
self,
message: str,
url: str,
elicitation_id: str,
*,
meta: Meta | None = None,
opts: CallOptions | None = None,
) -> ElicitResult:
"""Send a URL-mode `elicitation/create` request.
Raises:
MCPError: The peer responded with an error.
NoBackChannelError: No back-channel for server-initiated requests.
pydantic.ValidationError: The peer's result does not match the expected result type.
"""
params = ElicitRequestURLParams(message=message, url=url, elicitation_id=elicitation_id)
result = await self.send_raw_request("elicitation/create", dump_params(params, meta), opts)
return ElicitResult.model_validate(result, by_name=False)
async def list_roots(self, *, meta: Meta | None = None, opts: CallOptions | None = None) -> ListRootsResult:
"""Send a `roots/list` request.
Raises:
MCPError: The peer responded with an error.
NoBackChannelError: No back-channel for server-initiated requests.
pydantic.ValidationError: The peer's result does not match the expected result type.
"""
result = await self.send_raw_request("roots/list", dump_params(None, meta), opts)
return ListRootsResult.model_validate(result, by_name=False)
async def ping(self, *, meta: Meta | None = None, opts: CallOptions | None = None) -> None:
"""Send a `ping` request and ignore the result.
Raises:
MCPError: The peer responded with an error.
NoBackChannelError: No back-channel for server-initiated requests.
"""
await self.send_raw_request("ping", dump_params(None, meta), opts)