VRChat API MCP Server

GamingTypeScript

Access and interact with the VRChat API

Available Tools

vrchat_get_friends_list

Get a list of friends from VRChat

vrchat_send_friend_request

Send a friend request to a VRChat user

vrchat_search_avatars

Search for avatars on VRChat

vrchat_select_avatar

Select and switch to a specific avatar

vrchat_search_worlds

Search for worlds on VRChat

vrchat_list_favorited_worlds

Get a list of favorited worlds

vrchat_create_instance

Create a new instance of a world

vrchat_get_instance

Get information about a specific instance

vrchat_search_groups

Search for groups on VRChat

vrchat_join_group

Join a VRChat group

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

vrchat_list_invite_messages

Get a list of invite messages

vrchat_request_invite

Request an invite to an instance

vrchat_get_invite_message

Get a specific invite message

vrchat_get_notifications

Get a list of notifications

This MCP server provides a comprehensive interface to the VRChat API, allowing you to retrieve information about users, avatars, worlds, and more. It supports a wide range of functionalities including user authentication, friend management, avatar selection, world searching, and instance creation. With VRChat API, you can programmatically interact with VRChat's ecosystem, enabling you to search for content, manage your friends list, switch avatars, and access various other features of the platform through a standardized protocol.

Installation

To use the VRChat API MCP server, you'll need to have Node.js installed on your system. The server can be installed and run using npm.

Prerequisites

Node.js (latest LTS version recommended)
VRChat account credentials

Setting Up Environment Variables

Before running the server, you need to set up your VRChat credentials as environment variables:

export VRCHAT_USERNAME=your_username
export VRCHAT_AUTH_TOKEN=your_auth_token

Obtaining an Auth Token

To get your VRChat auth token, you can use the provided utility:

npx vrchat-auth-token-checker

# Follow the prompts to enter your username, password, and 2FA code (if enabled)
# Upon successful authentication, you'll receive an auth token

Important: Handle the auth token with care as it has a very long lifetime and provides full access to your VRChat account.

Running the Server

Once you have your credentials set up, you can run the server using:

npx vrchat-mcp

Integration with Claude Desktop

To use this MCP server with Claude Desktop, 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"
      }
    }
  }
}

Debugging

If you encounter issues or want to debug the server:

Build the project locally:

git clone https://github.com/sawa-zen/vrchat-mcp.git
cd vrchat-mcp
npm install
npm run build

Use the MCP Inspector for debugging:

npx @modelcontextprotocol/inspector "./dist/main.js"

The Inspector will provide a URL that you can access in your browser to debug the server.

Usage Examples

Here are some examples of how to use the VRChat API MCP server:

Searching for Avatars

You can search for avatars using specific keywords:

vrchat_search_avatars(query="cute cat", n=5)

Getting Friends List

Retrieve your list of friends:

vrchat_get_friends_list()

Searching for Worlds

Find worlds based on keywords:

vrchat_search_worlds(query="game world", n=10)

Switching Avatars

Change your avatar to a specific one:

vrchat_select_avatar(avatarId="avtr_12345678-1234-1234-1234-123456789012")

Security Considerations

Keep your auth token secure and never share it publicly
Be mindful of API rate limits to avoid being temporarily blocked
The server accesses your VRChat account with the same permissions you have when logged in