Pause, resume or stop crawling

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

Goes well beyond the annotations: pause means no new pages fetched, stop drops queued URLs, already-indexed pages survive, the auth requirement (YACY_ADMIN_PASSWORD), and the return shape. The destructive/irreversible aspect (queue dropped) is disclosed explicitly, consistent with destructiveHint=true.

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?

Front-loads the tool's purpose, then enumerates the three actions with their effects, then closes with routing and prerequisites. Dense but every clause carries information an agent needs; no filler.

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?

Covers the mutation semantics, the auth prerequisite, the sibling routing for page removal, and even summarizes the return values despite there being no output schema. Nothing needed to call it correctly is missing.

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 coverage is 100%, so baseline is 3, but the description adds real meaning: 'stop' consumes a handle sourced from the 'crawls' tool and 'pause'/'resume' target the local queue rather than a single crawl. The enum semantics are enriched beyond the schema's brief phrasing.

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?

Names the specific verb set (pause/resume/stop) and the exact resource (crawling on the user's YaCy peer), and spells out what each action does to the local crawler queue. An agent can distinguish it from the sibling 'crawl' (which starts crawls) without opening the schema.

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?

Gives per-action guidance (what 'stop' ends and that it takes a handle from the 'crawls' tool) and routes page removal to the sibling 'delete_document'. It also adds a caution ('Only act on crawls the user asked about'), but never states when not to call this tool versus alternatives.

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