这个项目是一个用于与VRChat API交互的模型上下文协议（MCP）服务器。它允许您使用标准协议从VRChat获取各种信息。
概述
VRChat MCP服务器提供了一种结构化访问VRChat API端点的方式。它支持广泛的功能，包括用户认证、获取用户和好友信息、访问角色和世界数据等。
使用方法
要启动服务器，请确保已设置必要的环境变量：
export VRCHAT_USERNAME=your_username
export VRCHAT_AUTH_TOKEN=your_auth_token
[!NOTE]
如何获取AUTH TOKEN
您可以使用以下命令登录并获取认证令牌：
$ npx vrchat-auth-token-checker VRChat用户名：your-username 密码：******** # 如果启用了双因素认证 双因素认证码：123456 # 成功输出 认证令牌：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 - 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，您可以在浏览器中访问它以开始调试。
发布
要发布新版本的包，请按照以下步骤操作：
-
从主分支拉取最新代码
git checkout main git pull origin main -
构建包
npm run build -
发布到npm
npm publish -
将更改推送到远程仓库
git push origin main --tags
贡献
欢迎贡献！请将仓库分叉并提交拉取请求以进行任何改进或修复错误。
许可证
本项目根据MIT许可证授权。有关详细信息，请参阅LICENSE文件。