Sales report

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

No annotations are provided, so the description carries the burden. It discloses the return metrics (gross sales, orders, items) and period options. However, it does not mention read-only status, response format, or potential errors, though the simple nature reduces need.

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?

Extremely concise: one sentence front-loaded with key details (platform, purpose, periods, metrics). No unnecessary words.

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 single-parameter tool with no output schema, the description covers the essential: what it does, what periods are available, and what data is returned. No gaps.

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 coverage is 100% with period parameter fully described. The description restates the enum values but adds no additional meaning beyond the schema. Baseline 3 is appropriate as description does not improve understanding.

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 it returns WooCommerce sales totals for a period, listing specific metrics (gross sales, orders, items) and periods. It explicitly distinguishes from sibling tools like get_product and list_orders, which focus on individual items or order lists.

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 use when sales aggregations are needed but does not specify when to avoid it or contrast with alternatives (e.g., list_orders for detailed view). No explicit guidance on context or prerequisites.

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