使用说明

项目简介

vrchat-mcp 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型 (LLM) 应用提供访问 VRChat API 的标准化接口。通过此服务器，LLM 可以安全、可扩展地获取 VRChat 平台的用户信息、好友列表、虚拟形象 (Avatars) 数据等上下文信息，从而实现更丰富的 VRChat 互动功能。

主要功能点

用户信息查询: 获取当前用户自身的信息。
好友列表查询: 检索VRChat好友列表，包括好友的详细资料和状态。
Avatars搜索: 根据关键词和筛选条件搜索VRChat Avatars。
基于 MCP 协议: 采用标准的 Model Context Protocol，易于与支持 MCP 协议的 LLM 客户端集成，如 Claude Desktop。
可扩展性: 易于添加更多 VRChat API 接口支持，扩展服务器功能。

安装步骤

安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm 包管理器。
下载仓库代码: 从 GitHub 仓库 vrchat-mcp 下载代码到本地。
安装依赖: 在项目根目录下，打开终端并运行 'npm install' 或 'npm install --legacy-peer-deps' 安装项目依赖。
配置环境变量: 根据仓库 'README.md' 提供的指引，设置以下环境变量：
- 'VRCHAT_USERNAME': 你的 VRChat 用户名
- 'VRCHAT_PASSWORD': 你的 VRChat 密码
- 'VRCHAT_TOTP_SECRET': 你的 VRChat 双因素认证 TOTP 密钥 (获取方法请参考 'README.md' 中的 Obtain your TOTP secret 部分，注意安全风险)
- 'VRCHAT_EMAIL': 你的 VRChat 注册邮箱

服务器配置

对于 MCP 客户端（例如 Claude Desktop），你需要配置服务器的启动命令和参数。以下是针对 vrchat-mcp 的配置示例 (JSON 格式)：

{
  "mcpServers": {
    "vrchat-mcp": {
      "command": "npx",  // 启动命令，通常为 npx (Node Package Execute)
      "args": ["vrchat-mcp"], // 命令参数，这里指定执行 vrchat-mcp 包
      "env": { // 环境变量配置，与安装步骤中配置的环境变量一致
        "VRCHAT_USERNAME": "your-username",  // 替换为你的 VRChat 用户名
        "VRCHAT_PASSWORD": "your-password",  // 替换为你的 VRChat 密码
        "VRCHAT_TOTP_SECRET": "your-totp-secret", // 替换为你的 VRChat TOTP 密钥
        "VRCHAT_EMAIL": "[email protected]" // 替换为你的 VRChat 注册邮箱
      }
    }
  }
}

注意:

请将上述 JSON 配置添加到你的 MCP 客户端配置文件中 (例如 Claude Desktop 的 'claude_desktop_config.json')。
如果你的 Node.js 环境使用了 'nodenv' 或 'nvm' 等版本管理工具，可能需要指定 'npx' 命令的完整路径。

基本使用方法

启动服务器: 配置完成后，启动你的 MCP 客户端 (例如 Claude Desktop)。客户端会自动根据配置启动 vrchat-mcp 服务器。
LLM 交互: 在 MCP 客户端中，你可以指示 LLM 使用 'vrchat_get_current_user', 'vrchat_get_friends_list', 'vrchat_search_avatars' 等工具来获取 VRChat 相关信息。

例如，在 Claude Desktop 中，你可以向 Claude 提问： "请使用 vrchat_get_friends_list 工具获取我的好友列表并展示。" Claude 将会调用 'vrchat_get_friends_list' 工具，并返回你的 VRChat 好友列表信息。

关键词