odoo_top_customers

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

No annotations are provided, so the description carries the full burden. It does not disclose that the tool is read-only, lacks destructive side effects, or whether special permissions are required. While the tool name implies a query, the description omits these behavioral details, which is a gap for safe usage.

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?

The description is a single, efficient sentence with no redundant words. It front-loades the core purpose immediately.

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?

For a simple query tool with three parameters and no output schema, the description covers the core function but lacks details on return format (e.g., fields provided), pagination, or behavioral safety. An agent may need additional context to fully understand the tool's output.

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?

The schema already covers all parameters with descriptions (100% coverage). The description adds value by explaining that the date range filters invoiced revenue and that customers are ranked by that revenue, providing context beyond the schema's field labels.

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 returns top customers ranked by invoiced revenue over a date range. This is a specific verb+resource+scope, and it distinguishes itself from sibling tools like odoo_search_read (generic read) and odoo_sales_summary (summary, not customer-specific).

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 implies the use case (date-range revenue ranking) but does not explicitly state when to use it vs alternatives or when not to use it. There are no exclusion criteria or references to other tools in the description.

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