Skip to main content
Glama

Stop a research report

cancel_research
Destructive

Stops a research run at its next step. A cancelled run is not charged and writes no report. Returns the run.

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": {
      "id": "<id>"
    },
    "name": "cancel_research"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe run's id, as the run's start gave it.

Output Schema

NameRequiredDescriptionDefault
idNo
depthNo
errorNo
inputNo
stageNo
usageNo
reportNo
statusNo
metadataNo
progressNo
created_atNo
started_atNo
completed_atNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "completed_at": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "created_at": {
      +      "type": "string"
      +    },
      +    "depth": {
      +      "type": "string"
      +    },
      +    "error": {
      +      "type": [
      +        "object",
      +        "null"
      +      ]
      +    },
      +    "id": {
      +      "type": "string"
      +    },
      +    "input": {
      +      "type": "string"
      +    },
      +    "metadata": {
      +      "type": "object"
      +    },
      +    "progress": {
      +      "type": "object"
      +    },
      +    "report": {
      +      "type": [
      +        "object",
      +        "null"
      +      ]
      +    },
      +    "stage": {
      +      "type": "string"
      +    },
      +    "started_at": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "status": {
      +      "type": "string"
      +    },
      +    "usage": {
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Added

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false and idempotentHint=false, so the safety profile is covered. The description adds genuinely useful context beyond that: no charge is incurred and no report is written. However it says nothing about what happens on a second cancel call (relevant given idempotentHint=false) or any permission requirements, so it is solid but not rich.

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 short sentences, zero filler, with the core action and its timing constraint front-loaded before the billing and side-effect consequences. Every sentence carries distinct information.

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?

An output schema exists, so the description needn't detail return values, and the brief "Returns the run" is sufficient. For a one-parameter destructive tool the definition covers action, timing, cost and side effects; only the repeat-call behavior is left unstated.

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 100% and the single id parameter is already documented in the schema as "the run's id, as the run's start gave it." The description adds no further meaning about the identifier, so the baseline 3 applies.

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 ("Stops a research run") plus the timing semantics ("at its next step"), which separates it from cancel_find and cancel_investigation_batch by resource. It stops short of explicitly naming a sibling to disambiguate against, so it lands at 4 rather than 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?

Usage is implied by the resource name and the "next step" timing, but there is no explicit when-to-use/when-not-to-use guidance and no pointer to alternatives such as cancel_investigation_batch for batch runs. An agent must infer the selection criteria.

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.