Skip to main content
Glama

Cancel a subscription

xaalis_cancel_subscription
DestructiveIdempotent

Cancel now (voids the unpaid invoice if checkout hasn't started) or at the end of the current period.

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": {
      "id": "<id>",
      "at_period_end": "<at_period_end>",
      "idempotency_key": "<idempotency_key>"
    },
    "name": "xaalis_cancel_subscription"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesSubscription id (sub_…)
at_period_endYestrue = stop after the current period
idempotency_keyYesStable key for this business action (e.g. order-1042). Reuse the SAME key when retrying; a new key creates a new operation.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare this as destructive, idempotent, and open-world. The description adds a concrete consequence beyond annotations: immediate cancellation voids the unpaid invoice only if checkout hasn't started, which helps an agent understand the real side effect. It does not cover permission requirements, error behavior, or 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?

A single sentence with no filler, front-loading the immediate-vs-period-end distinction. Every clause earns its place.

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

Completeness4/5

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

For a three-parameter mutation tool with full schema coverage and annotations covering safety and idempotency, the description supplies the key destructive consequence and the two cancellation modes. It omits permission/prerequisite details and failure behavior, but the essentials for correct invocation are present.

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 100%, so all three parameters are already documented in the schema. The description reinforces the at_period_end distinction but adds no new syntax, format, or constraint details beyond what the schema provides, so baseline 3 is appropriate.

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 (cancel) and resource (subscription) and clearly separates the two cancellation modes: immediate and at period end. It does not explicitly name or distinguish itself from sibling tools such as xaalis_advance_subscription, but the purpose is unambiguous.

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?

The description implies when each mode applies: immediate cancellation voids an unpaid invoice if checkout has not started, while the alternative stops at the end of the current period. It gives no explicit guidance about when to use this tool versus adjacent tools like refund_payment or advance_subscription.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources