MCP Browser

🚀 MCP ブラウザ

Model Control Protocol (MCP) のヘッドレスブラウザインターフェースです。

✨ 主な機能

• Playwright を使用したヘッドレスブラウザの自動化
• ブラウザとのインタラクションに使用するウェブ UI の提供
• リアルタイム更新を実現するための WebSocket 通信のサポート
• リアルタイムのブラウザイベントサブスクリプションシステム
• AI エージェント用の MCP の統合

📦 インストール

ワンラインインストール

Mac で1つのコマンドでインストールするには、以下を実行します。

curl -sSL https://raw.githubusercontent.com/neoforge-dev/mcp-browser/main/install_one_line.sh | bash

このコマンドはインストーラーをダウンロードして実行し、一般的な問題を回避します。

手動インストール

手動でインストールするには、以下の手順を実行します。

1. リポジトリをクローンします。
2. インストールスクリプトを実行します。

git clone https://github.com/neoforge-dev/mcp-browser.git
cd mcp-browser
./install.sh

XQuartz の要件

MCP ブラウザは可視化に XQuartz（X11）が必要です。インストーラーは以下のことを行います。

1. XQuartz がインストールされているかを確認し、インストールされていない場合は自動的にインストールします。
2. 複数の方法で X11 サーバーを起動しようとします。
3. 自動的な方法が失敗した場合は、手動での起動を促します。

問題が発生した場合は、XQuartz の問題の解決 のセクションを参照してください。

💻 使用例

ローカル開発

uv を使用したセットアップ

# リポジトリをクローンする
git clone https://github.com/yourusername/mcp-browser.git
cd mcp-browser

# 依存関係をインストールする
uv venv .venv
source .venv/bin/activate
uv pip install -e .

# Playwright ブラウザをインストールする
python -m playwright install

ローカルでの実行

Xvfb を使用しない簡単なテスト：

./simple_test.sh

Xvfb を使用した完全なテスト（X11 が必要）：

./test_local.sh

Docker デプロイ

Docker Compose を使用してビルドして実行する：

# MCP キーを設定する
export MCP_SECRET=your_secret_key

# ビルドして実行する
docker-compose up --build

または、提供されているスクリプトを使用する：

./run.sh

📚 ドキュメント

設定

以下の環境変数を設定できます。

• MCP_SECRET：MCP 認証に使用するキー
• SERVER_PORT：サーバーが実行されるポート（デフォルト：7665）
• PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD：1に設定すると、ブラウザのダウンロードをスキップし、ヘッドレスモードでのみ実行します。

API エンドポイント

• GET /：ウェブ UI
• GET /api/status：ブラウザと MCP クライアントの状態を取得
• WebSocket /ws：リアルタイム通信の WebSocket エンドポイント
• WebSocket /ws/browser/events：ブラウザイベントをサブスクライブするための WebSocket エンドポイント
• GET /api/browser/subscribe：ブラウザイベントをサブスクライブする
• GET /api/browser/unsubscribe：ブラウザイベントのサブスクリプションを解除する
• GET /api/browser/subscriptions：アクティブなイベントサブスクリプションをリストする

イベントサブスクリプション

MCP ブラウザは WebSocket を介したリアルタイムイベントサブスクリプションをサポートしています。これにより、クライアントは以下を含むブラウザイベントをリアルタイムで受け取ることができます。

• ページイベント（ナビゲーション、ロード、エラー）
• DOM イベント（ミューテーション、変更）
• コンソールイベント（ログ、警告、エラー）
• ネットワークイベント（リクエスト、レスポンス、エラー）

WebSocket イベントとイベントサブスクリプションシステムの詳細なドキュメントについては、以下を参照してください。

• WebSocket イベントドキュメント
• イベントサブスクリプションの例

📄 ライセンス

MIT