Generated banner for Openai Docs
Generated logo for Openai Docs

Openai Docs

JetBrainsOfficialCreated by OpenAIDistributed by JetBrains

  • Skill
  • Tool integration
  • Software development
  • Apache-2.0
  • No issues found

From the author

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.
— the description by OpenAI

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The openai-docs skill provides an authoritative interface for retrieving official OpenAI developer documentation. It prioritizes the use of the OpenAI developer docs MCP server to ensure accuracy, while utilizing internal reference files as supplementary context for model selection and GPT-5.4 upgrade planning. The skill enforces a strict hierarchy where official documentation is the source of truth, ensuring that users receive up-to-date information on APIs, model capabilities, and best practices for prompt engineering.

What it does

  • Searches and fetches official OpenAI developer documentation using MCP tools.
  • Provides structured guidance for upgrading existing prompts and workflows to GPT-5.4.
  • Offers model selection advice based on current performance and use-case requirements.
  • Automates the installation of the required MCP server if it is missing or misconfigured.
  • Enforces citation of official sources to maintain accuracy and reliability.
  • Restricts fallback web searches to official OpenAI domains only.

When to use it

  • When you need to look up technical specifications for OpenAI APIs or SDKs.
  • When planning a migration or upgrade to the GPT-5.4 model family.
  • When you need help selecting the most appropriate model for a specific application.
  • When you require verified prompt engineering patterns for complex agentic workflows.

Advantages

  • Ensures high accuracy by prioritizing official documentation over general web search.
  • Provides clear, actionable paths for model upgrades and prompt optimization.
  • Reduces hallucination risk by using a structured, citation-based retrieval process.
  • Simplifies the developer experience by managing MCP server connectivity.

Usage examples

“How do I implement the Realtime API for a voice-based application?”
The agent will search the official OpenAI developer docs via MCP to provide a step-by-step implementation guide and relevant code patterns.
“I am upgrading my agent from GPT-4o to GPT-5.4, what should I change in my prompts?”
The agent will load the GPT-5.4 prompting guide, analyze your current requirements, and suggest targeted prompt adjustments to improve performance.
“Which model should I use for a high-throughput classification task?”
The agent will consult the latest model guide and official docs to recommend the most cost-effective model, such as gpt-5.4-nano.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/jetbrains/openai-docs/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip openai-docs.zip -d .agents/skills

Documentation by OpenAI

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.

Files

references/upgrading-to-gpt-5p4.md

Upgrading to GPT-5.4

Use this guide when the user explicitly asks to upgrade an existing integration to GPT-5.4. Pair it with current OpenAI docs lookups. The default target string is gpt-5.4.

Upgrade posture

Upgrade with the narrowest safe change set:

  • replace the model string first

  • update only the prompts that are directly tied to that model usage

  • prefer prompt-only upgrades when possible

  • if the upgrade would require API-surface changes, parameter rewrites, tool rewiring, or broader code edits, mark it as blocked instead of stretching the scope

Upgrade workflow

  1. Inventory current model usage.

    • Search for model strings, client calls, and prompt-bearing files.

    • Include inline prompts, prompt templates, YAML or JSON configs, Markdown docs, and saved prompts when they are clearly tied to a model usage site.

  2. Pair each model usage with its prompt surface.

    • Prefer the closest prompt surface first: inline system or developer text, then adjacent prompt files, then shared templates.

    • If you cannot confidently tie a prompt to the model usage, say so instead of guessing.

  3. Classify the source model family.

    • Common buckets: gpt-4o or gpt-4.1, o1 or o3 or o4-mini, early gpt-5, later gpt-5.x, or mixed and unclear.

  4. Decide the upgrade class.

    • model string only

    • model string + light prompt rewrite

    • blocked without code changes

  5. Run the no-code compatibility gate.

    • Check whether the current integration can accept gpt-5.4 without API-surface changes or implementation changes.

    • For long-running Responses or tool-heavy agents, check whether phase is already preserved or round-tripped when the host replays assistant items or uses preambles.

    • If compatibility depends on code changes, return blocked.

    • If compatibility is unclear, return unknown rather than improvising.

  6. Recommend the upgrade.

    • Default replacement string: gpt-5.4

    • Keep the intervention small and behavior-preserving.

  7. Deliver a structured recommendation.

    • Current model usage

    • Recommended model-string updates

    • Starting reasoning recommendation

    • Prompt updates

    • Phase assessment when the flow is long-running, replayed, or tool-heavy

    • No-code compatibility check

    • Validation plan

    • Launch-day refresh items

Output rule:

  • Always emit a starting reasoning_effort_recommendation for each usage site.

  • If the repo exposes the current reasoning setting, preserve it first unless the source guide says otherwise.

  • If the repo does not expose the current setting, use the source-family starting mapping instead of returning null.

Upgrade outcomes

model string only

Choose this when:

  • the existing prompts are already short, explicit, and task-bounded

  • the workflow is not strongly research-heavy, tool-heavy, multi-agent, batch or completeness-sensitive, or long-horizon

  • there are no obvious compatibility blockers

