Skip to main content
Glama

Batches Send

batches_send

Sends a prepared batch via the Pingen API by submitting a JSON:API payload to the send endpoint, enabling programmatic dispatch of letters, emails, or eBills.

Instructions

Send a batch. PATCH /organisations/{organisationId}/batches/{batchId}/send

payload is the full JSON:API document (one of the BatchSendChannel* schemas), sent 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>",
      "payload": "<payload>"
    },
    "name": "batches_send"
  }
}

Input Schema

NameRequiredDescriptionDefault
payloadYes
batch_idYes
organisation_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/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 usefully discloses that the payload is sent verbatim as a JSON:API document conforming to one of the BatchSendChannel* schemas — a real behavioral detail. It says nothing about side effects (does this dispatch real deliveries?), reversibility, required permissions, or idempotency, which matter for a send 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 sentences, front-loaded with the action, followed by the endpoint and the one non-obvious payload constraint. The raw HTTP path is arguably redundant but still clarifying, and there is no filler.

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 mutation tool with no annotations, no output schema and an untyped nested payload, the description omits prerequisites, side effects, error behavior and the payload's required shape. An agent knows what the call is, but not enough to invoke it safely or predict the outcome.

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%, so the description must compensate. It does give genuine meaning for 'payload' (full JSON:API document, BatchSendChannel* variant, sent verbatim), but the internal structure of that nested object is undocumented in both places, and organisation_id/batch_id are only clarified implicitly via the 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?

States a specific verb and resource ('Send a batch') and pins it to the exact endpoint PATCH /organisations/{organisationId}/batches/{batchId}/send, which separates it from batches_edit, batches_cancel and batches_create. What 'send' actually does to deliveries is only implied, keeping it short of a 5.

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?

No statement of when to call this versus siblings such as batches_create, batches_edit or batches_cancel, and no prerequisites (e.g. that the batch must already exist or be in a sendable state). The lifecycle position is left entirely to inference from the endpoint path.

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