Vrchat Mcp

¿Qué es VRChat MCP?

VRChat MCP (Modelo Contexto Protocolo) es un servidor diseñado para facilitar interacciones con la API de VRChat. Permite a desarrolladores y usuarios crear y gestionar modelos y avatares personalizados dentro del entorno de VRChat, mejorando la experiencia general del usuario. Este protocolo sirve como un puente entre la plataforma de VRChat y aplicaciones externas, permitiendo una integración y funcionalidad sin problemas.

Características de VRChat MCP

• Integración de API: VRChat MCP proporciona una API robusta que permite a los desarrolladores acceder y manipular datos de VRChat, incluyendo avatares de usuarios, mundos e interacciones.
• Gestión de Modelos Personalizados: Los usuarios pueden subir, gestionar y personalizar sus modelos 3D y avatares, asegurando una experiencia personalizada en VRChat.
• Interacción en Tiempo Real: El servidor soporta comunicación en tiempo real, permitiendo a los usuarios interactuar dinámicamente con sus modelos y el entorno de VRChat.
• Interfaz Amigable: El servidor MCP viene con una interfaz intuitiva que simplifica el proceso de gestión de modelos e interacciones con la API.
• Código Abierto: Al ser un proyecto de código abierto, VRChat MCP fomenta contribuciones y mejoras de la comunidad, promoviendo un entorno de desarrollo colaborativo.

Cómo Usar VRChat MCP

1. Configura el Servidor: Comienza descargando el servidor VRChat MCP desde el repositorio oficial. Sigue las instrucciones de instalación proporcionadas en la documentación.
2. Configura el Acceso a la API: Obtén tus claves de API desde el portal de desarrolladores de VRChat y configúralas en la configuración del servidor MCP.
3. Sube Modelos: Utiliza la interfaz proporcionada para subir tus modelos y avatares personalizados. Asegúrate de que cumplan con los requisitos de VRChat para un rendimiento óptimo.
4. Interactúa con la API: Utiliza los puntos finales de la API para obtener, actualizar o eliminar datos relacionados con tus modelos y avatares. Consulta la documentación de la API para instrucciones detalladas sobre los puntos finales disponibles.
5. Prueba e Itera: Después de la configuración, prueba tus modelos en el entorno de VRChat. Realiza ajustes según sea necesario basándote en la retroalimentación de los usuarios y el rendimiento.

Preguntas Frecuentes

P: ¿Cuál es el propósito de VRChat MCP?

R: VRChat MCP sirve como un servidor para gestionar e interactuar con la API de VRChat, permitiendo a los usuarios crear y personalizar sus modelos y avatares.

P: ¿Es VRChat MCP gratuito para usar?

R: Sí, VRChat MCP es un proyecto de código abierto, lo que lo hace gratuito para que cualquiera lo use y contribuya.

P: ¿Puedo contribuir al proyecto VRChat MCP?

R: ¡Absolutamente! Las contribuciones son bienvenidas. Puedes bifurcar el repositorio, hacer tus cambios y enviar una solicitud de extracción para revisión.

P: ¿Cuáles son los requisitos del sistema para ejecutar VRChat MCP?

R: Los requisitos del sistema pueden variar, pero generalmente, una configuración de servidor estándar con RAM y potencia de procesamiento adecuadas debería ser suficiente. Consulta la documentación para requisitos específicos.

P: ¿Dónde puedo encontrar soporte para VRChat MCP?

R: El soporte se puede encontrar en los foros de la comunidad, la página de problemas de GitHub o a través de la documentación proporcionada en el repositorio.

日本語 | 한국어

This project is a Model Context Protocol (MCP) server for interacting with the VRChat API. It allows you to retrieve various information from VRChat using a standardized protocol.

<a href="https://youtu.be/0MRxhzlFCkw"> <img width="300" src="https://github.com/user-attachments/assets/85c00cc4-46b3-4f66-ab36-bf2891fdb283" alt="YouTube" /> </a> <a href="https://glama.ai/mcp/servers/u763zoyi5a"> <img width="380" height="200" src="https://glama.ai/mcp/servers/u763zoyi5a/badge" /> </a>

Overview

The VRChat MCP server provides a way to access VRChat's API endpoints in a structured manner. It supports a wide range of functionalities, including user authentication, retrieving user and friend information, accessing avatar and world data, and more.

Usage

To start the server, ensure you have the necessary environment variables set:

export VRCHAT_USERNAME=your_username
export VRCHAT_AUTH_TOKEN=your_auth_token

[!NOTE]

How to obtain AUTH TOKEN

You can use the following command to login and obtain an auth token:

$ npx vrchat-auth-token-checker

VRChat Username: your-username
Password: ********

# If 2FA is enabled
2FA Code: 123456

# Success output
Auth Token: authcookie-xxxxx

Command source code

Please handle the obtained token with care as it has a very long lifetime

Then, run the following command:

npx vrchat-mcp

This will launch the MCP server, allowing you to interact with the VRChat API through the defined tools.

Usage with Claude Desktop

To use this MCP server with Claude Desktop, you do not need to run npx vrchat-mcp manually. Instead, add the following configuration to your Claude Desktop config file:

• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "vrchat-mcp": {
      "command": "npx",
      "args": ["vrchat-mcp"],
      "env": {
        "VRCHAT_USERNAME": "your-username",
        "VRCHAT_AUTH_TOKEN": "your-auth-token"
      }
    }
  }
}

Then, start Claude Desktop as usual. If you have to use nodenv or nvm, you may need to specify the full path to the npx command.

Available Tools

This Model Context Protocol server provides the following VRChat-related tools:

User Related

• vrchat_get_friends_list: Get a list of friends
• vrchat_send_friend_request: Send a friend request

Avatar Related

• vrchat_search_avatars: Search for avatars
• vrchat_select_avatar: Select and switch to a specific avatar

World Related

• vrchat_search_worlds: Search for worlds
• vrchat_list_favorited_worlds: Get a list of favorited worlds

Instance Related

• vrchat_create_instance: Create a new instance
• vrchat_get_instance: Get information about a specific instance

Group Related

• vrchat_search_groups: Search for groups
• vrchat_join_group: Join a group

Favorites Related

• vrchat_list_favorites: Get a list of favorites
• vrchat_add_favorite: Add a new favorite
• vrchat_list_favorite_groups: Get a list of favorite groups

Invite Related

• vrchat_list_invite_messages: Get a list of invite messages
• vrchat_request_invite: Request an invite
• vrchat_get_invite_message: Get a specific invite message

Notification Related

• vrchat_get_notifications: Get a list of notifications

Debugging

First, build the project:

npm install
npm run build

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

npx @modelcontextprotocol/inspector "./dist/main.js"

Be sure that environment variables are properly configured.

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

Publishing

To publish a new version of the package, follow these steps:

1. Pull the latest code from the main branch

   git checkout main
   git pull origin main
   

2. Build the package

   npm run build
   

3. Publish to npm

   npm publish
   

4. Push changes to the remote repository

   git push origin main --tags
   

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for any improvements or bug fixes.

License

This project is licensed under the MIT License. See the LICENSE file for details.