SuperAPI AI 工具集

openai-docs-skill

编程与开发

查看项目

更新于 10-16 07:11

技能介绍

用途

OpenAI Docs MCP Skill 用于从 shell 中访问 OpenAI 开发者文档的 MCP 服务器,搜索并获取权威文档。它面向所有涉及 OpenAI 平台的工作,包括 OpenAI API(Responses、Chat 等)、SDK、Apps、Codex 相关问题,或在需要精确、最新文档时使用。技能明确要求:凡涉及 OpenAI 平台工作,应始终使用该技能,而不是依赖记忆或非官方来源。

主要能力

该技能通过 CLI 封装脚本 scripts/openai-docs-mcp.sh 查询 MCP 服务器,底层使用 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 schema 或代码示例。

环境变量 MCP_URL 可用于覆盖默认的 MCP 端点。

使用方式

快速开始示例:

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. 发现(Discover):用聚焦的查询进行 search;如果不确定,使用 list 浏览。
  2. 阅读(Read):fetch 最相关的 URL(可选添加锚点)。
  3. 应用(Apply):总结和/或引用相关章节,并附上 URL。

核心规则还包括:通过 CLI 封装脚本查询 MCP 服务器,不要依赖 Codex MCP 工具;先用 search 或 list 找到最佳文档页,再 fetch 页面或锚点获取精确文本;在回复中给出所用文档 URL,使来源清晰。

适用场景

适用于需要查询 OpenAI 开发者文档的各类任务,尤其是涉及 OpenAI API、SDK、Apps、Codex 的问题,或需要精确、最新官方文档支撑的场景。

限制

资料未提供关于收费、价格、平台兼容性、性能效果等方面的信息,暂未提供。