内容
# Pelican MCP
一款用于管理 [Pelican 面板](https://pelican.dev) 游戏服务器的 MCP 服务器。让 Claude 可以启动/停止服务器、管理文件、创建备份、运行控制台命令以及执行管理员操作 — 所有操作都通过自然语言进行。
## 安装
### 通过 npx（推荐）
无需安装。添加到您的 Claude Desktop 配置中：
```json
{
"mcpServers": {
"pelican": {
"command": "npx",
"args": ["-y", "pelican-mcp"],
"env": {
"PELICAN_URL": "https://您的面板.example.com",
"PELICAN_API_KEY": "pacc_..."
}
}
}
}
```
### 从源代码（需要 [Bun](https://bun.sh)）
```bash
git clone https://github.com/AJXD2/pelican-mcp
cd pelican-mcp
bun install
```
然后添加到您的 Claude Desktop 配置中：
```json
{
"mcpServers": {
"pelican": {
"command": "bun",
"args": ["run", "/path/to/pelican-mcp/src/index.ts"],
"env": {
"PELICAN_URL": "https://您的面板.example.com",
"PELICAN_API_KEY": "pacc_..."
}
}
}
}
```
## 配置
| 变量 | 描述 |
|---|---|
| `PELICAN_URL` | 您的 Pelican 面板实例的基本 URL |
| `PELICAN_API_KEY` | 从帐户 → API 凭证中获取的 API 密钥 |
对于管理员工具（`admin_*`，数据库，插件管理），请使用在面板的管理区域生成的**应用程序 API**密钥。
## 工具
### 服务器控制
| 工具 | 描述 |
|---|---|
| `list_servers` | 列出所有可访问的服务器 |
| `get_server` | 获取服务器详细信息 |
| `get_resource_usage` | CPU、内存、磁盘、网络统计 |
| `start_server` | 启动服务器 |
| `stop_server` | 正常停止服务器 |
| `restart_server` | 重启服务器 |
| `kill_server` | 强制终止服务器 |
### 文件管理
| 工具 | 描述 |
|---|---|
| `list_files` | 列出路径下的文件 |
| `read_file` | 读取文件内容 |
| `write_file` | 写入/覆盖文件 |
| `delete_files` | 删除文件或目录 |
| `rename_file` | 重命名或移动文件 |
### 备份
| 工具 | 描述 |
|---|---|
| `list_backups` | 列出服务器备份 |
| `create_backup` | 创建新的备份 |
| `delete_backup` | 删除备份 |
### 控制台
| 工具 | 描述 |
|---|---|
| `send_command` | 向正在运行的服务器发送控制台命令 |
### 管理员（需要应用程序 API 密钥）
| 工具 | 描述 |
|---|---|
| `admin_list_servers` | 列出面板上的所有服务器 |
| `admin_list_nodes` | 列出所有节点 |
| `admin_list_users` | 列出所有用户 |
| `admin_create_server` | 创建新的服务器 |
| `admin_update_server` | 更新服务器名称/所有者/描述 |
| `admin_suspend_server` | 暂停服务器 |
| `admin_unsuspend_server` | 恢复服务器 |
| `admin_reinstall_server` | 重新安装服务器 |
| `admin_delete_server` | 删除服务器 |
### 数据库（需要应用程序 API 密钥）
| 工具 | 描述 |
|---|---|
| `list_server_databases` | 列出服务器的数据库 |
| `create_server_database` | 创建数据库 |
| `delete_server_database` | 删除数据库 |
### 插件（需要应用程序 API 密钥）
| 工具 | 描述 |
|---|---|
| `list_plugins` | 列出所有面板插件 |
| `install_plugin` | 安装插件 |
| `update_plugin` | 更新插件 |
| `uninstall_plugin` | 卸载插件 |
| `enable_plugin` | 启用插件 |
| `disable_plugin` | 禁用插件 |
