Roblox Studio MCP 的作用
Roblox Studio MCP 是一个轻量级的 Node.js 和 TypeScript 服务器,通过模型上下文协议(Model Context Protocol)将 Roblox Studio 连接到 AI 编程助手。它为兼容的代理提供对 Roblox place 的结构化访问,使其能够理解层级结构并协助完成开发任务,而无需你离开编辑器。
服务器通过 WebSocket 或标准输入输出进行通信,同时由 Lua 插件使用 Roblox Studio API 在 Studio 内执行操作。支持的客户端包括 Claude Desktop、Cursor、Cline,以及通过兼容适配器接入的 ChatGPT。
安全模型:项目声明,所有操作均限制在 Studio 插件的沙箱内。它不提供内存操作或私有数据访问,也不会执行不受信任的代码。
主要功能
- 对象树读取器:浏览已打开 Roblox place 的完整层级结构。
- Lua 脚本编辑器:通过 AI 助手创建、读取和更新 Lua 脚本。
- 属性检查器:检查和修改 Roblox 实例属性。
- 试玩控制:从已连接的代理启动、暂停和停止试玩。
- 只读模式:探索项目,同时禁用破坏性操作。
- 自动发现:自动查找已打开的 Roblox Studio 会话。
- MCP 客户端支持:支持 Claude Desktop、Cursor、Cline,以及通过适配器接入的 ChatGPT。
- 轻量级架构:使用 Node.js 服务器和 WebSocket 通信,内存占用低。
开始之前
你必须拥有要检查或修改的 Roblox place 的编辑权限。你还需要 Roblox Studio、项目的 Studio 插件,以及兼容 MCP 的 AI 客户端。由于客户端配置会通过 npx 启动该软件包,因此系统中必须提供 Node.js 和 npm。
README 未提供 Lua 插件的详细手动安装说明。使用服务器前,请查阅仓库中可信的发布文件和文档,确认插件的安装和连接方式。
安装注意事项:README 的 Quick Start 链接到外部压缩包,要求用户运行
ProjectFiles.exe,并使用了“inject the script”(注入脚本)这一表述。运行外部下载内容前,请核实其来源和内容。优先使用可审计的源代码、官方仓库发布版本以及有文档说明的插件安装流程。
配置 Claude Desktop 或 Cursor
文档中的 MCP 配置会直接通过 npx 启动服务器。Claude Desktop 用户请打开 claude_desktop_config.json,Cursor 用户请打开 MCP 设置。
添加以下服务器定义:
{
"mcpServers": {
"roblox-studio": {
"command": "npx",
"args": ["-y", "roblox-studio-mcp"]
}
}
}
-y 参数允许 npx 在不显示交互式软件包安装提示的情况下继续执行。保存配置后,重启 AI 客户端,使其加载新的 MCP 服务器。
完成连接
- 打开 Roblox Studio。
- 打开一个你拥有编辑权限的 place。
- 确认项目的 Studio 插件已安装并处于启用状态。
- 在 Claude Desktop 或 Cursor 中保存 MCP 配置。
- 重启 AI 助手。
- 确认
roblox-studio服务器出现在客户端可用的 MCP 集成或工具列表中。
基本用法
读取对象树
先发送一个不会修改内容的请求,验证代理是否能够与 Studio 通信:
Show me the object tree of my Roblox place.
代理应调用 MCP 服务器,从 Studio 获取层级结构,并汇总或显示结果。这是一个实用的首次测试,因为它不需要修改 place。
检查实例
获取层级结构后,让助手检查某个特定对象。例如:
Find the SpawnLocation in the object tree and show me its properties.
请尽可能使用精确的实例名称。如果多个对象名称相同,请提供它们在层级结构中的位置,以便助手识别目标实例。
处理 Lua 脚本
服务器支持通过 AI 代理创建、读取和更新 Lua 脚本。谨慎的工作流程应从读取现有脚本开始:
Read the script under ServerScriptService and explain what it does. Do not change anything.
了解当前实现后,再请求进行针对性的编辑:
Update the selected Lua script to add clear error handling. Show me the proposed changes before applying them.
具体工具和确认流程取决于所连接的 MCP 客户端。允许修改前,请仔细检查生成的 Lua 代码。
控制试玩
Roblox Studio MCP 包含运行、暂停和停止试玩的控制功能。示例请求包括:
Start a playtest for the current place.
Pause the current playtest.
Stop the playtest.
发出这些命令时,请保持 Roblox Studio 开启,以便服务器发现并与该会话通信。
配置服务器
项目提供用于控制网络、安全、日志记录和超时行为的环境变量:
RBX_MCP_PORT设置 WebSocket 端口,默认值为44755。RBX_MCP_SAFE_MODE可设置为true,以禁用破坏性操作。RBX_MCP_LOG_LEVEL接受debug、info、warn或error。RBX_MCP_TIMEOUT设置请求超时时间,单位为毫秒。
使用只读探索
在了解不熟悉场景的结构,或只需要架构上下文时,请启用安全模式:
RBX_MCP_SAFE_MODE=true
启用安全模式后,可以使用助手进行探索,同时禁止破坏性操作。当多个 Studio 实例处于打开状态,并且你希望降低意外更改的风险时,也建议使用此设置。
使用日志进行故障排查
如果客户端无法连接或请求超时,请暂时提高日志级别:
RBX_MCP_LOG_LEVEL=debug
使用调试日志排查发现和通信问题,然后恢复为 info、warn 或 error
调整请求超时时间
较大的场景或较慢的操作可能需要更长的请求窗口。将 RBX_MCP_TIMEOUT 设置为所需的毫秒数。README 未规定具体值,因此请根据操作和环境谨慎调整。
高级工作流提示
- 从只读请求开始:在要求代理进行任何编辑前,先获取对象树并检查属性。
- 限定每项更改的范围:明确指出具体脚本或实例,并描述预期结果。
- 请求预览:在应用更改前,让助手说明拟执行的 Lua 或属性更改。
- 使用安全模式进行审计:分析架构或检查不熟悉的项目时,设置
RBX_MCP_SAFE_MODE=true。 - 谨慎处理多个会话:服务器可以自动发现多个已打开的 Studio 实例。请明确指出要使用的场景,并在探索期间保持安全模式启用。
- 保留恢复选项:在 AI 辅助编辑前保存场景,并使用常规的版本控制或备份流程。
- 使用明确的提示:将检查、修改和试玩拆分为独立请求,以便更容易审查每项操作。
故障排查清单
- 确认 Roblox Studio 已打开,并且你拥有该场景的编辑权限。
- 确认所需的 Lua 插件已安装并处于启用状态。
- 验证 MCP 客户端配置文件中的 JSON。
- 更改 MCP 设置后,重启 Claude Desktop 或 Cursor。
- 确认客户端进程可以使用 Node.js 和
npx。 - 检查默认 WebSocket 端口
44755是否可用。 - 设置
RBX_MCP_LOG_LEVEL=debug以收集更多诊断信息。 - 如果合法请求需要更多时间,请增大
RBX_MCP_TIMEOUT。
结语
Roblox Studio MCP 在 Roblox 开发与兼容 MCP 的 AI 助手之间提供了桥梁。完成配置后,它可以公开对象树、检查属性、编辑 Lua 脚本并控制试玩。请从只读探索开始,核实每项生成的更改,并在希望助手分析场景而不修改场景时使用安全模式。
