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.