Proxmox MCP is an opinionated MCP server

io.github.sergelogvinov由 GitHub 账号 sergelogvinov 发布v0.3.0更新于 Oct 24, 2026

Proxmox MCP is an opinionated MCP server

概览

AI 生成的概览

只读的 MCP 服务器,把 AI 助手连接到 Proxmox VE API,用于查看集群、节点、虚拟机、容器、存储和任务事件。

可以做什么
  • 列出并查看已配置的 Proxmox 集群,包括版本、节点、节点状态和总资源
  • 列出并查看节点状态、资源占用、运行时间、内核和启动信息
  • 列出并查看 QEMU 虚拟机和 LXC 容器,包括客户机或运行时的网络接口
  • 列出并查看存储资源的状态、类型、内容和容量占用
  • 列出所有节点上最近的 Proxmox 任务事件
  • 在启用破坏性工具后,可发起虚拟机与容器的异步备份并返回任务标识
适用场景
适合让助手代为收集和汇总 Proxmox 集群状态,而不必在 Proxmox 界面里翻页或执行多条命令,例如检查资源占用、查看近期任务,或在改动基础设施前收集信息。它补充而非替代 Terraform、Ansible 或 GitOps 等工具。
运行要求
需要本地二进制或容器镜像(Homebrew tap 或 ghcr.io 镜像),以 stdio 方式运行,或使用内置 HTTP 服务器模式。需要一个 YAML 集群配置文件,通过 --config 或 CONFIG_FILE 指定,其中每个集群包含 region、API 地址,以及 Proxmox API 令牌或用户名加密码,可选 CA 证书文件。需要能访问 Proxmox API 的网络。
安装前请注意
配置文件包含 Proxmox 凭据:token_secret、password 或密钥文件路径,建议使用文件类字段以免密钥写入 YAML。Proxmox 账号应只授予工具所需的权限。insecure 选项会跳过 TLS 证书校验,仅限本地测试。HTTP 端点本身不提供用户认证,依赖 Proxmox 令牌;通过 Authorization 头传入的令牌会覆盖配置中的凭据。启用 --allow-destructive 会增加备份操作,会真正启动任务。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Proxmox MCP is an opinionated MCP server,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

Proxmox MCP Server

NOTE: This project is under active development.

Motivation

Modern infrastructure often uses tools such as Terraform/OpenTofu, Ansible, and GitOps. These tools deploy and configure Proxmox infrastructure and Kubernetes clusters.

The Proxmox MCP Server does not replace these tools. It gives AI assistants and automation agents access to information about your Proxmox clusters.

The default tools are read-only. Optional action tools can be enabled with --allow-destructive for operations such as backups and reboots.

Instead of checking many pages in the Proxmox UI or running several commands, you can ask an AI assistant to collect and analyze the required information. Your existing automation tools remain the main source for infrastructure changes.

Overview

The server connects an MCP client, such as an AI assistant, to the Proxmox VE API. It supports multiple Proxmox clusters and returns structured data.

You can use it to:

  • inspect clusters, nodes, and storage
  • check resource usage and node status
  • review recent Proxmox task events
  • find differences and possible configuration problems
  • collect information before you make infrastructure changes

Keep your AI on the leash.

Proxmox core tools

The MCP server provides the following read-only tools:

ToolArgumentsDescription
proxmox_clusters_listNoneList the configured Proxmox clusters.
proxmox_clusters_describeclusterShow a cluster's version, nodes, node statuses, and total resources.
proxmox_containers_listclusterList LXC containers with their status and resource usage.
proxmox_containers_describecluster, vmid, node (optional)Show an LXC container's current status and runtime network interfaces when it is running.
proxmox_events_listcluster, limit (optional)List recent task events across all nodes. The default limit is 10.
proxmox_nodes_listclusterList nodes with their status and resource usage.
proxmox_nodes_describecluster, nodeShow a node's status, resources, uptime, version, kernel, and boot information.
proxmox_storage_listclusterList storage resources with their status, type, content, and capacity usage.
proxmox_storage_describecluster, name, node (optional)Show storage details and, when a node is provided, content visible on that node.
proxmox_vms_listclusterList QEMU virtual machines with their status and resource usage.
proxmox_vms_describecluster, vmid, node (optional)Show a QEMU virtual machine's current status and guest network interfaces when its QEMU guest agent is responding.

Use proxmox_clusters_list first to find the cluster names used by the other tools. MCP clients can discover the full input and output schemas. You can also list the tools from the command line:

sh
proxmox-mcp tools --config /absolute/path/to/cluster-config.yaml

