akb_search

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

Discloses key behavioral traits: result count is from deduped prefetch pool, not corpus-wide; explains truncated flag meaning; suggests using akb_grep for exact count. No annotations provided, so description carries full burden and does so well.

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?

Each sentence adds value, from hybrid method to caveats about hit counts. Front-loads purpose and usage, then explains nuances. No fluff.

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 main purpose, usage alternatives, behavioral details, and limitations. Lacks explicit listing of all output fields (e.g., results array structure), but given no output schema, the description provides sufficient guidance for an agent.

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 high (83%), so baseline is 3. Description does not add much parameter-level detail beyond schema; it focuses on behavior and result interpretation. However, it clarifies the meaning of total_matches and returned fields, which are not parameters.

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 it searches documents using hybrid retrieval (dense+sparse) and clearly distinguishes from sibling akb_grep for exact/regex matches. The verb 'search' and resource 'documents' are specific, and the method is described.

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?

Explicitly tells when to use (natural-language and keyword queries) and when to prefer akb_grep (exact string/regex). Also explains how to get full content via akb_drill_down or akb_get with the returned URI.

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