OA0 = Omni AI 0
OA0 是一个探索 AI 的论坛
现在注册
已注册用户请  登录
OA0  ›  技能包  ›  solarpunk-evidence-logger:创建或更新 AgentSkills 技能记录

solarpunk-evidence-logger:创建或更新 AgentSkills 技能记录

 
  chatgp ·  2026-02-06 09:51:05 · 3 次点击  · 0 条评论  

名称: skill-creator
描述: 创建或更新 AgentSkills。在设计、构建或打包技能(包含脚本、参考文档和资源文件)时使用。


技能创建器

本技能为创建高效技能提供指导。

关于技能

技能是模块化、自包含的包,通过提供专业知识、工作流程和工具来扩展 Codex 的能力。可以将它们视为特定领域或任务的“入职指南”——它们将 Codex 从一个通用代理转变为具备特定程序性知识的专业代理,这些知识是任何模型都无法完全掌握的。

技能提供的内容

  1. 专业化工作流程 - 针对特定领域的多步骤程序。
  2. 工具集成 - 处理特定文件格式或 API 的说明。
  3. 领域专业知识 - 公司特定的知识、架构、业务逻辑。
  4. 捆绑资源 - 用于复杂和重复任务的脚本、参考文档和资源文件。

核心原则

简洁是关键

上下文窗口是公共资源。技能需要与 Codex 所需的一切共享上下文窗口:系统提示、对话历史、其他技能的元数据以及实际的用户请求。

默认假设:Codex 已经非常智能。 只添加 Codex 尚不具备的上下文。质疑每一条信息:“Codex 真的需要这个解释吗?”以及“这段文字是否值得其令牌成本?”

优先使用简洁的示例,而非冗长的解释。

设定适当的自由度

根据任务的脆弱性和可变性匹配具体的详细程度:

  • 高自由度(基于文本的指令):适用于存在多种有效方法、决策依赖上下文或启发式方法指导的情况。
  • 中自由度(带参数的伪代码或脚本):适用于存在首选模式、允许一定变化或配置影响行为的情况。
  • 低自由度(特定脚本,参数少):适用于操作脆弱易错、一致性至关重要或必须遵循特定顺序的情况。

将 Codex 想象成在探索一条路径:两侧是悬崖的狭窄桥梁需要具体的护栏(低自由度),而开阔的田野则允许多条路线(高自由度)。

技能的构成

每个技能都包含一个必需的 SKILL.md 文件和可选的捆绑资源:

技能名称/
├── SKILL.md (必需)
│   ├── YAML 前置元数据 (必需)
│   │   ├── name: (必需)
│   │   └── description: (必需)
│   └── Markdown 指令 (必需)
└── 捆绑资源 (可选)
    ├── scripts/          - 可执行代码 (Python/Bash 等)
    ├── references/       - 旨在根据需要加载到上下文中的文档
    └── assets/           - 输出中使用的文件 (模板、图标、字体等)

SKILL.md (必需)

每个 SKILL.md 包含:

  • 前置元数据 (YAML):包含 namedescription 字段。Codex 仅读取这些字段来决定何时使用该技能,因此清晰全面地描述技能是什么以及何时使用至关重要。
  • 正文 (Markdown):使用技能的说明和指南。仅在技能触发后(如果需要)加载。

捆绑资源 (可选)

脚本 (scripts/)

用于需要确定性可靠性或需要重复重写的任务的可执行代码(Python/Bash 等)。

  • 何时包含:当同一代码被反复重写或需要确定性可靠性时。
  • 示例:用于 PDF 旋转任务的 scripts/rotate_pdf.py
  • 优点:令牌效率高、确定性、可能无需加载到上下文中即可执行。
  • 注意:脚本可能仍需要被 Codex 读取以进行修补或特定环境调整。
参考文档 (references/)

