nimwire/prompts

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

Prompt definitions, typed arguments, and prompt messages.

Types

McpPromptRole

McpPromptRole = enum
  mcpPromptUser, mcpPromptAssistant

View source

McpPromptArgument

McpPromptArgument = object
  name*: string
  description*: string
  required*: bool

View source

McpPromptArguments

McpPromptArguments = Table[string, string]

View source

McpPromptMessage

McpPromptMessage = object
  role*: McpPromptRole       ## Untrusted caller-facing metadata; never use it as an authorization policy.
  content*: JsonNode

View source

McpPromptHandler

McpPromptHandler = proc (arguments: McpPromptArguments; context: McpContext): Future[
    seq[McpPromptMessage]] {.closure.}

View source

McpPromptSingleHandler

McpPromptSingleHandler = proc (arguments: McpPromptArguments;
                               context: McpContext): Future[McpPromptMessage] {.
    closure.}

View source

McpSyncPromptHandler

McpSyncPromptHandler = proc (arguments: McpPromptArguments; context: McpContext): seq[
    McpPromptMessage] {.closure.}

View source

McpSyncPromptSingleHandler

McpSyncPromptSingleHandler = proc (arguments: McpPromptArguments;
                                   context: McpContext): McpPromptMessage {.
    closure.}

View source

McpPromptCompletionHandler

McpPromptCompletionHandler = proc (argument, prefix: string; context: McpContext): Future[
    seq[string]] {.closure.}

View source

McpSyncPromptCompletionHandler

McpSyncPromptCompletionHandler = proc (argument, prefix: string;
                                       context: McpContext): seq[string] {.
    closure.}

View source

McpCompletionHandler

McpCompletionHandler = proc (argument, prefix: string; context: McpContext): Future[
    seq[string]] {.closure.}

View source

McpCompletion

McpCompletion = object
  argument*: string
  handler*: McpCompletionHandler

View source

McpPrompt

McpPrompt = object
  name*: string
  title*: string
  description*: string
  icons*: JsonNode
  arguments*: seq[McpPromptArgument]

View source

Procedures

newMcpPromptArgument

