Vrchat Mcp

O que é o VRChat MCP?

VRChat MCP (Modelo Contexto Protocolo) é um servidor projetado para facilitar interações com a API do VRChat. Ele permite que desenvolvedores e usuários criem e gerenciem modelos e avatares personalizados dentro do ambiente VRChat, aprimorando a experiência geral do usuário. Este protocolo serve como uma ponte entre a plataforma VRChat e aplicações externas, permitindo integração e funcionalidade sem costura.

Recursos do VRChat MCP

• Integração de API: O VRChat MCP fornece uma API robusta que permite aos desenvolvedores acessar e manipular dados do VRChat, incluindo avatares de usuários, mundos e interações.
• Gerenciamento de Modelos Personalizados: Os usuários podem fazer upload, gerenciar e personalizar seus modelos 3D e avatares, garantindo uma experiência personalizada no VRChat.
• Interação em Tempo Real: O servidor suporta comunicação em tempo real, permitindo que os usuários interajam com seus modelos e o ambiente VRChat de forma dinâmica.
• Interface Amigável: O servidor MCP vem com uma interface intuitiva que simplifica o processo de gerenciamento de modelos e interações com a API.
• Código Aberto: Sendo um projeto de código aberto, o VRChat MCP incentiva contribuições e melhorias da comunidade, promovendo um ambiente de desenvolvimento colaborativo.

Como Usar o VRChat MCP

1. Configurar o Servidor: Comece baixando o servidor VRChat MCP do repositório oficial. Siga as instruções de instalação fornecidas na documentação.
2. Configurar Acesso à API: Obtenha suas chaves de API no portal de desenvolvedores do VRChat e configure-as nas configurações do servidor MCP.
3. Fazer Upload de Modelos: Use a interface fornecida para fazer upload de seus modelos e avatares personalizados. Certifique-se de que atendem aos requisitos do VRChat para desempenho ideal.
4. Interagir com a API: Utilize os endpoints da API para buscar, atualizar ou excluir dados relacionados aos seus modelos e avatares. Consulte a documentação da API para instruções detalhadas sobre os endpoints disponíveis.
5. Testar e Iterar: Após a configuração, teste seus modelos no ambiente VRChat. Faça ajustes conforme necessário com base no feedback dos usuários e no desempenho.

Perguntas Frequentes

Q: Qual é o propósito do VRChat MCP?

A: O VRChat MCP serve como um servidor para gerenciar e interagir com a API do VRChat, permitindo que os usuários criem e personalizem seus modelos e avatares.

Q: O VRChat MCP é gratuito para usar?

A: Sim, o VRChat MCP é um projeto de código aberto, tornando-o gratuito para qualquer pessoa usar e contribuir.

Q: Posso contribuir para o projeto VRChat MCP?

A: Absolutamente! Contribuições são bem-vindas. Você pode bifurcar o repositório, fazer suas alterações e enviar um pull request para revisão.

Q: Quais são os requisitos do sistema para executar o VRChat MCP?

A: Os requisitos do sistema podem variar, mas, em geral, uma configuração de servidor padrão com RAM e poder de processamento adequados deve ser suficiente. Consulte a documentação para requisitos específicos.

Q: Onde posso encontrar suporte para o VRChat MCP?

A: O suporte pode ser encontrado nos fóruns da comunidade, na página de problemas do GitHub ou através da documentação fornecida no repositório.

日本語 | 한국어

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.