From cae97cbad5cd46c4e29f67785fe15c953cece640 Mon Sep 17 00:00:00 2001 From: MORIMORI326 Date: Sun, 21 Sep 2025 16:25:06 +0300 Subject: [PATCH 1/2] Add VSCode MCP configuration and documentationCreate vscode-mcp-config.json - Add vscode-mcp-config.json with mcpServers configuration for Roblox Studio - Include setup instructions for VSCode users - Document proper file placement and configuration steps --- vscode-mcp-config.json | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 vscode-mcp-config.json diff --git a/vscode-mcp-config.json b/vscode-mcp-config.json new file mode 100644 index 0000000..3e12155 --- /dev/null +++ b/vscode-mcp-config.json @@ -0,0 +1,10 @@ +{ + "mcpServers": { + "Roblox Studio": { + "args": [ + "--stdio" + ], + "command": "Path-to-downloaded\rbx-studio-mcp.exe" + } + } +} From 4a8817a1839f21f8354acf1a81831b97d66a8504 Mon Sep 17 00:00:00 2001 From: MORIMORI326 Date: Sun, 21 Sep 2025 16:26:12 +0300 Subject: [PATCH 2/2] Add VSCode setup documentation and configurationUpdate README.md - Add comprehensive VSCode setup section to README - Include step-by-step instructions for VSCode MCP extension - Document configuration file placement and usage - Provide example settings.json configuration --- README.md | 64 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 34 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index d0ccaf0..a301552 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,13 @@ # Roblox Studio MCP Server -This repository contains a reference implementation of the Model Context Protocol (MCP) that enables -communication between Roblox Studio via a plugin and [Claude Desktop](https://claude.ai/download) or [Cursor](https://www.cursor.com/). -It consists of the following Rust-based components, which communicate through internal shared -objects. +This repository contains a reference implementation of the Model Context Protocol (MCP) that enables communication between Roblox Studio via a plugin and [Claude Desktop](https://claude.ai/download) or [Cursor](https://www.cursor.com/). It consists of the following Rust-based components, which communicate through internal shared objects. - A web server built on `axum` that a Studio plugin long polls. - A `rmcp` server that talks to Claude via `stdio` transport. -When LLM requests to run a tool, the plugin will get a request through the long polling and post a -response. It will cause responses to be sent to the Claude app. +When LLM requests to run a tool, the plugin will get a request through the long polling and post a response. It will cause responses to be sent to the Claude app. -**Please note** that this MCP server will be accessed by third-party tools, allowing them to modify -and read the contents of your opened place. Third-party data handling and privacy practices are -subject to their respective terms and conditions. +**Please note** that this MCP server will be accessed by third-party tools, allowing them to modify and read the contents of your opened place. Third-party data handling and privacy practices are subject to their respective terms and conditions. ![Scheme](MCP-Server.png) @@ -27,12 +21,10 @@ This MCP Server supports pretty much any MCP Client but will automatically set u To set up automatically: -1. Ensure you have [Roblox Studio](https://create.roblox.com/docs/en-us/studio/setup), - and [Claude Desktop](https://claude.ai/download)/[Cursor](https://www.cursor.com/) installed and started at least once. +1. Ensure you have [Roblox Studio](https://create.roblox.com/docs/en-us/studio/setup), and [Claude Desktop](https://claude.ai/download)/[Cursor](https://www.cursor.com/) installed and started at least once. 1. Exit MCP Clients and Roblox Studio if they are running. 1. Download and run the installer: - 1. Go to the [releases](https://github.com/Roblox/studio-rust-mcp-server/releases) page and - download the latest release for your platform. + 1. Go to the [releases](https://github.com/Roblox/studio-rust-mcp-server/releases) page and download the latest release for your platform. 1. Unzip the downloaded file if necessary and run the installer. 1. Restart Claude/Cursor and Roblox Studio if they are running. @@ -55,12 +47,33 @@ To set up manually add following to your MCP Client config: On macOS the path would be something like `"/Applications/RobloxStudioMCP.app/Contents/MacOS/rbx-studio-mcp"` if you move the app to the Applications directory. +### VSCode Setup + +For VSCode users who want to use this MCP server with the MCP extension: + +1. Install the [MCP extension](https://marketplace.visualstudio.com/items?itemName=microsoft.vscode-mcp) for VSCode +2. Download the latest release from the [releases](https://github.com/Roblox/studio-rust-mcp-server/releases) page +3. Use the provided `vscode-mcp-config.json` file as a reference for your VSCode MCP configuration +4. Place the configuration in your VSCode settings or create a workspace-specific settings file +5. Update the `command` path in the configuration to point to your downloaded `rbx-studio-mcp.exe` file + +Example VSCode settings.json configuration: +```json +{ + "mcp.servers": { + "Roblox Studio": { + "args": ["--stdio"], + "command": "C:\\path\\to\\your\\rbx-studio-mcp.exe" + } + } +} +``` + ### Build from source To build and install the MCP reference implementation from this repository's source code: -1. Ensure you have [Roblox Studio](https://create.roblox.com/docs/en-us/studio/setup) and - [Claude Desktop](https://claude.ai/download) installed and started at least once. +1. Ensure you have [Roblox Studio](https://create.roblox.com/docs/en-us/studio/setup) and [Claude Desktop](https://claude.ai/download) installed and started at least once. 1. Exit Claude and Roblox Studio if they are running. 1. [Install](https://www.rust-lang.org/tools/install) Rust. 1. Download or clone this repository. @@ -73,29 +86,20 @@ To build and install the MCP reference implementation from this repository's sou - Sets up Claude to communicate with the MCP server. - Builds and installs the Studio plugin to communicate with the MCP server. -After the command completes, the Studio MCP Server is installed and ready for your prompts from -Claude Desktop. +After the command completes, the Studio MCP Server is installed and ready for your prompts from Claude Desktop. ## Verify setup To make sure everything is set up correctly, follow these steps: -1. In Roblox Studio, click on the **Plugins** tab and verify that the MCP plugin appears. Clicking on - the icon toggles the MCP communication with Claude Desktop on and off, which you can verify in - the Roblox Studio console output. -1. In the console, verify that `The MCP Studio plugin is ready for prompts.` appears in the output. - Clicking on the plugin's icon toggles MCP communication with Claude Desktop on and off, - which you can also verify in the console output. -1. Verify that Claude Desktop is correctly configured by clicking on the hammer icon for MCP tools - beneath the text field where you enter prompts. This should open a window with the list of - available Roblox Studio tools (`insert_model` and `run_code`). +1. In Roblox Studio, click on the **Plugins** tab and verify that the MCP plugin appears. Clicking on the icon toggles the MCP communication with Claude Desktop on and off, which you can verify in the Roblox Studio console output. +1. In the console, verify that `The MCP Studio plugin is ready for prompts.` appears in the output. Clicking on the plugin's icon toggles MCP communication with Claude Desktop on and off, which you can also verify in the console output. +1. Verify that Claude Desktop is correctly configured by clicking on the hammer icon for MCP tools beneath the text field where you enter prompts. This should open a window with the list of available Roblox Studio tools (`insert_model` and `run_code`). -**Note**: You can fix common issues with setup by restarting Studio and Claude Desktop. Claude -sometimes is hidden in the system tray, so ensure you've exited it completely. +**Note**: You can fix common issues with setup by restarting Studio and Claude Desktop. Claude sometimes is hidden in the system tray, so ensure you've exited it completely. ## Send requests 1. Open a place in Studio. 1. Type a prompt in Claude Desktop and accept any permissions to communicate with Studio. -1. Verify that the intended action is performed in Studio by checking the console, inspecting the - data model in Explorer, or visually confirming the desired changes occurred in your place. +1. Verify that the intended action is performed in Studio by checking the console, inspecting the data model in Explorer, or visually confirming the desired changes occurred in your place.