robot_list_vswitches

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

Without annotations, the description clearly states 'Read only, free' indicating safety and cost, and 'Compact by default' explains default output behavior. No contradictions or hidden side effects mentioned, but it could elaborate on the meaning of 'compact' versus 'verbose'.

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 extremely concise with three short fragments. Every word serves a purpose. However, it could benefit from slightly more structured phrasing (e.g., a complete sentence) while maintaining brevity.

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 has 3 parameters, no output schema, and no annotations. The description covers read-only nature and default compact view. Missing details about what compact vs verbose returns, pagination, or any ordering. Adequate but not comprehensive.

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% with all parameters described. The description adds no additional meaning beyond the schema. According to guidelines, baseline is 3 when coverage is high.

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?

Description clearly states 'List vSwitches' with verb and resource. The addition of 'Read only, free' distinguishes it from mutation tools. It is specific and differentiates from sibling list tools for other resources.

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?

No explicit guidance on when to use this tool vs alternatives. Implicitly for listing vSwitches, but lacks context such as prerequisites or comparison with other list tools. The description does not provide exclusions or situational advice.

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