openai-docs-skill
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 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
searchorlistto find the best doc page, thenfetchthe 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
- Discover:
searchwith a focused query. If unsure, uselistto browse. - Read:
fetchthe most relevant URL (optionally add an anchor). - 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.
使用示例
查看来源仓库中的使用示例与配置说明。
查看来源 ↗来源历史
- 收录时间
- 2026-01-20
- 索引更新时间
- 2026-01-31
- Branch
- main
收录与同步日期属于本站记录。源码修改历史请查看来源仓库。
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!