Skip to main content
Glama

Read checkpointed ZCode batch status

zcode_batch_status
Read-only

Read a batch's checkpointed manifest, item statuses, aggregated token usage, and any circuit-breaker blocker so you can monitor progress and diagnose stalled or blocked runs.

Instructions

Read the current checkpointed manifest, item statuses, aggregated token usage, and any circuit-breaker blocker for a batchId.

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": {
      "batchId": "<batchId>"
    },
    "name": "zcode_batch_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
batchIdYes
includeItemsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds real behavioral signal beyond that: reads are of a durable checkpointed manifest, results aggregate token usage, and a circuit-breaker blocker may be returned—telling the agent to expect failure-state reporting, not just happy path. It omits scope details like whether a missing batch errors or returns empty.

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

Conciseness4/5

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

One front-loaded sentence with zero filler, listing the returned artifacts compactly. It could be restructured to also cover the includeItems toggle without adding bulk, but nothing is wasted as written.

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

Completeness3/5

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

No output schema exists, and the description does a fair job enumerating the returned components for a read-only status tool. But with 0% schema coverage on the parameters and no sibling disambiguation, an agent still lacks enough to call it confidently with includeItems or to choose it over the adjacent status tools.

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

Parameters2/5

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

Schema coverage is 0%, so the description carries full burden: it identifies batchId only implicitly by naming the concept, with no format, sourcing, or validity notes. includeItems is not mentioned at all, leaving half the parameters undocumented in both schema and description.

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?

Specific verb ("Read") plus a concrete resource set: checkpointed manifest, item statuses, aggregated token usage, and circuit-breaker blocker, scoped by batchId. It's clear what comes back, but nothing distinguishes it from near-namesakes like swarm_batch_status, zcode_status, or zcode_progress.

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

Usage Guidelines2/5

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

The description never says when to use this versus swarm_batch_status, zcode_status, zcode_progress, or zcode_result. An agent must infer from the name alone that this is the batch-level checkpoint read rather than a live progress poll or a final-result fetch.

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