Pihole MCP Server

🚀 🍓 Pi-hole MCP サーバー

このサーバーは、Pi-hole の機能をツールとして公開し、AI アシスタントが利用できるようにする Model Context Protocol (MCP) サーバーです。

🚀 クイックスタート

Pi-hole MCP サーバーを使用することで、Pi-hole の機能を AI アシスタントに提供することができます。以下の手順に従ってサーバーをセットアップしてください。

✨ 主な機能

• Pi-hole の機能を AI アシスタントが利用できるツールとして公開します。
• 複数の Pi-hole を管理することができます。

📦 インストール

依存関係

Docker

• Docker インストールガイド

uv（開発用、オプション）

ローカルでアプリケーションを実行する場合は、uv を使用します。パッケージマネージャーを通じてインストールしてください。

環境設定

プロジェクトのルートディレクトリに .env ファイルを作成し、Pi-hole の認証情報を記述します。

# メインの Pi-hole（必須）
PIHOLE_URL=https://your-pihole.local/
PIHOLE_PASSWORD=your-admin-password
#PIHOLE_NAME=Primary        # オプション、未設定の場合は URL がデフォルト

# サブの Pi-hole（オプション）
#PIHOLE2_URL=https://secondary-pihole.local/
#PIHOLE2_PASSWORD=password2
#PIHOLE2_NAME=Secondary     # オプション

# 最大 4 つの Pi-hole：
#PIHOLE3_URL=...
#PIHOLE3_PASSWORD=...
#PIHOLE3_NAME=...

#PIHOLE4_URL=...
#PIHOLE4_PASSWORD=...
#PIHOLE4_NAME=...

プロジェクト構造

• src/：プロジェクトのソースコードファイルが含まれています。
• public/：ビルド後の静的リソース（HTML、CSS、JavaScript ファイルなど）が含まれています。

サーバーの実行方法

Docker を使用して実行

1. Docker がインストールされ、実行中であることを確認してください。
2. プロジェクトのルートディレクトリに .env ファイルを作成し、Pi-hole の認証情報を設定してください。
3. 以下のコマンドを実行してコンテナをビルドし、実行します。

docker-compose up --build

Node.js を使用して実行

1. Node.js と npm がインストールされていることを確認してください。
2. プロジェクトの依存関係をインストールします。

npm install

3. サーバーを起動します。

npm start

📚 ドキュメント

API ドキュメント

リソース

• /api/pi-holes：すべての Pi-hole の情報を取得します。
  • メソッド：GET
  • レスポンス：すべての Pi-hole の詳細情報（URL や状態を含む）が含まれます。

ツール

• /api/tools：利用可能なすべてのツールのリストを取得します。
  • メソッド：GET
  • レスポンス：ツールの名前と説明が含まれます。

💻 使用例

すべての Pi-hole の情報を取得する

curl http://localhost:3000/api/pi-holes

ツールを呼び出す

check-dns-records というツールを呼び出す例です。

curl -X POST http://localhost:3000/api/tools/check-dns-records \
  -H "Content-Type: application/json" \
  -d '{"piHoleUrl": "https://your-pihole.local/"}'

📄 ライセンス

MIT