Vrchat Mcp

Was ist VRChat MCP?

VRChat MCP (Model Context Protocol) ist ein Server, der entwickelt wurde, um Interaktionen mit der VRChat-API zu erleichtern. Er ermöglicht Entwicklern und Nutzern, benutzerdefinierte Modelle und Avatare innerhalb der VRChat-Umgebung zu erstellen und zu verwalten, was das gesamte Benutzererlebnis verbessert. Dieses Protokoll dient als Brücke zwischen der VRChat-Plattform und externen Anwendungen und ermöglicht nahtlose Integration und Funktionalität.

Funktionen von VRChat MCP

• API-Integration: VRChat MCP bietet eine robuste API, die es Entwicklern ermöglicht, auf VRChat-Daten zuzugreifen und diese zu manipulieren, einschließlich Benutzeravatare, Welten und Interaktionen.
• Verwaltung benutzerdefinierter Modelle: Nutzer können ihre 3D-Modelle und Avatare hochladen, verwalten und anpassen, um ein personalisiertes Erlebnis in VRChat zu gewährleisten.
• Echtzeit-Interaktion: Der Server unterstützt die Echtzeitkommunikation, sodass Nutzer dynamisch mit ihren Modellen und der VRChat-Umgebung interagieren können.
• Benutzerfreundliche Oberfläche: Der MCP-Server verfügt über eine intuitive Benutzeroberfläche, die den Prozess der Verwaltung von Modellen und API-Interaktionen vereinfacht.
• Open Source: Als Open-Source-Projekt fördert VRChat MCP Beiträge und Verbesserungen aus der Community und schafft eine kollaborative Entwicklungsumgebung.

So verwenden Sie VRChat MCP

1. Server einrichten: Beginnen Sie mit dem Herunterladen des VRChat MCP-Servers aus dem offiziellen Repository. Befolgen Sie die Installationsanweisungen in der Dokumentation.
2. API-Zugriff konfigurieren: Erhalten Sie Ihre API-Schlüssel vom VRChat-Entwicklerportal und konfigurieren Sie diese in den MCP-Servereinstellungen.
3. Modelle hochladen: Verwenden Sie die bereitgestellte Benutzeroberfläche, um Ihre benutzerdefinierten Modelle und Avatare hochzuladen. Stellen Sie sicher, dass sie die Anforderungen von VRChat für optimale Leistung erfüllen.
4. Mit der API interagieren: Nutzen Sie die API-Endpunkte, um Daten zu Ihren Modellen und Avataren abzurufen, zu aktualisieren oder zu löschen. Konsultieren Sie die API-Dokumentation für detaillierte Anweisungen zu den verfügbaren Endpunkten.
5. Testen und iterieren: Testen Sie nach der Einrichtung Ihre Modelle in der VRChat-Umgebung. Nehmen Sie Anpassungen basierend auf Benutzerfeedback und Leistung vor.

Häufig gestellte Fragen

F: Was ist der Zweck von VRChat MCP?

A: VRChat MCP dient als Server zur Verwaltung und Interaktion mit der VRChat-API, der es Nutzern ermöglicht, ihre Modelle und Avatare zu erstellen und anzupassen.

F: Ist VRChat MCP kostenlos?

A: Ja, VRChat MCP ist ein Open-Source-Projekt und somit für jeden kostenlos nutzbar und beitragsfähig.

F: Kann ich zum VRChat MCP-Projekt beitragen?

A: Absolut! Beiträge sind willkommen. Sie können das Repository forken, Ihre Änderungen vornehmen und eine Pull-Anfrage zur Überprüfung einreichen.

F: Was sind die Systemanforderungen für den Betrieb von VRChat MCP?

A: Die Systemanforderungen können variieren, aber im Allgemeinen sollte eine Standardserverkonfiguration mit ausreichendem RAM und Rechenleistung ausreichen. Konsultieren Sie die Dokumentation für spezifische Anforderungen.

F: Wo finde ich Unterstützung für VRChat MCP?

A: Unterstützung finden Sie in den Community-Foren, auf der GitHub-Issues-Seite oder durch die in dem Repository bereitgestellte Dokumentation.

日本語 | 한국어

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.