pve-mcp

pve_guest

Retrieves status, configuration, and snapshots for a Proxmox VE VM or container by ID, with node and guest type detected automatically.

Instructions

Status of a VM or container (node and type are found automatically), plus its config and snapshots.

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": "pve_guest"
  }
}

Input Schema

Name	Required	Description	Default
`vmid`	Yes
`include_config`	No

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Nov 10, 2026

TDQS

B3/5.0

Behavior3/5

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

With no annotations, the description carries the full behavioral burden, and it does disclose one useful non-obvious trait: the node and guest type are resolved automatically, so the caller only needs an ID. It says nothing about permission requirements, behavior on stopped guests, or response size, all of which matter for a cluster-status read.

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

Conciseness4/5

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

One tightly packed sentence with the resource front-loaded and no filler. The parenthetical about automatic node/type discovery is well placed, though the trailing 'plus its config and snapshots' reads as an afterthought rather than a structured enumeration.

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?

An output schema exists, so return values need not be spelled out, and the tool is only two parameters deep. Still, an agent lacks the two things it needs to invoke correctly: the source of a vmid and the meaning of include_config, plus any routing against the overlapping config/snapshot siblings.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate, and it largely does not. It never explains what vmid is or how to obtain one (pve_next_vmid exists as a sibling), and it never mentions include_config as a toggle - if anything, 'plus its config' implies config is always returned, which the optional flag contradicts.

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?

The description names a specific resource (a VM or container) and enumerates what comes back: status, config, and snapshots. It is clearly a read/aggregate view rather than a mutation, but it does not differentiate itself from pve_guest_config or pve_snapshot, which appear to return overlapping pieces of the same data.

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?

There is no when-to-use or when-not-to-use guidance. The description never tells an agent whether to call this instead of pve_guest_config, pve_snapshot, or pve_resources, even though those siblings return overlapping information. The only implicit hint is that node/type resolution is automatic.

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