名称: skill-creator 描述: 创建或更新AgentSkills。在设计、构建或打包技能时使用,包括脚本、参考资料和资产。
技能创建者
此技能提供创建有效技能的指导。
关于技能
技能是模块化、自包含的包,通过提供专业知识和工具扩展Codex的能力。将其视为特定领域或任务的“入门指南”——它们将Codex从通用代理转变为具备程序性知识的专业代理。
技能提供的内容
- 专业工作流 - 针对特定领域的多步骤程序
- 工具集成 - 使用特定文件格式或API的指令
- 领域专业知识 - 公司特定知识、模式、业务逻辑
- 打包资源 - 用于复杂和重复任务的脚本、参考资料和资产
核心原则
简洁是关键
上下文窗口是公共资源。技能与所有其他内容共享上下文窗口:系统提示、对话历史、其他技能的元数据和实际用户请求。
默认假设:Codex已经非常智能。 仅添加Codex尚不具备的上下文。质疑每条信息:“Codex真的需要这个解释吗?”和“这段文字是否值得其令牌成本?”
优先使用简洁示例而非冗长解释。
设置适当的自由度
将特异性水平与任务的脆弱性和可变性匹配:
高自由度(基于文本的指令):当多种方法有效、决策取决于上下文或启发式指导时使用。
中自由度(伪代码或带参数的脚本):当存在首选模式、接受一些变化或配置影响行为时使用。
低自由度(特定脚本、少量参数):当操作脆弱易错、一致性关键或必须遵循特定序列时使用。
将Codex视为探索路径:狭窄桥梁需要具体护栏(低自由度),而开放领域允许多条路线(高自由度)。
技能的解剖结构
每个技能包含一个必需的SKILL.md文件和一个可选的打包资源:
skill-name/
├── SKILL.md(必需)
│ ├── YAML前导元数据(必需)
│ │ ├── 名称: (必需)
│ │ └── 描述: (必需)
│ └── Markdown指令(必需)
└── 打包资源(可选)
├── 脚本/ - 可执行代码(Python/Bash等)
├── 参考资料/ - 需要时加载到上下文中的文档
└── 资产/ - 输出中使用的文件(模板、图标、字体等)
SKILL.md(必需)
每个SKILL.md包含:
- 前导元数据(YAML):包含
名称和描述字段。这些是Codex读取以确定何时使用技能的唯一字段,因此清晰全面地描述技能内容和触发条件非常重要。 - 正文(Markdown):使用技能的指令和指导。仅在技能触发后加载(如果有)。
打包资源(可选)
脚本(scripts/)
可执行代码(Python/Bash等),用于需要确定性可靠性或重复重写的任务。
- 何时包含:当同一代码被重复重写或需要确定性可靠性时
- 示例:
scripts/rotate_pdf.py用于PDF旋转任务 - 优点:令牌高效、确定性、无需加载到上下文中即可执行
- 注意:脚本可能仍需由Codex读取以进行修补或环境特定调整
参考资料(references/)
文档和参考资料,需要时加载到上下文中以指导Codex的过程和思考。
- 何时包含:用于Codex在工作时应参考的文档
- 示例:
references/finance.md用于财务模式、references/mnda.md用于公司NDA模板、references/policies.md用于公司政策、references/api_docs.md用于API规范 - 用例:数据库模式、API文档、领域知识、公司政策、详细工作流指南
- 优点:保持SKILL.md精简,仅在Codex确定需要时加载
- 最佳实践:如果文件较大(>10k字),在SKILL.md中包含grep搜索模式
- 避免重复:信息应位于SKILL.md或参考资料文件中,不要两者都放。优先将详细信息、模式和示例放入参考资料文件——这保持SKILL.md精简,同时使信息可发现而不占用上下文窗口。仅在SKILL.md中保留必要的程序性指令和工作流指导;将详细参考资料、模式和示例移到参考资料文件。
资产(assets/)
不打算加载到上下文中的文件,而是用于Codex生成的输出。
- 何时包含:当技能需要用于最终输出的文件时
- 示例:
assets/logo.png用于品牌资产、assets/slides.pptx用于PowerPoint模板、assets/frontend-template/用于HTML/React样板、assets/font.ttf用于排版 - 用例:模板、图像、图标、样板代码、字体、复制或修改的样本文档
- 优点:将输出资源与文档分离,使Codex能够使用文件而不加载到上下文中
技能中不应包含的内容
技能应仅包含直接支持其功能的基本文件。不要创建无关文档或辅助文件,包括:
- README.md
- INSTALLATION_GUIDE.md
- QUICK_REFERENCE.md
- CHANGELOG.md
- 等
技能应仅包含AI代理完成工作所需的信息。不应包含创建过程的辅助上下文、设置和测试程序、面向用户的文档等。创建额外文档文件只会增加混乱和困惑。
渐进式披露设计原则
技能使用三级加载系统以高效管理上下文:
- 元数据(名称 + 描述) - 始终在上下文中(约100字)
- SKILL.md正文 - 当技能触发时(<5k字)
- 打包资源 - 按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预览时能看到完整范围。
技能创建过程
技能创建涉及以下步骤:
- 通过具体示例理解技能
- 规划可重用技能内容(脚本、参考资料、资产)
- 初始化技能(运行init_skill.py)
- 编辑技能(实现资源和编写SKILL.md)
- 打包技能(运行package_skill.py)
- 基于实际使用迭代
按顺序遵循这些步骤,仅当有明确原因不适用时才跳过。
技能命名
- 仅使用小写字母、数字和连字符;将用户提供的标题规范化为连字符格式(例如,“Plan Mode” ->
plan-mode)。 - 生成名称时,生成少于64个字符的名称(字母、数字、连字符)。
- 优先使用简短、以动词引导的短语描述操作。
- 当提高清晰度或触发时,按工具命名空间(例如,
gh-address-comments、linear-address-issue)。 - 将技能文件夹名称与技能名称完全匹配。
步骤1:通过具体示例理解技能
仅当技能的使用模式已清晰理解时才跳过此步骤。即使处理现有技能时,它仍具有价值。
要创建有效技能,清晰理解技能将如何使用的具体示例。此理解可以来自直接用户示例或生成并经用户反馈验证的示例。
例如,构建图像编辑技能时,相关问题包括:
- “图像编辑技能应支持什么功能?编辑、旋转,还有其他吗?”
- “你能给出一些此技能如何使用的示例吗?”
- “我可以想象用户会请求诸如‘从此图像中移除红眼’或‘旋转此图像’之类的内容。你想象此技能还有其他使用方式吗?”
- “用户说什么会触发此技能?”
为避免使用户不知所措,避免在单个消息中询问太多问题。从最重要的问题开始,并根据需要跟进以提高有效性。
当对技能应支持的功能有清晰感时,结束此步骤。
步骤2:规划可重用技能内容
要将具体示例转化为有效技能,通过以下方式分析每个示例:
- 考虑如何从头执行示例
- 识别在执行这些工作流重复时哪些脚本、参考资料和资产会有帮助
示例:构建处理“帮助我旋转此PDF”查询的pdf-editor技能时,分析显示:
- 旋转PDF每次都需要重写相同代码
- 在技能中存储
scripts/rotate_pdf.py脚本会有帮助
示例:设计用于“为我构建一个待办事项应用”或“为我构建一个跟踪步数的仪表板”查询的frontend-webapp-builder技能时,分析显示:
- 编写前端Web应用每次都需要相同样板HTML/React
- 在技能中存储包含样板HTML/React项目文件的
assets/hello-world/模板会有帮助
示例:构建处理“今天有多少用户登录?”查询的big-query技能时,分析显示:
- 查询BigQuery每次都需要重新发现表模式和关系
- 在技能中存储记录表模式的
references/schema.md文件会有帮助
要建立技能内容,分析每个具体示例以创建要包含的可重用资源列表:脚本、参考资料和资产。
步骤3:初始化技能
此时,是实际创建技能的时候。
仅当开发的技能已存在且需要迭代或打包时才跳过此步骤。在这种情况下,继续下一步。
从头创建新技能时,始终运行init_skill.py脚本。该脚本方便地生成一个新的模板技能目录,自动包含技能所需的一切,使技能创建过程更高效可靠。
用法:
scripts/init_skill.py <skill-name> --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
写作指南: 始终使用祈使或不定式形式。
前导元数据
使用名称和描述编写YAML前导元数据:
名称:技能名称描述:这是技能的主要触发机制,帮助Codex理解何时使用技能。- 包含技能做什么以及何时使用的具体触发/上下文。
- 在此包含所有“何时使用此技能”的信息——不要在正文中。正文仅在触发后加载,因此正文中的“何时使用此技能”部分对Codex无益。
docx技能的描述示例:“全面文档创建、编辑和分析,支持追踪更改、评论、格式保留和文本提取。当Codex需要处理专业文档(.docx文件)时使用:(1)创建新文档,(2)修改或编辑内容,(3)处理追踪更改,(4)添加评论,或任何其他文档任务”
不要在YAML前导元数据中包含任何其他字段。
正文
编写使用技能及其打包资源的指令。
步骤5:打包技能
技能开发完成后,必须打包成可分发的.skill文件,与用户共享。打包过程首先自动验证技能以确保满足所有要求:
scripts/package_skill.py <路径/到/技能文件夹>
可选输出目录规范:
scripts/package_skill.py <路径/到/技能文件夹> ./dist
打包脚本将:
-
验证技能自动,检查:
- YAML前导元数据格式和必需字段
- 技能命名规范和目录结构
- 描述完整性和质量
- 文件组织和资源引用
-
打包技能如果验证通过,创建以技能命名的.skill文件(例如,
my-skill.skill),包含所有文件并保持适当的目录结构以进行分发。.skill文件是带有.skill扩展名的zip文件。
如果验证失败,脚本将报告错误并退出而不创建包。修复任何验证错误并再次运行打包命令。
步骤6:迭代
测试技能后,用户可能请求改进。这通常在使用技能后立即发生,带着技能性能的新鲜上下文。
迭代工作流:
- 在实际任务上使用技能
- 注意困难或低效之处
- 识别应如何更新SKILL.md或打包资源
- 实施更改并再次测试