get_sales_report

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

Annotations already declare readOnlyHint=true, so safety is covered. The description adds insight into the report contents and breakdown type but does not clarify parameter interactions (e.g., how date_min and date_max relate to period, or default behavior when omitted). This is adequate but leaves some behavioral gaps.

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 two sentences, front-loaded with the primary action and a concise list of returned data. Every word serves a purpose, with no redundancy or filler.

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 read-only tool with no output schema, the description lists the key aggregate fields and indicates a breakdown by daily/weekly totals. The schema's rich field list compensates for the lack of an output schema. The main gap is not explaining how the parameters combine to produce the report, but overall it is sufficiently complete for typical use.

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 input schema has 100% parameter description coverage, so the schema already explains each field. The description adds minor semantic context by mentioning daily/weekly totals breakdown, which aligns with the `totals_grouped_by` field, but it does not significantly augment the schema-provided meanings.

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 retrieves a sales report for a period, listing specific metrics it returns (total sales, orders, items, tax, shipping, refunds) and a daily/weekly breakdown. This differentiates it from sibling tools like get_order_totals or get_customer_totals by scope, though no explicit alternative is named.

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?

No guidance is provided on when to use this tool versus related alternatives such as get_order_totals or list_orders. The description implies it is for period-based reporting but does not state exclusions or preferences, leaving the AI to infer usage context.

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