openai-knowledge
Use when working with the OpenAI API (Responses API) or OpenAI platform features (tools, streaming, Realtime API, auth, models, rate limits, MCP) and you need authoritative, up-to-date documentation (schemas, examples, limits, edge cases). Prefer the OpenAI Developer Documentation MCP server tools when available; otherwise guide the user to enable `openaiDeveloperDocs`.
When & Why to Use This Skill
This Claude skill provides real-time access to authoritative OpenAI Developer Documentation via the Model Context Protocol (MCP). It enables developers to fetch exact markdown docs, OpenAPI schemas, and endpoint details directly from the source, eliminating hallucinations and ensuring technical accuracy when working with OpenAI's Responses API, Realtime API, and platform features.
Use Cases
- Scenario 1: Fetching the latest rate limits and model specifications to optimize API usage and ensure production stability.
- Scenario 2: Retrieving exact OpenAPI schemas and parameter definitions to correctly implement tool calling and function definitions in code.
- Scenario 3: Debugging authentication, streaming, or complex error codes by referencing up-to-date, authoritative documentation instead of outdated training data.
- Scenario 4: Implementing advanced features like the OpenAI Realtime API or MCP integrations using precise, non-hallucinated code examples and architectural guidance.
| name | openai-knowledge |
|---|---|
| description | Use when working with the OpenAI API (Responses API) or OpenAI platform features (tools, streaming, Realtime API, auth, models, rate limits, MCP) and you need authoritative, up-to-date documentation (schemas, examples, limits, edge cases). Prefer the OpenAI Developer Documentation MCP server tools when available; otherwise guide the user to enable `openaiDeveloperDocs`. |
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 ananchor).
- When you need endpoint schemas or parameters, use:
mcp__openaiDeveloperDocs__get_openapi_specmcp__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"
- Add:
Also point to: https://developers.openai.com/resources/docs-mcp#quickstart