Roxlit MCP 服务器
使用说明(Markdown 格式)
项目简介
- 该仓库实现了一个基于 MCP 协议的服务器进程 roxlit-mcp(可在多平台编译为 roxlit-mcp 或 roxlit-mcp.exe),通过标准输入输出与 MCP 客户端进行 JSON-RPC 通信。
- MCP 服务器接收来自客户端的请求(如 initialize、tools/list、tools/call、ping),在需要时通过 Roxlit launcher 的 HTTP 接口将 Luau 代码发送给 Roblox Studio 插件执行,并把结果通过 MCP 返回给客户端。
- 该实现与 Roxlit Launcher 紧密集成,能够调用 roxlit launcher 提供的 run_code 能力,实现“在 Studio 内执行 Luau 代码并返回结果”的能力。
主要功能点
- MCP 协议支持:实现 initialize、tools/list、tools/call、ping 等基本方法,符合 JSON-RPC 2.0 的请求/响应模式。
- 工具调用转发:当执行 tools/call 的 run_code 时,代理发送到 Roxlit launcher 的 MCP 中转端点,获取 Studio 的执行结果并返回给 MCP 客户端。
- 日志与错误处理:在执行过程中对错误情况进行封装,向 MCP 客户端返回标准的错误响应。
- 与 Roxlit Launcher 集成:通过 HTTP 请求转发 Luau 代码执行请求,读取并返回执行结果或错误信息。
- 端对端运行能力:设计为独立的可执行服务器,服务端实现明确,具备可运行性而非仅示例。
安装与运行步骤
- 需要环境:Rust(用于编译 roxlit-mcp 二进制),以及 Roxlit Launcher 的运行依赖(Launcher HTTP 服务在 http://127.0.0.1:19556 上监听)。
- 构建与运行:
- 编译 roxlit-mcp 二进制(在本仓库对应路径下生成 roxlit-mcp,可在 Windows 上生成 roxlit-mcp.exe)。
- 启动 Roxlit Launcher 并确保其 HTTP 服务已就绪(监听 19556 端口)。
- 将 MCP 客户端的进程 STDIN/STDOUT 与 roxlit-mcp 进程进行连接,发送 JSON-RPC 请求。
- 通信模式:MCP 客户端通过标准输入向 roxlit-mcp 发送 JSON-RPC 请求,roxlit-mcp 通过标准输出返回 JSON-RPC 响应。
服务器配置(给 MCP 客户端使用的配置信息,JSON 格式描述)
- 服务名称(serverName): roxlit
- 启动命令(command): roxlit-mcp.exe(Windows)或 roxlit-mcp(其他平台)
- 启动参数(args): []
- 说明:该配置用于 MCP 客户端知道如何启动并连接到 MCP 服务器;由于使用的是 STDIO 通道,客户端需要以进程间通信方式启动 roxlit-mcp 并将其标准输入/输出接入。
基本使用方法
- 向 MCP 服务器发送初始化请求,获取协议版本与服务器能力(如可用工具列表)。
- 使用工具调用接口 tools/call 传入要执行的 Luau 代码(如 run_code),服务器会将请求转发到 Roxlit Launcher,执行结果回传。
- 通过 ping 等简单心跳方法确认连接可用。
- 服务器返回的响应遵循 JSON-RPC 2.0 规范,包含 id、result 或 error 字段。
关键词 Roblox Studio, Luau 执行, JSON-RPC, 后端服务, 自动化
分类ID 6