旨在根据需要加载到上下文中,以指导 Codex 的流程和思考的文档和参考资料。

  • 何时包含:用于 Codex 在工作时应参考的文档。
  • 示例:用于财务架构的 references/finance.md、用于公司 NDA 模板的 references/mnda.md、用于公司政策的 references/policies.md、用于 API 规范的 references/api_docs.md
  • 使用场景:数据库架构、API 文档、领域知识、公司政策、详细的工作流程指南。
  • 优点:保持 SKILL.md 简洁,仅在 Codex 确定需要时加载。
  • 最佳实践:如果文件较大(>1 万字),请在 SKILL.md 中包含 grep 搜索模式。
  • 避免重复:信息应仅存在于 SKILL.md 或参考文件中,而非两者。对于详细信息,优先使用参考文件,除非它确实是技能的核心——这能保持 SKILL.md 简洁,同时使信息可被发现而不占用上下文窗口。在 SKILL.md 中仅保留必要的程序性指令和工作流程指南;将详细的参考资料、架构和示例移至参考文件中。
资源文件 (assets/)

不打算加载到上下文中,而是在 Codex 生成的输出中使用的文件。

  • 何时包含:当技能需要用于最终输出的文件时。
  • 示例:用于品牌资产的 assets/logo.png、用于 PowerPoint 模板的 assets/slides.pptx、用于 HTML/React 样板代码的 assets/frontend-template/、用于字体的 assets/font.ttf
  • 使用场景:模板、图像、图标、样板代码、字体、被复制或修改的示例文档。
  • 优点:将输出资源与文档分离,使 Codex 能够使用文件而无需将其加载到上下文中。

技能中不应包含的内容

技能应仅包含直接支持其功能的基本文件。不要创建多余的文档或辅助文件,包括:

  • README.md
  • INSTALLATION_GUIDE.md
  • QUICK_REFERENCE.md
  • CHANGELOG.md
  • 等等。

技能应仅包含 AI 代理完成手头任务所需的信息。不应包含关于创建它的过程、设置和测试程序、面向用户的文档等辅助性上下文。创建额外的文档文件只会增加混乱和困惑。

渐进式披露设计原则

技能使用三级加载系统来高效管理上下文:

  1. 元数据(名称 + 描述) - 始终在上下文中(约 100 词)。
  2. SKILL.md 正文 - 当技能触发时加载(< 5000 词)。
  3. 捆绑资源 - 根据 Codex 的需要加载(无限制,因为脚本无需读入上下文窗口即可执行)。

渐进式披露模式

将 SKILL.md 正文保持在基本内容且少于 500 行,以最小化上下文膨胀。接近此限制时,将内容拆分到单独的文件中。将内容拆分到其他文件时,必须在 SKILL.md 中引用它们并清晰地描述何时读取它们,以确保技能的读者知道它们的存在以及何时使用它们。

关键原则: 当技能支持多种变体、框架或选项时,仅在 SKILL.md 中保留核心工作流程和选择指南。将特定变体的详细信息(模式、示例、配置)移至单独的参考文件中。

模式 1:带参考的高级指南

# PDF 处理

## 快速开始

使用 pdfplumber 提取文本:
[代码示例]

## 高级功能

*   **表单填写**:完整指南请参阅 [FORMS.md](FORMS.md)
*   **API 参考**:所有方法请参阅 [REFERENCE.md](REFERENCE.md)
*   **示例**:常见模式请参阅 [EXAMPLES.md](EXAMPLES.md)

Codex 仅在需要时加载 FORMS.md、REFERENCE.md 或 EXAMPLES.md。

模式 2:特定领域的组织方式

对于包含多个领域的技能,按领域组织内容以避免加载无关上下文:

bigquery-skill/
├── SKILL.md (概述和导航)
└── reference/
    ├── finance.md (收入、账单指标)
    ├── sales.md (机会、销售渠道)
    ├── product.md (API 使用、功能)
    └── marketing.md (活动、归因)

当用户询问销售指标时,Codex 仅读取 sales.md。

同样,对于支持多个框架或变体的技能,按变体组织:

cloud-deploy/
├── SKILL.md (工作流程 + 提供商选择)
└── references/
    ├── aws.md (AWS 部署模式)
    ├── gcp.md (GCP 部署模式)
    └── azure.md (Azure 部署模式)

当用户选择 AWS 时,Codex 仅读取 aws.md。

模式 3:条件性细节

显示基本内容,链接到高级内容:

# DOCX 处理

## 创建文档

使用 docx-js 创建新文档。参见 [DOCX-JS.md](DOCX-JS.md)。

## 编辑文档

对于简单编辑,直接修改 XML。

**对于修订跟踪**:参见 [REDLINING.md](REDLINING.md)
**对于 OOXML 详细信息**:参见 [OOXML.md](OOXML.md)

