zda_update_automation

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

Discloses that the tool is guarded and affects live ticket flow, and explains the preview-then-apply pattern. With no annotations, the description carries full burden. Could mention side effects or reversibility more explicitly.

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?

Three sentences that front-load purpose, followed by guard warning and common fields. No redundant or unnecessary text.

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?

Covers main points but lacks description of the return value, especially for the preview step. Does not explain condition structure (all/any arrays). Without output schema, more detail on response format would improve completeness.

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?

Adds value beyond schema by listing common fields (title, conditions, actions, active) and clarifying the passthrough wrapper behavior for the data parameter. Schema coverage is 67%, but description compensates with practical parameter guidance.

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 Zendesk automation' with a specific verb and resource, distinguishing it from sibling tools like create, delete, and other update tools. The term 'automation' is unique among siblings.

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: call without require_confirm to preview, then with require_confirm to apply. Warns about affecting live ticket flow. Lacks explicit when-not-to-use or comparisons to alternatives like create_automation or get_automation.

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