io.github.Justice219/roblox-studio-mcp
编码与调试by justice219
将 AI 助手连接到 Roblox Studio,可通过 14 个工具直接操作 DataModel。
什么是 io.github.Justice219/roblox-studio-mcp?
将 AI 助手连接到 Roblox Studio,可通过 14 个工具直接操作 DataModel。
README
Roblox Studio MCP Bridge
A Model Context Protocol (MCP) server that connects AI coding assistants like Claude Code directly to Roblox Studio. Read, create, modify, and delete instances in the DataModel — all from your terminal.
How It Works
Claude Code (MCP Client)
|
MCP Server (stdio)
|
HTTP Bridge (localhost:3001)
|
Studio Plugin (polls every 200ms)
|
Roblox Studio DataModel
The bridge has two halves:
- MCP Server (TypeScript) — Runs locally, exposes 14 tools via MCP over stdio, and serves an HTTP API on
localhost:3001 - Studio Plugin (Luau) — Polls the HTTP API for commands, executes them against the DataModel, and returns results
All write operations are wrapped in ChangeHistoryService, so every change can be undone with Ctrl+Z in Studio.
Available Tools
| Tool | Type | Description |
|---|---|---|
get_descendants | Read | Get all descendants with paths, optional maxDepth |
get_children | Read | Get immediate children of an instance |
get_properties | Read | Get serialized properties of an instance |
find_instances | Read | Search by className and/or namePattern |
get_services | Read | List all DataModel services |
get_selection | Read | Get currently selected instances in Studio |
create_instance | Write | Create a new Instance with properties |
set_properties | Write | Modify properties on an existing instance |
delete_instance | Write | Destroy an instance (undo-supported) |
clone_instance | Write | Clone an instance to a new parent |
move_instance | Write | Reparent an instance |
set_selection | Write | Set the Studio selection |
insert_service | Write | Insert a service via game:GetService() |
execute_luau | Write | Execute arbitrary Luau code in the plugin context |
Paths use dot-notation starting from game, e.g. game.Workspace.SpawnLocation.
Prerequisites
- Node.js 18+
- Roblox Studio
- Rojo 7+ (aftman or standalone install)
Installation
1. Clone the repository
git clone https://github.com/Justice219/roblox-studio-mcp.git
cd roblox-studio-mcp
2. Install dependencies and build
npm install
npm run build
Or install directly from npm:
npm install -g @jamesworkbenchcrm/roblox-studio-mcp
3. Build and install the Studio plugin
Using Rojo:
rojo build plugin.project.json -o MCPBridge.rbxmx
Then copy the plugin file to your Roblox plugins folder:
| OS | Path |
|---|---|
| macOS | ~/Documents/Roblox/Plugins/MCPBridge.rbxmx |
| Windows | %LOCALAPPDATA%\Roblox\Plugins\MCPBridge.rbxmx |
Or build directly to the plugins folder:
# macOS
rojo build plugin.project.json -o ~/Documents/Roblox/Plugins/MCPBridge.rbxmx
# Windows
rojo build plugin.project.json -o "%LOCALAPPDATA%\Roblox\Plugins\MCPBridge.rbxmx"
4. Enable HttpService in Studio
Open Roblox Studio, then:
Home → Game Settings → Security → Allow HTTP Requests → ON
This is required for the plugin to communicate with the local MCP server.
5. Configure your MCP client
Add the server to your MCP client configuration.
Claude Code (~/.claude/settings.json):
{
"mcpServers": {
"roblox-studio": {
"command": "node",
"args": ["/absolute/path/to/roblox-studio-mcp/dist/index.js"]
}
}
}
Claude Desktop (claude_desktop_config.json):
{
"mcpServers": {
"roblox-studio": {
"command": "node",
"args": ["/absolute/path/to/roblox-studio-mcp/dist/index.js"]
}
}
}
Replace /absolute/path/to/ with the actual path where you cloned the repo.
6. Restart Studio and your MCP client
- Restart Roblox Studio (or reload plugins) — you should see an "MCP Bridge" button in the toolbar
- Restart Claude Code / your MCP client
- The plugin status widget will show a green dot when connected
Usage
Once connected, your AI assistant can manipulate Studio directly:
"Create a Part named SpawnPad in Workspace at position 0, 5, 0"
"Get all children of ServerScriptService"
"Find all instances with className RemoteEvent"
"Set the BrickColor of game.Workspace.SpawnPad to Bright green"
The assistant uses the MCP tools to read the DataModel, create instances, set properties, and more — all reflected live in Studio with full undo support.
Configuration
| Environment Variable | Default | Description |
|---|---|---|
MCP_BRIDGE_PORT | 3001 | HTTP bridge port |
MCP_BRIDGE_PORT=4000 npm start
Development
# Watch mode — recompiles on file changes
npm run dev
# Type-check without emitting
npm run typecheck
# Build
npm run build
# Start the server
npm start
Architecture
src/
├── index.ts # Entry point — wires up all components
├── types.ts # Interfaces, constants, command type definitions
├── mcp-server.ts # MCP tool definitions (14 tools with Zod validation)
├── http-bridge.ts # Express HTTP server (poll/result/heartbeat endpoints)
└── command-queue.ts # In-memory command queue with timeout management
plugin/
├── init.server.luau # Plugin entry point — polling loop, UI, toolbar
└── modules/
├── CommandRouter.luau # Dispatches commands to handlers
├── HttpClient.luau # HTTP requests to the bridge
├── PathResolver.luau # Dot-notation path ↔ Instance resolution
└── Serializer.luau # Roblox type ↔ JSON serialization
Security
- The HTTP bridge only binds to
127.0.0.1— it is never exposed to the network - Write operations are wrapped in
ChangeHistoryServicefor undo support - Commands timeout after 30 seconds
- Connection requires heartbeat every 10 seconds
execute_luauruns code in the plugin context with no sandboxing — only use with trusted input
Supported Roblox Types
The serializer handles bidirectional conversion for:
Vector3 · Vector2 · CFrame · Color3 · BrickColor · UDim · UDim2 · Rect · NumberSequence · ColorSequence · NumberRange · Enum · Instance · Font · PhysicalProperties · Ray
All types use a { _type: "TypeName", ... } JSON format for lossless round-tripping.
Troubleshooting
Plugin shows red dot / "Disconnected"
- Make sure the MCP server is running (
npm start) - Check that HttpService is enabled in Studio
- Verify the port matches (default
3001)
"Plugin not connected" error in Claude Code
- Open Studio and check the MCP Bridge toolbar button is enabled
- The plugin auto-starts on load — try reloading plugins
- Check Studio's Output window for error messages
Port already in use
- Another instance may be running. Kill it or use a different port:
bash
MCP_BRIDGE_PORT=4000 npm start
npm
npm install -g @jamesworkbenchcrm/roblox-studio-mcp
https://www.npmjs.com/package/@jamesworkbenchcrm/roblox-studio-mcp
License
MIT
常见问题
io.github.Justice219/roblox-studio-mcp 是什么?
将 AI 助手连接到 Roblox Studio,可通过 14 个工具直接操作 DataModel。
相关 Skills
网页构建器
by anthropics
面向复杂 claude.ai HTML artifact 开发,快速初始化 React + Tailwind CSS + shadcn/ui 项目并打包为单文件 HTML,适合需要状态管理、路由或多组件交互的页面。
✎ 在 claude.ai 里做复杂网页 Artifact 很省心,多组件、状态和路由都能顺手搭起来,React、Tailwind 与 shadcn/ui 组合效率高、成品也更精致。
前端设计
by anthropics
面向组件、页面、海报和 Web 应用开发,按鲜明视觉方向生成可直接落地的前端代码与高质感 UI,适合做 landing page、Dashboard 或美化现有界面,避开千篇一律的 AI 审美。
✎ 想把页面做得既能上线又有设计感,就用前端设计:组件到整站都能产出,难得的是能避开千篇一律的 AI 味。
网页应用测试
by anthropics
用 Playwright 为本地 Web 应用编写自动化测试,支持启动开发服务器、校验前端交互、排查 UI 异常、抓取截图与浏览器日志,适合调试动态页面和回归验证。
✎ 借助 Playwright 一站式验证本地 Web 应用前端功能,调 UI 时还能同步查看日志和截图,定位问题更快。
相关 MCP Server
GitHub
编辑精选by GitHub
GitHub 是 MCP 官方参考服务器,让 Claude 直接读写你的代码仓库和 Issues。
✎ 这个参考服务器解决了开发者想让 AI 安全访问 GitHub 数据的问题,适合需要自动化代码审查或 Issue 管理的团队。但注意它只是参考实现,生产环境得自己加固安全。
Context7 文档查询
编辑精选by Context7
Context7 是实时拉取最新文档和代码示例的智能助手,让你告别过时资料。
✎ 它能解决开发者查找文档时信息滞后的问题,特别适合快速上手新库或跟进更新。不过,依赖外部源可能导致偶尔的数据延迟,建议结合官方文档使用。
by tldraw
tldraw 是让 AI 助手直接在无限画布上绘图和协作的 MCP 服务器。
✎ 这解决了 AI 只能输出文本、无法视觉化协作的痛点——想象让 Claude 帮你画流程图或白板讨论。最适合需要快速原型设计或头脑风暴的开发者。不过,目前它只是个基础连接器,你得自己搭建画布应用才能发挥全部潜力。