mcpField
O
openai-knowledge

openai-knowledge

github.com/openai开发4.0k132 次安装1 天前更新
代码仓库

关于 openai-knowledge

一项通过 OpenAI Developer Documentation MCP 服务检索准确文档内容、回答 OpenAI 开发文档问题的技能。它指导 Codex 用户检查服务、先搜索再获取页面，并在需要时配置服务。

主要功能

  1. 01检查 OpenAI 文档 MCP 可用性
  2. 02先搜索再获取文档
  3. 03获取原始 Markdown 页面
  4. 04检索 API Schema 和端点列表
  5. 05指导配置 MCP 服务

适用场景

  1. 01依据文档核实 OpenAI API 细节
  2. 02查找相关开发文档页面
  3. 03工具不可用时配置文档 MCP

MCP 相关

使用 OpenAI Developer Documentation MCP 服务搜索和获取文档、OpenAPI 规范及端点列表。若服务未配置，该技能会提供设置说明。

安装

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

$npx skills add https://github.com/openai/openai-agents-js --skill openai-knowledge

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

附带文件agents/openai.yaml

详细介绍

OpenAI 知识

概述

使用 OpenAI Developer Documentation MCP 服务搜索并获取准确的文档（Markdown），然后依据这些文本作答，而不是猜测。

工作流

1) 检查 Docs MCP 服务是否可用

如果 mcp__openaiDeveloperDocs__* 工具可用，请使用它们。

如果不确定，请运行 codex mcp list 并检查是否有 openaiDeveloperDocs。

2) 使用 MCP 工具获取准确的文档
  • 先搜索，再获取特定页面。
    • mcp__openaiDeveloperDocs__search_openai_docs → 选择最合适的 URL。
    • mcp__openaiDeveloperDocs__fetch_openai_doc → 获取准确的 Markdown（可选使用 anchor）。
  • 需要端点架构或参数时，请使用：
    • mcp__openaiDeveloperDocs__get_openapi_spec
    • mcp__openaiDeveloperDocs__list_api_endpoints

根据获取的文本作答，并准确引用或转述。不要编造标志、字段名称、默认值或限制。

3) 如果未配置 MCP，请引导用户完成设置（除非用户要求，否则不要更改配置）

提供以下其中一种设置选项，然后请用户重启 Codex 会话，以便加载工具：

  • CLI：
    • codex mcp add openaiDeveloperDocs --url https://developers.openai.com/mcp
  • 配置文件（~/.codex/config.toml）：
    • 添加： 
      [mcp_servers.openaiDeveloperDocs]
url = "https://developers.openai.com/mcp"

另请提供链接：https://developers.openai.com/resources/docs-mcp#quickstart

评论

支持 Markdown