Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Chrrxs/robloxstudio-mcp/llms.txt

Use this file to discover all available pages before exploring further.

Roblox Studio MCP is configured through a combination of CLI flags passed when the server starts and environment variables that unlock specific API-dependent features. Most setups only need --auto-install-plugin and an Open Cloud API key for asset operations. This page documents every available knob.

​
CLI flags

These flags are passed directly to the npx invocation that starts the MCP server.

​
--auto-install-plugin

Copies the Studio plugin bundled with the current package version into Roblox Studio’s Plugins folder when the server starts. The installer removes the other plugin variant (inspector or main) before writing, so you will never end up with both installed simultaneously. 
npx -y @chrrxs/robloxstudio-mcp@latest --auto-install-plugin
After the plugin is installed or updated, fully close and reopen Roblox Studio so it loads the new .rbxmx file.

​
--install-plugin

Installs the bundled plugin, then exits immediately without starting the MCP server. Use this for a one-time manual install or to update the plugin on a machine where the server is managed separately. 
npx -y @chrrxs/robloxstudio-mcp@latest --install-plugin

​
--open-cloud-key <key>

Sets ROBLOX_OPEN_CLOUD_API_KEY for this server process. Equivalent to passing the key as an environment variable, but useful for environments where env vars are awkward to set. 
npx -y @chrrxs/robloxstudio-mcp@latest --open-cloud-key rblx_XXXX

​
--creator-id <id>

Sets ROBLOX_CREATOR_USER_ID for this server process. Required for asset uploads that are owned by a user account. 
npx -y @chrrxs/robloxstudio-mcp@latest --creator-id 123456789

​
--creator-group-id <id>

Sets ROBLOX_CREATOR_GROUP_ID for this server process. Required for asset uploads owned by a Roblox group. Takes precedence over --creator-id when both are provided. 
npx -y @chrrxs/robloxstudio-mcp@latest --creator-group-id 987654321

​
Environment variables

​
ROBLOX_OPEN_CLOUD_API_KEY

An Open Cloud API key used by tools that call the Roblox Open Cloud REST API. Required for the following tools:
ToolRequired scope
search_assetsasset:read
get_asset_detailsasset:read (falls back to ROBLOSECURITY for own assets)
get_asset_thumbnailasset:read
upload_assetasset:write
manage_instance action="list_place_versions"asset:read
Generate a key at create.roblox.com/credentials. Grant the minimum scopes your workflow requires.

​
ROBLOX_CREATOR_USER_ID

The numeric Roblox user ID that should own uploaded assets. Required for upload_asset when ROBLOX_CREATOR_GROUP_ID is not set.

​
ROBLOX_CREATOR_GROUP_ID

The numeric Roblox group ID that should own uploaded assets. When provided, it takes precedence over ROBLOX_CREATOR_USER_ID for all upload calls.

​
MCP_PLUGINS_DIR

Overrides the default Studio Plugins folder path used by --auto-install-plugin and --install-plugin. Useful when Studio is installed to a non-standard location, or when running on WSL with a Windows Studio installation. 
MCP_PLUGINS_DIR="/mnt/d/Roblox/Plugins" npx -y @chrrxs/robloxstudio-mcp@latest --auto-install-plugin
Default paths when MCP_PLUGINS_DIR is not set:
PlatformDefault path
Windows%LOCALAPPDATA%\Roblox\Plugins\
macOS~/Documents/Roblox/Plugins/
WSL/mnt/c/Users/<you>/AppData/Local/Roblox/Plugins/

​
Default port

The MCP server listens on localhost:58741 and binds to the loopback interface only. All Studio plugin communication stays on your local machine. The port is not currently configurable; if another process is using it, see Troubleshooting.

​
MCP client JSON config

​
Claude Desktop / Cursor / other JSON-config clients

Add the following block to your MCP client’s JSON configuration file. @latest floats the package to the newest npm release on every server start. 
{
  "mcpServers": {
    "robloxstudio-mcp": {
      "command": "npx",
      "args": ["-y", "@chrrxs/robloxstudio-mcp@latest", "--auto-install-plugin"]
    }
  }
}
To include an Open Cloud key and creator ID directly in the config rather than as system env vars: 
{
  "mcpServers": {
    "robloxstudio-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@chrrxs/robloxstudio-mcp@latest",
        "--auto-install-plugin",
        "--open-cloud-key", "rblx_XXXX",
        "--creator-id", "123456789"
      ]
    }
  }
}

​
Windows cmd wrapper

On some Windows machines npx does not resolve correctly inside the MCP client’s process environment. Wrap it with cmd /c to fix this: 
{
  "mcpServers": {
    "robloxstudio-mcp": {
      "command": "cmd",
      "args": ["/c", "npx", "-y", "@chrrxs/robloxstudio-mcp@latest", "--auto-install-plugin"]
    }
  }
}

​
CLI clients (Claude Code, Codex, Gemini)

# Claude Code
claude mcp add robloxstudio -- npx -y @chrrxs/robloxstudio-mcp@latest --auto-install-plugin

# Codex CLI
codex mcp add robloxstudio -- npx -y @chrrxs/robloxstudio-mcp@latest --auto-install-plugin

# Gemini CLI
gemini mcp add robloxstudio npx --trust -- -y @chrrxs/robloxstudio-mcp@latest --auto-install-plugin

​
Version pinning

Replace @latest with a specific version tag for reproducible builds. This prevents unintentional plugin/server version mismatches caused by a new npm release. 
{
  "mcpServers": {
    "robloxstudio-mcp": {
      "command": "npx",
      "args": ["-y", "@chrrxs/robloxstudio-mcp@2.20.0", "--auto-install-plugin"]
    }
  }
}
When you pin to a specific version, the Studio plugin bundled with that exact package is installed. If you later float back to @latest and a newer plugin is installed, you must fully close and reopen Studio for the new plugin to load.

Build docs developers (and LLMs) love

Get started for freeTalk to us