pve_list_ipsets

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

No annotations are provided, so the description carries full burden. It states 'List' which implies a read-only operation, but doesn't disclose behavioral traits such as permission requirements, output format (e.g., JSON list), potential errors (e.g., if cluster is unavailable), or whether it's idempotent. The description is minimal and lacks critical context for safe invocation.

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, efficient sentence ('List cluster IP sets') with zero waste. It's front-loaded and directly conveys the core action, making it easy to parse. No unnecessary words or structural issues are present.

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 no annotations, no output schema, and a simple read operation, the description is incomplete. It lacks details on what 'cluster IP sets' entails (e.g., CIDR blocks, aliases), the return structure, or error handling. For a tool in a complex system like Proxmox VE, more context is needed to ensure correct usage beyond the basic purpose.

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 input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description doesn't add parameter details, which is appropriate. Baseline is 4 for 0 parameters, as the schema fully covers the absence of inputs without requiring description compensation.

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 'List cluster IP sets' clearly states the verb ('List') and resource ('cluster IP sets'), making the purpose immediately understandable. It distinguishes from siblings like 'pve_create_ipset' by indicating a read operation rather than creation. However, it doesn't specify if this lists all IP sets across the entire cluster or requires node specification, which could be more precise.

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 provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., cluster access), compare to related tools like 'pve_list_firewall_aliases' or 'pve_list_security_groups', or indicate if it's for monitoring or configuration purposes. Usage is implied by the name but not explicitly stated.

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