article
README
🚀 罗布乐克斯工作室模型上下文协议服务器
罗布乐克斯工作室MCP服务器是一个独立实现模型上下文协议规范的服务器,专为与罗布乐克斯工作室和大语言模型(LLMs)集成而设计。它能让Roblox Studio通过统一协议,轻松实现无缝、安全且可脚本化的AI驱动工作流程。
🚀 快速开始
先决条件
- Node.js 18或更高版本(建议使用Node.js 20+)
- 已安装罗布乐克斯工作室(仅限Windows;如需配置路径,请参见下方说明)
- npm(随Node.js捆绑提供)
使用npx运行
npx roblex-mcp
- 第一次启动时,MCP会自动启动并尝试打开罗布乐克斯工作室。
- 如果您的罗布乐克斯工作室不在标准位置,请在
.env文件或系统环境变量中设置ROBLOX_STUDIO_PATH。
环境配置
复制并编辑示例环境文件:
cp .env.example .env
根据需要编辑.env文件(请参见下方关于ROBLOX_STUDIO_PATH的说明)。
罗布乐克斯开放云API密钥设置
为了启用自动化脚本和资产管理,必须提供有效的罗布乐克斯开放云API密钥。
- 访问罗布乐克斯开放云控制台。
- 按照指示创建并获取API密钥。
将生成的密钥添加到您的.env文件中,例如:
ROBLOX_API_KEY=your_api_key_here
克隆项目
git clone https://github.com/dmae97/roblex-studio-mcp-server.git
cd roblex-studio-mcp-server
安装依赖
npm install
构建项目
npm run build
启动服务
npm start
环境变量配置
创建或编辑.env文件,并添加以下内容:
ROBLOX_API_KEY=your_api_key_here
ROBLOX_STUDIO_PATH=path_to_robx_studio
将path_to_robx_studio替换为罗布乐克斯工作室的实际安装路径。
✨ 主要特性
- npx一行安装/运行:使用
npx roblex-mcp命令即可快速启动。 - 自动打开罗布乐克斯工作室:MCP启动后会自动打开罗布乐克斯工作室(仅限Windows)。
- 完整的MCP实现:全面支持模型上下文协议的核心功能。
- 多种传输模式:支持SSE或STDIO,提供灵活的集成方式。
- Claude Desktop/Anthropic Claude支持:开箱即用的集成。
- 安全性:TPA保护、输入sanitization(净化)、速率限制、CORS等安全措施。
- 可扩展性:轻松添加自定义工具和资源。
📚 详细文档
项目简介
罗布乐克斯工作室MCP服务器是一个独立实现模型上下文协议的服务器,旨在为罗布乐克斯工作室提供AI驱动的功能支持。
功能特性
- npx一行安装/运行:通过简单的命令即可启动服务。
- 自动打开罗布乐克斯工作室:在Windows系统上,MCP会自动启动罗布乐克斯工作室。
- 完整的协议支持:全面实现模型上下文协议的核心功能。
- 多种传输模式:支持SSE流式通信和标准输入输出(STDIO)。
- Claude Desktop集成:无缝对接Claude Desktop和Anthropic的Claude大语言模型。
- 安全性增强:内置TPA保护机制,确保输入净化、速率限制和CORS策略等安全措施。
项目贡献
欢迎各位开发者参与项目的开发与维护!请参考CONTRIBUTING.md了解具体贡献指南。
📄 许可证
本项目采用MIT许可证,具体内容详见LICENSE文件。
微信扫一扫