{"_id":"@amailath/proxmox-mcp-server","_rev":"2-676acbacfdbf0f01d552f4b94b5fc476","name":"@amailath/proxmox-mcp-server","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@amailath/proxmox-mcp-server","version":"1.0.0","keywords":["proxmox","mcp","elysia","bun","typescript","model-context-protocol"],"author":{"name":"Antigravity Studio"},"license":"MIT","_id":"@amailath/proxmox-mcp-server@1.0.0","maintainers":[{"name":"amailath","email":"anbuathypathy+npm@gmail.com"}],"bin":{"proxmox-mcp":"src/index.ts"},"dist":{"shasum":"480dffd29f869d242cfcbdd2b2b9ea05b55ed63a","tarball":"https://registry.npmjs.org/@amailath/proxmox-mcp-server/-/proxmox-mcp-server-1.0.0.tgz","fileCount":30,"integrity":"sha512-aRrzvLI3EIFKo4UrU9cV5oWZhdW2WyFmKYe4YKOI/tftPEQOLI7AotrkwBFripish4YtdEWJTTXvrz6VnIotOg==","signatures":[{"sig":"MEUCIBy8J89w9x1HQ6lx+r9OXoS0ieKw/kKAOJdINTlZHoUhAiEAlTbnZv4VHoLJPUsoxWyeSJ3lEF77nqa+ZoSM9kb+UFs=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":639480},"main":"src/index.ts","type":"module","module":"src/index.ts","gitHead":"9931e3abb347b86656782e1953ba4cb95e704541","scripts":{"dev":"bun --watch src/index.ts","test":"bun test","build":"bun build src/index.ts --outdir dist --target bun","start":"bun run src/index.ts","typecheck":"tsc --noEmit"},"_npmUser":{"name":"amailath","email":"anbuathypathy+npm@gmail.com"},"_npmVersion":"11.18.0","description":"Enterprise-grade Proxmox VE Model Context Protocol (MCP) server in TypeScript, Elysia, and Bun","directories":{},"_nodeVersion":"24.16.0","dependencies":{"zod":"^3.24.2","dotenv":"^16.4.7","elysia":"^1.2.22","@sinclair/typebox":"^0.34.28","@modelcontextprotocol/sdk":"^1.6.1"},"_hasShrinkwrap":false,"devDependencies":{"@types/bun":"^1.2.4","typescript":"^5.7.3"},"_npmOperationalInternal":{"tmp":"tmp/proxmox-mcp-server_1.0.0_1787949561220_0.4461982019078887","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"_id":"@amailath/proxmox-mcp-server@1.0.1","bin":{"proxmox-mcp":"src/index.ts"},"dist":{"shasum":"729dde3cd7973bd43c246fa8f3c47affb1f2b16b","tarball":"https://registry.npmjs.org/@amailath/proxmox-mcp-server/-/proxmox-mcp-server-1.0.1.tgz","fileCount":9,"integrity":"sha512-nWoF5XeRRYMhrFGqujGwCLh6I1JMDZf/gFgY6ZoZv8pnkhtn/mrUvxB4QTZOMJ3IJGEovyYK+5zoNYXo3g5NSA==","signatures":[{"sig":"MEYCIQDXIBDf4GSFqU7y2Uyauu+BqYxs3nvKlBQlEjxVuWVXeAIhAJ8FUc5Lkv9uMHAzP2cSeuqWo8B7TUXURmQHS17bhEZX","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQD4NQXRMLN65yHuIztnp7caXMqIIG+J2yh74E1p7k+vVQIgdiM3XOJZ42fGX090yqUk57McKFZaImvjNoIPkljXw/M="}],"unpackedSize":2327346},"main":"src/index.ts","name":"@amailath/proxmox-mcp-server","type":"module","author":{"name":"Antigravity Studio"},"module":"src/index.ts","gitHead":"9931e3abb347b86656782e1953ba4cb95e704541","license":"MIT","scripts":{"dev":"bun --watch src/index.ts","test":"bun test","build":"bun build src/index.ts --outdir dist --target bun","start":"bun run src/index.ts","typecheck":"tsc --noEmit"},"version":"1.0.1","_npmUser":{"name":"amailath","email":"anbuathypathy+npm@gmail.com"},"keywords":["proxmox","mcp","elysia","bun","typescript","model-context-protocol"],"_npmVersion":"11.18.0","description":"Enterprise-grade Proxmox VE Model Context Protocol (MCP) server in TypeScript, Elysia, and Bun","directories":{},"maintainers":[{"name":"amailath","email":"anbuathypathy+npm@gmail.com"}],"_nodeVersion":"24.16.0","dependencies":{"zod":"^3.24.2","dotenv":"^16.4.7","elysia":"^1.2.22","@sinclair/typebox":"^0.34.28","@modelcontextprotocol/sdk":"^1.6.1"},"_hasShrinkwrap":false,"devDependencies":{"@types/bun":"^1.2.4","typescript":"^5.7.3"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/proxmox-mcp-server_1.0.1_1787950694588_0.12531706785691088"}}},"time":{"created":"2026-08-28T20:39:21.095Z","modified":"2026-08-28T20:58:14.929Z","1.0.0":"2026-08-28T20:39:21.405Z","1.0.1":"2026-08-28T20:58:14.676Z"},"author":{"name":"Antigravity Studio"},"license":"MIT","keywords":["proxmox","mcp","elysia","bun","typescript","model-context-protocol"],"description":"Enterprise-grade Proxmox VE Model Context Protocol (MCP) server in TypeScript, Elysia, and Bun","maintainers":[{"name":"amailath","email":"anbuathypathy+npm@gmail.com"}],"readme":"# Enterprise Proxmox VE Model Context Protocol (MCP) Server\n

\n \"v1.0.0\"\n \"298\n \"MIT\"\n

\nAn enterprise-grade, high-performance **Model Context Protocol (MCP)** server for Proxmox VE, built with **TypeScript**, **Bun**, and the **Elysia framework**.\n\nIt absorbs **all 285 tools** from the reference Python implementation and adds **enhanced guest command execution** capabilities and high-value enterprise management tools (totaling **298 tools**).\n\n---\n\n## šŸ“– Complete Documentation Links\n\n- šŸš€ **[Getting Started & Integration Guide](./docs/GETTING_STARTED.md)** ā€” Step-by-step installation, API Token configuration, Stdio mode setup for Claude Desktop/Cursor, and Elysia SSE server setup.\n- šŸ› ļø **[Complete 298 Tools Reference Guide](./docs/TOOLS_REFERENCE.md)** ā€” Comprehensive reference listing all 298 tools with parameter tables, types, required arguments, and descriptions grouped by domain.\n\n---\n\n\n## āš” Quick Start & Running via MCP Clients\n\n### Running directly (No installation needed)\nYou can run the server directly using `bunx` or `npx` inside your MCP client configuration (such as **Claude Desktop**, **Cursor**, or **VS Code**):\n\n```bash\n# Run with Bun\nbunx -y @amailath/proxmox-mcp-server\n\n# Run with Node / NPX\nnpx -y @amailath/proxmox-mcp-server\n```\n\nInstallation\n```\n# Install globally using Bun\nbun install -g @amailath/proxmox-mcp-server\n\n# Or install locally in a project\nbun add @amailath/proxmox-mcp-server\n\n# Using npm\nnpm install -g @amailath/proxmox-mcp-server\n\n```\n\nāš™ļø MCP Client Configuration\nClaude Desktop Configuration\nAdd the following to your claude_desktop_config.json:\n```json\n{\n \"mcpServers\": {\n \"proxmox\": {\n \"command\": \"bunx\",\n \"args\": [\"-y\", \"@amailath/proxmox-mcp-server@latest\"],\n \"env\": {\n \"PROXMOX_HOST\": \"[https://proxmox.local:8006](https://proxmox.local:8006)\",\n \"PROXMOX_TOKEN_NAME\": \"root@pam!mcp\",\n \"PROXMOX_TOKEN_VALUE\": \"your-api-token-secret\",\n \"PROXMOX_VERIFY_SSL\": \"false\"\n }\n }\n }\n}\n```\n---\n\n## šŸŒŸ Key Features\n\n- **āš” Bun & Elysia Powered**: Ultra-fast execution, native TypeScript support, and low memory consumption.\n- **šŸ› ļø 298 Enterprise MCP Tools**: Full coverage across 11 Proxmox VE domains:\n - `access`: Users, Groups, Roles, Permissions, Tokens, ACLs, TFA, Auth Domains.\n - `backup`: Jobs, schedules, included volumes, and manual backup triggers.\n - `cluster`: Cluster status, resources, tasks, logs, replication, metrics, options.\n - `firewall`: Node/Cluster/VM/LXC firewall rules, aliases, IP sets, security groups.\n - `ha`: High Availability status, manager, resources, groups.\n - `lxc`: Container management, creation, migration, snapshots, firewall, plus `lxc_exec_sync`.\n - `nodes`: Status, config, DNS, network interfaces, storage, services, APT updates, RRD stats, system journal, certificates, task logs, **Physical Disks**, **SMART Health**, **ZFS & LVM Pools**, **PCI & USB Passthrough Discovery**, **Task Cancellation**, **Bulk Operations**.\n - `pools`: Resource pools and ACME (Let's Encrypt) certificates.\n - `qemu`: Virtual machine lifecycle, snapshots, cloud-init, cloning, migration, plus **`vm_agent_exec_sync`** and **Auto Base64 File Read/Write**.\n - `sdn`: Software Defined Networks (VNets, zones, subnets, controllers, IPAM, DNS).\n - `storage`: Storage status, config, content, ISO upload, volume allocation/deletion.\n- **šŸš€ Corrected & Enhanced Guest Command Execution**:\n - **Synchronous Wait (`vm_agent_exec_sync`)**: Automatically polls `exec-status` until command completion, returning stdout, stderr, and exitcode in a single tool call.\n - **Auto Base64 Decoding**: Base64-encoded `out-data` and `err-data` from QEMU guest agent are automatically decoded into clean UTF-8 text strings.\n - **Smart Shell Formatting**: Automatically wraps string commands with shell execution (`/bin/sh -c`) so pipes, redirects, and quotes work out-of-the-box.\n - **LXC Guest Command Execution (`lxc_exec_sync`)**: Brand new execution capability inside LXC containers.\n- **šŸ”’ Enterprise Security & Auth**:\n - Dual Auth: API Tokens (`PROXMOX_TOKEN_NAME` + `PROXMOX_TOKEN_VALUE`) or User Passwords (`PROXMOX_USER` + `PROXMOX_PASSWORD` with automatic ticket renewal).\n - Read-Only Mode (`PROXMOX_READ_ONLY=true`) to prevent write/destructive operations.\n - TLS Verification Control (`PROXMOX_VERIFY_SSL=false` for self-signed certificates).\n- **šŸ“” Dual MCP Transport**:\n - **Stdio Transport**: Integrated for Cursor, Claude Desktop, VS Code, and CLI clients.\n - **Elysia HTTP & SSE Transport**: Real-time Server-Sent Events MCP endpoint at `/sse`, health check at `/health`, and metrics at `/metrics`.\n\n---\nšŸ› ļø Local Development & Contributing\n# Clone the repository\ngit clone [https://github.com/amaialth/ProxmoxMCP.git](https://github.com/amaialth/ProxmoxMCP.git)\ncd ProxmoxMCP\n\n# Install dependencies using Bun\nbun install\n\n# Run unit tests\nbun test\n\n# Type check\nbun run typecheck\n\n# Start Elysia HTTP/SSE server in development mode\nbun dev\n\n# Build production bundle\nbun run build\n\n# Publish updated package to NPM registry\nnpm version patch\nnpm publish --access public\n\n---\n\n\n\n## šŸ“„ License\n\nMIT Ā© Anbumani\n\n\n\n \n\n \n\n\n","readmeFilename":"README.md"}