Skip to main content
Glama

Cancel a running consultation

consult_cancel
Idempotent

Stop a running consultation or fan-out via job_id or group_id, sending stop requests to other severally servers and signalling the process tree where supported.

Instructions

Stop a running consultation (job_id) or fan-out (group_id). Other severally servers receive a stop request. The process tree is signalled where the platform permits; on Windows descendants may survive if the CLI already exited.

Input Schema

NameRequiredDescriptionDefault
job_idNo
group_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.4.1
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observedv1.1.0

TDQS

A4/5.0
Behavior4/5

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

The annotations already declare that this is a mutating but idempotent operation, and the description adds useful behavioral context: other servers receive a stop request, the process tree is signalled where permitted, and Windows descendants may survive if the CLI already exited. It does not describe permissions or partial-failure responses, but the added distributed cancellation caveat is meaningful beyond the annotations.

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?

The description is three compact sentences with the action and target types front-loaded. The remaining sentences add distributed-stop and platform-caveat details without unnecessary preamble.

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 cancellation tool with annotations covering mutation and idempotency, the description provides the key operational context: what is stopped, that other servers are notified, and the platform limitation on descendants. It leaves some gaps around return behavior and exact identifier requirements, but is largely complete for this complexity level.

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%, so the description must carry parameter meaning. It usefully maps job_id to a running consultation and group_id to a fan-out, and "or" implies choosing one, but it does not explicitly state that exactly one identifier is required, whether both may be supplied, or what happens if neither is provided.

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?

The description states a specific verb and resource: "Stop a running consultation" or "fan-out". It clearly distinguishes cancellation from sibling operations such as consult_start, consult_get, consult_record, consult_export, and consult_list by describing the terminating action and the two target types.

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 to use the tool by mapping job_id to stopping a consultation and group_id to stopping a fan-out. However, it does not explicitly state prerequisites, when not to use it, or which sibling tools should be used to find the relevant identifiers.

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