proxmox_agent_hwRetrieve guest hardware details from a VM via QEMU agent: memory blocks, vCPUs, memory block info, hostname, or users. Requires elevated permissions.
Query guest hardware via QEMU agent. operation=memory_blocks|vcpus|memory_block_info|hostname|users (requires elevated permissions)
| Name | Required | Description | Default |
|---|---|---|---|
| node | Yes | Node name where VM is located | |
| vmid | Yes | VM ID number | |
| operation | Yes |
Changes observed during successful MCP inspections.
v1.3.0v1.2.2v1.2.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already establishes that this is a safe read operation, and the description adds a permission caveat. It does not disclose behaviors like what happens if the QEMU agent is unavailable or whether results reflect live host state, but the annotation covers the main safety profile.
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 front-loaded sentence that states the action, resource, supported operations, and a permission caveat with no filler 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?
The description is adequate for a simple read-only query tool: it names the purpose, operations, and permission requirement. However, it omits the prerequisite that a QEMU agent must be running, and with no output schema it does not hint at the expected return shape.
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?
Node and vmid already have schema descriptions, while the operation parameter has an enum in the schema. The description mostly repeats the operation enum values and adds the 'requires elevated permissions' note, providing only marginal semantic value beyond the 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 uses a specific verb and resource: 'Query guest hardware via QEMU agent,' and enumerates the supported operations. This clearly distinguishes it from most agent siblings like proxmox_agent_exec or proxmox_agent_file, though it does not explicitly contrast it with proxmox_agent_info or proxmox_guest_status.
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 gives no guidance on when to choose this tool over alternatives, and it does not state exclusions or prerequisites such as the guest agent needing to be installed and running. The only usage hint is 'requires elevated permissions,' which is a precondition rather than a selection rule.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.