delete_crawl

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

Explicitly warns 'This permanently deletes the crawl data. It cannot be undone.' which covers the destructive nature. No annotations provided, so description carries full burden. Could mention prerequisites like ensuring crawl is not in use, but still strong.

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?

Two short sentences plus a warning. Front-loaded with action and purpose. No fluff. Every sentence adds value.

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?

Completeness is high for a simple delete tool. Output schema exists (not shown), so return value explanation is not needed. Could mention success/failure behavior or side effects, but overall adequate.

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?

Schema description coverage is 0%, but description fully explains the sole parameter 'db_id' as 'The Database ID from list_crawls', adding clear provenance beyond the bare 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?

Clearly states 'Delete a crawl' with specific resource and verb. Distinguishes from sibling tools like list_crawls or crawl_site by noting it deletes from the internal database to free disk space.

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?

Provides context (free disk space) and source for db_id (list_crawls), but lacks explicit guidance on when not to use or alternatives like export_crawl before deletion. Adequate but not exhaustive.

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