VRChat MCP Server

日本語 | 한국어

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

<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>

概述

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

用法

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

export VRCHAT_USERNAME=your_username
export VRCHAT_PASSWORD=your_password
export VRCHAT_TOTP_SECRET=your_totp_secret
export VRCHAT_EMAIL=your_email@example.com

[!NOTE]

获取您的 TOTP 密钥

1. 访问 VRChat Profile 并启用双重身份验证。
2. 解码显示的二维码以获取类似 otpauth://totp/VRChat:your@email.com?secret=XXXXXXXXXXXXXXXXXXX&issuer=VRChat 的字符串。
3. 使用 XXXXXXXXXXXXXXXXXXX 部分作为您的 TOTP 密钥。

此方法可能存在安全问题，请谨慎操作。

然后，运行以下命令：

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_PASSWORD": "your-password",
        "VRCHAT_TOTP_SECRET": "your-totp-secret",
        "VRCHAT_EMAIL": "your-email@example.com"
      }
    }
  }
}

然后，像往常一样启动 Claude Desktop。 如果您必须使用 nodenv 或 nvm，您可能需要指定 npx 命令的完整路径。

VRChat API 端点

这是 VRChat API 中我们的模型上下文协议服务器支持或计划支持的端点列表。 包括 GET 和 POST 方法以提供全面的功能。 复选框指示每个端点的实现状态。

身份验证和用户信息

• [x] 获取当前用户信息
• [ ] 搜索用户
• [ ] 获取特定用户个人资料
• [ ] 获取用户组
• [ ] 获取玩家管理
• [ ] 获取用户状态
• [ ] 更新用户信息
• [ ] 更新用户状态
• [ ] 阻止用户
• [ ] 解锁用户

好友相关

• [x] 获取好友列表
• [ ] 获取在线好友
• [x] 发送好友请求
• [ ] 接受/拒绝好友请求
• [ ] 删除好友

头像相关

• [ ] 获取自己的头像
• [ ] 获取收藏的头像
• [x] 搜索头像
• [ ] 获取特定头像详细信息
• [ ] 获取公共头像
• [ ] 创建头像
• [ ] 更新头像
• [ ] 删除头像
• [x] 选择头像
• [ ] 收藏/取消收藏头像

世界相关

• [ ] 获取世界列表
• [ ] 获取活跃世界
• [ ] 获取最近访问的世界
• [ ] 获取收藏的世界
• [x] 搜索世界
• [ ] 获取特定世界详细信息
• [ ] 获取世界实例
• [ ] 获取公共世界
• [ ] 创建世界
• [ ] 更新世界
• [ ] 删除世界
• [ ] 收藏/取消收藏世界

实例相关

• [x] 创建实例
• [x] 获取实例信息
• [ ] 获取实例参与者
• [ ] 获取实例短名称
• [ ] 加入实例
• [ ] 离开实例
• [ ] 邀请用户加入实例

文件相关

• [ ] 获取文件信息
• [ ] 获取文件下载信息
• [ ] 获取文件状态

群组相关

• [x] 搜索群组
• [ ] 获取特定群组信息
• [ ] 获取群组成员
• [ ] 获取群组权限
• [ ] 获取群组请求
• [ ] 获取群组邀请
• [ ] 获取群组封禁
• [ ] 获取群组画廊
• [ ] 获取群组拥有的世界
• [ ] 创建群组
• [ ] 更新群组
• [ ] 删除群组
• [x] 加入群组
• [ ] 离开群组
• [ ] 邀请用户加入群组
• [ ] 接受/拒绝群组邀请
• [ ] 从群组封禁用户
• [ ] 从群组解封用户

通知相关

• [ ] 获取通知列表
• [ ] 获取好友请求
• [ ] 获取未读通知计数
• [ ] 将通知标记为已读
• [ ] 删除通知
• [ ] 清除所有通知

库存相关

• [ ] 获取许可证类型
• [ ] 获取拥有的许可证
• [ ] 获取商店列表

系统相关

• [ ] 获取 API 配置
• [ ] 获取 API 限制
• [ ] 检查系统健康状况
• [ ] 获取在线用户数
• [ ] 获取服务器公告

收藏夹

• [x] 列出收藏夹
• [x] 添加收藏夹
• [ ] 删除收藏夹
• [x] 列出收藏夹组
• [ ] 显示收藏夹组
• [ ] 更新收藏夹组
• [ ] 清除收藏夹组
• [ ] 获取收藏夹限制

邀请

• [x] 列出邀请消息
• [x] 请求邀请
• [ ] 发送邀请
• [x] 获取邀请消息
• [ ] 更新邀请消息

其他

• [ ] 获取标签列表
• [ ] 获取隐身列表
• [ ] 获取管理
• [ ] 获取收藏夹组类型
• [ ] 创建管理
• [ ] 删除管理

调试

首先，构建项目：

npm install
npm run build

由于 MCP 服务器通过 stdio 运行，因此调试可能具有挑战性。 为了获得最佳调试体验，我们强烈建议使用 MCP Inspector。

您可以使用以下命令通过 npm 启动 MCP Inspector：

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

确保环境变量已正确配置。

启动后，Inspector 将显示一个 URL，您可以在浏览器中访问该 URL 以开始调试。

发布

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

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

   git checkout main
   git pull origin main
   

2. 根据需要更新版本

   # 对于补丁版本更新（例如，0.1.2 → 0.1.3）
   npm version patch
   
   # 对于次要版本更新（例如，0.1.2 → 0.2.0）
   npm version minor
   
   # 对于主要版本更新（例如，0.1.2 → 1.0.0）
   npm version major
   

3. 构建软件包

   npm run build
   

4. 发布到 npm

   npm publish
   

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

   git push origin main --tags
   

贡献

欢迎贡献！ 请 fork 存储库并提交 pull request 以进行任何改进或错误修复。

许可证

本项目根据 MIT 许可证获得许可。 有关详细信息，请参见 LICENSE 文件。