openai-knowledge_skill

Overview

This skill provides authoritative, up-to-date guidance when working with the OpenAI API, Realtime API, platform features, rate limits, and model schemas. It prefers the OpenAI Developer Documentation MCP server for exact documentation and gives clear setup instructions when the MCP is not available. Use it to avoid guessing fields, defaults, or limits and to cite precise docs.

How this skill works

First it checks for the presence of the OpenAI Developer Documentation MCP tools (mcp__openaiDeveloperDocs__*). If available, it runs a targeted search and fetch workflow to retrieve exact markdown pages, OpenAPI specs, or endpoint lists. If the MCP tools are not configured, it provides concise setup instructions for adding the MCP server and asks the user to restart the session so the tools load.

When to use it

• When you need exact API schemas, parameter lists, or example requests/responses.
• When implementing Realtime API, streaming, or auth flows and you want authoritative limits or edge-case behavior.
• When troubleshooting rate limits, model capabilities, or platform tool integrations.
• When generating code that must match official API field names and types.
• When you must cite or paraphrase official documentation rather than rely on memory.

Best practices

• If MCP tools are missing, present the two setup options (CLI and config file) and instruct the user to restart the Codex session so the tools become available.
• When quoting docs, paraphrase precisely and cite the fetched page; mark any limitations or versioning noted in the source.
• For implementation, validate against the fetched OpenAPI spec before deploying changes to ensure compatibility.

Example use cases

• Implementing a streaming Realtime client and needing exact event names and payload schemas.
• Checking model rate limits and retry headers to implement correct backoff logic.
• Generating typed TypeScript clients from the exact OpenAPI spec for production use.
• Verifying auth flows and tool integrations before releasing multi-agent workflows.
• Resolving ambiguity about a parameter or response field by fetching the official doc page and quoting it.