SuperAPI AI 工具集
合作ENAI 行业资讯收藏
Skill 广场openai-docs

openai-docs

编程与开发

查看项目

更新于 10-15 03:31

技能介绍

用途

openai-docs 用于在回答 OpenAI 相关问题时，提供来自 OpenAI 开发者文档的权威、最新指导。它通过 developers.openai.com 的 MCP 服务器获取文档内容，并强调始终优先使用开发者文档 MCP 工具，而不是网络搜索。只有当 MCP 服务器已安装且返回无有效结果时，才回退到网络搜索。

主要能力

该技能围绕三个 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 服务器缺失时，技能给出安装指引：

在 Codex 中：

运行：codex mcp add openaiDeveloperDocs --url https://developers.openai.com/mcp

如果因权限或沙箱问题失败，请以提升的权限重试。

请用户重启 Codex，然后重新运行文档搜索/抓取。

在 Claude Code 中：

将 MCP 服务器添加到 ~/.claude/settings.json 的 "mcpServers" 下：

{ "mcpServers": { "openaiDeveloperDocs": { "type": "url", "url": "https://developers.openai.com/mcp" } } }

重启 Claude Code，然后重新运行文档搜索/抓取。

在其他智能体中：请用户根据其智能体文档配置 MCP 服务器。

工作流程为：

  1. 明确产品范围（Codex、OpenAI API 或 ChatGPT Apps SDK）和任务。
  2. 使用精确查询搜索文档。
  3. 抓取最佳页面和所需的具体章节（尽可能使用锚点）。
  4. 以简洁指导作答并引用文档来源。
  5. 仅在文档支持时提供代码片段。

适用场景

适用于需要基于 OpenAI 官方文档回答问题的场景，例如：

  • OpenAI API 指导：用户询问“如何在 Responses API 中使用工具调用？”时，搜索 OpenAI 文档 MCP 中的“Responses API tools”，抓取最相关章节，返回带引用的实现指导。
  • Codex 能力检查：用户询问“Codex 是否支持只读审查工作流？”时，通过 MCP 查询 Codex 文档，抓取标志/沙箱参考，给出有来源支持的指导与约束。

限制

质量规则要求：将 OpenAI 文档视为事实来源，避免推测；引用保持简短并符合政策限制，优先转述并附引用；如果多个页面存在差异，指出差异并同时引用；如果文档未覆盖用户需求，应明确说明并提供后续步骤。

工具使用注意事项：对于 OpenAI 相关问题，始终先使用 MCP 文档工具再进行任何网络搜索；如果 MCP 服务器已安装但返回无有效结果，则使用网络搜索作为回退；回退到网络搜索时，限制在官方 OpenAI 域名（developers.openai.com、platform.openai.com）并引用来源。

故障排查：

  • MCP 文档搜索无结果：原因是 MCP 服务器未安装；解决方法是安装 openaiDeveloperDocs MCP，重启 Codex，重试搜索。
  • 结果过时/不清晰：原因是查询过宽；解决方法是按产品 + 功能缩小查询范围，然后抓取精确页面章节。
  • 需要可引用的答案：原因是未抓取来源；解决方法是在回答前抓取具体文档章节。
  • 文档未覆盖问题：原因是官方文档存在空白；解决方法是明确说明空白并提供安全的最佳努力指导。

参考文档：references/openai-docs.feature — 可执行规范：搜索官方文档、抓取并引用精确章节、基于文档而非凭记忆（soc-qk4b）。