mcpField
O
openai-docs-skill

openai-docs-skill

github.com/am-willDevelopment1.0k1.2k installsUpdated 15w ago
Repository

About openai-docs-skill

openai-docs-skill is a shell-based skill for consulting authoritative OpenAI developer documentation. It helps developers working with OpenAI APIs, SDKs, Apps, or Codex find and fetch current reference pages, then cite their URLs.

Key features

  1. 01Search the documentation index
  2. 02Browse documentation listings
  3. 03Fetch pages or anchored sections
  4. 04Inspect MCP server tools and capabilities
  5. 05Retrieve OpenAPI schemas and samples

Use cases

  1. 01Checking current OpenAI API guidance
  2. 02Finding exact SDK or Codex documentation
  3. 03Citing official docs in technical answers

MCP support

Uses a shell CLI wrapper to query the OpenAI developer documentation MCP server, with search, list, fetch, and capability-inspection commands.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/am-will/codex-skills --skill openai-docs-skill

After installing, type/openai-docs-skillin Claude Code to confirm it loaded.

Bundled filesscripts/openai-docs-mcp.sh

Details

From the project README

OpenAI Docs MCP Skill

Overview

Use the OpenAI developer documentation MCP server from the shell to search and fetch authoritative docs. Always do this for OpenAI platform work instead of relying on memory or non-official sources.

Core rules

  • Always use this skill for OpenAI API/SDK/Apps/Codex questions or when precise, current docs are required.
  • Query the MCP server via the CLI wrapper in scripts/openai-docs-mcp.sh (do not rely on Codex MCP tools).
  • Use search or list to find the best doc page, then fetch the page (or anchor) for exact text.
  • Surface the doc URL you used in your response so sources are clear.

Quick start

scripts/openai-docs-mcp.sh search "Responses API" 5
scripts/openai-docs-mcp.sh fetch https://platform.openai.com/docs/guides/migrate-to-responses

Workflow

  1. Discover: search with a focused query. If unsure, use list to browse.
  2. Read: fetch the most relevant URL (optionally add an anchor).
  3. Apply: summarize and/or quote relevant sections; include the URL.

Script reference

The CLI wrapper is at scripts/openai-docs-mcp.sh and uses curl + jq against https://developers.openai.com/mcp.

Subcommands:

  • init: initialize and inspect server capabilities.
  • tools: list available tools on the MCP server.
  • search <query> [limit] [cursor]: return JSON hits from the docs index.
  • list [limit] [cursor]: browse docs index.
  • fetch <url> [anchor]: return markdown for a doc page or section.
  • endpoints: list OpenAPI endpoints.
  • openapi <endpoint-url> [lang1,lang2] [code-only]: fetch OpenAPI schema or code samples.

Environment:

  • MCP_URL: override the default MCP endpoint.

Comments

Markdown supported