Skip to main content
Glama

Get Batch

get_batch
Read-onlyIdempotent

Retrieve progress and completed results for a batch of shell commands, with an option to include unfinished placeholders. Use it to monitor parallel local or SSH tasks and collect outcomes.

Instructions

Collect background progress and finished results; full mode includes unfinished placeholders.

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": {
      "batch_id": "<batch_id>"
    },
    "name": "get_batch"
  }
}

Input Schema

NameRequiredDescriptionDefault
batch_idYes
output_modeNocompact
wait_secondsNo

Output Schema

NameRequiredDescriptionDefault
taskNo
errorNo
statusNo
resultsNo
batch_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

C2.6/5.0
Behavior3/5

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

Annotations already cover the safety profile (readOnlyHint, idempotentHint, openWorldHint=false), so the bar is lower. The description adds one genuine behavioral detail — that full mode includes placeholders for unfinished work — but omits the significant blocking behavior implied by wait_seconds (up to 30s), which an agent needs to know before calling.

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?

It is a single short sentence with no wasted words, so it is not verbose. But the brevity comes at the cost of clarity — the front-loaded clause 'Collect background progress and finished results' is ambiguous about what is actually returned.

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

Completeness2/5

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

An output schema exists, so return values needn't be explained. However, for a 3-parameter tool with 0% schema description coverage and three sibling tools, the description leaves the wait/poll semantics, the compact-vs-full difference, and the sibling routing all unaddressed.

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 all parameter meaning, and it does not. It hints at the 'full' value of output_mode but never explains 'compact' (the default), never mentions batch_id at all, and says nothing about wait_seconds despite its 0–30 bound being a meaningful behavioral knob.

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

Purpose3/5

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

The description says it 'collects background progress and finished results', which gestures at retrieving batch status/results, but never states the resource explicitly ('batch') or uses a precise verb like 'retrieve' or 'poll'. Combined with the name get_batch an agent can infer the purpose, but the description itself does not clearly distinguish it from execute_batch or execute.

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?

There is no statement of when to call this versus the siblings (cancel_batch, execute, execute_batch), and no mention of polling patterns or that wait_seconds can block. The only guidance-like clause ('full mode includes unfinished placeholders') is about output shape, not about tool selection.

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