Vrchat Mcp

什麼是 VRChat MCP？

VRChat MCP（模型上下文協議）是一個旨在促進與 VRChat API 互動的伺服器。它允許開發者和用戶在 VRChat 環境中創建和管理自定義模型和虛擬形象，提升整體用戶體驗。這個協議作為 VRChat 平台與外部應用之間的橋樑，實現無縫的整合和功能。

VRChat MCP 的特點

• API 整合：VRChat MCP 提供了一個強大的 API，允許開發者訪問和操作 VRChat 數據，包括用戶虛擬形象、世界和互動。
• 自定義模型管理：用戶可以上傳、管理和自定義他們的 3D 模型和虛擬形象，確保在 VRChat 中獲得個性化的體驗。
• 實時互動：該伺服器支持實時通信，允許用戶動態地與他們的模型和 VRChat 環境互動。
• 友好的界面：MCP 伺服器配備直觀的界面，簡化了管理模型和 API 互動的過程。
• 開源：作為一個開源項目，VRChat MCP 鼓勵社區貢獻和增強，促進協作開發環境。

如何使用 VRChat MCP

1. 設置伺服器：首先從官方庫下載 VRChat MCP 伺服器。按照文檔中提供的安裝說明進行操作。
2. 配置 API 訪問：從 VRChat 開發者門戶獲取 API 密鑰，並在 MCP 伺服器設置中進行配置。
3. 上傳模型：使用提供的界面上傳您的自定義模型和虛擬形象。確保它們符合 VRChat 的要求以獲得最佳性能。
4. 與 API 互動：利用 API 端點來獲取、更新或刪除與您的模型和虛擬形象相關的數據。請參考 API 文檔以獲取可用端點的詳細說明。
5. 測試和迭代：設置完成後，在 VRChat 環境中測試您的模型。根據用戶反饋和性能進行必要的調整。

常見問題解答

問：VRChat MCP 的目的是什么？

答：VRChat MCP 作為一個伺服器，用於管理和與 VRChat API 互動，允許用戶創建和自定義他們的模型和虛擬形象。

問：VRChat MCP 是免費使用的嗎？

答：是的，VRChat MCP 是一個開源項目，任何人都可以免費使用和貢獻。

問：我可以為 VRChat MCP 項目做貢獻嗎？

答：當然可以！歡迎貢獻。您可以分叉庫，進行更改，並提交拉取請求以供審核。

問：運行 VRChat MCP 的系統要求是什麼？

答：系統要求可能會有所不同，但一般來說，標準的伺服器設置，具備足夠的 RAM 和處理能力即可。請參考文檔以獲取具體要求。

問：我可以在哪裡找到 VRChat MCP 的支持？

答：支持可以在社區論壇、GitHub 問題頁面或通過庫中提供的文檔找到。

日本語 | 한국어

This project is a Model Context Protocol (MCP) server for interacting with the VRChat API. It allows you to retrieve various information from VRChat using a standardized protocol.

<a href="https://youtu.be/0MRxhzlFCkw"> <img width="300" src="https://github.com/user-attachments/assets/85c00cc4-46b3-4f66-ab36-bf2891fdb283" alt="YouTube" /> </a> <a href="https://glama.ai/mcp/servers/u763zoyi5a"> <img width="380" height="200" src="https://glama.ai/mcp/servers/u763zoyi5a/badge" /> </a>

Overview

The VRChat MCP server provides a way to access VRChat's API endpoints in a structured manner. It supports a wide range of functionalities, including user authentication, retrieving user and friend information, accessing avatar and world data, and more.

Usage

To start the server, ensure you have the necessary environment variables set:

export VRCHAT_USERNAME=your_username
export VRCHAT_AUTH_TOKEN=your_auth_token

[!NOTE]

How to obtain AUTH TOKEN

You can use the following command to login and obtain an 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

Command source code

Please handle the obtained token with care as it has a very long lifetime

Then, run the following command:

npx vrchat-mcp

This will launch the MCP server, allowing you to interact with the VRChat API through the defined tools.

Usage with Claude Desktop

To use this MCP server with Claude Desktop, you do not need to run npx vrchat-mcp manually. Instead, add the following configuration to your Claude Desktop config file:

• 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"
      }
    }
  }
}

Then, start Claude Desktop as usual. If you have to use nodenv or nvm, you may need to specify the full path to the npx command.

Available Tools

This Model Context Protocol server provides the following VRChat-related tools:

User Related

• vrchat_get_friends_list: Get a list of friends
• vrchat_send_friend_request: Send a friend request

Avatar Related

• vrchat_search_avatars: Search for avatars
• vrchat_select_avatar: Select and switch to a specific avatar

World Related

• vrchat_search_worlds: Search for worlds
• vrchat_list_favorited_worlds: Get a list of favorited worlds

Instance Related

• vrchat_create_instance: Create a new instance
• vrchat_get_instance: Get information about a specific instance

Group Related

• vrchat_search_groups: Search for groups
• vrchat_join_group: Join a group

Favorites Related

• vrchat_list_favorites: Get a list of favorites
• vrchat_add_favorite: Add a new favorite
• vrchat_list_favorite_groups: Get a list of favorite groups

Invite Related

• vrchat_list_invite_messages: Get a list of invite messages
• vrchat_request_invite: Request an invite
• vrchat_get_invite_message: Get a specific invite message

Notification Related

• vrchat_get_notifications: Get a list of notifications

Debugging

First, build the project:

npm install
npm run build

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

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

Be sure that environment variables are properly configured.

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

Publishing

To publish a new version of the package, follow these steps:

1. Pull the latest code from the main branch

   git checkout main
   git pull origin main
   

2. Build the package

   npm run build
   

3. Publish to npm

   npm publish
   

4. Push changes to the remote repository

   git push origin main --tags
   

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for any improvements or bug fixes.

License

This project is licensed under the MIT License. See the LICENSE file for details.