aggregate_records

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is clear. The description adds a bit of behavioral context by mentioning the version-specific read_group methods, but does not disclose other traits like error behavior or performance implications.

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 sentence that front-loads the purpose. It is concise, but could be slightly more structured to separate the purpose from the implementation detail.

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?

With 9 parameters and no inline parameter explanations, the description is insufficient for an agent to use the tool correctly. The presence of an output schema partially compensates for return value documentation, but parameter semantics are critically lacking.

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% for 9 parameters. The description only hints at group_by and measures (via 'sum/count'), but does not explain key parameters like lazy, domain, order, or instance. This lack of detail hinders correct parameter usage.

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 aggregates Odoo records server-side using Postgres groupby/sum/count. It specifies the underlying methods (formatted_read_group for Odoo 19+, read_group for earlier versions), which distinguishes it from sibling tools like search_records or read_record that return raw records.

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 tool is for aggregation tasks, but does not explicitly state when to use it versus alternatives. It lacks guidance on prerequisites, when not to use, or comparison with siblings like aggregate_across_instances.

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