Skip to main content
Glama

Get logged-in guest users (agent)

proxmox_get_guest_users
Read-only

List users currently logged in to a running QEMU VM, including domain and login time, to audit active sessions without opening a console.

Instructions

List the users currently logged in to a running VM (QEMU guest agent get-users), with domain and login time. VMs only.

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_users"
  }
}

Input Schema

NameRequiredDescriptionDefault
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/5.0
Behavior3/5

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

Annotations already establish this is a read-only, non-open-world operation, so the safety profile is covered. The description contributes the real prerequisite — the VM must be running with a QEMU guest agent available — which is genuine operational context not present in annotations. It says nothing about behavior when the agent is absent or unresponsive, which is the most likely failure mode.

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?

Two sentences, front-loaded with the scope and back-loaded with the exclusion, with zero filler. Every clause carries information: verb, resource, mechanism, return fields, and the VM-only restriction.

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

Completeness4/5

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

For a two-parameter read tool with full schema coverage and no output schema, the description covers purpose, precondition (running VM plus guest agent), and the shape of the result. The only meaningful omission is what happens on failure — e.g., a stopped VM or missing agent — which would help an agent interpret an error.

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 both vmid and node are fully documented in the schema, and the baseline of 3 applies. The description adds only the implicit constraint that the vmid must refer to a VM rather than a container; it adds nothing about the optional node parameter or ID formatting.

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 pairs a specific verb ('List') with a precisely scoped resource ('users currently logged in to a running VM'), names the underlying mechanism (QEMU guest agent get-users), and even previews the returned fields (domain, login time). The clause 'VMs only' separates it from cluster-level siblings like proxmox_list_users and from container-oriented tools without the agent needing to open either 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 a clear positive condition (a running VM with a QEMU guest agent) and a clear exclusion ('VMs only'), which matters because the vmid parameter description otherwise suggests containers are acceptable. It stops short of explicitly naming the alternative tool for containers or cluster users, so the routing is implied rather than spelled out.

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