VRChat

You run a VRChat MCP Server to access VRChat data and actions through a single, standardized interface. It lets you retrieve user and friend information, avatar and world data, and other VRChat resources in a consistent way, so your applications can interact with VRChat without handling multiple API details directly.

How to use

You interact with the VRChat MCP Server using a client that understands the MCP protocol. Start the server locally, configure authentication, and then request user data, avatar information, world data, and other VRChat resources through the predefined tools. You can also integrate the server with clients like Claude Desktop for a streamlined workflow.

How to install

Prerequisites: ensure you have Node.js and npm installed on your system.

1. Install dependencies and build the package locally.

npm install
npm run build

Configuration and usage notes

You need to provide VRChat credentials to authenticate with the VRChat API. Set these environment variables in your shell before starting the MCP Server.

export VRCHAT_USERNAME=your_username
export VRCHAT_AUTH_TOKEN=your_auth_token

Debugging

For debugging, you can run the MCP Inspector to attach a debugging interface to the running MCP server.

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

Starting the server

Once credentials are set, start the MCP server using the standard command.

npx vrchat-mcp

Using with Claude Desktop

If you prefer not to run the command manually, configure Claude Desktop to launch the MCP server automatically.

{
  "mcpServers": {
    "vrchat-mcp": {
      "command": "npx",
      "args": ["vrchat-mcp"],
      "env": {
        "VRCHAT_USERNAME": "your-username",
        "VRCHAT_AUTH_TOKEN": "your-auth-token"
      }
    }
  }
}

Available tools

vrchat_get_friends_list

Fetches the list of friends for the authenticated VRChat user.

vrchat_send_friend_request

Sends a friend request to another VRChat user.

vrchat_search_avatars

Searches available avatars by criteria such as name or author.

vrchat_select_avatar

Selects and activates a specific avatar for your account.

vrchat_search_worlds

Searches VRChat worlds with filters like name, author, or category.

vrchat_list_favorited_worlds

Retrieves the worlds you have marked as favorites.

vrchat_create_instance

Creates a new instance in a world for users to join.

vrchat_get_instance

Gets information about a specific instance.

vrchat_search_groups

Searches VRChat groups by name or topic.

vrchat_join_group

Joins a VRChat group.

vrchat_list_favorites

Retrieves your favorite items across VRChat resources.

vrchat_add_favorite

Adds a new item to your favorites.

vrchat_list_favorite_groups

Lists your favorite groups.

vrchat_list_invite_messages

Gets a list of invite messages.

vrchat_request_invite

Requests an invite to a VRChat session or feature.

vrchat_get_invite_message

Retrieves a specific invite message.

vrchat_get_notifications

Fetches a list of notifications for the authenticated user.