query_documents

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

Discloses query semantics, scoring (0=best match), and explain behavior. Since no annotations exist, the description carries full burden and does so adequately.

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?

Effective front-loading: first sentence states purpose, then syntax details. Slightly verbose but remains clear. Every sentence adds value.

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?

Covers query syntax, scoring, and explain. Missing output schema but explains result score. Adequate for a search tool with 3 parameters.

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 coverage, the description compensates by explaining the query parameter's syntax in detail and the explain parameter. limit is self-explanatory, but not detailed.

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's purpose: 'Search your documents using both meaning and exact keyword matching.' This distinguishes it from sibling tools like ingest_file, delete_file, etc.

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 detailed usage guidelines including advanced query syntax and parameter effects. No explicit when-to-use vs alternatives, but the search purpose is clear.

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