proxmox_cluster_firewall_ipset

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

No annotations are provided, so the description bears full burden. It discloses 'elevated' for create/delete but does not explicitly state that list is read-only, nor describe side effects or idempotency. The behavioral disclosure is partial.

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 with two sentences and uses a pipe-separated list for actions, which is efficient and easy to scan. No redundant information.

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 tool with 3 parameters, no output schema, and no annotations, the description is incomplete. It does not explain parameters' roles per action, nor hint at output format for list. More context is needed for effective invocation.

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?

The description adds minimal value beyond the schema. It lists actions but does not clarify how parameters like name and comment apply to each action (e.g., name required for create/delete, optional for list). Schema coverage is 67%, but description does not compensate for the 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?

The description clearly states it manages cluster firewall IP sets and enumerates list, create, delete actions. It distinguishes from sibling tools like proxmox_cluster_firewall_ipset_entry by focusing on the set itself, but does not explicitly mention that entries are handled separately.

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 notes that create and delete are 'elevated', implying need for permissions, but does not provide explicit guidance on when to use this tool vs alternatives like proxmox_cluster_firewall_ipset_entry. Usage context is implied rather than explicit.

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