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.

manage_instance is the control plane for Studio windows themselves. While most MCP tools operate inside an already-connected place, manage_instance operates on the Studio process — opening fresh windows, closing managed or explicitly connected sessions, checking what is currently running, and fetching the version history of a published place so you can open any past revision. This makes it the right starting point whenever you need to set up a clean testing environment, work on a historical snapshot, or tear down a window when you are done.

​
Actions

​
action=“launch”

Open a new Studio window. The source parameter controls what place file is loaded. Four sources are available:

​
source=“baseplate”

Opens a blank baseplate place. Does not require a place_id. Use this whenever you need a clean scratch environment independent of any published game.

​
source=“local_file”

Opens a local .rbxl place file from disk. Does not require a place_id. Requires the local_place_file parameter.

​
source=“published_place”

Downloads and opens the latest published version of the place identified by place_id. This action is blocked if that place_id is already connected to the MCP server — use source="place_revision" if you need a second window pointing at the same place.

​
source=“place_revision”

Opens a specific past revision of the place identified by place_id and place_version. Studio treats explicit past revisions as anonymous local copies, so this action is allowed even when the published version of that place is already connected. Use action="list_place_versions" first to discover available version numbers.

​
action=“close”

Close a Studio window managed by the MCP server, or an explicitly connected edit instance. Specify the target by instance_id.

​
action=“status”

List all MCP-managed Studio instances and their current state. Does not require additional parameters.

​
action=“list_place_versions”

Retrieve the version history of a published place via the Open Cloud asset versions API. Returns version numbers, creation timestamps, and publication state. Use the version numbers here as input to a subsequent action="launch" with source="place_revision".
list_place_versions requires ROBLOX_OPEN_CLOUD_API_KEY with the asset:read permission scope. Without it the call will be rejected.

​
Parameters

​
action
string
required
The management action to perform. One of: launch, close, status, list_place_versions.
​
source
string
Required for action="launch". One of: baseplate, local_file, published_place, place_revision.
​
place_id
string or number
The numeric Roblox place ID. Required for source="published_place" and source="place_revision". Also required for action="list_place_versions".
​
place_version
number
The specific version number to open. Required for source="place_revision". Obtain this from action="list_place_versions".
​
local_place_file
string
Absolute filesystem path to a local .rbxl file. Required for source="local_file".
​
instance_id
string
The instance ID of the window to close. Required for action="close". Also used to target a specific place for action="status" when multiple are connected.

​
Worked workflow: inspect version 3134, then close

The following sequence lists available versions of a place, picks version 3134, opens it as an anonymous revision window, inspects it, and then closes it cleanly. Step 1 — List versions 
{
  "action": "list_place_versions",
  "place_id": 12345678
}
Sample response: 
{
  "assetVersions": [
    {
      "path": "assets/12345678/versions/3135",
      "createTime": "2025-06-10T14:22:00Z",
      "published": true
    },
    {
      "path": "assets/12345678/versions/3134",
      "createTime": "2025-06-09T09:45:00Z",
      "published": false
    },
    {
      "path": "assets/12345678/versions/3133",
      "createTime": "2025-06-08T17:01:00Z",
      "published": false
    }
  ],
  "nextPageToken": "..."
}
Step 2 — Launch the revision 
{
  "action": "launch",
  "source": "place_revision",
  "place_id": 12345678,
  "place_version": 3134
}
Studio opens the revision as an anonymous local copy. The MCP server registers a new instance ID, e.g. "anon:a1b2c3d4". Step 3 — Inspect the window 
{
  "action": "status"
}

{
  "instances": [
    {
      "instanceId": "place:12345678",
      "role": "edit",
      "placeName": "MyGame",
      "isRunning": false
    },
    {
      "instanceId": "anon:a1b2c3d4",
      "role": "edit",
      "placeName": "MyGame (revision 3134)",
      "isRunning": false
    }
  ]
}
Step 4 — Close the revision window 
{
  "action": "close",
  "instance_id": "anon:a1b2c3d4"
}
source="published_place" is blocked when that place ID is already connected. This prevents accidentally opening two edit sessions against the same live place. source="place_revision" bypasses this check because Studio treats the result as a local anonymous copy, not a live connection to the published place.

Build docs developers (and LLMs) love

Get started for freeTalk to us