nimwire/transport

This page is generated from the module’s exported API and ## documentation comments.

Transport-neutral MCP messages and request/response handling.

Types

McpTransportRequest

McpTransportRequest = proc (message: McpJsonRpcMessage): Future[
    McpJsonRpcMessage] {.closure.}

View source

McpTransportNotification

McpTransportNotification = proc (message: McpJsonRpcMessage): Future[void] {.
    closure.}

View source

McpTransportClose

McpTransportClose = proc () {.closure.}

View source

McpMessageTransport

A message transport carries already validated JSON-RPC values. It does not know about servers, HTTP, stdio, or any higher-level client API.

McpMessageTransport = ref object

View source

McpPeer

Small client-side request/response helper shared by proxies and clients.

McpPeer = ref object
  transport*: McpMessageTransport
  metadata*: McpRequestMeta

View source

Procedures

newMcpRequestMeta

proc newMcpRequestMeta(clientName = "nimwire"; clientVersion = "0.1.0";
                       clientCapabilities: JsonNode = nil): McpRequestMeta {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpRequestMeta.

Arguments

Name	Type	Default
clientName	inferred	"nimwire"
clientVersion	inferred	"0.1.0"
clientCapabilities	JsonNode	nil

View source

newMcpParams

proc newMcpParams(values: JsonNode = nil; metadata = McpRequestMeta()): McpParams {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpParams.

Arguments

Name	Type	Default
values	JsonNode	nil
metadata	inferred	McpRequestMeta()

View source

newMcpRequest

proc newMcpRequest(id: McpId; methodName: string; values: JsonNode = nil;
                   metadata = McpRequestMeta()): McpRpcRequest {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpRpcRequest.

Arguments

Name	Type	Default
id	McpId
methodName	string
values	JsonNode	nil
metadata	inferred	McpRequestMeta()

View source

newMcpNotification

proc newMcpNotification(methodName: string; values: JsonNode = nil;
                        metadata = McpRequestMeta()): McpRpcRequest {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpRpcRequest.

Arguments

Name	Type	Default
methodName	string
values	JsonNode	nil
metadata	inferred	McpRequestMeta()

View source

newMcpMessageTransport

proc newMcpMessageTransport(request: McpTransportRequest;
                            notification: McpTransportNotification = nil;
                            close: McpTransportClose = nil): McpMessageTransport {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpMessageTransport.

Arguments

Name	Type	Default
request	McpTransportRequest
notification	McpTransportNotification	nil
close	McpTransportClose	nil

View source

isClosed

proc isClosed(transport: McpMessageTransport): bool {.raises: [], tags: [],
    forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
transport	McpMessageTransport

View source

requestAsync (overload 1)

proc requestAsync(transport: McpMessageTransport; message: McpJsonRpcMessage): Future[
    McpJsonRpcMessage] {.stackTrace: false,
                         raises: [Exception, ValueError, McpError],
                         tags: [RootEffect], forbids: [].}

Returns: Future[McpJsonRpcMessage].

Arguments

Name	Type	Default
transport	McpMessageTransport
message	McpJsonRpcMessage

View source

notifyAsync (overload 1)

proc notifyAsync(transport: McpMessageTransport; message: McpJsonRpcMessage): Future[
    void] {.stackTrace: false, raises: [Exception, McpError, ValueError],
            tags: [RootEffect], forbids: [].}

Returns: Future[void].

Arguments

Name	Type	Default
transport	McpMessageTransport
message	McpJsonRpcMessage

View source

close (overload 1)

proc close(transport: McpMessageTransport) {.raises: [Exception],
    tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
transport	McpMessageTransport

View source

newMcpPeer

proc newMcpPeer(transport: McpMessageTransport; metadata = McpRequestMeta()): McpPeer {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpPeer.

Arguments

Name	Type	Default
transport	McpMessageTransport
metadata	inferred	McpRequestMeta()

View source

requestAsync (overload 2)

proc requestAsync(peer: McpPeer; methodName: string; values: JsonNode = nil): Future[
    McpWireResult] {.stackTrace: false,
                     raises: [Exception, ValueError, McpError],
                     tags: [RootEffect], forbids: [].}

Returns: Future[McpWireResult].

Arguments

Name	Type	Default
peer	McpPeer
methodName	string
values	JsonNode	nil

View source

request

proc request(peer: McpPeer; methodName: string; values: JsonNode = nil): McpWireResult {.
    raises: [ValueError, Exception, OSError, McpError],
    tags: [TimeEffect, RootEffect], forbids: [].}

Returns: McpWireResult.

Arguments

Name	Type	Default
peer	McpPeer
methodName	string
values	JsonNode	nil

View source

notifyAsync (overload 2)

proc notifyAsync(peer: McpPeer; methodName: string; values: JsonNode = nil): Future[
    void] {.stackTrace: false, raises: [Exception, McpError, ValueError],
            tags: [RootEffect], forbids: [].}

Returns: Future[void].

Arguments

Name	Type	Default
peer	McpPeer
methodName	string
values	JsonNode	nil

View source

notify

proc notify(peer: McpPeer; methodName: string; values: JsonNode = nil) {.
    raises: [ValueError, Exception, OSError, McpError],
    tags: [TimeEffect, RootEffect], forbids: [].}

Arguments

Name	Type	Default
peer	McpPeer
methodName	string
values	JsonNode	nil

View source

close (overload 2)

proc close(peer: McpPeer) {.raises: [Exception], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
peer	McpPeer

View source