name: 技能创建器 description: 创建有效技能的指南。当用户想要创建新技能(或更新现有技能)以通过专门知识、工作流或工具集成扩展Codex能力时,应使用此技能。 metadata: short-description: 创建或更新技能
技能创建器
此技能提供创建有效技能的指导。
关于技能
技能是模块化、自包含的文件夹,通过提供专门知识、工作流和工具来扩展Codex的能力。将它们视为特定领域或任务的“入门指南”——它们将Codex从通用代理转变为配备程序性知识的专门代理,这些知识是任何模型都无法完全掌握的。
技能提供的内容
- 专门工作流 - 针对特定领域的多步程序
- 工具集成 - 用于处理特定文件格式或API的说明
- 领域专业知识 - 公司特定知识、模式、业务逻辑
- 捆绑资源 - 用于复杂和重复任务的脚本、参考和资产
核心原则
简洁是关键
上下文窗口是公共资源。技能与Codex所需的一切共享上下文窗口:系统提示、对话历史、其他技能的元数据和实际用户请求。
默认假设:Codex已经非常智能。 仅添加Codex尚不具备的上下文。挑战每条信息:“Codex真的需要这个解释吗?”和“这段文字是否值得其token成本?”
优先使用简洁示例而非冗长解释。
设置适当的自由度
将特异性级别与任务的脆弱性和可变性匹配:
高自由度(基于文本的说明):当多种方法有效、决策取决于上下文或启发式方法指导时使用。
中自由度(伪代码或带参数的脚本):当存在首选模式、可接受一些变化或配置影响行为时使用。
低自由度(特定脚本,少数参数):当操作脆弱易错、一致性关键或必须遵循特定序列时使用。
将Codex视为探索路径:狭窄的桥梁和悬崖需要具体护栏(低自由度),而开阔的场地允许多种路线(高自由度)。
技能结构
每个技能由必需的SKILL.md文件和可选的捆绑资源组成:
技能名称/
├── SKILL.md(必需)
│ ├── YAML前置元数据(必需)
│ │ ├── name:(必需)
│ │ └── description:(必需)
│ └── Markdown说明(必需)
├── agents/(推荐)
│ └── openai.yaml - 技能列表和芯片的UI元数据
└── 捆绑资源(可选)
├── scripts/ - 可执行代码(Python/Bash等)
├── references/ - 文档,根据需要加载到上下文中
└── assets/ - 输出中使用的文件(模板、图标、字体等)
SKILL.md(必需)
每个SKILL.md包含:
- 前置元数据(YAML):包含
name和description字段。这些是Codex读取以确定何时使用技能的唯一字段,因此清晰全面地描述技能内容和使用时机非常重要。 - 主体(Markdown):使用技能及其捆绑资源的说明。仅在技能触发后加载(如果需要)。
Agents元数据(推荐)
- 面向UI的技能列表和芯片元数据
- 在生成值之前阅读references/openai_yaml.md,并遵循其描述和约束
- 通过阅读技能创建:面向用户的
display_name、short_description和default_prompt - 通过将值作为
--interface key=value传递给scripts/generate_openai_yaml.py或scripts/init_skill.py来确定性生成 - 更新时:验证
agents/openai.yaml是否仍与SKILL.md匹配;如果过时则重新生成 - 仅当明确提供时包括其他可选界面字段(图标、品牌颜色)
- 有关字段定义和示例,请参阅references/openai_yaml.md
捆绑资源(可选)
脚本(scripts/)
可执行代码(Python/Bash等),用于需要确定性可靠性或重复重写的任务。
- 何时包括:当同一代码被重复重写或需要确定性可靠性时
- 示例:用于PDF旋转任务的
scripts/rotate_pdf.py - 好处:token高效、确定性,可能无需加载到上下文中执行
- 注意:脚本可能仍需由Codex读取以进行补丁或环境特定调整
参考(references/)
文档和参考材料,旨在根据需要加载到上下文中,以告知Codex的流程和思考。
- 何时包括:用于Codex在操作中应参考的文档
- 示例:用于金融模式的
references/finance.md,用于公司NDA模板的references/mnda.md,用于公司政策的references/policies.md,用于API规范的references/api_docs.md - 用例:数据库模式、API文档、领域知识、公司政策、详细工作流指南
- 好处:保持SKILL.md精简,仅在Codex确定需要时加载
- 最佳实践:如果文件较大(>10k字),在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代理完成工作所需的信息。不应包括有关创建过程的辅助上下文、设置和测试程序、面向用户的文档等。创建额外文档文件只会增加混乱和混淆。
渐进式披露设计原则
技能使用三级加载系统来高效管理上下文:
- 元数据(名称 + 描述) - 始终在上下文中(约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)
- 验证技能(运行quick_validate.py)
- 基于实际使用迭代
按顺序遵循这些步骤,仅当有明确理由表明不适用时才跳过。
技能命名
- 仅使用小写字母、数字和连字符;将用户提供的标题规范化为连字符格式(例如,“Plan Mode” ->
plan-mode)。 - 生成名称时,生成一个少于64字符(字母、数字、连字符)的名称。
- 优先使用简短、以动词为首的短语描述操作。
- 当提高清晰度或触发时,按工具命名空间(例如,
gh-address-comments、linear-address-issue)。 - 技能文件夹名称与技能名称完全相同。
步骤1:通过具体示例理解技能
仅在技能的用法模式已清晰理解时跳过此步骤。即使处理现有技能,此步骤仍有价值。
要创建有效技能,清晰理解技能将如何使用的具体示例。此理解可以来自直接用户示例或生成并经用户反馈验证的示例。
例如,在构建图像编辑技能时,相关问题包括:
- “图像编辑技能应支持什么功能?编辑、旋转,还有其他吗?”
- “你能给出一些此技能如何使用的示例吗?”
- “我可以想象用户提出像‘从这张图像中去除红眼’或‘旋转这张图像’这样的请求。你想象此技能还有哪些其他用法?”
- “用户说什么应触发此技能?”
为避免压倒用户,避免在单个消息中问太多问题。从最重要的问题开始,根据需要跟进以提高效果。
当对技能应支持的功能有清晰认识时结束此步骤。
步骤2:规划可重复使用的技能内容
要将具体示例转化为有效技能,通过以下方式分析每个示例:
- 考虑如何从头执行示例
- 识别在执行这些工作流重复时哪些脚本、参考和资产会有帮助
示例:构建pdf-editor技能处理像“帮我旋转此PDF”这样的查询时,分析显示:
- 旋转PDF每次需要重写相同代码
- 一个
scripts/rotate_pdf.py脚本会有助于存储在技能中
示例:设计frontend-webapp-builder技能处理像“为我构建一个待办事项应用”或“为我构建一个跟踪步数的仪表板”这样的查询时,分析显示:
- 编写前端webapp每次需要相同的样板HTML/React
- 一个包含样板HTML/React项目文件的
assets/hello-world/模板会有助于存储在技能中
示例:构建big-query技能处理像“今天有多少用户登录?”这样的查询时,分析显示:
- 查询BigQuery每次需要重新发现表模式和关系
- 一个记录表模式的
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模板
- 使用通过
--interface key=value传递的代理生成的display_name、short_description和default_prompt创建agents/openai.yaml - 可选地,基于
--resources创建资源目录 - 当设置
--examples时,可选地添加示例文件
初始化后,根据需要自定义SKILL.md并添加资源。如果使用了--examples,替换或删除占位符文件。
通过阅读技能生成display_name、short_description和default_prompt,然后将它们作为--interface key=value传递给init_skill.py或使用以下命令重新生成:
scripts/generate_openai_yaml.py <路径/到/技能文件夹> --interface key=value
仅当用户明确提供其他可选界面字段时才包括它们。有关完整字段描述和示例,请参阅references/openai_yaml.md。
步骤4:编辑技能
编辑(新生成或现有)技能时,记住技能是为另一个Codex实例使用而创建的。包括对Codex有益且非显而易见的信息。考虑哪些程序性知识、领域特定细节或可重复使用资产能帮助另一个Codex实例更有效地执行这些任务。
学习已证实的设计模式
根据技能需求咨询这些有用指南:
- 多步过程:有关顺序工作流和条件逻辑,请参阅references/workflows.md
- 特定输出格式或质量标准:有关模板和示例模式,请参阅references/output-patterns.md
这些文件包含有效技能设计的已确立最佳实践。
从可重复使用的技能内容开始
开始实现时,从上述识别的可重复使用资源开始:scripts/、references/和assets/文件。注意,此步骤可能需要用户输入。例如,实现brand-guidelines技能时,用户可能需要提供存储在assets/中的品牌资产或模板,或存储在references/中的文档。
添加的脚本必须通过实际运行进行测试,以确保没有错误且输出符合预期。如果有许多类似脚本,仅需测试代表性样本以确保所有工作,同时平衡完成时间。
如果使用了--examples,删除技能不需要的任何占位符文件。仅创建实际需要的资源目录。
更新SKILL.md
写作指南:始终使用命令式/不定式形式。
前置元数据
使用name和description编写YAML前置元数据:
name:技能名称description:这是技能的主要触发机制,帮助Codex理解何时使用技能。- 包括技能做什么以及何时使用它的具体触发/上下文。
- 将所有“何时使用”信息包括在此处——而非在主体中。主体仅在触发后加载,因此主体中的“何时使用此技能”部分对Codex没有帮助。
- 例如,
docx技能的描述:“全面的文档创建、编辑和分析,支持跟踪更改、评论、格式保留和文本提取。当Codex需要处理专业文档(.docx文件)时使用,用于:(1) 创建新文档,(2) 修改或编辑内容,(3) 处理跟踪更改,(4) 添加评论,或任何其他文档任务”
不要在YAML前置元数据中包括任何其他字段。
主体
编写使用技能及其捆绑资源的说明。
步骤5:验证技能
技能开发完成后,验证技能文件夹以早期捕捉基本问题:
scripts/quick_validate.py <路径/到/技能文件夹>
验证脚本检查YAML前置元数据格式、必需字段和命名规则。如果验证失败,修复报告的问题并再次运行命令。
步骤6:迭代
测试技能后,用户可能请求改进。通常在使用技能后立即发生,新鲜地记得技能表现如何。
迭代工作流:
- 在实际任务中使用技能
- 注意困难或低效之处
- 识别应如何更新SKILL.md或捆绑资源
- 实施更改并再次测试