内容
# 云面板 MCP 服务器
<div align="center">
**50 个工具**,通过任何 AI 管理您的云面板 VPS - Claude, Cursor, OpenCode, Gemini CLI, Kiro, Windsurf, Cline 等。
[](https://www.npmjs.com/package/cloudpanel-mcp)
[](https://hub.docker.com/r/heyyjish/cloudpanel-mcp)
[](https://pypi.org/project/cloudpanel-mcp/)
[](https://github.com/heyjishh/cloudpanel-mcp)
</div>
## 快速开始
```bash
# 1. 为您的 AI 工具安装和配置(选择一个):
npx cloudpanel-mcp install # npm
docker run --rm heyyjish/cloudpanel-mcp:latest install # Docker
pip install cloudpanel-mcp && cloudpanel-mcp install # Python
# 2. 连接到您的服务器(选择一个):
# SSH 密钥: ssh-copy-id root@your-server.com
# 密码: 设置 CP_PASSWORD 环境变量
# 3. 开始使用
# "检查我的服务器上安装了什么"
# "创建一个名为 myapp 的 MySQL 数据库"
# "安装 Docker 并部署我的应用程序"
```
## 50 个工具
| 类别 | 工具 | 您可以使用 |
|---|---|---|
| **云面板** (26) | `cloudpanel_list_sites`, `cloudpanel_create_php_site`, `cloudpanel_create_nodejs_site`, `cloudpanel_create_python_site`, `cloudpanel_create_reverse_proxy_site`, `cloudpanel_create_static_site`, `cloudpanel_delete_site`, `cloudpanel_install_ssl`, `cloudpanel_list_ssl_certificates`, `cloudpanel_create_mysql_database`, `cloudpanel_create_mysql_user`, `cloudpanel_delete_mysql_database`, `cloudpanel_delete_mysql_user`, `cloudpanel_create_postgresql_database`, `cloudpanel_export_database`, `cloudpanel_import_database`, `cloudpanel_system_info`, `cloudpanel_system_update`, `cloudpanel_list_users`, `cloudpanel_create_user`, `cloudpanel_delete_user`, `cloudpanel_enable_2fa`, `cloudpanel_disable_2fa`, `cloudpanel_create_backup`, `cloudpanel_list_backups`, `cloudpanel_delete_backup` | 网站 · SSL · 数据库 · 系统 · 用户 · 备份 |
| **Docker** (10) | `docker_list_containers`, `docker_deploy_compose`, `docker_container_logs`, `docker_stop_container`, `docker_restart_container`, `docker_list_images`, `docker_prune`, `docker_exec`, `docker_load_image`, `docker_login` | 完整的 Docker 管理 · 注册表登录 |
| **服务器安装** (8) | `server_install_docker`, `server_install_postgresql`, `server_install_nodejs`, `server_install_nginx`, `server_install_certbot`, `server_install_redis`, `server_install_mysql`, `server_software_status` | 一键安装,带有 `dryRun`, `method`, `version` 标志 |
| **防火墙和 DNS** (3) | `server_firewall_status`, `server_firewall_allow_port`, `server_dns_check` | 安全 · 网络 |
| **部署** (1) | `deploy_project` | 一键全栈部署,带有 `method` 标志:`docker`, `cloudpanel-reverse-proxy`, `cloudpanel-nodejs` |
| **逃生舱** (1) | `cloudpanel_raw_command` | 运行任何 shell 命令 |
## 安装
### 自动安装(所有平台)
```bash
npx cloudpanel-mcp install
```
扫描您的机器并配置它找到的每个 AI 工具。
### 手动安装(每个平台)
#### npm
```json
{
"mcpServers": {
"cloudpanel": {
"command": "npx",
"args": ["-y", "cloudpanel-mcp"],
"env": {
"CP_USER": "root",
"CP_SSH_KEY": "/home/you/.ssh/id_ed25519",
"CP_HOST": "your-server.com"
}
}
}
}
```
#### Docker
```json
{
"mcpServers": {
"cloudpanel": {
"command": "docker",
"args": ["run", "--rm", "-i", "-v", "/home/you/.ssh:/root/.ssh", "-e", "CP_HOST", "-e", "CP_USER", "-e", "CP_SSH_KEY", "heyyjish/cloudpanel-mcp:latest"],
"env": {
"CP_USER": "root",
"CP_SSH_KEY": "/home/you/.ssh/id_ed25519",
"CP_HOST": "your-server.com"
}
}
}
}
```
#### pip
```json
{
"mcpServers": {
"cloudpanel": {
"command": "cloudpanel-mcp",
"args": [],
"env": {
"CP_USER": "root",
"CP_SSH_KEY": "/home/you/.ssh/id_ed25519",
"CP_HOST": "your-server.com"
}
}
}
}
```
### 支持的平台
| 工具 | 配置路径 | 范围 |
|---|---|---|
| **OpenCode** | `~/.config/opencode/opencode.jsonc` | 全局 |
| **Claude Desktop** | `claude_desktop_config.json` | 全局 |
| **Claude Code** | `~/.claude/settings.json` | 全局 |
| **Claude Code (本地)** | `.claude/settings.local.json` | 本地 |
| **Cursor** | `~/.cursor/mcp.json` | 全局 |
| **Windsurf** | `~/.codeium/windsurf/mcp_config.json` | 全局 |
| **Cline** | `~/.config/cline/mcp_settings.json` | 全局 |
| **Gemini CLI** | `~/.config/gemini/config.json` | 全局 |
| **Kiro** | `~/.config/kiro/config.json` | 全局 |
| **Continue (VS Code)** | `~/.continue/config.json` | 全局 |
| **VS Code MCP** | `.vscode/mcp.json` | 本地 |
| **Codex CLI** | `~/.codex/config.json` | 全局 |
| **Roo Code** | `~/.config/roo-code/mcp_settings.json` 或 `.roo/mcp.json` | 两个 |
| **Aider** | `~/.aider.mcp.json` 或 `.aider.mcp.json` | 两个 |
| **Cherry Studio** | `~/.config/cherry-studio/mcp.json` | 全局 |
| **Enchanted (macOS)** | `~/Library/Application Support/com.enchant.MCP/config.json` | 全局 |
| **JetBrains MCP** | `.idea/mcp.json` 或 `~/.config/JetBrains/mcp.json` | 两个 |
## 环境变量
| 变量 | 默认值 | 描述 |
|---|---|---|
| `CP_HOST` | `your-server.com` | 服务器主机名或 IP |
| `CP_USER` | `root` | SSH 用户 |
| `CP_SSH_KEY` | `~/.ssh/id_ed25519` | SSH 私钥(省略密码身份验证) |
| `CP_PASSWORD` | — | SSH 密码(在未设置密钥时使用) |
| `CP_SSH_PORT` | `22` | SSH 端口 |
## 安装方法
### npm(推荐)
```bash
npx cloudpanel-mcp install
# 或全局安装:
npm install -g cloudpanel-mcp && cloudpanel-mcp install
```
### Docker
```bash
docker run --rm -v ~/.ssh:/root/.ssh heyyjish/cloudpanel-mcp:latest install
# 作为 MCP 服务器运行(适用于支持 Docker 的 MCP 配置):
docker run --rm -i -v ~/.ssh:/root/.ssh \
-e CP_HOST=your-server.com \
heyyjish/cloudpanel-mcp:latest
```
### pip / uv
```bash
pip install cloudpanel-mcp && cloudpanel-mcp install
# 或使用 uv:
uv tool install cloudpanel-mcp && cloudpanel-mcp install
```
## 架构
```
├── src/
│ ├── index.ts # MCP 服务器 — 50 个工具已注册
│ ├── cli.ts # CLI 入口 — 安装,帮助,提供服务
│ └── ssh.ts # 具有自动重新连接的持久 SSH 客户端
├── python/ # Python CLI 包装器(pip/uv)
├── Dockerfile # Docker 镜像
└── build/ # 编译输出
```
服务器建立单个持久的 SSH 连接,具有保持活动和自动重新连接。
没有每个命令的连接开销。
## 部署应用程序
### 一键部署
```bash
# 使用 Docker 部署(如果缺少,则自动安装 Docker)
deploy_project method=docker autoSsl=true frontendDomain=mysite.com
# 在 CloudPanel 反向代理后面部署
deploy_project method=cloudpanel-reverse-proxy autoSsl=true
# 作为 CloudPanel 管理的 Node.js 应用程序部署
deploy_project method=cloudpanel-nodejs
```
### 首先安装先决条件
```bash
# 预览将安装的内容
server_install_docker dryRun=true
# 实际安装
server_install_docker method=official
# 安装 PostgreSQL 16
server_install_postgresql version=16
# 通过 nvm 安装 Node.js 22
server_install_nodejs method=nvm version=--lts
```
## 先决条件
- 运行 [CloudPanel](https://www.cloudpanel.io) (v2+)的 VPS
- 作为 root 的 SSH 访问服务器
- 在运行 MCP 的机器上安装 Node.js 18+
## 许可证
MIT