list_promo_codes

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

Annotations already indicate readOnlyHint=true and destructiveHint=false, so the safety profile is clear. The description adds the purpose and return format (JSON with store_id, promo_rule_id, etc.), but doesn't discuss pagination behavior beyond parameters or any other behavioral nuances.

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 concise and well-structured: a clear first line, a brief paragraph explaining codes, followed by Args and Returns sections. Every sentence is informative and efficient.

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?

Given the schema has 5 parameters (including account), the description covers the main ones. An output schema exists, and the description outlines the return structure. Lacks coverage of the account parameter, but overall sufficient for the tool's simplicity.

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 0%, so the description must compensate. It explains store_id, promo_rule_id, count (range and default), and offset (pagination). This adds meaning beyond the schema parameter names, though 'account' parameter in schema is not mentioned.

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 'List the redeemable codes attached to a promo rule' with specific examples like 'SUMMER20', 'VIPONLY'. It distinguishes itself from sibling tools like create_promo_code, delete_promo_code, get_promo_code by focusing on listing.

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?

It explains that codes are what customers type at checkout and that a single rule can have many codes, providing context. It also mentions obtaining promo_rule_id from list_promo_rules. However, it does not explicitly state when not to use this tool or mention alternatives.

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