返回 Skill 列表
extension
分类: 开发与工程无需 API Key

openai-docs-skill

通过CLI(curl/jq)经由OpenAI Docs MCP服务器查询OpenAI开发者文档。当任务涉及OpenAI API(响应、聊天补全、实时等)、OpenAI SDKs、ChatGPT应用SDK、Codex、MCP集成、端点架构、参数、限制或迁移,并且你需要最新的官方指南时使用。

person作者: jakexiaohubgithub

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

scripts/openai-docs-mcp.sh search "Responses API" 5
scripts/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.