关键词

aaPanel服务器管理面板控制网站管理Docker管理

使用说明

项目简介

aaPanel MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端，旨在为 LLM 客户端提供管理 aaPanel 面板的功能。通过标准化的 MCP 协议，LLM 客户端可以安全、可扩展地与 aaPanel 服务器进行交互，实现服务器管理自动化。

主要功能点

  • 系统信息与网络状态查询: 获取 aaPanel 服务器的系统信息和网络状态。
  • 网站管理: 查询 PHP 网站列表、创建新的 PHP 网站。
  • 数据库管理: 查询 MySQL 数据库列表。
  • Docker 管理: 查看 Docker 容器和镜像列表、查看容器详情。
  • 邮件管理: 添加邮件账户、查看邮件列表。
  • 公共配置信息获取: 获取 aaPanel 面板的公共配置信息。

安装步骤

  1. 克隆仓库 
    git clone https://github.com/aaPanel/mcp-server.git
cd mcp-server
  2. 安装依赖 
    go mod tidy
  3. 编译项目 
    make build
    或从 Releases 页面 下载预编译的二进制文件。

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令和环境变量才能连接。以下是 Cursor 客户端的配置示例，其他 MCP 客户端的配置方式类似。

在 Cursor 设置 > Extensions > MCP Tools 中，添加新的 MCP Tool，并填入以下配置信息：

{
    "mcpServers": {
        "mcp-aapanel": {
            "command": "/path/to/mcp-server",  //  请替换为 mcp-server 可执行文件的实际路径
            "env": {
                "BT_BASE_URL": "http://your-panel-address:8888/", //  请替换为你的 aaPanel 面板地址，例如 http://192.168.xx.xx:8888/
                "BT_API_TOKEN": "your-api-token" //  请替换为你的 aaPanel API Token
            }
        }
    }
}

配置参数说明:

  • 'command': 必填。MCP 服务器可执行文件的路径。请根据实际情况修改为 'mcp-server' (Linux/macOS) 或 'mcp-server.exe' (Windows) 的绝对路径。
  • 'env': 必填。环境变量配置。
    • 'BT_BASE_URL': 必填。你的 aaPanel 面板的 URL 地址，包括端口号。例如 'http://192.168.1.100:8888/'。
    • 'BT_API_TOKEN': 必填。你的 aaPanel API Token。你需要在 aaPanel 面板中获取 API Token。

获取 aaPanel API Token 步骤:

  1. 登录 aaPanel 面板。
  2. 点击面板首页的 "安全" 菜单。
  3. 在 "API 密钥" 部分，点击 "生成密钥" 或 "显示密钥" 获取 API Token。

基本使用方法

  1. 启动 MCP 服务器: 在安装目录下运行编译好的 'mcp-server' 可执行文件。

    • Linux/macOS: './mcp-server'
    • Windows: '.\mcp-server.exe' 你可以添加 '-sse' 参数以 SSE 模式启动服务器，例如 './mcp-server -sse'。

  2. 配置 MCP 客户端: 根据 MCP 客户端 (如 Cursor) 的指引，配置上面生成的 JSON 配置信息。确保 'command' 和环境变量配置正确。

  3. 在 MCP 客户端中使用工具: 配置完成后，MCP 客户端应该能够检测到 aaPanel MCP 服务器提供的工具。你可以在客户端中通过自然语言指令或图形界面调用这些工具，例如：

    • "获取网站列表"
    • "创建新网站，域名为 example.com"
    • "查看 Docker 容器列表"

    具体工具的使用方法和参数，请参考各 MCP 客户端的文档。

注意:

  • 确保 aaPanel 面板的 API 功能已启用。
  • 首次使用前，请务必正确配置 'BT_BASE_URL' 和 'BT_API_TOKEN' 环境变量。
  • 如果使用 SSE 模式，请确保 MCP 客户端支持 SSE 协议。

信息

分类

开发者工具

访问项目