aaPanel MCP接口

功能

• 获取面板系统信息和网络状态
• 查询PHP网站列表
• 创建新的PHP网站
• 查询MySQL数据库列表
• Docker容器管理
  • 查看容器列表
  • 查看容器详情
• Docker镜像管理
  • 查看本地镜像列表
• 邮件管理
  • 添加邮件账户
  • 查看邮件列表
• 获取面板公共配置信息
• 更多功能正在开发中...

要求

• Go 1.18+
• aaPanel API访问权限
• aaPanel API令牌

安装

从源代码安装

# 克隆仓库
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令牌
export BT_API_TOKEN="your-api-token"

Cursor配置

在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"
            }
        }
    }
}

添加新功能

1. 在对应的模块目录下创建或修改文件
2. 定义新的工具常量和工具对象
3. 实现处理器函数
4. 在main.go中的registerTools函数中注册工具

构建与部署

使用Makefile构建：

# 构建项目
make build

# 构建Windows版本
make build-windows

# 清理构建产物
make clean

# 查看更多命令
make help

许可证

本项目采用MIT许可证。详情见LICENSE文件。

贡献

欢迎提交问题和功能请求！如果您想贡献，请遵循以下步骤：

1. 分叉此仓库
2. 创建您的功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m '添加一些精彩的功能'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 打开Pull Request