Skill 拆解
拆清楚 Skill 的每个组成部分。
Skill 的完整结构
`` my-skill/ ├── SKILL.md # [必需] 核心定义 ├── scripts/ # [可选] 可执行脚本 │ ├── process.py │ └── upload.js ├── references/ # [可选] 详细参考文档 │ ├── guide.md │ └── examples.md ├── assets/ # [可选] 静态资源 │ ├── template.json │ └── config.yaml └── agents/ # [可选] 平台扩展配置 └── openai.yaml # OpenAI/Codex 的界面、调用策略和依赖元数据 ``
SKILL.md 详解
Frontmatter(元数据)
``yaml --- name: code-reviewer # [可选] 唯一标识符,默认为目录名 description: | # 触发条件和功能描述(最重要的字段) 审查代码是否符合团队规范。 使用场景:用户请求 review 代码、提交 PR 前、或提到"代码审查"时。 whentouse: | # [可选] 补充触发条件,追加到 description 之后 当用户提到"review"、"代码检查"、"PR 审查"时触发。 --- ``
关键字段说明:
name(可选)
小写字母、数字和连字符,最长 64 字符 省略时默认使用目录名 简短且描述性
示例:
✅ code-reviewer ✅ multi-platform-adapter ❌ Code Reviewer(有空格) ❌ cr(太简短)
description(必需)
这是最重要的字段,决定 AI 什么时候调用这个 Skill。 Frontmatter 会被加载到系统提示词中,AI 根据 description 来判断当前任务是否需要调用这个 Skill。
这篇文档有问题?