把「密钥使用规范」做成 Claude Code Skill:SKILL.md 写法与上手
「密钥使用规范」是安全工程师与开发团队的高频任务。它的输入通常是项目配置,期望得到的是改进建议。这类有固定流程、又需要一点判断力的工作,很适合封装成智能体 Skill。
本文介绍如何在 Claude Code Skill 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 密钥使用规范(api-key-hygiene) |
| 作用 | 检查项目中密钥的存放与使用方式 |
| 输入 | 项目配置 |
| 输出 | 改进建议 |
| 形态 | 带脚本 |
| 风险 | 高 |
| 适用人群 | 安全工程师与开发团队 |
处理流程分四步:
- 查找硬编码密钥
- 检查环境变量与密钥管理
- 建议轮换
- 写规范
这个技能需要运行本地脚本(解析文件、调用命令行工具等),要求运行环境允许执行代码;属于高风险:涉及权限、个人信息或不可逆操作,Skill 只产出建议或草稿,执行前必须人工确认。
在 Claude Code Skill 中是什么形态
Claude Code 的 Agent Skills 以文件夹为单位:一个 SKILL.md(YAML 头写 name 与 description)加上可选的脚本和参考资料。智能体平时只看到 description,判断相关时才加载全文,所以 description 写得准不准,直接决定 Skill 会不会被用上。
个人级放在 ~/.claude/skills/,项目级放在仓库的 .claude/skills/,随代码一起提交,团队成员拉取后即可使用。
示例配置
.claude/skills/api-key-hygiene/
├── SKILL.md
├── scripts/api_key_hygiene.py
└── reference.md # 可选:团队规范、模板等长资料,按需加载
SKILL.md 示例(示意):
---
name: api-key-hygiene
description: 检查项目中密钥的存放与使用方式。当用户提到密钥使用规范、或给出项目配置并希望得到改进建议时使用。
---
# 密钥使用规范
## 输入
- 项目配置
- 若缺少关键信息,先列出需要补充的问题
## 步骤
1. 查找硬编码密钥
2. 检查环境变量与密钥管理
3. 建议轮换
4. 写规范
## 输出
- 改进建议
- 末尾附「需人工确认」清单(没有则写“无”)
## 约束
- 扫描结论需人工复核,涉及生产的动作走变更流程。
- 只输出建议、草稿或命令预览,不执行任何不可逆操作;需要执行时先请用户明确确认。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
## 脚本
- 需要解析或批量处理时运行 `python scripts/api_key_hygiene.py <路径>`,读取其输出后再总结
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在安全工程师与开发团队提出相关请求时能对上号;二是约束部分要写进「扫描结论需人工复核,涉及生产的动作走变更流程」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 在项目根目录新建
.claude/skills/api-key-hygiene/文件夹 - 写 SKILL.md:先写 name 和 description,再写步骤、输出与约束
- 需要确定性处理的部分放进 scripts/ 目录,在 SKILL.md 中写明何时调用
- 重新启动或新开会话,用一句自然语言描述任务,观察是否自动加载
- 把 Skill 提交到仓库,在 README 或 AGENTS.md 中登记
实操:一次完整的运行
假设你在代码、配置与云环境中发出这样的请求(虚构示例):
帮我做一下密钥使用规范,材料是附上的项目配置。
智能体识别到任务与「密钥使用规范」相关后,会依次查找硬编码密钥、检查环境变量与密钥管理、建议轮换、写规范。最终交付改进建议,并在末尾列出需要人工确认的内容。你的工作是对照原始项目配置抽查两三处关键信息,确认无误后再使用。
测试与验收
在新会话中用三种说法描述同一任务,确认 Skill 都能被触发;再用一个不相关请求确认它不会误触发。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准项目配置,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- description 写成口号(如“强大的助手”),智能体无法判断何时使用。
- 把大量参考资料塞进 SKILL.md 正文,拖慢每次加载;长资料应拆到单独文件按需读取。
- 只写了步骤,没写交付格式,导致每次输出的改进建议结构不同。
- 高风险技能没有设置人工确认环节,智能体直接执行了不可逆操作。
延伸阅读
- 密钥使用规范 · OpenAI Agents SDK 版
- 密钥使用规范 · GPTs 版
- 密钥使用规范 · 测试用例
- 审计日志设计 · Claude Code Skill 版
- 威胁建模 · Claude Code Skill 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。