Skip to main content
Glama
Sign In
enesjakozh

VRChat MCP Server

by sawa-zen
npmGitHub
TypeScript
MIT License
132
33
  • Apple
OverviewInspectNewSchemaRelated ServersReviewsScore
Need Help?View Source CodeReport Issue

Integrations

  • Enables configuration of the MCP server using environment variables stored in a .env file for credentials and settings.

  • Hosts the repository for cloning and contributing to the project.

  • Used as the runtime environment for executing the MCP server.

日本語 | 한국어

This project is a Model Context Protocol (MCP) server for interacting with the VRChat API. It allows you to retrieve various information from VRChat using a standardized protocol.

Overview

The VRChat MCP server provides a way to access VRChat's API endpoints in a structured manner. It supports a wide range of functionalities, including user authentication, retrieving user and friend information, accessing avatar and world data, and more.

Usage

To start the server, ensure you have the necessary environment variables set:

export VRCHAT_USERNAME=your_username export VRCHAT_AUTH_TOKEN=your_auth_token

Note

How to obtain AUTH TOKEN

You can use the following command to login and obtain an auth token:

$ npx vrchat-auth-token-checker VRChat Username: your-username Password: ******** # If 2FA is enabled 2FA Code: 123456 # Success output Auth Token: authcookie-xxxxx

Command source code

Please handle the obtained token with care as it has a very long lifetime

Then, run the following command:

npx vrchat-mcp

This will launch the MCP server, allowing you to interact with the VRChat API through the defined tools.

Usage with Claude Desktop

To use this MCP server with Claude Desktop, you do not need to run npx vrchat-mcp manually. Instead, 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" } } } }

Then, start Claude Desktop as usual. If you have to use nodenv or nvm, you may need to specify the full path to the npx command.

Available Tools

This Model Context Protocol server provides the following VRChat-related tools:

  • vrchat_get_friends_list: Get a list of friends
  • vrchat_send_friend_request: Send a friend request
  • vrchat_search_avatars: Search for avatars
  • vrchat_select_avatar: Select and switch to a specific avatar
  • vrchat_search_worlds: Search for worlds
  • vrchat_list_favorited_worlds: Get a list of favorited worlds
  • vrchat_create_instance: Create a new instance
  • vrchat_get_instance: Get information about a specific instance
  • vrchat_search_groups: Search for groups
  • vrchat_join_group: Join a 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
  • vrchat_get_invite_message: Get a specific invite message
  • vrchat_get_notifications: Get a list of notifications

Debugging

First, build the project:

npm install npm run build

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

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

Be sure that environment variables are properly configured.

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

Publishing

To publish a new version of the package, follow these steps:

  1. Pull the latest code from the main branch
    git checkout main git pull origin main
  2. Build the package
    npm run build
  3. Publish to npm
    npm publish
  4. Push changes to the remote repository
    git push origin main --tags

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for any improvements or bug fixes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Tools

A Model Context Protocol server that allows AI assistants to interact with the VRChat API, enabling retrieval of user information, friends lists, and other VRChat data through a standardized interface.

  1. Usage
    1. How to obtain AUTH TOKEN
  2. Usage with Claude Desktop
    1. Available Tools
      1. User Related
      2. Avatar Related
      3. World Related
      4. Instance Related
      5. Group Related
      6. Favorites Related
      7. Invite Related
      8. Notification Related
    2. Debugging
      1. Publishing
        1. Contributing
          1. License

            Related Resources

            Related MCP Servers

            • Logseq MCP Tools

              joelhooks
              -
              security
              F
              license
              -
              quality
              A Model Context Protocol server that provides AI assistants with structured access to your Logseq knowledge graph, enabling retrieval, searching, analysis, and creation of content within your personal knowledge base.
              Last updated -
              19
              TypeScript
              • Apple

            • Scrapybara MCP

              Scrapybara
              A
              security
              A
              license
              A
              quality
              A Model Context Protocol server that enables AI clients to interact with virtual Ubuntu desktops, allowing them to browse the web, run code, and control instances through mouse/keyboard actions and bash commands.
              Last updated -
              5
              9
              JavaScript
              MIT License

            • Zulip MCP Server

              Monadical-SAS
              -
              security
              A
              license
              -
              quality
              A Model Context Protocol server that enables AI assistants like Claude to interact with Zulip workspaces, supporting capabilities such as posting messages, listing channels, sending direct messages, and accessing conversation history.
              Last updated -
              JavaScript
              Apache 2.0

            • Bluesky MCP Server

              brianellin
              A
              security
              F
              license
              A
              quality
              A Model Context Protocol server that enables AI assistants to interact with Bluesky/ATProtocol, providing authentication, timeline access, post creation, and social features like likes and follows.
              Last updated -
              18
              10
              TypeScript
              • Apple
              • Linux

            View all related MCP servers

            Appeared in Searches

            New MCP Servers

            ID: u763zoyi5a