pause_automation

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

Annotations indicate mutating but not destructive. Description adds significant behavioral details: queue preserved, new subscribers enter but no emails, reversible, and error states. No contradiction with annotations.

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 with a clear structure: single-sentence purpose, behavioral note, Args section, Returns section. No unnecessary words.

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 that an output schema exists, the description adequately covers purpose, usage, parameters, and return format. Complete for a pause action.

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?

For the required 'automation_id', description provides an example and source ('e.g. 'auto123'. Obtain from list_automations.'), adding value beyond the raw schema. Optional 'account' param is not described, but coverage is 0%, so partial compensation.

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 clearly states it pauses an automation workflow, stopping delivery while preserving the queue. Distinguishes from 'start_automation' and sibling 'pause_automation_email' is listed, making the specific resource clear.

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 clear context on when to use (pause automation) and behavior (queue preserved, subscribers resume on start_automation). Mentions error conditions (already paused, draft status). However, does not explicitly contrast with 'pause_automation_email'.

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