mcpField
O
openai-docs

openai-docs

github.com/boshu2开发451733 次安装今天更新
代码仓库

关于 openai-docs

openai-docs 是一项技能，依据最新的 OpenAI 官方开发者文档回答问题。它通过 developers.openai.com MCP 服务搜索和获取页面，并优先使用这些来源而非网页搜索。

主要功能

  1. 01搜索 OpenAI 官方开发者文档
  2. 02获取指定页面与章节
  3. 03网页搜索前优先使用文档
  4. 04提供带来源的指导与引用
  5. 05支持 Codex 和 Claude Code 的 MCP 配置

适用场景

  1. 01查找 OpenAI API 任务的指南
  2. 02核实 Codex 已文档说明的能力
  3. 03回答 ChatGPT Apps SDK 相关问题
  4. 04查找开发者文档中的特定章节

MCP 相关

通过 developers.openai.com MCP 服务搜索、列出和获取 OpenAI 开发者文档。服务不可用时，技能会说明如何在 Codex 或 Claude Code 中配置。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/boshu2/agentops --skill openai-docs

安装后在 Claude Code 中输入/openai-docs确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

LICENSE.txt
agents/
openai.yaml
assets/
openai-small.svg
references/
openai-docs.feature
scripts/
validate.sh

详细介绍

OpenAI 文档

通过 developers.openai.com MCP 服务，提供权威且最新的 OpenAI 开发者文档指南。对于 OpenAI 相关问题，始终优先使用开发者文档 MCP 工具，而非 web.run。只有在 MCP 服务已安装但未返回有意义的结果时，才回退到网页搜索。

快速入门

  • 使用 mcp__openaiDeveloperDocs__search_openai_docs 查找最相关的文档页面。
  • 使用 mcp__openaiDeveloperDocs__fetch_openai_doc 获取准确章节，并准确引用或转述。
  • 仅在需要浏览或发现页面、且没有明确查询时，才使用 mcp__openaiDeveloperDocs__list_openai_docs。

OpenAI 产品概览

  1. Apps SDK：通过提供网页组件 UI 和 MCP 服务（向 ChatGPT 提供应用工具），构建 ChatGPT 应用。
  2. Responses API：统一端点，专为 Agent 工作流中的有状态、多模态、使用工具的交互而设计。
  3. Chat Completions API：根据由对话消息组成的列表生成模型响应。
  4. Codex：OpenAI 的编码 Agent，可编写、理解、审查和调试代码，适用于软件开发。
  5. gpt-oss：采用 Apache 2.0 许可证发布的开放权重 OpenAI 推理模型（gpt-oss-120b 和 gpt-oss-20b）。
  6. Realtime API：构建低延迟、多模态体验，包括自然的语音到语音对话。
  7. Agents SDK：用于构建 Agent 应用的工具包，模型可使用工具和上下文、移交任务给其他 Agent、流式传输部分结果，并保留完整追踪记录。

如果缺少 MCP 服务

如果 MCP 工具运行失败，或没有可用的 OpenAI 文档资源：

在 Codex 中：

  1. 运行：codex mcp add openaiDeveloperDocs --url https://developers.openai.com/mcp
  2. 如果因权限或沙盒限制而失败，请使用提升后的权限重试。
  3. 请用户重启 Codex，然后重新运行文档搜索/获取。

在 Claude Code 中：

  1. 在 ~/.claude/settings.json 的 "mcpServers" 下添加 MCP 服务： 
    {
  "mcpServers": {
    "openaiDeveloperDocs": {
      "type": "url",
      "url": "https://developers.openai.com/mcp"
    }
  }
}
  2. 重启 Claude Code，然后重新运行文档搜索/获取。

在其他 Agent 中： 请用户根据其 Agent 的文档配置 MCP 服务。

工作流

  1. 明确产品范围（Codex、OpenAI API 或 ChatGPT Apps SDK）和任务。
  2. 使用精确查询搜索文档。
  3. 获取最合适的页面和所需的具体章节（尽可能使用 anchor）。
  4. 提供简洁的指南，并引用文档来源。
  5. 仅在文档支持的情况下提供代码片段。

质量规范

  • 将 OpenAI 文档视为权威来源；避免臆测。
  • 引文应简短并符合政策限制；优先转述并附上引用。
  • 如果多个页面内容有差异，请指出差异并引用两者。
  • 如果文档未涵盖用户的需求，请说明情况并提供后续步骤。

工具使用说明

  • 对于 OpenAI 相关问题，始终先使用 MCP 文档工具，再进行任何网页搜索。
  • 如果 MCP 服务已安装但未返回有意义的结果，则回退到网页搜索。
  • 回退到网页搜索时，仅限官方 OpenAI 域名（developers.openai.com、platform.openai.com），并引用来源。

示例

OpenAI API 指南

用户说：“如何在 Responses API 中使用工具调用？”

执行过程：

  1. 在 OpenAI 文档 MCP 中搜索“Responses API tools”。
  2. 获取最相关的章节。
  3. 提供带引用的实现指南。
Codex 功能确认

用户说：“Codex 是否支持只读审查工作流？”

执行过程：

  1. 通过 MCP 查询 Codex 文档。
  2. 获取相关标志/沙盒说明。
  3. 提供有来源支持的指南和限制。

故障排除

问题原因解决方案
MCP 文档搜索无结果未安装 MCP 服务安装 openaiDeveloperDocs MCP，重启 Codex，然后重试搜索
结果已过时或不清晰查询范围太广按产品和功能缩小查询范围，然后获取准确的页面章节
需要可引用的答案尚未获取来源回答前获取具体的文档章节
文档未涵盖该问题官方文档存在缺漏明确说明缺漏，并提供安全且尽力而为的指导

参考文档

  • references/openai-docs.feature — 可执行规范：搜索官方文档、获取并引用准确章节、基于文档而非记忆作答（soc-qk4b）

评论

支持 Markdown