SuperAPI AI 工具集

openai-docs

编程与开发

查看项目

更新于 10-15 11:06

技能介绍

用途

本技能用于在用户询问如何使用 OpenAI 产品或 API 构建应用、询问 Codex 本身或如何选择 Codex 使用界面、以及需要最新官方文档时,提供来自 OpenAI 开发者文档的权威、当前指引。它同时负责模型选择、API 模型迁移和提示词升级方面的指导。

主要能力

  • 通过 developers.openai.com 的 MCP 服务器检索与获取 OpenAI 开发者文档。
  • 处理 API 参考、schema、参数或必填字段类问题,在可用时使用 OpenAPI 规范核对 API 形态。
  • 回答 Codex 自身相关问题:配置、扩展、操作、故障排查、本地状态、产品界面,以及 Codex 行为应放置的位置。
  • 处理模型选择、“最新模型”或默认模型问题,以及模型升级与提示词升级。
  • 提供 OpenAI 产品快照,包括 Apps SDK、Responses API、Chat Completions API、Codex、gpt-oss、Realtime API、Agents SDK。

使用方式

来源优先级:

  • Codex 自身知识走 Codex 来源路径,由该路径决定何时使用手册助手、Docs MCP 或有限不确定性。
  • 非 Codex 的 OpenAI 文档问题,先用 mcp__openaiDeveloperDocs__search_openai_docs 查找最相关文档页。
  • 回答前用 mcp__openaiDeveloperDocs__fetch_openai_doc 获取相关页面;若搜索噪声大,改用更窄的 Docs MCP 搜索;已知或找到任何可能的官方 OpenAI 文档 URL 时,先尝试通过 Docs MCP 获取该 URL。
  • API 参考、schema、参数或必填字段问题,在可用时用 mcp__openaiDeveloperDocs__get_openapi_spec 核对 API 形态。
  • 仅在需要浏览或发现非 Codex 页面且无明确查询时,使用 mcp__openaiDeveloperDocs__list_openai_docs。
  • 模型选择、“最新模型”或默认模型问题,先获取 https://developers.openai.com/api/docs/guides/latest-model.md;不可用时加载 references/latest-model.md。
  • 模型升级或提示词升级,仅当目标为 latest/current/default 或未指定时运行 node scripts/resolve-latest-model-info.js;否则保留用户明确指定的目标。

Codex 自身知识来源路径:

  • 对 Codex 行为、设置、自定义、技能、插件、MCP、hooks、AGENTS.md、自动化、界面、本地状态或系统地图类宽泛问题,先复用同线程的新鲜手册与大纲路径;否则在正常可写会话中先运行技能本地助手:node <skill-dir>/scripts/fetch-codex-manual.mjs。
  • 助手默认按顺序选择第一个可用临时缓存目录:$TMPDIR/openai-docs-cache、%TEMP%\openai-docs-cache、%TMP%\openai-docs-cache、/private/tmp/openai-docs-cache、/tmp/openai-docs-cache。
  • 助手会校验新鲜度、写入 codex-manual.md 并生成 codex-manual.outline.md,用大纲定位相关手册章节。
  • 若因只读、无 shell 执行或无允许的临时缓存而跳过助手,下一来源是 Docs MCP:先 search_openai_docs,再对相关命中 fetch_openai_doc,之后才考虑网页回退。
  • 仅当手册不可用、助手失败、不允许临时缓存、其他重要声明缺失或可能过时,或用户明确需要页面级引用时,才使用最窄的官方下一来源。
  • 若官方文档/手册与当前会话中已出现的可调用能力冲突,说明冲突并优先采用该环境中已验证的当前会话行为。

界面映射:当 Codex 名词或持久指令界面重叠时,推荐与范围匹配的最小界面:提示词或线程上下文用于一次性任务约束;AGENTS.md 用于持久仓库约定;项目 .codex/config.toml 用于受信任仓库的 Codex 设置;全局配置或全局指引用于跨仓库个人默认值;Skill 用于可复用任务工作流;Plugin 用于可安装捆绑包;MCP 服务器或应用连接器用于实时外部数据/操作;Automation 用于计划检查、提醒、监控或后续工作;Hook 用于工具调用、命令或文件编辑的生命周期强制。

若 MCP 服务器缺失:自行运行安装命令 codex mcp add openaiDeveloperDocs --url https://developers.openai.com/mcp;若因权限/沙箱失败,立即以升级权限重试同一命令并附一句理由;仅在升级尝试失败后请用户运行安装命令;请用户重启 Codex;重启后重新运行文档搜索/获取。

适用场景

  • 询问如何用 OpenAI 产品或 API 构建应用。
  • 询问 Codex 本身或如何选择 Codex 使用界面。
  • 需要最新官方 OpenAI 文档。
  • 模型选择、API 模型迁移、提示词升级。
  • API 参考、schema、参数或必填字段问题。

限制

  • API key 认证不代表拥有 ChatGPT、云任务或连接器访问权限。
  • 沙箱或网络拒绝需要带明确理由的范围化升级;破坏性命令、工作区外写入或广泛访问变更需要明确批准。
  • 记忆可提供用户偏好或上下文,但显式提示指令优先,且记忆不是当前外部事实的来源。
  • 模型升级应保持改动狭窄:仅更新活跃的 OpenAI API 模型默认值及直接相关提示词;历史文档、示例、评估基线、fixtures、提供商比较、提供商注册表、定价表、别名默认值、低成本回退路径及不明确的旧模型用法保持不变,除非用户明确要求升级。
  • 若升级需要 API 界面变更、schema 重连、工具处理器变更或超出字面模型字符串替换与提示词编辑的实现工作,应报告为受阻或需确认。
  • 若来源路径仍无法确立某项声明,返回有限不确定性或转介支持、管理员或产品反馈,而不是扩大调查。