Skip to main content

Nutanix MCP — Model Context Protocol server for Nutanix Prism Element, Prism Central, and Move

Project description

Nutanix MCP

License: MIT PyPI Python 3.10+

Ask GitHub Copilot questions about your Nutanix environment in plain English — VMs, hosts, storage, networking, alerts, tasks, protection domains, resource utilization, migration plans, and more — directly from VS Code.

Supports Prism Element (PE), Prism Central (PC), and Nutanix Move — with per-cluster, per-PC, and per-Move-appliance credentials stored securely in your OS keyring (Windows Credential Manager / macOS Keychain / Linux Secret Service).

Requirements

Quick start

# 1. Install
pip install nutanix-mcp

# 2. Create a folder for your inventory, navigate to it, and run the wizard
mkdir my-nutanix && cd my-nutanix
nutanix-mcp configure

The wizard will:

  • Verify Python 3.10+ is active
  • Install / update all dependencies
  • Register your Prism Element cluster(s), Prism Central instance(s), and Move appliance(s) in inventory.yaml
  • Store credentials securely in the OS keyring — no plain-text passwords anywhere
  • Write .vscode/mcp.json pointing VS Code at the server (no credentials in this file)
# 3. Open the folder in VS Code
code .

In VS Code, open Copilot Chat, switch to Agent mode, and start asking questions.

Already set up? Re-run nutanix-mcp configure at any time to add new clusters, PC instances, or Move appliances, and to update credentials.

Configuration

Credential storage

Credentials are stored in the OS keyring under the service name nutanix-mcp. Key format:

Entity Keyring key examples
PE cluster (default) pe.default.username, pe.default.password
PE cluster (override) pe.CLUSTER-NAME.username, pe.CLUSTER-NAME.password
Prism Central pc.PC-NAME.api_key (preferred) or pc.PC-NAME.username / pc.PC-NAME.password
Move appliance move.MOVE-NAME.username, move.MOVE-NAME.password

Lookup falls back from named entry → pe.default.* → legacy environment variables (NUTANIX_PE_USERNAME etc.) for backward compatibility.

Cluster inventory — inventory.yaml

Register your instances here. Edit directly or re-run nutanix-mcp configure.

prism_central:
  - name: PROD-PC-1
    pc_host: 192.168.1.50

clusters:
  - name: PROD-CLUSTER-1
    pe_host: 192.168.1.100
  - name: PROD-CLUSTER-2
    pe_host: 192.168.1.200

move_instances:
  - name: PROD-MOVE-1
    move_host: 192.168.1.75
  • name — label used in prompts and tool parameters (pc_name, cluster_name, move_name)
  • Single entry → selected automatically; multiple entries → specify the name in your prompt

VS Code — .vscode/mcp.json

Generated by nutanix-mcp configure. Contains no credentials:

{
  "servers": {
    "nutanix-mcp": {
      "type": "stdio",
      "command": "nutanix-mcp",
      "env": {
        "NUTANIX_MCP_INVENTORY": "${workspaceFolder}/inventory.yaml"
      }
    }
  }
}

Usage

Switch Copilot Chat to Agent mode and ask in plain English:

List all VMs and their power state
How much free storage does the cluster have?
Show me any critical alerts
What tasks are currently running?
Show resource utilization for the cluster over the last hour
Get CPU and memory stats for VM <uuid>
Which hosts are in the cluster and what model are they?
List all protection domains
Show migration plans on the Move appliance
Which VMs are currently being seeded?

Target a specific cluster, PC instance, or Move appliance by name:

List all hosts from cluster PROD-CLUSTER-1
Show VMs on PROD-CLUSTER-2
List all VMs managed by PC PROD-PC-1
Show subnets across all clusters from PROD-PC-1
List migration plans on PROD-MOVE-1

Copilot calls list_inventory automatically when needed to discover available entries.

Project structure

