list_device_vdoms

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

No annotations are provided, so the description carries the full burden. It describes the return format and gives an example, but does not explicitly state that the operation is read-only or discuss any side effects. Given the lack of annotations, a score of 3 is appropriate.

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 well-structured with 'Args' and 'Returns' sections and an example. It is slightly verbose but each part adds value. Could be trimmed slightly but still efficient.

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 description covers the return format with status, count, vdoms, and message, and gives an example. Given the presence of an output schema (implied by the returns documentation), the description is fairly complete for this tool's purpose. Could mention possible error scenarios or rate limits, but not essential here.

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 0%, so the description must add meaning. It explains 'device' as 'Device name' and 'adom' as 'ADOM name (default: from DEFAULT_ADOM env var, or "root")', which goes beyond the schema's type-only information. This adds useful default and source context.

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 the action ('List VDOMs') and the target resource ('for a specific device'). It defines VDOMs and distinguishes itself from sibling list_* tools by focusing on VDOMs. The example reinforces the purpose.

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 explains when to use the tool (to list VDOMs for a device) and provides default behavior for the adom parameter. However, it doesn't explicitly state when not to use it or mention alternatives, though the context among sibling tools makes it clear.

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