Overview
What is vrchat-mcp-osc?
vrchat-mcp-osc is a bridge between AI assistants (such as Claude) and VRChat using the Model Context Protocol (MCP) and OSC (Open Sound Control). It enables AI-driven avatar control, movement, communication, and interaction in virtual reality environments.
How to use vrchat-mcp-osc?
Clone the repository, run npm link to install globally, then configure Claude Desktop by editing claude_desktop_config.json with the npx command and optional command-line arguments (e.g., --websocket-port, --osc-send-port, --debug). Ensure Node.js 18+ and OSC enabled in VRChat.
Key features of vrchat-mcp-osc
- Avatar control: manipulate parameters and expressions
- Movement: direct avatar movement and orientation
- Communication: send messages via VRChat’s chatbox
- Menu access: toggle VRChat menu and interface elements
- Query avatar properties and available parameters
- Seamless detection of avatar configurations
Use cases of vrchat-mcp-osc
- An AI assistant controlling a user’s avatar expressions and emotes in real time.
- Automated movement and navigation of an avatar within VRChat.
- Sending chat messages triggered by AI analysis or voice commands.
- Toggling VRChat menus and features without manual intervention.
- Querying avatar parameters to adapt interactions based on avatar state.
FAQ from vrchat-mcp-osc
What are the system requirements?
Node.js 18 or higher, VRChat with OSC enabled, and Claude Desktop with MCP support.
What command-line options are available and what do they do?
Options include --websocket-port (default 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 (enable debug logging), and --no-relay (disable relay server).
What MCP tools does vrchat-mcp-osc expose?
Tools include get_avatar_name, get_avatar_parameters, set_avatar_parameter, set_emote_parameter, move_avatar, look_direction, jump, menu, voice, and send_message.
How do I troubleshoot if VRChat does not respond?
Ensure OSC is enabled in VRChat settings, check that OSC ports match between VRChat and the MCP configuration, and restart both VRChat and Claude Desktop.
Why might the MCP server not start?
Verify Node.js 18+ is installed, check command-line arguments for errors, try the --debug flag, or use the double‑dash format npx vrchat-mcp-osc -- --debug if direct arguments fail.
