Vrchat MCP Osc

🚀 VRChat MCP OSC

VRChat MCP OSC bridges the gap between AI assistants and VRChat through the Model Context Protocol (MCP), enabling AI - based virtual avatar control and interaction, and providing support in virtual reality environments.

🚀 Quick Start

VRChat MCP OSC communicates with VRChat via Open Sound Control (OSC), allowing AI assistants like Claude to:

• Control character parameters and expressions
• Send messages
• Perform other interactive operations

✨ Features

• AI - Driven Virtual Avatar Control: Achieve fine - grained control of virtual characters by AI through the MCP protocol.
• Multi - platform Compatibility: Support different devices and VR systems to ensure wide compatibility.
• Efficient Communication Mechanism: Utilize OSC for low - latency and high - efficiency data transmission.

📦 Installation

System Requirements

• Node.js 18 or higher
• VRChat with OSC support
• Claude Desktop with MCP implementation

Command - line Configuration

# Create and navigate to the project directory
mkdir -p vrchat-mcp-osc
cd vrchat-mcp-osc

# Clone the repository
git clone https://github.com/Krekun/vrchat-mcp-osc.git .

# Install dependencies
pnpm install

# Build the project
pnpm build

# Start the service
npm start

📚 Documentation

Parameter Configuration

Basic Parameters

--port <number>         # Listening port, default is 3000
--host <string>         # Listening address, default is localhost
--debug                 # Enable debug mode

Advanced Options

--max_connections <number>  # Maximum number of connections, default is 100
--timeout <seconds>        # Idle timeout in seconds, default is 3600

Functional Modules

Core Components

• MCP Server: Responsible for processing instructions and data from AI.
• WebSocket Relay: Implements protocol conversion from WebSocket to OSC.
• Type Definitions: Provide unified TypeScript interface specifications.

Toolset

• Logging and Monitoring: Track the system's running status in real - time.
• Performance Optimization Tools: Improve communication efficiency and stability.

Project Architecture

vrchat-mcp-osc/
├── packages/
│   ├── mcp-server/    # Main entry for MCP protocol implementation
│   ├── relay-server/  # Protocol converter from WebSocket to OSC
│   ├── types/         # Shared TypeScript interface definitions
│   └── utils/         # Commonly used utility functions
└── pnpm-workspace.yaml  # Workspace configuration file

Development Guide

Source Code Building

# Clone the repository
git clone https://github.com/Krekun/vrchat-mcp-osc.git

# Install dependencies
pnpm install

# Build all packages
pnpm -r build

# Start in development mode
pnpm -r dev

📄 License

VRChat MCP OSC uses a dual - license model:

• Non - commercial Use: It follows the MIT license. Refer to the MIT license file for details.
• Commercial Use: A separate commercial license is required.

By using this software under the MIT license for non - commercial purposes, you must comply with the license terms. Commercial users must obtain the corresponding commercial authorization.

Acknowledgments

Thanks to the contributions of the following teams and projects:

• The VRChat team for their work on OSC integration
• Model Context Protocol for providing a standardized AI interface
• Anthropic for the MCP implementation of Claude