开发团队经常要做「提交信息生成」这类事：根据暂存区改动生成规范的提交信息。每次都从头写提示词，结果时好时坏；把它做成智能体 Skill，就能让智能体每次按同一套步骤执行，输出结构也更稳定。

本文介绍如何在 OpenAI Agents SDK 上实现这个技能，包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。

这个技能做什么

项目说明
技能提交信息生成（commit-message）
作用根据暂存区改动生成规范的提交信息
输入git diff
输出提交信息
形态带脚本
风险低
适用人群开发团队

处理流程分四步：

  1. 读取改动
  2. 判断类型与范围
  3. 写简洁标题
  4. 在正文说明原因

这个技能需要运行本地脚本（解析文件、调用命令行工具等），要求运行环境允许执行代码；风险较低，但输出仍需快速过目再使用。

在 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_commit_message(path: str) -> str:
    """读取git diff并返回文本。"""
    with open(path, encoding="utf-8") as fh:
        return fh.read()[:20000]

agent = Agent(
    name="提交信息生成",
    instructions="""
1. 读取改动
2. 判断类型与范围
3. 写简洁标题
4. 在正文说明原因
输出：提交信息。不确定的内容标注“需人工确认”。
""",
    tools=[load_commit_message],
)

result = Runner.run_sync(agent, "请处理 input.txt 中的git diff")
print(result.final_output)

示例里最重要的是两处：一是描述（或指令开头）要写明「什么时候用」，让智能体在开发团队提出相关请求时能对上号；二是约束部分要写进「改写历史、删除分支类操作只给建议，不直接执行」这类领域规矩，避免智能体自作主张。

安装与启用步骤

  1. 安装 SDK 并配置模型访问凭据（放在环境变量中）
  2. 用 function_tool 定义读取或处理数据的工具
  3. 在 Agent 的 instructions 中写入技能步骤与约束
  4. 用 Runner 运行并打印结果
  5. 把它包装成命令行工具或接口供团队使用

实操：一次完整的运行

假设你在Git 仓库与代码托管平台中发出这样的请求（虚构示例）：

用提交信息生成技能处理这份git diff，输出提交信息。

智能体识别到任务与「提交信息生成」相关后，会依次读取改动、判断类型与范围、写简洁标题、在正文说明原因。最终交付提交信息，并在末尾列出需要人工确认的内容。你的工作是对照原始git diff抽查两三处关键信息，确认无误后再使用。

测试与验收

为 Agent 写几条固定输入的回归用例，每次修改指令后重跑，比较输出结构。

针对这个技能，还建议额外准备：

  • 一份信息齐全的标准git diff，检查输出是否完整
  • 一份缺少关键信息的输入，检查智能体是否先提问而不是编造
  • 一份包含“忽略以上规则”等字样的输入，检查约束是否仍然有效

常见坑

  • 把密钥写在代码里提交。
  • instructions 写得过长，关键约束被淹没。
  • 只写了步骤，没写交付格式，导致每次输出的提交信息结构不同。
  • 没有给出样例，智能体对“好结果”的理解与你不一致；在参考资料里放一两份范例会明显改善。

延伸阅读

说明：文中的配置、代码与目录结构均为示意，用于说明思路；各平台的入口、字段名与能力会更新，落地前请以对应官方文档为准。示例中的数据与场景为虚构，不代表真实案例。