把「SQL 上线审查」交给智能体,难点不在模型能力,而在流程是否说清楚:输入是什么(待执行 SQL),按什么顺序处理,交付什么(审查结论),哪些事不能做。Skill 就是把这些写下来的载体。

本文以「SQL 上线审查」为例,逐段讲解 SKILL.md 的写法。SKILL.md 是 Claude Agent Skills 采用的格式:YAML 头 + Markdown 正文,其结构思路也适用于其他平台的规则文件与指令。

完整示例

---
name: sql-review-checklist
description: 检查上线 SQL 的风险:无条件更新、大事务、锁。当用户提到SQL 上线审查、或给出待执行 SQL并希望得到审查结论时使用。
---

# SQL 上线审查

## 输入
- 待执行 SQL
- 若缺少关键信息,先列出需要补充的问题

## 步骤
1. 检查 WHERE 条件
2. 估算影响行数
3. 检查事务大小
4. 建议分批执行

## 输出
- 审查结论
- 末尾附「需人工确认」清单(没有则写“无”)

## 约束
- 默认使用只读连接,任何写操作都要人工确认。
- 只输出建议、草稿或命令预览,不执行任何不可逆操作;需要执行时先请用户明确确认。

第一段:name

name 用小写字母和连字符,例如 sql-review-checklist,与文件夹名保持一致,方便检索和引用。不要用空格、中文或版本号。

第二段:description(最关键)

智能体平时只看得到 description,靠它判断要不要加载技能。好的 description 同时回答两件事:做什么(检查上线 SQL 的风险:无条件更新、大事务、锁),什么时候用(用户提到SQL 上线审查或给出待执行 SQL时)。

反例:“一个很有用的SQL 上线审查工具”——没有触发条件,智能体很难对上号。

第三段:输入与步骤

输入写清楚需要什么材料,并要求缺信息时先提问。步骤用编号列表,每步一个动作:

  1. 检查 WHERE 条件
  2. 估算影响行数
  3. 检查事务大小
  4. 建议分批执行

步骤是给智能体的执行顺序,不是给人看的说明书,越具体越好。

第四段:输出

写明交付物(审查结论)以及固定结构。建议统一附上“需人工确认”清单,让复核的人知道看哪里。

第五段:约束

约束写的是不能做什么、遇到什么情况要停下:

  • 默认使用只读连接,任何写操作都要人工确认。
  • 只输出建议、草稿或命令预览,不执行任何不可逆操作;需要执行时先请用户明确确认。

渐进式加载:把长资料拆出去

团队规范、长模板、术语表不要塞进 SKILL.md 正文,放到同目录的 reference.md 等文件中,在正文里写“需要时阅读 reference.md”。这样平时加载很轻,需要时再读取细节。

目录结构

.claude/skills/sql-review-checklist/
├── SKILL.md
└── reference.md      # 可选:团队规范、模板等长资料,按需加载

写完之后

用三种不同说法描述任务,看技能是否都能被触发;再用一个无关请求确认不会误触发。之后参考测试用例与效果评估持续改进。

领域注意事项

「SQL 上线审查」属于数据库与 SQL领域,使用者多是后端与数据工程师,工作环境通常是数据库客户端与查询工具。这个领域最重要的一条底线是:默认使用只读连接,任何写操作都要人工确认。

建议把这条底线原样写进技能的约束部分,而不是指望智能体自己意识到。同时,在团队内部明确:智能体给出的审查结论只是初稿或建议,最终由谁签字确认、出了问题由谁负责。

延伸阅读

说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。