pve_sdn_fabric_get

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

No annotations are provided, so the description carries full behavioral burden. It explicitly states the tool is read-only, identifies and corrects a known upstream documentation error, and notes the absence of a pending/running filter (schema-verified). This provides valuable context beyond basic functionality.

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 concise, consisting of two sentences. It is front-loaded with 'READ-ONLY' for immediate clarity, and every sentence adds value without unnecessary words.

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?

The tool is simple (read a single object) and has an output schema, so the description need not explain return values. It explains the read-only nature, the upstream bug, and the lack of pending/running filters. This is sufficient for an agent to understand the tool's behavior and use it correctly.

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 the schema already provides clear descriptions for both parameters (fabric and proximo_target). The tool description does not add any additional meaning or context about parameter usage beyond what the schema provides, meeting the baseline expectation.

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 clearly states 'read one SDN fabric's configuration', specifying verb ('read') and resource ('SDN fabric's configuration'). It distinguishes from sibling tools like pve_sdn_fabric_create, pve_sdn_fabric_delete, pve_sdn_fabric_update by emphasizing this is a read operation, and even calls out upstream's copy-paste bug to avoid confusion.

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 implies when to use this tool (to read a single fabric's configuration) by contrasting with a list tool (mentioning 'unlike the list tool above'). However, it does not explicitly state when not to use it or provide alternatives beyond the implicit differentiation.

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