Search Notes

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

Discloses query syntax (quotes for exact phrase, implicit AND, Porter stemming) and returns ranking by relevance. Annotations already indicate safety (readOnly, idempotent), and description adds valuable 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?

Three well-organized paragraphs: function and syntax, usage guidance with example, and output format. Every sentence adds value, no fluff. Front-loaded with key action.

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 fully documents return fields (path, title, snippet, etc.) and handles edge cases (null created). Covers query, filters, ranking, and alternatives. Entirely adequate for a complex tool.

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 baseline is 3. However, description adds significant value: explains query semantics, provides an example, mentions default limit and snippet tokens, and describes filter usage. Greatly enhances understanding.

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?

Clearly states full-text search across vault notes ranked by relevance. Specific verb (search) and resource (notes). Distinguishes from siblings like vault_search_by_tag and vault_search_by_folder via explicit guidance.

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 (content-based search when path unknown) and when to prefer alternatives (tag-only, folder browsing, recent notes). Provides clear context for tool selection.

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