Pause, resume or stop crawling

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

Goes well beyond the annotations (destructiveHint, idempotentHint) by specifying what is destroyed — the crawl's queued URLs — versus what survives (already-indexed pages stay in the index). Also discloses the YACY_ADMIN_PASSWORD auth requirement and the return payload, which the annotations cannot convey.

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 action semantics, then folds in side effects, routing, and auth in a few dense sentences. Slightly long, but nearly 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 actions, side effects, prerequisites, sibling routing, and even the return value despite there being no output schema. Nothing an agent needs to invoke this 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: it maps 'stop' to the handle parameter and clarifies that 'pause'/'resume' act on the local crawler queue rather than a specific crawl. This goes beyond the schema's terse per-field notes.

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 (control) and resource (crawling on your YaCy peer) and enumerates the three actions 'pause', 'resume', 'stop' with their distinct effects. An agent can separate this from siblings like crawl_site and list_crawls from the description alone.

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?

Routes the agent explicitly: 'stop' needs a handle from list_crawls, and single-page removal belongs to delete_document. Adds the guardrail 'Only act on crawls the user asked about.' No explicit statement of when-not to use control_crawl versus crawl_site, but the operating context is clear.

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