pause_recurring_invoice

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

With no annotations provided, the description carries the full burden. It does disclose the key behavioral outcome ('stops auto-generation'), which is useful. However, it does not mention reversibility (via resume_recurring_invoice), any permissions required, or effects on existing generated invoices, leaving room for ambiguity.

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 a single, concise sentence that is front-loaded with the action and resource. It contains no wasted words and communicates the primary purpose effectively.

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 the simplicity of this tool (one parameter, no output schema, no annotations), the description is largely complete: it states the action and its consequence. However, it could benefit from a note about reversibility or the fact that it only affects future auto-generation, though these are implied by sibling tools.

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?

The schema description coverage is 100%, and the only parameter 'id' is already described as 'The recurring invoice UUID'. The tool description itself adds no extra parameter semantics, so the baseline of 3 is appropriate.

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 uses the specific verb 'pause' and identifies the resource as 'recurring invoice', with the parenthetical 'stops auto-generation' clarifying the exact effect. This clearly distinguishes it from sibling tools like resume_recurring_invoice and generate_recurring_invoice_now.

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?

No explicit guidance is given on when to use this tool versus alternatives. The description does not mention exclusions, prerequisites, or contrast with sibling tools like resume_recurring_invoice or delete_recurring_invoice. The intended use is only implied by the tool name.

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