VRChat MCP

versión npm Licencia: MIT

Este proyecto es un servidor de Protocolo de Contexto de Modelo (MCP) para interactuar con la API de VRChat. Permite recuperar información diversa de VRChat mediante un protocolo estandarizado.

Descripción general

El servidor MCP de VRChat permite acceder a los puntos finales de la API de VRChat de forma estructurada. Admite una amplia gama de funcionalidades, como la autenticación de usuarios, la recuperación de información de usuarios y amigos, el acceso a datos de avatares y del mundo, y más.

Related MCP server: MCP AI Chat LangChain

Uso

Para iniciar el servidor, asegúrese de tener configuradas las variables de entorno necesarias:

export VRCHAT_USERNAME=your_username export VRCHAT_AUTH_TOKEN=your_auth_token

[!NOTA]
Cómo obtener AUTH TOKEN
Puede utilizar el siguiente comando para iniciar sesión y obtener un token de autorización:
$ npx vrchat-auth-token-checker VRChat Username: your-username Password: ******** # If 2FA is enabled 2FA Code: 123456 # Success output Auth Token: authcookie-xxxxx
Código fuente del comando
Por favor, manipule el token obtenido con cuidado ya que tiene una vida útil muy larga.

Luego, ejecute el siguiente comando:

npx vrchat-mcp

Esto iniciará el servidor MCP, lo que le permitirá interactuar con la API VRChat a través de las herramientas definidas.

Uso con Claude Desktop

Para usar este servidor MCP con Claude Desktop, no es necesario ejecutar npx vrchat-mcp manualmente. En su lugar, agregue la siguiente configuración a su archivo de configuración de Claude Desktop:

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Ventanas: %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" } } } }

Luego, inicie Claude Desktop como de costumbre. Si necesita usar nodenv o nvm, quizás deba especificar la ruta completa del comando npx .

Herramientas disponibles

Este servidor de protocolo de contexto de modelo proporciona las siguientes herramientas relacionadas con VRChat:

Relacionado con el usuario

vrchat_get_friends_list: Obtener una lista de amigos
vrchat_send_friend_request: Enviar una solicitud de amistad

Relacionado con Avatar

vrchat_search_avatars: Busca avatares
vrchat_select_avatar: Selecciona y cambia a un avatar específico

Relacionado con el mundo

vrchat_search_worlds: Buscar mundos
vrchat_list_favorited_worlds: Obtener una lista de mundos favoritos

Instancia relacionada

vrchat_create_instance: Crea una nueva instancia
vrchat_get_instance: Obtener información sobre una instancia específica

Grupo Relacionado

vrchat_search_groups: Buscar grupos
vrchat_join_group: Únete a un grupo

Favoritos Relacionados

vrchat_list_favorites: Obtener una lista de favoritos
vrchat_add_favorite: Agregar un nuevo favorito
vrchat_list_favorite_groups: Obtenga una lista de grupos favoritos

Invitar a personas relacionadas

vrchat_list_invite_messages: Obtener una lista de mensajes de invitación
vrchat_request_invite: Solicitar una invitación
vrchat_get_invite_message: Obtener un mensaje de invitación específico

Notificación relacionada

vrchat_get_notifications: Obtener una lista de notificaciones

Depuración

Primero, construya el proyecto:

npm install npm run build

Dado que los servidores MCP se ejecutan en stdio, la depuración puede ser complicada. Para una experiencia óptima, recomendamos usar el Inspector MCP.

Puede iniciar el Inspector MCP a través de npm con este comando:

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

Asegúrese de que las variables de entorno estén configuradas correctamente.

Al iniciarse, el Inspector mostrará una URL a la que podrá acceder en su navegador para comenzar a depurar.

Publicación

Para publicar una nueva versión del paquete, siga estos pasos:

Extraiga el código más reciente de la rama principal
git checkout main git pull origin main
Construir el paquete
npm run build
Publicar en npm
npm publish
Enviar cambios al repositorio remoto
git push origin main --tags

Contribuyendo

¡Agradecemos sus contribuciones! Por favor, bifurquen el repositorio y envíen una solicitud de incorporación de cambios para cualquier mejora o corrección de errores.