VRChat MCP Server

日本語|韓国語

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

概要

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

Related MCP server: VRChat MCP OSC

使用法

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

export VRCHAT_USERNAME=your_username
export VRCHAT_AUTH_TOKEN=your_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コマンドのフルパスを指定する必要があるかもしれません。

利用可能なツール

このモデルコンテキストプロトコルサーバーは、次の 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"

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

起動すると、ブラウザでアクセスしてデバッグを開始できる URL がインスペクタに表示されます。

出版

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

1. メインブランチから最新のコードを取得する

   git checkout main
   git pull origin main

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

   npm run build

3. npmに公開する

   npm publish

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

   git push origin main --tags

貢献

貢献を歓迎します！改善やバグ修正が必要な場合は、リポジトリをフォークしてプルリクエストを送信してください。

ライセンス

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