Skip to main content
Glama

List batches

list_batches
Read-onlyIdempotent

Lists the workspace's batches, newest first, one page at a time, with each batch's ID, name, status, and total, completed, failed, and processing job counts; total counts every match, so it also answers how many batches exist. search matches part of a batch name, ignoring case, and templateId keeps one template's batches. For one known batch ID, get_batch returns the same counts, and job details are in get_batch_jobs. Needs batches:read.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number, starting at 1
limitNoResults per page (default 10); values above 20 are capped at 20
searchNoText matched against batch names
templateIdNoOnly batches with jobs for this template

Output Schema

NameRequiredDescriptionDefault
pageYes
itemsYes
limitYesPage size actually applied
totalYesCount of all matches across every page

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed13 schema fields changed
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / limit / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / page / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / templateId / 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})$"
    • addedOutput schema / properties / items / items / properties / cancelledRows / maximum
      Added value: +9007199254740991
    • addedOutput schema / properties / items / items / properties / completedRows / maximum
      Added value: +9007199254740991
    • addedOutput schema / properties / items / items / properties / failedRows / maximum
      Added value: +9007199254740991
    • addedOutput schema / properties / items / items / properties / id / 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})$"
    • addedOutput schema / properties / items / items / properties / processingRows / maximum
      Added value: +9007199254740991
    • addedOutput schema / properties / items / items / properties / totalRows / maximum
      Added value: +9007199254740991
    • addedOutput schema / properties / limit / maximum
      Added value: +9007199254740991
    • addedOutput schema / properties / page / maximum
      Added value: +9007199254740991
    • addedOutput schema / properties / total / maximum
      Added value: +9007199254740991
  2. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Beyond the readOnly/idempotent/non-destructive annotations, the description discloses ordering ('newest first'), paging behavior, included count fields, the meaning of `total`, case-insensitive partial matching for `search`, filtering via `templateId`, and the required `batches:read` permission. These details materially improve invocation confidence for a read 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?

The description is dense but front-loaded: it starts with what the tool lists and returns, then moves to filtering behavior, sibling alternatives, and the required permission. Every sentence contributes useful information without repetition.

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

Completeness5/5

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

For a low-complexity read-only listing tool with full schema descriptions and an output schema, the description covers purpose, behavior, filters, sibling alternatives, and auth requirements. Nothing essential is missing for correct selection or invocation.

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 coverage is 100%, so page and limit are already well documented in the schema. The description adds semantic meaning for `search` ('matches part of a batch name, ignoring case') and `templateId` ('keeps one template's batches'), though it does not elaborate on pagination parameters beyond the schema.

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?

The description states a specific verb and resource ('Lists the workspace's batches'), specifies ordering and pagination, and enumerates the returned batch fields. It also distinguishes the tool from get_batch by noting that get_batch should be used for one known batch ID.

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?

It explains the tool's purpose for listing, filtering, and counting batches, and explicitly routes the agent to get_batch for a single known ID and to get_batch_jobs for job details. This is clear when-to-use and alternative guidance with no misleading exclusions.

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