openai-knowledge
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`.
安装与使用
请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。
查看来源 ↗使用指南技能说明
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 ananchor).
-
- 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:
[mcp_servers.openaiDeveloperDocs] url = "https://developers.openai.com/mcp"
- Add:
Also point to: https://developers.openai.com/resources/docs-mcp#quickstart
使用示例
查看来源仓库中的使用示例与配置说明。
查看来源 ↗来源历史
- 收录时间
- 2026-01-20
- 索引更新时间
- 2026-01-28
- Branch
- main
收录与同步日期属于本站记录。源码修改历史请查看来源仓库。
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!