Skip to main content
Glama

guest_snapshots

Read-onlyIdempotent

Read snapshot metadata for one scoped guest, enabling inspection of available snapshots without changing the Proxmox environment.

Instructions

Read snapshot metadata for one scoped guest.

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": {
      "guest_id": "<guest_id>"
    },
    "name": "guest_snapshots"
  }
}

Input Schema

NameRequiredDescriptionDefault
guest_idYesA guest identifier permitted by startup configuration.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.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 needs no restating. The description's one contribution is the word "metadata", signaling it returns descriptive records rather than snapshot contents or data — useful, but nothing is said about volume, permissions beyond startup config, or failure behavior.

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 ten-word sentence, front-loaded with the verb and resource, with no filler. Slight ambiguity in "scoped" is the only cost.

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 one-parameter read-only tool this is close to sufficient, but with no output schema the description never indicates what the snapshot metadata contains, so an agent cannot anticipate the response shape. It is adequate, not complete.

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 coverage is 100% and the guest_id parameter already carries its own description with numeric bounds (100–999999) and the "permitted by startup configuration" constraint. The description's "scoped" echoes that constraint without adding format or acquisition guidance, so the schema does the heavy lifting.

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?

"Read snapshot metadata" gives a specific verb and resource, and "for one scoped guest" fixes the scope to a single guest, which separates it from aggregate tools like list_guests or node_status. It stops short of explicitly distinguishing snapshot metadata from the similarly-named backup_history sibling, leaving that boundary to inference.

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?

"One scoped guest" implies the tool operates on a single already-identified guest, hinting that a valid id must be obtained first, but there is no explicit when-to-use, when-not-to-use, or named alternative (e.g. guest_config or backup_history). Usage is only implied.

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