Skip to main content
Glama

Cancel Schedule

cancel_schedule
DestructiveIdempotent

Cancel active schedules for the linked wallet. Call list_schedules first to get a real id. Pass id to cancel exactly one (no PIN needed). Cancelling several at once — provider for every schedule of that provider, or all: true for every schedule on this wallet — requires the PIN, asked from the human each time. Calling with none of id/provider/all is refused rather than cancelling everything.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoThe exact schedule id from list_schedules. Cancels only that one schedule. No PIN needed.
allNoSet true to cancel EVERY active schedule on this wallet. Requires pin. Never inferred — must be passed explicitly.
pinNoThe PIN set when the API key was created. Required with provider or all; not needed for a single id.
api_keyNoAbaPay MCP API key. NOT needed when the connector is authorized via OAuth — omit it entirely in that case.
providerNoCancel every active schedule for this provider, e.g. "mtn". Requires pin. Ignored if id is also given.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedInput schema / properties / all
      Added value: +{
      +  "description": "Set true to cancel EVERY active schedule on this wallet. Requires pin. Never inferred — must be passed explicitly.",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / id / description
      Previous value: -"The exact schedule id from list_schedules. Cancels only that one schedule."New value: +"The exact schedule id from list_schedules. Cancels only that one schedule. No PIN needed."
    • addedInput schema / properties / pin
      Added value: +{
      +  "description": "The PIN set when the API key was created. Required with provider or all; not needed for a single id.",
      +  "type": "string"
      +}
    • changedInput schema / properties / provider / description
      Previous value: -"Cancel every active schedule for this provider, e.g. \"mtn\". Ignored if id is also given."New value: +"Cancel every active schedule for this provider, e.g. \"mtn\". Requires pin. Ignored if id is also given."
  2. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare destructive, idempotent, open-world, non-read-only. The description adds genuinely new behavior: PIN is required for multi-cancel and re-requested from the human each time, single-id cancel needs no PIN, and an empty selector is refused. It does not discuss irreversibility or return shape, keeping it short of a 5.

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?

Front-loads the operation, then the safety rules, then the failure mode. Every sentence carries actionable information (sequencing, PIN rules, refusal behavior) with no filler.

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

Completeness5/5

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

A destructive, zero-required-param tool with no output schema is fully covered: selection modes, auth requirements, and the empty-selector guard are all specified. Nothing needed for correct invocation is missing.

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 100%, so the baseline is 3, but the description adds cross-parameter semantics beyond the schema: exactly-one cancellation for id, no-PIN rule, and PIN prompting cadence per bulk operation. It reinforces the mutual-exclusion behavior of provider vs id.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (cancel) and resource (schedules) scoped to the linked wallet, and explicitly separates single-id cancellation from bulk cancellation via provider/all. It is clearly distinguishable from the sibling list_schedules, which it names.

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

Usage Guidelines5/5

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

Gives explicit sequencing (call list_schedules first for a real id), names the alternatives (id vs provider vs all) with the condition selecting each, and states what happens with no selector at all (refused rather than cancelling everything). No inference required.

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.