Skip to main content
Glama

Deliveries Emails Cancel

deliveries_emails_cancel

Cancel a pending email delivery for a specified organisation; no request body is required.

Instructions

Cancel an email. PATCH /organisations/{organisationId}/deliveries/emails/{emailId}/cancel

Cancels a pending email; the request carries no 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>",
      "email_id": "<email_id>"
    },
    "name": "deliveries_emails_cancel"
  }
}

Input Schema

NameRequiredDescriptionDefault
email_idYes
organisation_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/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. It usefully discloses that the request has no body, but says nothing about permission requirements, whether cancellation is reversible, what happens to an already-sent or already-cancelled email, or what the response contains.

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, with no filler. The raw path line is slightly redundant with the parameter names but does clarify endpoint placement.

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?

The tool is simple (two required string params, no nested objects, no output schema), so a brief definition is defensible, but a state-changing operation with zero annotations and zero schema descriptions should say more about preconditions and irreversibility.

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 coverage is 0% and neither parameter is described in the schema, but the names organisation_id and email_id are self-explanatory and the embedded path template shows where each one is placed in the URL. Format or ID-type details are still absent from both sources.

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 ("Cancel an email") and pins it to a concrete endpoint, so the agent knows the exact operation. The one ambiguity is that it never contrasts with the sibling deliveries_emails_delete, leaving the cancel-vs-delete distinction to inference.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

"Cancels a pending email" implies a precondition (only pending emails qualify), which is useful implied guidance. However there is no explicit statement of when to prefer this over deleting the email, nor what to do if the email is already sent.

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