pve_sdn_prefix_lists_list

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

Declares READ-ONLY, indicating no side effects, but lacks details on authentication, rate limits, or what cluster-scoped entails. With no annotations, the description carries full burden and meets a basic level.

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?

Two sentences, no wasted words, front-loaded with purpose. Concise and effective.

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 an output schema exists, explanation of return values is unnecessary. Description adds cluster-scoped context and workflow guidance, though parameter usage could be elaborated. Adequate for a list tool.

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 coverage is 100% with good parameter descriptions; the tool description adds no extra meaning beyond schema, hitting the baseline.

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?

Description clearly states verb (list), resource (SDN prefix lists), and scope (cluster-scoped), distinguishing it from sibling tools like pve_sdn_prefix_list_get.

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?

Provides context on related actions (use create to add, apply to commit), aiding workflow decisions, but does not fully differentiate from other list tools like pve_sdn_prefix_list_entries_list.

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