Cluster Firewall Rules

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

The description adds the useful detail that create/update/delete are elevated, which is not present in the annotations. The annotations already convey readOnlyHint=false and destructiveHint=true, so the mutation/destruction risk is covered; the description does not contradict them. It does not disclose additional behavioral details such as position shifting or update prerequisites.

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 compact, front-loaded with the resource name, and uses a clear action-keyed format. Every part contributes directly to understanding the tool's operations, with no filler or redundant explanation.

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?

For a 17-parameter action-dispatch tool with no output schema, this description is under-specified. It fails to indicate which parameters apply to each action, which are required for create/update/delete, or what positional and rule-field semantics matter, leaving agents to guess for anything beyond a trivial list or get call.

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 18%, so the description must compensate for the many undocumented parameters, but it only clarifies the action parameter and partially explains that 'get' uses a position. The remaining 16 parameters, including dest, source, dport, digest, rule_action, and iface, receive no meaningful semantic guidance.

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 resource, cluster firewall rules, and enumerates the five supported operations: list, get, create, update, and delete. It is specific enough to identify the tool's purpose, though it relies on the tool name rather than explicit contrast to distinguish it from sibling firewall tools.

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 gives per-action guidance and notes that create/update/delete require elevated privileges, which is useful context. However, it does not explain when to choose this tool over related siblings like proxmox_cluster_firewall_group, proxmox_cluster_firewall_alias, or proxmox_guest_firewall_rule, nor does it state any exclusions.

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