首页/技术写作/openai-docs
O

openai-docs

by @openaiv
4.3(47)

通过 MCP 服务器提供来自 OpenAI 开发者文档的权威且最新的指导。

openai-apidocumentationapi-referencesdk-usageai-developmentGitHub
安装方式
npx skills add openai/skills --skill openai-docs
compare_arrows

Before / After 效果对比

1
使用前

在没有OpenAI Docs技能时,开发者需要手动浏览developers.openai.com网站,搜索特定的API用法、模型参数或最佳实践。这过程耗时且可能错过最新或最权威的信息。

使用后

通过OpenAI Docs技能,可以快速、准确地从OpenAI官方开发者文档中获取权威、最新的指导。技能能够直接查询文档内容,提供模型选择建议和GPT-5.4相关请求的参考,大大提高了信息检索效率和准确性。

SKILL.md

openai-docs

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. This skill may also load targeted files from references/ for model-selection and GPT-5.4-specific requests, but current OpenAI docs remain authoritative. 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.

  • Load only the relevant file from references/ when the question is about model selection or a GPT-5.4 upgrade.

OpenAI product snapshots

  • Apps SDK: Build ChatGPT apps by providing a web component UI and an MCP server that exposes your app's tools to ChatGPT.

  • Responses API: A unified endpoint designed for stateful, multimodal, tool-using interactions in agentic workflows.

  • Chat Completions API: Generate a model response from a list of messages comprising a conversation.

  • Codex: OpenAI's coding agent for software development that can write, understand, review, and debug code.

  • gpt-oss: Open-weight OpenAI reasoning models (gpt-oss-120b and gpt-oss-20b) released under the Apache 2.0 license.

  • Realtime API: Build low-latency, multimodal experiences including natural speech-to-speech conversations.

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

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

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

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

  • Ask the user to restart Codex.

  • Re-run the doc search/fetch after restart.

Workflow

  • Clarify the product scope and whether the request is general docs lookup, model selection, a GPT-5.4 upgrade, or a GPT-5.4 prompt upgrade.

  • If it is a model-selection request, load references/latest-model.md.

  • If it is an explicit GPT-5.4 upgrade request, load references/upgrading-to-gpt-5p4.md.

  • If the upgrade may require prompt changes, or the workflow is research-heavy, tool-heavy, coding-oriented, multi-agent, or long-running, also load references/gpt-5p4-prompting-guide.md.

  • Search docs with a precise query.

  • Fetch the best page and the exact section needed (use anchor when possible).

  • For GPT-5.4 upgrade reviews, always make the per-usage-site output explicit: target model, starting reasoning recommendation, phase assessment when relevant, prompt blocks, and compatibility status.

  • Answer with concise guidance and cite the doc source, using the reference files only as helper context.

Reference map

Read only what you need:

  • references/latest-model.md -> model-selection and "best/latest/current model" questions; verify every recommendation against current OpenAI docs before answering.

  • references/upgrading-to-gpt-5p4.md -> only for explicit GPT-5.4 upgrade and upgrade-planning requests; verify the checklist and compatibility guidance against current OpenAI docs before answering.

  • references/gpt-5p4-prompting-guide.md -> prompt rewrites and prompt-behavior upgrades for GPT-5.4; verify prompting guidance against current OpenAI docs before answering.

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.

  • Reference files are convenience guides only; for volatile guidance such as recommended models, upgrade instructions, or prompting advice, current OpenAI docs always win.

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

Weekly Installs449Repositoryopenai/skillsGitHub Stars14.5KFirst SeenFeb 1, 2026Security AuditsGen Agent Trust HubPassSocketPassSnykFailInstalled oncodex409opencode381gemini-cli368github-copilot355kimi-cli344amp342

用户评价 (0)

发表评价

效果
易用性
文档
兼容性

暂无评价

统计数据

安装量2.0K
评分4.3 / 5.0
版本
更新日期2026年5月21日
对比案例1 组

用户评分

4.3(47)
5
77%
4
23%
3
0%
2
0%
1
0%

为此 Skill 评分

0.0

兼容平台

🔧Claude Code
🔧OpenClaw
🔧OpenCode
🔧Codex
🔧Gemini CLI
🔧GitHub Copilot
🔧Amp
🔧Kimi CLI

时间线

创建2026年3月17日
最后更新2026年5月21日