Skip to main content
Glama
CyberKnightLabs

vmware-knight

vm_list_snapshots

Read-onlyIdempotent

List a VM's full snapshot tree, including nested child snapshots, to identify exact snapshot names before reverting, deleting, or creating a linked clone.

Instructions

[READ] List the full snapshot tree of a VM, including nested child snapshots.

Read-only, no side effects. Call this before vm_revert_snapshot, vm_delete_snapshot, or deploy_linked_clone to get exact snapshot names. 'items' is empty when the VM has no snapshots.

Returns: The list envelope. 'items' is one dict per snapshot: name, description, created, state (power state at snapshot time), level (0 = root). The whole tree is walked, so 'total' is the real count and 'truncated' is always false.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetNovCenter/ESXi target name from config.yaml; omit to use the default target.
vm_nameYesExact VM name as shown in vCenter inventory.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.12.10

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint false. The description adds useful behavioral details: the whole tree is walked, 'total' is the real count, 'truncated' is always false, and 'items' is empty when no snapshots exist. This goes beyond the annotation baseline.

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 front-loaded with the operation and key usage, then gives only necessary behavioral and response details. Every sentence adds value and the returns section is clearly separated. No fluff.

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?

With no output schema, the description fully explains return values: one dict per snapshot, fields included, nesting behavior, and the empty case. It also explains when to use the tool and what it guarantees about pagination. Nothing needed for correct invocation is missing.

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 the schema already documents vm_name and target. The description does not add parameter-level details beyond what the schema provides, but no compensation is needed at full coverage.

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 states a specific verb and resource: 'List the full snapshot tree of a VM, including nested child snapshots.' This clearly distinguishes it from snapshot creation, deletion, and revert tools by emphasizing the read-only listing of the entire tree.

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

Usage Guidelines5/5

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

Explicitly says 'Call this before vm_revert_snapshot, vm_delete_snapshot, or deploy_linked_clone to get exact snapshot names.' This gives direct, actionable guidance on when this tool is the right choice compared to sibling tools.

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