Skip to main content
Glama

Cancel Crawl Job

crawl_cancel
DestructiveIdempotent

Cancel an active crawl job and preserve its checkpoint so you can resume later without losing progress.

Instructions

Cancel an active Crawl Job and preserve its checkpoint.

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": {
      "crawlId": "<crawlId>"
    },
    "name": "crawl_cancel"
  }
}

Input Schema

NameRequiredDescriptionDefault
crawlIdYes

Output Schema

NameRequiredDescriptionDefault
pagesYes
totalYes
errorsYes
offsetYes
statusYes
crawlIdYes
hasMoreYes
partialYes
returnedYes
completedYes
expiresAtNo
artifactIdNo
providerJobIdNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, so the safety profile is covered structurally. The description adds genuinely new behavior beyond them: the checkpoint is preserved, telling the agent the job's progress survives and can likely be resumed. It still omits whether cancellation is synchronous or eventual, and what error surfaces for a non-active job.

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?

A single sentence with no filler, front-loading the action and appending the one behavioral detail that matters. Nothing is redundant or buried.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need no explanation, and the tool is a simple one-parameter mutation. However, for a state-changing operation the description says nothing about preconditions (job must be active), post-conditions (state transition, resumability after cancel), or failure modes, leaving meaningful gaps.

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%, but the single parameter is a self-describing UUID (crawlId) with format and pattern constraints already in the schema. The description does not say where the ID comes from (presumably a crawl or crawl_status response) or whether it must reference an active job, so it adds little beyond the structured field.

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 ("Cancel an active Crawl Job") plus a qualifying precondition ("active") and a side effect ("preserve its checkpoint"). It is clearly distinguishable from crawl/crawl_status/browse by the verb alone, though it never names a sibling explicitly.

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 word "active" implies the tool only applies to running jobs, which is soft when-to-use guidance. There is no statement about what to do with a finished or nonexistent job, no alternative listed (e.g., crawl_status for inspection), and no prerequisites such as permissions or ownership.

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