VRChat MCP OSC

by Krekun
Verified

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Enables AI-driven avatar control and interactions in VRChat through OSC, allowing manipulation of avatar parameters, movement control, message sending, menu toggling, and retrieval of avatar information.

OSC de MCP de VRChat

VRChat MCP OSC proporciona un puente entre los asistentes de IA y VRChat mediante el Protocolo de contexto de modelo (MCP), lo que permite el control de avatares e interacciones impulsadas por IA en entornos de realidad virtual.

Descripción general

Al aprovechar OSC (Open Sound Control) para comunicarse con VRChat, VRChat MCP OSC permite a los asistentes de IA como Claude:

  • Controlar los parámetros y expresiones del avatar
  • Enviar mensajes en VRChat
  • Responder a diversos eventos de realidad virtual
    Y mucho más, todo a través de la API de alto nivel proporcionada por el Protocolo de Contexto de Modelo.

Características principales

  • Control de avatar : manipule los parámetros y expresiones del avatar
  • Control de movimiento : movimiento y orientación directos del avatar
  • Comunicación : Envía mensajes a través del chatbox de VRChat
  • Acceso al menú : alternar entre el menú y los elementos de la interfaz de VRChat
  • Información del avatar : Consultar propiedades y parámetros del avatar
  • Integración perfecta con VRChat : detección automática de configuraciones de avatar

Requisitos del sistema

  • Node.js 18 o superior
  • VRChat con OSC habilitado
  • Claude Desktop (con soporte MCP)

Uso con Claude Desktop

Clonar y vincular npm

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

Configurar Claude Desktop

Configure Claude Desktop editando el archivo claude_desktop_config.json :

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

Opciones de línea de comandos

El servidor admite varios argumentos de línea de comandos para la personalización:

# Claude Desktop configuration { "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" ] } } }

Opciones disponibles

OpciónDescripciónPor defectoNotas
--websocket-port <port>Puerto WebSocket8765Para la comunicación WebSocket
--websocket-host <host>Host de WebSockethost localPara la comunicación WebSocket
--osc-send-port <port>Puerto de envío OSC9000Puerto para enviar a VRChat
--osc-send-ip <ip>OSC envía IP127.0.0.1Dirección para enviar a VRChat
--osc-receive-port <port>Puerto de recepción OSC9001Puerto para recibir desde VRChat
--osc-receive-ip <ip>OSC recibe IP127.0.0.1Dirección para recibir de VRChat
--debugHabilitar el registro de depuraciónFALSOGenerar registros detallados
--no-relayDeshabilitar el servidor de retransmisiónFALSOCuando no se utiliza el servidor de retransmisión

Herramientas MCP disponibles

VRChat MCP OSC expone las siguientes herramientas MCP a los asistentes de IA:

Nombre de la herramientaDescripción
get_avatar_nameRecupera el nombre del avatar actual
get_avatar_parametersEnumera los parámetros de avatar disponibles
set_avatar_parameterEstablece un parámetro de avatar específico
set_emote_parameterActiva los gestos del avatar
move_avatarMueve el avatar en una dirección específica.
look_directionControla la dirección de la vista del avatar.
jumpHace que el avatar salte
menuActiva o desactiva el menú de VRChat
voiceActiva o desactiva las funciones de voz
send_messageEnvía un mensaje al chatbox de VRChat

Solución de problemas

Problemas comunes

  1. VRChat no responde a los comandos
    • Asegúrese de que OSC esté habilitado en la configuración de VRChat
    • Verifique que los puertos OSC coincidan entre la configuración de VRChat y MCP
    • Reiniciar VRChat y Claude Desktop
  2. El servidor MCP no se inicia
    • Asegúrese de que Node.js 18+ esté instalado
    • Comprobar los argumentos de la línea de comandos para detectar errores
    • Intente ejecutar con el indicador --debug para obtener registros más detallados
    • Utilice npx vrchat-mcp-osc -- --debug si los argumentos directos no funcionan
  3. Problemas de ejecución de NPX
    • Si no se reconocen los argumentos, intente usar el formato de doble guion: npx vrchat-mcp-osc -- --debug
    • En Windows, intente ejecutar en un símbolo del sistema con privilegios de administrador
    • Si tiene problemas con la instalación global, pruebe el enfoque del enlace npm local

Estructura del proyecto

vrchat-mcp-osc/ ├── packages/ │ ├── mcp-server/ # MCP server implementation (main entry point) │ ├── relay-server/ # WebSocket to OSC relay │ ├── types/ # Shared TypeScript interfaces │ └── utils/ # Common utilities └── pnpm-workspace.yaml # Workspace configuration

Desarrollo

Construir desde la fuente

# Clone the repository git clone https://github.com/Krekun/vrchat-mcp-osc cd vrchat-mcp-osc # Install dependencies pnpm install # Build all packages pnpm -r build # Development mode pnpm -r dev

Licencia

VRChat MCP OSC tiene doble licencia de la siguiente manera:

Para uso no comercial: Puede usar, modificar y redistribuir el software bajo los términos de la Licencia MIT. (Consulte el archivo de la Licencia MIT para más detalles).

Para uso comercial: el uso comercial de este software requiere una licencia comercial separada.

Al utilizar este software bajo la Licencia MIT con fines no comerciales, usted acepta los términos de dicha licencia. Los usuarios comerciales deben obtener una licencia comercial, como se describe anteriormente.

Expresiones de gratitud

  • Equipo de VRChat para la integración de OSC
  • Protocolo de contexto del modelo para la interfaz de IA estandarizada
  • Antrópico para la implementación del MCP de Claude
-
security - not tested
F
license - not found
-
quality - not tested

Proporciona un puente entre los asistentes de IA y VRChat, lo que permite el control de avatares e interacciones impulsados por IA en entornos de realidad virtual a través del Protocolo de contexto de modelo.

  1. Overview
    1. Key Features
      1. System Requirements
        1. Using with Claude Desktop
          1. Clone and npm link
          2. Configure Claude Desktop
          3. Command Line Options
          4. Available Options
        2. Available MCP Tools
          1. Troubleshooting
            1. Common Issues
          2. Project Structure
            1. Development
              1. Build From Source
            2. License
              1. Acknowledgments
                ID: szi385y758