pve_sdn_prefix_list_get

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

Annotations are absent, so the description must carry the behavioral burden. It declares 'READ-ONLY' upfront, signaling no modifications. However, it lacks details on error behavior (e.g., if the prefix list doesn't exist), authentication needs, or rate limits. It's acceptable but minimal.

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 extremely concise: two sentences. The first sentence defines purpose and read-only nature; the second provides workflow guidance. No unnecessary words, fully front-loaded with essential 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?

Given the existence of an output schema, the description does not need to explain return values. It mentions that the configuration includes entries, which adds useful context. It could optionally note that the output is a configuration object, but the output schema fills that gap. Overall, it's sufficiently complete for a read-only retrieval 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% and both parameters have descriptions. The main description adds no new semantic detail beyond 'read one SDN prefix list's configuration.' Since the schema already explains the parameters, the description provides marginal added value, meeting 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?

The description states 'READ-ONLY: read one SDN prefix list's configuration (including its entries).' This clearly identifies the operation as a read with a specific verb and resource, and includes scope (entries). It also distinguishes from sibling pve_sdn_prefix_lists_list which is for enumeration.

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 explicitly instructs: 'Use pve_sdn_prefix_lists_list to enumerate prefix-list ids first.' This provides clear workflow guidance, though it does not mention when not to use this tool or alternative variants. Still, the directive is helpful for an AI agent.

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