Openai Docs Skill

am-will/codex-skills/skills/openai-docs-skill

作者 am-will9f954c3b63fda0d1875252009c196bf15072c1ca無授權條款1K 個星標收錄於 2026年10月9日更新於 2026年10月9日儲存庫2 個月前更新

Query the OpenAI developer documentation via the OpenAI Docs MCP server using CLI (curl/jq). Use whenever a task involves the OpenAI API (Responses, Chat Completions, Realtime, etc.), OpenAI SDKs, ChatGPT Apps SDK, Codex, MCP integrations, endpoint schemas, parameters, limits, or migrations and you need up-to-date official guidance.

AI 產生的概覽

透過命令列查詢 OpenAI 開發者文件 MCP 伺服器,取得最新的官方 API 與 SDK 指引。

功能
此技能將 OpenAI 開發者文件 MCP 伺服器包裝成命令列工具,使用 curl 與 jq 存取預設端點。它支援初始化伺服器、列出工具、搜尋或瀏覽文件索引、以 Markdown 形式取得文件頁面或錨點、列出 OpenAPI 端點,以及取得 OpenAPI 結構描述或程式碼範例等子命令。它會產出搜尋結果、擷取的文件文字,以及端點或結構描述資訊,並要求代理在回覆中註明所使用的文件網址。
適用情境
當任務涉及 OpenAI API、OpenAI SDK、ChatGPT Apps SDK、Codex、MCP 整合、端點結構描述、參數、限制或移轉,且需要最新官方文件時使用。它用於在 OpenAI 平台相關工作中取代依賴記憶或非官方來源的做法。
執行需求
需要具備 curl 與 jq 的命令列環境,並能存取 OpenAI 文件 MCP 端點(預設為 MCP_URL 環境變數覆寫)。技能附有可執行指令碼 scripts/openai-docs-mcp.sh。未提及需要憑證。

OpenAI Docs MCP Skill

Overview

Use the OpenAI developer documentation MCP server from the shell to search and fetch authoritative docs. Always do this for OpenAI platform work instead of relying on memory or non-official sources.

Core rules

  • Always use this skill for OpenAI API/SDK/Apps/Codex questions or when precise, current docs are required.
  • Query the MCP server via the CLI wrapper in scripts/openai-docs-mcp.sh (do not rely on Codex MCP tools).
  • Use search or list to find the best doc page, then fetch the page (or anchor) for exact text.
  • Surface the doc URL you used in your response so sources are clear.

Quick start

bash
scripts/openai-docs-mcp.sh search "Responses API" 5scripts/openai-docs-mcp.sh fetch https://platform.openai.com/docs/guides/migrate-to-responses

Workflow

  1. Discover: search with a focused query. If unsure, use list to browse.
  2. Read: fetch the most relevant URL (optionally add an anchor).
  3. Apply: summarize and/or quote relevant sections; include the URL.

Script reference

The CLI wrapper is at scripts/openai-docs-mcp.sh and uses curl + jq against https://developers.openai.com/mcp.

Subcommands:

  • init: initialize and inspect server capabilities.
  • tools: list available tools on the MCP server.
  • search <query> [limit] [cursor]: return JSON hits from the docs index.
  • list [limit] [cursor]: browse docs index.
  • fetch <url> [anchor]: return markdown for a doc page or section.
  • endpoints: list OpenAPI endpoints.
  • openapi <endpoint-url> [lang1,lang2] [code-only]: fetch OpenAPI schema or code samples.

Environment:

  • MCP_URL: override the default MCP endpoint.

來源與署名

來源:am-will/codex-skills位於skills/openai-docs-skill提交9f954c3

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架