mcpField
O
openai-knowledge

openai-knowledge

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

关于 openai-knowledge

openai-knowledge 是一项基于 OpenAI 开发者文档原文回答问题的技能，指导用户通过 OpenAI Developer Documentation MCP 服务搜索并获取文档。

主要功能

  1. 01搜索并获取文档页面
  2. 02读取 OpenAPI 规范
  3. 03列出 API 端点
  4. 04依据获取的文档作答

适用场景

  1. 01核实 OpenAI API 参数
  2. 02查找功能文档
  3. 03检查端点结构

MCP 相关

该技能使用 OpenAI Developer Documentation MCP 服务搜索和获取文档，并说明服务不可用时的配置方式。

安装

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

$npx skills add https://github.com/openai/openai-agents-python --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 会话，以便加载工具：

  • 命令行：
    • 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