VRChat MCP OSC

VRChat MCP OSC

site icon
2025.03.30 4
TypeScript虚拟现实交互AI控制接口娱乐功能
VRChat MCP OSC 是一个基于 Model Context Protocol (MCP) 的桥梁工具,用于连接 AI 助手和 VRChat 虚拟现实环境。它通过 OSC (Open Sound Control) 协议实现 AI 对 VRChat 中虚拟角色的控制和交互。
View on GitHub

Overview

基本能力

产品定位

VRChat MCP OSC 是一个专门为 VRChat 虚拟现实环境设计的 AI 交互中间件,通过标准化的 MCP 协议实现 AI 对虚拟角色的高级控制。

核心功能

  • 虚拟角色控制:操纵虚拟角色的参数和表情
  • 移动控制:控制虚拟角色的移动和方向
  • 通讯功能:通过 VRChat 聊天框发送消息
  • 菜单访问:切换 VRChat 菜单和界面元素
  • 角色信息查询:获取虚拟角色属性和参数
  • 无缝集成:自动检测虚拟角色配置

适用场景

  • AI 驱动的虚拟角色互动体验
  • 自动化虚拟角色表演
  • 智能虚拟角色助手开发
  • 虚拟现实环境中的 AI 交互实验

工具列表

工具名称 功能描述
get_avatar_name 获取当前虚拟角色名称
get_avatar_parameters 列出可用虚拟角色参数
set_avatar_parameter 设置特定虚拟角色参数
set_emote_parameter 触发虚拟角色表情
move_avatar 控制虚拟角色移动方向
look_direction 控制虚拟角色视角方向
jump 使虚拟角色跳跃
menu 切换 VRChat 菜单
voice 切换语音功能
send_message 向 VRChat 聊天框发送消息

常见问题解答

  1. VRChat 不响应命令
  2. 确认 VRChat 设置中启用了 OSC
  3. 检查 OSC 端口配置是否匹配
  4. 重启 VRChat 和 Claude Desktop

  5. MCP 服务无法启动

  6. 确认已安装 Node.js 18+
  7. 检查命令行参数是否正确
  8. 使用 --debug 标志获取详细日志

  9. NPX 执行问题

  10. 尝试使用双破折号格式:npx vrchat-mcp-osc -- --debug
  11. Windows 系统尝试以管理员权限运行

使用教程

使用依赖

  • Node.js 18 或更高版本
  • 已启用 OSC 的 VRChat
  • 支持 MCP 的 Claude Desktop

安装教程

git clone https://github.com/Krekun/vrchat-mcp-osc
cd vrchat-mcp-osc
npm link

配置 Claude Desktop

编辑 claude_desktop_config.json 文件:

{
  "mcpServers": {
    "vrchat-mcp-osc": {
      "command": "npx",
      "args": [
        "vrchat-mcp-osc"
      ]
    }
  }
}

调试方式

npx vrchat-mcp-osc -- --debug

或使用详细配置:

npx vrchat-mcp-osc --websocket-port 8765 --websocket-host localhost --osc-send-port 9000 --osc-send-ip 127.0.0.1 --osc-receive-port 9001 --osc-receive-ip 127.0.0.1 --debug

许可证

该项目遵循 MIT 开源许可条款。