pve_realm_create

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

With no annotations provided, the description effectively discloses key behaviors: it is a mutation, dry-run by default, confirm=True executes synchronously and returns a dict with no UPID. It also explains that 'options' are passed verbatim to PVE with type-specific examples. This covers the main behavioral traits expected for a create operation.

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, front-loaded with the core purpose, and every sentence adds essential information. It efficiently covers behavior, parameters, and a usage hint without extraneous 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 the tool's complexity (6 parameters, 2 required) and the presence of an output schema, the description covers the main aspects: creation behavior, dry-run/confirm, options structure, and a suggestion to list realms. It is nearly complete, though it could mention prerequisites or return value details not covered by the output schema.

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?

Although schema coverage is 100%, the description adds significant value beyond the schema by providing concrete examples for the 'options' parameter (ldap, ad, openid fields) and explaining the 'confirm' parameter's effect. This helps the agent understand how to construct the arguments for different realm types.

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 'create an auth realm' with a specific verb and resource. It mentions 'MUTATION' to indicate it's a write operation. It provides a hint to list realms first, partially distinguishing from pve_realm_list, but does not explicitly differentiate from pve_realm_update or pve_realm_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 advises using pve_realms_list before creating, giving some context. It explains the confirm parameter for execution vs dry-run. However, it lacks explicit guidance on when not to use this tool or how it compares to realm update/delete alternatives.

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