- Home
- MCP servers
- Proxmox
Proxmox
- javascript
0
GitHub Stars
javascript
Language
6 months ago
First Indexed
3 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"ruashots-proxmox-mcp": {
"command": "node",
"args": [
"/home/YOUR_USER/.local/share/proxmox-mcp/dist/index.js"
],
"env": {
"PROXMOX_HOST": "https://192.168.1.100:8006",
"PROXMOX_TOKEN_ID": "root@pam!claude",
"PROXMOX_TOKEN_SECRET": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}
}
}You run an MCP server to manage Proxmox VE resources through a unified set of tools. This server lets you list and inspect nodes, VMs (QEMU) and LXC containers, storage, and tasks from a single interface, enabling start/stop, snapshots, migrations, and more through your MCP client.
How to use
Use your MCP client to connect to the Proxmox MCP Server and invoke the available tools to manage your Proxmox environment. You can list nodes, check status and versions, manage QEMU VMs and LXC containers, browse storage, and monitor tasks. Typical actions include starting, stopping, rebooting, taking snapshots, cloning, migrating, and rolling back to snapshots. You can perform these actions on individual nodes or on specific resources (VMs, containers, storage). Access is controlled via an API token and a configured host URL so your client can authenticate and execute operations securely.
Examples of practical workflows you can accomplish with the MCP client include:
- List all nodes and their status
- Start or reboot a specific VM or container
- Create or rollback snapshots for VMs or containers
- Migrate a VM or container to another node
- Browse and inspect storage on a node
- View running tasks and their logs for troubleshooting
How to install
Prerequisites before you begin:
- Node.js 18+
- jq (install with
sudo apt install jq) - Proxmox VE 7.0+ with API token
- Quick install (curl script) to set up the MCP server quickly:
curl -fsSL https://raw.githubusercontent.com/Ruashots/proxmox-mcp/master/install.sh | bash
- Manual installation (clone, install dependencies, build):
git clone https://github.com/Ruashots/proxmox-mcp.git ~/.local/share/proxmox-mcp
cd ~/.local/share/proxmox-mcp
npm install && npm run build
- Add your MCP server configuration to your Claude client configuration file. Create or update the following entry to point to your local MCP server runtime:
{
"mcpServers": {
"proxmox_mcp": {
"command": "node",
"args": ["/home/YOUR_USER/.local/share/proxmox-mcp/dist/index.js"],
"env": {
"PROXMOX_HOST": "https://192.168.1.100:8006",
"PROXMOX_TOKEN_ID": "root@pam!claude",
"PROXMOX_TOKEN_SECRET": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}
}
}
Available tools
pve_list_nodes
List all nodes in the Proxmox cluster
pve_get_nodes_status
Get status information for all nodes
pve_get_nodes_version
Get version information for Proxmox nodes
pve_list_nodes_qemu
List all QEMU virtual machines on a node
pve_get_nodes_qemu
Get details for a specific QEMU VM
pve_get_nodes_qemu_config
Retrieve the configuration of a QEMU VM
pve_update_nodes_qemu_config
Update the configuration of a QEMU VM
pve_get_nodes_qemu_status_current
Get the current status of a QEMU VM
pve_create_nodes_qemu_status_start
Start a QEMU VM
pve_create_nodes_qemu_status_stop
Stop a QEMU VM (hard)
pve_create_nodes_qemu_status_shutdown
Shutdown a QEMU VM (graceful)
pve_create_nodes_qemu_status_reboot
Reboot a QEMU VM
pve_create_nodes_qemu_status_suspend
Suspend a QEMU VM
pve_create_nodes_qemu_status_resume
Resume a suspended QEMU VM
pve_list_nodes_qemu_snapshot
List snapshots for QEMU VMs
pve_create_nodes_qemu_snapshot
Create a snapshot for a QEMU VM
pve_get_nodes_qemu_snapshot
Get details of a QEMU VM snapshot
pve_delete_nodes_qemu_snapshot
Delete a QEMU VM snapshot
pve_create_nodes_qemu_snapshot_rollback
Rollback a QEMU VM snapshot
pve_create_nodes_qemu_clone
Clone a QEMU VM
pve_create_nodes_qemu_migrate
Migrate a QEMU VM to another node
pve_list_nodes_lxc
List all LXC containers on a node
pve_get_nodes_lxc
Get details of an LXC container
pve_get_nodes_lxc_config
Get LXC container configuration
pve_update_nodes_lxc_config
Update LXC container configuration
pve_get_nodes_lxc_status_current
Get current status of an LXC container
pve_create_nodes_lxc_status_start
Start an LXC container
pve_create_nodes_lxc_status_stop
Stop an LXC container
pve_create_nodes_lxc_status_shutdown
Shutdown an LXC container
pve_create_nodes_lxc_status_reboot
Reboot an LXC container
pve_create_nodes_lxc_status_suspend
Suspend an LXC container
pve_create_nodes_lxc_status_resume
Resume a suspended LXC container
pve_list_nodes_lxc_snapshot
List snapshots for LXC containers
pve_create_nodes_lxc_snapshot
Create a snapshot for an LXC container
pve_get_nodes_lxc_snapshot
Get details of an LXC container snapshot
pve_delete_nodes_lxc_snapshot
Delete an LXC container snapshot
pve_create_nodes_lxc_snapshot_rollback
Rollback an LXC container snapshot
pve_create_nodes_lxc_clone
Clone an LXC container
pve_create_nodes_lxc_migrate
Migrate an LXC container to another node
pve_list_nodes_storage
List storage on a node
pve_get_nodes_storage_status
Get storage status on a node
pve_list_nodes_storage_content
List storage content on a node
pve_list_nodes_tasks
List running tasks on a node
pve_get_nodes_tasks_status
Get status of a task
pve_get_nodes_tasks_log
Get logs for a task