Skip to main content
Glama
edymol

proxmox-mcp

by edymol

get_guest_config

Fetches a Proxmox guest's full configuration from a specified node, including CPU, memory, storage, network, and boot settings. Read-only and idempotent.

Instructions

One guest's configuration, on exactly the node named.

Read-only and idempotent. Returns cores, memory, swap, disks and their storage, network interfaces with bridge, address, and gateway, the unprivileged flag, the OS template, boot-on-start, and features. It never returns a password, a cloud-init password, or an SSH public key: there is no field for one.

A vmid the cluster does not report on the node named raises a structured error naming both. A config that cannot be read yields a partial result with a warning.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nodeYes
vmidYes
profileNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
nodeYes
vmidYes
coresNo
disksNo
sourceYes
os_typeNo
partialNo
profileYes
featuresNo
networksNo
warningsNo
guest_typeYes
protectionNo
swap_bytesNo
os_templateNo
architectureNo
collected_atYes
memory_bytesNo
unprivilegedNo
start_on_bootNo
Behavior5/5

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

Despite lacking annotations, the description discloses important behavioral traits: it is read-only and idempotent, explicitly states what fields are returned, clarifies that secrets are never included, and describes error handling for unknown vmid and unreadable configs. This significantly exceeds basic expectations.

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?

The description is compact and information-dense, with three sentences each serving a purpose: defining scope, listing return fields and exclusions, and describing error behavior. No redundant wording or unnecessary details are present.

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?

Given the output schema exists, the description need not enumerate return fields, but it does anyway, adding value. It covers return content, exclusions, error conditions, and partial result behavior, making it fully sufficient for an agent to use correctly.

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?

The schema has 0% description coverage, so the description must compensate. It clarifies the roles of 'node' and 'vmid' through natural language, but the optional 'profile' parameter is not explained at all. This partial coverage merits a mid-range score.

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 clearly states the tool retrieves a single guest's configuration on a specified node. It distinguishes itself from sibling list tools by emphasizing 'one guest' and listing specific configuration fields returned, making the purpose unmistakable.

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?

The description provides clear context that this tool is for retrieving a detailed configuration of a single guest on a specific node, implying it is not for listing or status checks. However, it does not explicitly name alternatives like list_guests or state when not to use this tool, so it falls short of a 5.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/edymol/proxmox-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server