Skip to main content
Glama
jkmills

Nutanix MCP Server

by jkmills

pe_list_snapshots

Retrieve all snapshots associated with a protection domain on a Prism Element cluster to manage backup and recovery operations.

Instructions

List snapshots for a protection domain on a Prism Element cluster.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pe_hostYesPrism Element CVM IP address or hostname
protection_domainYesName of the protection domain

Implementation Reference

  • Schema definition for pe_list_snapshots tool: defines name, description, and inputSchema with pe_host and protection_domain parameters.
        {
            "name": "pe_list_snapshots",
            "description": (
                "List snapshots for a protection domain on a Prism Element cluster."
            ),
            "inputSchema": {
                "type": "object",
                "properties": {
                    "pe_host": {
                        "type": "string",
                        "description": "Prism Element CVM IP address or hostname",
                    },
                    "protection_domain": {
                        "type": "string",
                        "description": "Name of the protection domain",
                    },
                },
                "required": ["pe_host", "protection_domain"],
            },
        },
    ]
    
    
    # ─── Tool Handlers ────────────────────────────────────────────────────────────
    
    
    async def handle_pe_get_cluster_info(
        client: NutanixClient, arguments: dict[str, Any]
    ) -> dict[str, Any]:
  • Handler function handle_pe_list_snapshots: calls client.pe_get on protection_domains/{pd_name}/dr_snapshots and returns snapshot details.
    async def handle_pe_list_snapshots(
        client: NutanixClient, arguments: dict[str, Any]
    ) -> dict[str, Any]:
        """List snapshots for a protection domain from Prism Element v2 API."""
        pe_host = arguments["pe_host"]
        pd_name = arguments["protection_domain"]
    
        result = await client.pe_get(
            pe_host, f"protection_domains/{pd_name}/dr_snapshots"
        )
        entities = result.get("entities", [])
    
        return {
            "count": len(entities),
            "snapshots": [
                {
                    "snapshotId": s.get("snapshot_id"),
                    "snapshotName": s.get("snapshot_name"),
                    "createdTimestamp": s.get("created_time_stamp_in_usecs"),
                    "expiryTimestamp": s.get("expiry_time_stamp_in_usecs"),
                    "state": s.get("state"),
                }
                for s in entities
            ],
        }
  • Handler dispatch registration mapping 'pe_list_snapshots' to handle_pe_list_snapshots in PE_HANDLERS dict.
    PE_HANDLERS: dict[str, Any] = {
        "pe_get_cluster_info": handle_pe_get_cluster_info,
        "pe_list_vms": handle_pe_list_vms,
        "pe_list_hosts": handle_pe_list_hosts,
        "pe_list_containers": handle_pe_list_containers,
        "pe_list_storage_pools": handle_pe_list_storage_pools,
        "pe_list_disks": handle_pe_list_disks,
        "pe_list_alerts": handle_pe_list_alerts,
        "pe_list_protection_domains": handle_pe_list_protection_domains,
        "pe_list_snapshots": handle_pe_list_snapshots,
    }
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It does not disclose behavioral traits such as read-only nature, pagination, limits, or required permissions. The word 'list' implies read-only, but that's insufficient without additional context.

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 a single, clear sentence with no wasted words. It is efficient and front-loaded with the key action and resource.

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 simple list tool with two parameters and no output schema, the description is minimally adequate. However, it does not explain the return format, dependencies (e.g., need a protection domain name from another tool), or any usage context beyond the literal action.

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%, so baseline is 3. The description adds no additional meaning beyond what is in the parameter descriptions. It merely restates the purpose at a high level.

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 clearly states the action (list) and the resource (snapshots) with specific context (protection domain, Prism Element cluster). It distinguishes from sibling tools like pe_list_protection_domains by specifying snapshots.

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 usage when you need snapshots for a specific protection domain, but it provides no guidance on when to use this tool versus alternatives (e.g., first listing protection domains). No exclusions or contextual cues are given.

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

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/jkmills/nutanix-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server