Skip to main content
Glama

Batches Show

batches_show

Fetch details of a specific batch by organisation and batch ID, with query fields passed through verbatim, to inspect or verify batch information.

Instructions

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

query keys (fields[batches]) 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_show"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryNo
batch_idYes
organisation_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.7/5.0
Behavior2/5

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

With no annotations and no output schema, the description carries the full behavioral burden. It discloses the GET endpoint and that query keys pass through verbatim, but does not state authentication requirements, response shape, error behavior, or whether any side effects occur.

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?

The description is short and front-loaded, with the core purpose first and endpoint details second. The query pass-through note is terse but useful; minor ambiguity around 'fields[batches]' keeps it from being fully polished.

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

Completeness2/5

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

For a read tool with no annotations, no output schema, and 0% schema parameter coverage, the description is incomplete. It gives the endpoint and one query note, but lacks sufficient detail about parameters, returns, and operational behavior for an agent to call it confidently.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate. It adds some meaning for the query parameter by mentioning fields[batches] pass-through, but does not explain the two required path parameters beyond the endpoint template, leaving key parameter semantics undocumented.

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 details of a batch,' and supplies the HTTP endpoint. It clearly distinguishes retrieval of a single batch from list/event sibling tools, though it does not explicitly name alternatives.

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_list, batches_events, or other siblings. The retrieval intent is implied by 'Get details,' but no conditions, exclusions, or alternatives are provided.

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