update_promo_rule

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

Discloses authentication via API key, max 10 concurrent requests, respect for read-only/dry-run modes, and 404 return for invalid IDs. Partial update behavior is clarified. No annotation provided, but description covers key behavioral traits.

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?

Concise at ~100 words, well-structured with intro, usage tip, technical notes, args list, and returns. Every sentence adds value; no redundancy.

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 10 parameters, no annotations, and output schema present, the description covers update behavior, usage cues, error handling, and parameter details comprehensively. It leaves no critical gaps for agent invocation.

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?

With 0% schema description coverage, the args section adds full meaning: each parameter gets a one-line purpose, and enums for type and target are listed. This compensates completely for the missing schema descriptions.

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 'Update an existing promo rule' and distinguishes from siblings by specifying it modifies existing rules (vs create_promo_rule). Examples of toggling, extending, adjusting set it apart from list/get/delete tools.

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?

Explicitly mentions typical use cases (toggle on/off, extend end date, adjust amount) and advises using list_promo_rules to find IDs. Lacks explicit when-not-to-use or alternatives, but context is clear.

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