Default action:

  • replace the model string with gpt-5.4

  • keep prompts unchanged

  • validate behavior with existing evals or spot checks

model string + light prompt rewrite

Choose this when:

  • the old prompt was compensating for weaker instruction following

  • the workflow needs more persistence than the default tool-use behavior will likely provide

  • the task needs stronger completeness, citation discipline, or verification

  • the upgraded model becomes too verbose or under-complete unless instructed otherwise

  • the workflow is research-heavy and needs stronger handling of sparse or empty retrieval results

  • the workflow is coding-oriented, tool-heavy, or multi-agent, but the existing API surface and tool definitions can remain unchanged

Default action:

  • replace the model string with gpt-5.4

  • add one or two targeted prompt blocks

  • read references/gpt-5p4-prompting-guide.md to choose the smallest prompt changes that recover the old behavior

  • avoid broad prompt cleanup unrelated to the upgrade

  • for research workflows, default to research_mode + citation_rules + empty_result_handling; add tool_persistence_rules when the host already uses retrieval tools

  • for dependency-aware or tool-heavy workflows, default to tool_persistence_rules + dependency_checks + verification_loop; add parallel_tool_calling only when retrieval steps are truly independent

  • for coding or terminal workflows, default to terminal_tool_hygiene + verification_loop

  • for multi-agent support or triage workflows, default to at least one of tool_persistence_rules, completeness_contract, or verification_loop

  • for long-running Responses agents with preambles or multiple assistant messages, explicitly review whether phase is already handled; if adding or preserving phase would require code edits, mark the path as blocked

  • do not classify a coding or tool-using Responses workflow as blocked just because the visible snippet is minimal; prefer model string + light prompt rewrite unless the repo clearly shows that a safe GPT-5.4 path would require host-side code changes

blocked

Choose this when:

  • the upgrade appears to require API-surface changes

  • the upgrade appears to require parameter rewrites or reasoning-setting changes that are not exposed outside implementation code

  • the upgrade would require changing tool definitions, tool handler wiring, or schema contracts

  • you cannot confidently identify the prompt surface tied to the model usage

Default action:

  • do not improvise a broader upgrade

  • report the blocker and explain that the fix is out of scope for this guide

No-code compatibility checklist

Before recommending a no-code upgrade, check:

  1. Can the current host accept the gpt-5.4 model string without changing client code or API surface?

  2. Are the related prompts identifiable and editable?

  3. Does the host depend on behavior that likely needs API-surface changes, parameter rewrites, or tool rewiring?

  4. Would the likely fix be prompt-only, or would it need implementation changes?

  5. Is the prompt surface close enough to the model usage that you can make a targeted change instead of a broad cleanup?

  6. For long-running Responses or tool-heavy agents, is phase already preserved if the host relies on preambles, replayed assistant items, or multiple assistant messages?

If item 1 is no, items 3 through 4 point to implementation work, or item 6 is no and the fix needs code changes, return blocked.

If item 2 is no, return unknown unless the user can point to the prompt location.

Important:

  • Existing use of tools, agents, or multiple usage sites is not by itself a blocker.

  • If the current host can keep the same API surface and the same tool definitions, prefer model string + light prompt rewrite over blocked.

  • Reserve blocked for cases that truly require implementation changes, not cases that only need stronger prompt steering.

Scope boundaries

This guide may:

  • update or recommend updated model strings

  • update or recommend updated prompts

  • inspect code and prompt files to understand where those changes belong

  • inspect whether existing Responses flows already preserve phase

  • flag compatibility blockers

This guide may not:

  • move Chat Completions code to Responses

  • move Responses code to another API surface

  • rewrite parameter shapes

  • change tool definitions or tool-call handling

  • change structured-output wiring

  • add or retrofit phase handling in implementation code

  • edit business logic, orchestration logic, or SDK usage beyond a literal model-string replacement

If a safe GPT-5.4 upgrade requires any of those changes, mark the path as blocked and out of scope.

Validation plan

  • Validate each upgraded usage site with existing evals or realistic spot checks.

  • Check whether the upgraded model still matches expected latency, output shape, and quality.

  • If prompt edits were added, confirm each block is doing real work instead of adding noise.

  • If the workflow has downstream impact, add a lightweight verification pass before finalization.

Launch-day refresh items

When final GPT-5.4 guidance changes:

  1. Replace release-candidate assumptions with final GPT-5.4 guidance where appropriate.

  2. Re-check whether the default target string should stay gpt-5.4 for all source families.

  3. Re-check any prompt-block recommendations whose semantics may have changed.

  4. Re-check research, citation, and compatibility guidance against the final model behavior.

  5. Re-run the same upgrade scenarios and confirm the blocked-versus-viable boundaries still hold.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs an MCP server

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
OpenAI
Publisher
JetBrains (Official)
Distributed by
JetBrains
Source
JetBrains/skills · openai-docs · commit 3f53782
Licence
Apache License 2.0 (redistribution allowed)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by OpenAI or JetBrains.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download openai-docs.zip