kb_search

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

With no annotations provided, the description carries full burden. It discloses default search mode and available modes (hybrid, fts, vector, sag_fast, sag_precise) but lacks details on pagination, result format, rate limits, or behavior with empty results.

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 single sentence that front-loads the purpose and key default. It could be improved by adding structure like bullet points for modes, but it is efficient and not verbose.

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?

Given no output schema, the description does not explain return values (e.g., list of chunks, metadata). It also does not describe the difference between search modes (e.g., when to use sag_fast vs vector). This is adequate but leaves gaps for an agent to understand full behavior.

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 the baseline is 3. The description adds the default hybrid mode and mentions 'enabled (or specified) KBs' which adds minimal value over the schema's parameter descriptions (which already document defaults and options).

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 across enabled (or specified) knowledge bases' with a specific verb and resource. It distinguishes from sibling tools like kb_list (list KBs) and mgmt_query (query arbitrary tables) by focusing on search across knowledge bases.

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 implies usage for searching KBs but does not explicitly state when to use this vs alternatives like mgmt_query or when not to use it. There is no mention of exclusions or when to choose different search modes.

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