pve_network_list

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

Declares READ-ONLY and 'No state change', and describes return fields. No annotations provided, so description carries full burden; it covers key behavioral aspects but lacks details on permissions or edge cases.

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?

Three sentences: purpose, return/filter, sibling distinction. No unnecessary words, well front-loaded.

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 is a simple list operation with an output schema, the description is complete enough for correct usage, including a clear guard for SDN alternatives.

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 100%, but description adds context: summarizes filter parameter (iface_type) and return fields (iface, type, etc.), and notes default node behavior.

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?

Clearly states the verb (list), resource (network interfaces on a PVE node), and specifics (bridges/bonds/VLANs/etc). Distinguishes from sibling tools for SDN.

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?

Explicitly tells when to use (listing network interfaces) and when not to use (for SDN zones/vnets, use pve_sdn_zones_list/pve_sdn_vnets_list).

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