vault_search

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

Annotations declare readOnly and idempotent, but the description adds detailed behavioral context: how modes affect results, parameter interactions (e.g., ranked=True, since_days>0). This goes beyond the annotations, though it could mention output size limits or error behavior.

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 extremely concise, using only a few sentences to convey the purpose and all four modes. It is front-loaded with the main purpose and structured clearly, with 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?

Given the complexity (12 parameters, multiple modes) and the presence of an output schema, the description adequately covers the main modes and their triggers. It could be slightly more complete by addressing parameter interactions or defaults, but overall it is sufficient for an agent to understand usage.

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% with descriptions for each parameter. The description adds value by explaining how parameters like ranked, since_days, and rank_by alter the search mode, which is not evident from individual parameter descriptions alone.

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 the tool searches the vault with specific modes (full-text, ranked, recent changes). It distinguishes from sibling tools like vault_list or vault_query by describing unique modes and functionality, making the purpose very specific.

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 explicitly explains when to use each mode (default, ranked, recent, rank_by), providing clear context. However, it does not directly contrast with sibling tools or state when not to use this tool, missing some guidance on alternatives.

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