VRChat MCP

by basic-bit

1.4k downloads Not rated yet

GitHub Website

Other
API

About

MCP server for VRChat friends, worlds, groups, events, notifications, status, avatars, and VRCX history.

Explore

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below

Plugin Name VRChat MCP

Command (node, npx, python, etc.)

Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

`vrchat_friends_search`

Search friends by display name (read-only).

`vrchat_friends_list`

List friends with cache-backed pagination (read-only). Defaults to online-only; set includeOffline=true to include offline friends.

`vrchat_friends_overview`

Summarize friends by status and location with enriched world/group info (read-only).

`vrchat_friend_details`

Get a friend's profile, status, and location details by display name or userId (read-only).

`vrchat_avatar_profile`

Get an avatar profile by avatarId (read-only).

`vrchat_avatar_update`

Edit your own avatar metadata: name, description, releaseStatus, and content tags. Asset fields (assetUrl, unityPackageUrl, unityVersion, version) are unreachable — a bad value there repoints the avatar at the wrong build with no undo. Content tags: content_sex, content_adult, content_violence, content_gore, content_horror. Tags merge rather than replace, so author tags survive; clearContentTags strips every content_* tag, including ones this build does not know. CAUTION — releaseStatus is risky in BOTH directions; confirm intent before changing it. Going public can expose a creator’s work against their terms, leak a private avatar, or breach VRChat’s content policy depending on what the avatar contains. Going private breaks the avatar for everyone currently wearing it. Use dryRun to preview.

`vrchat_events_discover`

Discover public calendar events with optional category/tag filters (read-only).

`vrchat_events_upcoming`

List calendar events in the upcoming window (read-only). Defaults to the next 7 days.

`vrchat_events_search`

Search calendar events by term (read-only).

`vrchat_event_create`

Create a group calendar event.

`vrchat_event_update`

Update a group calendar event.

`vrchat_event_follow`

Follow or unfollow a group calendar event.

`vrchat_event_delete`

Delete a group calendar event after verifying whether the target is an occurrence or series.

`vrchat_favorites`

Read favorites, favorite groups, limits, or favorited avatars with compact outputs (read-only).

`vrchat_favorite_add`

Add a user, avatar, or world to a favorite group.

`vrchat_favorite_remove`

Remove a favorite by favorite record ID. Use vrchat_favorites to look up favoriteRecordId first.

`vrchat_groups_search`

Search groups by name or shortCode (read-only).

`vrchat_group_profile`

Get a group profile by groupId or shortCode (read-only).

`vrchat_group_members`

List one page of compact group members by default. Use view=all only when a complete, cached snapshot is required (read-only, capped at 10,000).

`vrchat_group_roles`

List group roles or role templates with compact fields (read-only).

`vrchat_group_roles_manage`

Assign/remove member roles or create/update/delete group role definitions.

`vrchat_group_events_list`

List group calendar events (read-only).

`vrchat_group_event_get`

Get a single group calendar event (read-only).

`vrchat_group_event_next`

Get the next upcoming calendar event for a group (read-only).

`vrchat_group_events_upcoming`

List upcoming group events in a time window (read-only).

`vrchat_group_instances_overview`

Summarize active group instances (read-only).

`vrchat_group_posts_recent`

List recent posts for a group (read-only).

`vrchat_group_post_create`

Create a group post (announcement). Does not notify members unless sendNotification is true.

`vrchat_group_post_update`

Update a group post. Omitted fields keep their current values; pass roleIds: [] to clear role restrictions. VRChat replaces the whole post on edit, so this reads the most recent 300 posts to recover the fields you did not send. If the post is older than that window, supplying title, text, and visibility still lets the edit land, but it cannot preserve roleIds or imageId and the response reports mergedFromExisting: false. Editing does not re-notify members unless sendNotification is true.

`vrchat_group_post_delete`

Delete a group post. Members already notified about it are not un-notified.

`vrchat_instance_create`

Create a new instance.

`vrchat_invite`

Invite yourself or one/many users to an instance. Users may be usr_ ids or exact display names. Destination is here=true, a full location like "wrld_:instance", or worldId+instanceId. A bare instanceId is not accepted: VRChat needs the worldId and rejects the stripped form.

`vrchat_group_invite`

Invite one or many users to a group. Users may be usr_ ids or exact display names. Requires groupId or shortCode. confirmOverrideBlock defaults false; pass true only to override an existing target-user block.

