GitHub Copilot 提示文件实现「SQL 上线审查」:写法与调用
把「SQL 上线审查」交给智能体,难点不在模型能力,而在流程是否说清楚:输入是什么(待执行 SQL),按什么顺序处理,交付什么(审查结论),哪些事不能做。Skill 就是把这些写下来的载体。
本文介绍如何在 GitHub Copilot 指令与提示文件 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | SQL 上线审查(sql-review-checklist) |
| 作用 | 检查上线 SQL 的风险:无条件更新、大事务、锁 |
| 输入 | 待执行 SQL |
| 输出 | 审查结论 |
| 形态 | 纯提示词 |
| 风险 | 高 |
| 适用人群 | 后端与数据工程师 |
处理流程分四步:
- 检查 WHERE 条件
- 估算影响行数
- 检查事务大小
- 建议分批执行
这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用;属于高风险:涉及权限、个人信息或不可逆操作,Skill 只产出建议或草稿,执行前必须人工确认。
在 GitHub Copilot 指令与提示文件 中是什么形态
GitHub Copilot 支持仓库级自定义指令文件 .github/copilot-instructions.md,以及放在 .github/prompts/ 下、以 .prompt.md 结尾的可复用提示文件,适合把固定流程交给 Copilot Chat 或智能体模式执行。
仓库级指令对该仓库的对话默认生效;提示文件需要在支持的编辑器中手动调用,具体支持情况以 Copilot 文档为准。
示例配置
.github/prompts/sql-review-checklist.prompt.md 示例(示意):
---
description: SQL 上线审查
---
请对我提供的待执行 SQL执行「SQL 上线审查」:
1. 检查 WHERE 条件
2. 估算影响行数
3. 检查事务大小
4. 建议分批执行
输出格式:审查结论。
- 默认使用只读连接,任何写操作都要人工确认。
- 只输出建议、草稿或命令预览,不执行任何不可逆操作;需要执行时先请用户明确确认。
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在后端与数据工程师提出相关请求时能对上号;二是约束部分要写进「默认使用只读连接,任何写操作都要人工确认」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 在
.github/copilot-instructions.md中写入团队通用约定 - 新建
.github/prompts/sql-review-checklist.prompt.md写入本技能流程 - 在编辑器的 Copilot Chat 中调用该提示文件
- 检查输出是否遵循步骤与格式
- 提交到仓库并在 PR 中说明用途
实操:一次完整的运行
假设你在数据库客户端与查询工具中发出这样的请求(虚构示例):
用SQL 上线审查技能处理这份待执行 SQL,输出审查结论。
智能体识别到任务与「SQL 上线审查」相关后,会依次检查 WHERE 条件、估算影响行数、检查事务大小、建议分批执行。最终交付审查结论,并在末尾列出需要人工确认的内容。你的工作是对照原始待执行 SQL抽查两三处关键信息,确认无误后再使用。
测试与验收
在 Copilot Chat 中分别以有、无提示文件的方式处理同一任务,对比差异是否符合预期。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准待执行 SQL,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- 仓库级指令写得过细,与提示文件互相矛盾。
- 以为提示文件会自动生效,实际需要手动调用。
- 只写了步骤,没写交付格式,导致每次输出的审查结论结构不同。
- 高风险技能没有设置人工确认环节,智能体直接执行了不可逆操作。
延伸阅读
- SQL 上线审查 · 常见问题
- SQL 上线审查 · Cursor Rules 版
- SQL 上线审查 · MCP 服务 版
- 数据库问答 · GitHub Copilot 指令与提示文件 版
- SQL 查询编写 · GitHub Copilot 指令与提示文件 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。