Vrchat OSC

🚀 VRChat MCP OSC 日本語版

VRChat MCP OSC は、Model Context Protocol (MCP) を介して AI アシスタントと VRChat の間に架ける橋となり、人工知能に基づくアバター制御と仮想現実環境でのインタラクションを実現します。

🚀 クイックスタート

VRChat MCP OSC は、OSC（Open Sound Control）を利用して VRChat と通信します。これにより、Claude などの AI アシスタントは、MCP が提供する高度な API を通じて、アバターのパラメータや表情の制御、VRChat チャットボックスへのメッセージ送信、さまざまな VR イベントへの応答など、様々な機能を実行できます。

✨ 主な機能

• アバター制御：アバターのパラメータと表情を調整します。
• 運動制御：アバターの移動と方向を操作します。
• 通信機能：メッセージを VRChat のチャットボックスに送信します。
• メニューアクセス：VRChat のメニューとインターフェース要素を切り替えます。
• アバター情報：アバターの属性とパラメータを照会します。
• シームレスな統合：アバターの設定を自動検出します。

📦 インストール

システム要件

• Node.js：Node.js v16.0 以上のバージョンをインストールする必要があります。
• VRChat：OSC サポートが有効な VRChat バージョンが必要です。
• Claude：MCP インターフェースをサポートする Claude バージョンを使用する必要があります。

インストール手順

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

# npm リンクを作成する
npm link packages/mcp-server
npm link packages/relay-server

設定ファイルの変更

config.json をプロジェクトのルートディレクトリにコピーし、必要に応じて以下のパラメータを調整します。

{
  "mcpPort": 12345,
  "wsPort": 12346,
  "debugMode": true
}

📚 ドキュメント

コマンドラインオプション

パラメータ説明

• --mcp-port：MCP サーバーのリスニングポート。デフォルト値は 12345 です。
• --ws-port：WebSocket 関連サービスのポート。デフォルトは 12346 です。
• --debug：デバッグモードを有効にし、詳細なログ出力を提供します。

例

MCP サーバーを起動し、カスタムポートを指定する：

node index.js --mcp-port 12345 --ws-port 12346

利用可能なツール

以下は、AI アシスタントが利用できる MCP ツールとその説明です。

トラブルシューティング

一般的な問題

• VRChat に接続できない場合：OSC サポートが有効になっていることを確認し、ターゲットのアドレスとポートが正しいことを確認してください。
• MCP サービスが応答しない場合：Node.js のバージョンが要件を満たしていること、およびすべての依存関係がインストールされていることを確認してください。

プロジェクト構造

vrchat-mcp-osc/
├── packages/
│   ├── mcp-server/    # MCP サーバーの実装（メインエントリー）
│   ├── relay-server/  # WebSocket から OSC への中継
│   ├── types/         # 共有 TypeScript インターフェース
│   └── utils/         # 一般的なユーティリティ関数
└── pnpm-workspace.yaml  # ワークスペース設定

開発ガイド

ソースコードのビルド

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

# 依存関係をインストールする
pnpm install

# すべてのパッケージをビルドする
pnpm -r build

# 開発モードで実行する
pnpm -r dev

📄 ライセンス

VRChat MCP OSC は、二重ライセンス方式を採用しています。

• 非商用利用：MIT ライセンスに基づいてソフトウェアを使用、変更、配布できます。
• 商用利用：商用利用には個別の商用ライセンスが必要です。

非商用利用で MIT ライセンスを使用する場合、そのライセンス条項に従う必要があります。商用ユーザーは、適切な商用ライセンスを取得する必要があります。

謝辞

以下のチームとプロトコルに感謝します。

• OSC 統合を行ってくれた VRChat チーム
• 標準化された AI インターフェースを提供してくれた Model Context Protocol
• Claude の MCP 技術を実装してくれた Anthropic