Roblox Studio MCP服务器

Roblox Studio MCP服务器是一个独立的服务器实现,专为与Roblox Studio和LLMs集成设计,通过统一的协议实现无缝、安全且可脚本化的AI驱动工作流程。

  • by dmae97
  • TypeScript
  • 本地部署
  • 7 星标
  • 更新于
在 GitHub 查看 dmae97/roblex-studio-mcp-server

使用说明

Roblex Studio模型上下文协议服务器

Roblex Studio MCP服务器是 模型上下文协议 规范,专为与Roblox Studio和LLM集成而设计。它通过统一的协议在Roblox Studio中实现了无缝、安全和可脚本化的AI驱动工作流。

特性

  • npx单线安装/运行:立即启动 npx roblex-mcp
  • Roblox工作室自动启动:MCP启动并自动启动Roblox Studio(Windows)
  • 完整的MCP实施:支持所有核心模型上下文协议功能
  • 多种运输方式:SSE或STDIO用于灵活集成
  • 克劳德桌面/拟人克劳德支持:开箱即用的集成
  • 安全:TPA保护、输入消毒、速率限制、CORS等
  • 可扩展:轻松添加自定义工具/资源

快速开始

先决条件

  • Node.js 18或更高版本(建议使用Node.js 20+)
  • 已安装Roblox Studio(Windows;请参阅下面的启动路径)
  • npm(与Node.js捆绑在一起)

使用npx运行

npx roblex-mcp
  • 首次启动时,MCP将启动并尝试自动打开Roblox Studio。
  • 如果您的Roblox Studio不在标准位置,请设置 ROBLOX_STUDIO_PATH 您的环境变量 .env 文件或系统环境。

环境设置

复制并编辑示例环境文件:

cp .env.example .env

编辑 .env 根据需要(见下文ROBLOX_SDIO_PATH)。

Roblox/Open Cloud API密钥设置

要启用自动脚本和资产管理,您必须提供有效的Roblox Open Cloud API密钥。

  1. 转到 Roblox开放云仪表板.

  2. 点击 创建API密钥,选择所需的权限(例如“写入资产”、“读取Universe数据”),然后复制您生成的API密钥。

  3. 把这把钥匙放在你的 .env 文件:

    ROBLOX_API_KEY=your_api_key_here
    ROBLOX_OPEN_CLOUD_API_KEY=your_open_cloud_api_key_here
    
    • 永远不要分享你的密钥。像对待密码一样对待他们。
    • (可选)设置 ROBLOX_OPEN_CLOUD_UNIVERSE_ID 用于宇宙范围的操作。
  4. 编辑后重新启动MCP .env 以应用更改。

看 Roblox开放云文档 了解更多详情。

环境变量

所有配置都可以用 .env 文件。关键变量:

  • PORT:服务器端口(默认值:3001)

  • TRANSPORT_MODE:“sse”或“stdio”(默认值:“stdio“)

  • CLAUDE_DESKTOP_ENABLED:Claude桌面集成(默认值:true)

  • ROBLOX_STUDIO_PATH:RobloxStudio Beta.exe的完整路径(可选)。例子:

    ROBLOX_STUDIO_PATH=C:\Users\USER\AppData\Local\Roblox\Versions\version-04a222f011414c81\RobloxStudioBeta.exe
    
  • ROBLOX_API_KEY, ROBLOX_OPEN_CLOUD_API_KEY:来自Roblox开放云的API密钥; 必需的 对于大多数服务器功能。

看 .env.示例 对于所有选项。

运作原理

  • npx roblex mcp:

    • 启动MCP服务器(传输、工具、API、安全等)
    • 自动启动Roblox Studio
    • 可与克劳德桌面、开放云等集成。
  • 自定义工具和资源:

    • 通过扩展来添加您自己的 src/tools 和 src/resources 目录。

故障排除

  • Roblox工作室无法打开?

    • 集 ROBLOX_STUDIO_PATH 在你的 .env 走向你的全部道路 RobloxStudioBeta.exe.
  • API密钥错误或“未经授权”?

    • 请确保API密钥有效,具有正确的权限,并且在中设置 .env.
  • 权限错误或端口冲突?

    • 确保您有绑定服务器端口的权限,或在中选择非标准端口 .env.
  • TypeScript/模块错误?

    • 跑 npm install 和 npm run build 如果在本地开发,但npx用户不需要这个。
  • 未检测到Claude Desktop?

    • 确保 CLAUDE_DESKTOP_ENABLED=true 在……里面 .env 克劳德桌面正在运行。

发展

克隆、安装和构建:

git clone https://github.com/dmae97/roblex-studio-mcp-server.git
cd roblex-studio-mcp-server
npm install
npm run build
npm start

贡献

欢迎投稿!看 贡献.md 作为指导方针。

许可证

MIT许可证-请参阅 许可证


©2025 Roblex Studio MCP服务器贡献者