在 AGENTS.md 里写「密钥使用规范」技能:通用编码智能体都能用
「密钥使用规范」是安全工程师与开发团队的高频任务。它的输入通常是项目配置,期望得到的是改进建议。这类有固定流程、又需要一点判断力的工作,很适合封装成智能体 Skill。
本文介绍如何在 AGENTS.md 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 密钥使用规范(api-key-hygiene) |
| 作用 | 检查项目中密钥的存放与使用方式 |
| 输入 | 项目配置 |
| 输出 | 改进建议 |
| 形态 | 带脚本 |
| 风险 | 高 |
| 适用人群 | 安全工程师与开发团队 |
处理流程分四步:
- 查找硬编码密钥
- 检查环境变量与密钥管理
- 建议轮换
- 写规范
这个技能需要运行本地脚本(解析文件、调用命令行工具等),要求运行环境允许执行代码;属于高风险:涉及权限、个人信息或不可逆操作,Skill 只产出建议或草稿,执行前必须人工确认。
在 AGENTS.md 中是什么形态
AGENTS.md 是放在仓库根目录、写给编码智能体看的说明文件,多个编码智能体工具都会读取它。把常用流程写成其中的一个小节,就相当于给所有智能体装上同一个技能。
根目录的 AGENTS.md 对整个仓库生效;子目录也可以放自己的 AGENTS.md,就近补充或覆盖说明。
示例配置
AGENTS.md 中的小节示例(示意):
## 密钥使用规范(api-key-hygiene)
- 何时使用:用户需要检查项目中密钥的存放与使用方式
- 输入:项目配置
- 输出:改进建议
- 步骤:
1. 查找硬编码密钥
2. 检查环境变量与密钥管理
3. 建议轮换
4. 写规范
- 约束:
- 扫描结论需人工复核,涉及生产的动作走变更流程。
- 只输出建议、草稿或命令预览,不执行任何不可逆操作;需要执行时先请用户明确确认。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在安全工程师与开发团队提出相关请求时能对上号;二是约束部分要写进「扫描结论需人工复核,涉及生产的动作走变更流程」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 在仓库根目录打开(或新建)AGENTS.md
- 新增一个以技能名命名的小节,写清何时使用、输入、步骤与约束
- 引用项目里已有的命令和脚本,不要写不存在的命令
- 让智能体执行一次相关任务,检查是否遵循
- 随代码评审一起维护这个小节
实操:一次完整的运行
假设你在代码、配置与云环境中发出这样的请求(虚构示例):
帮我做一下密钥使用规范,材料是附上的项目配置。
智能体识别到任务与「密钥使用规范」相关后,会依次查找硬编码密钥、检查环境变量与密钥管理、建议轮换、写规范。最终交付改进建议,并在末尾列出需要人工确认的内容。你的工作是对照原始项目配置抽查两三处关键信息,确认无误后再使用。
测试与验收
让两个不同的编码智能体分别执行同一任务,对比是否都按小节中的步骤进行。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准项目配置,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- AGENTS.md 越写越长,变成没人维护的百科;每个小节保持一屏以内。
- 写了与实际不符的构建或测试命令,智能体会照做并失败。
- 只写了步骤,没写交付格式,导致每次输出的改进建议结构不同。
- 高风险技能没有设置人工确认环节,智能体直接执行了不可逆操作。
延伸阅读
- 密钥使用规范 · Function Calling 版
- 密钥使用规范 · 扣子(Coze)智能体与工作流 版
- 密钥使用规范 · 场景实录
- 审计日志设计 · AGENTS.md 版
- 威胁建模 · AGENTS.md 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。