Skip to main content
Glama

Get a batch’s progress

get_batch
Read-onlyIdempotent

The state of a batch and of each picture in it: queued, running, done, failed or cancelled, the job_id of its run once started (get_job gives the files), credits charged, and whether retry_batch can run it again.

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_idYesThe batch id start_batch returned.

Output Schema

NameRequiredDescriptionDefault
itemsYes
modelYes
sceneYes
countsYes
statusYes
batch_idYes
created_atYes
item_countYes
settled_atYes
quoted_creditsYesWhat the batch costs if every picture runs.
charged_creditsYesWhat its runs were charged so far.
per_item_creditsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / additionalProperties
      Added value: +false
  2. Changed6 schema fields changed
    • removedOutput schema / properties / items / items / properties / error_code / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / items / items / properties / error_code / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / items / items / properties / job_id / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / items / items / properties / job_id / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / settled_at / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / settled_at / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  3. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds the state vocabulary and cross-tool linkage (get_job, retry_batch), but most of what it covers is return payload that the output schema already documents, and it says nothing about polling frequency or how long states persist.

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 densely packed sentence that front-loads the core meaning (batch and per-picture state) before the auxiliary fields. The parenthetical about get_job is effective, though the trailing 'credits charged' and retry clause make it slightly run-on.

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 an output schema present, rich annotations, and full schema coverage on the only parameter, the description does enough: it names the sibling tools an agent needs next (get_job for files, retry_batch for reruns). Only polling behavior and terminality of states are left unaddressed.

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?

The single parameter batch_id has 100% schema description coverage ('The batch id start_batch returned'), which already explains its origin. The description adds no parameter-level meaning at all, so the baseline 3 for a fully documented schema applies.

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 clearly frames the tool as returning the state of a batch and of each picture in it, and enumerates the concrete states (queued, running, done, failed, cancelled) plus the job_id and credits fields. It separates itself from siblings by noting 'get_job gives the files' and by referencing retry_batch's eligibility check. It loses a point only because the action verb is implicit rather than stated.

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?

It gives clear usage context: poll this for progress, and note that this is not the tool for retrieving files ('get_job gives the files') and that the response tells you whether retry_batch can rerun it. There is no explicit when-not-to-use case or polling guidance, so it stops short of a 5.

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