get_crawl
Get a single crawl run by id, including its status and progress.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| crawlId | Yes | Path parameter crawlId. |
Get a single crawl run by id, including its status and progress.
| Name | Required | Description | Default |
|---|---|---|---|
| crawlId | Yes | Path parameter crawlId. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full behavioral burden. It hints at return content ('status and progress') but says nothing about read-only semantics, authorization requirements, or behavior when the id does not exist.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One tightly written sentence with the resource and scope front-loaded; there is no filler or redundant restatement of the name.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a one-parameter read tool with no output schema, the description gives minimal but sufficient framing, mentioning status and progress. It could say more about the returned shape or failure conditions, leaving a modest gap given the absence of annotations and output schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The single parameter has 100% schema description coverage, so the baseline is 3. The description only reinforces that the id identifies the crawl run, adding nothing beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (Get), resource (a single crawl run), and scope (by id), which clearly separates it from list_crawls. It does not explicitly name any sibling, so it falls short of the 5 required for full sibling differentiation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The phrase 'by id' implies the tool is for retrieving a known crawl, but it never states when to use this versus list_crawls or the crawl sub-resource tools (get_crawl_issues, get_crawl_alerts). Usage is only implied.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.