agentleFS
hebertzhuhebertzhu/agent-foundry/skills/openai-docs/SKILL.md

openai-docs

Skill0 starsChanged 8 months agoMITView on GitHub

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 an OpenAI docs MCP integration when available, use bundled references only as helper context, and restrict any fallback browsing to official OpenAI domains.

31 other projects use a version of this, 15 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use review-agent, atlas and 2 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • OpenAISkill

    review-agent

    Perform a read-only, defect-first review of a specified code change and return every actionable finding. Use when another agent delegates review of uncommitted changes, a base-branch diff, a commit, or custom review instructions.

    Also in 3 projects that use this

  • arigaSkill

    atlas

    Database schema management, migrations, data scripts, and Atlas Cloud operations with the Atlas CLI. Use when: generating or applying migrations, diffing, linting, validating, or testing schemas, working with atlas.hcl, schema.hcl, or ORM schemas (GORM, Drizzle, SQLAlchemy, Django, Ent, Sequelize, TypeORM, Prisma), running data backfills, purges, or reports with atlas script, or answering questions about Atlas Cloud: which databases are synced, pending, or failed, recent or failed deployments, what is waiting for deployment, registry repos, and pending plan approvals.

    Also in 3 projects that use this

  • ElasticSkill

    agents-sdk

    Build AI agents on Cloudflare Workers using the Agents SDK. Load when creating stateful agents, durable workflows, real-time WebSocket apps, scheduled tasks, MCP servers, or chat applications. Covers Agent class, state management, callable RPC, Workflows integration, and React hooks.

    Also in 3 projects that use this

  • HK-hubSkill

    computer-use

    Use Orca's computer-use CLI to inspect and operate local desktop app windows through accessibility trees, screenshots, and safe UI actions. Use for desktop app interaction: list apps/windows, get app state, read visible UI, click controls, type, press keys, scroll, drag, set values, or perform accessibility actions. Also use for browser windows, webviews, Orca app UI, or other desktop UI. Triggers include "computer use", "orca computer", "read Spotify", "read Slack", "control/click/read in a desktop app", and "get app state".

    Also in 3 projects that use this

The file

Show its rules and text

We split this skill into the rules it gives an agent

19 rules. 2 are common, 14 are distinctive, and 3 are very specific to this project.

  • 2

    Common

    Most of the 31 edited versions we read keep these.

  • 14

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use the current host's OpenAI docs search capability to find the most relevant doc pages.

    line 13
  2. Distinctive:

    Use the current host's OpenAI docs fetch capability to pull exact sections and quote or paraphrase accurately.

    line 14
  3. Distinctive:

    Use the current host's OpenAI docs listing capability only when you need to browse or discover pages without a clear query.

    line 15
  4. Distinctive:

    If no OpenAI docs MCP integration or equivalent host connector is available:

    line 30
  5. Distinctive:

    Check whether the current host supports MCP or official docs connectors.

    line 32
  6. Distinctive:

    If it does, connect an OpenAI developer docs MCP server or equivalent docs source for that host.

    line 33
  7. Distinctive:

    If the current host cannot connect an MCP server directly, use official OpenAI web docs as the fallback source.

    line 34
  8. Very specific:

    If it is a model-selection request, load references/latest-model.md.

    line 40
  9. Very specific:

    If it is an explicit GPT-5.4 upgrade request, load references/upgrading-to-gpt-5p4.md.

    line 41
  10. Very specific:

    If the upgrade may require prompt changes, or the workflow is research-heavy, tool-heavy, coding-oriented, multi-agent, or long-running, …

    line 42
  11. Distinctive:

    Search docs with a precise query.

    line 43
  12. Distinctive:

    Read only what you need:

    line 50
  13. Common:

    Treat OpenAI docs as the source of truth.

    line 58
  14. Distinctive:

    Keep quotes short and within policy limits.

    line 59
  15. Common:

    If multiple pages differ, call out the difference and cite both.

    line 60
  16. Distinctive:

    If docs do not cover the user’s need, say so and offer next steps.

    line 62
  17. Distinctive:

    Always use an OpenAI docs MCP integration or equivalent host docs connector before any web search for OpenAI-related questions.

    line 66
  18. Distinctive:

    If the docs integration is available but returns no meaningful results, then use web search as a fallback.

    line 67
  19. Distinctive:

    When falling back to web search, restrict to official OpenAI domains (developers.openai.com, platform.openai.com) and cite sources.

    line 68

“Common” is measured: kept by at least 6 in 10 of the 31 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

OpenAI Docs

Provide authoritative, current guidance from OpenAI developer docs using an OpenAI developer docs MCP integration when the current host supports it. Always prioritize that docs integration over general web search 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 docs integration is unavailable or returns no meaningful results should you fall back to official web docs.

Quick start

  • Use the current host's OpenAI docs search capability to find the most relevant doc pages.
  • Use the current host's OpenAI docs fetch capability to pull exact sections and quote or paraphrase accurately.
  • Use the current host's OpenAI docs listing capability 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 the docs integration is missing

If no OpenAI docs MCP integration or equivalent host connector is available:

  1. Check whether the current host supports MCP or official docs connectors.
  2. If it does, connect an OpenAI developer docs MCP server or equivalent docs source for that host.
  3. If the current host cannot connect an MCP server directly, use official OpenAI web docs as the fallback source.
  4. Re-run the doc search and fetch flow once the docs source is available.

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 an OpenAI docs MCP integration or equivalent host docs connector before any web search for OpenAI-related questions.
  • If the docs integration is available 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.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.