Skip to main content
Glama

Stop a running check

cancel_check
Destructive

Stop a check that is still running — started by mistake, on the wrong store or app, or no longer needed. It stops at once, publishes nothing and costs nothing; its status becomes canceled. A check that has finished cannot be stopped, nor can an extension check or one allowed to create test records — they clean up at their own end. Needs a key that can start checks (member or admin).

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": "cancel_check"
  }
}

Input Schema

NameRequiredDescriptionDefault
teamNoAct in another of your teams, by its name or id (whoami lists them). Omitted: the key's own team
run_idYesRun id returned by start_check or latest_results, or the run's number as the verdict page shows it ("#332")

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations declare destructiveHint=true and readOnlyHint=false, and the description adds real context beyond them: cancellation is immediate, publishes nothing, costs nothing, and the run's status becomes 'canceled'. It also states the authorization requirement (a key that can start checks, member or admin) and explains the cleanup semantics of the excluded check types.

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 action and scope, then eligibility rules, then side effects, then permissions — each sentence carries distinct information with no restatement of the title or name.

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?

For a two-parameter mutation with no output schema, the description covers the outcome (status becomes canceled), the side effects (nothing published, no cost), the eligibility boundary, and the auth prerequisite. Nothing an agent needs before invoking it is missing.

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 run_id (including the '#332' number form) and team are already fully documented in the schema. The description adds no additional meaning about either parameter, so the baseline 3 applies.

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?

Opens with a specific verb and resource plus a scope qualifier ('Stop a check that is still running'), which separates it cleanly from start_check, get_check_status, wait_for_run and latest_results in the sibling list. An agent can pick this tool without opening the schema.

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 concrete motivating cases (started by mistake, wrong store or app, no longer needed) and explicit exclusions: finished checks cannot be stopped, nor extension checks, nor checks allowed to create test records, which 'clean up at their own end'. That is when-to-use plus when-not-to-use, which is rare.

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.