agentleFS
Sign inStart free
leaf76leaf76/agent-skills/openai-docs/SKILL.md

openai-docs

Skill0 starsChanged 3 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 (for example: Codex, Responses API, Chat Completions, Apps SDK, Agents SDK, Realtime, model capabilities or limits); prioritize OpenAI docs MCP tools and restrict any fallback browsing to official OpenAI domains.

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

Adopted by

Most recently taken up by

Used with

Projects with it also use review-agent and find-skills.

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

  • VercelSkill

    find-skills

    Helps users discover and install agent skills when they ask questions like "how do I do X", "find a skill for X", "is there a skill that can...", or express interest in extending capabilities. This skill should be used when the user is looking for functionality that might exist as an installable skill.

    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

16 rules. 0 are common, 12 are distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 27 edited versions we read keep these.

  • 12

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use mcp__openaiDeveloperDocs__search_openai_docs to find the most relevant doc pages.

    line 13
  2. Very specific:

    Use mcp__openaiDeveloperDocs__fetch_openai_doc to pull exact sections and quote/paraphrase accurately.

    line 14
  3. Very specific:

    Use mcp__openaiDeveloperDocs__list_openai_docs only when you need to browse or discover pages without a clear query.

    line 15
  4. Distinctive:

    If MCP tools fail or no OpenAI docs resources are available:

    line 29
  5. Very specific:

    Run the install command yourself: codex mcp add openaiDeveloperDocs --url https://developers.openai.com/mcp

    line 31
  6. Distinctive:

    If it fails due to permissions/sandboxing, immediately retry the same command with escalated permissions and include a 1-sentence …

    line 32
  7. Distinctive:

    Only if the escalated attempt fails, ask the user to run the install command.

    line 33
  8. Distinctive:

    Ask the user to restart Codex.

    line 34
  9. Distinctive:

    Search docs with a precise query.

    line 40
  10. Distinctive:

    Treat OpenAI docs as the source of truth.

    line 47
  11. Distinctive:

    Keep quotes short and within policy limits.

    line 48
  12. Distinctive:

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

    line 49
  13. Distinctive:

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

    line 50
  14. Distinctive:

    Always use MCP doc tools before any web search for OpenAI-related questions.

    line 54
  15. Distinctive:

    If the MCP server is installed but returns no meaningful results, then use web search as a fallback.

    line 55
  16. Distinctive:

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

    line 56

“Common” is measured: kept by at least 6 in 10 of the 27 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 the developers.openai.com MCP server. Always prioritize the developer docs MCP tools over web.run for OpenAI-related questions. 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.

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 (Codex, OpenAI API, or ChatGPT Apps SDK) and the task.
  2. Search docs with a precise query.
  3. Fetch the best page and the specific section needed (use anchor when possible).
  4. Answer with concise guidance and cite the doc source.
  5. Provide code snippets only when the docs support them.

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.
  • 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.

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.

Check your setup, free