When --allow-destructive is enabled, proxmox_vms_backup and proxmox_containers_backup accept cluster, vmid, optional node, storage, mode, and compress arguments. They start an asynchronous backup and return its Proxmox task identifier; task creation does not mean that the backup has already completed successfully.

Installation

For a local installation with Homebrew, run:

sh
brew install sergelogvinov/tap/proxmox-mcp

You do not need a local installation when you use an MCP server hosted on another machine.

Configure Proxmox clusters

Create a YAML file that contains one or more Proxmox clusters:

yaml
clusters:  - region: homelab    url: https://pve.example.com:8006/api2/json    token_id: mcp@pve!reader    token_secret_file: /absolute/path/to/token-secret    ca_file: /absolute/path/to/proxmox-ca.crt

Each cluster supports these fields:

FieldRequiredDescription
regionYesUnique name used to select the cluster in tool calls.
urlYesFull Proxmox API URL, including /api2/json.
token_idFor token loginProxmox API token ID, for example mcp@pve!reader.
token_id_fileFor token loginFile that contains the token ID. Use this instead of token_id.
token_secretFor token loginProxmox API token secret.
token_secret_fileFor token loginFile that contains the token secret. Use this instead of token_secret.
usernameFor password loginProxmox user name. Must be used with password.
passwordFor password loginProxmox password. Must be used with username.
ca_fileNoPath to the CA certificate used to check the Proxmox TLS certificate.
insecureNoSkip TLS certificate checks. Use only for local testing. Default: false.

Use either token login or password login for a cluster, not both. Files are recommended for secrets because they keep secret values out of the YAML file. The Proxmox account should have only the permissions required by the tools.

Set the configuration path with --config or CONFIG_FILE.

Configure an MCP client

Local stdio server

For clients that use a JSON MCP configuration, add an entry like this:

json
{  "mcpServers": {    "proxmox": {      "command": "proxmox-mcp",      "args": ["mcp"],      "env": {        "CONFIG_FILE": "/absolute/path/to/cluster-config.yaml"      }    }  }}

Remote HTTP server

Start the streamable HTTP server with:

sh
proxmox-mcp server \  --config /absolute/path/to/cluster-config.yaml \  --listen-address :8080

:8080 accepts connections on every IPv4 and IPv6 address. To listen on one address, give it with the port, for example 127.0.0.1:8080 or [::1]:8080. The MCP endpoint is http://host:8080/mcp

For a remote client, use an HTTPS URL that ends with /mcp:

json
{  "mcpServers": {    "proxmox": {      "type": "http",      "url": "https://proxmox-mcp.example.com/mcp",      "headers": {        "Authorization": "Bearer PVEAPIToken=mcp@pve!reader=TOKEN_SECRET"      }    }  }}

The server does not provide user authentication for the HTTP endpoint. It relies on Proxmox authentication and API tokens for access control. Provide the token in mcp header like:

text
Authorization: PVEAPIToken=mcp@pve!reader=TOKEN_SECRET

When this header is present, its token is used for the tool call instead of the credentials from the cluster configuration. The configured cluster must still include region and url.

Restart or reload the MCP client after you save its configuration.

Running

Common flags

The mcp, server, and tools commands use the following flags. Each flag can also be set with an environment variable. A command-line flag has higher priority than an environment variable.

FlagEnvironment variableDefaultDescription
--config <path>CONFIG_FILENonePath to the required clusters YAML configuration file.
--extensions <list>EXTENSIONSallComma-separated list of extensions to enable, or all.
--allow-destructiveALLOW_DESTRUCTIVEfalseAllow destructive tools when they are available. Current core tools are read-only.
--log-level <level>LOG_LEVELinfoLog level: debug, info, warn, or error.
--log-format <format>LOG_FORMATtextLog output format: text or json.

The server command also accepts --listen-address or LISTEN_ADDRESS (host:port). The default is 127.0.0.1:8080, and the container image sets LISTEN_ADDRESS=:8080. The tools command accepts --output (-o) with text, json, or yaml. Its default is text.

For example, run the stdio server with JSON logs:

sh
proxmox-mcp mcp \  --config /absolute/path/to/cluster-config.yaml \  --log-format json

Test the configuration

List all available tools:

sh
export CONFIG_FILE="/absolute/path/to/cluster-config.yaml"proxmox-mcp tools

Call a tool directly:

sh
proxmox-mcp tools proxmox_clusters_listproxmox-mcp tools proxmox_nodes_list cluster=homelabproxmox-mcp tools -o json proxmox_events_list cluster=homelab limit=5

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.


Proxmox® is a registered trademark of Proxmox Server Solutions GmbH.

来源:README.md,提交 689e944

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

2
  1. v0.3.0最新Oct 5, 2026
  2. v0.2.0Sep 22, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分