AgentSkillsCN

openai-knowledge

当您需要使用 OpenAI API(响应 API)或 OpenAI 平台功能(工具、流式传输、实时 API、认证、模型、速率限制、MCP)时,若需要权威且最新的文档(Schema、示例、限制、边缘案例),此工具将为您提供可靠支持。在 OpenAI 开发者文档 MCP 服务器可用时,优先使用该工具;否则,请引导用户启用 `openaiDeveloperDocs`。

SKILL.md
--- frontmatter
name: openai-knowledge
description: Use when working with the OpenAI API (Responses API) or OpenAI platform features (tools, streaming, Realtime API, auth, models, rate limits, MCP) and you need authoritative, up-to-date documentation (schemas, examples, limits, edge cases). Prefer the OpenAI Developer Documentation MCP server tools when available; otherwise guide the user to enable `openaiDeveloperDocs`.

OpenAI Knowledge

Overview

Use the OpenAI Developer Documentation MCP server to search and fetch exact docs (markdown), then base your answer on that text instead of guessing.

Workflow

1) Check whether the Docs MCP server is available

If the mcp__openaiDeveloperDocs__* tools are available, use them.

If you are unsure, run codex mcp list and check for openaiDeveloperDocs.

2) Use MCP tools to pull exact docs

  • Search first, then fetch the specific page(s).
    • mcp__openaiDeveloperDocs__search_openai_docs → pick the best URL.
    • mcp__openaiDeveloperDocs__fetch_openai_doc → retrieve the exact markdown (optionally with an anchor).
  • When you need endpoint schemas or parameters, use:
    • mcp__openaiDeveloperDocs__get_openapi_spec
    • mcp__openaiDeveloperDocs__list_api_endpoints

Base your answer on the fetched text and quote or paraphrase it precisely. Do not invent flags, field names, defaults, or limits.

3) If MCP is not configured, guide setup (do not change config unless asked)

Provide one of these setup options, then ask the user to restart the Codex session so the tools load:

  • CLI:
    • codex mcp add openaiDeveloperDocs --url https://developers.openai.com/mcp
  • Config file (~/.codex/config.toml):
    • Add:
      toml
      [mcp_servers.openaiDeveloperDocs]
      url = "https://developers.openai.com/mcp"
      

Also point to: https://developers.openai.com/resources/docs-mcp#quickstart