vm agent get osinfo

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false. The description adds only that it returns specific fields, without additional behavioral context such as potential errors if the guest agent is unavailable or if the VM is powered off.

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 a single, well-structured sentence that front-loads the core purpose: 'Return guest OS info'. No superfluous words or repetition.

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 simplicity of the tool and the presence of annotations, the description is minimal. It lacks important context such as the requirement for the QEMU Guest Agent to be active, or that the VM must be running. The output fields are listed, but input semantics and error conditions are absent.

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 input schema has 2 parameters (node, vmid) with 0% description coverage. The description does not explain or add meaning to these parameters, leaving the agent to infer from schema alone.

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 uses a specific verb ('Return') and resource ('guest OS info'), listing the exact fields (kernel, name, version, pretty name). This clearly distinguishes it from sibling tools like vm_agent_get_hostname or vm_agent_get_fsinfo, which return different information.

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 guidance is provided on when to use this tool versus alternatives such as vm_agent_info or other vm_agent_get_* tools. The description does not mention prerequisites (e.g., guest agent must be running in the VM) or typical use cases.

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