proc newMcpPromptArgument(name: string; description = ""; required = false): McpPromptArgument {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpPromptArgument.

Arguments

Name	Type	Default
name	string
description	inferred	""
required	inferred	false

View source

validatePromptContent

proc validatePromptContent(content: JsonNode) {.raises: [McpError, KeyError],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
content	JsonNode

View source

newMcpPromptMessage

proc newMcpPromptMessage(role: McpPromptRole; content: JsonNode): McpPromptMessage {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpPromptMessage.

Arguments

Name	Type	Default
role	McpPromptRole
content	JsonNode

View source

userPrompt

proc userPrompt(content: JsonNode): McpPromptMessage {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpPromptMessage.

Arguments

Name	Type	Default
content	JsonNode

View source

assistantPrompt

proc assistantPrompt(content: JsonNode): McpPromptMessage {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpPromptMessage.

Arguments

Name	Type	Default
content	JsonNode

View source

userText

proc userText(text: string; annotations: JsonNode = nil): McpPromptMessage {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpPromptMessage.

Arguments

Name	Type	Default
text	string
annotations	JsonNode	nil

View source

assistantText

proc assistantText(text: string; annotations: JsonNode = nil): McpPromptMessage {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpPromptMessage.

Arguments

Name	Type	Default
text	string
annotations	JsonNode	nil

View source

toJson (overload 1)

proc toJson(message: McpPromptMessage): JsonNode {.raises: [], tags: [],
    forbids: [].}

Returns: JsonNode.

Arguments

Name	Type	Default
message	McpPromptMessage

View source

newMcpPrompt (overload 1)

proc newMcpPrompt(name: string; handler: McpPromptHandler; title = "";
                  description = ""; arguments: seq[McpPromptArgument] = @[];
                  icons: JsonNode = nil): McpPrompt {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpPrompt.

Arguments

Name	Type	Default
name	string
handler	McpPromptHandler
title	inferred	""
description	inferred	""
arguments	seq[McpPromptArgument]	@[]
icons	JsonNode	nil

View source

newMcpPrompt (overload 2)

proc newMcpPrompt(name: string; handler: McpPromptSingleHandler; title = "";
                  description = ""; arguments: seq[McpPromptArgument] = @[];
                  icons: JsonNode = nil): McpPrompt {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpPrompt.

Arguments

Name	Type	Default
name	string
handler	McpPromptSingleHandler
title	inferred	""
description	inferred	""
arguments	seq[McpPromptArgument]	@[]
icons	JsonNode	nil

View source

newMcpPrompt (overload 3)

proc newMcpPrompt(name: string; handler: McpSyncPromptHandler; title = "";
                  description = ""; arguments: seq[McpPromptArgument] = @[];
                  icons: JsonNode = nil): McpPrompt {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpPrompt.

Arguments

Name	Type	Default
name	string
handler	McpSyncPromptHandler
title	inferred	""
description	inferred	""
arguments	seq[McpPromptArgument]	@[]
icons	JsonNode	nil

View source

newMcpPrompt (overload 4)

proc newMcpPrompt(name: string; handler: McpSyncPromptSingleHandler; title = "";
                  description = ""; arguments: seq[McpPromptArgument] = @[];
                  icons: JsonNode = nil): McpPrompt {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpPrompt.

Arguments

Name	Type	Default
name	string
handler	McpSyncPromptSingleHandler
title	inferred	""
description	inferred	""
arguments	seq[McpPromptArgument]	@[]
icons	JsonNode	nil

View source

newMcpCompletion (overload 1)

proc newMcpCompletion(argument: string; handler: McpCompletionHandler): McpCompletion {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpCompletion.

Arguments

Name	Type	Default
argument	string
handler	McpCompletionHandler

View source

newMcpCompletion (overload 2)

proc newMcpCompletion(argument: string; handler: McpSyncPromptCompletionHandler): McpCompletion {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpCompletion.

Arguments

Name	Type	Default
argument	string
handler	McpSyncPromptCompletionHandler

View source

addCompletion (overload 1)

proc addCompletion(prompt: var McpPrompt; argument: string;
                   handler: McpPromptCompletionHandler) {.raises: [McpError],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
prompt	var McpPrompt
argument	string
handler	McpPromptCompletionHandler

View source

addCompletion (overload 2)

proc addCompletion(prompt: var McpPrompt; completion: McpCompletion) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
prompt	var McpPrompt
completion	McpCompletion

View source

addCompletion (overload 3)

proc addCompletion(prompt: var McpPrompt; argument: string;
                   handler: McpSyncPromptCompletionHandler) {.
    raises: [McpError], tags: [], forbids: [].}

Arguments

Name	Type	Default
prompt	var McpPrompt
argument	string
handler	McpSyncPromptCompletionHandler

View source

completePromptArgument

proc completePromptArgument(prompt: McpPrompt; 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
prompt	McpPrompt
argument	string
prefix	string
context	McpContext

View source

toJson (overload 2)

proc toJson(prompt: McpPrompt): JsonNode {.raises: [KeyError], tags: [],
    forbids: [].}

Returns: JsonNode.

Arguments

Name	Type	Default
prompt	McpPrompt

View source

decodePromptArguments

proc decodePromptArguments(prompt: McpPrompt; values: JsonNode): McpPromptArguments {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpPromptArguments.

Arguments

Name	Type	Default
prompt	McpPrompt
values	JsonNode

View source

getPromptArgument

proc getPromptArgument(arguments: McpPromptArguments; name: string;
                       required = true): string {.raises: [McpError, KeyError],
    tags: [], forbids: [].}

Returns: string.

Arguments

Name	Type	Default
arguments	McpPromptArguments
name	string
required	inferred	true

View source

runPrompt

proc runPrompt(prompt: McpPrompt; arguments: McpPromptArguments;
               context: McpContext): Future[seq[McpPromptMessage]] {.
    stackTrace: false, raises: [Exception, ValueError, McpError, KeyError],
    tags: [RootEffect], forbids: [].}

Returns: Future[seq[McpPromptMessage]].

Arguments

Name	Type	Default
prompt	McpPrompt
arguments	McpPromptArguments
context	McpContext

View source

Templates

mcpCompletion

Reusable prompt/resource-template completion declaration.

template mcpCompletion(argument: string; handler: untyped): McpCompletion

Returns: McpCompletion.

Arguments

Name	Type	Default
argument	string
handler	untyped

View source

mcpPrompt

Concise prompt declaration; message escaping remains explicit in handlers.

template mcpPrompt(name: string; handler: untyped; title = ""; description = "";
                   arguments: seq[McpPromptArgument] = @[];
                   icons: JsonNode = nil): McpPrompt

Returns: McpPrompt.

Arguments

Name	Type	Default
name	string
handler	untyped
title	inferred	""
description	inferred	""
arguments	seq[McpPromptArgument]	@[]
icons	JsonNode	nil

View source