AutoGineer
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
Download ZIP

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

agents/openai.yaml

interface:
  display_name: "OpenAI Docs"
  short_description: "Reference official OpenAI docs, including upgrade guidance"
  icon_small: "./assets/openai-small.svg"
  icon_large: "./assets/openai.png"
  default_prompt: "Look up official OpenAI docs, load relevant GPT-5.4 upgrade references when applicable, and answer with concise, cited guidance."

dependencies:
  tools:
    - type: "mcp"
      value: "openaiDeveloperDocs"
      description: "OpenAI Developer Docs MCP server"
      transport: "streamable_http"
      url: "https://developers.openai.com/mcp"

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