Skip to main content
Glama

List VMs and containers

list_guests
Read-onlyIdempotent

List VMs and containers across a Proxmox cluster with resource usage, tags, and HA state. Filter results by node, status, guest type, or tag to audit guests.

Instructions

List VMs and containers across the cluster with resource usage, tags and HA state.

Input Schema

NameRequiredDescriptionDefault
tagNoOnly guests carrying this tag.
nodeNoOnly guests on this node.
statusNoFilter by state.
guest_typeNo'qemu' (VM) or 'lxc' (container).
include_templatesNoAlso list VM and container templates.

Output Schema

NameRequiredDescriptionDefault
totalYes
guestsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and non-destructive behavior, so the safety profile is covered. The description adds that results carry resource usage, tags and HA state, but says nothing about pagination, result size on large clusters, or cost of a cluster-wide scan.

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?

A single front-loaded sentence with no filler. The purpose and returned content are stated in the first clause.

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

Completeness3/5

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

With rich annotations and an output schema, the description needn't explain returns or safety, and it does mention returned fields. However, for a 5-filter list tool it omits the existence of filtering entirely, which is the main thing an agent needs in order to call it well.

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 every filter is documented in the schema itself. The description adds no parameter semantics beyond the schema, which sets the baseline at 3.

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

Purpose4/5

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

States a specific verb and resource ('List VMs and containers') and scopes it to 'across the cluster', which separates it from get_guest (single guest) and list_nodes (nodes). It does not explicitly name any sibling, so it falls just short of 5.

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

Usage Guidelines2/5

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

The description gives no when-to-use guidance or alternatives. Critically, it never mentions that the tool supports filtering by tag, node, status, guest_type, or templates, so an agent has to open the schema to learn the tool's main usage pattern.

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