create_promo_code

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

No annotations provided, so the description carries full burden. It discloses authentication method (API key), concurrency limit (max 10 concurrent requests), respect for read-only/dry-run modes, and two error conditions (400 for missing rule, 409 for duplicate code). This is comprehensive and clear.

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?

Well-organized: purpose statement, paragraphs for usage/behavior, bullet list for parameters, and output description. No redundant information; every sentence earns its place. Concise yet thorough.

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 lack of annotations and full schema descriptions, this description covers all essential aspects: purpose, prerequisites, error handling, concurrency, parameter semantics, and return values. It integrates well with sibling tools and provides a complete picture for an agent.

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%, but the description lists each parameter with meaningful explanations, examples (e.g., 'SUMMER20' for code), and sourcing advice (e.g., obtain promo_rule_id from list_promo_rules). It also notes the default for enabled and describes the output schema, adding significant value beyond the schema.

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?

Description starts with a clear verb+resource statement: 'Create a redeemable code under an existing promo rule.' It specifies the tool's function and distinguishes it from related siblings like create_promo_rule and list_promo_codes by mentioning the prerequisite promo rule and the action of creating a code.

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?

Provides explicit guidance: use list_promo_codes before creating duplicates, and obtain promo_rule_id from list_promo_rules. It also describes the checkout use case and case-insensitivity. While it doesn't explicitly state when not to use this tool, the guidance is sufficient for correct invocation.

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