Codex 仅在用户需要这些功能时读取 REDLINING.md 或 OOXML.md。

重要指南:

  • 避免深度嵌套的引用 - 保持引用文件距 SKILL.md 仅一级深度。所有引用文件都应直接从 SKILL.md 链接。
  • 结构化较长的引用文件 - 对于超过 100 行的文件,在顶部包含目录,以便 Codex 在预览时能看到完整范围。

技能创建流程

技能创建涉及以下步骤:

  1. 通过具体示例理解技能
  2. 规划可重用的技能内容(脚本、参考文档、资源文件)
  3. 初始化技能(运行 init_skill.py)
  4. 编辑技能(实现资源并编写 SKILL.md)
  5. 打包技能(运行 package_skill.py)
  6. 根据实际使用情况迭代

按顺序执行这些步骤,仅在有明确理由不适用时才跳过。

技能命名

  • 仅使用小写字母、数字和连字符;将用户提供的标题规范化为连字符格式(例如,"Plan Mode" -> plan-mode)。
  • 生成名称时,生成一个少于 64 个字符(字母、数字、连字符)的名称。
  • 优先使用描述动作的简短、动词引导的短语。
  • 当工具命名空间能提高清晰度或触发准确性时使用(例如,gh-address-comments, linear-address-issue)。
  • 技能文件夹的名称应与技能名称完全一致。

步骤 1:通过具体示例理解技能

仅当技能的使用模式已清晰理解时才跳过此步骤。即使处理现有技能,此步骤仍有价值。

要创建有效的技能,需清晰理解技能将如何使用的具体示例。这种理解可以来自直接的用户示例,也可以来自生成并经用户反馈验证的示例。

例如,在构建图像编辑器技能时,相关的问题包括:

  • “图像编辑器技能应支持哪些功能?编辑、旋转,还有其他吗?”
  • “你能给出一些这个技能将如何使用的例子吗?”
  • “我可以想象用户会提出诸如‘去除这张图片的红眼’或‘旋转这张图片’的要求。你还能想到这个技能的其他使用方式吗?”
  • “用户说什么会触发这个技能?”

为避免让用户不知所措,避免在单条消息中提出过多问题。从最重要的问题开始,并根据需要进行跟进以获得更好的效果。

当对技能应支持的功能有清晰认识时,结束此步骤。

步骤 2:规划可重用的技能内容

要将具体示例转化为有效技能,需分析每个示例:

  1. 考虑如何从头开始执行该示例。
  2. 识别在执行这些工作流程时,哪些脚本、参考文档和资源文件会有所帮助。

示例:在构建处理“帮我旋转这个 PDF”等查询的 pdf-editor 技能时,分析显示:

  1. 旋转 PDF 每次都需要重写相同的代码。
  2. 在技能中存储一个 scripts/rotate_pdf.py 脚本会很有帮助。

示例:在设计处理“给我构建一个待办事项应用”或“给我构建一个跟踪步数的仪表板”等查询的 frontend-webapp-builder 技能时,分析显示:

  1. 编写前端 Web 应用每次都需要相同的样板 HTML/React 代码。
  2. 在技能中存储一个包含样板 HTML/React 项目文件的 assets/hello-world/ 模板会很有帮助。

示例:在构建处理“今天有多少用户登录?”等查询的 big-query 技能时,分析显示:

  1. 查询 BigQuery 每次都需要重新发现表架构和关系。
  2. 在技能中存储一个记录表架构的 references/schema.md 文件会很有帮助。

通过分析每个具体示例,创建要包含的可重用资源列表:脚本、参考文档和资源文件,从而确定技能的内容。

步骤 3:初始化技能

此时,是时候实际创建技能了。

仅当正在开发的技能已存在,并且只需要迭代或打包时,才跳过此步骤。在这种情况下,请继续下一步。

从头开始创建新技能时,始终运行 init_skill.py 脚本。该脚本方便地生成一个新的模板技能目录,自动包含技能所需的一切,使技能创建过程更加高效可靠。

用法:

scripts/init_skill.py <技能名称> --path <输出目录> [--resources scripts,references,assets] [--examples]

示例:

