OpenAI 官方文档查询指引(OpenAI Developer Docs):先查官方文档,再作答

前言

回答 OpenAI API 相关问题时,最容易踩的坑是凭记忆答参数、端点和迁移步骤。模型与接口迭代快,记忆里的字段名和端点结构经常已经过时,答错了要到线上才发现。这个 Skill 把「查官方文档」固化成固定流程:通过 OpenAI Docs MCP 服务器搜索并抓取官方文档页面,再把带出处的内容整理成答复,避免依赖记忆或非官方来源。

这是什么

一句话定位:这是一个命令行查询 OpenAI 官方开发者文档的 Skill,把文档检索做成可复用的脚本调用。

  • 发布者:am-will,来源 clawhub,上游仓库 https://clawhub.ai/am-will/openai-docs
  • 当前版本:v1.0.0,License MIT-0,安全审计 Pass
  • SkillHub 数据:评分 100000,下载 6095 次,安装 130 次,分类 ai-agent,标签 requires_api_key=false(无需 API Key)

解决什么问题:当任务涉及 OpenAI API(Responses、Chat Completions、Realtime 等)、OpenAI SDK、ChatGPT Apps SDK、Codex、MCP 集成、端点结构、参数、限制或迁移时,需要最新官方指导,这个 Skill 提供统一的查询入口。

核心功能

1、通过 shell 脚本调用 OpenAI Docs MCP 服务器检索文档,脚本位于 skill 目录下的 scripts/openai-docs-mcp.sh,底层用 curl + jq 请求 https://developers.openai.com/mcp。

2、提供 7 个子命令:

  • init:初始化并查看 MCP 服务器能力
  • tools:列出 MCP 服务器上可用的工具
  • search <query> [limit] [cursor]:按关键词搜索文档索引,返回 JSON 命中结果
  • list [limit] [cursor]:浏览文档索引
  • fetch <url> [anchor]:抓取文档页面或锚点章节,返回 markdown
  • endpoints:列出 OpenAPI 端点
  • openapi <endpoint-url> [lang1,lang2] [code-only]:获取 OpenAPI schema 或代码示例

3、MCP_URL 环境变量可覆盖默认的 MCP 端点地址。

4、官方建议的标准工作流分三步:先 search(不确定时用 list 浏览)找到相关页面,再 fetch 抓取正文,最后在答复中引用所依据的文档 URL。

安装与启用

官方给出的安装命令:

openclaw skills install @am-will/openai-docs

Skill 页面同时提供 npx skills 方式安装。运行环境需要 curl 和 jq,标签 requires_api_key=false,不需要 OpenAI API Key。

使用前先确认脚本路径可用,脚本相对 skill 目录调用:

scripts/openai-docs-mcp.sh --help

说明:上游页面只给出 openclaw skills 这一种安装方式,资料中未核实 Cursor、Claude Code 等其他环境的专门安装路径,这里不写未经核实的步骤。

典型用法

按「搜索 → 抓取 → 引用」的顺序操作。先搜索:

bash scripts/openai-docs-mcp.sh search "Responses API" 5

这条命令在文档索引里检索 “Responses API”,返回前 5 条 JSON 命中,用于确定该读哪个页面。拿到最相关的 URL 后抓取正文:

scripts/openai-docs-mcp.sh fetch https://platform.openai.com/docs/guides/migrate-to-responses

fetch 返回页面的 markdown 内容,可以直接摘录或摘要。官方文档站支持锚点定位,需要精确到某个小节时在 URL 后追加锚点:

scripts/openai-docs-mcp.sh fetch <页面URL> <锚点>

答复用户时,附上实际使用的文档 URL,让出处可核对。

适用场景与注意

适合的场景:OpenAI API 接入(Responses、Chat Completions、Realtime 等)、SDK 选型与用法、ChatGPT Apps SDK、Codex 相关开发、MCP 集成、端点结构与参数查询、限额说明、接口迁移(如迁移到 Responses)等需要最新官方文档的场合。

注意事项:

  • 必须先查再用,不要凭记忆回答 OpenAI 平台相关问题,这是该 Skill 的核心规则。
  • 运行依赖 curl 和 jq,环境里缺一不可。
  • 脚本路径 scripts/openai-docs-mcp.sh 相对 skill 目录,切换工作目录后要用相对或绝对路径调用。
  • 内部走 MCP 服务器,不要改用 Codex MCP 工具访问文档。
  • 抓取到的页面内容以官方文档为准,文档更新后以最新页面为准。

结尾

这个 Skill 的价值不在于提供文档内容,而是把「先查官方文档、再给带引用的答复」变成固定动作,适合日常与 OpenAI API、SDK、Codex 打交道的开发者和编码智能体。安装与使用见官方地址:https://api.skillhub.cn/org-b6kzcl68/openai-docs,上游仓库:https://clawhub.ai/am-will/openai-docs。

羽毛球分组比赛记分
小程序二维码

欢迎使用《羽毛球分组比赛记分》微信小程序

小夜