name: “openai-docs” description: “当用户询问如何使用 OpenAI 产品或 API 构建并需要带有引用的最新官方文档时使用(例如:Codex、Responses API、Chat Completions、Apps SDK、Agents SDK、Realtime、模型能力或限制);优先使用 OpenAI 文档 MCP 工具,并限制任何回退浏览到官方 OpenAI 域名。” author: openai
OpenAI 文档
使用 developers.openai.com MCP 服务器从 OpenAI 开发者文档提供权威、当前的指导。始终优先使用开发者文档 MCP 工具而不是 web.run 来处理 OpenAI 相关问题。仅当 MCP 服务器已安装但返回无意义结果时,才应回退到网页搜索。
快速开始
- 使用
mcp__openaiDeveloperDocs__search_openai_docs查找最相关的文档页面。 - 使用
mcp__openaiDeveloperDocs__fetch_openai_doc拉取精确部分并准确引用/转述。 - 仅当需要浏览或发现页面而没有明确查询时,才使用
mcp__openaiDeveloperDocs__list_openai_docs。
OpenAI 产品快照
- Apps SDK:通过提供 Web 组件 UI 和向 ChatGPT 暴露应用工具的 MCP 服务器来构建 ChatGPT 应用。
- Responses API:为代理工作流中的有状态、多模态、工具使用交互设计的统一端点。
- Chat Completions API:从组成对话的消息列表生成模型响应。
- Codex:OpenAI 的软件开发编码代理,可以编写、理解、审查和调试代码。
- gpt-oss:以 Apache 2.0 许可证发布的开放式权重 OpenAI 推理模型(gpt-oss-120b 和 gpt-oss-20b)。
- Realtime API:构建低延迟、多模态体验,包括自然语音到语音对话。
- Agents SDK:用于构建代理应用的工具包,其中模型可以使用工具和上下文、传递给其他代理、流式传输部分结果并保持完整跟踪。
如果 MCP 服务器缺失
如果 MCP 工具失败或没有可用的 OpenAI 文档资源:
- 自行运行安装命令:
codex mcp add openaiDeveloperDocs --url https://developers.openai.com/mcp - 如果由于权限/沙盒化失败,立即重试相同命令并提升权限,包括一行批准理由。暂时不要要求用户运行它。
- 仅当提升尝试失败时,才要求用户运行安装命令。
- 要求用户重启 Codex。
- 重启后重新运行文档搜索/获取。
工作流程
- 澄清产品范围(Codex、OpenAI API 或 ChatGPT Apps SDK)和任务。
- 使用精确查询搜索文档。
- 获取最佳页面和所需的具体部分(尽可能使用
anchor)。 - 提供简洁的指导并引用文档来源。
- 仅当文档支持时才提供代码片段。
质量规则
- 将 OpenAI 文档视为真理来源;避免猜测。
- 保持引用简短且在策略限制内;更喜欢带引用的转述。
- 如果多个页面有差异,指出差异并引用两者。
- 如果文档未涵盖用户需求,说明并建议下一步。
工具说明
- 对于 OpenAI 相关问题,始终在使用网页搜索之前优先使用 MCP 文档工具。
- 如果 MCP 服务器已安装但返回无意义结果,则使用网页搜索作为回退。
- 回退到网页搜索时,限制到官方 OpenAI 域名(developers.openai.com、platform.openai.com)并引用来源。