nutanix-mcp/
├── inventory.yaml              Cluster, PC, and Move registry (user-generated)
├── pyproject.toml              Package metadata and dependencies
├── available_tools.md          Full tool reference
└── src/
    └── nutanix_mcp/
        ├── __init__.py
        ├── app.py              Shared FastMCP instance ("Nutanix MCP")
        ├── cli.py              Entry point — 'nutanix-mcp' and 'nutanix-mcp configure'
        ├── server.py           Thin wrapper delegating to cli.main()
        ├── credentials.py      OS keyring read/write helpers
        ├── registry.py         Inventory loading, host+credential resolvers, JSON helper
        ├── client.py           HTTP clients: pe_get, pc_v4_get, move_get
        └── tools/
            ├── inventory.py            list_inventory
            ├── pe_cluster.py           list_clusters, get_cluster
            ├── pe_hosts.py             list_hosts, get_host
            ├── pe_cvms.py              list_cvms, get_cvm
            ├── pe_vms.py               list_vms, get_vm, get_vm_nics, get_vm_disks
            ├── pe_storage.py           list_storage_containers, get_storage_container,
            │                           list_storage_pools, list_disks, get_disk
            ├── pe_networking.py        list_subnets
            ├── pe_images.py            list_images
            ├── pe_alerts.py            list_alerts, list_events
            ├── pe_ops.py               list_protection_domains, list_tasks
            ├── pe_stats.py             get_vm_stats, get_host_stats,
            │                           get_cluster_stats, get_storage_container_stats
            ├── pc_clusters.py          list_pc_clusters, get_pc_cluster
            ├── pc_vms.py               list_pc_vms, get_pc_vm, list_pc_vm_disks, list_pc_vm_nics
            ├── pc_hosts.py             list_pc_hosts, get_pc_host
            ├── pc_networking.py        list_pc_subnets
            ├── pc_images.py            list_pc_images
            ├── pc_storage.py           list_pc_storage_containers
            ├── pc_alerts.py            list_pc_alerts, get_pc_alert, list_pc_alert_policies
            ├── pc_tasks.py             list_pc_tasks, get_pc_task
            ├── pc_categories.py        list_pc_categories, get_pc_category, list_pc_category_values
            ├── move_environments.py    list_move_environments, get_move_environment,
            │                           list_move_source_environments, list_move_target_environments
            ├── move_plans.py           list_move_plans, get_move_plan, get_move_plan_status
            └── move_vms.py             list_move_workloads, get_move_workload,
                                        list_move_plan_workloads

See available_tools.md for the full tool reference including parameters, return values, and source modules.

Notes

  • All tools are read-only — no changes are made to your Nutanix environment
  • PE tools use the Prism Element v2.0 REST API (per-cluster, port 9440)
  • PC tools use the Prism Central v4.0 REST API (cross-cluster, port 9440); alert listing uses the v2.0 gateway at /PrismGateway/services/rest/v2.0/alerts
  • Move tools use the Move v2 REST API (port 443)
  • PC tools use extId as the entity identifier; use values from list_* calls as input to get_* calls
  • Stats metrics are in ppm (parts per million); divide by 10,000 to convert to a percentage
  • Transport is stdio — the server runs locally and is managed by VS Code

Disclaimer

This is an independent, community-built project and is not an official Nutanix product. It is not affiliated with, endorsed by, or supported by Nutanix, Inc. in any way. Nutanix, Prism, and Move are trademarks of Nutanix, Inc.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nutanix_mcp-0.1.1.tar.gz (30.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nutanix_mcp-0.1.1-py3-none-any.whl (38.4 kB view details)

Uploaded Python 3

File details

Details for the file nutanix_mcp-0.1.1.tar.gz.

File metadata

  • Download URL: nutanix_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 30.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for nutanix_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 25e2850aab3ef3352f904dcb72b2c99acf5aeaf55f9a8b4a76790e3b80ec8ec4
MD5 f999301c392c690c97826a92eddd4e37
BLAKE2b-256 00024f488d2b758acb7a68d331b2ff185b07ad251f6d013d5a2668af9a7089c1

See more details on using hashes here.

File details

Details for the file nutanix_mcp-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: nutanix_mcp-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 38.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for nutanix_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 857c58f040ac377eb47e49552b64c0e9958e05b322a7f71410e9f759dd6c8abb
MD5 234875badd942e2bc7528618eda4f946
BLAKE2b-256 8cfb0d08f1c0534f905d0093ca26ac778e98b880bca5c6f80218bd1d90249d16

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page