A client connected to an in-memory server (Effect's McpTest.Client).
Attributes#
| Attribute | Type | Description |
|---|---|---|
protocol_version | str | The protocol the handshake chose. |
server | McpServerService | The server, to register with or send notifications from a test. |
notifications | Dequeue[Notification, Never] | What the server sent this client, in delivery order. |
ping | Effect[None, McpError] |
Functions#
__init__#
__init__(protocol_version, server, _notifications, _wire, _metadata, _pending=dict[int, Any](), _ids=(lambda: itertools.count(2))()) -> None| Parameter | Type | Description |
|---|---|---|
protocol_version | str | |
server | McpServerService | |
_notifications | Queue[Notification, Never] | |
_wire | _Wire | |
_metadata | JsonObject | None | |
_pending | dict[int, Deferred[JsonObject]] = dict[int, Any]() | |
_ids | itertools.count[int] = (lambda: itertools.count(2))() |
request#
request(method, params=None) -> Effect[JsonObject, McpError]Send a request; its result, or its error as an McpError.
| Parameter | Type | Description |
|---|---|---|
method | str | |
params | Mapping[str, Any] | None = None |
Returns Effect[JsonObject, McpError]
def request(
self, method: str, params: Mapping[str, Any] | None = None
) -> Effect[JsonObject, McpError]:
"""Send a request; its result, or its error as an ``McpError``."""
@gen
def run():
id = next(self._ids)
reply = Deferred[JsonObject]()
self._pending[id] = reply
body: JsonObject = dict(params or {})
if self._metadata is not None:
own = cast("JsonObject", body.get("_meta") or {})
body["_meta"] = {**self._metadata, **own}
message: JsonObject = {"jsonrpc": "2.0", "id": id, "method": method, "params": body}
yield from self._wire.send(message, self._receive)
answer = yield from reply.wait()
error = answer.get("error")
if isinstance(error, dict):
return (yield from fail(_error_of(cast("Mapping[str, Any]", error))))
return cast("JsonObject", answer.get("result") or {})
return runlist_tools#
list_tools(params=None) -> Effect[ListToolsResult, McpError]| Parameter | Type | Description |
|---|---|---|
params | JsonObject | None = None |
Returns Effect[ListToolsResult, McpError]
def list_tools(self, params: JsonObject | None = None) -> Effect[ListToolsResult, McpError]:
return cast("Any", self.request("tools/list", params))call_tool#
call_tool(params) -> Effect[CallToolResult, McpError]| Parameter | Type | Description |
|---|---|---|
params | CallToolParams |
Returns Effect[CallToolResult, McpError]
def call_tool(self, params: CallToolParams) -> Effect[CallToolResult, McpError]:
return cast("Any", self.request("tools/call", params))list_resources#
list_resources(params=None) -> Effect[ListResourcesResult, McpError]| Parameter | Type | Description |
|---|---|---|
params | JsonObject | None = None |
Returns Effect[ListResourcesResult, McpError]
def list_resources(
self, params: JsonObject | None = None
) -> Effect[ListResourcesResult, McpError]:
return cast("Any", self.request("resources/list", params))list_resource_templates#
list_resource_templates(params=None) -> Effect[ListResourceTemplatesResult, McpError]| Parameter | Type | Description |
|---|---|---|
params | JsonObject | None = None |
Returns Effect[ListResourceTemplatesResult, McpError]
def list_resource_templates(
self, params: JsonObject | None = None
) -> Effect[ListResourceTemplatesResult, McpError]:
return cast("Any", self.request("resources/templates/list", params))read_resource#
read_resource(params) -> Effect[ReadResourceResult, McpError]| Parameter | Type | Description |
|---|---|---|
params | Mapping[str, Any] |
Returns Effect[ReadResourceResult, McpError]
def read_resource(self, params: Mapping[str, Any]) -> Effect[ReadResourceResult, McpError]:
return cast("Any", self.request("resources/read", params))subscribe#
subscribe(params) -> Effect[None, McpError]| Parameter | Type | Description |
|---|---|---|
params | Mapping[str, Any] |
Returns Effect[None, McpError]
def subscribe(self, params: Mapping[str, Any]) -> Effect[None, McpError]:
return self.request("resources/subscribe", params).as_void()unsubscribe#
unsubscribe(params) -> Effect[None, McpError]| Parameter | Type | Description |
|---|---|---|
params | Mapping[str, Any] |
Returns Effect[None, McpError]
def unsubscribe(self, params: Mapping[str, Any]) -> Effect[None, McpError]:
return self.request("resources/unsubscribe", params).as_void()list_prompts#
list_prompts(params=None) -> Effect[ListPromptsResult, McpError]| Parameter | Type | Description |
|---|---|---|
params | JsonObject | None = None |
Returns Effect[ListPromptsResult, McpError]
def list_prompts(self, params: JsonObject | None = None) -> Effect[ListPromptsResult, McpError]:
return cast("Any", self.request("prompts/list", params))get_prompt#
get_prompt(params) -> Effect[GetPromptResult, McpError]| Parameter | Type | Description |
|---|---|---|
params | Mapping[str, Any] |
Returns Effect[GetPromptResult, McpError]
def get_prompt(self, params: Mapping[str, Any]) -> Effect[GetPromptResult, McpError]:
return cast("Any", self.request("prompts/get", params))complete#
complete(params) -> Effect[CompleteResult, McpError]| Parameter | Type | Description |
|---|---|---|
params | CompleteParams |
Returns Effect[CompleteResult, McpError]
def complete(self, params: CompleteParams) -> Effect[CompleteResult, McpError]:
return cast("Any", self.request("completion/complete", params))set_level#
set_level(params) -> Effect[None, McpError]| Parameter | Type | Description |
|---|---|---|
params | Mapping[str, Any] |
Returns Effect[None, McpError]
def set_level(self, params: Mapping[str, Any]) -> Effect[None, McpError]:
return self.request("logging/setLevel", params).as_void()