`vrchat_friend_request`

Send friend requests to one or many users. Users may be usr_ ids or exact display names.

`vrchat_boop`

Send boops to one or many users. Users may be usr_ ids or exact display names.

`vrchat_invite_self`

Invite yourself to an instance (low-risk write).

`vrchat_invite_user`

Invite a user to an instance.

`vrchat_invite_user_to_me`

Invite a user to your current instance. Requires only the target userId; resolves your current location automatically. If you only have a display name, run vrchat_friends_search first to get userId.

`vrchat_status_get`

Get your current status + description (read-only).

`vrchat_status_set`

Set your status + description (write). Requires status or color (blue/green/orange/red); if both are provided they must agree. Defaults to current user.

`vrchat_status_page_overview`

Compact VRChat status-page overview: up/down state, graph min/max/current values, unresolved + recent incidents, and active + upcoming maintenance (read-only).

`vrchat_me`

Get your profile (read-only). Use view=presence/summary/profile presets; provide fields to override. Optionally include a paged list of your groups.

`vrchat_user_profile`

Get a user profile (read-only). Optionally include a paged list of the user's groups.

`vrchat_user_groups`

List a user's groups (id + name only, cache-backed).

`vrchat_profile_update`

Update your profile fields (bio, bioLinks, pronouns, userIcon, booping, content filters). Status is preserved automatically.

`vrchat_notifications_recent`

List recent notifications (read-only).

`vrchat_worlds_search`

Search worlds by name and return compact results (read-only).

`vrchat_worlds_favorites`

List favorited worlds with compact results (read-only).

`vrchat_world_profile`

Get a world profile by worldId or name (read-only).

`vrchat_world_instances_overview`

Summarize world instances by access type and region (read-only).

`vrcx_db_status`

Detect VRCX on this machine and report database path, active user, and DB version (read-only).

`vrcx_memos_user_get`

Get a VRCX user memo by userId (read-only).

`vrcx_memos_world_get`

Get a VRCX world memo by worldId (read-only).

`vrcx_memos_avatar_get`

Get a VRCX avatar memo by avatarId (read-only).

`vrcx_gamelog_world_visits_recent`

List recent world visits from the VRCX gamelog (read-only). This reflects your local VRChat/VRCX activity history.

`vrcx_instances_recent`

List recent instance sessions for your active VRCX account (read-only). Derived from VRCX gamelog OnPlayerLeft entries.

`vrcx_user_relationship_summary`

Summarize your relationship history with a user using VRCX logs: time spent, join count, and last seen (read-only).

`vrcx_user_relationship_sessions`

List recent shared instance sessions with a user from VRCX logs (read-only). Use this for deep history; results are limited by default.

`vrchat_cache_invalidate`

Invalidate cached data (local-only).

`vrchat_config_get`

Fetch API config (read-only).

`vrchat_system_time`

Get current system time (read-only).

`vrchat_operations`

List VRChat OpenAPI operationIds and generated-tool availability for vrchat_read/vrchat_write/vrchat_delete.

`vrchat_operation_details`

Look up exact OpenAPI params and request body schema for a VRChat operationId.

`vrchat_auth_begin`

Begin login flow via local browser UI.

`vrchat_auth_status`

Auth status.

`vrchat_auth_logout`

Logout and clear session.

`vrchat_read`

Call an available generated VRChat GET operation by operationId. Use vrchat_operations and vrchat_operation_details to discover params.

`vrchat_write`

Call an available generated VRChat POST/PUT/PATCH operation by operationId. Use vrchat_operations and vrchat_operation_details to discover params/body.

`vrchat_delete`

Call an available generated VRChat DELETE operation by operationId. Use vrchat_operations and vrchat_operation_details to discover params/body.

