pve_sdn_zone_get

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

Clearly indicates read-only nature; no annotations provided, but description carries burden well. Lacks mention of possible errors (e.g., zone not found) but output schema exists.

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 concise sentences, front-loaded with key info (READ-ONLY), no fluff.

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?

With output schema present, description provides necessary context: use case, prerequisite listing tool, and read-only nature. Could add minimal guidance on pending vs running parameters, but schema covers those.

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%, so description adds minimal parameter info beyond what schema already provides; baseline 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?

States it reads one SDN zone's configuration, explicitly marks as READ-ONLY, and distinguishes itself from the list tool by noting the historical gap.

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 advises to use pve_sdn_zones_list first to enumerate zone ids, and the READ-ONLY label implies safe use cases.

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