Skip to main content
Glama
claude-proxmox-controller

claude-proxmox-controller

guest_details

Read-onlyIdempotent

Retrieve a Proxmox guest's complete configuration by host and VMID, including pending VM settings for its next start.

Instructions

One guest's full Proxmox configuration, and for a VM the settings waiting for its next start.

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": {
      "host": "<host>",
      "vmid": "<vmid>"
    },
    "name": "guest_details"
  }
}

Input Schema

NameRequiredDescriptionDefault
hostYesThe host's id, from list_hosts.
vmidYesThe guest's ID (VMID).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and closed-world scope, so the safety profile is fully covered. The description's only extra contribution is the non-obvious note that for a VM the response also includes settings waiting for its next start (pending config), which is genuinely useful but is the sole behavioral detail; nothing is said about failure modes for an unknown vmid or how large the returned configuration is.

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?

A single compact sentence with no redundancy, and the core purpose is front-loaded. The appended clause about pending VM settings makes the sentence slightly convoluted but it carries real information, so nothing is wasted.

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?

For a two-parameter read with full schema coverage and rich annotations, the main remaining gap is return-shape context, since there is no output schema. The description gestures at that ('full Proxmox configuration', pending settings) but does not indicate what a configuration object broadly contains or how an invalid vmid is reported.

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% and both parameters are documented in the schema itself (host id from list_hosts, guest VMID). The description adds no additional meaning about either parameter, so the baseline of 3 applies.

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 identifies a single-resource retrieval of a guest's full Proxmox configuration, which is clearly narrower than list_guests and clearly distinct from mutators like edit_guest or delete_guest. It does not use an explicit verb like 'get' or 'retrieve', so the read intent is only implied, and no sibling is named.

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

Usage Guidelines3/5

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

Use is implied by 'One guest's full ... configuration' — this is the per-guest detail lookup versus the enumeration tools — but there is no explicit when-to-use statement, no prerequisites (e.g. host must exist, vmid must be valid), and no stated exclusions against siblings such as guest_usage or list_guests.

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