Vrchat Mcp

Cos'è VRChat MCP?

VRChat MCP (Model Context Protocol) è un server progettato per facilitare le interazioni con l'API di VRChat. Permette agli sviluppatori e agli utenti di creare e gestire modelli e avatar personalizzati all'interno dell'ambiente di VRChat, migliorando l'esperienza complessiva dell'utente. Questo protocollo funge da ponte tra la piattaforma VRChat e le applicazioni esterne, consentendo un'integrazione e una funzionalità senza soluzione di continuità.

Caratteristiche di VRChat MCP

• Integrazione API: VRChat MCP fornisce un'API robusta che consente agli sviluppatori di accedere e manipolare i dati di VRChat, inclusi avatar degli utenti, mondi e interazioni.
• Gestione Modelli Personalizzati: Gli utenti possono caricare, gestire e personalizzare i propri modelli 3D e avatar, garantendo un'esperienza personalizzata in VRChat.
• Interazione in Tempo Reale: Il server supporta la comunicazione in tempo reale, consentendo agli utenti di interagire dinamicamente con i propri modelli e l'ambiente di VRChat.
• Interfaccia Intuitiva: Il server MCP è dotato di un'interfaccia intuitiva che semplifica il processo di gestione dei modelli e delle interazioni API.
• Open Source: Essendo un progetto open-source, VRChat MCP incoraggia i contributi e i miglioramenti della comunità, promuovendo un ambiente di sviluppo collaborativo.

Come Utilizzare VRChat MCP

1. Configura il Server: Inizia scaricando il server VRChat MCP dal repository ufficiale. Segui le istruzioni di installazione fornite nella documentazione.
2. Configura l'Accesso API: Ottieni le tue chiavi API dal portale sviluppatori di VRChat e configurale nelle impostazioni del server MCP.
3. Carica Modelli: Utilizza l'interfaccia fornita per caricare i tuoi modelli e avatar personalizzati. Assicurati che soddisfino i requisiti di VRChat per prestazioni ottimali.
4. Interagisci con l'API: Utilizza gli endpoint API per recuperare, aggiornare o eliminare dati relativi ai tuoi modelli e avatar. Consulta la documentazione API per istruzioni dettagliate sugli endpoint disponibili.
5. Testa e Itera: Dopo aver configurato, testa i tuoi modelli nell'ambiente di VRChat. Apporta modifiche secondo necessità in base al feedback degli utenti e alle prestazioni.

Domande Frequenti

D: Qual è lo scopo di VRChat MCP?

R: VRChat MCP funge da server per gestire e interagire con l'API di VRChat, consentendo agli utenti di creare e personalizzare i propri modelli e avatar.

D: VRChat MCP è gratuito da usare?

R: Sì, VRChat MCP è un progetto open-source, rendendolo gratuito per chiunque voglia usarlo e contribuire.

D: Posso contribuire al progetto VRChat MCP?

R: Assolutamente! I contributi sono benvenuti. Puoi forkare il repository, apportare le tue modifiche e inviare una pull request per la revisione.

D: Quali sono i requisiti di sistema per eseguire VRChat MCP?

R: I requisiti di sistema possono variare, ma in generale, una configurazione server standard con RAM e potenza di elaborazione adeguate dovrebbe essere sufficiente. Consulta la documentazione per requisiti specifici.

D: Dove posso trovare supporto per VRChat MCP?

R: Il supporto può essere trovato nei forum della comunità, nella pagina delle issue di GitHub o attraverso la documentazione fornita nel repository.

日本語 | 한국어

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.