Open source MCP Server for Proxmox, powered by NANDI Services.
nandi-proxmox-mcp
Open source MCP Server for Proxmox, powered by NANDI Services.
nandi-proxmox-mcp lets users connect to their own Proxmox server and operate nodes, VMs, and CT/LXC securely via MCP tools in VS Code.
Important: API token ownership
The Proxmox API token is not delivered by npm, VS Code, or this MCP package. Each user must create a token in their own Proxmox environment with minimum ACL permissions.
5-minute Quickstart (Windows)
- Install Node.js 20+.
- Run
npm install -g nandi-proxmox-mcp. - Run
nandi-proxmox-mcp setupand complete guided onboarding. - Run
nandi-proxmox-mcp doctor --check mcp-config,nodes,vms,cts,node-status,remote-op. - Open VS Code and confirm MCP server is registered (
.vscode/mcp.json).
Alternative direct run:
npx nandi-proxmox-mcp setupnpx nandi-proxmox-mcp run
Fastest repeatable setup for an existing Proxmox server:
npx nandi-proxmox-mcp setup `
--proxmox-host `
--proxmox-user `
--token-name <TOKEN_NAME> `
--token-secret "<TOKEN_SECRET>" `
--ssh-key-path "$env:USERPROFILE\\.ssh\\id_ed25519" `
--skip-connectivity
Fast doctor against a real container:
npx nandi-proxmox-mcp doctor `
--check mcp-config,nodes,vms,cts,node-status,remote-op `
--ctid <CTID>
One-command Windows install:
powershell -ExecutionPolicy Bypass -File .\scripts\setup-win.ps1 `
-ProxmoxHost `
-ProxmoxUser `
-TokenName <TOKEN_NAME> `
-TokenSecret "<TOKEN_SECRET>" `
-DoctorCtid <CTID>
VS Code / Codex plug-and-play paths
- Custom server: use
.vscode/mcp.json(rootserversformat). - Manifest install: use
mcp-manifest.json. - User-level config template:
templates/vscode.user.mcp.template.json.
Install from MCP marketplace / plugin marketplace
The npm package is already public, but marketplace discovery has an additional submission process.
- MCP marketplace (
@mcpin VS Code): submit server metadata +mcp-manifest.json+ npm package reference. - Codex/VS Code recommended servers: publish the corresponding Agent Plugin in the configured plugin marketplace.
Submission metadata and assets are prepared in:
marketplace/listing.mdmarketplace/security.mdmarketplace/icon.pngmarketplace/screenshot-setup.pngmarketplace/mcp-registry/server.jsonmarketplace/agent-plugin-marketplace/.github/plugin/marketplace.json
MCP tools included
- Inventory:
listNodes,listVMs,listContainers - Status:
getNodeStatus,getVMStatus,getContainerStatus - Control:
startVM,stopVM,startContainer,stopContainer - CT operations:
execInContainer,dockerPsInContainer,dockerLogsInContainer,runRemoteDiagnostic,sshBatchDiagnostics
Security principles
- No hardcoded host/token secrets in versioned files.
- Local sensitive config generated in
.nandi-proxmox-mcp/config.json. - Templates with placeholders only.
- CI includes secret scanning and dependency scanning.
Docs
- Quickstart
- Windows Installation
- Proxmox Token + ACL Setup
- SSH Setup and Batch Validation
- VS Code MCP Setup
- Marketplace Go-Live
- Release Notes v0.1.4
- Security Guide
- Troubleshooting
- FAQ
- CI Secrets Policy
Development
npm cinpm run lintnpm run typechecknpm testnpm run build
License
MIT. See LICENSE.
Tools (11)
listNodesList all nodes in the Proxmox environmentlistVMsList all virtual machineslistContainersList all LXC containersgetNodeStatusGet status of a specific nodegetVMStatusGet status of a specific virtual machinegetContainerStatusGet status of a specific containerstartVMStart a virtual machinestopVMStop a virtual machinestartContainerStart a containerstopContainerStop a containerexecInContainerExecute a command inside a containerEnvironment Variables
PROXMOX_HOSTrequiredThe URL or IP address of the Proxmox serverPROXMOX_USERrequiredThe Proxmox API userTOKEN_NAMErequiredThe name of the Proxmox API tokenTOKEN_SECRETrequiredThe secret value of the Proxmox API tokenConfiguration
{"mcpServers": {"proxmox": {"command": "npx", "args": ["-y", "nandi-proxmox-mcp", "run"]}}}