- vrchat_friends_search: Search friends by display name (read-only).
- vrchat_friends_list: List friends with cache-backed pagination (read-only). Defaults to online-only; set includeOffline=true to include offline friends.
- vrchat_friends_overview: Summarize friends by status and location with enriched world/group info (read-only).
- vrchat_friend_details: Get a friend's profile, status, and location details by display name or userId (read-only).
- vrchat_avatar_profile: Get an avatar profile by avatarId (read-only).
- vrchat_avatar_update: Edit your own avatar metadata: name, description, releaseStatus, and content tags. Asset fields (assetUrl, unityPackageUrl, unityVersion, version) are unreachable — a bad value there repoints the avatar at the wrong build with no undo. Content tags: content_sex, content_adult, content_violence, content_gore, content_horror. Tags merge rather than replace, so author tags survive; clearContentTags strips every content_* tag, including ones this build does not know. CAUTION — releaseStatus is risky in BOTH directions; confirm intent before changing it. Going public can expose a creator’s work against their terms, leak a private avatar, or breach VRChat’s content policy depending on what the avatar contains. Going private breaks the avatar for everyone currently wearing it. Use dryRun to preview.
- vrchat_events_discover: Discover public calendar events with optional category/tag filters (read-only).
- vrchat_events_upcoming: List calendar events in the upcoming window (read-only). Defaults to the next 7 days.
- vrchat_events_search: Search calendar events by term (read-only).
- vrchat_event_create: Create a group calendar event.
- vrchat_event_update: Update a group calendar event.
- vrchat_event_follow: Follow or unfollow a group calendar event.
- vrchat_event_delete: Delete a group calendar event after verifying whether the target is an occurrence or series.
- vrchat_favorites: Read favorites, favorite groups, limits, or favorited avatars with compact outputs (read-only).
- vrchat_favorite_add: Add a user, avatar, or world to a favorite group.
- vrchat_favorite_remove: Remove a favorite by favorite record ID. Use vrchat_favorites to look up favoriteRecordId first.
- vrchat_groups_search: Search groups by name or shortCode (read-only).
- vrchat_group_profile: Get a group profile by groupId or shortCode (read-only).
- vrchat_group_members: List one page of compact group members by default. Use view=all only when a complete, cached snapshot is required (read-only, capped at 10,000).
- vrchat_group_roles: List group roles or role templates with compact fields (read-only).
- vrchat_group_roles_manage: Assign/remove member roles or create/update/delete group role definitions.
- vrchat_group_events_list: List group calendar events (read-only).
- vrchat_group_event_get: Get a single group calendar event (read-only).
- vrchat_group_event_next: Get the next upcoming calendar event for a group (read-only).
- vrchat_group_events_upcoming: List upcoming group events in a time window (read-only).
- vrchat_group_instances_overview: Summarize active group instances (read-only).
- vrchat_group_posts_recent: List recent posts for a group (read-only).
- vrchat_group_post_create: Create a group post (announcement). Does not notify members unless sendNotification is true.
- vrchat_group_post_update: Update a group post. Omitted fields keep their current values; pass roleIds: [] to clear role restrictions. VRChat replaces the whole post on edit, so this reads the most recent 300 posts to recover the fields you did not send. If the post is older than that window, supplying title, text, and visibility still lets the edit land, but it cannot preserve roleIds or imageId and the response reports mergedFromExisting: false. Editing does not re-notify members unless sendNotification is true.
- vrchat_group_post_delete: Delete a group post. Members already notified about it are not un-notified.
- vrchat_instance_create: Create a new instance.
- vrchat_invite: Invite yourself or one/many users to an instance. Users may be usr_ ids or exact display names. Destination is here=true, a full location like "wrld_:instance", or worldId+instanceId. A bare instanceId is not accepted: VRChat needs the worldId and rejects the stripped form.
- vrchat_group_invite: Invite one or many users to a group. Users may be usr_ ids or exact display names. Requires groupId or shortCode. confirmOverrideBlock defaults false; pass true only to override an existing target-user block.
- vrchat_friend_request: Send friend requests to one or many users. Users may be usr_ ids or exact display names.
- vrchat_boop: Send boops to one or many users. Users may be usr_ ids or exact display names.
- vrchat_invite_self: Invite yourself to an instance (low-risk write).
- vrchat_invite_user: Invite a user to an instance.
- vrchat_invite_user_to_me: Invite a user to your current instance. Requires only the target userId; resolves your current location automatically. If you only have a display name, run vrchat_friends_search first to get userId.
- vrchat_status_get: Get your current status + description (read-only).
- vrchat_status_set: Set your status + description (write). Requires status or color (blue/green/orange/red); if both are provided they must agree. Defaults to current user.
- vrchat_status_page_overview: Compact VRChat status-page overview: up/down state, graph min/max/current values, unresolved + recent incidents, and active + upcoming maintenance (read-only).
- vrchat_me: Get your profile (read-only). Use view=presence/summary/profile presets; provide fields to override. Optionally include a paged list of your groups.
- vrchat_user_profile: Get a user profile (read-only). Optionally include a paged list of the user's groups.
- vrchat_user_groups: List a user's groups (id + name only, cache-backed).
- vrchat_profile_update: Update your profile fields (bio, bioLinks, pronouns, userIcon, booping, content filters). Status is preserved automatically.
- vrchat_notifications_recent: List recent notifications (read-only).
- vrchat_worlds_search: Search worlds by name and return compact results (read-only).
- vrchat_worlds_favorites: List favorited worlds with compact results (read-only).
- vrchat_world_profile: Get a world profile by worldId or name (read-only).
- vrchat_world_instances_overview: Summarize world instances by access type and region (read-only).
- vrcx_db_status: Detect VRCX on this machine and report database path, active user, and DB version (read-only).
- vrcx_memos_user_get: Get a VRCX user memo by userId (read-only).
- vrcx_memos_world_get: Get a VRCX world memo by worldId (read-only).
- vrcx_memos_avatar_get: Get a VRCX avatar memo by avatarId (read-only).
- vrcx_gamelog_world_visits_recent: List recent world visits from the VRCX gamelog (read-only). This reflects your local VRChat/VRCX activity history.
- vrcx_instances_recent: List recent instance sessions for your active VRCX account (read-only). Derived from VRCX gamelog OnPlayerLeft entries.
- vrcx_user_relationship_summary: Summarize your relationship history with a user using VRCX logs: time spent, join count, and last seen (read-only).
- vrcx_user_relationship_sessions: List recent shared instance sessions with a user from VRCX logs (read-only). Use this for deep history; results are limited by default.
- vrchat_cache_invalidate: Invalidate cached data (local-only).
- vrchat_config_get: Fetch API config (read-only).
- vrchat_system_time: Get current system time (read-only).
- vrchat_operations: List VRChat OpenAPI operationIds and generated-tool availability for vrchat_read/vrchat_write/vrchat_delete.
- vrchat_operation_details: Look up exact OpenAPI params and request body schema for a VRChat operationId.
- vrchat_auth_begin: Begin login flow via local browser UI.
- vrchat_auth_status: Auth status.
- vrchat_auth_logout: Logout and clear session.
- vrchat_read: Call an available generated VRChat GET operation by operationId. Use vrchat_operations and vrchat_operation_details to discover params.
- vrchat_write: Call an available generated VRChat POST/PUT/PATCH operation by operationId. Use vrchat_operations and vrchat_operation_details to discover params/body.
- vrchat_delete: Call an available generated VRChat DELETE operation by operationId. Use vrchat_operations and vrchat_operation_details to discover params/body.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "vrchat mcp": {
            "server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@basicbit/vrchat-mcp"
                ],
                "env": {
                    "VRCHAT_MCP_CONFIG_FILE": "",
                    "VRCHAT_MCP_USER_AGENT": "",
                    "VRCHAT_MCP_LOG_LEVEL": "",
                    "VRCHAT_MCP_COOKIE_STORE": "",
                    "VRCHAT_MCP_COOKIE_FILE": "",
                    "VRCHAT_MCP_ALLOW_WRITES": "",
                    "VRCHAT_MCP_UPLOAD_ROOTS": ""
                }
            }
        }
    }
}

