update_promo_code

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

No annotations provided, so description carries the burden. It discloses authentication, rate limit (10 concurrent), respect for read-only/dry-run modes, and 404 error for invalid IDs. However, it does not clarify the behavior when nullable parameters (code, redemption_url, enabled) are set to null (whether it clears the field or ignores the update).

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 well-structured with a clear opening sentence, a common use case, and a bullet-like Args list. No redundant sentences; every part adds value.

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 no output schema in structured data, the description provides the return format. It covers authentication, concurrency, error handling, and a common use case. Missing details on conflict handling (e.g., duplicate code) but generally complete for an update tool.

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 includes an Args section that briefly explains each parameter (e.g., 'New code string (case-insensitive)'). This adds meaning beyond the schema's type/title. However, it lacks details on ID relationships and potential constraints like uniqueness.

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 updates a promo code's string, redemption URL, or enabled state. It also distinguishes from moving to a different rule, which is not allowed.

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: toggle enabled=false to temporarily disable without deleting history, and for moving a code to a different rule, delete and re-create. Also mentions authentication, concurrency limits, and response for invalid IDs.

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