roblox-docs

Roblox creator-docs 搜索

此技能依据 官方 文档回答 Roblox/Luau 问题，而不是凭记忆作答。它基于 Roblox/creator-docs 的本地自动更新克隆版本运行，因此内容保持最新，并且可以一次全文搜索所有类、数据类型、枚举、全局对象、库和指南——这是实时抓取单个文档页面无法做到的。

何时使用

这主要是供 你（Agent）使用的工具，帮助你在面对变化速度远快于训练数据的 API 时保持准确。不要等用户提出“查文档”的要求。遇到以下情况时使用：

• 不确定时。 你准备编写或建议调用某个 API（方法名称、参数、返回类型、枚举值、属性），但不能完全确定它是否正确且为最新。核实成本很低；而捏造签名会让用户浪费大量调试时间。
• 需要深入了解时。 任务所需的不只是名称，还包括行为、边缘情况、弃用信息、替代方案，或不同部分如何配合使用。
• 探索替代方案时。 针对目标存在不止一种 API 或方法，而你想比较文档实际推荐的方案。
• 制定计划时。 尤其是在规划阶段，确定方案之前——先查阅文档，避免计划建立在错误假设之上。基于真实 API 制定的计划，胜过之后还得推翻重来的计划。

有疑问时就查阅。这个工具的目的就是用有引用依据的事实取代自信的猜测。

为什么使用子 Agent

文档文件很大（单个类的 YAML 文件就可能有数千行）。直接把多个文件读入当前对话，会让原始参考文本淹没实际答案。因此，请将查找工作委派给 Explore 子 Agent：它会在自己的上下文中搜索并阅读全文，然后只返回简明且带引用的答案。这样可以保持你的上下文整洁。

使用方法

遇到 Roblox/Luau 问题时，使用下方的提示词派遣一个 Explore 子 Agent（通过 Agent 工具）。搜索脚本位于：

${CLAUDE_PLUGIN_ROOT}/skills/roblox-docs/scripts/robloxdocs.py

将该绝对路径和用户的问题代入此提示词：

你正在查找 Roblox 官方文档以回答问题。 使用捆绑的搜索工具——不要抓取网页，也不要凭记忆作答。

1. 运行：python3 <SCRIPT_PATH> "<search query>" 首次运行会克隆文档（约 1 分钟）；之后的运行会复用缓存的克隆版本，并在缓存过期时自动拉取更新。该脚本会打印按相关度排序的 path:line 匹配项及其片段。
2. 选出最相关的文件，并用 Read 阅读全文（片段仅用于排序——真正的答案在文件中）。
3. 如果首次查询没有结果，换用其他词语再试（确切的 API 名称、相关类或该功能的通俗名称）。该工具接受带点号或冒号的形式，例如 TweenService:Create。
4. 返回简明答案：相关 API 签名或步骤、酌情提供简短代码示例，并将每条事实引用为克隆文档中的 path:line。如果文档确实未涵盖相关内容，请如实说明——不要捏造 API。

问题：<THE USER'S QUESTION>

然后将子 Agent 的答案转达给用户，并保留其中的引用。

注意事项

• 先决条件： PATH 中需要有 git 和 Python 3。如果存在，还会使用 ripgrep（rg）加快搜索，但它并非必需。
• 时效性： 克隆版本超过 24 小时后会自动拉取更新。若要强制刷新，子 Agent（或你）可以运行 python3 <SCRIPT_PATH> --update。
• 多个问题： 将相关查找合并到一个子 Agent 提示词中，让它一次搜索并阅读，而不是反复启动。
• 离线： 如果拉取失败，工具会回退到缓存的克隆版本并注明这一点——答案可能略有过时，但仍然可用。