pve_role_create

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

With no annotations, description must fully disclose behavior. It does: marks as MUTATION, describes two-step dry-run/confirm pattern, states MEDIUM risk, and explains inert nature until ACL reference. Covers key traits without omissions.

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 impactful sentences, front-loaded with key attributes (MUTATION, dry-run, risk). All information is relevant and no superfluous content.

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 output schema exists and siblings cover other role operations, description fully explains creation, execution mode, risk, and privilege format. No gaps for an AI agent to decide when to use this tool.

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 (25%), but description adds crucial detail for 'privs' with format and example. Roleid and confirm are self-explanatory. Compensates well for schema gaps.

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?

Clearly states 'create a custom role' with verb 'create' and resource 'custom role'. Differentiates from siblings like 'pve_role_delete' and 'pve_role_update' by specifying creation with optional privileges.

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?

Explains dry-run default and confirm flag for execution, with risk level. Provides context on when the role becomes active (inert until referenced by ACL). No explicit when-not instructions, but clear enough for usage.

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