pve_sdn_subnet_get

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

No annotations provided, so description carries the burden. Declares read-only behavior upfront, which is necessary. However, doesn't elaborate on return structure or confirm idempotency, though that is implied. Adequate for a simple read operation.

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. Front-loaded with key 'READ-ONLY' label. Each sentence contributes meaning.

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?

Output schema exists, so return format is documented. All 5 parameters have descriptions in schema. Description provides prerequisite context. For a low-complexity read tool, this is complete.

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 description coverage is 100%, so baseline is 3. The description adds no new meaning beyond the schema's parameter descriptions; the mention of using list for subnet IDs is already in the schema. No extra semantic value.

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 reads one SDN subnet's configuration with 'READ-ONLY' prefix. Distinguishes from sibling tools like pve_sdn_subnet_list (enumerate) and pve_sdn_subnet_create/delete/update by specifying it reads a single subnet's configuration.

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 recommends using pve_sdn_subnet_list to enumerate subnet IDs first, providing clear prerequisite guidance. Lacks explicit when-not-to-use scenarios, but context is sufficient.

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