VRChat MCP
by sawa-zen
The VRChat MCP server provides a way to access VRChat's API endpoints in a structured manner. It allows you to retrieve various information from VRChat using a standardized protocol.
Last updated: N/A
What is VRChat MCP?
The VRChat MCP server is a Model Context Protocol server designed to interact with the VRChat API. It provides a structured way to access various VRChat API endpoints, enabling functionalities like user authentication, retrieving user and friend information, accessing avatar and world data, and more.
How to use VRChat MCP?
To use the server, you need to set environment variables for your VRChat username, password, TOTP secret, and email. Then, you can start the server using npx vrchat-mcp. Alternatively, you can integrate it with Claude Desktop by adding a configuration to the Claude Desktop config file.
Key features of VRChat MCP
User authentication
Retrieving user and friend information
Accessing avatar and world data
Supports various VRChat API endpoints (GET and POST)
Integration with Claude Desktop
Use cases of VRChat MCP
Building VRChat tools and applications
Automating VRChat tasks
Integrating VRChat data with other services
Creating custom VRChat experiences
FAQ from VRChat MCP
How do I obtain my TOTP secret?
How do I obtain my TOTP secret?
Visit the VRChat Profile and enable Two-factor authentication. Decode the displayed QR code to get a string like otpauth://totp/VRChat:[email protected]?secret=XXXXXXXXXXXXXXXXXXX&issuer=VRChat. Use the XXXXXXXXXXXXXXXXXXX part as your TOTP secret. Proceed with caution due to potential security concerns.
How do I use this with Claude Desktop?
How do I use this with Claude Desktop?
Add the provided configuration to your Claude Desktop config file, specifying the command, arguments, and environment variables.
What API endpoints are supported?
What API endpoints are supported?
The server supports a variety of endpoints related to authentication, user information, friends, avatars, worlds, instances, groups, notifications, favorites, invites and more. Check the README for a detailed list.
How do I debug the server?
How do I debug the server?
Use the MCP Inspector by running npx @modelcontextprotocol/inspector "./dist/main.js" after building the project. Ensure environment variables are properly configured.
How do I contribute to the project?
How do I contribute to the project?
Fork the repository and submit a pull request for any improvements or bug fixes.