Skip to main content
Glama

Batch status

batch_status
Read-only

Read a batch started with batch: its progress, and one page of results in the order the URLs were sent. When nextOffset is not null, pass it as offset to read the next page of results.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoResults to return in this call (default 10).
offsetNoPosition of the first result to return. Defaults to 0.
batchIdYesThe id returned by batch.
maxCharsPerPageNoCut each page's markdown to this many characters; a cut page says so in data.truncated with its full length. Use it when results are too large for your context.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / maxCharsPerPage
      Added value: +{
      +  "description": "Cut each page's markdown to this many characters; a cut page says so in data.truncated with its full length. Use it when results are too large for your context.",
      +  "maximum": 9007199254740991,
      +  "minimum": 500,
      +  "type": "integer"
      +}
  2. Changed2 schema fields changed
    • addedInput schema / properties / batchId / format
      Added value: +"uuid"
    • addedInput schema / properties / batchId / pattern
      Added value: +"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
  3. Changed2 schema fields changed
    • addedInput schema / properties / limit
      Added value: +{
      +  "description": "Results to return in this call (default 10).",
      +  "maximum": 25,
      +  "minimum": 1,
      +  "type": "integer"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "description": "Position of the first result to return. Defaults to 0.",
      +  "maximum": 9007199254740991,
      +  "minimum": 0,
      +  "type": "integer"
      +}
  4. Added

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already carry the safety profile (readOnlyHint=true, destructiveHint=false, openWorldHint=true), so this is known to be a safe read. The description adds behaviors beyond that: results are returned one page at a time, in the order the URLs were sent, and the paging contract via nextOffset. It does not mention rate limits, auth, or terminal batch states.

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?

Two sentences, no filler, and the what-is-it clause is front-loaded before the paging instruction. Every clause carries an actionable fact.

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?

There is no output schema, so the description is the only place an agent can learn the return shape; it names progress, a page of results, and nextOffset, which covers the paging loop. However, it omits the rest of the payload (completion state, totals, data.truncated) that the agent must interpret to decide whether to keep polling, so it is only partially complete for a no-output-schema tool.

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

Parameters4/5

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

Schema description coverage is 100%, so the baseline is 3, but the description adds semantics the schema does not: the relationship between the returned nextOffset and the `offset` parameter, i.e., how the parameters chain across calls. It says nothing about `limit` or `maxCharsPerPage` beyond what the schema already states.

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 ('Read a batch') plus the concrete payload ('its progress, and one page of results'), and explicitly ties itself to the sibling that produced the input ('started with batch'). An agent can distinguish this from `batch` (the creator) and from `crawl_status` without opening either schema.

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?

Gives an explicit conditional instruction for pagination: 'When nextOffset is not null, pass it as offset to read the next page of results.' This tells the agent exactly how to continue, but offers no guidance on when not to call it (e.g., completed/failed batches) or how it differs from other status siblings.

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