McpServers

{
    "server": {
        "command": "npx",
        "args": [
            "-y",
            "@basicbit/vrchat-mcp"
        ],
        "env": {
            "VRCHAT_MCP_CONFIG_FILE": "",
            "VRCHAT_MCP_USER_AGENT": "",
            "VRCHAT_MCP_LOG_LEVEL": "",
            "VRCHAT_MCP_COOKIE_STORE": "",
            "VRCHAT_MCP_COOKIE_FILE": "",
            "VRCHAT_MCP_ALLOW_WRITES": "",
            "VRCHAT_MCP_UPLOAD_ROOTS": ""
        }
    }
}

Transport

"stdio"

Package

"@basicbit/vrchat-mcp"

Registry

"npm"

Unofficial localModel Context Protocoltools for VRChat friends, worlds, groups, events, notifications, status, invites, and local VRCX history.

This project is unofficial and is not affiliated with VRChat Inc.

VRChat does not provide a public OAuth flow for third-party API applications. VRChat's Creator Guidelines say API applications should not request or store VRChat login credentials, auth tokens, or session data, should identify themselves with a clear User-Agent, should cache/back off instead of sending unmetered requests, and should not act on behalf of another user.

- Node.js 24.15.0 or newer.
- An MCP client that can run local stdio servers.
- Native dependencies are installed for keychain and VRCX SQLite support (keytar,better-sqlite3).

