正文内容
OpenAI 文档 MCP 技能
概述
通过 Shell 调用 OpenAI 开发者文档 MCP 服务,以搜索和获取权威的官方文档。在开展任何 OpenAI Platform 相关工作时,务必使用此技能,切勿依赖记忆或非官方来源。
核心规则
- 凡涉及 OpenAI API / SDK / Apps / Codex 的问题,或需要精确、最新文档时,必须使用本技能。
- 请通过
scripts/openai-docs-mcp.sh中的 CLI 封装脚本调用 MCP 服务(不得使用 Codex MCP 工具)。 - 先用
search或list定位最匹配的文档页面,再用fetch获取该页面(或指定锚点)的准确内容。 - 在响应中明确提供所使用的文档 URL,确保信息来源清晰可溯。
快速开始
scripts/openai-docs-mcp.sh search "Responses API" 5 scripts/openai-docs-mcp.sh fetch https://platform.openai.com/docs/guides/migrate-to-responses
工作流程
-
发现:使用
search执行聚焦式查询;若不确定关键词,可用list浏览索引。 -
阅读:对最相关的 URL 执行
fetch(可选添加锚点以定位具体章节)。 - 应用:摘要或直接引用相关内容,并附上原始文档 URL。
脚本参考
CLI 封装脚本位于 scripts/openai-docs-mcp.sh,底层通过 curl + jq 调用 https://developers.openai.com/mcp。
支持的子命令:
-
init:初始化并检查服务器能力; -
tools:列出 MCP 服务器上可用的工具; -
search:按查询词从文档索引中返回 JSON 格式的匹配结果;[limit] [cursor] -
list [limit] [cursor]:浏览文档索引; -
fetch:返回指定文档页(或带锚点的章节)的 Markdown 内容;[anchor] -
endpoints:列出 OpenAPI 接口端点; -
openapi:获取 OpenAPI 规范或代码示例(支持指定语言及是否仅返回代码)。[lang1,lang2] [code-only]
环境变量:
-
MCP_URL:用于覆盖默认的 MCP 端点地址。