Skip to main content
Glama

platform_cancel_run

Request cancellation of a running platform run; stops execution at its next checkpoint. Use it to halt active crawls or jobs safely without deleting records.

Instructions

Request cancellation of a RUNNING platform run (sets the cancel_requested flag; the runner terminates as cancelled at its next checkpoint). Terminal runs return an explanation, unknown ids {"status": "not_found"}.

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": {
      "run_id": "<run_id>"
    },
    "name": "platform_cancel_run"
  }
}

Input Schema

NameRequiredDescriptionDefault
run_idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

Adds real value beyond the annotations: it discloses that cancellation is asynchronous and cooperative (a cancel_requested flag, runner terminates at its next checkpoint), and it documents the terminal-run and not-found responses. This is consistent with readOnlyHint=false and destructiveHint=false. It does not address idempotency, even though idempotentHint=false suggests repeat calls may behave differently.

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?

Three compact sentences, front-loaded with the core action, then the mechanism, then edge-case returns. No filler or restated metadata.

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?

With an output schema present, return values need not be detailed, and the description still covers the important states (cancelled-at-checkpoint, terminal, not_found). For a mutation tool it is nearly complete; the only omission is what a repeat call does given idempotentHint=false.

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 0% for the single run_id integer, so the description carries the burden; it only implies that run_id identifies a run via the 'unknown ids' behavior. Since there is just one obvious parameter, the gap is minor, but no format or source-of-id guidance is given.

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 ('Request cancellation of a RUNNING platform run') and scopes it to the RUNNING state, which implicitly separates it from platform_cancel_pending. It never names the sibling explicitly, so the distinction rests on the agent inferring that the all-caps state qualifier is the discriminator.

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

Usage Guidelines4/5

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

Clear context for when the tool applies: only RUNNING runs, with terminal runs returning an explanation rather than erroring, and unknown ids returning not_found. No alternative is named, so an agent deciding between this and platform_cancel_pending must rely on the state wording alone.

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