name: skill-creator 描述: 创建有效技能的指南。当用户想要创建新技能(或更新现有技能)以扩展Codex的能力,通过专业知识、工作流程或工具集成时,应使用此技能。 元数据: 简短描述: 创建或更新技能
技能创建器
此技能提供创建有效技能的指导。
关于技能
技能是模块化、自包含的文件夹,通过提供专业知识、工作流程和工具来扩展Codex的能力。将它们视为特定领域或任务的“入门指南”——它们将Codex从通用代理转变为具备过程知识的专业化代理,这些知识是任何模型都无法完全拥有的。
技能提供什么
- 专业化工作流程 - 针对特定领域的多步骤程序
- 工具集成 - 用于处理特定文件格式或API的说明
- 领域专业知识 - 公司特定知识、模式、业务逻辑
- 捆绑资源 - 用于复杂和重复任务的脚本、参考和资产
核心原则
简洁是关键
上下文窗口是公共资源。技能与Codex所需的一切共享上下文窗口:系统提示、对话历史、其他技能的元数据以及实际用户请求。
默认假设:Codex已经非常智能。 仅添加Codex尚不具备的上下文。质疑每一条信息:“Codex真的需要这个解释吗?”和“这段落是否证明其令牌成本合理?”
优先使用简洁示例而非冗长解释。
设置适当的自由度
匹配具体性级别与任务的脆弱性和可变性:
高自由度(基于文本的指令):当多种方法有效、决策依赖上下文或启发式指导方法时使用。
中等自由度(伪代码或带参数的脚本):当存在首选模式、可接受一些变化或配置影响行为时使用。
低自由度(特定脚本,少量参数):当操作脆弱易错、一致性至关重要或必须遵循特定序列时使用。
将Codex视为探索路径:狭窄桥梁有悬崖需要具体护栏(低自由度),而开阔田野允许多条路线(高自由度)。
技能结构
每个技能由必需的SKILL.md文件和可选捆绑资源组成:
技能名称/
├── SKILL.md(必需)
│ ├── YAML frontmatter元数据(必需)
│ │ ├── name:(必需)
│ │ └── description:(必需)
│ └── Markdown指令(必需)
├── agents/(推荐)
│ └── openai.yaml - 用于技能列表和芯片的UI元数据
└── 捆绑资源(可选)
├── scripts/ - 可执行代码(Python/Bash等)
├── references/ - 文档,旨在根据需要加载到上下文中
└── assets/ - 用于输出的文件(模板、图标、字体等)
SKILL.md(必需)
每个SKILL.md包含:
- Frontmatter(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 - 好处:令牌高效、确定性,可以在不加载到上下文的情况下执行
- 注意:脚本可能仍需要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”等查询的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 <技能名称> --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
脚本:
- 在指定路径创建技能目录
- 使用适当的frontmatter和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
编写指南:始终使用命令式或不定式形式。
Frontmatter
使用name和description编写YAML frontmatter:
name:技能名称description:这是技能的主要触发机制,帮助Codex理解何时使用技能。- 包括技能做什么以及何时使用的具体触发器/上下文。
- 在此包含所有“何时使用”信息——不要在正文中。正文仅在触发后加载,因此正文中的“何时使用此技能”部分对Codex无帮助。
- 例如,
docx技能的描述:“全面的文档创建、编辑和分析,支持跟踪更改、注释、格式保留和文本提取。当Codex需要处理专业文档(.docx文件)时使用: (1) 创建新文档, (2) 修改或编辑内容, (3) 处理跟踪更改, (4) 添加注释,或任何其他文档任务”
不要在YAML frontmatter中包含任何其他字段。
正文
编写使用技能及其捆绑资源的指令。
步骤5:验证技能
一旦技能开发完成,验证技能文件夹以早期捕捉基本问题:
scripts/quick_validate.py <路径/到/技能文件夹>
验证脚本检查YAML frontmatter格式、必需字段和命名规则。如果验证失败,修复报告的问题并再次运行命令。
步骤6:迭代
测试技能后,用户可能请求改进。通常这发生在使用技能后,对技能表现有新鲜上下文时。
迭代工作流程:
- 在实际任务中使用技能
- 注意困难或低效之处
- 识别SKILL.md或捆绑资源应如何更新
- 实施更改并再次测试