vmware-vks

list_vm_service_snapshots

Read-onlyIdempotent

[READ] List VirtualMachineSnapshot objects in a vSphere Namespace.

Instructions

[READ] List VirtualMachineSnapshot objects in a vSphere Namespace.

VM Service snapshots (vmoperator.vmware.com CRD, new at v1alpha5) via the Supervisor K8s API — the served CRD version is discovered at runtime, not hardcoded. Returns the family list envelope: items of {name, namespace, vm_name, created, ready} plus returned/total/truncated (walked to completion, so truncated is always false) and served_version. If the Supervisor is older than v1alpha5 the error names the required version. Run list_namespaces first for the namespace; use list_vm_service_network_interfaces for a VM's NICs.

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": {
      "namespace": "<namespace>"
    },
    "name": "list_vm_service_snapshots"
  }
}

Input Schema

Name	Required	Description	Default
`target`	No	vCenter in config.yaml; omit for the default.
`namespace`	Yes	vSphere Namespace to list snapshots in (via list_namespaces).

Schema Changelog

Changes observed during successful MCP inspections.

Addedv2.0.0Oct 14, 2026

TDQS

A4.4/5.0

Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive/openWorld, so the safety profile is covered. The description adds genuine context beyond that: runtime CRD version discovery, the specific error when the Supervisor predates v1alpha5, and the truncation semantics (walked to completion, so truncated is always false). It stops short of stating auth/permission needs, keeping it at 4.

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?

Front-loaded with a [READ] marker and the core purpose, then detail; every sentence carries information. The dense parenthetical clauses (CRD version, envelope fields) are useful but slightly heavy, so not a 5.

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 compensates by spelling out the return envelope (items shape plus returned/total/truncated/served_version) and the error path for old Supervisors, and it covers the prerequisite and sibling routing. Nothing an agent needs to invoke this correctly 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 both parameters are already documented (namespace 'via list_namespaces', target defaulting to config.yaml). The description only restates the namespace source and adds nothing about the target parameter, so the baseline 3 is appropriate.

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 (list) and resource (VirtualMachineSnapshot objects) with explicit scope (a vSphere Namespace), plus the CRD origin (vmoperator.vmware.com, v1alpha5). It names the sibling it is not (list_vm_service_network_interfaces), so an agent can distinguish it without opening a schema.

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 routes the agent: 'Run list_namespaces first for the namespace' gives the prerequisite, and 'use list_vm_service_network_interfaces for a VM's NICs' names the alternative and the condition that selects it. No inference required.

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