Skip to main content
Glama

Organisations Batches Statistics Details

organisations_batches_statistics_details

Retrieve statistics for a specific batch within an organisation to monitor delivery performance and track batch progress.

Instructions

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

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": "organisations_batches_statistics_details"
  }
}

Input Schema

NameRequiredDescriptionDefault
batch_idYes
organisation_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full disclosure burden. The embedded 'GET' hints at a read-only call, but the definition says nothing about what the statistics comprise, the aggregation window, whether results are cached or expensive to compute, or what a call returns.

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 sentences with the purpose front-loaded and the endpoint as supporting detail. Nothing is padded, though the endpoint restates the tool name rather than adding new constraints.

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?

There is no output schema, so the description is the only place return values could be explained — yet it never says what statistics are returned or in what shape. For a details/reporting tool with two opaque path IDs, that is a meaningful gap an agent would notice when trying to use the result.

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

Parameters3/5

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

Schema description coverage is 0% for the two required parameters, so the description must compensate. The path template 'GET /organisations/{organisationId}/batches/{batchId}/statistics' does clarify the role and nesting of each ID, which is genuine added meaning, but it gives no format or type detail (e.g., ID shape) for either parameter.

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 statistics of a batch'), which is clearly distinct from mutation siblings like batches_cancel or batches_send. It does not explicitly contrast with batches_show or batches_events, so the differentiation is left implicit rather than stated.

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 guidance on when this tool should be chosen versus alternatives such as batches_show or batches_events. The agent must infer the use case from the word 'statistics' alone, with no prerequisites or exclusions stated.

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