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