MCP Server Runner

🚀 MCP サーバーランナー

このアプリケーションは、WebSocket を介して モデルコンテキストプロトコル (MCP) サーバーにアクセスできるようにする WebSocket サーバーの実装です。これにより、Web アプリケーションを含むネットワーククライアントとの統合が可能になります。

🚀 クイックスタート

⚠️ 重要提示

このプロジェクトは現在積極的に開発中であり、WIP（未完成）状態です。機能や API は大幅に変更される可能性があります。

✨ 主な機能

• 単一クライアントをサポートする WebSocket サーバーの実装
• MCP サーバーインスタンスのプロセス管理
• クライアントとサーバー間の双方向メッセージング
• エレガントなシャットダウン処理
• 包括的なエラーロギング
• Unix/Windows プラットフォームの汎用サポート

📦 インストール

前提条件

• Rust 1.70 以上
• MCP サーバーの実装が可能な実行ファイル

設定

環境変数

このアプリケーションは環境変数で設定できます。

PROGRAM=        # MCP サーバーの実行ファイルのパス（必須、設定ファイルが指定されていない場合）
ARGS=           # MCP サーバーに渡す引数
HOST=           # リッスンするホストアドレス、デフォルトは 0.0.0.0
PORT=           # リッスンするポート番号、デフォルトは 3000

設定ファイル

以下のコマンドでデフォルトの設定ファイルを生成できます。

mcp-server-runner init-config > config.yml

使用方法

環境変数での設定例

export PROGRAM=/path/to/mcp-server
export ARGS=--some-argument
export HOST=127.0.0.1
export PORT=8080

サーバーを起動します。

mcp-server-runner start

コマンドラインでの設定例

mcp-server-runner --program /path/to/mcp-server --args --some-argument --host 127.0.0.1 --port 8080 start

📚 ドキュメント

開発状況

• 🚧 開発中：このソフトウェアは現在積極的に開発されています。
• ⚠️ API の安定性：API と機能は予告なく変更される可能性があります。
• 🧪 テスト：現在、テストと最適化が行われています。
• 📝 ドキュメント：ドキュメントは積極的に更新されています。

概要

MCP サーバーランナーは、WebSocket クライアントと MCP サーバーの実装の間の橋渡し役を果たします。

• MCP サーバープロセスを起動します。
• WebSocket 接続を管理します。
• クライアントと MCP サーバー間の双方向通信を処理します。
• エレガントなシャットダウン処理とエラー処理をサポートします。

アーキテクチャ

MCP サーバーランナーは以下の主要なモジュールで構成されています。

• main.rs：プログラムのエントリポイント
• config/：設定関連の実装
• server/：WebSocket サーバーの核心ロジック
• logger/：ログ記録とエラー処理

エラー処理

エラータイプ

• ConfigurationError：設定関連のエラー
• ConnectionError：接続関連のエラー
• ProtocolError：プロトコル関連のエラー

既知の制限事項

• 現在のバージョンは単一クライアント接続のみをサポートしています。
• WebSocket プロトコルの圧縮とプロキシはサポートされていません。
• 完全な MCP プロトコル仕様は実装されていません。

貢献ガイド

貢献の方法

1. リポジトリをクローンする

git clone git@github.com:your-repository.git

2. 機能ブランチを作成する

git checkout -b feature/your-feature-name

3. 変更をコミットする

git commit -m '添加 awesome 機能'

4. リモートリポジトリにプッシュする

git push origin feature/your-feature-name

5. プルリクエストを作成する GitHub Pull Request を通じて変更を提出してください。

📄 ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。詳細は LICENSE ファイルを参照してください。

追加リソース

• モデルコンテキストプロトコル仕様
• WebSocket プロトコル (RFC 6455)