vm_list

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

Declares itself as read-only via '[READ]', lists filters and limit, explains truncated behavior. No hidden side effects. No annotations provided, so description carries full burden; it does so adequately.

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?

First line summarizes, then return format, then bullet-point args. No fluff; every sentence adds value. Perfectly front-loaded.

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?

Includes return format and truncated handling. No output schema, so description covers that. Could mention pagination limits or max limit, but overall sufficient for a list tool.

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?

With 0% schema description coverage, the description compensates by explaining each parameter (power_state filter, pool uuid, limit default, target). Adds meaning beyond type information, though lacks enum values for power_state.

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 it lists VMs with specific attributes; '[READ]' prefix and verb 'List' with resource 'VMs' make purpose unmistakable. Distinguishes from sibling tools like vm_get or vm_stats.

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?

Explains return format and truncated flag, advising to re-run with higher limit if truncated. Describes optional filters. However, lacks explicit comparison with sibling tools like vm_get.

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