pve_realm_update

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

No annotations are provided, so the description carries full burden. It discloses critical behavioral traits: synchronous execution, no UPID, dry-run by default, risk for built-in realms, and that options are passed verbatim with PVE validation. This is thorough for a mutation tool.

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 concise, consisting of 3-4 sentences with no wasted words. It front-loads the core purpose and key details, making it easy for an agent to parse quickly.

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 tool's complexity (5 params, 1 required, output schema exists), the description covers the essential context: what it does, how to use it safely, important warnings, and a recommendation for a pre-flight check. It is fully adequate for agent decision-making.

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 description coverage is 100%, so the baseline is 3. The description adds value by explaining the confirm parameter's dry-run vs execute behavior and clarifying that options carries type-specific fields passed verbatim. This extra context raises the score above baseline.

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 explicitly states 'MUTATION: update a realm' with a clear verb and resource. It distinguishes itself from sibling realm tools by mentioning a prerequisite (pve_realm_get) and focusing on mutation, while the name itself differentiates from create/delete.

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?

The description provides excellent usage guidance: it explains the dry-run default behavior, how to execute with confirm=True, warns about the high risk for built-in realms, and recommends using pve_realm_get first. This gives the agent clear when-to-use and when-not-to-use information.

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