Vrchat Mcp

Qu'est-ce que VRChat MCP ?

VRChat MCP (Model Context Protocol) est un serveur conçu pour faciliter les interactions avec l'API de VRChat. Il permet aux développeurs et aux utilisateurs de créer et de gérer des modèles et des avatars personnalisés dans l'environnement VRChat, améliorant ainsi l'expérience utilisateur globale. Ce protocole sert de pont entre la plateforme VRChat et les applications externes, permettant une intégration et une fonctionnalité sans faille.

Fonctionnalités de VRChat MCP

• Intégration API : VRChat MCP fournit une API robuste qui permet aux développeurs d'accéder et de manipuler les données de VRChat, y compris les avatars des utilisateurs, les mondes et les interactions.
• Gestion de modèles personnalisés : Les utilisateurs peuvent télécharger, gérer et personnaliser leurs modèles 3D et avatars, garantissant une expérience personnalisée dans VRChat.
• Interaction en temps réel : Le serveur prend en charge la communication en temps réel, permettant aux utilisateurs d'interagir dynamiquement avec leurs modèles et l'environnement VRChat.
• Interface conviviale : Le serveur MCP est doté d'une interface intuitive qui simplifie le processus de gestion des modèles et des interactions API.
• Open Source : Étant un projet open-source, VRChat MCP encourage les contributions et améliorations de la communauté, favorisant un environnement de développement collaboratif.

Comment utiliser VRChat MCP

1. Configurer le serveur : Commencez par télécharger le serveur VRChat MCP depuis le dépôt officiel. Suivez les instructions d'installation fournies dans la documentation.
2. Configurer l'accès API : Obtenez vos clés API depuis le portail développeur de VRChat et configurez-les dans les paramètres du serveur MCP.
3. Télécharger des modèles : Utilisez l'interface fournie pour télécharger vos modèles et avatars personnalisés. Assurez-vous qu'ils répondent aux exigences de VRChat pour des performances optimales.
4. Interagir avec l'API : Utilisez les points de terminaison de l'API pour récupérer, mettre à jour ou supprimer des données liées à vos modèles et avatars. Consultez la documentation de l'API pour des instructions détaillées sur les points de terminaison disponibles.
5. Tester et itérer : Après la configuration, testez vos modèles dans l'environnement VRChat. Apportez des ajustements si nécessaire en fonction des retours des utilisateurs et des performances.

Questions Fréquemment Posées

Q : Quel est le but de VRChat MCP ?

R : VRChat MCP sert de serveur pour gérer et interagir avec l'API de VRChat, permettant aux utilisateurs de créer et de personnaliser leurs modèles et avatars.

Q : VRChat MCP est-il gratuit à utiliser ?

R : Oui, VRChat MCP est un projet open-source, ce qui le rend gratuit pour quiconque souhaite l'utiliser et y contribuer.

Q : Puis-je contribuer au projet VRChat MCP ?

R : Absolument ! Les contributions sont les bienvenues. Vous pouvez forker le dépôt, apporter vos modifications et soumettre une demande de tirage pour révision.

Q : Quelles sont les exigences système pour exécuter VRChat MCP ?

R : Les exigences système peuvent varier, mais en général, une configuration serveur standard avec une RAM et une puissance de traitement adéquates devrait suffire. Consultez la documentation pour des exigences spécifiques.

Q : Où puis-je trouver de l'aide pour VRChat MCP ?

R : Le support peut être trouvé dans les forums communautaires, la page des problèmes GitHub, ou à travers la documentation fournie dans le dépôt.

日本語 | 한국어

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.