Skip to main content
Glama
Sign In
doc-scraper

doc-scraper

by Sriram-PR
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Go
Local

cancel_crawl

Idempotent

Stop a running or pending documentation crawl by job ID, leaving stored corpus and crawl history unchanged. Has no effect on jobs already finished.

Instructions

Cancel a running or pending crawl job by job ID. The previously stored corpus and crawl history are left untouched. Has no effect on jobs already in a terminal state.

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": {
      "job_id": "<job_id>"
    },
    "name": "cancel_crawl"
  }
}

Input Schema

NameRequiredDescriptionDefault
job_idYesThe job ID returned by crawl_site

Output Schema

NameRequiredDescriptionDefault
job_idYes
statusYes
messageYes
site_keyYes
cancelledYesfalse when the job was already in a terminal state

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.15.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "cancelled": {
+      "description": "false when the job was already in a terminal state",
+      "type": "boolean"
+    },
+    "job_id": {
+      "type": "string"
+    },
+    "message": {
+      "type": "string"
+    },
+    "site_key": {
+      "type": "string"
+    },
+    "status": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "job_id",
+    "cancelled",
+    "site_key",
+    "status",
+    "message"
+  ],
+  "type": "object"
+}
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare non-read-only, non-destructive, idempotent behavior. The description adds valuable specifics: stored corpus and crawl history are untouched, and terminal-state jobs are unaffected. It does not cover auth or rate limits, but those are not critical here.

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, front-loaded with the core action and immediately followed by the key side-effect and state constraints. No wasted words.

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?

With a complete input schema, rich annotations, and an output schema, the description covers purpose, side effects, and state limitations. It could add a note about checking job status before cancelling, but otherwise is sufficient for a simple cancel operation.

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?

The single job_id parameter has 100% schema coverage and the schema already documents it as the ID returned by crawl_site. The description adds no semantic detail beyond 'by job ID', 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?

States a specific verb (cancel) and resource (running or pending crawl job) with scope. Though it doesn't name a sibling, its purpose is unmistakable against crawl_site and get_job_status in the sibling list.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Clearly indicates the applicable job states (running or pending) and an exclusion (terminal state jobs have no effect). It does not name an alternative tool or say when to prefer checking status first.

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

Deploy Server

Other Tools