Vrchat MCP

🚀 VRChat Bot Development Documentation

This is an open-source project for developing VRChat bots. Through this project, developers can create custom bots and implement various functions, such as automatic replies and user management.

🚀 Quick Start

Installation Steps

1. Install Dependencies

   npm install
   

2. Build the Project

   npm run build
   

3. Run the Bot

   node dist/index.js
   

📦 Environment Variable Configuration

Before running the bot, make sure to set the following environment variables:

• VRCHAT_APP_ID: Your application ID
• VRCHAT_APP_SECRET_KEY: Your application secret key

💻 Integration with Claude Desktop

For convenient debugging, you can integrate the bot with Claude Desktop. In this way, you can view and control the bot in the graphical interface.

📚 VRChat API Endpoint List

The following are the main API endpoints provided by VRChat and their function descriptions:

User Management

• POST /api/users: Create a new user
• GET /api/users/{id}: Get detailed information of a specified user
• PUT /api/users/{id}: Update the information of a specified user
• DELETE /api/users/{id}: Delete a specified user

Group Management

• POST /api/groups: Create a new group
• GET /api/groups: List all groups
• GET /api/groups/{id}: Get detailed information of a specified group
• PUT /api/groups/{id}: Update the information of a specified group
• DELETE /api/groups/{id}: Delete a specified group

Message Management

• POST /api/messages: Send a new message
• GET /api/messages: List all messages
• GET /api/messages/{id}: Get detailed information of a specified message
• DELETE /api/messages/{id}: Delete a specified message

🔧 Debugging Guide

1. Install Debugging Tools

   npm install -g @modelcontextprotocol/inspector
   

2. Start Debugging Mode

   npx @modelcontextprotocol/inspector "node dist/index.js"
   

3. Access the Console Open a browser and access the URL provided by the tool.

🚀 Publishing Guide

1. Update the Version Number

   • Patch version: npm version patch
   • Minor version: npm version minor
   • Major version: npm version major

2. Build and Publish

   npm run build && npm publish
   

3. Commit the Code

   git add .  
   git commit -m "Update to a new version"
   git push origin main
   

🤝 Contribution Guide

Everyone's contributions are welcome! Please follow these steps:

1. Clone the Repository

   git clone https://github.com/your-repository.git
   cd your-repository
   

2. Create a Feature Branch

   git checkout -b feature/new-feature-name main
   

3. Commit the Code

   git add .  
   git commit -m "Implement a new feature"
   git push origin feature/new-feature-name
   

4. Create a Pull Request Initiate a merge request on GitHub and wait for review.

📄 License

This project follows the MIT license. Please refer to the LICENSE file for detailed information.