Skip to main content
Glama

Batches List

batches_list

Retrieve batches for an organisation with pagination and pass-through query options for sorting, filtering, searching, and field selection.

Instructions

List batches. GET /organisations/{organisationId}/batches

page_number/page_limit map to page[number]/page[limit]; query keys (sort, filter, q, include, fields[...]) pass through verbatim.

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": {
      "organisation_id": "<organisation_id>"
    },
    "name": "batches_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryNo
page_limitNo
page_numberNo
organisation_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It does usefully disclose that query keys are forwarded verbatim to the API rather than validated, but it says nothing about authentication, rate limiting, result ordering, or what a response contains, leaving meaningful behavioral gaps for a list operation.

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?

Two short, front-loaded sentences with no filler. The endpoint line is slightly redundant with the tool name but does convey scoping that would otherwise be missing.

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?

For a four-parameter list tool with no annotations, no output schema, and 0% schema coverage, the description covers pagination and query pass-through adequately but leaves the caller without any sense of the returned data shape or default ordering. It is minimally sufficient rather than complete.

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 0%, so the description must compensate, and it largely does: it names the accepted query keys (sort, filter, q, include, fields[...]) and explains that page_number/page_limit map to page[number]/page[limit]. The only remaining gap is that organisation_id is documented only implicitly through the endpoint path template.

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 pairs a specific verb and resource ("List batches") with the exact REST endpoint, which also reveals the organisation-scoped nature of the listing. It is not differentiated from siblings such as batches_show or batches_events, but the verb+resource combination is unambiguous.

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 explicit when-to-use guidance, no prerequisites, and no mention of when another tool (e.g. batches_show, organisations_batches_statistics_details) would be a better choice. Usage is only inferable from the endpoint path, which lists batches under an organisation.

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