nimwire/subscriptions

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

In-process change notification bus for modern MCP subscriptions.

Types

McpSubscriptionEventKind

McpSubscriptionEventKind = enum
  mcpToolsListChanged, mcpPromptsListChanged, mcpResourcesListChanged,
  mcpResourceUpdated

View source

McpSubscriptionFilter

McpSubscriptionFilter = object
  toolsListChanged*: bool
  promptsListChanged*: bool
  resourcesListChanged*: bool
  resourceSubscriptions*: seq[string]

View source

McpSubscriptionEvent

McpSubscriptionEvent = object
  kind*: McpSubscriptionEventKind
  uri*: string

View source

McpSubscriptionMessageHandler

McpSubscriptionMessageHandler = proc (message: JsonNode) {.closure.}

View source

McpEventPublisher

McpEventPublisher = proc (event: McpSubscriptionEvent) {.closure.}

View source

McpSubscriptionCloseHandler

McpSubscriptionCloseHandler = proc (subscription: McpSubscription;
                                    graceful: bool) {.closure.}

View source

McpSubscription

McpSubscription = ref object
  id*: McpId
  filter*: McpSubscriptionFilter
  active*: bool

View source

McpEventBus

McpEventBus = ref object

View source

Procedures

newMcpEventBus

proc newMcpEventBus(publisher: McpEventPublisher = nil): McpEventBus {.
    raises: [], tags: [], forbids: [].}

Returns: McpEventBus.

Arguments

Name	Type	Default
publisher	McpEventPublisher	nil

View source

subscribe

proc subscribe(bus: McpEventBus; id: McpId; filter: McpSubscriptionFilter;
               handler: McpSubscriptionMessageHandler): McpSubscription {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpSubscription.

Arguments

Name	Type	Default
bus	McpEventBus
id	McpId
filter	McpSubscriptionFilter
handler	McpSubscriptionMessageHandler

View source

activate

proc activate(subscription: McpSubscription) {.raises: [], tags: [], forbids: [].}

Arguments

Name	Type	Default
subscription	McpSubscription

View source

unsubscribe

proc unsubscribe(bus: McpEventBus; subscription: McpSubscription): bool {.
    raises: [Exception], tags: [RootEffect], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
bus	McpEventBus
subscription	McpSubscription

View source

setCloseHandler

proc setCloseHandler(subscription: McpSubscription;
                     handler: McpSubscriptionCloseHandler) {.raises: [],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
subscription	McpSubscription
handler	McpSubscriptionCloseHandler

View source

close

proc close(subscription: McpSubscription; graceful = true) {.
    raises: [Exception], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
subscription	McpSubscription
graceful	inferred	true

View source

isActive

proc isActive(subscription: McpSubscription): bool {.raises: [], tags: [],
    forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
subscription	McpSubscription

View source

waitClosed

proc waitClosed(subscription: McpSubscription): Future[void] {.
    raises: [McpError], tags: [], forbids: [].}

Returns: Future[void].

Arguments

Name	Type	Default
subscription	McpSubscription

View source

notification

proc notification(subscription: McpSubscription; event: McpSubscriptionEvent): JsonNode {.
    raises: [KeyError], tags: [], forbids: [].}

Returns: JsonNode.

Arguments

Name	Type	Default
subscription	McpSubscription
event	McpSubscriptionEvent

View source

deliver

proc deliver(subscription: McpSubscription; message: JsonNode) {.
    raises: [Exception], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
subscription	McpSubscription
message	JsonNode

View source

publish

proc publish(bus: McpEventBus; event: McpSubscriptionEvent) {.
    raises: [Exception, KeyError], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
bus	McpEventBus
event	McpSubscriptionEvent

View source

publishToolsChanged

proc publishToolsChanged(bus: McpEventBus) {.raises: [Exception, KeyError],
    tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
bus	McpEventBus

View source

publishPromptsChanged

proc publishPromptsChanged(bus: McpEventBus) {.raises: [Exception, KeyError],
    tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
bus	McpEventBus

View source

publishResourcesChanged

proc publishResourcesChanged(bus: McpEventBus) {.raises: [Exception, KeyError],
    tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
bus	McpEventBus

View source

publishResourceUpdated

proc publishResourceUpdated(bus: McpEventBus; uri: string) {.
    raises: [Exception, KeyError], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
bus	McpEventBus
uri	string

View source