OpenAI文档查询

技能简介

通过OpenAI Docs MCP服务器，以命令行方式查询OpenAI官方开发者文档，获取Responses API、Chat Completions、Realtime、Codex等产品的最新接口规范与迁移指南。

业务背景

帮助开发者实时追踪OpenAI平台接口变更，避免因文档滞后导致的集成故障。通过命令行直接检索官方最新规范与迁移指南，减少在网页间跳转查找的时间损耗，确保代码实现与平台能力同步更新。

落地案例：某SaaS产品团队计划从旧版Chat Completions迁移至Responses API。后端工程师通过关键词搜索定位迁移指南页面，获取完整Markdown文档及Python/Node.js双端代码示例；随后查询/v1/responses端点的OpenAPI Schema确认字段变更，30分钟内完成接口适配方案评估，避免上线后兼容性问题。

能做什么

• 搜索并定位特定主题的官方文档页面
• 获取指定URL的完整文档内容或锚点段落
• 查询OpenAPI端点列表及详细Schema
• 生成多语言代码示例（Python/Node.js/cURL等）

使用说明

安装准备

本技能依赖curl与jq，请确保系统已安装。将仓库中的scripts/openai-docs-mcp.sh脚本置于可执行路径。

基础用法

1. 初始化连接：
   scripts/openai-docs-mcp.sh init
2. 搜索文档：
   scripts/openai-docs-mcp.sh search "Responses API" 5
3. 获取页面：
   scripts/openai-docs-mcp.sh fetch https://platform.openai.com/docs/guides/migrate-to-responses
4. 浏览索引：
   scripts/openai-docs-mcp.sh list 20
5. 查看端点：
   scripts/openai-docs-mcp.sh openapi /v1/responses python,node

可通过环境变量MCP_URL自定义服务端点。

输入与输出

见下方输入与输出表格。

风险提示

• 查询结果依赖网络连接至OpenAI官方服务
• 文档内容随平台更新而变化，需核对返回URL的时间戳
• MCP服务器可用性不受本技能控制
• 频繁调用可能触发速率限制

来源信息

原始链接：https://github.com/openclaw/skills/tree/main/skills/am-will/openai-docs/SKILL.md
来源类型：GitHub仓库