Aapanel

🚀 aaPanel MCP インターフェース

aaPanel MCP インターフェースは、aaPanelの各種機能をAPI経由で操作するためのものです。システム情報やネットワーク状態の取得、PHPサイトやMySQLデータベースの管理、Dockerコンテナやイメージの操作、メール管理など、多様な機能を提供します。

🚀 クイックスタート

このインターフェースを使用する前に、Go 1.18以上のバージョンが必要で、aaPanel APIのアクセス権限とAPIトークンが必要です。以下の手順でインストールと設定を行ってください。

✨ 主な機能

• パネルのシステム情報とネットワーク状態を取得します。
• PHPウェブサイトのリストを照会します。
• 新しいPHPウェブサイトを作成します。
• MySQLデータベースのリストを照会します。
• Dockerコンテナの管理：
  • コンテナのリストを表示します。
  • コンテナの詳細情報を表示します。
• Dockerイメージの管理：
  • ローカルのイメージリストを表示します。
• 電子メールの管理：
  • 電子メールアカウントを追加します。
  • 電子メールのリストを表示します。
• パネルの公共設定情報を取得します。
• その他の機能は開発中です...

📦 インストール

ソースコードからのインストール

# リポジトリをクローンします
git clone https://github.com/aaPanel/mcp-server.git
cd mcp_btpanel

# 依存関係をインストールします
go mod tidy

# プロジェクトをビルドします
make build

# Windows版をビルドします
.\build.bat build

直接ダウンロード

リリースページから事前にコンパイルされたバイナリファイルをダウンロードすることもできます。

📚 ドキュメント

環境変数の設定

環境変数を使用してプログラムを設定します：

# 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ファイルを参照してください。