diff --git a/content/en-us/studio/mcp.md b/content/en-us/studio/mcp.md index 1d452ba96..9cc8f33e9 100644 --- a/content/en-us/studio/mcp.md +++ b/content/en-us/studio/mcp.md @@ -27,11 +27,11 @@ The server provides the following tools: `script_read` - Reads a scripts from the game using dot-notation paths (for example, `game.ServerScriptService.MyScript`). Supports reading entire scripts or specific line ranges. + Reads a script from the game using dot-notation paths (for example, `game.ServerScriptService.MyScript`). Supports reading entire scripts or specific line ranges. `multi_edit` - Applies multiple edits to a script. If the target path doesn't exist, it creates a new script. + Applies multiple edits to a script in one operation. If the target path doesn't exist, it creates a new script. Requires specifying a `datamodel_type` (Edit). `script_search` @@ -39,7 +39,7 @@ The server provides the following tools: `script_grep` - Searches for a string pattern across all script in the game. Returns up to 50 matches. + Searches for a string pattern across all scripts in the game. Returns up to 50 matches. @@ -51,19 +51,35 @@ The server provides the following tools: `generate_mesh` - Generates a textured 3D mesh. + Generates a textured 3D mesh from a text prompt using AI. `generate_material` - Generates custom material or texture. + Generates a custom material variant. Returns the base material and material variant name to apply to parts. `generate_procedural_model` - Generates custom procedural models that scale and adapt automatically. + Creates 3D objects built from primitive parts (blocks, spheres, cylinders, wedges) as a ProceduralModel with configurable attributes. Supports reference images and custom part schemas. - `insert_from_creator_store` - Inserts assets, plugins, and models from the Creator Store. + `wait_job_finished` + Waits for a procedural model generation job to finish and returns the final status. + + + `search_asset` + Searches for assets across the Creator Store (public marketplace) and Creator Inventory (user, group, or universe). Supports filtering by asset type, price, tags, and scope. + + + `insert_asset` + Inserts an asset into the game by its numeric Roblox asset ID. Supports models, meshes, images, audio, video, animations, and packages. + + + `upload_image` + Uploads a batch of images from HTTP URLs to the Roblox asset server, returning an image path to asset ID map. + + + `store_image` + Loads an image from a local file path and returns an image URI that can be passed to other tools (for example, as a reference image for `generate_procedural_model`). @@ -74,16 +90,16 @@ The server provides the following tools: - `explore_subagent` - Investigates your place in parallel and return a compact summary without cluttering the main conversation. + `subagent` + Launches a specialized subagent to handle complex, multi-step tasks autonomously. Available types include `explore` (for codebase investigation and game state queries) and `playtest` (for running gameplay scenarios and verifying outcomes). `search_game_tree` - Explores the instance hierarchy as a flat JSON array. Supports filtering by path, instance type, and keywords. + Explores the instance hierarchy as a flat JSON array. Supports filtering by path, instance type, and keywords, with configurable depth limiting. `inspect_instance` - Returns detailed information about a specific instance, including readable properties, custom attributes, and a summary of its children and descendants. + Returns detailed information about a specific instance, including all readable properties, custom attributes, and a summary of its children and descendants. @@ -95,7 +111,7 @@ The server provides the following tools: `execute_luau` - Runs Luau code in Studio. Returns either the result or an error. + Runs Luau code in Studio. Returns either the result or an error. Requires specifying a `datamodel_type` (Edit, Client, or Server). @@ -105,21 +121,21 @@ The server provides the following tools: + + `get_studio_state` + Gets the current state of Studio, including the play state and available datamodel types. + `start_stop_play` Starts or stops playtesting. - `console_output` - Retrieves output logs while the game is running. + `get_console_output` + Retrieves output from the Studio output log. `screen_capture` - Captures the current Studio viewport in Play mode and returns the image data. - - - `playtest_subagent` - Spawns a test character that runs through gameplay scenarios. + Captures the current Studio viewport and returns the image data. Optionally accepts a custom camera position and look-at target. @@ -131,15 +147,31 @@ The server provides the following tools: `character_navigation` - Moves the player character to a position or instance. + Moves the player character to a given position or instance path. Supports a configurable speed multiplier. - `keyboard_input` - Simulates key presses, key holds, and text input. + `user_keyboard_input` + Sends one or more keyboard actions in order: key down, key up, key press, text input, or wait. Supports targeting specific UI instances. + + + `user_mouse_input` + Sends one or more mouse actions in order: move, click, button down/up, scroll, or wait. Supports targeting specific instances or screen coordinates. + + + + + **Documentation and skills** + + + + + + `http_get` + Fetches content from allowed Roblox documentation URLs (Engine API reference, Creator docs, Cloud API, performance optimization guides). Supports keyword search within fetched content. - `mouse_input` - Simulates mouse clicks, movement, and scrolling. + `skill` + Retrieves detailed knowledge, best practices, or reference material for specific skills such as debugging, device simulation, and documentation search.