VRChat MCP OSC
About
Provides a bridge between AI assistants and VRChat, enabling direct avatar parameter manipulation, movement control, and interaction through WebSocket and OSC protocols.
Details
- Author
- krekun
- Repository
- Krekun/vrchat-mcp-osc
- GitHub stars
- 4
- Downloads
- 479
- Categories
- Communication, Productivity, Community, Design, Developer Tools, AI, Frontend, Other
- Tags
- #integration, #web
Jump to
- Avatar Control: Manipulate avatar parameters and expressions
- Movement Control: Direct avatar movement and orientation
- Communication: Send messages through VRChat's chatbox
- Menu Access: Toggle VRChat menu and interface elements
- Avatar Information: Query avatar properties and parameters
- Seamless VRChat Integration: Automatic detection of avatar configurations
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
VRChat MCP OSCCommand (node, npx, python, etc.)npxArguments-
Argument 1
vrchat-mcp-osc -
Argument 2
--websocket-port -
Argument 3
8765 -
Argument 4
--websocket-host -
Argument 5
localhost -
Argument 6
--osc-send-port -
Argument 7
9000 -
Argument 8
--osc-send-ip -
Argument 9
127.0.0.1 -
Argument 10
--osc-receive-port -
Argument 11
9001 -
Argument 12
--osc-receive-ip -
Argument 13
127.0.0.1 -
Argument 14
--debug
Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
-
Argument 1
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
Configure Claude Desktop by editing the claude_desktop_config.json file:
{
"mcpServers": {
"vrchat-mcp-osc": {
"command": "npx",
"args": [
"vrchat-mcp-osc"
]
}
}
}
{
"mcpServers": {
"vrchat-mcp-osc": {
"command": "npx",
"args": [
"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"
]
}
}
}
```
pnpm install
get_avatar_name
Retrieves the current avatar's name.
get_avatar_parameters
Lists available avatar parameters.
set_avatar_parameter
Sets a specific avatar parameter.
set_emote_parameter
Triggers avatar emotes.
move_avatar
Moves the avatar in a specific direction.
look_direction
Controls avatar's view direction.
jump
Makes the avatar jump.
menu
Toggles the VRChat menu.
voice
Toggles voice features.
send_message
Sends a message to the VRChat chatbox.
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"vrchat mcp osc": {
"env": {},
"args": [
"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"
],
"command": "npx"
}
}
}Linux
{
"env": [],
"args": [
"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"
],
"command": "npx"
}Macos
{
"env": [],
"args": [
"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"
],
"command": "npx"
}Windows
{
"env": [],
"args": [
"/c",
"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"
],
"command": "cmd"
}VRChat MCP OSC
VRChat MCP OSC provides a bridge between AI assistants and VRChat using the Model Context Protocol (MCP), enabling AI-driven avatar control and interactions in virtual reality environments.
Overview
By leveraging OSC (Open Sound Control) to communicate with VRChat, VRChat MCP OSC allows AI assistants such as Claude to:
- Control avatar parameters and expressions
- Send messages in VRChat
- Respond to various VR events
And more—all through the high-level API provided by the Model Context Protocol.
Key Features
- Avatar Control: Manipulate avatar parameters and expressions
- Movement Control: Direct avatar movement and orientation
- Communication: Send messages through VRChat's chatbox
- Menu Access: Toggle VRChat menu and interface elements
- Avatar Information: Query avatar properties and parameters
- Seamless VRChat Integration: Automatic detection of avatar configurations
System Requirements
- Node.js 18 or higher
- VRChat with OSC enabled
- Claude Desktop (with MCP support)
Using with Claude Desktop
Clone and npm link
git clone https://github.com/Krekun/vrchat-mcp-osc
cd vrchat-mcp-osc
npm link
Configure Claude Desktop
Configure Claude Desktop by editing the claude_desktop_config.json file:
{
"mcpServers": {
"vrchat-mcp-osc": {
"command": "npx",
"args": [
"vrchat-mcp-osc"
]
}
}
}
Command Line Options
The server supports various command-line arguments for customization:
```bash
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
