nimwire/extensions

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

Generic, opt-in extension registry and dispatch.

Types

McpExtensionMethodHandler

McpExtensionMethodHandler = proc (params: JsonNode; context: McpContext): Future[
    McpWireResult] {.closure.}

View source

McpExtensionMethod

McpExtensionMethod = object
  name*: string
  handler*: McpExtensionMethodHandler
  inputSchema*: JsonNode
  outputSchema*: JsonNode
  metadata*: JsonNode
  transportRules*: JsonNode

View source

McpExtension

McpExtension = ref object
  name*: string
  capabilities*: JsonNode
  metadata*: JsonNode
  methods*: seq[McpExtensionMethod]
  requiresClientCapability*: bool

View source

McpExtensionRegistry

McpExtensionRegistry = ref object

View source

Procedures

newMcpExtension

proc newMcpExtension(name: string; capabilities: JsonNode = nil;
                     metadata: JsonNode = nil; requiresClientCapability = false): McpExtension {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpExtension.

Arguments

Name	Type	Default
name	string
capabilities	JsonNode	nil
metadata	JsonNode	nil
requiresClientCapability	inferred	false

View source

addExtensionMethod

proc addExtensionMethod(extension: McpExtension; name: string;
                        handler: McpExtensionMethodHandler;
                        inputSchema: JsonNode = nil;
                        outputSchema: JsonNode = nil; metadata: JsonNode = nil;
                        transportRules: JsonNode = nil) {.
    raises: [McpError, Exception], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
extension	McpExtension
name	string
handler	McpExtensionMethodHandler
inputSchema	JsonNode	nil
outputSchema	JsonNode	nil
metadata	JsonNode	nil
transportRules	JsonNode	nil

View source

newMcpExtensionRegistry

proc newMcpExtensionRegistry(): McpExtensionRegistry {.raises: [], tags: [],
    forbids: [].}

Returns: McpExtensionRegistry.

View source

registerExtension

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

Arguments

Name	Type	Default
registry	McpExtensionRegistry
extension	McpExtension

View source

finalizeExtension

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

Arguments

Name	Type	Default
registry	McpExtensionRegistry
name	string

View source

hasFinalizedExtension

proc hasFinalizedExtension(registry: McpExtensionRegistry; name: string): bool {.
    raises: [], tags: [], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
registry	McpExtensionRegistry
name	string

View source

hasDraftExtension

proc hasDraftExtension(registry: McpExtensionRegistry; name: string): bool {.
    raises: [], tags: [], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
registry	McpExtensionRegistry
name	string

View source

finalizedExtensions

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

Returns: seq[McpExtension].

Arguments

Name	Type	Default
registry	McpExtensionRegistry

View source

draftExtensions

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

Returns: seq[McpExtension].

Arguments

Name	Type	Default
registry	McpExtensionRegistry

View source

extensionCapabilities

proc extensionCapabilities(registry: McpExtensionRegistry): JsonNode {.
    raises: [], tags: [], forbids: [].}

Returns: JsonNode.

Arguments

Name	Type	Default
registry	McpExtensionRegistry

View source

addExtensionMetadata

proc addExtensionMetadata(registry: McpExtensionRegistry; target: JsonNode) {.
    raises: [], tags: [], forbids: [].}

Arguments

Name	Type	Default
registry	McpExtensionRegistry
target	JsonNode

View source

clientSupportsExtension

proc clientSupportsExtension(context: McpContext; name: string): bool {.
    raises: [KeyError], tags: [], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
context	McpContext
name	string

View source

requireClientExtension

proc requireClientExtension(context: McpContext; name: string) {.
    raises: [KeyError, McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
context	McpContext
name	string

View source

dispatchExtensionAsync

proc dispatchExtensionAsync(registry: McpExtensionRegistry;
                            request: McpRpcRequest; context: McpContext): Future[
    McpWireResult] {.stackTrace: false,
                     raises: [Exception, ValueError, McpError, KeyError],
                     tags: [RootEffect], forbids: [].}

Returns: Future[McpWireResult].

Arguments

Name	Type	Default
registry	McpExtensionRegistry
request	McpRpcRequest
context	McpContext

View source