Aapanel

🚀 aaPanel MCP 接口

aaPanel MCP 接口提供了豐富的功能，可用於獲取面板系統信息、管理網站、數據庫、Docker 容器和鏡像，以及進行電子郵件管理等，能有效提升面板操作的便捷性和效率。

✨ 主要特性

• 系統與網絡信息獲取：獲取面板系統信息和網絡狀態。
• 網站管理：查詢 PHP 網站列表，並可創建新的 PHP 網站。
• 數據庫管理：查詢 MySQL 數據庫列表。
• Docker 管理：
  • 容器管理：查看容器列表及詳細信息。
  • 鏡像管理：查看本地鏡像列表。
• 電子郵件管理：可添加電子郵件賬戶並查看電子郵件列表。
• 配置信息獲取：獲取面板公共配置信息。
• 功能持續更新：更多功能正在開發中...

📦 安裝指南

從源代碼安裝

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

# 安裝依賴項
go mod tidy

# 構建項目
make build

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

直接下載

您也可以從發佈頁面下載預編譯的二進制文件。

📚 詳細文檔

先決條件

• Go 1.18+ 版本
• aaPanel API 訪問權限
• aaPanel API 令牌

配置指南

環境變量配置

通過環境變量配置程序：

# 設置 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

# 清理構建 artifact
make clean

# 查看更多命令
make help

📄 許可證

該項目 licensed under the MIT License。有關詳細信息，請參閱 LICENSE 文件。

🤝 貢獻指南

歡迎提交問題和功能請求！如果您希望貢獻代碼：

1. 叉取此倉庫
2. 創建或修改功能分支 ( git checkout -b feature/amazing-feature )
3. 提交更改 ( git commit -m 'Add some amazing feature' )
4. 推送到分支 ( git push origin feature/amazing-feature )
5. 提交 Pull Request