| name | openai-docs |
| description | Use when the user asks how to build with OpenAI products or APIs and needs up-to-date official documentation with citations (for example: Codex, Responses API, Chat Completions, Apps SDK, Agents SDK, Realtime, model capabilities or limits); prioritize OpenAI docs MCP tools and restrict any fallback browsing to official OpenAI domains. |
| zh_description | 用于查阅和应用 OpenAI 官方文档、API 行为和集成指南。 |
| version | 1.0.0 |
| author | seaworld008 |
| source | in-house |
| source_url | |
| tags | ["agent", "ai", "docs", "openai"] |
| created_at | 2026-03-04 |
| updated_at | 2026-03-20 |
| quality | 3 |
| complexity | intermediate |
OpenAI Docs
Provide authoritative, current guidance from OpenAI developer docs using the developers.openai.com MCP server. Always prioritize the developer docs MCP tools over web.run for OpenAI-related questions. Only if the MCP server is installed and returns no meaningful results should you fall back to web search.
When to Use
Use this skill when the user asks about:
- OpenAI APIs or SDKs
- model capabilities, limits, or migration guidance
- Codex, Responses API, Chat Completions, Realtime, Agents SDK, or Apps SDK
- official OpenAI setup instructions where current docs matter
Do not use this skill when:
- the task is general coding help with no OpenAI product dependency
- the user only wants speculative comparison without needing official guidance
Usage
Preferred flow:
search official docs
-> fetch exact page or section
-> answer with citation
-> only fall back to official-domain web search if MCP docs fail
Quick start
- Use
mcp__openaiDeveloperDocs__search_openai_docs to find the most relevant doc pages.
- Use
mcp__openaiDeveloperDocs__fetch_openai_doc to pull exact sections and quote/paraphrase accurately.
- Use
mcp__openaiDeveloperDocs__list_openai_docs only when you need to browse or discover pages without a clear query.
Example:
1. Search docs for "Responses API tool calling"
2. Fetch the best page
3. Cite the fetched URL in the answer
4. If needed, fetch a narrower anchor section
OpenAI product snapshots
- Apps SDK: Build ChatGPT apps by providing a web component UI and an MCP server that exposes your app's tools to ChatGPT.
- Responses API: A unified endpoint designed for stateful, multimodal, tool-using interactions in agentic workflows.
- Chat Completions API: Generate a model response from a list of messages comprising a conversation.
- Codex: OpenAI's coding agent for software development that can write, understand, review, and debug code.
- gpt-oss: Open-weight OpenAI reasoning models (gpt-oss-120b and gpt-oss-20b) released under the Apache 2.0 license.
- Realtime API: Build low-latency, multimodal experiences including natural speech-to-speech conversations.
- Agents SDK: A toolkit for building agentic apps where a model can use tools and context, hand off to other agents, stream partial results, and keep a full trace.
If MCP server is missing
If MCP tools fail or no OpenAI docs resources are available:
