mcp-proxmox

MCP server for managing Proxmox VE clusters through AI assistants like Claude, Cursor, and Cline.

Provision, manage, and monitor your entire Proxmox infrastructure through natural language. Create VMs and containers, manage snapshots, browse storage, and more.

Quick Start

# Run directly with uvx (no install needed)
uvx mcp-proxmox

# Or install with pip
pip install mcp-proxmox

Configuration

Set these environment variables (or create a .env file):

PROXMOX_HOST=192.168.1.100          # Your Proxmox VE host
PROXMOX_TOKEN_ID=user@pam!mcp       # API token ID
PROXMOX_TOKEN_SECRET=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx  # API token secret

Optional:

PROXMOX_PORT=8006                   # Default: 8006
PROXMOX_VERIFY_SSL=false            # Default: false

Creating a Proxmox API Token

1. Log into your Proxmox web UI

2. Go to Datacenter > Permissions > API Tokens

3. Click Add and create a token for your user

4. Uncheck "Privilege Separation" for full access, or assign specific permissions:

   • VM.Audit — read VM/CT status and config

   • VM.PowerMgmt — start/stop/shutdown/reboot

   • VM.Snapshot — create/rollback/delete snapshots

   • VM.Allocate — create/delete/clone VMs and containers

   • VM.Clone — clone operations

   • Datastore.Audit — list storages and browse content

   • Datastore.AllocateSpace — allocate disk space for new VMs/CTs

   • Sys.Audit — read node status and tasks

   • VM.Monitor — access QEMU monitor (for metrics)

Integration

Claude Desktop

Add to ~/.claude/claude_desktop_config.json:

{
  "mcpServers": {
    "proxmox": {
      "command": "uvx",
      "args": ["mcp-proxmox"],
      "env": {
        "PROXMOX_HOST": "192.168.1.100",
        "PROXMOX_TOKEN_ID": "user@pam!mcp",
        "PROXMOX_TOKEN_SECRET": "your-token-secret"
      }
    }
  }
}

Claude Code

Add to .claude/settings.json or ~/.claude/settings.json:

{
  "mcpServers": {
    "proxmox": {
      "command": "uvx",
      "args": ["mcp-proxmox"],
      "env": {
        "PROXMOX_HOST": "192.168.1.100",
        "PROXMOX_TOKEN_ID": "user@pam!mcp",
        "PROXMOX_TOKEN_SECRET": "your-token-secret"
      }
    }
  }
}

Cursor

Add to Cursor Settings > MCP with the same configuration as above.

Available Tools

Discovery

Lifecycle

Storage

Provisioning

Backup & Restore

Command Execution

Note: exec_command requires qemu-guest-agent installed and running inside the VM. Not supported for LXC containers (Proxmox API limitation).

Snapshots

Monitoring

Safety

Destructive operations (stop_guest, reboot_guest, rollback_snapshot, delete_snapshot, delete_guest) require explicit confirm=true. The first call returns a warning describing the impact; only a second call with confirmation executes the action.

Examples

Once connected, you can ask your AI assistant:

• "List all my VMs and their status"

• "How much memory is VM 100 using?"

• "Shut down container 105"

• "Create a snapshot of VM 200 called before-upgrade"

• "Show me the CPU usage of VM 100 over the last day"

• "What tasks ran on node pve recently?"

• "Which VMs are stopped?"

• "What storage pools do I have and how full are they?"

• "Show me available ISO images"

• "Create a new Ubuntu VM with 4 cores and 8GB RAM"

• "Clone VM 100 as a test environment"

• "Create a Debian container from template"

• "Delete the old test VM 999"

• "Back up VM 100 to the zfs-backup-storage"

• "Show me all backups for VM 200"

• "Restore the latest backup of container 101"

• "Run 'df -h' on VM 100"

• "Check if nginx is running on VM 200"

Development

git clone https://github.com/antonio-mello-ai/mcp-proxmox.git
cd mcp-proxmox
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

# Run tests
pytest

# Lint
ruff check src/ tests/
ruff format src/ tests/

# Type check
mypy src/

License

MIT