用 OpenAI Agents SDK 实现「迁移脚本编写」:工具与智能体代码
后端与数据工程师经常要做「迁移脚本编写」这类事:为结构变更编写可回滚的迁移脚本。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。
本文介绍如何在 OpenAI Agents SDK 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 迁移脚本编写(migration-writer) |
| 作用 | 为结构变更编写可回滚的迁移脚本 |
| 输入 | 变更需求 |
| 输出 | 迁移与回滚脚本 |
| 形态 | 纯提示词 |
| 风险 | 高 |
| 适用人群 | 后端与数据工程师 |
处理流程分四步:
- 确认当前结构
- 编写升级脚本
- 编写回滚脚本
- 评估锁表风险
这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用;属于高风险:涉及权限、个人信息或不可逆操作,Skill 只产出建议或草稿,执行前必须人工确认。
在 OpenAI Agents SDK 中是什么形态
OpenAI Agents SDK 是一个轻量的智能体开发框架,用 Agent 定义指令与工具,用 function_tool 把 Python 函数变成工具,用 Runner 运行,还支持多智能体交接与护栏。
代码运行在你自己的环境中,可接入日志与追踪;具体的包名、版本与模型配置以官方文档为准。
示例配置
# 示意代码:OpenAI Agents SDK(pip 包名与接口以官方文档为准)
from agents import Agent, Runner, function_tool
@function_tool
def load_migration_writer(path: str) -> str:
"""读取变更需求并返回文本。"""
with open(path, encoding="utf-8") as fh:
return fh.read()[:20000]
agent = Agent(
name="迁移脚本编写",
instructions="""
1. 确认当前结构
2. 编写升级脚本
3. 编写回滚脚本
4. 评估锁表风险
输出:迁移与回滚脚本。不确定的内容标注“需人工确认”。
""",
tools=[load_migration_writer],
)
result = Runner.run_sync(agent, "请处理 input.txt 中的变更需求")
print(result.final_output)
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在后端与数据工程师提出相关请求时能对上号;二是约束部分要写进「默认使用只读连接,任何写操作都要人工确认」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 安装 SDK 并配置模型访问凭据(放在环境变量中)
- 用 function_tool 定义读取或处理数据的工具
- 在 Agent 的 instructions 中写入技能步骤与约束
- 用 Runner 运行并打印结果
- 把它包装成命令行工具或接口供团队使用
实操:一次完整的运行
假设你在数据库客户端与查询工具中发出这样的请求(虚构示例):
用迁移脚本编写技能处理这份变更需求,输出迁移与回滚脚本。
智能体识别到任务与「迁移脚本编写」相关后,会依次确认当前结构、编写升级脚本、编写回滚脚本、评估锁表风险。最终交付迁移与回滚脚本,并在末尾列出需要人工确认的内容。你的工作是对照原始变更需求抽查两三处关键信息,确认无误后再使用。
测试与验收
为 Agent 写几条固定输入的回归用例,每次修改指令后重跑,比较输出结构。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准变更需求,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- 把密钥写在代码里提交。
- instructions 写得过长,关键约束被淹没。
- 只写了步骤,没写交付格式,导致每次输出的迁移与回滚脚本结构不同。
- 高风险技能没有设置人工确认环节,智能体直接执行了不可逆操作。
延伸阅读
- 迁移脚本编写 · 极简与进阶
- 迁移脚本编写 · 定制指南
- 迁移脚本编写 · AGENTS.md 版
- 数据质量规则 · OpenAI Agents SDK 版
- 恢复演练脚本 · OpenAI Agents SDK 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。