pve_sdn_fabrics_all

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

Discloses read-only nature and the return structure. No annotations exist, so description carries the burden. Does not mention auth or rate limits, but these are less critical for a read-only tool.

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 with no wasted words. Key information is front-loaded: 'READ-ONLY: AGGREGATE read'. Every sentence adds value.

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 has an output schema, the description adequately covers the return data. Parameters are fully documented in schema. Lack of error/permission info is acceptable for a simple read operation.

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% for the three optional parameters. Description adds no extra meaning beyond the schema, so baseline of 3 is appropriate.

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 it is a READ-ONLY aggregate that returns all SDN fabric configs and nodes in one call. Distinct from siblings by explicitly naming the two alternative calls it replaces.

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?

Explains the N+1 avoidance benefit and that it is reconstructable from two other calls, implying when to use this aggregate version. However, does not provide explicit exclusions for when not to use it.

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