Search kb docs

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

Discloses search scope (titles+content), ranking (title hits weighted higher), and output details (excerpt, path). Annotations already provide readOnlyHint, and description adds significant behavioral context.

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?

Two sentences, front-loaded with purpose, then results and context. No wasted words.

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?

Explains return structure (matches, excerpt, path) despite no output schema. Relates to get_work_packet for additional context. Could detail pagination but adequate for typical use.

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 covers limit and query with descriptions (67%). The description adds value by linking 'project' to 'a board's kb doc', clarifying the required parameter's role. No further elaboration on limit or query beyond 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 states specific verb+resource: 'Keyword search across a board's kb doc titles + content, ranked'. It clearly differentiates from siblings like list_kb_docs and get_kb_doc by focusing on search. It also notes the relationship to get_work_packet.

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?

Implies usage for searching kb docs by keyword and notes the same matcher used in get_work_packet, providing context. However, it does not explicitly state when not to use or compare to alternatives like rag_search.

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