Vrchat Mcp

日本語 | 한국어

此项目是一个用于与 VRChat API 交互的模型上下文协议（MCP）服务。它可以通过标准化协议从 VRChat 获取各种信息。

概述

VRChat MCP 服务提供了一种以结构化方式访问 VRChat API 端点的途径。它支持多种功能，包括用户身份验证、获取用户和好友信息、访问虚拟形象和世界数据等。

用法

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

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 中使用

要在 Claude Desktop 中使用此 MCP 服务，无需手动运行 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"

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

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

发布

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

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

   git checkout main
   git pull origin main
   

2. 构建软件包

   npm run build
   

3. 发布到 npm

   npm publish
   

4. 将更改推送到远程仓库

   git push origin main --tags
   

贡献

欢迎贡献！请 Fork 此仓库，并针对任何改进或错误修复提交拉取请求。

许可证

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