search_across_instances

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

Annotations already declare readOnly, non-destructive, idempotent. Description adds value by specifying distributed fan-out, merging, and attribution—key behaviors beyond annotations. Could include more details like pagination or error handling.

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?

Single, front-loaded sentence with no wasted words. Every phrase ('read-only', 'fanned out', 'merged and attributed') adds specific meaning.

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?

Despite having an output schema, description omits critical details about required 'model' parameter, how 'domain' and 'fields' work, and 'limit_per_instance'. Too minimal for a complex multi-instance search 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?

With 0% schema coverage, description should explain parameters. It only hints at 'instances' via 'across configured Odoo instances' but provides no info on 'model', 'domain', 'fields', or 'limit_per_instance'. Significant gap.

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?

Description clearly states it's a read-only search across multiple Odoo instances with merging and attribution. Differentiates from siblings like 'search_records' (single instance) and 'aggregate_across_instances' (aggregation).

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?

Implies usage for multi-instance searches but lacks explicit guidance on when to use versus alternatives, prerequisites, or when not to use. No mention of sibling tools or context.

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