nimwire/tasks

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

Opt-in MCP tasks extension with scoped, expiring task storage.

Constants

mcpTasksExtensionName

mcpTasksExtensionName = "io.modelcontextprotocol/tasks"

View source

Types

McpTaskStatus

McpTaskStatus = enum
  mcpTaskWorking, mcpTaskInputRequired, mcpTaskCompleted, mcpTaskFailed,
  mcpTaskCancelled

View source

McpTaskHandler

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

View source

McpTaskCreateProc

McpTaskCreateProc = proc (task: McpTask) {.closure.}

View source

McpTaskGetProc

McpTaskGetProc = proc (taskId, subject: string): McpTask {.closure.}

View source

McpTaskUpdateProc

McpTaskUpdateProc = proc (task: McpTask) {.closure.}

View source

McpTask

McpTask = ref object
  taskId*: string
  status*: McpTaskStatus
  statusMessage*: string
  createdAt*: string
  lastUpdatedAt*: string
  ttlMs*: int
  pollIntervalMs*: int
  progress*: float
  hasProgress*: bool
  total*: float
  hasTotal*: bool
  inputRequests*: JsonNode
  result*: McpWireResult
  hasResult*: bool
  error*: McpRpcError
  hasError*: bool
  owner*: string
  expiresAt*: int64
  cancellation*: McpCancellation

View source

McpTaskStore

Implement create/get/update for durable storage, or use the in-memory backend created by newMcpTaskStore.

McpTaskStore = ref object
  create*: McpTaskCreateProc
  get*: McpTaskGetProc
  update*: McpTaskUpdateProc

View source

Procedures

taskStatusName

proc taskStatusName(status: McpTaskStatus): string {.raises: [], tags: [],
    forbids: [].}

Returns: string.

Arguments

Name	Type	Default
status	McpTaskStatus

View source

newMcpTaskStore

proc newMcpTaskStore(ttlMs = 3600000; maxTasks = 10000; pollIntervalMs = 5000): McpTaskStore {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpTaskStore.

Arguments

Name	Type	Default
ttlMs	inferred	3600000
maxTasks	inferred	10000
pollIntervalMs	inferred	5000

View source

newMcpTaskStoreBackend

proc newMcpTaskStoreBackend(create: McpTaskCreateProc; get: McpTaskGetProc;
                            update: McpTaskUpdateProc; ttlMs = 3600000;
                            pollIntervalMs = 5000): McpTaskStore {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpTaskStore.

Arguments

Name	Type	Default
create	McpTaskCreateProc
get	McpTaskGetProc
update	McpTaskUpdateProc
ttlMs	inferred	3600000
pollIntervalMs	inferred	5000

View source

newMcpTaskResult

proc newMcpTaskResult(task: McpTask): McpWireResult {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpWireResult.

Arguments

Name	Type	Default
task	McpTask

View source

newMcpTaskGetResult

proc newMcpTaskGetResult(task: McpTask): McpWireResult {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpWireResult.

Arguments

Name	Type	Default
task	McpTask

View source

startMcpTask

proc startMcpTask(store: McpTaskStore; handler: McpTaskHandler;
                  arguments: JsonNode; context: McpContext;
                  outputSchema: JsonNode = nil): McpTask {.
    raises: [McpError, OSError, Exception], tags: [TimeEffect, RootEffect],
    forbids: [].}

Returns: McpTask.

Arguments

Name	Type	Default
store	McpTaskStore
handler	McpTaskHandler
arguments	JsonNode
context	McpContext
outputSchema	JsonNode	nil

View source

getMcpTask

proc getMcpTask(store: McpTaskStore; taskId: string; context: McpContext): McpTask {.
    raises: [Exception, McpError], tags: [RootEffect, TimeEffect], forbids: [].}

Returns: McpTask.

Arguments

Name	Type	Default
store	McpTaskStore
taskId	string
context	McpContext

View source

updateMcpTask

proc updateMcpTask(store: McpTaskStore; taskId: string; responses: JsonNode;
                   context: McpContext) {.
    raises: [Exception, McpError, KeyError], tags: [RootEffect, TimeEffect],
    forbids: [].}

Arguments

Name	Type	Default
store	McpTaskStore
taskId	string
responses	JsonNode
context	McpContext

View source

cancelMcpTask

proc cancelMcpTask(store: McpTaskStore; taskId: string; context: McpContext) {.
    raises: [Exception, McpError], tags: [RootEffect, TimeEffect], forbids: [].}

Arguments

Name	Type	Default
store	McpTaskStore
taskId	string
context	McpContext

View source

newMcpTasksExtension

proc newMcpTasksExtension(store: McpTaskStore): McpExtension {.
    raises: [McpError, Exception], tags: [RootEffect], forbids: [].}

Returns: McpExtension.

Arguments

Name	Type	Default
store	McpTaskStore

View source