rbx-iris

关键词

Roblox StudioLuauRustAI context serverStudio automation

使用说明（简明指南，便于快速上手）

  • 项目简介

    • rbx-iris 是一个完整的 MCP 服务器实现，围绕 Roblox Studio 提供的强大工具集，向 AI 客户端提供资源访问、工具执行和提示渲染等能力。服务器通过 MCP 协议与客户端通信，支持在本地以不同传输方式接入，便于与你的 LLM 工作流无缝对接。

  • 主要功能点

    • 资源与数据访问：提供对 Roblox Studio 数据与资源的查询与更新能力。
    • 工具注册与执行：暴露广泛的 Studio 工具集合，允许远程调用。
    • 提示与渲染：支持与 Prompt 模板和对话流程的集成，提供上下文信息。
    • 服务器端会话与能力声明：支持会话管理、能力声明、以及会话级权限控制。
    • 传输协议支持：实现 stdio、HTTP（带 MCP 端点的 /mcp 路径）、WebSocket 传输，满足不同客户端的接入需求。
    • Roblox Studio 插件与插件机制：服务端内嵌 Luau 插件并自动在 Studio 中安装与连接。

  • 安装步骤

    • 安装工具链：请在具备 Rust 开发环境的机器上编译本项目（需要 Rust、cargo、以及相关依赖）。
    • 构建与运行：
      • 使用 Cargo 构建并运行服务器（默认会启动 MCP 服务端，详见下方“运行模式”）。
      • 如需开发调试，可直接运行 cargo run。
    • 运行模式（两种模式任选其一）：
      • stdio 传输模式（默认在本地以标准输入输出与 MCP 客户端对接）：
        • 运行命令包含虚拟的 MCP 客户端，例如 Claude Desktop/Cursor 等直接从本地通过 stdio 与服务器通信。
      • HTTP/WebSocket 传输模式（通过 /mcp 路径提供 MCP 端点，/ws 提供 Roblox Studio 连接的 WebSocket 通道）：
        • 使用本地或远程的 MCP 客户端连接，读取/写入 MCP 请求与响应。
    • 运行后端会监听在 127.0.0.1:44756（默认端口），提供：
      • WebSocket 端点: ws://127.0.0.1:44756/ws
      • MCP HTTP 端点: http://127.0.0.1:44756/mcp

  • 服务器配置（MCP 客户端配置示例，供 Cursor/Claude 等工具使用）

    • MCP 客户端通常需要提供一个“服务器名称、启动命令及参数”的配置，用于启动并通过 MCP 与 Iris 服务器通信。
    • 下面给出一个准确对照仓库信息的示例配置（仅用作参考，实际请按你们的客户端 UI/CLI 配置）：
      • 服务器名称（server name）：Iris
      • 启动命令（command）：npx
      • 启动参数（args）：["-y", "--prefer-online", "github:UserGeneratedLLC/rbx-iris", "--stdio"] 注：该配置与仓库中 Quick Setup 的 Cursor/Claude 配置保持一致，指向本项目的远程实现并通过 stdio 传输。

  • 基本使用方法

    • 启动前提
      • 已安装 Roblox Studio、合适的 Node.js 版本（若使用快速设置脚本集成，请按仓库 README 提示准备环境）。
      • Rust 工具链已就绪，能够编译运行该 MCP 服务器实现。
    • 启动方式
      • 使用本地构建的二进制直接启动，在命令行进入项目根目录后执行 cargo run（如需调试，可使用 --stdio 以进入 stdio 传输模式，或使用 HTTP/WS 模式）。
      • 根据需要选择传输模式：stdio、HTTP(WebSocket)。
    • 与 Roblox Studio 的对接
      • 在 Roblox Studio 的插件或 Studio 端口设置中，启用 MCP 插件并确保网络连通（如使用本地测试，请确保端口无防火墙拦截）。
      • 启动后，MCP 客户端应能通过 Iris 服务器提供的工具列表、资源访问等能力进行对话式交互。
    • 常见操作
      • 通过 MCP 客户端发起请求（读取资源、执行工具、获取提示等），服务器端将路由到 Roblox Studio 插件（Luau 插件），执行并返回结构化的 JSON-RPC 响应。
      • 监控日志与指标：服务器提供运行时日志与性能指标，帮助你观测工具调用次数、错误率以及与 Studio 的连接状态。

  • 运行模式与接入要点

    • stdio 模式下，服务器通过标准输入输出与 MCP 客户端直接对接，适用于本地开发或集成在本地开发环境的工作流。
    • HTTP/WebSocket 模式下，服务器暴露 /mcp 端点供 MCP 客户端接入，/ws 提供 Studio 的 WebSocket 通信入口。该模式适合嵌入式或远程部署场景。
    • 客户端配置（示意，不作为代码块展示）
      • server name: Iris
      • command: npx
      • args: ["-y", "--prefer-online", "github:UserGeneratedLLC/rbx-iris", "--stdio"]

  • 额外信息

    • Iris 服务器具备会话管理、能力声明、日志记录与工具耗时统计等机制，便于与大模型/LLM 的对话进行可观测与追踪。
    • 仓库还包含一系列工具模块、数据存储、云服务、Luau 编译/分析等多种能力的实现，目标是为 LLM 提供丰富的 Roblox Studio 上下文与操作能力。

  1. 关键词 Roblox Studio, Luau, Rust, AI context server, Studio automation

  2. 分类ID 6

服务器信息

访问项目