Skip to main content
Glama

snap_list

Retrieve the snapshot tree, current snapshot, and stored metadata for a registered VM to inspect its snapshot history.

Instructions

Snapshot tree of a VM plus the current snapshot and stored metadata.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
vmYesVM name as registered in vms.yaml

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?

There are no annotations, so the description carries the burden of behavioral disclosure. It communicates the read-oriented nature and the content returned (tree, current snapshot, stored metadata), but does not mention failure modes, output formatting, or any side effects. This is adequate but not highly detailed.

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?

The description is a single concise sentence that front-loads the resource and result components. It is compact and free of filler, though the phrasing 'Snapshot tree of a VM' is slightly awkward as an imperative.

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 list tool, the description is mostly complete: it names the target VM and the expected output contents. However, there is no output schema and no explanation of return format or error conditions, leaving some gaps in what an agent should expect.

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 the vm parameter is already well-described as 'VM name as registered in vms.yaml'. The tool description adds no additional parameter semantics beyond confirming the operation is for a single VM, so the baseline score of 3 is appropriate.

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 clearly identifies the tool as returning the snapshot tree of a VM plus the current snapshot and stored metadata. It is distinguishable from sibling snapshot tools like snap_take, snap_revert, and snap_delete, though it lacks an explicit verb such as 'list'.

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 description implies the tool is for viewing snapshot state for a specific VM, but it does not explicitly state when to prefer this tool over alternatives or mention any exclusions. Usage context is inferable from the tool name and sibling set, not directly stated.

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