Skip to main content
Glama

Batches Events

batches_events

Fetch a paginated collection of event records for a specified organisation and batch, passing through filters, sorting, and includes.

Instructions

Get a collection of batch events. GET /organisations/{organisationId}/batches/{batchId}/events

page_number/page_limit map to page[number]/page[limit]; query keys (language, 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>",
      "batch_id": "<batch_id>"
    },
    "name": "batches_events"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryNo
batch_idYes
page_limitNo
page_numberNo
organisation_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden; it does disclose the read-only GET nature and the non-obvious translation of page_number/page_limit into page[number]/page[limit] and verbatim passthrough of query keys, which is genuine behavioral context. It says nothing about authentication requirements, rate limits, result volume, or the shape/ordering of the returned event collection.

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?

Purpose is front-loaded in the first sentence, followed by the endpoint and two tightly scoped clarifications about parameter mapping. No sentence is redundant or padded.

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 5-parameter read tool with no annotations and no output schema, the description covers input mechanics adequately but omits what an event record contains and whether the list is paginated in the response. An agent could invoke it correctly but would be guessing at the return payload.

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?

With 0% schema description coverage across 5 parameters, the description compensates well for the two pagination params and the free-form query object, naming the accepted keys (language, sort, filter, q, include, fields[...]) and stating they pass through verbatim. It adds nothing about organisation_id or batch_id beyond the path template, but those are self-evident from the route.

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 states a specific verb and resource ('Get a collection of batch events') and gives the underlying endpoint, so an agent knows exactly what is returned. It does not distinguish this from sibling event-listing tools such as deliveries_emails_events or letters_events, leaving that discrimination to the resource name alone.

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 guidance on when to use this tool versus batches_show, batches_list, or the other *_events tools. The pagination and query-passthrough notes describe how to call it, not when to prefer it over an alternative.

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