关于 openai-docs
openai-docs 是一项技能,借助 OpenAI 官方开发者文档回答产品问题。它优先使用 MCP 文档工具,并规定搜索、获取内容和引用的流程。
主要功能
- 01搜索 OpenAI 开发者文档
- 02获取指定文档章节
- 03按需浏览文档
- 04回退至官方域名网页搜索
适用场景
- 01查找 OpenAI API 的最新指南
- 02核对 ChatGPT Apps SDK 细节
- 03回答 Codex 文档问题
MCP 相关
使用 developers.openai.com MCP 服务搜索、获取和列出 OpenAI 开发者文档;MCP 无可用结果时再回退到网页搜索。
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ davila7/ claude-code-templates --skill openai-docs安装后在 Claude Code 中输入/openai-docs确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
LICENSE.txtagents/openai.yamlassets/openai-small.svg详细介绍
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 产品概览
- Apps SDK:通过提供 Web 组件 UI 和一个向 ChatGPT 提供应用工具的 MCP 服务,构建 ChatGPT 应用。
- Responses API:一个统一的端点,专为具备状态、多模态、使用工具的 Agent 工作流交互而设计。
- Chat Completions API:根据一组构成对话的消息生成模型响应。
- Codex:OpenAI 的编码 Agent,可编写、理解、审查和调试代码,服务于软件开发。
- gpt-oss:OpenAI 的开放权重推理模型(gpt-oss-120b 和 gpt-oss-20b),采用 Apache 2.0 许可证发布。
- Realtime API:构建低延迟的多模态体验,包括自然语音到语音的对话。
- Agents SDK:用于构建 Agent 应用的工具包,模型可借助它使用工具和上下文、将任务交接给其他 Agent、流式传输部分结果,并保留完整追踪记录。
如果缺少 MCP 服务
如果 MCP 工具运行失败,或没有可用的 OpenAI 文档资源:
- 自行运行安装命令:
codex mcp add openaiDeveloperDocs --url https://developers.openai.com/mcp - 如果因权限或沙盒限制而失败,立即以提升的权限重试同一命令,并附上一句说明申请批准的理由。暂时不要要求用户运行该命令。
- 只有在提升权限后仍然失败,才请用户运行安装命令。
- 请用户重启 Codex。
- 重启后重新运行文档搜索和获取操作。
工作流
- 明确产品范围(Codex、OpenAI API 或 ChatGPT Apps SDK)和任务。
- 使用精确的查询搜索文档。
- 获取最佳页面及所需的具体章节(尽可能使用
anchor)。 - 提供简洁的指南,并引用文档来源。
- 仅在文档支持时提供代码片段。
质量规则
- 将 OpenAI 文档视为事实来源;避免猜测。
- 引文应简短并符合政策限制;优先转述并附上引用。
- 如果多个页面的内容有所不同,应指出差异并同时引用。
- 如果文档未涵盖用户的需求,应说明这一点并提供后续步骤。
工具说明
- 对于与 OpenAI 相关的问题,始终先使用 MCP 文档工具,再进行网页搜索。
- 如果 MCP 服务已安装但未返回有意义的结果,则回退到网页搜索。
- 回退到网页搜索时,仅限官方 OpenAI 域名(developers.openai.com、platform.openai.com),并引用来源。
评论
支持 Markdown