VRChat MCP助手

简介

一种模型上下文协议服务器，允许AI助手与VRChat API进行交互，通过标准化接口检索用户信息、好友列表及其他VRChat数据。

简介

一种模型上下文协议服务器，允许AI助手与VRChat API进行交互，通过标准化接口检索用户信息、好友列表及其他VRChat数据。

日本語 | 한국어

此项目是一个用于与 VRChat API 交互的 Model Context Protocol (MCP) 服务器。它允许您通过标准化协议从 VRChat 获取各种信息。

概述

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 个人资料页面 并启用双因素认证。
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 端点

这是我们的 Model Context Protocol 服务器支持或计划支持的 VRChat API 端点列表。为了提供全面的功能，同时包含了 GET 和 POST 方法。复选框表示每个端点的实现状态。

认证和用户信息

• 获取当前用户信息
• 搜索用户
• 获取特定用户资料
• 获取用户组
• 获取玩家管理
• 获取用户状态
• 更新用户信息
• 更新用户状态
• 封锁用户
• 解除封锁用户

朋友相关

• 获取好友列表
• 获取在线好友
• 发送好友请求
• 接受/拒绝好友请求
• 移除好友

头像相关

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

世界相关

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

实例相关

• 创建实例
• 获取实例信息
• 获取实例参与者
• 获取实例简称
• 加入实例
• 离开实例
• 邀请用户加入实例

文件相关

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

组相关

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

通知相关

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

库存相关

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

系统相关

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

收藏夹

• 列出收藏夹
• 添加收藏
• 移除收藏
• 列出收藏组
• 显示收藏组
• 更新收藏组
• 清除收藏组
• 获取收藏限制

邀请

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

其他

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

调试

首先，构建项目：

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 文件。

服务配置

[{'mcpServers': {'vrchat-mcp': {'args': ['vrchat-mcp'], 'command': 'npx', 'env': {'VRCHAT_EMAIL': 'your-email@example.com', 'VRCHAT_PASSWORD': 'your-password', 'VRCHAT_TOTP_SECRET': 'your-totp-secret', 'VRCHAT_USERNAME': 'your-username'}}}}]

来源

• 来源：github
• 链接：https://github.com/sawa-zen/vrchat-mcp