qemu_vm_list

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

The description adds a significant behavioral note that the VM remains locked by the session and advises calling vm_unlock afterward. This goes beyond the annotations (readOnlyHint, idempotentHint) by disclosing a session-lock related side condition, which is important for the agent to know for proper workflow management.

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 two sentences, both directly relevant. The primary action is front-loaded, and the additional lock warning is concise and actionable. There is no wasted wording.

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?

For a simple list operation with no parameters and no output schema, the description covers the essential purpose and the important lock note. It could be slightly clearer about what 'lifecycle state' includes or that it returns a list of VMs, but the core information is present and sufficient for a tool of this complexity.

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?

The tool has zero parameters, so the baseline is 4. The description correctly focuses on the operation itself rather than parameter details, which are unnecessary. It adds no confusion and aligns with the empty schema.

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' and the resource 'broker-managed QEMU VMs' along with the output 'their lifecycle state'. This distinguishes it from sibling tools like qemu_vm_status which focuses on a single VM's status, while this lists all managed VMs.

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 does not explicitly state when to use this tool versus alternatives such as qemu_vm_status or qemu_vm_select. However, it provides a clear follow-up instruction ('call vm_unlock when finished') which gives some usage context, but no explicit when-not or alternative guidance.

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