kloakt_crawl

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

With no annotations, the description fully bears the burden and covers key behaviors: breadth-first, budget-limited, depth-limited, same-domain default, cycle detection, and network-bound nature. However, it omits details on authentication, rate limits, or error handling.

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?

The description is two sentences, front-loaded with the core action and parameters, and contains no fluff. Every sentence earns its place.

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?

The description provides sufficient context for an agent to understand the tool's purpose and constraints (max_pages, max_depth, same_domain, cycle detection). It mentions returning clean content but does not detail the output format or include error handling. Given the lack of output schema, a bit more detail on return structure could improve completeness.

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 input schema already has 100% description coverage for all parameters. The description adds value beyond the schema by mentioning 'cycle detection' and contextualizing 'budget-limited' and 'depth-limited,' which are not explicit in individual parameter descriptions.

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?

The description explicitly states it's a breadth-first crawl from a start URL returning clean content, with budget/depth limits, domain restriction, and cycle detection. This clearly distinguishes it from sibling tools like kloakt_fetch (single page) or kloakt_scrape (page scraping).

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 description advises using it 'to gather a small section of a site in one call' and warns it's 'network-bound — keep max_pages modest,' providing clear context. However, it does not explicitly state when not to use it or compare to specific alternatives.

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