nimwire/mrtr

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

Multi round-trip requests and low-level input handling.

Types

McpElicitationMode

McpElicitationMode = enum
  mcpElicitationForm, mcpElicitationUrl

View source

McpElicitationRequest

McpElicitationRequest = object
  mode*: McpElicitationMode
  message*: string
  requestedSchema*: JsonNode
  url*: string

View source

McpElicitationAction

McpElicitationAction = enum
  mcpElicitationAccept, mcpElicitationDecline, mcpElicitationCancel

View source

McpElicitationResult

McpElicitationResult = object
  action*: McpElicitationAction
  content*: JsonNode

View source

McpInputRequests

McpInputRequests = Table[string, McpInputRequest]

View source

McpElicitationHandler

McpElicitationHandler = proc (request: McpElicitationRequest): McpElicitationResult {.
    closure.}

View source

McpInputResponseHandler

McpInputResponseHandler = proc (request: McpInputRequest): JsonNode {.closure.}

View source

McpInputClient

McpInputClient = ref object
  elicitationHandler*: McpElicitationHandler
  samplingHandler*: McpInputResponseHandler
  rootsHandler*: McpInputResponseHandler

View source

Procedures

newMcpInputRequest

proc newMcpInputRequest(methodName: string; params: JsonNode = nil): McpInputRequest {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpInputRequest.

Arguments

Name	Type	Default
`methodName`	`string`
`params`	`JsonNode`	`nil`

View source

newMcpElicitationFormRequest

proc newMcpElicitationFormRequest(message: string; requestedSchema: JsonNode): McpInputRequest {.
    raises: [McpError, Exception, KeyError], tags: [RootEffect], forbids: [].}

Returns: McpInputRequest.

Arguments

Name	Type	Default
`message`	`string`
`requestedSchema`	`JsonNode`

View source

newMcpElicitationUrlRequest

proc newMcpElicitationUrlRequest(message, url: string): McpInputRequest {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpInputRequest.

Arguments

Name	Type	Default
`message`	`string`
`url`	`string`

View source

toJson (overload 1)

proc toJson(value: McpInputRequest): JsonNode {.raises: [], tags: [],
    forbids: [].}

Returns: JsonNode.

Arguments

Name	Type	Default
`value`	`McpInputRequest`

View source

parseMcpInputRequest

proc parseMcpInputRequest(node: JsonNode): McpInputRequest {.
    raises: [KeyError, McpError], tags: [], forbids: [].}

Returns: McpInputRequest.

Arguments

Name	Type	Default
`node`	`JsonNode`

View source

inputRequestsJson

proc inputRequestsJson(inputRequests: McpInputRequests): JsonNode {.
    raises: [McpError], tags: [], forbids: [].}

Returns: JsonNode.

Arguments

Name	Type	Default
`inputRequests`	`McpInputRequests`

View source

newMcpInputRequiredResult (overload 1)

proc newMcpInputRequiredResult(inputRequests: JsonNode = nil; requestState = ""): McpWireResult {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpWireResult.

Arguments

Name	Type	Default
`inputRequests`	`JsonNode`	`nil`
`requestState`	`inferred`	`""`

View source

newMcpInputRequiredResult (overload 2)

proc newMcpInputRequiredResult(inputRequests: McpInputRequests;
                               requestState = ""): McpWireResult {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpWireResult.

Arguments

Name	Type	Default
`inputRequests`	`McpInputRequests`
`requestState`	`inferred`	`""`

View source

newMcpInputRequiredResult (overload 3)

proc newMcpInputRequiredResult(entries: openArray[(string, McpInputRequest)];
                               requestState = ""): McpWireResult {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpWireResult.

Arguments

Name	Type	Default
`entries`	`openArray[(string, McpInputRequest)]`
`requestState`	`inferred`	`""`

View source

parseInputRequests

proc parseInputRequests(value: McpWireResult): McpInputRequests {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpInputRequests.

Arguments

Name	Type	Default
`value`	`McpWireResult`

View source

parseMcpElicitationRequest

proc parseMcpElicitationRequest(request: McpInputRequest): McpElicitationRequest {.
    raises: [McpError, KeyError, Exception], tags: [RootEffect], forbids: [].}

Returns: McpElicitationRequest.

Arguments

Name	Type	Default
`request`	`McpInputRequest`

View source

newMcpElicitationResult

proc newMcpElicitationResult(action: McpElicitationAction;
                             content: JsonNode = nil): McpElicitationResult {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpElicitationResult.

Arguments

Name	Type	Default
`action`	`McpElicitationAction`
`content`	`JsonNode`	`nil`

View source

acceptElicitation

proc acceptElicitation(content: JsonNode = nil): McpElicitationResult {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpElicitationResult.

Arguments

Name	Type	Default
`content`	`JsonNode`	`nil`

View source

declineElicitation

proc declineElicitation(): McpElicitationResult {.raises: [McpError], tags: [],
    forbids: [].}

Returns: McpElicitationResult.

View source

cancelElicitation

proc cancelElicitation(): McpElicitationResult {.raises: [McpError], tags: [],
    forbids: [].}

Returns: McpElicitationResult.

View source

toJson (overload 2)

proc toJson(value: McpElicitationResult): JsonNode {.raises: [], tags: [],
    forbids: [].}

Returns: JsonNode.

Arguments

Name	Type	Default
`value`	`McpElicitationResult`

View source

parseMcpElicitationResult

proc parseMcpElicitationResult(node: JsonNode): McpElicitationResult {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpElicitationResult.

Arguments

Name	Type	Default
`node`	`JsonNode`

View source

validateElicitationResponse

proc validateElicitationResponse(request: McpElicitationRequest;
                                 response: McpElicitationResult) {.
    raises: [McpError, Exception, KeyError], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
`request`	`McpElicitationRequest`
`response`	`McpElicitationResult`

View source

newMcpInputClient

proc newMcpInputClient(firstRequestId = 1'i64;
                       elicitationHandler: McpElicitationHandler = nil;
                       samplingHandler: McpInputResponseHandler = nil;
                       rootsHandler: McpInputResponseHandler = nil): McpInputClient {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpInputClient.

Arguments

Name	Type	Default
`firstRequestId`	`inferred`	`1'i64`
`elicitationHandler`	`McpElicitationHandler`	`nil`
`samplingHandler`	`McpInputResponseHandler`	`nil`
`rootsHandler`	`McpInputResponseHandler`	`nil`

View source

setElicitationHandler

proc setElicitationHandler(client: McpInputClient;
                           handler: McpElicitationHandler) {.raises: [],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
`client`	`McpInputClient`
`handler`	`McpElicitationHandler`

View source

setSamplingHandler

proc setSamplingHandler(client: McpInputClient; handler: McpInputResponseHandler) {.
    raises: [], tags: [], forbids: [].}

Arguments

Name	Type	Default
`client`	`McpInputClient`
`handler`	`McpInputResponseHandler`

View source

setRootsHandler

proc setRootsHandler(client: McpInputClient; handler: McpInputResponseHandler) {.
    raises: [], tags: [], forbids: [].}

Arguments

Name	Type	Default
`client`	`McpInputClient`
`handler`	`McpInputResponseHandler`

View source

rememberRequest

proc rememberRequest(client: McpInputClient; id: McpId) {.raises: [McpError],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
`client`	`McpInputClient`
`id`	`McpId`

View source

freshRequestId

proc freshRequestId(client: McpInputClient): McpId {.raises: [McpError],
    tags: [], forbids: [].}

Returns: McpId.

Arguments

Name	Type	Default
`client`	`McpInputClient`

View source

retryInputRequired (overload 1)

proc retryInputRequired(client: McpInputClient;
                        original, response: McpJsonRpcMessage; retryId: McpId): McpJsonRpcMessage {.
    raises: [McpError, KeyError, Exception], tags: [RootEffect], forbids: [].}

Returns: McpJsonRpcMessage.

Arguments

Name	Type	Default
`client`	`McpInputClient`
`original`	`McpJsonRpcMessage`
`response`	`McpJsonRpcMessage`
`retryId`	`McpId`

View source

retryInputRequired (overload 2)

proc retryInputRequired(client: McpInputClient;
                        original, response: McpJsonRpcMessage): McpJsonRpcMessage {.
    raises: [McpError, KeyError, Exception], tags: [RootEffect], forbids: [].}

Returns: McpJsonRpcMessage.

Arguments

Name	Type	Default
`client`	`McpInputClient`
`original`	`McpJsonRpcMessage`
`response`	`McpJsonRpcMessage`

View source