pve_role_update

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

With no annotations, the description carries full burden. It discloses that the tool is a mutation, defaults to dry-run, and that changing built-in roles re-scopes all ACLs using them. This is good disclosure of key side effects, though it omits details like reversibility or immediate impact after confirm.

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?

Extremely concise: one sentence plus a fragment, front-loaded with 'MUTATION' and the core action. Every word adds value with no redundancy.

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 essential behavioral context (dry-run, built-in warning) but lacks detailed parameter descriptions, prerequisites, or permissions. The presence of an output schema means return values need not be described, but other gaps remain.

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%), so description must compensate. It adds meaning for confirm (confirm=True to apply) and implies privs is the main parameter for privileges, but does not explain privs format, append behavior, or roleid beyond being required.

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 it changes a role's privileges, which is a specific verb+resource. It distinguishes from siblings by labeling itself 'MUTATION' and focusing on privilege modification, though it doesn't explicitly contrast with create/delete/list.

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 guidance on dry-run default and the need for confirm=True to apply changes, along with a warning for built-in roles. However, it does not explicitly state when to use this tool versus alternatives like pve_role_create or pve_role_delete.

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