Skip to main content
Glama

Batches Cancel

batches_cancel

Cancel an existing Pingen batch using its organisation and batch IDs to stop further processing of its letters, emails, or eBills.

Instructions

Cancel a batch. PATCH /organisations/{organisationId}/batches/{batchId}/cancel

No request body.

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_cancel"
  }
}

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?

With no annotations, the description carries the full disclosure burden. It implies a state-changing operation via the PATCH endpoint and clarifies there is no request body, but says nothing about reversibility, whether already-sent deliveries are affected, required permissions, or error behavior for already-cancelled batches.

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; the action is front-loaded and "No request body" is a useful eliminator of ambiguity about payload parameters. Slightly terse to the point of omitting preconditions, but nothing is wasted.

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 zero annotation coverage, no output schema, and 0% parameter description coverage, the description does too little: no state preconditions, no return value note (e.g., whether a cancellation status or the batch object comes back), and no failure conditions.

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 schema names the two required parameters without explaining them. The description partially compensates by showing both as path segments in the endpoint template, clarifying that organisation_id scopes the org and batch_id identifies the target, but adds no format or validation detail.

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?

"Cancel a batch" is a specific verb plus resource and is reinforced by the explicit endpoint PATCH .../batches/{batchId}/cancel. It does not, however, distinguish cancel from the sibling batches_delete, leaving the agent to guess how cancellation differs from deletion.

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 guidance on when to cancel rather than delete a batch, and no mention of preconditions such as whether only unsent/scheduled batches may be cancelled. The agent gets no routing or eligibility information.

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