mcpField
O
openai-docs-skill

openai-docs-skill

github.com/am-will开发1.0k1.2k 次安装15 周前更新
代码仓库

关于 openai-docs-skill

openai-docs-skill 是通过命令行查阅 OpenAI 开发者文档的技能，面向使用 OpenAI API、SDK、Apps 或 Codex 的开发者。它可搜索并获取当前参考页面，便于在回答中注明文档链接。

主要功能

  1. 01搜索文档索引
  2. 02浏览文档目录
  3. 03获取页面或锚定章节
  4. 04检查 MCP 服务工具与能力
  5. 05获取 OpenAPI 模式和示例

适用场景

  1. 01核对最新 OpenAI API 指引
  2. 02查找 SDK 或 Codex 文档细节
  3. 03在技术答复中引用官方文档

MCP 相关

通过命令行封装脚本查询 OpenAI 开发者文档 MCP 服务，支持搜索、列举、获取内容及检查服务能力。

安装

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

$npx skills add https://github.com/am-will/codex-skills --skill openai-docs-skill

安装后在 Claude Code 中输入/openai-docs-skill确认已加载。

附带文件scripts/openai-docs-mcp.sh

详细介绍

OpenAI 文档 MCP 技能

概述

在 shell 中使用 OpenAI 开发者文档 MCP 服务，搜索并获取权威文档。处理 OpenAI 平台相关工作时，始终这样做，不要依赖记忆或非官方来源。

核心规则

  • 对于 OpenAI API/SDK/Apps/Codex 相关问题，或需要准确、最新文档时，始终使用此技能。
  • 通过 scripts/openai-docs-mcp.sh 中的 CLI 封装脚本查询 MCP 服务（不要依赖 Codex MCP 工具）。
  • 使用 search 或 list 查找最合适的文档页面，然后使用 fetch 获取页面（或锚点）的准确文本。
  • 在回复中提供所用文档的 URL，明确标注来源。

快速开始

scripts/openai-docs-mcp.sh search "Responses API" 5
scripts/openai-docs-mcp.sh fetch https://platform.openai.com/docs/guides/migrate-to-responses

工作流

  1. 查找：使用 search 并输入聚焦的查询。如果不确定，使用 list 浏览。
  2. 阅读：使用 fetch 获取最相关的 URL（可选添加锚点）。
  3. 应用：总结和／或引用相关章节，并附上 URL。

脚本参考

CLI 封装脚本位于 scripts/openai-docs-mcp.sh，通过 curl + jq 访问 https://developers.openai.com/mcp。

子命令：

  • init：初始化并检查服务功能。
  • tools：列出 MCP 服务上可用的工具。
  • search <query> [limit] [cursor]：返回文档索引中的 JSON 搜索结果。
  • list [limit] [cursor]：浏览文档索引。
  • fetch <url> [anchor]：返回文档页面或章节的 Markdown。
  • endpoints：列出 OpenAPI 端点。
  • openapi <endpoint-url> [lang1,lang2] [code-only]：获取 OpenAPI 架构或代码示例。

环境变量：

  • MCP_URL：覆盖默认 MCP 端点。

评论

支持 Markdown