Skip to main content
Glama

Read checkpointed swarm batch status

swarm_batch_status
Read-only

Read a batch's current manifest, item statuses, aggregated token and credit usage, and any blocker for a batchId to track progress and diagnose stalled jobs.

Instructions

Read the current manifest, item statuses, aggregated token/credit usage, and any 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": "swarm_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 and the bar is lower. The description adds useful content disclosure (returns a manifest, per-item statuses, aggregated usage, and blockers), but says nothing about what "checkpointed" or "blocker" means operationally, whether results are stale/eventually consistent, or how large the item list can get.

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?

A single front-loaded sentence with no filler; every listed noun corresponds to real output content. It could be slightly better structured by separating what the tool does from what it returns, but there is no wasted wording.

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?

With no output schema, the description usefully enumerates the returned sections, which covers a lot of the return-value burden for a read-only tool. However, the undocumented includeItems flag and the absence of any note on result size or state semantics leave a real gap for a two-parameter status reader.

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 description coverage is 0%, so the description must carry parameter meaning and it only partially does: batchId is implied as the batch key but its format/constraints are documented only in the schema pattern. The second parameter, includeItems, is never mentioned at all, leaving the agent to guess whether omitting it suppresses the item statuses the description promises.

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?

The description gives a specific verb ("Read") and enumerates the exact resources returned: manifest, item statuses, aggregated token/credit usage, and blockers, scoped by batchId. This is far more than a name restatement, though it never names a sibling (e.g., zcode_batch_status or swarm_status) to distinguish itself from the several overlapping status tools.

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?

Usage is only implied by the phrase "for a batchId"; there is no statement of when to prefer this over swarm_status, zcode_batch_status, or swarm_batch_run, and no mention of prerequisites such as the batch still being active or checkpointed. An agent must infer selection from the tool name alone.

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