VRChat MCP 服务器

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

Integrations

Enables configuration of the MCP server using environment variables stored in a .env file for credentials and settings.
Hosts the repository for cloning and contributing to the project.
Used as the runtime environment for executing the MCP server.

日语|韩语

该项目是一个用于与 VRChat API 交互的模型上下文协议 (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

[！笔记]
获取您的 TOTP 密钥
访问VRChat 个人资料并启用双因素身份验证。
解码显示的二维码以获得类似otpauth://totp/VRChat:your@email.com?secret=XXXXXXXXXXXXXXXXXXX&issuer=VRChat字符串。
使用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"

确保环境变量配置正确。

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

出版

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

从主分支拉取最新代码
git checkout main git pull origin main
根据需要更新版本
# For patch version updates (e.g., 0.1.2 → 0.1.3) npm version patch # For minor version updates (e.g., 0.1.2 → 0.2.0) npm version minor # For major version updates (e.g., 0.1.2 → 1.0.0) npm version major
构建包
npm run build
发布到 npm
npm publish
将更改推送到远程存储库
git push origin main --tags

贡献

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

执照

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

You must be authenticated.

A

security – no known vulnerabilities

A

license - permissive license

A

quality - confirmed to work

Tools

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

Related Resources

Reddit Discussion about this server

VRChat MCP Server