pve_acme_account_update

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

With no annotations, description fully covers behavioral aspects: mutation, dry-run default, low risk (metadata only), and execution plan. Does not detail failure modes or permissions but adequately supplements missing 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?

Four sentences with no redundancy. Purpose and risk are front-loaded. Every sentence adds essential information.

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 behavioral aspects and return values for execution. With output schema present, not needing to detail return structure. Missing prerequisites (e.g., account existence) but acceptable given tool specificity.

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 coverage is 100%, so parameters are documented. Description adds value by explaining dry-run behavior (related to 'confirm') and the contents of the plan, going beyond schema.

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 ACME account contact info' and distinguishes from sibling 'pve_acme_account_delete' by explicitly naming it as an alternative for deletion.

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 when-to-use (updating contact info) and when-not (deletion via sibling), along with risk level. Lacks explicit guidance on when to use 'pve_acme_account_create' instead, but the context implies the tool is for updates only.

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