Proxmox

by canvrno

82 stars
Not rated
GitHub

About

Integrates with Proxmox virtualization environments to enable monitoring and management of virtual machines, containers, storage pools, and cluster resources through token-based authentication and structured API commands.

Details

Author
canvrno
Repository
canvrno/ProxmoxMCP
GitHub stars
82
License
MIT License
Categories
AI, Design, Developer Tools, File Management, Infrastructure, API, Security, Frontend

- 🤖 Full integration with Cline
- 🛠️ Built with the official MCP SDK
- 🔒 Secure token-based authentication with Proxmox
- 🖥️ Tools for managing nodes and VMs
- 💻 VM console command execution
- 📝 Configurable logging system
- ✅ Type-safe implementation with Pydantic
- 🎨 Rich output formatting with customizable themes

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Proxmox
    Command (node, npx, python, etc.) /absolute/path/to/ProxmoxMCP/.venv/bin/python
    Arguments
    • Argument 1 -m
    • Argument 2 proxmox_mcp.server
    Environment
    • LOG_LEVEL DEBUG
    • PYTHONPATH /absolute/path/to/ProxmoxMCP/src
    • PROXMOX_HOST your-proxmox-host
    • PROXMOX_PORT 8006
    • PROXMOX_USER username@pve
    • PROXMOX_SERVICE PVE
    • PROXMOX_MCP_CONFIG /absolute/path/to/ProxmoxMCP/proxmox-config/config.json
    • PROXMOX_TOKEN_NAME token-name
    • PROXMOX_VERIFY_SSL false
    • PROXMOX_TOKEN_VALUE token-value

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

get_nodes

Lists all nodes in the Proxmox cluster. Parameters: None

get_node_status

Get detailed status of a specific node. Parameters: node (string, required): Name of the node

get_vms

List all VMs across the cluster. Parameters: None

get_storage

List available storage. Parameters: None

get_cluster_status

Get overall cluster status. Parameters: None

execute_vm_command

Execute a command in a VM's console using QEMU Guest Agent. Parameters: node (string, required): Name of the node where VM is running, vmid (string, required): ID of the VM, command (string, required): Command to execute

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "proxmox": {
            "cwd": "/absolute/path/to/ProxmoxMCP",
            "env": {
                "LOG_LEVEL": "DEBUG",
                "PYTHONPATH": "/absolute/path/to/ProxmoxMCP/src",
                "PROXMOX_HOST": "your-proxmox-host",
                "PROXMOX_PORT": "8006",
                "PROXMOX_USER": "username@pve",
                "PROXMOX_SERVICE": "PVE",
                "PROXMOX_MCP_CONFIG": "/absolute/path/to/ProxmoxMCP/proxmox-config/config.json",
                "PROXMOX_TOKEN_NAME": "token-name",
                "PROXMOX_VERIFY_SSL": "false",
                "PROXMOX_TOKEN_VALUE": "token-value"
            },
            "args": [
                "-m",
                "proxmox_mcp.server"
            ],
            "command": "/absolute/path/to/ProxmoxMCP/.venv/bin/python"
        }
    }
}

Linux

{
    "cwd": "/absolute/path/to/ProxmoxMCP",
    "env": {
        "LOG_LEVEL": "DEBUG",
        "PYTHONPATH": "/absolute/path/to/ProxmoxMCP/src",
        "PROXMOX_HOST": "your-proxmox-host",
        "PROXMOX_PORT": "8006",
        "PROXMOX_USER": "username@pve",
        "PROXMOX_SERVICE": "PVE",
        "PROXMOX_MCP_CONFIG": "/absolute/path/to/ProxmoxMCP/proxmox-config/config.json",
        "PROXMOX_TOKEN_NAME": "token-name",
        "PROXMOX_VERIFY_SSL": "false",
        "PROXMOX_TOKEN_VALUE": "token-value"
    },
    "args": [
        "-m",
        "proxmox_mcp.server"
    ],
    "command": "/absolute/path/to/ProxmoxMCP/.venv/bin/python"
}

Macos

{
    "cwd": "/absolute/path/to/ProxmoxMCP",
    "env": {
        "LOG_LEVEL": "DEBUG",
        "PYTHONPATH": "/absolute/path/to/ProxmoxMCP/src",
        "PROXMOX_HOST": "your-proxmox-host",
        "PROXMOX_PORT": "8006",
        "PROXMOX_USER": "username@pve",
        "PROXMOX_SERVICE": "PVE",
        "PROXMOX_MCP_CONFIG": "/absolute/path/to/ProxmoxMCP/proxmox-config/config.json",
        "PROXMOX_TOKEN_NAME": "token-name",
        "PROXMOX_VERIFY_SSL": "false",
        "PROXMOX_TOKEN_VALUE": "token-value"
    },
    "args": [
        "-m",
        "proxmox_mcp.server"
    ],
    "command": "/absolute/path/to/ProxmoxMCP/.venv/bin/python"
}

Windows

{
    "cwd": "/absolute/path/to/ProxmoxMCP",
    "env": {
        "LOG_LEVEL": "DEBUG",
        "PYTHONPATH": "/absolute/path/to/ProxmoxMCP/src",
        "PROXMOX_HOST": "your-proxmox-host",
        "PROXMOX_PORT": "8006",
        "PROXMOX_USER": "username@pve",
        "PROXMOX_SERVICE": "PVE",
        "PROXMOX_MCP_CONFIG": "/absolute/path/to/ProxmoxMCP/proxmox-config/config.json",
        "PROXMOX_TOKEN_NAME": "token-name",
        "PROXMOX_VERIFY_SSL": "false",
        "PROXMOX_TOKEN_VALUE": "token-value"
    },
    "args": [
        "-m",
        "proxmox_mcp.server"
    ],
    "command": "/absolute/path/to/ProxmoxMCP/.venv/bin/python"
}

🚀 Proxmox Manager - Proxmox MCP Server

ProxmoxMCP

A Python-based Model Context Protocol (MCP) server for interacting with Proxmox hypervisors, providing a clean interface for managing nodes, VMs, and containers.

🏗️ Built With

- Cline - Autonomous coding agent - Go faster with Cline.
- Proxmoxer - Python wrapper for Proxmox API
- MCP SDK - Model Context Protocol SDK
- Pydantic - Data validation using Python type annotations

✨ Features

- 🤖 Full integration with Cline
- 🛠️ Built with the official MCP SDK
- 🔒 Secure token-based authentication with Proxmox
- 🖥️ Tools for managing nodes and VMs
- 💻 VM console command execution
- 📝 Configurable logging system
- ✅ Type-safe implementation with Pydantic
- 🎨 Rich output formatting with customizable themes

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.