SuperAPI AI 工具集

openai-knowledge

写作与研究

查看项目

更新于 10-15 15:38

技能介绍

用途

当某个集成方案或某项说法需要当前的外部证据支撑时,使用本技能检索权威的 OpenAI API 与平台文档。核心目标是把回答建立在检索到的确切文档文本之上,而不是凭空猜测。

主要能力

本技能通过 OpenAI 开发者文档 MCP 服务器来搜索并获取精确文档(Markdown 格式)。可用的工具类别包括:

  • mcp__openaiDeveloperDocs__search_openai_docs:先进行搜索,挑选最合适的 URL。
  • mcp__openaiDeveloperDocs__fetch_openai_doc:获取确切的 Markdown 内容,可选择附带锚点。
  • mcp__openaiDeveloperDocs__get_openapi_spec:在需要端点结构(schema)或参数时使用。
  • mcp__openaiDeveloperDocs__list_api_endpoints:列出 API 端点。

使用方式

工作流程如下:

  1. 检查 Docs MCP 服务器是否可用。若 mcp__openaiDeveloperDocs__* 工具可用,则直接使用它们;如果不确定,运行 codex mcp list 并检查其中是否存在 openaiDeveloperDocs。
  2. 使用 MCP 工具拉取确切文档:先搜索,再获取具体的页面。用 mcp__openaiDeveloperDocs__search_openai_docs 选定最佳 URL,再用 mcp__openaiDeveloperDocs__fetch_openai_doc 检索确切的 Markdown(可选带锚点)。需要端点结构或参数时,使用 get_openapi_spec 与 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

适用场景

适用于需要以 OpenAI 官方文档为权威依据的问答、集成核对与文档查证类任务,尤其是当回答依赖当前 API 细节、端点结构或参数时。

限制

资料未提供关于收费、价格、平台覆盖范围、效果承诺等方面的信息,暂未提供。技能本身要求在未获许可时不修改配置,并强调不得凭空编造文档内容。