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。

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

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

小夜