Search Quai Docs

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

Annotations already declare readOnlyHint=true and openWorldHint=false, and the description reinforces this by noting it is 'an offline index, not a live web search.' It also discloses the limitation that results only cover topics in the curated index and instructs the agent to avoid guessing. This adds useful behavioral context beyond the minimal annotations.

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?

Three dense sentences contain the action, the scope, concrete usage examples, and an explicit limitation/fallback path. Every sentence earns its place, and the key purpose is front-loaded.

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 two-parameter read-only search tool, the description covers what it searches, what it returns (snippets with links), when to use it, and how to handle misses. No output schema is present, but the return format is sufficiently described. The agent can invoke this tool correctly without further information.

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 100%, so the parameters are already fully documented. The description adds helpful query examples for the query parameter, which improves usability, but it does not enrich the semantics of maxResults beyond what the schema provides. Baseline 3 is appropriate.

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 uses a specific verb ('Search') and resource ('small curated index of Quai Network developer documentation') and states the output ('relevant snippets with links to the official docs'). It clearly distinguishes this documentation-search tool from the on-chain/sibling tools like get_transaction or get_balance.

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?

It explicitly says when to use the tool ('explain a Quai concept, find the right doc page, or clarify terminology') and gives a concrete fallback behavior for uncoveed topics: say so and point at docs.qu.ai rather than guessing. This is strong, actionable usage guidance.

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