Get the FREE Ultimate OpenClaw Setup Guide →

vrchat

This project is a Model Context Protocol (MCP) server for interacting with the VRChat API.

Installation
Run this command in your terminal to add the MCP server to Claude Code.
Run in terminal:
Command
claude mcp add --transport stdio sawa-zen-vrchat-mcp npx vrchat-mcp \
  --env VRCHAT_USERNAME="your_username" \
  --env VRCHAT_AUTH_TOKEN="your_auth_token"

How to use

This MCP server provides a structured interface to VRChat's API, exposing a variety of VRChat-related tools through the Model Context Protocol. It enables actions such as retrieving a friend list, sending friend requests, searching and selecting avatars, exploring worlds and groups, managing favorites, handling invites, and checking notifications. The server relies on a VRChat authentication token, obtained by logging in and using the provided token checker, and then runs via npx vrchat-mcp to expose the MCP tools for use by clients like Claude Desktop or other MCP-enabled environments. To operate, set your VRCHAT_USERNAME and VRCHAT_AUTH_TOKEN environment variables, then start the server to make the tools available for requests.

How to install

Prerequisites:

  • Node.js and npm (or pnpm) installed on your system
  • Access to a VRChat account to obtain an auth token

Installation steps:

  1. Ensure Node.js and npm are installed. Verify with: node -v npm -v

  2. Install the VRChat MCP package (via npm) and build if needed: npm install npm run build

  3. Run the MCP server using npx (as described in the README), after exporting your VRChat credentials: export VRCHAT_USERNAME=your_username export VRCHAT_AUTH_TOKEN=your_auth_token npx vrchat-mcp

  4. If integrating with Claude Desktop, add the configured mcpServers entry to your Claude config as shown in the README, ensuring the environment variables are set there as well.

Note: The MCP Inspector can be used for debugging by launching: npx @modelcontextprotocol/inspector "./dist/main.js"

Additional notes

Tips and common considerations:

  • Keep your VRChat auth token secure; it has a long lifetime and provides access to your account.
  • When using Claude Desktop, you can point to npx vrchat-mcp with your credentials embedded in the env section of the config.
  • The server exposes a broad set of tools grouped by User, Avatar, World, Instance, Group, Favorites, Invite, and Notifications. Each tool accepts specific parameters defined by the MCP protocol.
  • If you use nodenv or nvm, you may need to provide the full path to the npx executable in your environment configuration.
  • For debugging, the MCP Inspector can help trace tool calls and responses during development.
  • Ensure you periodically update Vrchat MCP package to incorporate changes in VRChat API or MCP protocol updates.

Related MCP Servers

Sponsor this space

Reach thousands of developers