日本語 | 한국어

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

概述

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

使用

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

export VRCHAT_USERNAME=你的用户名
export VRCHAT_AUTH_TOKEN=你的认证令牌

[!NOTE]

如何获取认证令牌

你可以使用以下命令登录并获取认证令牌：

$ npx vrchat-auth-token-checker

VRChat 用户名: 你的用户名
密码: ********

# 如果启用了双因素认证
双因素认证代码: 123456

# 成功输出
认证令牌: 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": "你的用户名",
        "VRCHAT_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。

你可以通过以下命令启动MCP Inspector：

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

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

启动后，Inspector将显示一个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仓库并提交拉取请求以进行任何改进或错误修复。

许可证

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