VRChat MCP Server

日语|韩语

该项目是一个用于与 VRChat API 交互的模型上下文协议 (MCP) 服务器。它允许您使用标准化协议从 VRChat 检索各种信息。

概述

VRChat MCP 服务器提供了一种以结构化方式访问 VRChat API 端点的方法。它支持多种功能，包括用户身份验证、检索用户和好友信息、访问头像和世界数据等等。

Related MCP server: VRChat MCP OSC

用法

要启动服务器，请确保已设置必要的环境变量：

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命令的完整路径。

可用工具

该模型上下文协议服务器提供以下与 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，您可以在浏览器中访问该 URL 以开始调试。

出版

要发布软件包的新版本，请按照以下步骤操作：

1. 从主分支拉取最新代码

   git checkout main
   git pull origin main

2. 构建包

   npm run build

3. 发布到 npm

   npm publish

4. 将更改推送到远程存储库

   git push origin main --tags

贡献

欢迎贡献代码！请 fork 此代码库并提交 Pull 请求，以改进代码或修复错误。

执照

本项目遵循 MIT 许可证。详情请参阅 LICENSE 文件。