Skip to main content
Glama

watch_print_status

Read-only

Check a background 3D print watcher's progress, collected snapshots, and completion state, or block until a print event fires to avoid repeated polling.

Instructions

Check the current status of a background print watcher.

        Returns progress, collected snapshots, and whether the watcher
        has finished.

        By default returns immediately with the current state.  Set
        ``block_until_event=True`` to wait server-side until a new
        event fires on the bus matching this watcher's printer (or
        ``timeout`` seconds elapse).  Loop a single blocking call
        instead of polling every N seconds — roughly 50× fewer tool
        invocations on a multi-hour print.

        Args:
            watch_id: The watcher ID returned by ``watch_print``.
            block_until_event: If True, block until a matching event
                arrives on the event bus or ``timeout`` is reached.
                Default False (return immediately, current behaviour).
            timeout: Maximum seconds to block when
                ``block_until_event=True``.  Default 60.  MCP clients
                should set their tool-call timeout comfortably above
                this (e.g. 120s) so the call returns cleanly instead
                of being killed mid-wait.
            event_types: Optional list of event-type strings to wait
                on.  Defaults to
                ``["vision.alert", "print.terminal", "recovery.completed"]``
                — failure alerts, print completion, and recovery
                terminal state (so a recovered-and-resumed print
                doesn't leave the watcher hanging if no
                ``print.terminal`` fires for the failed attempt).
                Pass a custom list to wait on different events
                (e.g. ``["vision.frame_captured"]`` to wake on
                every snapshot).

        When ``block_until_event=True`` and an event arrives, the
        return payload includes ``events_received`` (list of events)
        alongside the watcher's current status.  On timeout the
        payload includes ``timed_out: True``.  If the watcher has
        already finished before subscription, the call returns
        immediately with ``watcher_already_finished: True``.
        

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "watch_id": "<watch_id>"
    },
    "name": "watch_print_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
timeoutNoMaximum seconds to block when ``block_until_event=True``. Default 60. MCP clients should set their tool-call timeout comfortably above this (e.g. 120s) so the call returns cleanly instead of being killed mid-wait. Default: 60.
watch_idYesThe watcher ID returned by ``watch_print``.
event_typesNoOptional list of event-type strings to wait on. Defaults to ``["vision.alert", "print.terminal", "recovery.completed"]`` — failure alerts, print completion, and recovery terminal state (so a recovered-and-resumed print doesn't leave the watcher hanging if no ``print.terminal`` fires for the failed attempt). Pass a custom list to wait on different events (e.g. ``["vision.frame_captured"]`` to wake on every snapshot).
block_until_eventNoIf True, block until a matching event arrives on the event bus or ``timeout`` is reached. Default False (return immediately, current behaviour). Default: false.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.5.1
    • changedInput schema / properties / block_until_event / description
      Previous value: -"Default: false."New value: +"If True, block until a matching event arrives on the event bus or ``timeout`` is reached. Default False (return immediately, current behaviour). Default: false."
    • addedInput schema / properties / event_types / description
      Added value: +"Optional list of event-type strings to wait on.  Defaults to ``[\"vision.alert\", \"print.terminal\", \"recovery.completed\"]`` — failure alerts, print completion, and recovery terminal state (so a recovered-and-resumed print doesn't leave the watcher hanging if no ``print.terminal`` fires for the failed attempt). Pass a custom list to wait on different events (e.g. ``[\"vision.frame_captured\"]`` to wake on every snapshot)."
    • changedInput schema / properties / timeout / description
      Previous value: -"Default: 60."New value: +"Maximum seconds to block when ``block_until_event=True``.  Default 60.  MCP clients should set their tool-call timeout comfortably above this (e.g. 120s) so the call returns cleanly instead of being killed mid-wait. Default: 60."
    • addedInput schema / properties / watch_id / description
      Added value: +"The watcher ID returned by ``watch_print``."
  2. Changed5 schema fields changedv1.5.0
    • removedInput schema / properties / block_until_event / default
      Removed value: -false
    • addedInput schema / properties / block_until_event / description
      Added value: +"Default: false."
    • removedInput schema / properties / event_types / default
      Removed value: -null
    • removedInput schema / properties / timeout / default
      Removed value: -60
    • addedInput schema / properties / timeout / description
      Added value: +"Default: 60."
  3. First observedv0.1.0

TDQS

A4.1/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover the safety profile (readOnly, non-destructive, closed-world), yet the description adds substantial operational detail: server-side blocking semantics, the default event set and why `recovery.completed` is included, and the three distinct terminal outcomes (`events_received`, `timed_out`, `watcher_already_finished`). The warning to set the client tool-call timeout above `timeout` (e.g. 120s) is exactly the kind of caller-side hazard disclosure that annotations cannot carry.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The opening sentence is well front-loaded, and the closing paragraph about return payloads earns its place since there is no output schema. However, the full Args block duplicates the input schema word-for-word, which is roughly half the description and adds length without adding information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description takes on the burden of describing return values and does so for every terminal case: event arrival, timeout, and already-finished watchers. For a four-parameter read tool with annotations, nothing an agent needs in order to call it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The Args block restates the schema descriptions almost verbatim (identical text for `timeout`, `event_types`, `watch_id`, `block_until_event`), adding rationale but no new parameter semantics beyond what the schema already documents.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource — check the current status of a background print watcher — and immediately enumerates what is returned (progress, snapshots, finished flag). It ties itself to `watch_print` via the required `watch_id`, but never distinguishes itself from nearby siblings like `monitor_print`, `first_layer_status`, or `await_print_completion`, so the reader must infer the boundary.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives clear default-vs-optional behavior (returns immediately unless `block_until_event=True`) and an explicit motivating scenario for the blocking mode: a single blocking call instead of polling every N seconds, ~50x fewer invocations on a multi-hour print. It does not state when to prefer this tool over `watch_print`/`await_print_completion`, so no exclusions are offered.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools