New to Claude Skills? Learn how to install them →

openai on GitHub

OpenAI Knowledge

OfficialFree

Access authoritative OpenAI API documentation seamlessly.

Get this skill

Free · Opens the source repo

What OpenAI Knowledge does

The OpenAI Knowledge skill is designed for developers and designers working with the OpenAI API and its associated features. It provides a streamlined process for accessing the latest and most accurate documentation directly from the OpenAI Developer Documentation MCP server. By utilizing this skill, users can avoid the pitfalls of misinformation or outdated references, ensuring they have the correct schemas, examples, and limits at their fingertips.

The workflow begins by checking the availability of the Docs MCP server. If the necessary tools are present, the skill allows users to search for specific documentation and fetch the relevant pages. This is accomplished through a series of MCP commands that enable users to locate the best URLs and retrieve markdown content efficiently. Users can also access detailed endpoint schemas and parameters, which are crucial for effective API integration.

In cases where the MCP is not configured, the skill provides clear guidance on how to set it up. Users can choose between a command-line interface (CLI) method or a configuration file adjustment, along with a link to a quickstart guide. This ensures that even those unfamiliar with the MCP setup can easily enable the necessary tools and restart their Codex session to begin using the skill.

Overall, the OpenAI Knowledge skill is an essential tool for anyone needing reliable access to OpenAI's API documentation. It is particularly useful for developers who require up-to-date information to implement features correctly and efficiently, minimizing errors and enhancing productivity.

When to use it

Use this skill when you need accurate and current documentation for the OpenAI API and its features.

When not to use it

This skill may not be suitable if you do not require real-time access to documentation or are working with APIs outside of OpenAI.

What you can build with it

Integrating OpenAI API in a Project

When starting a new project that requires OpenAI's capabilities, this skill helps you find the relevant documentation quickly.

Debugging API Calls

If you're encountering issues with API calls, use this skill to retrieve the exact documentation needed to troubleshoot effectively.

Learning OpenAI API Features

When learning about new features of the OpenAI API, this skill provides direct access to the latest documentation and examples.

How to install OpenAI Knowledge

View source

1. Install with the skills CLI

npx skills add openai/openai-agents-python/openai-knowledge --agent claude-code

2. Or install it manually

Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.

Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs

Inside SKILL.md

Written by openai

OpenAI Knowledge

Overview

Use the OpenAI Developer Documentation MCP server to search and fetch exact docs (markdown), then base your answer on that text instead of guessing.

Workflow

1) Check whether the Docs MCP server is available

If the mcp__openaiDeveloperDocs__* tools are available, use them.

If you are unsure, run codex mcp list and check for openaiDeveloperDocs.

2) Use MCP tools to pull exact docs

  • Search first, then fetch the specific page or pages.
    • mcp__openaiDeveloperDocs__search_openai_docs → pick the best URL.
    • mcp__openaiDeveloperDocs__fetch_openai_doc → retrieve the exact markdown (optionally with an anchor).
  • When you need endpoint schemas or parameters, use:
    • mcp__openaiDeveloperDocs__get_openapi_spec
    • mcp__openaiDeveloperDocs__list_api_endpoints

Base your answer on the fetched text and quote or paraphrase it precisely. Do not invent flags, field names, defaults, or limits.

3) If MCP is not configured, guide setup (do not change config unless asked)

Provide one of these setup options, then ask the user to restart the Codex session so the tools load:

  • CLI:
    • codex mcp add openaiDeveloperDocs --url https://developers.openai.com/mcp
  • Config file (~/.codex/config.toml):
    • Add:
      [mcp_servers.openaiDeveloperDocs]
      url = "https://developers.openai.com/mcp"
      

Also point to: https://developers.openai.com/resources/docs-mcp#quickstart

Frequently asked questions about OpenAI Knowledge

Similar skills