Skip to main content
Glama
vmware-skills

VMware-Monitor

by vmware-skills
OverviewSchemaSourceRelated ServersScoreDiscussionsAdmin
Python
Hybrid

vm_list_snapshots

Read-onlyIdempotent

List all snapshots of a single VM with nesting hierarchy, including name, description, timestamp, state, and level. Verify snapshot presence and structure before changes.

Instructions

[READ] List all snapshots of one VM, including the nesting hierarchy.

Returns the list envelope, one row per snapshot with name, description, created timestamp, state and level (0 = root; children are level+1). Empty items with truncated False means the VM genuinely has no snapshots. Read-only — creating, reverting and deleting snapshots live in vmware-aiops.

Use this for one known VM; prefer snapshot_aging to sweep the whole inventory for old or sprawling snapshots. Get the name from list_virtual_machines first — an unknown name returns a teaching error.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetNovCenter/ESXi target from config (default if omitted).
vm_nameYesExact name of the virtual machine.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.9.2
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / target / description
      Added value: +"vCenter/ESXi target from config (default if omitted)."
    • addedInput schema / properties / vm_name / description
      Added value: +"Exact name of the virtual machine."
    • changedOutput schema / (root)
      Previous value: -{
-  "properties": {
-    "result": {
-      "items": {
-        "additionalProperties": true,
-        "type": "object"
-      },
-      "title": "Result",
-      "type": "array"
-    }
-  },
-  "required": [
-    "result"
-  ],
-  "title": "vm_list_snapshotsOutput",
-  "type": "object"
-}New value: +null
  2. Addedv1.5.38

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already include readOnlyHint, idempotentHint, and destructiveHint, but the description adds meaningful behavioral context on top: distinguishing a genuinely empty snapshot list via 'empty items with truncated False,' explaining the level hierarchy, and clarifying that mutating snapshot operations live in vmware-aiops. No contradiction with annotations.

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 efficiently organized into three short paragraphs, each earning its place: what/returns, alternatives and preconditions, and error behavior. Key scope and read-only details are front-loaded, and no sentence is filler.

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?

The description fully equips an agent to call the tool correctly: exact parameter semantics, return envelope details, empty-result interpretation, the source for the VM name, and which sibling handles inventory-wide scanning. Despite having no output schema, the return structure is clearly documented.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and both parameters are already described in the schema. The description adds extra practical meaning by requiring an 'exact name,' telling the agent to obtain it from list_virtual_machines, and reinforcing that the target defaults from config. This goes beyond the baseline schema-only explanation.

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 opens with a specific verb and resource: 'List all snapshots of one VM, including the nesting hierarchy.' It specifies what is returned per row (name, description, created timestamp, state, level) and explicitly distinguishes itself from mutating snapshot operations and related siblings.

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?

Provides explicit when-to-use guidance: 'Use this for one known VM.' It names the alternative for sweeping inventory (snapshot_aging) and instructs the agent to get the VM name from list_virtual_machines first. It even warns about behavior for unknown names.

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

Install Server

Other Tools