pve_realm_update

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

With no annotations, the description carries full burden. It discloses default dry-run behavior, that confirm=True finalizes the update, and that built-in realms are high-risk. It explains that options are passed verbatim. Could mention success/error behavior but generally transparent.

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?

Two sentences, no redundant words. Front-loads purpose and then provides critical details. Every sentence adds value.

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 purpose, default behavior, risk warning, and parameter hint for options. Output schema exists, so return values are covered. Lacks prerequisites (e.g., realm must exist) but overall sufficient for the tool's complexity.

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 low (20%). Description adds meaning for 'options' (type-specific fields passed verbatim) and mentions 'confirm=True'. However, 'realm', 'comment', and 'proximo_target' are not explained beyond schema. Partially compensates.

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?

Starts with 'MUTATION: update a realm.' Clearly states the verb and resource. Differentiates from sibling tools like pve_realm_create and pve_realm_delete by specifying update. Also adds context about dry-run and built-in realms, enhancing clarity.

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?

Describes when to use (update realm) and gives key guidance: dry-run by default, need confirm=True, and warns about built-in realms. However, does not explicitly list alternatives or situations to avoid, though the sibling list provides context.

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