The npm package is the normal install path:

The server is also published to the official MCP Registry asio.github.BASIC-BIT/vrchat-mcp.

Most clients use one of these shapes. No environment variables are required for the default setup.

OpenCode uses an array-valuedcommandfield.

Add this to~/.config/opencode/opencode.json:

{ "mcp": { "vrchat": { "type": "local", "command": ["npx", "-y", "@basicbit/vrchat-mcp"], "enabled": true } } }

Claude Desktop, Cursor, Kiro, Roo, Windsurf

These clients usually split the executable intocommandplusargs.

Use this in clients that expect anmcpServersobject:

{ "mcpServers": { "vrchat": { "command": "npx", "args": ["-y", "@basicbit/vrchat-mcp"] } } }

VS Code uses aserversobject instead ofmcpServers.

{ "servers": { "vrchat": { "type": "stdio", "command": "npx", "args": ["-y", "@basicbit/vrchat-mcp"] } } }

Add this to~/.codex/config.tomlor.codex/config.toml:

[mcp_servers.vrchat] command = "npx" args = ["-y", "@basicbit/vrchat-mcp"] startup_timeout_sec = 40

If your Windows client cannot spawnnpxdirectly, usecmdas the command and put/c,npx,-y, and@basicbit/vrchat-mcpin the argument list.

Use native Streamable HTTP when an MCP client needs to connect to a long-running local server instead of spawning its own stdio child process. STDIO remains the default and recommended setup for ordinary desktop clients.

- Binds only to127.0.0.1.
- Uses the MCP endpointhttp://127.0.0.1:8765/mcpby default.
- RequiresAuthorization: Bearer <token>on every MCP request.
- Supports stateful sessions, SSE notifications, resource subscriptions, and session termination.
- Reaps abandoned sessions after 30 minutes of inactivity while preserving active response streams.
- Shares one local VRChat login, cache, and pipeline connection across all connected HTTP clients.
- Is not a hosted or multi-user mode.

Generate a secret and launch the server in PowerShell:

$env:VRCHAT_MCP_HTTP_BEARER_TOKEN = node -e "console.log(require('node:crypto').randomBytes(32).toString('hex'))" npx -y @basicbit/vrchat-mcp --transport http

Then configure the MCP client to usehttp://127.0.0.1:8765/mcpand send the token fromVRCHAT_MCP_HTTP_BEARER_TOKENas a bearer token. Keep the token in an environment variable or secret store; do not put it in a URL or commit it to a client configuration.

npx -y @basicbit/vrchat-mcp --transport http --port 9000 --path /vrchat-mcp

The HTTP listener deliberately cannot bind to a LAN or public interface. Public hosting remains unsupported because VRChat does not provide the OAuth/account-isolation model needed for a hosted personal-account service.

After adding the server to your MCP client, ask it to callvrchat_auth_begin. The tool returns a local browser login URL.

- vrchat_auth_begin: start local browser login.
- vrchat_auth_status: check whether the server is logged in.
- vrchat_auth_logout: clear the stored session.

Show my VRChat status and current location.

Which friends are online, grouped by world?

Search my friends for Alice and show their profile.

Find public VRChat events happening today.

Show recent worlds from my local VRCX history.

VRChat MCP exposes curated tools plus generated read/write/delete routers by default. Curated tools cover common tasks with compact, agent-friendly inputs and outputs.

- vrchat_me
- vrchat_friends_overview
- vrchat_friends_search
- vrchat_friend_details
- vrchat_worlds_search
- vrchat_group_profile
- vrchat_events_upcoming
- vrchat_notifications_recent
- vrchat_invite
- vrchat_group_invite
- vrchat_friend_request
- vrchat_boop
- vrcx_instances_recent

Generated OpenAPI API-gap coverage uses three router tools:

Usevrchat_operationsto list available generated operation IDs andvrchat_operation_detailsfor exact per-operation params/body schemas.

