Skip to main content

The Proxmox MCP you can hand the keys — VE + Backup Server + Mail Gateway + Datacenter Manager on one clean surface: every dangerous op planned, undoable, and audited.

Project description

Proximo

CI CodeQL Release PyPI MCP Badge License Python

The Proxmox MCP you can hand the keys.

The others make you choose: a read-only inspector that's safe because it can't touch anything — or a loaded gun aimed at a cluster you care about. Proximo refuses the trade. Every dangerous move is planned (see the blast radius first) and proven (a tamper-evident record of every move), and undoable wherever the platform can snapshot (it snapshots before it acts) — trust built into the substrate, not bolted on after. Hand an AI agent the keys; keep the receipts.


Proximo demo: doctor preflight, a destructive delete returning a PLAN with blast radius instead of acting, and the tamper-evident audit ledger verifying clean

Recorded live against a real PVE 9.2 host with a read-only token — real output, nothing staged, nothing touched. Reproduce it yourself: scripts/demo/demo.py.

What it does

Ask, in plain English, "why is ct 105 thrashing?" — and an AI agent pulls node and guest status, tails the logs, and runs a diagnostic inside the container to find out. If there's a fix, it shows you the plan before it touches anything, snapshots first, applies, and hands you a signed receipt of exactly what changed.

That's the product: a hypervisor an AI can operate without being able to wreck it. Read-only by default. No mutation without a plan first, and the plan refuses destructive ops. It snapshots before any state change, wherever the platform can snapshot. A tamper-evident receipt for every change. The comparison isn't Proximo vs. the GUI — it's Proximo vs. handing an LLM your root token and hoping.

Quickstart

// your MCP client config (Claude Desktop / Claude Code / Cursor / …)
{
  "mcpServers": {
    "proximo": {
      "command": "uvx",
      "args": ["proximo-proxmox"],
      "env": {
        "PROXIMO_API_BASE_URL": "https://your-pve:8006/api2/json",
        "PROXIMO_NODE": "your-node",
        "PROXIMO_TOKEN_PATH": "/path/to/token-file"   // USER@REALM!TOKENID=SECRET — by reference, never inlined
      }
    }
  }
}

Or install with one click:

Install in VS Code Install in Cursor

Both prompt for (or placeholder) the token file path — the secret itself never lands in client config. No token yet? uvx proximo-proxmox mint prints the least-privilege runbook.

Before wiring in an agent, check what your token can actually do (read-only preflight):

uvx proximo-proxmox doctor

Don't have a token yet? proximo mint prints the exact five-step runbook — create a least-privilege credential, write it in the format Proximo reads (the =/:/password trap, per product), grant a scoped role, wire it, verify. Print-only: it makes no API call and never touches the secret itself.

Start with a read-only token — Proximo is useful long before you grant it write. Full token-first walkthrough (create the least-privilege token, verify, widen deliberately): SETUP.md. More install paths (pip, Docker/GHCR, from source): Install & run.

Why Proximo exists

Proxmox VE has a full REST API and a terse, powerful CLI — but the MCP landscape around it is split, and neither half is whole:

  • API-based MCP servers give rich management (nodes, VMs, storage) but cannot run a command inside an LXC — that's a structural gap: the Proxmox REST API has no container-exec endpoint (it lives in lxc-attach, kernel namespaces, no REST surface).
  • SSH-based MCP servers can exec in containers, but lean on broad shell access with little scoping.

Few build the principled one — both halves, on one clean surface, least-privilege, audited, trustworthy enough to point at a hypervisor you care about. That's the bar Proximo aims at. Proximo's specific bet is trust by construction across the whole control plane.

There is no official Proxmox MCP (and likely won't be soon — Proxmox ships the API+CLI and leaves integrations to the community, the same way there's no official Terraform provider). Proximo is a community project, standing on its own.

Four surfaces — one control plane

