aaPanel MCP Interface

aaPanel MCP Interface

site icon
2025.03.28 5
Go面板管理自动化工具其它
mcp-server是一个与aaPanel面板交互的接口服务,主要用于管理和操作aaPanel上的各种资源。它提供了丰富的功能,包括获取面板系统信息、管理PHP网站、MySQL数据库、Docker容器和镜像、电子邮件账户等。该服务适合需要自动化管理aaPanel面板的开发者和系统管理员使用。
View on GitHub

Overview

基本能力

产品定位

mcp-server是一个与aaPanel面板交互的接口服务,主要用于管理和操作aaPanel上的各种资源。

核心功能

  • 获取面板系统信息和网络状态
  • 查询和管理PHP网站列表
  • 创建新的PHP网站
  • 查询和管理MySQL数据库列表
  • Docker容器管理(查看容器列表和详情)
  • Docker镜像管理(查看本地镜像列表)
  • 电子邮件管理(添加邮箱账户和查看邮箱列表)
  • 获取面板公共配置信息

适用场景

  • 自动化管理aaPanel面板
  • 批量操作PHP网站和MySQL数据库
  • Docker容器和镜像的集中管理
  • 电子邮件账户的自动化管理

工具列表

  • aaPanel API访问工具:用于与aaPanel面板进行交互
  • Docker管理工具:用于管理Docker容器和镜像
  • 电子邮件管理工具:用于管理电子邮件账户

常见问题解答

  • 需要Go 1.18+环境
  • 需要aaPanel API访问权限和API token

使用教程

使用依赖

  • Go 1.18+
  • aaPanel API访问权限
  • aaPanel API token

安装教程

从源代码安装

# 克隆仓库
git clone https://github.com/aaPanel/mcp-server.git
cd mcp_btpanel

# 安装依赖
go mod tidy

# 构建项目
make build

# 构建Windows版本
.\build.bat build

直接下载

可以从Releases页面下载预编译的二进制文件。

配置

环境变量

# 设置aaPanel地址
export BT_BASE_URL="http://your-panel-address:8888"

# 设置aaPanel API token
export BT_API_TOKEN="your-api-token"

Cursor配置

  1. 打开Cursor设置 > 扩展 > MCP工具
  2. 添加新的MCP工具
  3. 填写配置,格式如下:
{
    "mcpServers": {
        "mcp-aapanel": {
            "command": "C:\\path\\to\\mcp-server.exe",
            "env": {
                "BT_BASE_URL": "http://192.168.xx.xx:8888/",
                "BT_API_TOKEN": "xxxxxxxxxxxxxxxxxxxxxxxx"
            }
        }
    }
}

调试方式

构建完成后,可以直接运行生成的二进制文件,检查日志输出以确认服务是否正常运行。

构建与部署

# 构建项目
make build

# 构建Windows版本
make build-windows

# 清理构建产物
make clean

# 查看更多命令
make help

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。