Skip to main content
Glama

Get snapshot details

proxmox_get_snapshot
Read-only

Retrieve a VM or container snapshot's details, including description, timestamp, parent, RAM state, and summarized disk/network configuration to preview what a rollback would restore.

Instructions

Get a snapshot of a VM or container: its description, time, parent, whether RAM was saved, and the guest configuration as it was at that snapshot (disks and networks summarized, secrets redacted). Useful to see what a rollback would restore.

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>",
      "snapname": "<snapname>"
    },
    "name": "proxmox_get_snapshot"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the full unprocessed objects from the API (larger)
nodeNoNode the guest is on. Looked up automatically from the VMID when omitted.
vmidYesVM or container ID (VMID), e.g. 100
snapnameYesSnapshot name (see proxmox_list_snapshots)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds genuinely new behavioral detail beyond them: returned content is summarized (disks and networks) and secrets are redacted, which tells the agent the payload is not raw runtime state. It does not contradict the non-idempotent hint, though it also never explains behavior differences when the raw flag is used.

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?

Two sentences, front-loaded with the core purpose and the returned field list before the optional usage framing. The parenthetical "(disks and networks summarized, secrets redacted)" is dense but earns its place; the only minor cost is that the first sentence is long and enumerative.

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?

There is no output schema, so the description carries the burden of describing return values, and it does so adequately by listing the fields an agent would receive. For a simple read operation with full schema coverage and read-only annotations, the remaining gaps (raw output differences, what happens if the snapshot no longer exists) are minor.

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 all four parameters including the raw and node fallback behavior are already documented in the schema, establishing a baseline of 3. The description's field enumeration describes return values rather than adding meaning to vmid, snapname, node, or raw, so it adds little on this dimension.

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?

States a specific verb and resource ("Get a snapshot of a VM or container") and then enumerates exactly what the snapshot record contains: description, time, parent, RAM-saved flag, and the point-in-time guest configuration. This is clearly distinct from a listing tool, and the schema's reference to proxmox_list_snapshots reinforces the split between listing names and fetching details.

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?

The trailing clause "Useful to see what a rollback would restore" gives a concrete use case, which is more than nothing. However, it never states when not to use it, never names an explicit alternative (proxmox_list_snapshots appears only in the schema, not the description), and gives no prerequisites such as requiring an existing snapshot name.

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