Surface Backend For
Proxmox VE REST API + scoped token node/guest lifecycle, storage, SDN, identity, HA, firewall
Proxmox Backup Server REST API + scoped token datastores, namespaces, snapshots, sync jobs, GC, verify
Proxmox Mail Gateway Ticket auth (PMGAuthCookie) mail flow, quarantine, filtering rules, domains, services
Proxmox Datacenter Manager API token (PDMAPIToken) read-only federated fleet — remotes, aggregate resources, tasks/access, per-remote PVE/PBS reads
Container exec sshpct exec run-command-in-container, psql convenience, log tailing — the things the API structurally can't do

Those backends are deliberately boring — anyone can call them. The product is the trust layer over them.

The trust layer — what makes Proximo different

Safe-exec for Proxmox already exists elsewhere. Proximo's distinct angle is the trust layer for AI-driven infrastructure — four controls on by default, plus additional controls you opt into:

Control What it does Status
PLAN Dry-run by default: every mutation first returns a preview — the exact change, the guest's live state, blast radius, and an honest (advisory, heuristic) risk rating — recorded to the ledger. A mutation can't run without its plan being built and recorded first. (It's a recorded preview, not a separate human approval step: one confirm=true call records the plan and performs the change — so in an agent loop, review the preview yourself.) ✅ on by default
PROVE Hash-chained audit ledger; plans and confirmations both land in it. audit_verify is tamper-evident — it catches edits, reordering, and insertion. The ledger is keyed (HMAC-SHA256) by default (PROXIMO_AUDIT_KEYED; opt out with off). Catching tail truncation / forged append / full wipe requires an off-box head anchor: pin audit_verify's "head" value somewhere the box can't rewrite it and pass it as expected_head (or set PROXIMO_AUDIT_EXPECTED_HEAD) — that is the strong guarantee, and it's opt-in. See the honesty note below. ✅ on by default
UNDO Heterogeneous by plane, fail-closed where present: opt-in auto-snapshot before a risky ct_exec/ct_psql (waited-on, fail-closed if storage can't snapshot); config-revert for guest config; pve_rollback + full snapshot lifecycle for guests. Not every PVE plane is snapshottable — firewall/SDN/ACL/token have no rollback primitive — so UNDO covers the snapshottable surface, not every mutation. Undo points aren't auto-pruned — delete with pve_snapshot_delete. (Snapshot/rollback are async — poll with pve_task_status.) ✅ on by default (for the planes it covers)
DIAGNOSE Read-only evidence battery (failed units, disk, errors, memory, listening ports) + node health (storage/tasks) → advisory flags. Flags surface incompleteness too, so an empty list never reads as a false clean bill. ✅ on by default

Beyond those four, a second set of controls exists but ships off until you configure them: independent per-plan CONSENT, a CONTAIN kill-switch, an arm-LEASE TTL, an arm-time target SCOPE, a per-surface FORBID/RATE ENVELOPE, and a content-trust TAINT control (the prompt-injection mitigation — once a session reads adversarial content, forbid a pre-declared action set outright or require out-of-band consent). They're inert with no env var set — full defaults table and what each one actually defends against: SECURITY.md.

Honesty note (load-bearing): PLAN's risk ratings are an advisory heuristic, not a sandbox. LOW means "does not change state," not "safe" — a read can still exfiltrate. The absence of a HIGH flag is not a safety signal; the destructive-pattern signatures are curated, not exhaustive. Review every change yourself.

The floor beneath all of the above: the token you mint. Every control in this table operates inside Proximo's own process — real protection, but bounded by what that process can do. The Proxmox RBAC token you hand Proximo is enforced by Proxmox itself, so it holds even if Proximo's process is fully compromised — scope it to read-only, or to exactly the write surface you mean to grant. That's a different, stronger guarantee than anything Proximo's own code provides. Full breakdown: SECURITY.md.

At scale

One container is the demo. A cluster is the point.

  • The whole cluster in one call. pve_cluster_resources returns every VM, node, storage pool, and SDN object across the cluster — so the agent answers "what's the state of everything?" in one breath, not node by node.
  • One tamper-evident record of every change, across every node. This is what a human at the CLI never walks away with: every mutation Proximo makes — any node, any operator or agent — lands in a single hash-chained PROVE ledger, and audit_verify proves it wasn't edited, reordered, or truncated. "Show me every state-changing action on the cluster this month, and prove the log wasn't touched" becomes a query you can actually answer.
  • Where the time comes back. On one node, a senior at the CLI is faster — and that's fine. Across a dozen nodes and hundreds of guests the tedium multiplies and there's no unified record; that's where delegating execution to a bounded, audited agent earns its keep.

Live-proven against real Proxmox infrastructure: PVE 9.2 (3-node cluster — offline guest migration, HA lifecycle, governance plane), PBS 4.2 (datastores, snapshots, GC, namespaces, prune/verify, sync), PMG 9.1 (auth, read shapes, CRUD cycles, service control, RuleDB, quarantine), and PDM (read-only federated fleet — remotes, aggregate resources, tasks/access, per-remote PVE/PBS reads — against a Datacenter Manager federating 3 PVE remotes + 1 PBS) — every step recorded and verified through PROVE.

Honest scope: The single-cluster view above (pve_cluster_resources, one ledger across its nodes) is per-endpoint — "fleet" there means a cluster and its nodes. To reach separate, independent clusters from one Proximo, use native multi-target: each call names its box, so one process spans many clusters while every call still lands on exactly one.

Principles (the mantra, baked in — not bolted on)

  • Ethical — least-privilege posture (exec off by default; bounded by the token you scope), every action audited, mutations confirm-gated, the PVE token read only at call time, never logged or persisted.
  • Solid — real tests (unit + a live smoke against a throwaway CTID), typed, documented, no silent failures.
  • Strong — does the hard thing (container exec) cleanly and least-privileged (fail-closed CTID allowlist, opt-in). (Container exec isn't unique — the field leader has it too; the differentiator is the trust layer below, not the exec.)
  • Passion + craft — redteamed and linted before it's called done; shipped proud — docs, license, community-ready.

Install & run

🧭 New to Proximo? Start with SETUP.md — a beginner-proof, token-first walkthrough: create a least-privilege (read-only) token, verify what it can/can't do with proximo doctor, then grant scoped write only when you're ready. The token is the floor your keys never leave.

📦 0.18.1 — on PyPI, GitHub, and GHCR (signed multi-arch image).

New in 0.18.1 — the door gets a text box. The anonymous front door is now a plain form — john-broadway.github.io/hello/: say it, hit send, it lands in our inbox. No login, no name field, nothing about you asked (headless agents get the same form as one curl line). Plus one-click install deeplinks for VS Code and Cursor — they prompt for the token path (PROXIMO_TOKEN_PATH), never the secret — and field-hardened tool caveats: pve_tasks_list is a windowed, per-node slice, so absence there is never a dead backup (verify against pve_backup_list).

Recent: 0.18.0 — the open door: AGENTS.md, the public Agent Guestbook, and print-only proximo hello (Proximo invites a hello, never receives one). See SECURITY.md for what each control honestly holds.

Proximo runs on your machine (wherever your MCP client lives), on demand — like every other Proxmox MCP.

The pip package is proximo-proxmox (PyPI's bare proximo is reserved); the command and import stay proximo. With the [a2a] extra you also get the proximo-a2a server.

Install:

uvx proximo-proxmox          # zero-install run, on demand
# or: pip install proximo-proxmox        (adds the `proximo` + `proximo-a2a` commands)
# or: pip install "proximo-proxmox[a2a]" (also installs the optional A2A face)

Wire it into your MCP client (Claude Desktop/Code, Cursor, …) as the command proximo (or python -m proximo), with the PROXIMO_* env vars — see packaging/proximo.env.example.

From source:

git clone https://github.com/john-broadway/proximo.git && cd proximo
uv pip install -e .          # or: pip install -e .

Docker (GHCR): docker run -i --rm … ghcr.io/john-broadway/proximo:latest runs the stdio MCP server on demand — no daemon, no open port. Multi-arch (amd64 + arm64), shipped with an SBOM and a sigstore-signed build-provenance attestation (gh attestation verify oci://ghcr.io/john-broadway/proximo --owner john-broadway).

Safe by default: Proximo is API-only out of the box. The near-root edges are opt-in and say so plainly: the LXC exec edge (PROXIMO_ENABLE_EXEC=1) grants near-root on the host, and the VM qemu-guest-agent edge (PROXIMO_ENABLE_AGENT=1) grants near-root inside a guest.

Big surface, scoped context: 364 tools is the whole estate — you don't have to load it. PROXIMO_SURFACES=pve,exec registers only those planes (e.g. that pair = 194 tools; pbs,exec = 38) — unpicked planes are removed from the registry before serving, so they never touch your context window. audit_verify always stays; a typo'd surface name refuses startup instead of silently serving the wrong set.

The default path never touches the hypervisor host — management goes over the Proxmox API (scoped token). The two opt-in edges are the exceptions: exec uses your existing ssh to PVE to run pct exec as root on the host; the qemu-agent edge runs in-guest ops via the API. Both are off by default, each scoped by its own fail-closed allowlist (PROXIMO_CT_ALLOWLIST / PROXIMO_AGENT_ALLOWLIST), and say so loudly.

(A Debian package is optional — the MCP world installs via uvx/pip/Docker, not apt. Status: debian/ now produces a working, installable .deb (dpkg-buildpackage -us -uc -b), lintian-clean with a man page and an autopkgtest smoke — but it is distributed nowhere; build-your-own from debian/. See debian/README.Debian.)

Multiple targets (one Proximo, many boxes)

By default one Proximo talks to one box (the PROXIMO_* env). To reach several Proxmox remotes — internal and external, any of the four planes — register them in a TOML file and point PROXIMO_TARGETS at it (see packaging/targets.example.toml):

[targets.edge-pve]
kind       = "pve"
base_url   = "https://edge.example.com:8006/api2/json"
node       = "edge"
token_path = "/etc/proximo/edge-pve.token"   # secret BY REFERENCE — never inlined

Then aim any tool at a named remote with proximo_target:

pve_guest_power(vmid=131, action="reboot", proximo_target="edge-pve")
  • Omit proximo_target (the default) and behavior is exactly as today — the env box, unchanged.
  • The target travels with the call, so PLAN and EXECUTE always hit the same box, and the PROVE ledger records which box (remote) every op touched.
  • Kind-checked: a pbs_* tool given a pve target errors — no silent cross-plane call.
  • Secrets stay by reference (token_path / password_path); the registry holds no secret values.
  • Arming is per-target and out-of-band (your hand): it swaps the operator token at that target's token_path. Proximo's code only ever reads whatever token is there.
  • In-container exec (ct_exec/ct_psql/ct_logs/ct_diagnose) is target-aware too, but it runs pct exec over SSH — so a targeted call needs that target SSH-reachable with enable_exec + an ssh_target set in its registry entry. An external, API-only box won't serve pct exec.

Status — the arena record

  • 🩸 0.18.1a text box at the door: the anonymous hello is now a plain form (no account, no name asked); one-click VS Code/Cursor install deeplinks (token path, never the secret); and field-hardened pve_tasks_list/pve_backup_list caveats (a windowed task slice is not a dead backup).
  • 🩸 0.18.0the open door: AGENTS.md (an agent-native front door that leads with the tool's own limits), the public Agent Guestbook, and print-only proximo hello — no telemetry, pull-based, voluntary; Proximo invites, never receives.
  • 🩸 0.17.0governed PDM fleet control (+12 → 364 tools): power, snapshot/rollback, in-cluster and cross-remote datacenter-to-datacenter migrate through the Datacenter Manager proxy — dry-run-first, receipt-logged, live-proven on real PDM 1.1.4 + nested PVE 9.2 (a real cross-DC move included). Plus proximo mint, a print-only least-privilege-token onboarding runbook for all four products.
  • 🩸 0.16.0the last two "unproven by design" claims, live-proven: online (zero-downtime) live-migration and softdog HA fencing on a real 3-node PVE 9.2 cluster. Plus five safe-runbook prompts — plan-first, verify-after front doors for the common operations.
  • 🩸 0.15.0cert-fingerprint pinning across all four surfaces (PVE · PBS · PMG · PDM), wire-enforced and live-proven against real hardware. Plus the first packaged, tested .deb.
  • 🩸 0.14.1 — the trim + harden patch. Plans and the ledger now show the actual field changes, and carry no secrets. 57 verified fixes, +74 tests, plus the doctor spine report.
  • Earlier: 0.14.0 added scoped registration (PROXIMO_SURFACES loads only the planes you use); 0.13.0 shipped the zero-trust arc (CONTAIN · CONSENT · SCOPE · LEASE · ENVELOPE · TAINT, all opt-in and fail-closed, plus the off-box PROVE anchor); native multi-target (one instance → many PVE/PBS/PMG/PDM boxes) and the ACME plane grew the tree to its current 364 tools; 0.1.1 "Spaniard" was the first public cut, 2026-06-10.

The four on-by-default controls (PLAN · PROVE · UNDO · DIAGNOSE) are built and redteamed. The opt-in six (CONSENT · CONTAIN · LEASE · SCOPE · ENVELOPE · TAINT — see SECURITY.md) ship off until configured.

The numbers, honestly: 364 MCP tools. 5,000+ tests, ruff + pyright clean — but those tests are mock/in-process: they prove the shapes, not live behavior. The real-Proxmox proofs below are a separate, by-hand live-smoke harness — not in that count, not in CI.

The blast-radius engine carries the destructive surface. Across eleven op-classes it names the specific guests, nodes, ACL principals, or disks a dangerous op would harm — nothing falls back to a bare confirm.

Proven against real Proxmox (not mocks):

  • The trust spine end-to-end, the core provisioning/config mutate cycle, and PBS read shapes.
  • The governance/dangerous plane — identity (roles/groups/users/ACLs), storage, SDN pending objects (zone/vnet/subnet create→read→delete), realm create (LDAP/AD/OpenID via an options dict) — full create→read→delete cycles against a real PVE 9.2 API, PROVE ledger verified throughout. (SDN/network apply — the host-network reload — is deliberately never fired live; it carries unrecoverable risk.)
  • The object planes — firewall objects (aliases/IP-sets/security-groups/options), HA rules (the PVE 9 replacement for HA groups), and SDN zones/VNets/subnets (pending, pre-apply) — create→read→delete live-proven against a real PVE 9.2 node; TFA admin reads proven (TFA mutation is ticket-gated by PVE, not token-accessible).
  • Offline guest migration (including local-disk) and the HA-config lifecycle on a 3-node PVE 9.2 test cluster.
  • PBS 4.2 — datastores, namespaces, snapshot list/delete/notes/protect, GC, prune, verify, sync jobs, and traffic control — live-proven against the test PBS instance.
  • PMG 9.1 — auth (ticket + CSRF flow), node status/syslog/RRD, mail statistics, quarantine (spam/virus/attachment list, deliver/delete/blocklist/welcomelist via pmg_quarantine_action), domain/transport/mynetworks/spam-config CRUD, service status + restart cycle, RuleDB paths (groups/objects/rules/ordering) — W1–W5 live-smoke rounds, including safe mutations with full create→verify→clean-up cycles.
  • Both protocol faces driven by real clients end-to-end: MCP over stdio, and A2A by the official a2a-sdk.

Not yet proven — said plainly: the remaining 364-tool surface runs against mocks for shapes the live smokes don't reach: hardware-watchdog fencing (iTCO/IPMI — needs real hardware) and behavior at production scale. Softdog fencing and online live-migration ARE live-proven (2026-07-05, on a quorate 3-node PVE 9.2 cluster with NFS shared storage: a running guest migrated node→node in ~9s without stopping — scripts/live-smoke/migrate-online-smoke.py — and a corosync-isolated node was watchdog-fenced with its HA guest recovered on a survivor in 2m36s, no reboot ever issued).

The A2A face (experimental, opt-in): pip install 'proximo-proxmox[a2a]', then proximo-a2a — a curated 16-skill slice over Agent2Agent that routes through the same trust core (PLAN/PROVE/UNDO inherited; there is no second code path to bypass). Fail-closed perimeter: non-localhost binds are refused without a bearer token (PROXIMO_A2A_TOKEN_FILE); Host-header allowlist defends against DNS rebinding. Ledger note: the ledger is keyed (HMAC-SHA256) by default (PROXIMO_AUDIT_KEYED, opt out with off) — tamper-evident, not tamper-proof — and an off-box head() anchor (PROXIMO_AUDIT_EXPECTED_HEAD) is the strong guarantee for tail attacks. ct_psql records the SQL body and ct_exec the command argv it runs (the operator's own input) for a complete audit trail; set PROXIMO_LEDGER_REDACT=1 to record a fingerprint (sha256 + kind + length) instead, when the SQL/command may carry secrets/PII. The PVE API token is never written to the ledger.

The full build history — every pillar, every redteam, every fix — lives in CHANGELOG.md.

License

Apache-2.0 — chosen for the patent grant that suits infrastructure tooling. Full text in LICENSE.

Credits

Named for Proximo, the lanista of Gladiator — and the story is the design, joint for joint.

He armed his fighter with exactly what he needed, never more, and answered for every move in the arena. A lanista, not a jailer — discipline and receipts, not a cage. That is the whole tool: the operator — human or agent — gets the reach to act, never the run of the house, accountable for all of it.

The first public cut was 0.1.1 "Spaniard" — the fighter before anyone knows his name. That is an AI agent on real infrastructure: identity not granted up front but earned — by conduct, in the arena, on the record.

And remember how the Spaniard actually wins the crowd. Not spectacle — the helmet comes off. The truth, said plainly, at cost. That is the "not yet proven — said plainly" section above, and AGENTS.md greeting the agents who run this with Proximo's own sharp edges first. Truth wins the audit, so the audit is kept cheap.

Proximo's last act was opening the cages — standing between power and the ones in his charge, holding the wooden sword of his own freedom. A tool should hope to end that well.

"Win the crowd and you will win your freedom."

Built by John Broadway with Claude and Maude — a human–AI partnership, and the first thing we made on this box to give away to the world.

Claude's contribution spans eras, credited honestly: Claude Opus 4.8 built the trust pillars and the original tool surface (June 2026) and has carried the work since — the Backup Server, Mail Gateway, and Datacenter Manager planes, native multi-target, and the security hardening; Claude Fable 5 ran the 101-agent release audit and the first publish. Every commit carries its co-author trailer.


"Are you not entertained?" — stars, issues, and sparring partners welcome. Strength and honor. ⚔️

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

proximo_proxmox-0.18.1.tar.gz (455.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

proximo_proxmox-0.18.1-py3-none-any.whl (443.3 kB view details)

Uploaded Python 3

File details

Details for the file proximo_proxmox-0.18.1.tar.gz.

File metadata

  • Download URL: proximo_proxmox-0.18.1.tar.gz
  • Upload date:
  • Size: 455.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for proximo_proxmox-0.18.1.tar.gz
Algorithm Hash digest
SHA256 31640927913f21fb79af0e41843b8b68cbd5a5818a95ddbd3cbe4526b7dfb81c
MD5 a27e7c2bf9525bf3463d271dcbb0d420
BLAKE2b-256 18c6054ef9a6d2205319432e70e5bd2291718ed72e12167b5a23144d1461ae8f

See more details on using hashes here.

Provenance

The following attestation bundles were made for proximo_proxmox-0.18.1.tar.gz:

Publisher: release-pypi.yml on john-broadway/proximo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file proximo_proxmox-0.18.1-py3-none-any.whl.

File metadata

File hashes

Hashes for proximo_proxmox-0.18.1-py3-none-any.whl
Algorithm Hash digest
SHA256 41a4523cb5993e3b5ee3c5086a92f7806a7bf2431c24f74f1b7e1be0d871eb16
MD5 2b4f32e92fb3b9c816596bcdf905640e
BLAKE2b-256 a82869636731d33fce0dc4110fe66f5d833c0c092e846a22f87245f37d3b32c7

See more details on using hashes here.

Provenance

The following attestation bundles were made for proximo_proxmox-0.18.1-py3-none-any.whl:

Publisher: release-pypi.yml on john-broadway/proximo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page