如需查看完整的文档索引,请参阅 llms.txt。在文档页面的 URL 末尾加上 .md 即可查看该页面的 Markdown 版本。
主导航
主题
Codex

Codex 使用场景

构建 AI 操作向导

根据用户的操作进度调整引导,帮助他们学会使用您的应用。

难度 Advanced
时间跨度 Long-running

使用 Codex 为您的 Web 应用添加基于 WebMCP 的操作向导。向导会高亮显示下一步要使用的控件,说明如何操作,并根据用户当前的状态调整指引。每一步都由用户亲自完成。

最适合

  • 希望帮助新用户在 Web 应用中完成首个工作流的团队。
  • 需要根据登录状态、已连接的服务或当前打开的面板调整步骤的新手引导流程。
  • 需要用户学会使用控件并亲自操作的任务。

目录

    ← 所有使用场景

    构建 AI 操作向导

    根据用户的操作进度调整引导,帮助他们学会使用您的应用。

    使用 Codex 为您的 Web 应用添加基于 WebMCP 的操作向导。向导会高亮显示下一步要使用的控件,说明如何操作,并根据用户当前的状态调整指引。每一步都由用户亲自完成。

    Advanced
    Long-running

    使用 Codex 为您的 Web 应用添加基于 WebMCP 的操作向导。向导会高亮显示下一步要使用的控件,说明如何操作,并根据用户当前的状态调整指引。每一步都由用户亲自完成。

    Advanced
    Long-running

    最适合

    • 希望帮助新用户在 Web 应用中完成首个工作流的团队。
    • 需要根据登录状态、已连接的服务或当前打开的面板调整步骤的新手引导流程。
    • 需要用户学会使用控件并亲自操作的任务。

    起始提示词

    请为 [web app/repository] 添加操作向导,让 Codex 向用户演示如何 [complete one specific workflow]。 先了解应用现有的用户界面和状态管理方式,并阅读现有文档。使用 WebMCP,让 Codex 能够: - 通过稳定且含义明确的 ID、标签和描述,找到需要向用户介绍的界面元素 - 高亮显示目标元素并附上简短说明,也能取消高亮显示 - 读取选择下一步所需的界面状态 - 等待用户操作,然后读取更新后的状态 - 阅读应用的使用说明和相关文档 工作流应由用户亲自完成。将提供引导的工具与执行操作的工具分开,并保留应用现有的身份验证和权限检查。 先实现一个完整流程。复用现有组件和设计系统。在 Codex 可以调用 WebMCP 工具的浏览器环境中测试向导。测试应覆盖不同的初始状态、用户取消某一步骤的情况,以及目标元素尚不可见的情况。 请总结所做的更改、已验证的内容以及仍需完成的配置。未经我批准,请勿部署或发布。
    请为 [web app/repository] 添加操作向导,让 Codex 向用户演示如何 [complete one specific workflow]。 先了解应用现有的用户界面和状态管理方式,并阅读现有文档。使用 WebMCP,让 Codex 能够: - 通过稳定且含义明确的 ID、标签和描述,找到需要向用户介绍的界面元素 - 高亮显示目标元素并附上简短说明,也能取消高亮显示 - 读取选择下一步所需的界面状态 - 等待用户操作,然后读取更新后的状态 - 阅读应用的使用说明和相关文档 工作流应由用户亲自完成。将提供引导的工具与执行操作的工具分开,并保留应用现有的身份验证和权限检查。 先实现一个完整流程。复用现有组件和设计系统。在 Codex 可以调用 WebMCP 工具的浏览器环境中测试向导。测试应覆盖不同的初始状态、用户取消某一步骤的情况,以及目标元素尚不可见的情况。 请总结所做的更改、已验证的内容以及仍需完成的配置。未经我批准,请勿部署或发布。

    简介

    学习某些工作流程时,如果有人指给您看该去哪里、该选哪一项,您会更容易上手。您可以使用 Codex 为 Web 应用创建操作导览,让用户在引导下亲自完成每一步。

    通过 WebMCP 工具,Codex 可以查看应用的控件、状态和文档,再根据用户当前看到的界面给出下一步操作说明。对于尚未连接服务的用户和已经完成设置的用户,导览的第一步应有所不同。

    使用方法

    1. 在 Codex 中打开应用的代码仓库,选择一个需要引导用户完成的工作流程,例如连接服务或添加文件夹。
    2. 提供相关文档,并说明导览需要支持哪些初始状态。
    3. 在 Codex 中运行本页的入门提示词,添加导览目标和用于读取界面状态的工具,并让 Codex 能够访问应用的操作说明。
    4. 在 Codex 能够调用应用的 WebMCP 工具的浏览器环境中测试该流程。请 Codex 为您提供引导,然后亲自完成每一步。

    先把第一个导览限定在一个小范围内。确认它能引导用户从初始设置一直走到任务完成,再添加其他工作流程。

    示例:在 Runme 中添加 Google Drive 文件夹

    在 Runme 中,用户可以编辑笔记本,也可以通过文件资源管理器添加 Google Drive 文件夹并浏览自己的文件。导览能帮助新用户找到这些控件,熟悉操作流程。

    要进一步了解 Runme,您可以阅读《OpenAI 如何使用 Codex 自动完成重复性工作》。

    观看视频,了解 Codex 如何高亮显示 Runme 中的控件并解释其用途。视频下方的截图展示了另一个导览,专门引导用户添加 Google Drive 文件夹。

    用户可以用下面这句话开始 Google Drive 导览:

    请教我如何添加 Google Drive 文件夹。

    连接 Google Drive

    Codex 会检查是否已连接 Google Drive。如果尚未连接,Codex 会高亮显示 Connect Google Drive,请用户选择该控件并完成连接。

    Codex 在 Runme 中高亮显示“Connect Google Drive”,并说明如何开始连接。

    打开文件资源管理器

    连接完成后,Codex 会引导用户打开文件资源管理器。Codex 会根据应用更新后的状态给出下一步操作说明。

    Codex 高亮显示用于打开 Runme 文件资源管理器的控件。

    添加文件夹

    用户展开工具栏后,Codex 会高亮显示用于添加 Google Drive 文件夹的控件。整个过程由用户亲自操作,下次添加文件夹时,用户就知道去哪里找这个控件了。

    Codex 在 Runme 中高亮显示用于添加 Google Drive 文件夹的控件。

    为 Codex 提供引导用户所需的上下文

    Runme 为 Codex 提供三类上下文:导览目标、应用状态和文档。下列工具名称来自 Runme,您可以根据自己应用的情况实现相应功能。

    让 Codex 能找到控件

    为每个导览目标设置稳定且能体现其用途的 data-tour-id 值,并提供标签和说明。Runme 通过三个 WebMCP 工具让 Codex 访问这些控件:

    • listTargets 列出已注册的目标及其 ID、标签和说明。
    • showTourStep({ target, title?, message, placement? }) 高亮显示目标并展示说明。
    • dismiss 取消高亮显示。

    这样,Codex 就能识别控件并说明其用途,具体操作仍由用户完成。

    读取状态并等待用户操作

    Runme 在 React 外部维护导览相关状态,并通过控制器提供访问接口。其 getUiSnapshot 工具提供当前界面状态,其中包括登录状态。通过 waitForUiChange(...),Codex 可以等待界面发生变化,例如等待用户选中高亮显示的控件。

    请 Codex 在每次交互后重新读取状态。导览应根据应用中实际发生的变化决定是否进入下一步。仅仅显示了操作说明,还不足以推进导览。

    将操作说明与应用一起发布

    Runme 将 Markdown 文档打包到应用中,供 Codex 通过 WebMCP 访问:

    • readInstructionsForAIAgents 说明 Codex 应如何与应用及其工具交互。
    • listDocumentation() 列出可用的文档页面及各页简介。
    • getDocumentation({ name }) 以 Markdown 格式返回选定的页面。

    导览说明和工具可以随应用一起发布,无需为导览单独开发 Codex 插件。

    检查导览

    从不同的初始状态发出同一个请求。检查导览能否跳过已完成的设置步骤、等待用户操作,并在界面变化时调整操作说明。

    还应测试两种情况:用户取消某一步操作,以及目标控件尚未显示。Codex 应说明还缺少什么,或选择当前可执行的下一步操作。它不应仅仅因为高亮显示了某个按钮,就声称操作已经成功。

    身份验证、权限检查和用户操作都应沿用应用现有的流程。导览应帮助用户理解界面,同时遵循这些控制机制。

    后续可以尝试的提示词

    第一个流程可以正常运行后,您可以在同一聊天中继续提出请求:

    • “请在 Google Drive 已连接且文件资源管理器已关闭的情况下测试这个导览。”
    • “请让导览能够处理用户取消某一步操作后又要求继续的情况。”
    • “请为 [next workflow] 添加一个导览,复用现有的导览目标和状态工具。”

    相关使用场景