pdf_search

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

Describes it as a semantic search returning snippets. No annotations provided, so description carries full burden. Does not disclose potential side effects, rate limits, or specific behavioral traits beyond the basic read operation.

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?

Concise and well-structured: brief intro, then clear Args and Returns sections. No redundant information. Front-loaded with purpose.

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 purpose, all parameters with defaults and examples, and return type. Missing details on return format/structure, but acceptable for a search tool given no output schema. Siblings provide related context.

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?

Despite 0% schema coverage, the description adds useful context for all parameters: query (search query description), n_results (default and max), module (example values). Enhances understanding beyond bare schema.

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 it searches COMSOL PDF documentation using semantic search. Specifies scope (60+ modules) and purpose (find info on physics, modeling, API usage). Distinguishes from sibling tools like docs_get and pdf_list_modules.

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?

Implied usage for searching documentation by query and optional module filter. No explicit guidance on when to use this vs alternatives like docs_get or pdf_list_modules. Lacks when-not or context-specific recommendations.

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