Search Vault

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

With no annotations, the description carries the full burden. It reveals matching semantics (substring) and return shape (snippets), but says nothing about safety, pagination across the limit, scope defaults when vault is null, or whether it touches the graph. This is thin for a no-annotation tool.

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?

A single tight sentence that front-loads the operation and appends the return shape. Nothing is wasted.

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?

An output schema exists, so return value details aren't required. But with 0% parameter coverage and no annotations, the description should clarify scoping and limit behavior; it leaves key invocation details to inference.

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 description coverage is 0% across three parameters. The description mentions id/body as search surface but doesn't explain query syntax, what limit controls, or what vault=null means (default scope). The agent gets no compensating meaning for the undocumented parameters.

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?

States a specific verb (substring search) and resource scope (every note's id/body), and describes the result shape (short snippet per hit). It doesn't distinguish itself from the very similar sibling search_nodes, leaving the agent to guess which search target applies.

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?

There is no guidance on when to use this tool versus search_nodes, retrieve_context, or list_notes. The description gives no conditions, exclusions, or alternatives despite a crowded sibling namespace.

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