vm_agent_exec

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

With no annotations provided, the description must fully disclose behavioral traits. It only states the action without mentioning potential side effects, authentication needs, error handling, or that the command may be destructive. A user or agent is left unaware of risks or required permissions.

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 only five short lines and a clear 'Args' section. Every word contributes to understanding the tool's purpose and parameters, with no redundancy or irrelevant information.

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?

Given the complexity of executing arbitrary commands in a VM, the description lacks essential context: it does not mention that the QEMU Guest Agent must be active, that the tool may be dangerous if misused, or what the output schema returns. An output schema exists but is not described. The description is incomplete for safe and effective use.

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?

Although schema coverage is 0%, the description provides one-line explanations for each parameter (node, vmid, command, input_data). This adds basic meaning beyond the schema titles but lacks detail such as expected formats, constraints, or examples. For a tool with 4 parameters, the description meets the minimum but does not fully compensate for the lack of schema descriptions.

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 'Execute a command inside a VM via the QEMU Guest Agent,' which specifies the action (execute), resource (command in a VM), and mechanism (Guest Agent). This effectively distinguishes it from sibling tools like vm_agent_file_read or vm_agent_set_password.

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 guide when to use this tool versus alternatives like vm_agent_file_read or vm_agent_exec_status. While the purpose is clear, there is no mention of prerequisites (e.g., the VM must have the QEMU Guest Agent installed and running) or exclusions, leaving the agent to infer usage context.

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