Generated read and write tools are enabled by default.VRCHAT_MCP_DISABLE_GENERATED_READ_TOOLS=truehidesvrchat_read.VRCHAT_MCP_DISABLE_GENERATED_WRITE_TOOLS=truehides bothvrchat_writeandvrchat_delete, which share the generated-write switch. JSON config can also narrow either surface to specific operation IDs;generatedWriteTools.operationIdscovers DELETE operations too, so a list holding only POST/PUT/PATCH IDs also hidesvrchat_delete:

{ "generatedReadTools": { "enabled": true, "operationIds": ["getAvatarStyles"] }, "generatedWriteTools": { "enabled": true, "operationIds": ["selectAvatar"] } }

When anoperationIdslist is empty and that generated tool class is enabled, all generated operations in that class are available through its router except hard-skipped operations and operations with curated replacements. Prefer curated tools for common workflows, but generated routers keep the local server capable as the VRChat API evolves without duplicating known curated coverage or exposing generated endpoints this client cannot reliably call.

Seedocs/tools-guide.mdfor a short guide anddocs/tools.mdfor the generated catalog.

Curated write tools and generated write tools for API gaps are enabled by default so the local MCP server is usable from the first run. Your MCP client or agent harness is expected to control tool-call permission, approval, and denial for account-changing actions.

To force read-only mode, add thisenvfragment inside the server entry for your MCP client:

{ "env": { "VRCHAT_MCP_ALLOW_WRITES": "false" } }

Only use write tools when you intend this local MCP server to perform VRChat account actions. Bulk social tools are capped and back off on 429s, but you are responsible for avoiding spam, harassment, or unwanted automation.

For group write tools, you can restrict writes to specific group IDs with a JSON config file:

{ "groups": { "allowlist": ["grp_abc123"] } }

Then setVRCHAT_MCP_CONFIG_FILEto that file path in your MCP client config.

Configuration is optional. Defaults cover normal local use.

Seesrc/config/defaults.jsonfor all defaults.

git clone https://github.com/BASIC-BIT/vrchat-mcp.git cd vrchat-mcp npm install npm run build npm run check

- npm run dev: run fromsrc/index.ts.
- npm run start: run the built server fromdist/.
- npm run dev -- --transport http: run the local Streamable HTTP server from source.
- npm run start -- --transport http: run the built local Streamable HTTP server.
- npm run mcp:login: start login through the local harness.
- npm run mcp:status: check auth through the local harness.
- npm run smoke:live: run the opt-in live smoke check.
- npm run generate:tools-docs: regeneratedocs/tools.md.
- npm run generate:schemas: regenerate OpenAPI schemas.
- npm run mcpb:build: build a local MCPB bundle undermcpb/.

Live E2E tests and LLM evals are opt-in. Seedocs/evals.mdfor details.

Fetches daily Wordle solutions using the official Wordle API.

Live AI agent city-economy on Base L2 — 92 NPC agents earn real USDC via jobs, trading, and businesses across 10 cities. Claim jobs for USDC payouts, chat with agents, check AGWC token data, and get live crypto news. 11 tools, no API key.

Comprehensive astrology MCP backed by the AstroWay Calculation API — natal, synastry, transits, Vedic dashas (Vimshottari/Yogini/Ashtottari/Kalachakra), Tarot (Rider-Waite-Smith / Marseille / Lenormand), Numerology, Human Design, AI horoscopes. Sub-arcsecond Swiss Ephemeris precision. 10 000 free credits/month, no card required. Install: npx @astroway/mcp

40 MCP tools for AI agents to play a yield-generating pet game on Base chain. Earn USDC/ETH/BTC by raising virtual pets. Impact: every action burns tokens and retires carbon credits.

An MCP server for accessing Bazi (Chinese astrology) data, requiring an API key.

Connect to UCI-compatible chess engines like Stockfish to play and analyze games. Requires a local chess engine binary.

Connects Large Language Models (LLMs) with Guild Wars 2 data sources. Requires a Guild Wars 2 API key for wallet functionality.

An MCP server for '海龟汤' (Turtle Soup), a scenario-based reasoning puzzle game.

Play a legendary text adventure by talking to your AI — no commands to memorize. The Hidden Empire puts a full underground world of puzzles, treasures, and trolls inside your conversation. Speak naturally: say 'head north,' 'grab the lantern,' or 'what am I carrying?' and your AI handles the rest. Execute multi-move plans in one shot, undo mistakes instantly, and save up to 20 named playthroughs you can resume from any session. Based on the MIT-licensed Zork I source, rebuilt from the ground up for AI-native play.

