Catalog
openai/openai-docs

openai

openai-docs

Use when the user asks how to build with OpenAI products or APIs and needs up-to-date official documentation with citations, help choosing the latest model for a use case, or explicit GPT-5.4 upgrade and prompt-upgrade guidance; prioritize OpenAI docs MCP tools, use bundled references only as helper context, and restrict any fallback browsing to official OpenAI domains.

global
0installs0uses~1.3k
v1.1Saved Apr 20, 2026

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. This skill may also load targeted files from references/ for model-selection and GPT-5.4-specific requests, but current OpenAI docs remain authoritative. Only if the MCP server is installed and returns no meaningful results should you fall back to web search.

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.
  • Load only the relevant file from references/ when the question is about model selection or a GPT-5.4 upgrade.

OpenAI product snapshots

  1. Apps SDK: Build ChatGPT apps by providing a web component UI and an MCP server that exposes your app's tools to ChatGPT.
  2. Responses API: A unified endpoint designed for stateful, multimodal, tool-using interactions in agentic workflows.
  3. Chat Completions API: Generate a model response from a list of messages comprising a conversation.
  4. Codex: OpenAI's coding agent for software development that can write, understand, review, and debug code.
  5. gpt-oss: Open-weight OpenAI reasoning models (gpt-oss-120b and gpt-oss-20b) released under the Apache 2.0 license.
  6. Realtime API: Build low-latency, multimodal experiences including natural speech-to-speech conversations.
  7. 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:

  1. Run the install command yourself: codex mcp add openaiDeveloperDocs --url https://developers.openai.com/mcp
  2. If it fails due to permissions/sandboxing, immediately retry the same command with escalated permissions and include a 1-sentence justification for approval. Do not ask the user to run it yet.
  3. Only if the escalated attempt fails, ask the user to run the install command.
  4. Ask the user to restart Codex.
  5. Re-run the doc search/fetch after restart.

Workflow

  1. Clarify the product scope and whether the request is general docs lookup, model selection, a GPT-5.4 upgrade, or a GPT-5.4 prompt upgrade.
  2. If it is a model-selection request, load references/latest-model.md.
  3. If it is an explicit GPT-5.4 upgrade request, load references/upgrading-to-gpt-5p4.md.
  4. If the upgrade may require prompt changes, or the workflow is research-heavy, tool-heavy, coding-oriented, multi-agent, or long-running, also load references/gpt-5p4-prompting-guide.md.
  5. Search docs with a precise query.
  6. Fetch the best page and the exact section needed (use anchor when possible).
  7. For GPT-5.4 upgrade reviews, always make the per-usage-site output explicit: target model, starting reasoning recommendation, phase assessment when relevant, prompt blocks, and compatibility status.
  8. Answer with concise guidance and cite the doc source, using the reference files only as helper context.

Reference map

Read only what you need:

  • references/latest-model.md -> model-selection and "best/latest/current model" questions; verify every recommendation against current OpenAI docs before answering.
  • references/upgrading-to-gpt-5p4.md -> only for explicit GPT-5.4 upgrade and upgrade-planning requests; verify the checklist and compatibility guidance against current OpenAI docs before answering.
  • references/gpt-5p4-prompting-guide.md -> prompt rewrites and prompt-behavior upgrades for GPT-5.4; verify prompting guidance against current OpenAI docs before answering.

Quality rules

  • Treat OpenAI docs as the source of truth; avoid speculation.
  • Keep quotes short and within policy limits; prefer paraphrase with citations.
  • If multiple pages differ, call out the difference and cite both.
  • Reference files are convenience guides only; for volatile guidance such as recommended models, upgrade instructions, or prompting advice, current OpenAI docs always win.
  • If docs do not cover the user’s need, say so and offer next steps.

Tooling notes

  • Always use MCP doc tools before any web search for OpenAI-related questions.
  • If the MCP server is installed but returns no meaningful results, then use web search as a fallback.
  • When falling back to web search, restrict to official OpenAI domains (developers.openai.com, platform.openai.com) and cite sources.
Files7
7 files · 41.1 KB

Select a file to preview

Overall Score

87/100

Grade

A

Excellent

Safety

88

Quality

90

Clarity

88

Completeness

82

Summary

This skill guides AI agents to answer OpenAI product and API questions using official OpenAI Developer Docs via an MCP server, with fallback reference files for model selection and GPT-5.4 upgrade guidance. It prioritizes live documentation over bundled references and includes detailed prompting patterns for model migration.

Detected Capabilities

MCP tool invocation (search, fetch, list OpenAI docs)Reference file loading and context synthesisModel selection and recommendation workflowsGPT-5.4 upgrade assessment and prompt rewritingReasoning effort and parameter guidanceStructured compatibility and validation planning

Trigger Keywords

Phrases that MCP clients use to match this skill to user intent.

choose openai modelupgrade to gpt-5.4openai api docsgpt-5.4 promptingmodel selectionmigrate to latest modelopenai integration helpreasoning settings

Risk Signals

WARNING

Fallback instruction to run MCP install command with 'escalated permissions' if initial install fails

SKILL.md: 'If MCP server is missing' section, step 2
INFO

Reference to `phase` handling in long-running Responses workflows, with caveat that adding phase support may require code changes outside scope

references/gpt-5p4-prompting-guide.md and references/upgrading-to-gpt-5p4.md
INFO

Instruction to 'verify every recommendation against current OpenAI docs before answering' — indicates bundled reference files may become stale

references/latest-model.md: 'Maintenance notes' section

Referenced Domains

External domains referenced in skill content, detected by static analysis.

developers.openai.comwww.apache.org

Use Cases

  • Help users choose the latest or best OpenAI model for their use case
  • Guide users through upgrading existing integrations to GPT-5.4
  • Provide official OpenAI API documentation with current best practices
  • Adapt prompts for GPT-5.4 behavioral differences and reasoning settings
  • Research OpenAI product capabilities (Chat Completions, Realtime API, Responses API, Agents SDK)

Quality Notes

  • Excellent documentation structure: clear workflow steps, detailed reference map, and scope boundaries
  • Strong quality rules emphasizing source-of-truth verification and preventing hallucination
  • Comprehensive prompt-upgrade guidance with 15+ reusable prompt blocks tailored to specific workflow types (research, tools, coding, multi-agent)
  • Well-designed upgrade workflow with explicit classification (model-string-only vs. light-rewrite vs. blocked) to prevent over-scoping
  • Good error handling guidance for MCP server installation failures, though escalated permissions instruction warrants clarification
  • Reference files are well-maintained with explicit drift warnings and maintenance checklist for launch-day updates
  • Prompting guide includes regression checklist and example upgrade profiles covering major source models (GPT-4o, GPT-5.3-Codex, long-horizon agents)
  • Scope boundaries are explicitly documented in upgrading guide ('may' vs. 'may not' sections), reducing scope creep risk
Model: claude-haiku-4-5-20251001Analyzed: Apr 20, 2026

Reviews

Add this skill to your library to leave a review.

No reviews yet

Be the first to share your experience.

Version History

v1.1

Content updated

2026-04-20

Latest
v1.0

Seeded from github.com/openai/skills

2026-03-16

Add openai/openai-docs to your library

Command Palette

Search for a command to run...