Vrchat Mcp

日本語 | 한국어

このプロジェクトは、VRChat API と連携するための Model Context Protocol（MCP）サーバーです。標準化されたプロトコルを使用して、VRChat からさまざまな情報を取得できます。

概要

VRChat MCP サーバーを使用すると、VRChat の API エンドポイントに構造化された方法でアクセスできます。ユーザー認証、ユーザーやフレンドの情報の取得、アバターやワールドのデータへのアクセスなど、幅広い機能に対応しています。

使用方法

サーバーを起動する前に、必要な環境変数が設定されていることを確認してください。

export VRCHAT_USERNAME=your_username
export VRCHAT_AUTH_TOKEN=your_auth_token

メモ

AUTH TOKEN の取得方法

次のコマンドを使用してログインし、認証トークンを取得できます。

$ npx vrchat-auth-token-checker

VRChat Username: your-username
Password: ********

# If 2FA is enabled
2FA Code: 123456

# Success output
Auth Token: authcookie-xxxxx

コマンドのソースコード

取得したトークンは有効期間が非常に長いため、慎重に取り扱ってください

続いて、次のコマンドを実行してください。

npx vrchat-mcp

これにより MCP サーバーが起動し、定義されたツールを通じて VRChat API と連携できるようになります。

Claude Desktop での使用方法

この MCP サーバーを Claude Desktop で使用する場合、npx vrchat-mcp を手動で実行する必要はありません。代わりに、以下の設定を Claude Desktop の設定ファイルに追加してください。

• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "vrchat-mcp": {
      "command": "npx",
      "args": ["vrchat-mcp"],
      "env": {
        "VRCHAT_USERNAME": "your-username",
        "VRCHAT_AUTH_TOKEN": "your-auth-token"
      }
    }
  }
}

その後、通常どおり Claude Desktop を起動してください。nodenv または nvm を使用する必要がある場合は、npx コマンドのフルパスを指定する必要があります。

利用可能なツール

この Model Context Protocol サーバーでは、VRChat 関連の以下のツールを利用できます。

ユーザー関連

• vrchat_get_friends_list: フレンドの一覧を取得
• vrchat_send_friend_request: フレンドリクエストを送信

アバター関連

• vrchat_search_avatars: アバターを検索
• vrchat_select_avatar: 特定のアバターを選択して切り替え

ワールド関連

• vrchat_search_worlds: ワールドを検索
• vrchat_list_favorited_worlds: お気に入りのワールド一覧を取得

インスタンス関連

• vrchat_create_instance: 新しいインスタンスを作成
• vrchat_get_instance: 特定のインスタンスの情報を取得

グループ関連

• vrchat_search_groups: グループを検索
• vrchat_join_group: グループに参加

お気に入り関連

• vrchat_list_favorites: お気に入り一覧を取得
• vrchat_add_favorite: 新しいお気に入りを追加
• vrchat_list_favorite_groups: お気に入りグループの一覧を取得

招待関連

• vrchat_list_invite_messages: 招待メッセージの一覧を取得
• vrchat_request_invite: 招待をリクエスト
• vrchat_get_invite_message: 特定の招待メッセージを取得

通知関連

• vrchat_get_notifications: 通知の一覧を取得

デバッグ

まず、プロジェクトをビルドしてください。

npm install
npm run build

MCP サーバーは stdio 経由で動作するため、デバッグが難しい場合があります。最適なデバッグ体験のために、MCP Inspector の使用を強くおすすめします。

次のコマンドを使用すると、npm 経由で MCP Inspector を起動できます。

npx @modelcontextprotocol/inspector "./dist/main.js"

環境変数が正しく設定されていることを確認してください。

起動すると、Inspector に URL が表示されます。その URL にブラウザーからアクセスして、デバッグを開始できます。

公開

パッケージの新しいバージョンを公開するには、次の手順に従ってください。

1. main ブランチから最新のコードをプルします

   git checkout main
   git pull origin main
   

2. パッケージをビルドします

   npm run build
   

3. npm に公開します

   npm publish
   

4. 変更をリモートリポジトリにプッシュします

   git push origin main --tags
   

コントリビューション

コントリビューションを歓迎します！リポジトリをフォークし、改善やバグ修正をプルリクエストとして送信してください。

ライセンス

このプロジェクトは MIT License の下でライセンスされています。詳細については LICENSE ファイルをご覧ください。