hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Integrations
Enables configuration of the MCP server using environment variables stored in a .env file for credentials and settings.
Hosts the repository for cloning and contributing to the project.
Used as the runtime environment for executing the MCP server.
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.
Uso
Para iniciar el servidor, asegúrese de tener configuradas las variables de entorno necesarias:
[!NOTA]
Obtén tu secreto TOTP
- Visita el perfil de VRChat y habilita la autenticación de dos factores.
- Descodifique el código QR que se muestra para obtener una cadena como
otpauth://totp/VRChat:your@email.com?secret=XXXXXXXXXXXXXXXXXXX&issuer=VRChat
.- Utilice la parte
XXXXXXXXXXXXXXXXXXX
como su secreto TOTP.Este método puede presentar problemas de seguridad, por lo que debe procederse con precaución.
Luego, ejecute el siguiente comando:
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
Luego, inicie Claude Desktop como de costumbre. Si necesita usar nodenv o nvm, quizás deba especificar la ruta completa del comando npx
.
Puntos finales de la API de VRChat
Esta es una lista de puntos finales de la API de VRChat que nuestro servidor de Protocolo de Contexto de Modelo admite o planea admitir. Se incluyen los métodos GET y POST para ofrecer una funcionalidad completa. Las casillas de verificación indican el estado de implementación de cada punto final.
Autenticación e información del usuario
- [x] Obtener información del usuario actual
- [ ] Buscar usuarios
- [ ] Obtener perfil de usuario específico
- [ ] Obtener grupos de usuarios
- [ ] Obtener moderaciones de jugadores
- [ ] Obtener el estado del usuario
- [ ] Actualizar la información del usuario
- [ ] Actualizar el estado del usuario
- [ ] Bloquear usuario
- [ ] Desbloquear usuario
Relacionado con amigos
- [x] Obtener lista de amigos
- [ ] Consigue amigos en línea
- [x] Enviar solicitud de amistad
- [ ] Aceptar/Rechazar solicitud de amistad
- [ ] Eliminar amigo
Relacionado con Avatar
- [ ] Obtén tus propios avatares
- [ ] Obtén tus avatares favoritos
- [x] Buscar avatares
- [ ] Obtener detalles específicos del avatar
- [ ] Obtener avatares públicos
- [ ] Crear avatar
- [ ] Actualizar avatar
- [ ] Eliminar avatar
- [x] Seleccionar avatar
- [ ] Avatar favorito/no favorito
Relacionado con el mundo
- [ ] Obtener lista de mundos
- [ ] Consigue mundos activos
- [ ] Obtener mundos visitados recientemente
- [ ] Consigue tus mundos favoritos
- [x] Buscar mundos
- [ ] Obtenga detalles específicos del mundo
- [ ] Obtener instancias mundiales
- [ ] Obtener mundos públicos
- [ ] Crear mundo
- [ ] Actualizar mundo
- [ ] Eliminar mundo
- [ ] Mundo favorito/no favorito
Instancia relacionada
- [x] Crear instancia
- [x] Obtener información de la instancia
- [ ] Obtener los asistentes de la instancia
- [ ] Obtener el nombre corto de la instancia
- [ ] Unirse a la instancia
- [ ] Salir de la instancia
- [ ] Invitar al usuario a la instancia
Archivo relacionado
- [ ] Obtener información del archivo
- [ ] Obtener información de descarga de archivos
- [ ] Obtener el estado del archivo
Grupo Relacionado
- [x] Grupos de búsqueda
- [ ] Obtener información específica del grupo
- [ ] Obtener miembros del grupo
- [ ] Obtener permisos de grupo
- [ ] Obtener solicitudes de grupo
- [ ] Recibir invitaciones a grupos
- [ ] Obtener prohibiciones de grupo
- [ ] Obtener galerías de grupo
- [ ] Obtener mundos propiedad del grupo
- [ ] Crear grupo
- [ ] Actualizar grupo
- [ ] Eliminar grupo
- [x] Unirse al grupo
- [ ] Salir del grupo
- [ ] Invitar usuario al grupo
- [ ] Aceptar/Rechazar invitación al grupo
- [ ] Prohibir el acceso al usuario al grupo
- [ ] Desbanear a un usuario del grupo
Notificación relacionada
- [ ] Obtener lista de notificaciones
- [ ] Recibir solicitudes de amistad
- [ ] Obtener el recuento de notificaciones no leídas
- [ ] Marcar notificación como leída
- [ ] Eliminar notificación
- [ ] Borrar todas las notificaciones
Inventario relacionado
- [ ] Obtener tipos de licencia
- [ ] Obtener licencias propias
- [ ] Obtener lista de tiendas
Relacionado con el sistema
- [ ] Obtener la configuración de la API
- [ ] Obtener límites de API
- [ ] Verificar el estado del sistema
- [ ] Obtener el recuento de usuarios en línea
- [ ] Obtener anuncios del servidor
Favoritos
- [x] Lista de favoritos
- [x] Agregar favorito
- [ ] Eliminar favorito
- [x] Lista de grupos favoritos
- [ ] Mostrar grupo favorito
- [ ] Actualizar grupo de favoritos
- [ ] Borrar grupo de favoritos
- [ ] Obtener límites de favoritos
Invitaciones
- [x] Lista de mensajes de invitación
- [x] Solicitar invitación
- [ ] Enviar invitación
- [x] Recibir mensaje de invitación
- [ ] Actualizar mensaje de invitación
Otros
- [ ] Obtener lista de etiquetas
- [ ] Obtener lista de invisibles
- [ ] Obtener moderaciones
- [ ] Obtener tipos de grupos favoritos
- [ ] Crear moderación
- [ ] Eliminar moderación
Depuración
Primero, construya el proyecto:
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:
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 principalCopy
- Actualice la versión según sea necesarioCopy
- Construir el paqueteCopy
- Publicar en npmCopy
- Enviar cambios al repositorio remotoCopy
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.
Licencia
Este proyecto está licenciado bajo la Licencia MIT. Consulte el archivo de LICENCIA para más detalles.
You must be authenticated.
Tools
Un servidor de protocolo de contexto de modelo que permite a los asistentes de IA interactuar con la API de VRChat, lo que permite la recuperación de información del usuario, listas de amigos y otros datos de VRChat a través de una interfaz estandarizada.