Skip to main content
Glama

Cancel a running ZCode task

zcode_cancel
Idempotent

Stops a running ZCode task by clicking its stop button; disk changes already made are kept, not rolled back.

Instructions

Stop a running task (clicks ZCode's stop button). Work already done on disk is not rolled back.

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": {
      "taskId": "<taskId>"
    },
    "name": "zcode_cancel"
  }
}

Input Schema

NameRequiredDescriptionDefault
taskIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare the mutation profile (readOnlyHint=false, destructiveHint=false, idempotentHint=true), so the bar is lower; the description still adds real value by disclosing that cancellation is a cooperative UI-button click and that on-disk work is not rolled back. The main remaining gap is whether the stop is immediate or eventual and what the caller gets back.

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?

Two short sentences, the core action front-loaded, and the caveat about un-rolled-back work immediately after. No filler.

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 one-parameter cancellation tool with annotations and no output schema, this covers the essentials: what it does, how it does it, and the side-effect caveat. Only the post-cancel state (does the task become cancelled? is it idempotent for finished tasks?) is left implicit.

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% – the single taskId parameter has no description or format hint beyond the regex pattern in the schema. The description never mentions taskId, so it adds nothing about which session identifier to pass or what happens if the ID is unknown/already finished.

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 ('Stop a running task') and even names the mechanism ('clicks ZCode's stop button'), which anchors it to the zcode_* family rather than hub_cancel or swarm_cancel. It stops short of explicitly contrasting with those siblings, so a 4 rather than a 5.

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 phrase 'a running task' implies the condition for use (task must be in flight), but there is no explicit when-not guidance and no named alternative such as hub_cancel or swarm_cancel. An agent must infer the scoping from the tool name prefix.

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