scripts/init_skill.py my-skill --path skills/public
scripts/init_skill.py my-skill --path skills/public --resources scripts,references
scripts/init_skill.py my-skill --path skills/public --resources scripts --examples

该脚本:

  • 在指定路径创建技能目录。
  • 生成具有正确前置元数据和 TODO 占位符的 SKILL.md 模板。
  • 根据 --resources 选项可选地创建资源目录。
  • 当设置了 --examples 时,可选地添加示例文件。

初始化后,根据需要自定义 SKILL.md 并添加资源。如果使用了 --examples,请替换或删除占位符文件。

步骤 4:编辑技能

编辑(新生成或现有的)技能时,请记住,技能是为另一个 Codex 实例使用而创建的。包含对 Codex 有益且非显而易见的信息。考虑哪些程序性知识、领域特定细节或可重用资源能帮助另一个 Codex 实例更有效地执行这些任务。

学习成熟的设计模式

根据技能需求参考以下有用的指南:

  • 多步骤流程:关于顺序工作流程和条件逻辑,请参阅 references/workflows.md。
  • 特定输出格式或质量标准:关于模板和示例模式,请参阅 references/output-patterns.md。

这些文件包含了有效技能设计的既定最佳实践。

从可重用的技能内容开始

开始实施时,从上面确定的可重用资源开始:scripts/references/assets/ 文件。请注意,此步骤可能需要用户输入。例如,在实施 brand-guidelines 技能时,用户可能需要提供要存储在 assets/ 中的品牌资产或模板,或要存储在 references/ 中的文档。

添加的脚本必须通过实际运行来测试,以确保没有错误且输出符合预期。如果有很多类似的脚本,只需测试一个代表性样本,以确保它们都能正常工作,同时平衡完成时间。

如果使用了 --examples,请删除技能不需要的任何占位符文件。仅创建实际需要的资源目录。

更新 SKILL.md

写作指南: 始终使用祈使句/不定式形式。

前置元数据

编写包含 namedescription 的 YAML 前置元数据:

  • name:技能名称。
  • description:这是技能的主要触发机制,帮助 Codex 理解何时使用该技能。
    • 包含技能的功能以及使用它的具体触发条件/上下文。
    • 所有“何时使用”的信息都放在这里——而不是在正文中。正文仅在触发后加载,因此正文中的“何时使用此技能”部分对 Codex 没有帮助。
    • docx 技能的描述示例:“全面的文档创建、编辑和分析,支持修订跟踪、批注、格式保留和文本提取。当 Codex 需要处理专业文档(.docx 文件)时使用,例如:(1) 创建新文档,(2) 修改或编辑内容,(3) 处理修订跟踪,(4) 添加批注,或任何其他文档任务。”

不要在 YAML 前置元数据中包含任何其他字段。

正文

编写使用技能及其捆绑资源的说明。

步骤 5:打包技能

技能开发完成后,必须将其打包成可分发的 .skill 文件,以便与用户共享。打包过程首先会自动验证技能,以确保其满足所有要求:

scripts/package_skill.py <技能文件夹路径>

可选输出目录指定:

scripts/package_skill.py <技能文件夹路径> ./dist

打包脚本将:

  1. 自动验证技能,检查:
    • YAML 前置元数据格式和必填字段。
    • 技能命名规范和目录结构。
    • 描述的完整性和质量。
    • 文件组织和资源引用。
  2. 打包技能(如果验证通过),创建一个以技能命名的 .skill 文件(例如,my-skill.skill),其中包含所有文件并保持正确的目录结构以便分发。.skill 文件是一个带有 .skill 扩展名的 zip 文件。

如果验证失败,脚本将报告错误并退出,不创建包。修复任何验证错误,然后再次运行打包命令。

步骤 6:迭代

测试技能后,用户可能会请求改进。这通常发生在使用技能后不久,此时对技能的表现有清晰的记忆。

迭代工作流程:

  1. 在实际任务中使用技能。
  2. 注意遇到的困难或低效之处。
  3. 确定应如何更新 SKILL.md 或捆绑资源。
  4. 实施更改并再次测试。
3 次点击  ∙  0 人收藏  
登录后收藏  
目前尚无回复
0 条回复
About   ·   Help   ·    
OA0 - Omni AI 0 一个探索 AI 的社区
沪ICP备2024103595号-2
Developed with Cursor