Search Vault

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

Beyond annotations (readOnly, idempotent, non-destructive), the description discloses FTS5 syntax, the semantic search behavior, the fallback to FTS5 if the semantic index is missing, and the Pro/pip install requirement. This is rich, useful behavioral context that helps the agent anticipate outcomes.

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 well-structured: a one-sentence intro, a bullet list of FTS5 syntax examples, and a compact paragraph on semantic mode. Every sentence adds value, with no redundancy or filler.

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?

The output schema exists, so return format is covered. The description thoroughly explains modes, syntax, prerequisites, and fallback behavior. Minor gaps: it does not explain the vault parameter's filtering role or response_format, but these are inferable from the schema and the tool's purpose.

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?

With 0% schema description coverage, the description compensates for the most important parameters: query (supports FTS5 syntax) and semantic (Pro-only, hybrid search, fallback). However, it does not add meaning for limit, offset, vault, or response_format, relying on schema titles and defaults. Partial compensation warrants a 3.

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 opens with 'Full-text or semantic search across document contents,' clearly stating a specific verb (search) on a specific resource (document contents). It distinguishes two search modes (FTS5 vs semantic) and differentiates from sibling tools like vault_search_by_tag and vault_get_doc.

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 provides clear context for when to use each mode: default FTS5 for keyword search, semantic for meaning-based search (with Pro requirement and fallback note). It mentions a prerequisite (run vault_rebuild_index first) but does not explicitly reference alternatives like vault_search_by_tag or state when this tool should not be used.

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