vrchat-mcp

vrchat-mcp

34

The VRChat MCP server is a tool for interacting with the VRChat API using a standardized protocol. It offers various functionalities such as user and avatar management and integrates with Claude Desktop for enhanced use. Its debugging tools and contribution guidelines promote further development and community engagement.

Overview

The VRChat MCP server provides a way to access VRChat's API endpoints in a structured manner. It supports functionalities like user authentication, retrieving information about users and friends, accessing avatar and world data, and more.

Usage

Set the necessary environment variables for VRChat credentials and run the command to launch the server, allowing interaction with the VRChat API.

Usage with Claude Desktop

Configure Claude Desktop by editing the configuration file to automatically run the MCP server without manual commands.

Available Tools

User Related

  • Get friends list, send friend requests

Avatar Related

  • Search for avatars, select and switch to a specific avatar

World Related

  • Search for worlds, list favorited worlds

Instance Related

  • Create a new instance, get instance information

Group Related

  • Search for groups, join groups

Favorites Related

  • Manage favorites and favorite groups

Invite Related

  • Manage invite messages and requests

Notification Related

  • Get notifications

Debugging

Use the MCP Inspector for debugging. It helps visualize and debug MCP communication.

Publishing

Follow the steps to publish a new package version, involving code updates, building, and pushing to npm.

Contributing

Contributions are welcome through pull requests.

License

Licensed under the MIT License.