VRChat MCP Server

VRChat MCP

](https://badge.fury.io/js/vrchat-mcp) 

日本语 | 韩语

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

概述

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

用法

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

export VRCHAT_USERNAME=your_username
export VRCHAT_AUTH_TOKEN=your_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

要将此MCP服务器与Claude Desktop一起使用，您不需要运行 npx vrchat-mcp 手动。相反，请将以下配置添加到您的Claude Desktop配置文件中：

• MacOS： ~/Library/Application Support/Claude/claude_desktop_config.json
• 窗户： %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_ntifications：获取通知列表

调试

首先，构建项目：

npm install
npm run build

由于MCP服务器在stdio上运行，调试可能具有挑战性。为了获得最佳的调试体验，我们强烈建议使用MCP检查器。

您可以使用以下命令通过npm启动MCP检查器：

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

确保环境变量配置正确。

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

出版

要发布包的新版本，请执行以下步骤：

1. 从主分支中提取最新代码

   git checkout main
   git pull origin main

1. 构建包

   npm run build

1. 发布到npm

   npm publish

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

   git push origin main --tags

贡献

欢迎投稿！请分叉存储库，并提交任何改进或错误修复的拉取请求。

许可证

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