nimwire/schema

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

Lightweight JSON Schema validation for tool boundaries.

Types

McpHeaderBinding

A tool argument path mirrored into Mcp-Param-{name}.

McpHeaderBinding = object
  name*: string
  path*: seq[string]
  valueType*: string

View source

Procedures

validateJsonSchema

proc validateJsonSchema(schema: JsonNode; context = "JSON Schema") {.
    raises: [McpError, KeyError, Exception], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
schema	JsonNode
context	inferred	"JSON Schema"

View source

requireJsonSchema

proc requireJsonSchema(schema: JsonNode; context = "JSON Schema"): JsonNode {.
    raises: [McpError, Exception], tags: [RootEffect], forbids: [].}

Returns: JsonNode.

Arguments

Name	Type	Default
schema	JsonNode
context	inferred	"JSON Schema"

View source

mcpHeaderBindings

Return the valid statically reachable x-mcp-header annotations.

proc mcpHeaderBindings(schema: JsonNode): seq[McpHeaderBinding] {.
    raises: [Exception, KeyError, McpError], tags: [RootEffect], forbids: [].}

Returns: seq[McpHeaderBinding].

Arguments

Name	Type	Default
schema	JsonNode

View source

mcpLiteralJson

Evaluate the literal subset used by %* without executing user code. A nil result means that the expression is dynamic and will be checked at registration time instead.

proc mcpLiteralJson(node: NimNode): JsonNode {.raises: [], tags: [], forbids: [].}

Returns: JsonNode.

Arguments

Name	Type	Default
node	NimNode

View source

validateMcpSchemaLiteral

proc validateMcpSchemaLiteral(node: NimNode; context: string) {.
    raises: [Exception], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
node	NimNode
context	string

View source

validateToolName

proc validateToolName(name: string) {.raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
name	string

View source

validateToolPresentation

proc validateToolPresentation(icons, annotations: JsonNode) {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Arguments

Name	Type	Default
icons	JsonNode
annotations	JsonNode

View source

mcpSchemaFromType

proc mcpSchemaFromType(n: NimNode): JsonNode {.raises: [KeyError, Exception],
    tags: [RootEffect], forbids: [].}

Returns: JsonNode.

Arguments

Name	Type	Default
n	NimNode

View source

mcpJsonArgument

proc mcpJsonArgument(arguments: JsonNode; name: string): JsonNode {.
    raises: [KeyError], tags: [], forbids: [].}

Returns: JsonNode.

Arguments

Name	Type	Default
arguments	JsonNode
name	string

View source

mcpJsonDecode

Decode typed tool arguments while allowing absent Option properties.

proc mcpJsonDecode[T](value: JsonNode): T

Type parameters: T.

Returns: T.

Arguments

Name	Type	Default
value	JsonNode

View source

mcpJsonEncode

Encode typed results with stable, model-facing enum names.

proc mcpJsonEncode[T](value: T): JsonNode

Type parameters: T.

Returns: JsonNode.

Arguments

Name	Type	Default
value	T

View source

validateJsonValue

proc validateJsonValue(schema, value: JsonNode; context = "value") {.
    raises: [McpError, Exception, KeyError], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
schema	JsonNode
value	JsonNode
context	inferred	"value"

View source

Macros

mcpJsonSchema

Derive a JSON Schema for primitives, objects, enums, containers, tables, options, and nested combinations of those types.

macro mcpJsonSchema(T: typedesc): JsonNode

Type parameters: T:type.

Returns: JsonNode.

Arguments

Name	Type	Default
T	typedesc

View source