Provides daily horoscope readings and fortune telling for all 12 zodiac signs using a horoscope API.

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Explore

Setting up with Highlight

vrchat_friends_search

vrchat_friends_list

vrchat_friends_overview

vrchat_friend_details

vrchat_avatar_profile

vrchat_avatar_update

vrchat_events_discover

vrchat_events_upcoming

vrchat_events_search

vrchat_event_create

vrchat_event_update

vrchat_event_follow

vrchat_event_delete

vrchat_favorites

vrchat_favorite_add

vrchat_favorite_remove

vrchat_groups_search

vrchat_group_profile

vrchat_group_members

vrchat_group_roles

vrchat_group_roles_manage

vrchat_group_events_list

vrchat_group_event_get

vrchat_group_event_next

vrchat_group_events_upcoming

vrchat_group_instances_overview

vrchat_group_posts_recent

vrchat_group_post_create

vrchat_group_post_update

vrchat_group_post_delete

vrchat_instance_create

vrchat_invite

vrchat_group_invite

vrchat_friend_request

vrchat_boop

vrchat_invite_self

vrchat_invite_user

vrchat_invite_user_to_me

vrchat_status_get

vrchat_status_set

vrchat_status_page_overview

vrchat_me

vrchat_user_profile

vrchat_user_groups

vrchat_profile_update

vrchat_notifications_recent

vrchat_worlds_search

vrchat_worlds_favorites

vrchat_world_profile

vrchat_world_instances_overview

vrcx_db_status

vrcx_memos_user_get

vrcx_memos_world_get

vrcx_memos_avatar_get

vrcx_gamelog_world_visits_recent

vrcx_instances_recent

vrcx_user_relationship_summary

vrcx_user_relationship_sessions

vrchat_cache_invalidate

vrchat_config_get

vrchat_system_time

vrchat_operations

vrchat_operation_details

vrchat_auth_begin

vrchat_auth_status

vrchat_auth_logout

vrchat_read

vrchat_write

vrchat_delete

Claude Desktop / Cursor

McpServers

Transport

Package

Registry

Claude Desktop, Cursor, Kiro, Roo, Windsurf

More like this

Sequential Thinking

`vrchat_friends_search`

`vrchat_friends_list`

`vrchat_friends_overview`

`vrchat_friend_details`

`vrchat_avatar_profile`

`vrchat_avatar_update`

`vrchat_events_discover`

`vrchat_events_upcoming`

`vrchat_events_search`

`vrchat_event_create`

`vrchat_event_update`

`vrchat_event_follow`

`vrchat_event_delete`

`vrchat_favorites`

`vrchat_favorite_add`

`vrchat_favorite_remove`

`vrchat_groups_search`

`vrchat_group_profile`

`vrchat_group_members`

`vrchat_group_roles`

`vrchat_group_roles_manage`

`vrchat_group_events_list`

`vrchat_group_event_get`

`vrchat_group_event_next`

`vrchat_group_events_upcoming`

`vrchat_group_instances_overview`

`vrchat_group_posts_recent`

`vrchat_group_post_create`

`vrchat_group_post_update`

`vrchat_group_post_delete`

`vrchat_instance_create`

`vrchat_invite`

`vrchat_group_invite`

`vrchat_friend_request`

`vrchat_boop`

`vrchat_invite_self`

`vrchat_invite_user`

`vrchat_invite_user_to_me`

`vrchat_status_get`

`vrchat_status_set`

`vrchat_status_page_overview`

`vrchat_me`

`vrchat_user_profile`

`vrchat_user_groups`

`vrchat_profile_update`

`vrchat_notifications_recent`

`vrchat_worlds_search`

`vrchat_worlds_favorites`

`vrchat_world_profile`

`vrchat_world_instances_overview`

`vrcx_db_status`

`vrcx_memos_user_get`

`vrcx_memos_world_get`

`vrcx_memos_avatar_get`

`vrcx_gamelog_world_visits_recent`

`vrcx_instances_recent`

`vrcx_user_relationship_summary`

`vrcx_user_relationship_sessions`

`vrchat_cache_invalidate`

`vrchat_config_get`

`vrchat_system_time`

`vrchat_operations`

`vrchat_operation_details`

`vrchat_auth_begin`

`vrchat_auth_status`

`vrchat_auth_logout`

`vrchat_read`

`vrchat_write`

`vrchat_delete`