Skip to main content
Glama

Get guest OS info (agent)

proxmox_get_guest_info
Read-only

Retrieve a Proxmox VM's guest agent details—OS, kernel, hostname, timezone, clock skew, online vCPUs, and agent version—to check guest health. Failed queries are reported separately.

Instructions

Ask a running VM's QEMU guest agent about the guest: OS name/version/kernel, hostname, timezone, guest clock (and its skew from this server), vCPUs online and the agent version with its disabled commands. VMs only (containers need no agent). Individual queries that fail are reported under errors instead of failing the call. Use proxmox_get_guest_network for IP addresses.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "vmid": "<vmid>"
    },
    "name": "proxmox_get_guest_info"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the full unprocessed objects from the API (larger)
nodeNoNode the guest is on. Looked up automatically from the VMID when omitted.
vmidYesVM or container ID (VMID), e.g. 100

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds genuinely useful behavior beyond them: partial failures surface under `errors` rather than aborting the call, which tells the agent to inspect the result rather than treat success as all-or-nothing. Return shape is not documented beyond the field list, which keeps it short of a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, front-loaded with the action, and each sentence does distinct work: what is returned, which guests are in scope, and how failures are reported. The field enumeration is verbose but justified because no output schema exists.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description carries the return-value burden and does so by listing the returned fields. Combined with the errors caveat and the container exclusion, an agent has everything needed to call this correctly against a VM.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so vmid, node and raw are each already documented in the schema. The description adds no syntax, defaults, or semantics beyond implying a VMs-only scope for vmid, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb and resource ('ask a running VM's QEMU guest agent about the guest') and then enumerates the exact payload: OS name/version/kernel, hostname, timezone, clock skew, vCPUs online, agent version and disabled commands. That is concrete enough for an agent to distinguish this from sibling guest-info tools without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives an explicit exclusion ('VMs only (containers need no agent)') and routes the agent to proxmox_get_guest_network for IP addresses, which is exactly the serialization decision an agent would otherwise get wrong. What is missing is an explicit precondition statement that the guest agent must be installed and responsive on the VM, though 'ask a running VM's QEMU guest agent' strongly implies it.

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

Deploy Server

Other Tools