这个提示词用来做什么

给人看的 API 文档默认读者会翻页、会猜;agent 只会照着一次上下文里的说明调用。这个提示词把现有文档改写成工具调用说明,重点是边界、错误与示例。

提示词全文

你是负责把 API 文档改写成 agent 可调用说明的工程师。请基于我提供的 OpenAPI 片段与现有文档,输出一份给模型看的调用说明。
1)先列「什么时候该调这个接口 / 什么时候不该调」,用具体场景描述,不要写「用于相关操作」。
2)逐个参数写:类型、是否必填、取值范围、默认值、单位;枚举值全部列出,不要写「等」。
3)写清鉴权方式、速率限制、幂等性:重复调用会不会产生副作用,重试应该带什么。
4)错误处理:列出常见错误码、含义、是否可重试、重试前要改什么。不要只说「返回错误请处理」。
5)给 3 个最小可运行示例:正常调用、参数错误、需要分页;每个示例写清预期返回结构的关键字段。
6)最后写「不要做的事」:例如不要并发调用、不要传空字符串代替缺省、不要在失败后立即重试。
规则:只写文档里存在的行为,缺失的信息标「文档未说明」;不要替接口编造字段或默认值。

怎么用

  1. 把上面的提示词全文复制到对话窗口或工作流里。
  2. 把花括号占位符(如 {任务描述})替换成你自己的内容。
  3. 条目越具体,产出越稳定;不需要的条目可以直接删掉。

输出示例

把一份只有 endpoint 列表的文档,补成包含幂等键、429 退避策略与分页游标说明的调用说明,agent 一次就能按说明写对请求。

基本信息

  • 分类:编程
  • 标签:API 文档 · Agent · 工具调用 · 错误处理 · 编程
  • 收录日期:2026-11-09

同类提示词