Skip to main content
Glama

get_batch

Fetch one batch's status, progress, and aggregated results by batch_uuid. Use it to check whether a batch has finished and how it is going; for the verdict of each address use get_batch_results, and to find a batch_uuid you lost use list_batches. Requires the results:read scope.

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_uuid": "<batch_uuid>"
    },
    "name": "get_batch"
  }
}

Input Schema

NameRequiredDescriptionDefault
batch_uuidYesPublic batch UUID returned by submit_batch or list_batches.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

No annotations, so the description carries the burden; it discloses the required results:read scope and the content classes returned (status, progress, aggregated results). It does not explain error behavior for an unknown or malformed batch_uuid, or the possible status values, which leaves a small gap for an unannotated tool.

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

Conciseness5/5

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

Three compact sentences, front-loaded with the action and return contents, followed by routing and auth requirements. Every clause carries information; nothing is redundant.

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

Completeness4/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 does tell the agent what comes back at a high level and covers scope and sibling routing. The shape of the 'aggregated results' object and the status field's value space remain unspecified, which matters slightly more given the absence of an output schema.

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 coverage is 100% and the sole parameter already documents itself as the public batch UUID returned by submit_batch or list_batches. The description adds no format or validation detail beyond restating the key name, so the baseline 3 applies.

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

Purpose5/5

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

States a specific verb and resource — fetch one batch's status, progress, and aggregated results keyed by batch_uuid. It also explicitly separates itself from get_batch_results (per-address verdicts) and list_batches (finding a lost UUID), so an agent can route without opening a schema.

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

Usage Guidelines5/5

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

Gives the triggering condition ('check whether a batch has finished and how it is going') and names both alternatives with the exact situations that select them. No inference required about which sibling to call.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources