pve_ha_rule_create

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

With no annotations provided, the description takes full responsibility. It discloses the mutation nature, dry-run default, synchronous execution, RISK_MEDIUM level, and CRM placement constraints. It lacks details on error states or rollback, but overall is quite 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?

The description is a single paragraph that front-loads the main action and then provides details. It is relatively concise, though a more structured format (e.g., bullet points) could improve readability.

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 complexity (10 parameters, 3 required) and no annotations, the description covers behavior, rule types, parameter usage, risk level, and synchronization. An output schema exists, so return values are not needed. The description is sufficiently complete for an agent to use the tool correctly.

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 only 10%, so the description compensates exceptionally well by explaining the meaning and dependencies of key parameters like rule_type, nodes, strict, affinity, resources, confirm, and disable. It adds significant value beyond the schema.

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 HA rule, identifies it as a mutation, and distinguishes it from sibling tools like pve_ha_rule_delete and pve_ha_groups_list by noting it's a replacement for HA groups.

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 explains the dry-run default behavior and how to execute with confirm=True, and details the two rule types and their parameters. It could explicitly state when not to use this tool, but the context makes it reasonably clear.

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