Skip to main content
Glama

Letters Cancel

letters_cancel

Cancel a physical letter by organisation and letter ID, queuing the cancellation request through the Pingen API.

Instructions

Cancel a letter. PATCH /organisations/{organisationId}/deliveries/letters/{letterId}/cancel

No request body. Answers 202 once the cancellation is queued.

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>",
      "letter_id": "<letter_id>"
    },
    "name": "letters_cancel"
  }
}

Input Schema

NameRequiredDescriptionDefault
letter_idYes
organisation_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/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 useful behaviour: no request body is needed and a 202 is returned once cancellation is queued, signalling an asynchronous operation. It omits whether cancellation is reversible, whether it can be repeated safely, or what happens if the letter is already delivered — gaps that matter for a mutation tool.

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?

Three short sentences, front-loaded with the action, followed by the endpoint and the response contract. Nothing is padded, though the bare URL on its own line adds little beyond the sibling naming convention.

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

Completeness3/5

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

For a two-parameter mutation with no annotations and no output schema, the description covers the essential call mechanics (path, no body, 202). It falls short on failure modes, idempotency, and permission requirements, which an agent needs before invoking a state-changing operation.

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%, and the description supplies no meaning for 'organisation_id' or 'letter_id' beyond their appearance in the URL template. An agent gets the resource path shape but no format, sourcing, or constraint details for either required 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 ('Cancel a letter') and names the exact endpoint, so the operation is unambiguous. It does not distinguish cancellation from the sibling 'letters_delete', which is a meaningful semantic difference an agent would want clarified.

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 to cancel versus delete a letter, nor any stated prerequisites (e.g. whether the letter must already be sent, or must not have been dispatched). The agent must infer all selection criteria from the name alone.

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