yacy_search

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

No annotations are provided, so the description carries the full burden. It discloses the main behavior (search) and parameter defaults (max_results, resource), but does not add additional behavioral context such as return format, error handling, network requirements, or rate limits. The output schema covers return values, but other traits are not mentioned.

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 a succinct single-sentence purpose followed by a structured Args list. Every sentence earns its place; there is no fluff. The format is front-loaded with the primary action.

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 simple search tool with three parameters (one required), the description fully covers all parameters and defaults. The output schema exists, so return values are documented externally. There are no siblings or complex edge cases, making the description complete.

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 schema has 0% description coverage, meaning parameter titles only. The description compensates by providing a clear Args list with explanations for query, max_results (with default), and resource (with default). This adds significant meaning beyond the raw 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?

The description clearly states 'Search using YaCy web search engine', which is a specific verb ('Search') and resource ('YaCy web search engine'). It is concise and directly indicates what the tool does. Since there are no sibling tools, there is no need for 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 description provides clear context on when to use the tool: when a search against the YaCy web search engine is needed. It does not explicitly mention alternatives (none exist in the sibling list) or exclusions, but the context is unambiguous for a search tool.

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