pve_realm_create

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

With no annotations provided, the description carries full burden. It discloses the mutation nature, dry-run default, and verbatim passing of options. However, it lacks information on required permissions, side effects, error handling, or return value specifics, which are important for an agent to use safely.

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 extremely concise (two sentences) with no redundant information. It front-loads 'MUTATION' to signal the action type and uses clear, direct language. 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?

Given the tool has an output schema (so return values are covered) and the parameter count is 6, the description provides adequate context for basic usage. However, it omits information about prerequisites (e.g., permissions, existing realm conflicts), potential errors, or idempotency. It is minimally complete for an agent with domain knowledge.

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 low (17%), but the description adds significant value by explaining how the 'options' parameter should be structured for different realm types (ldap, ad, openid). Other parameters like 'realm', 'realm_type', 'confirm', and 'comment' lack explanation, but the critical 'options' parameter is well-defined.

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 the tool creates an auth realm, identifies it as a mutation, and distinguishes it from other realm tools like delete, get, list, update. The verb 'create' and resource 'auth realm' are explicit.

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 implies when to use the tool (to create a realm) and notes the dry-run default but does not explicitly state when not to use or provide alternatives among sibling tools. No exclusions or context about prerequisites are given.

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