Skip to main content
Glama

Batches Delete

batches_delete

Deletes a specified batch within an organisation by sending the required JSON:API payload to the Pingen API, enabling cleanup or removal of batch records.

Instructions

Delete a batch. DELETE /organisations/{organisationId}/batches/{batchId}

The spec marks a required JSON:API request body for this DELETE (schema BatchDeleteDELETE); payload is 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_delete"
  }
}

Input Schema

NameRequiredDescriptionDefault
payloadYes
batch_idYes
organisation_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose a genuinely non-obvious trait: this DELETE requires a JSON:API request body (BatchDeleteDELETE schema) sent verbatim. However, it says nothing about irreversibility, what happens to already-sent deliveries in the batch, required scopes/permissions, or the response shape.

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?

Two short sentences, front-loaded with the action, with the endpoint and the body caveat following immediately. Nothing is padding; the network-path notation is compact and useful.

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 destructive, annotation-free tool with a nested free-form required payload and no output schema, the description leaves too much open: payload structure is unstated, and consequences of the delete are unaddressed. It covers the unusual required-body mechanic but not the risk profile an agent needs before calling it.

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?

Schema coverage is 0% and all three parameters are required, but the description adds real meaning: it names the body schema (BatchDeleteDELETE) and states that payload is forwarded verbatim, which is the key semantic for an otherwise opaque free-form object. organisation_id and batch_id remain documented only by name and endpoint templating.

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: "Delete a batch", reinforced by the literal endpoint DELETE /organisations/{organisationId}/batches/{batchId}. It does not explicitly distinguish itself from the sibling batches_cancel (cancel vs. delete), which is the one distinction an agent most needs here.

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 statement of when to use this over batches_cancel, batches_edit, or batches_create, nor of prerequisites such as ownership or batch state. The only usage-adjacent fact is that a body is required, which is a mechanics note rather than selection guidance.

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