nimwire/server

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

MCP server registry and typed feature dispatch.

Types

McpToolHandler

McpToolHandler = proc (arguments: JsonNode; context: McpContext): Future[
    McpToolResult] {.closure.}

View source

McpSyncToolHandler

McpSyncToolHandler = proc (arguments: JsonNode; context: McpContext): McpToolResult {.
    closure.}

View source

McpToolFilter

McpToolFilter = proc (name: string; principal: McpPrincipal): bool {.closure.}

View source

McpResourceFilter

McpResourceFilter = proc (uri: string; principal: McpPrincipal): bool {.closure.}

View source

McpPromptFilter

McpPromptFilter = proc (name: string; principal: McpPrincipal): bool {.closure.}

View source

McpTool

McpTool = object

View source

McpToolGroup

McpToolGroup = object
  namespace*: string
  tools*: seq[McpTool]

View source

McpServer

McpServer = ref object

View source

Procedures

newMcpServer

proc newMcpServer(name, version: string; instructions = ""; listTtlMs = 0;
                  listCacheScope = "private"; listPageSize = 0;
                  eventBus: McpEventBus = nil;
                  requestStateSealer: McpRequestStateSealer = nil;
                  requestStateVerifier: McpRequestStateVerifier = nil): McpServer {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpServer.

Arguments

Name	Type	Default
name	string
version	string
instructions	inferred	""
listTtlMs	inferred	0
listCacheScope	inferred	"private"
listPageSize	inferred	0
eventBus	McpEventBus	nil
requestStateSealer	McpRequestStateSealer	nil
requestStateVerifier	McpRequestStateVerifier	nil

View source

closeSubscription

proc closeSubscription(server: McpServer; subscription: McpSubscription;
                       graceful = true): bool {.
    raises: [Exception, KeyError, McpError], tags: [RootEffect], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
server	McpServer
subscription	McpSubscription
graceful	inferred	true

View source

findResourceTemplate

proc findResourceTemplate(server: McpServer; uriTemplate: string): int {.
    raises: [], tags: [], forbids: [].}

Returns: int.

Arguments

Name	Type	Default
server	McpServer
uriTemplate	string

View source

newMcpTool (overload 1)

proc newMcpTool(name, description: string; inputSchema: JsonNode;
                handler: McpToolHandler; outputSchema: JsonNode = nil;
                title = ""; icons: JsonNode = nil; annotations: JsonNode = nil): McpTool {.
    raises: [McpError, Exception, KeyError], tags: [RootEffect], forbids: [].}

Returns: McpTool.

Arguments

Name	Type	Default
name	string
description	string
inputSchema	JsonNode
handler	McpToolHandler
outputSchema	JsonNode	nil
title	inferred	""
icons	JsonNode	nil
annotations	JsonNode	nil

View source

newMcpTool (overload 2)

proc newMcpTool(name, description: string; inputSchema: JsonNode;
                handler: McpSyncToolHandler; outputSchema: JsonNode = nil;
                title = ""; icons: JsonNode = nil; annotations: JsonNode = nil): McpTool {.
    raises: [McpError, Exception, KeyError], tags: [RootEffect], forbids: [].}

Returns: McpTool.

Arguments

Name	Type	Default
name	string
description	string
inputSchema	JsonNode
handler	McpSyncToolHandler
outputSchema	JsonNode	nil
title	inferred	""
icons	JsonNode	nil
annotations	JsonNode	nil

View source

newMcpTaskTool

proc newMcpTaskTool(name, description: string; inputSchema: JsonNode;
                    handler: McpTaskHandler; outputSchema: JsonNode = nil;
                    title = ""; icons: JsonNode = nil;
                    annotations: JsonNode = nil): McpTool {.
    raises: [McpError, Exception, KeyError], tags: [RootEffect], forbids: [].}

Returns: McpTool.

Arguments

Name	Type	Default
name	string
description	string
inputSchema	JsonNode
handler	McpTaskHandler
outputSchema	JsonNode	nil
title	inferred	""
icons	JsonNode	nil
annotations	JsonNode	nil

View source

toolName

proc toolName(tool: McpTool): string {.raises: [], tags: [], forbids: [].}

Returns: string.

Arguments

Name	Type	Default
tool	McpTool

View source

addTool (overload 1)

proc addTool(server: McpServer; tool: McpTool) {.raises: [McpError], tags: [],
    forbids: [].}

Arguments

Name	Type	Default
server	McpServer
tool	McpTool

View source

addTool (overload 2)

proc addTool(group: var McpToolGroup; tool: McpTool) {.raises: [McpError],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
group	var McpToolGroup
tool	McpTool

View source

newMcpToolGroup

proc newMcpToolGroup(namespace = ""; tools: seq[McpTool] = @[]): McpToolGroup {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpToolGroup.

Arguments

Name	Type	Default
namespace	inferred	""
tools	seq[McpTool]	@[]

View source

addToolGroup

proc addToolGroup(server: McpServer; group: McpToolGroup) {.raises: [McpError],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
group	McpToolGroup

View source

addTools (overload 1)

proc addTools(server: McpServer; namespace: string; tools: openArray[McpTool]) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
namespace	string
tools	openArray[McpTool]

View source

addTools (overload 2)

proc addTools(server: McpServer; tools: openArray[McpTool]) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
tools	openArray[McpTool]

View source

markResourcesChanged

proc markResourcesChanged(server: McpServer) {.
    raises: [McpError, Exception, KeyError], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
server	McpServer

View source

markResourceUpdated

proc markResourceUpdated(server: McpServer; uri: string) {.
    raises: [McpError, Exception, KeyError], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
uri	string

View source

addResource

proc addResource(server: McpServer; resource: McpResource) {.raises: [McpError],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
resource	McpResource

View source

addResourceTemplate

proc addResourceTemplate(server: McpServer;
                         resourceTemplate: McpResourceTemplate) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
resourceTemplate	McpResourceTemplate

View source

addResourceTemplateCompletion (overload 1)

proc addResourceTemplateCompletion(server: McpServer;
                                   uriTemplate, argument: string;
                                   handler: McpResourceCompletionHandler) {.
    raises: [McpError, Exception], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
uriTemplate	string
argument	string
handler	McpResourceCompletionHandler

View source

addResourceTemplateCompletion (overload 2)

proc addResourceTemplateCompletion(server: McpServer; uriTemplate: string;
                                   completion: McpCompletion) {.
    raises: [McpError, Exception], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
uriTemplate	string
completion	McpCompletion

View source

addResourceTemplateCompletion (overload 3)

proc addResourceTemplateCompletion(server: McpServer;
                                   uriTemplate, argument: string;
                                   handler: McpSyncResourceCompletionHandler) {.
    raises: [McpError, Exception], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
uriTemplate	string
argument	string
handler	McpSyncResourceCompletionHandler

View source

findResource

proc findResource(server: McpServer; uri: string): int {.raises: [], tags: [],
    forbids: [].}

Returns: int.

Arguments

Name	Type	Default
server	McpServer
uri	string

View source

addPrompt

proc addPrompt(server: McpServer; prompt: McpPrompt) {.raises: [McpError],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
prompt	McpPrompt

View source

findPrompt

proc findPrompt(server: McpServer; name: string): int {.raises: [], tags: [],
    forbids: [].}

Returns: int.

Arguments

Name	Type	Default
server	McpServer
name	string

View source

parseSubscriptionFilter

proc parseSubscriptionFilter(value: JsonNode): McpSubscriptionFilter {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpSubscriptionFilter.

Arguments

Name	Type	Default
value	JsonNode

View source

openSubscription

proc openSubscription(server: McpServer; id: McpId;
                      requested: McpSubscriptionFilter;
                      handler: McpSubscriptionMessageHandler): McpSubscription {.
    raises: [McpError, Exception, KeyError], tags: [RootEffect], forbids: [].}

Returns: McpSubscription.

Arguments

Name	Type	Default
server	McpServer
id	McpId
requested	McpSubscriptionFilter
handler	McpSubscriptionMessageHandler

View source

subscriptionCount

proc subscriptionCount(server: McpServer): int {.raises: [], tags: [],
    forbids: [].}

Returns: int.

Arguments

Name	Type	Default
server	McpServer

View source

findSubscription

proc findSubscription(server: McpServer; id: McpId): McpSubscription {.
    raises: [], tags: [], forbids: [].}

Returns: McpSubscription.

Arguments

Name	Type	Default
server	McpServer
id	McpId

View source

closeSubscriptions

proc closeSubscriptions(server: McpServer; graceful = true): int {.
    raises: [Exception, KeyError, McpError], tags: [RootEffect], forbids: [].}

Returns: int.

Arguments

Name	Type	Default
server	McpServer
graceful	inferred	true

View source

cancelSubscription

proc cancelSubscription(server: McpServer; id: McpId): bool {.
    raises: [Exception, KeyError, McpError], tags: [RootEffect], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
server	McpServer
id	McpId

View source

addPromptCompletion (overload 1)

proc addPromptCompletion(server: McpServer; promptName, argument: string;
                         handler: McpPromptCompletionHandler) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
promptName	string
argument	string
handler	McpPromptCompletionHandler

View source

addPromptCompletion (overload 2)

proc addPromptCompletion(server: McpServer; promptName: string;
                         completion: McpCompletion) {.raises: [McpError],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
promptName	string
completion	McpCompletion

View source

addPromptCompletion (overload 3)

proc addPromptCompletion(server: McpServer; promptName, argument: string;
                         handler: McpSyncPromptCompletionHandler) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
promptName	string
argument	string
handler	McpSyncPromptCompletionHandler

View source

completePromptArgument

proc completePromptArgument(server: McpServer;
                            promptName, argument, prefix: string;
                            context: McpContext): Future[seq[string]] {.
    stackTrace: false, raises: [Exception, ValueError, McpError, KeyError],
    tags: [RootEffect], forbids: [].}

Returns: Future[seq[string]].

Arguments

Name	Type	Default
server	McpServer
promptName	string
argument	string
prefix	string
context	McpContext

View source

markPromptsChanged

proc markPromptsChanged(server: McpServer) {.
    raises: [McpError, Exception, KeyError], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
server	McpServer

View source

completeResourceTemplate

proc completeResourceTemplate(server: McpServer;
                              uriTemplate, argument, prefix: string;
                              context: McpContext): Future[seq[string]] {.
    stackTrace: false, raises: [Exception, ValueError, McpError, KeyError],
    tags: [RootEffect], forbids: [].}

Returns: Future[seq[string]].

Arguments

Name	Type	Default
server	McpServer
uriTemplate	string
argument	string
prefix	string
context	McpContext

View source

markToolsChanged

proc markToolsChanged(server: McpServer) {.
    raises: [McpError, Exception, KeyError], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
server	McpServer

View source

findTool

proc findTool(server: McpServer; name: string): int {.raises: [], tags: [],
    forbids: [].}

Returns: int.

Arguments

Name	Type	Default
server	McpServer
name	string

View source

setToolFilter

proc setToolFilter(server: McpServer; filter: McpToolFilter) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
filter	McpToolFilter

View source

setResourceFilter

proc setResourceFilter(server: McpServer; filter: McpResourceFilter) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
filter	McpResourceFilter

View source

setPromptFilter

proc setPromptFilter(server: McpServer; filter: McpPromptFilter) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
filter	McpPromptFilter

View source

setToolTimeout

proc setToolTimeout(server: McpServer; toolName: string; timeoutMs: int) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
toolName	string
timeoutMs	int

View source

setSecurityLimits

proc setSecurityLimits(server: McpServer; limits: McpSecurityLimits) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
limits	McpSecurityLimits

View source

setObservability

proc setObservability(server: McpServer; hooks: McpObservability) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
hooks	McpObservability

View source

use (overload 1)

proc use(server: McpServer; middleware: McpToolMiddleware) {.raises: [McpError],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
middleware	McpToolMiddleware

View source

use (overload 2)

proc use(server: McpServer; middlewares: openArray[McpToolMiddleware]) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
middlewares	openArray[McpToolMiddleware]

View source

registerExtension

proc registerExtension(server: McpServer; extension: McpExtension) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
extension	McpExtension

View source

finalizeExtension

proc finalizeExtension(server: McpServer; name: string) {.raises: [McpError],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
name	string

View source

hasExtension

proc hasExtension(server: McpServer; name: string): bool {.raises: [], tags: [],
    forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
server	McpServer
name	string

View source

finalizedExtensions

proc finalizedExtensions(server: McpServer): seq[McpExtension] {.raises: [],
    tags: [], forbids: [].}

Returns: seq[McpExtension].

Arguments

Name	Type	Default
server	McpServer

View source

draftExtensions

proc draftExtensions(server: McpServer): seq[McpExtension] {.raises: [],
    tags: [], forbids: [].}

Returns: seq[McpExtension].

Arguments

Name	Type	Default
server	McpServer

View source

enableTasks

proc enableTasks(server: McpServer; store: McpTaskStore = nil) {.
    raises: [McpError, Exception], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
server	McpServer
store	McpTaskStore	nil

View source

cancelRequest

proc cancelRequest(server: McpServer; id: McpId; reason = ""): bool {.
    raises: [Exception, KeyError], tags: [RootEffect], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
server	McpServer
id	McpId
reason	inferred	""

View source

cancelActiveRequests

proc cancelActiveRequests(server: McpServer; reason = "server shutdown"): int {.
    raises: [Exception], tags: [RootEffect], forbids: [].}

Returns: int.

Arguments

Name	Type	Default
server	McpServer
reason	inferred	"server shutdown"

View source

dispatchAsync

proc dispatchAsync(server: McpServer; request: McpRpcRequest;
                   context: McpContext): Future[McpWireResult] {.
    stackTrace: false,
    raises: [Exception, ValueError, McpError, KeyError, OSError],
    tags: [RootEffect, TimeEffect], forbids: [].}

Returns: Future[McpWireResult].

Arguments

Name	Type	Default
server	McpServer
request	McpRpcRequest
context	McpContext

View source

handleMessageAsync

proc handleMessageAsync(server: McpServer; message: McpJsonRpcMessage;
                        context: McpContext; subscriptionHandler: McpSubscriptionMessageHandler = nil): Future[
    Option[McpJsonRpcMessage]] {.stackTrace: false, raises: [Exception,
    ValueError, OSError, McpError], tags: [RootEffect, TimeEffect], forbids: [].}

Returns: Future[Option[McpJsonRpcMessage]].

Arguments

Name	Type	Default
server	McpServer
message	McpJsonRpcMessage
context	McpContext
subscriptionHandler	McpSubscriptionMessageHandler	nil

View source

handleJsonAsync

Decode one JSON-RPC message, dispatch its typed form, then encode it.

proc handleJsonAsync(server: McpServer; request: JsonNode): Future[JsonNode] {.
    stackTrace: false, raises: [Exception, ValueError, McpError, KeyError],
    tags: [RootEffect, TimeEffect], forbids: [].}

Returns: Future[JsonNode].

Arguments

Name	Type	Default
server	McpServer
request	JsonNode

View source

handleJson

proc handleJson(server: McpServer; request: JsonNode): JsonNode {.
    raises: [ValueError, Exception, OSError, McpError, KeyError],
    tags: [TimeEffect, RootEffect], forbids: [].}

Returns: JsonNode.

Arguments

Name	Type	Default
server	McpServer
request	JsonNode

View source

Templates

mcpTool

Concise tool declaration that works with sync or async handlers.

template mcpTool(name, description: string; inputSchema: JsonNode;
                 handler: untyped; outputSchema: JsonNode = nil; title = "";
                 icons: JsonNode = nil; annotations: JsonNode = nil): McpTool

Returns: McpTool.

Arguments

Name	Type	Default
name	string
description	string
inputSchema	JsonNode
handler	untyped
outputSchema	JsonNode	nil
title	inferred	""
icons	JsonNode	nil
annotations	JsonNode	nil

View source

Macros

tool

Register a typed tool; the expansion remains a normal McpTool.

macro tool(server: McpServer; name, description: static[string]; handler: typed;
           inputSchema: untyped = nil; outputSchema: untyped = nil): untyped

Type parameters: name:type, description:type.

Returns: untyped.

Arguments

Name	Type	Default
server	McpServer
name	static[string]
description	static[string]
handler	typed
inputSchema	untyped	nil
outputSchema	untyped	nil

View source

mcpServer

Build a server declaratively while keeping registration code local.

macro mcpServer(name, version: static[string]; body: untyped): untyped

Type parameters: name:type, version:type.

Returns: untyped.

Arguments

Name	Type	Default
name	static[string]
version	static[string]
body	untyped

View source

Iterators

toolHeaderBindings

iterator toolHeaderBindings(server: McpServer; name: string): McpHeaderBinding {.
    raises: [], tags: [], forbids: [].}

Returns: McpHeaderBinding.

Arguments

Name	Type	Default
server	McpServer
name	string

View source