sawa-zen/vrchat-mcp

分类Web
作者Community
星标730
定价Free

简介

vrchat-mcp 是一个基于模型上下文协议的开源插件，旨在将 VRChat 的实时数据能力直接引入 AI 助手。它通过对接 VRChat API，让 LLM 能够查询好友状态、搜索热门世界及获取模型信息。对于 VRChat 玩家或内容创作者来说，这意味着你不再需要频繁切换窗口查资料，直接通过对话就能让 AI 帮你筛选感兴趣的世界或确认好友动态。该工具安装门槛较低，只要配置好 API 凭据即可在支持 MCP 的客户端（如 Claude Desktop）中使用，实现了社交数据与 AI 生产力的无缝连接。

核心亮点

  • 实时同步 VRChat 好友状态与动态
  • 快捷检索并筛选虚拟世界与模型信息
  • 消除应用切换，在对话框内管理社交数据
  • 标准 MCP 协议，快速集成至 AI 客户端

完整文档

!VRChat MCP

![npm version](https://badge.fury.io/js/vrchat-mcp) ![License: MIT](https://opensource.org/licenses/MIT)

日本語 | 한국어

本项目是一个用于与 VRChat API 交互的 Model Context Protocol (MCP) server。它允许你通过标准化协议从 VRChat 获取各种信息。

<a href="https://youtu.be/0MRxhzlFCkw">
<img width="300" src="https://github.com/user-attachments/assets/85c00cc4-46b3-4f66-ab36-bf2891fdb283" alt="YouTube" />
</a>

<a href="https://glama.ai/mcp/servers/u763zoyi5a">
<img width="380" height="200" src="https://glama.ai/mcp/servers/u763zoyi5a/badge" />
</a>

Overview

VRChat MCP server 提供了一种以结构化方式访问 VRChat API endpoints 的方法。它支持广泛的功能，包括用户身份验证、获取用户和好友信息、访问 avatar 和 world 数据等。

Usage

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

bash
export VRCHAT_USERNAME=your_username
export VRCHAT_AUTH_TOKEN=your_auth_token
> [!NOTE]
> #### 如何获取 AUTH TOKEN
>
> 您可以使用以下命令登录并获取 auth token：
code
> $ npx vrchat-auth-token-checker
>
> VRChat Username: your-username
> Password: ******
>
> # If 2FA is enabled
> 2FA Code: 123456
>
> # Success output
> Auth Token: authcookie-xxxxx
>
> Command source code
>
> 请谨慎处理获取的 token，因为其有效期非常长**

然后，运行以下命令：

bash
npx vrchat-mcp
这将启动 MCP server，允许你通过定义的 tools 与 VRChat API 进行交互。

在 Claude Desktop 中使用

要在 Claude Desktop 中使用此 MCP server，你无需手动运行 npx vrchat-mcp。相反，请将以下配置添加到你的 Claude Desktop 配置文件中：

  • MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
    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 命令的完整路径。

Available Tools

此 Model Context Protocol 服务器提供以下 VRChat 相关工具：

User Related

  • vrchat_get_friends_list: 获取好友列表
  • vrchat_send_friend_request: 发送好友请求

Avatar Related

  • vrchat_search_avatars: 搜索 Avatar
  • vrchat_select_avatar: 选择并切换到特定的 Avatar

World Related

  • vrchat_search_worlds: 搜索 World
  • vrchat_list_favorited_worlds: 获取收藏的 World 列表

Instance Related

  • vrchat_create_instance: 创建新 Instance
  • vrchat_get_instance: 获取特定 Instance 的信息

Group Related

  • vrchat_search_groups: 搜索 Group
  • vrchat_join_group: 加入 Group

Favorites Related

  • vrchat_list_favorites: 获取收藏列表
  • vrchat_add_favorite: 添加新收藏
  • vrchat_list_favorite_groups: 获取收藏的 Group 列表

Invite Related

  • vrchat_list_invite_messages: 获取邀请消息列表
  • vrchat_request_invite: 请求邀请
  • vrchat_get_invite_message: 获取特定的邀请消息

Notification Related

  • vrchat_get_notifications: 获取通知列表

Debugging

首先，构建项目：

bash
npm install
npm run build
由于 MCP server 通过 stdio 运行，调试可能会比较困难。为了获得最佳的调试体验，我们强烈建议使用 MCP Inspector。

您可以通过 npm 使用以下命令启动 MCP Inspector：

bash
npx @modelcontextprotocol/inspector "./dist/main.js"
请确保环境变量已正确配置。

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

发布

要发布新版本的 package，请遵循以下步骤：

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

bash
git checkout main
   git pull origin main
2. 构建 package
bash
npm run build
4. 发布到 npm
bash
npm publish
5. 将更改推送到远程仓库
bash
git push origin main --tags
## Contributing

欢迎贡献！请 fork 本仓库并提交 pull request 以提供任何改进或 bug 修复。

License

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

查看官方来源