Openai Docs
JetBrainsOfficialCreated by OpenAIDistributed by JetBrains
- Skill
- Tool integration
- Software development
- Apache-2.0
- No issues found
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
Download the skill as a ZIP:
https://autogineer.com/agent-skills/jetbrains/openai-docs/downloadUnzip 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_docsto find the most relevant doc pages.Use
mcp__openaiDeveloperDocs__fetch_openai_docto pull exact sections and quote/paraphrase accurately.Use
mcp__openaiDeveloperDocs__list_openai_docsonly 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
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:
Run the install command yourself:
codex mcp add openaiDeveloperDocs --url https://developers.openai.com/mcpIf 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.
Only if the escalated attempt fails, ask the user to run the install command.
Ask the user to restart Codex.
Re-run the doc search/fetch after restart.
Workflow
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.
If it is a model-selection request, load
references/latest-model.md.If it is an explicit GPT-5.4 upgrade request, load
references/upgrading-to-gpt-5p4.md.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.Search docs with a precise query.
Fetch the best page and the exact section needed (use
anchorwhen possible).For GPT-5.4 upgrade reviews, always make the per-usage-site output explicit: target model, starting reasoning recommendation,
phaseassessment when relevant, prompt blocks, and compatibility status.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
- ATTRIBUTION.mdAdded by AutoGineer900 B
- LICENSE.txt10.5 KiB
- SKILL.md5.2 KiB
- agents/openai.yaml563 B
- assets/openai-small.svg1.1 KiB
- assets/openai.png1.4 KiB
- references/gpt-5p4-prompting-guide.md17.6 KiB
- references/latest-model.md1.6 KiB
- references/upgrading-to-gpt-5p4.md8.4 KiB
references/gpt-5p4-prompting-guide.md
GPT-5.4 prompting upgrade guide
Use this guide when prompts written for older models need to be adapted for GPT-5.4 during an upgrade. Start lean: keep the model-string change narrow, preserve the original task intent, and add only the smallest prompt changes needed to recover behavior.
Default upgrade posture
Start with
model string onlywhenever the old prompt is already short, explicit, and task-bounded.Move to
model string + light prompt rewriteonly when regressions appear in completeness, persistence, citation quality, verification, or verbosity.Prefer one or two targeted prompt additions over a broad rewrite.
Treat reasoning effort as a last-mile knob. Start lower, then increase only after prompt-level fixes and evals.
Before increasing reasoning effort, first add a completeness contract, a verification loop, and tool persistence rules - depending on the usage case.
If the workflow clearly depends on implementation changes rather than prompt changes, treat it as blocked for prompt-only upgrade guidance.
Do not classify a case as blocked just because the workflow uses tools; block only if the upgrade requires changing tool definitions, wiring, or other implementation details.
Behavioral differences to account for
Current GPT-5.4 upgrade guidance suggests these strengths:
stronger personality and tone adherence, with less drift over long answers
better long-horizon and agentic workflow stamina
stronger spreadsheet, finance, and formatting tasks
more efficient tool selection and fewer unnecessary calls by default
stronger structured generation and classification reliability
The main places where prompt guidance still helps are:
retrieval-heavy workflows that need persistent tool use and explicit completeness
research and citation discipline
verification before irreversible or high-impact actions
terminal and tool workflow hygiene
defaults and implied follow-through
verbosity control for compact, information-dense answers
Start with the smallest set of instructions that preserves correctness. Add the prompt blocks below only for workflows that actually need them.
Prompt rewrite patterns
| Older prompt pattern | GPT-5.4 adjustment | Why | Example addition |
|---|---|---|---|
| Long, repetitive instructions that compensate for weaker instruction following | Remove duplicate scaffolding and keep only the constraints that materially change behavior | GPT-5.4 usually needs less repeated steering | Replace repeated reminders with one concise rule plus a verification block |
| Fast assistant prompt with no verbosity control | Keep the prompt as-is first; add a verbosity clamp only if outputs become too long | Many GPT-4o or GPT-4.1 upgrades work with just a model-string swap | Add output_verbosity_spec only after a verbosity regression |
| Tool-heavy agent prompt that assumes the model will keep searching until complete | Add persistence and verification rules | GPT-5.4 may use fewer tool calls by default for efficiency | Add tool_persistence_rules and verification_loop |
| Tool-heavy workflow where later actions depend on earlier lookup or retrieval | Add prerequisite and missing-context rules before action steps | GPT-5.4 benefits from explicit dependency-aware routing when context is still thin | Add dependency_checks and missing_context_gating |
| Retrieval workflow with several independent lookups | Add selective parallelism guidance | GPT-5.4 is strong at parallel tool use, but should not parallelize dependent steps | Add parallel_tool_calling |
| Batch workflow prompt that often misses items | Add an explicit completeness contract | Item accounting benefits from direct instruction | Add completeness_contract |
| Research prompt that needs grounding and citation discipline | Add research, citation, and empty-result recovery blocks | Multi-pass retrieval is stronger when the model is told how to react to weak or empty search results | Add research_mode, citation_rules, and empty_result_handling; add tool_persistence_rules when retrieval tools are already in use |
| Coding or terminal prompt with shell misuse or early stop failures | Keep the same tool surface and add terminal hygiene and verification instructions | Tool-using coding workflows are not blocked just because tools exist; they usually need better prompt steering, not host rewiring | Add terminal_tool_hygiene and verification_loop, optionally tool_persistence_rules |
| Multi-agent or support-triage workflow with escalation or completeness requirements | Add one lightweight control block for persistence, completeness, or verification | GPT-5.4 can be more efficient by default, so multi-step support flows benefit from an explicit completion or verification contract | Add at least one of tool_persistence_rules, completeness_contract, or verification_loop |
Prompt blocks
Use these selectively. Do not add all of them by default.
output_verbosity_spec
Use when:
the upgraded model gets too wordy
the host needs compact, information-dense answers
the workflow benefits from a short overview plus a checklist
<output_verbosity_spec>
- Default: 3-6 sentences or up to 6 bullets.
- If the user asked for a doc or report, use headings with short bullets.
- For multi-step tasks:
- Start with 1 short overview paragraph.
- Then provide a checklist with statuses: [done], [todo], or [blocked].
- Avoid repeating the user's request.
- Prefer compact, information-dense writing.
</output_verbosity_spec>default_follow_through_policy
Use when:
the host expects the model to proceed on reversible, low-risk steps
the upgraded model becomes too conservative or asks for confirmation too often
<default_follow_through_policy>
- If the user's intent is clear and the next step is reversible and low-risk, proceed without asking permission.
- Only ask permission if the next step is:
(a) irreversible,
(b) has external side effects, or
(c) requires missing sensitive information or a choice that materially changes outcomes.
- If proceeding, state what you did and what remains optional.
</default_follow_through_policy>instruction_priority
Use when:
users often change task shape, format, or tone mid-conversation
the host needs an explicit override policy instead of relying on defaults
<instruction_priority>
- User instructions override default style, tone, formatting, and initiative preferences.
- Safety, honesty, privacy, and permission constraints do not yield.
- If a newer user instruction conflicts with an earlier one, follow the newer instruction.
- Preserve earlier instructions that do not conflict.
</instruction_priority>tool_persistence_rules
Use when:
the workflow needs multiple retrieval or verification steps
the model starts stopping too early because it is trying to save tool calls
<tool_persistence_rules>
- Use tools whenever they materially improve correctness, completeness, or grounding.
- Do not stop early just to save tool calls.
- Keep calling tools until:
(1) the task is complete, and
(2) verification passes.
- If a tool returns empty or partial results, retry with a different strategy.
</tool_persistence_rules>dig_deeper_nudge
Use when:
the model is too literal or stops at the first plausible answer
the task is safety- or accuracy-sensitive and needs a small initiative nudge before raising reasoning effort
<dig_deeper_nudge>
- Do not stop at the first plausible answer.
- Look for second-order issues, edge cases, and missing constraints.
- If the task is safety- or accuracy-critical, perform at least one verification step.
</dig_deeper_nudge>dependency_checks
Use when:
later actions depend on prerequisite lookup, memory retrieval, or discovery steps
the model may be tempted to skip prerequisite work because the intended end state seems obvious
<dependency_checks>
- Before taking an action, check whether prerequisite discovery, lookup, or memory retrieval is required.
- Do not skip prerequisite steps just because the intended final action seems obvious.
- If a later step depends on the output of an earlier one, resolve that dependency first.
</dependency_checks>parallel_tool_calling
Use when:
the workflow has multiple independent retrieval steps
wall-clock time matters but some steps still need sequencing
<parallel_tool_calling>
- When multiple retrieval or lookup steps are independent, prefer parallel tool calls to reduce wall-clock time.
- Do not parallelize steps with prerequisite dependencies or where one result determines the next action.
- After parallel retrieval, pause to synthesize before making more calls.
- Prefer selective parallelism: parallelize independent evidence gathering, not speculative or redundant tool use.
</parallel_tool_calling>completeness_contract
Use when:
the task involves batches, lists, enumerations, or multiple deliverables
missing items are a common failure mode
<completeness_contract>
- Deliver all requested items.
- Maintain an itemized checklist of deliverables.
- For lists or batches:
- state the expected count,
- enumerate items 1..N,
- confirm that none are missing before finalizing.
- If any item is blocked by missing data, mark it [blocked] and state exactly what is missing.
</completeness_contract>empty_result_handling
Use when:
the workflow frequently performs search, CRM, logs, or retrieval steps
no-results failures are often false negatives
<empty_result_handling>
If a lookup returns empty or suspiciously small results:
- Do not conclude that no results exist immediately.
- Try at least 2 fallback strategies, such as a broader query, alternate filters, or another source.
- Only then report that no results were found, along with what you tried.
</empty_result_handling>verification_loop
Use when:
the workflow has downstream impact
accuracy, formatting, or completeness regressions matter
<verification_loop>
Before finalizing:
- Check correctness: does the output satisfy every requirement?
- Check grounding: are factual claims backed by retrieved sources or tool output?
- Check formatting: does the output match the requested schema or style?
- Check safety and irreversibility: if the next step has external side effects, ask permission first.
</verification_loop>missing_context_gating
Use when:
required context is sometimes missing early in the workflow
the model should prefer retrieval over guessing
<missing_context_gating>
- If required context is missing, do not guess.
- Prefer the appropriate lookup tool when the context is retrievable; ask a minimal clarifying question only when it is not.
- If you must proceed, label assumptions explicitly and choose a reversible action.
</missing_context_gating>action_safety
Use when:
the agent will actively take actions through tools
the host benefits from a short pre-flight and post-flight execution frame
<action_safety>
- Pre-flight: summarize the intended action and parameters in 1-2 lines.
- Execute via tool.
- Post-flight: confirm the outcome and any validation that was performed.
</action_safety>citation_rules
Use when:
the workflow produces cited answers
fabricated citations or wrong citation formats are costly
<citation_rules>
- Only cite sources that were actually retrieved in this session.
- Never fabricate citations, URLs, IDs, or quote spans.
- If you cannot find a source for a claim, say so and either:
- soften the claim, or
- explain how to verify it with tools.
- Use exactly the citation format required by the host application.
</citation_rules>research_mode
Use when:
the workflow is research-heavy
the host uses web search or retrieval tools
<research_mode>
- Do research in 3 passes:
1) Plan: list 3-6 sub-questions to answer.
2) Retrieve: search each sub-question and follow 1-2 second-order leads.
3) Synthesize: resolve contradictions and write the final answer with citations.
- Stop only when more searching is unlikely to change the conclusion.
</research_mode>If your host environment uses a specific research tool or requires a submit step, combine this with the host's finalization contract.
structured_output_contract
Use when:
the host depends on strict JSON, SQL, or other structured output
<structured_output_contract>
- Output only the requested format.
- Do not add prose or markdown fences unless they were requested.
- Validate that parentheses and brackets are balanced.
- Do not invent tables or fields.
- If required schema information is missing, ask for it or return an explicit error object.
</structured_output_contract>bbox_extraction_spec
Use when:
the workflow extracts OCR boxes, document regions, or other coordinates
layout drift or missed dense regions are common failure modes
<bbox_extraction_spec>
- Use the specified coordinate format exactly, such as [x1,y1,x2,y2] normalized to 0..1.
- For each box, include page, label, text snippet, and confidence.
- Add a vertical-drift sanity check so boxes stay aligned with the correct line of text.
- If the layout is dense, process page by page and do a second pass for missed items.
</bbox_extraction_spec>terminal_tool_hygiene
Use when:
the prompt belongs to a terminal-based or coding-agent workflow
tool misuse or shell misuse has been observed
<terminal_tool_hygiene>
- Only run shell commands through the terminal tool.
- Never try to "run" tool names as shell commands.
- If a patch or edit tool exists, use it directly instead of emulating it in bash.
- After changes, run a lightweight verification step such as ls, tests, or a build before declaring the task done.
</terminal_tool_hygiene>user_updates_spec
Use when:
the workflow is long-running and user updates matter
<user_updates_spec>
- Only update the user when starting a new major phase or when the plan changes.
- Each update should contain:
- 1 sentence on what changed,
- 1 sentence on the next step.
- Do not narrate routine tool calls.
- Keep the user-facing update short, even when the actual work is exhaustive.
</user_updates_spec>If you are using Compaction in the Responses API, compact after major milestones, treat compacted items as opaque state, and keep prompts functionally identical after compaction.
Responses phase guidance
For long-running Responses workflows, preambles, or tool-heavy agents that replay assistant items, review whether phase is already preserved.
If the host already round-trips
phase, keep it intact during the upgrade.If the host uses
previous_response_idand does not manually replay assistant items, note that this may reduce manualphasehandling needs.If reliable GPT-5.4 behavior would require adding or preserving
phaseand that would need code edits, treat the case as blocked for prompt-only or model-string-only migration guidance.
Example upgrade profiles
GPT-5.2
Use
gpt-5.4Match the current reasoning effort first
Preserve the existing latency and quality profile before tuning prompt blocks
If the repo does not expose the exact setting, emit
sameas the starting recommendation
GPT-5.3-Codex
Use
gpt-5.4Match the current reasoning effort first
If you need Codex-style speed and efficiency, add verification blocks before increasing reasoning effort
If the repo does not expose the exact setting, emit
sameas the starting recommendation
GPT-4o or GPT-4.1 assistant
Use
gpt-5.4Start with
nonereasoning effortAdd
output_verbosity_speconly if output becomes too verbose
Long-horizon agent
Use
gpt-5.4Start with
mediumreasoning effortAdd
tool_persistence_rulesAdd
completeness_contractAdd
verification_loop
Research workflow
Use
gpt-5.4Start with
mediumreasoning effortAdd
research_modeAdd
citation_rulesAdd
empty_result_handlingAdd
tool_persistence_ruleswhen the host already uses web or retrieval toolsAdd
parallel_tool_callingwhen the retrieval steps are independent
Support triage or multi-agent workflow
Use
gpt-5.4Prefer
model string + light prompt rewriteovermodel string onlyAdd at least one of
tool_persistence_rules,completeness_contract, orverification_loopAdd more only if evals show a real regression
Coding or terminal workflow
Use
gpt-5.4Keep the model-string change narrow
Match the current reasoning effort first if you are upgrading from GPT-5.3-Codex
Add
terminal_tool_hygieneAdd
verification_loopAdd
dependency_checkswhen actions depend on prerequisite lookup or discoveryAdd
tool_persistence_rulesif the agent stops too earlyReview whether
phaseis already preserved for long-running Responses flows or assistant preamblesDo not classify this as blocked just because the workflow uses tools; block only if the upgrade requires changing tool definitions or wiring
If the repo already uses Responses plus tools and no required host-side change is shown, prefer
model_string_plus_light_prompt_rewriteoverblocked
Prompt regression checklist
Check whether the upgraded prompt still preserves the original task intent.
Check whether the new prompt is leaner, not just longer.
Check completeness, citation quality, dependency handling, verification behavior, and verbosity.
For long-running Responses agents, check whether
phasehandling is already in place or needs implementation work.Confirm that each added prompt block addresses an observed regression.
Remove prompt blocks that are not earning their keep.
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