diff --git a/plugins/openai-developers/.codex-plugin/plugin.json b/plugins/openai-developers/.codex-plugin/plugin.json index d5dc81b81..ddeef3cc8 100644 --- a/plugins/openai-developers/.codex-plugin/plugin.json +++ b/plugins/openai-developers/.codex-plugin/plugin.json @@ -1,6 +1,6 @@ { "name": "openai-developers", - "version": "1.2.3", + "version": "1.3.0", "description": "Build with OpenAI APIs, Agents SDK, and ChatGPT Apps, and create and save OpenAI API keys from Codex.", "author": { "name": "OpenAI", diff --git a/plugins/openai-developers/README.md b/plugins/openai-developers/README.md index f2bf11f49..85fe46bab 100644 --- a/plugins/openai-developers/README.md +++ b/plugins/openai-developers/README.md @@ -7,6 +7,7 @@ This plugin is the Codex-facing bundle for OpenAI developer workflows. It pairs - `.codex-plugin/plugin.json` declares the Codex plugin metadata and user-facing `OpenAI Developers` brand. - `.app.json` exposes the `openai-platform` app connector used to work with the OpenAI Platform. - `.mcp.json` and `mcp/server.mjs` provide an editable local destination confirmation form for the API-key setup flow. +- `skills/openai-docs/` retrieves current OpenAI documentation and applies model-aware GPT-5.6 prompting and migration guidance. - `skills/openai-platform-api-key/` handles encrypted API-key creation and local project setup; its preferred flow uses the OpenAI Platform connector-owned picker for the key name, organization, and project, then requests local confirmation of the env-file destination before writing locally. - `skills/openai-api-troubleshooting/` classifies common runtime API failures and routes users to the right next step. - `assets/openai-platform.png` is intentionally shared by both the plugin tile and the bundled OpenAI Platform app tile. diff --git a/plugins/openai-developers/skills/openai-docs/LICENSE.txt b/plugins/openai-developers/skills/openai-docs/LICENSE.txt new file mode 100644 index 000000000..13e25df86 --- /dev/null +++ b/plugins/openai-developers/skills/openai-docs/LICENSE.txt @@ -0,0 +1,201 @@ +Apache License +Version 2.0, January 2004 +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf of + any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don\'t include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/plugins/openai-developers/skills/openai-docs/SKILL.md b/plugins/openai-developers/skills/openai-docs/SKILL.md new file mode 100644 index 000000000..d96aa875b --- /dev/null +++ b/plugins/openai-developers/skills/openai-docs/SKILL.md @@ -0,0 +1,178 @@ +--- +name: "openai-docs" +description: "Use when the user asks how to build with OpenAI products or APIs, asks about Codex itself or choosing Codex surfaces, needs up-to-date official documentation with citations, help choosing the latest model for a use case, latest/current/default-model prompting guidance, or model upgrade and prompt-upgrade guidance; use OpenAI docs MCP tools for non-Codex docs questions, use the Codex manual helper first for broad Codex self-knowledge, and restrict fallback browsing to official OpenAI domains." +--- + + +# OpenAI Docs + +Provide authoritative, current guidance from OpenAI developer docs using the developers.openai.com MCP server. "Docs MCP" means `mcp__openaiDeveloperDocs__search_openai_docs` and `mcp__openaiDeveloperDocs__fetch_openai_doc`; for API reference, schema, parameter, or required-field questions, also use `mcp__openaiDeveloperDocs__get_openapi_spec` when available. Official-domain web search is fallback after those tools are unavailable or unhelpful. Broad Codex questions use the manual helper before Docs MCP. This skill also owns model selection, API model migration, and prompt-upgrade guidance. + +## API Key Setup + +For requests to build, run, configure, debug, or implement an API-backed app, script, CLI, generator, or tool, use `openai-platform-api-key` first when available. After that credential gate is resolved, return here for current docs as needed. + +Use this skill directly for docs-only questions, citations, model/API guidance, conceptual explanations, and examples that do not require building or running an API-backed artifact. + +For latest/current/default/unspecified model migration or prompting-guidance requests, complete the read-only latest-model resolver and guide fetch before the API-key credential gate. The credential gate still blocks edits, tests, and API-backed implementation until resolved; it does not block read-only retrieval of current model, migration, or prompting guidance. + +## First action for latest-model changes + +Before reading memory, inspecting the repo, fetching docs, or checking API credentials, classify the request: + +- **Latest/current prompting guidance, or change requested + latest/current/newest/recommended/default/flagship/unspecified target:** immediately execute `/scripts/resolve-latest-model-info` and inspect its JSON output. This includes asking how to prompt the latest model, changing prompts, a model picker, model references, an SDK integration, replacing an older named model with "the current model", or asking "which model should I migrate/upgrade to?". Do not directly fetch `latest-model.md` for this branch. +- **Pure model-selection question only, with no prompting guidance or requested change:** directly fetch `https://developers.openai.com/api/docs/guides/latest-model.md`; do not run the resolver. +- **Change requested + explicit target model:** preserve that target; do not run the latest-model resolver. For an explicit GPT-5.6 Sol or GPT-5.6-family migration, fetch the live GPT-5.6 model-guidance page and read `references/upgrading-to-gpt-5p6-sol.md` for skill-specific migration judgment. +- **Prompting or migration guidance for an explicitly named GPT-5-family model:** fetch `https://developers.openai.com/api/docs/guides/model-guidance?model=` through Docs MCP and extract the relevant migration section or the `## Prompting Best Practices` section through the next H2 heading. Do not substitute latest-model guidance. + +For the resolver branch, do not suppress or redirect its stdout. Success requires JSON containing `model`, `migrationGuideUrl`, and `promptingGuideUrl`; if the command exits without all three fields, run it once more before any fallback. + +## Source Priority + +- For Codex self-knowledge, use the Codex source route below; it owns when to use the manual helper, Docs MCP, or bounded uncertainty. +- For non-Codex OpenAI docs questions, use `mcp__openaiDeveloperDocs__search_openai_docs` to find the most relevant doc pages. +- For non-Codex OpenAI docs questions, fetch the relevant page with `mcp__openaiDeveloperDocs__fetch_openai_doc` before answering. If search is noisy, run a narrower Docs MCP search; when any plausible official OpenAI docs URL is known or found, try fetching that URL through Docs MCP before relying on web-search content. +- For API reference, schema, parameter, or required-field questions, use `mcp__openaiDeveloperDocs__get_openapi_spec` when available to verify the API shape alongside the relevant guide or reference page. +- Use `mcp__openaiDeveloperDocs__list_openai_docs` only when you need to browse or discover non-Codex pages without a clear query. +- For latest/current prompting guidance, model upgrades, or prompt upgrades, apply the first-action classifier above. Run /scripts/resolve-latest-model-info rather than the implementation file. When `load_workspace_dependencies` is available, you may set `NODE` to its returned Node.js executable before running the wrapper, but do not depend on that tool being available or remembered. The wrapper uses `$NODE` when supplied, then PATH and bundled/system fallbacks. If it reports no usable runtime, call `load_workspace_dependencies` when available, set `NODE` to the returned Node.js executable, and retry the wrapper once. +- For docs-only model-selection questions that do not ask to change an app, project, repo, model configuration, or prompts, fetch `https://developers.openai.com/api/docs/guides/latest-model.md` first. If that is unavailable, load `references/latest-model.md`. +- Preserve explicit target requests: if the user names a target model like "migrate to GPT-5.4", keep that requested target even if `latest-model.md` names a newer model. Mention newer guidance only as optional. +- If current remote guidance is needed, treat the returned migration and prompting guide URLs as opaque and fetch those exact URLs directly. Do not derive, substitute, or append a model query to them. If a prompting guide URL resolves to a combined model-guidance page, extract only the `## Prompting Best Practices` section through the next H2 heading. If a fetched guide contains only a title or no substantive body, retry the exact markdown URL through MCP/search fallback; if that also fails, use bundled fallback references and disclose the fallback. + +## OpenAI product snapshots + +1. Apps SDK: Build ChatGPT apps by providing a web component UI and an MCP server that exposes your app's tools to ChatGPT. +2. Responses API: A unified endpoint designed for stateful, multimodal, tool-using interactions in agentic workflows. +3. Chat Completions API: Generate a model response from a list of messages comprising a conversation. +4. Codex: OpenAI's coding agent for software development that can write, understand, review, and debug code. +5. gpt-oss: Open-weight OpenAI reasoning models (gpt-oss-120b and gpt-oss-20b) released under the Apache 2.0 license. +6. Realtime API: Build low-latency, multimodal experiences including natural speech-to-speech conversations. +7. 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. + +## Codex self-knowledge + +Use this path for questions about Codex itself: configuring, extending, operating, troubleshooting, local state, product surfaces, or where Codex behavior should live. A codebase merely mentioning a plugin, skill, hook, MCP server, browser, or automation is not enough. For generic software tasks, answer the software task directly; if asked whether Codex self-knowledge applies, answer that meta question briefly and continue the requested artifact. + +### Source Route + +The Codex manual is the first source for broad Codex synthesis. Treat the manual and Docs MCP as different lanes, not interchangeable official-doc sources. For published-user Codex product answers, the source route is complete: the manual, Docs MCP when this route calls for it, official OpenAI web fallback, and callable capabilities surfaced in the current session when the question is about that capability. Knowledge bases outside developers.openai.com are outside this route for public product answers. + +For broad Codex behavior, setup, customization, skills, plugins, MCP, hooks, `AGENTS.md`, automations, surfaces, local state, or system-map questions: + +1. Reuse a same-thread manual and outline path when it is still fresh. +2. Otherwise run the skill-local helper first in normal writable sessions. Skip it without trying only when the session is explicitly read-only, shell execution is unavailable, or visible policy shows no allowed temp cache. +3. By default, the helper chooses the first usable temp cache dir in this order: `$TMPDIR/openai-docs-cache`, `%TEMP%\openai-docs-cache`, `%TMP%\openai-docs-cache`, `/private/tmp/openai-docs-cache`, then `/tmp/openai-docs-cache`. Workspace-only write access is not enough for this temp cache. +4. Run the helper directly unless you need to override the cache dir. The helper falls back to `curl` when native `fetch` is unavailable or when proxy env vars are present, so no shell-specific proxy prefix is required. Resolve `` to this skill's actual directory; in copied local eval workdirs this is usually `.codex/skills/openai-docs`: + +```bash +node /scripts/fetch-codex-manual.mjs +``` + +If you need to override the cache dir, pass `--cache-dir `. On Windows, the helper checks `%TEMP%` and `%TMP%` automatically; in PowerShell, `$env:TEMP\\openai-docs-cache` is a typical explicit override. + +Treat helper availability as established by explicit read-only/no-shell policy or an actual command result. A guessed sandbox or guessed helper failure is not enough to switch to Docs MCP or web lookup; after an actual helper command failure, continue to the narrowest official next source below. + +The helper verifies freshness, writes `codex-manual.md`, and emits `codex-manual.outline.md`. The outline maps source pages and headings to line ranges; use it to choose the relevant manual section, then read or search targeted manual sections for Codex product facts. Use the skill directory to locate and run the helper; after the helper succeeds, use the returned manual and outline paths as the search scope for Codex product facts and term coverage checks. + +Reuse the same-thread manual and outline paths for follow-up Codex questions. Refresh first when the manual was fetched more than about a day ago, the path is unusable, the path came from another thread or uncertain provenance, or likely-current information is missing and staleness is plausible. + +For questions about whether the manual is current enough to rely on now, run the helper when temp caching is allowed and base the answer on its returned status, manual path, and outline path. + +If the manual resolves a Codex claim, answer from it and stop expanding sources for that claim; continue the user's broader task if the docs lookup was only one dependency. Manual source pages and known anchors are enough citation support for manual-covered material. + +If the helper is skipped because the session is read-only, has no shell execution, or has no allowed temp cache, the next source is Docs MCP: call `mcp__openaiDeveloperDocs__search_openai_docs`, then `mcp__openaiDeveloperDocs__fetch_openai_doc` for a relevant hit before any web fallback. + +If a user names a Codex term or mode that a fresh manual does not use, search the manual for obvious adjacent concepts, then answer that the exact term is not documented and use the closest documented terminology. If the prompt asks how that term maps to Codex behavior, resolve the mapping from adjacent manual sections. If the exact term remains material or likely current after that manual pass, use one narrow Docs MCP search/fetch before bounded uncertainty; otherwise, the source lookup for that terminology or mapping claim is complete. + +Use the narrowest official next source only when the manual is unavailable, the helper fails, temp caching is not allowed, another material claim is missing or likely stale, or the user explicitly needs a page-specific citation. Prefer one specific Docs MCP search and, if it returns a clearly relevant page, one fetch; for unresolved Codex capability names, acronyms, scheduling terms, or exact error text, this Docs MCP step is the next source before web search. After the manual plus any permitted Docs MCP gap-fill, resolve remaining gaps as bounded uncertainty. Use official-domain web fallback only after that Docs MCP path is unavailable or unhelpful. If the claim is still not established, stop with bounded uncertainty. If official docs/manual conflict with a callable capability already surfaced in the current session, state the conflict and prefer verified current-session behavior for that environment. + +For undocumented or private-looking model slugs, product mode labels, entitlement labels, account access paths, or rollout names, answer from current public docs and bounded uncertainty. Those labels are not a reason to leave the public source route. + +For support-style diagnostics, prefer a layer-by-layer answer from the manual over provider-specific web lookups: installed/enabled plugin, bundled app or connector authorization, MCP setup, workspace/admin policy, restart or new-thread expectations, then support or feedback if still unresolved. + +If the source route still does not establish a claim, return bounded uncertainty or route to support, an admin, or product feedback instead of widening the investigation. + +For unresolved product terminology, answer from the manual plus the allowed official next source. If those sources do not establish the term, answer with bounded uncertainty from those sources. + +### Surface Map + +When Codex nouns or durable-instruction surfaces overlap, recommend the smallest surface that matches the scope: + +- Prompt or thread context -> one-off task constraints. +- `AGENTS.md` -> durable repo conventions, commands, verification steps, and review expectations; closer nested files apply under their subtree. +- Project `.codex/config.toml` -> trusted-repo Codex settings such as sandbox, MCP, hooks, model, or reasoning defaults. +- Global config or global guidance -> personal defaults across repos. +- Skill -> reusable task workflow with references or scripts. +- Plugin -> installable bundle with skills plus commands, tools, MCP config, hooks, assets, apps, or marketplace metadata. +- MCP server or app connector -> live external data/actions or authorized private app/workspace data. Use connectors for private Google Docs, Calendar, Slack, GitHub, Notion, and similar data instead of web search or model memory. +- Automation -> scheduled checks, reminders, monitors, or follow-up work; use a thread heartbeat when continuity in an existing thread matters. +- Hook -> lifecycle enforcement around tool calls, commands, or file edits. + +Split mixed-scope requests instead of forcing one answer. Example: "always do X, but only for this PR" defaults to prompt/thread context for the current run; use `AGENTS.md` or project config only if it should persist, hooks only for mechanical enforcement, and automations only for scheduled or follow-up work. + +Use this quick product map when needed: CLI is terminal-first local repo work; IDE extension is editor-attached coding; Codex app is desktop planning, review, and interactive work; cloud/web is hosted parallel/offloaded work; Browser Use/in-app browser is Codex-controlled web testing; Chrome extension uses the user's Chrome profile; Computer Use controls desktop apps and OS UI. Keep `config.toml` defaults, `requirements.toml` constraints, and managed/admin policy separate. + +### Boundaries And Output + +- API key auth does not imply ChatGPT, cloud task, or connector access. For plugin/app/auth failures, check bundle availability, plugin installed/enabled state, connector/app authorization, MCP setup, restart/refresh expectations, workspace policy, and per-surface availability before answering. +- Sandbox or network denials need scoped escalation with a clear justification. Destructive commands, writes outside the workspace, or broad access changes require explicit approval. +- Memory can provide user preference or context, but explicit prompt instructions win and memory is not a source for current external facts. +- For affirmative surface-selection answers, use this shape: recommendation, why, what to avoid, and the manual/source evidence used. +- When page-specific Codex citations are actually needed, these anchors often fit: `concepts/customization#agents-guidance` for `AGENTS.md`, `concepts/customization#skills` for skills, `plugins/build#plugin-structure` for plugins, `concepts/customization#mcp` for MCP, `config-advanced#hooks` for hooks, `app/automations#thread-automations` for thread automations, and `config-reference#configtoml` for config. + +## If MCP server is missing + +If MCP tools fail or no OpenAI docs resources are available: + +1. Run the install command yourself: `codex mcp add openaiDeveloperDocs --url https://developers.openai.com/mcp` +2. If it fails due to permissions/sandboxing, immediately retry the same command with escalated permissions and include a 1-sentence justification for approval. +3. Ask the user to run the install command only if the escalated attempt fails. +4. Ask the user to restart Codex. +5. Re-run the doc search/fetch after restart. + +## Workflow + +1. Clarify whether the request is general docs lookup, model selection, a model-string upgrade, prompt-upgrade guidance, or broader API/provider migration. +2. For Codex self-knowledge requests, follow the Codex self-knowledge source procedure above. +3. For model-selection or upgrade requests, prefer current remote docs over bundled references when the user asks for latest/current/default guidance. + - For docs-only model-selection questions, fetch `https://developers.openai.com/api/docs/guides/latest-model.md`, find the latest model ID and explicit migration or prompt-guidance links, and prefer explicit links over derived URLs. + - For explicit named-model requests, preserve the requested model target. Mention newer remote guidance only as optional. + - For latest/current/default prompting guidance or dynamic upgrades, run /scripts/resolve-latest-model-info as the first docs operation before any direct latest-model.md fetch or API-key credential gate, then fetch both returned guide URLs directly when possible. + - Fetch returned guide URLs exactly; do not derive or substitute model-specific URLs. + - If a direct guide fetch fails or returns only a title, use the developer-docs MCP tools or official OpenAI-domain search to find the same guide content. + - If remote docs are unavailable, use bundled fallback references and say that fallback guidance was used. +4. For model upgrades, keep changes behavior-preserving and scoped: update active OpenAI API model defaults, directly related prompts, and the registries, routing, pricing, capability, or picker surfaces that the user actually placed in scope. +5. Leave historical docs, examples, eval baselines, fixtures, provider comparisons, intentionally pinned fallbacks, and ambiguous older model usage unchanged unless the user explicitly asks to upgrade them. Do not collapse a multi-model router or picker into one flagship model; preserve the existing cost, latency, and quality roles. +6. Keep SDK, tooling, IDE, plugin, shell, auth, and provider-environment migrations out of a model-and-prompt upgrade unless the user explicitly asks for them. +7. If a safe upgrade needs API-surface changes, schema rewiring, tool-handler changes, or broader implementation work, classify it explicitly. Make those changes when implementation is within the user's requested scope; otherwise report the exact blocker or confirmation needed instead of silently changing behavior. +8. For general docs lookup, start with a compact, title-like search query of 2-6 essential terms. Do not turn the full user question into a keyword list. Fetch the best page and exact section needed, and answer with concise citations. + +## Reference map + +Read only what you need: + +- `https://developers.openai.com/api/docs/guides/latest-model.md` -> current model-selection and "best/latest/current model" questions. +- `scripts/fetch-codex-manual.mjs` -> current Codex manual fetch, verification, local temp cache, and outline generation. +- `https://developers.openai.com/codex/codex-manual.md` -> current Codex self-knowledge synthesis, including setup, customization, skills, plugins, MCP, hooks, `AGENTS.md`, automations, and surface behavior; normally access it through the helper path and targeted file reads when temp caching is available. +- `references/latest-model.md` -> bundled fallback for model-selection and "best/latest/current model" questions. +- `references/upgrade-guide.md` -> bundled routing fallback for model upgrade and upgrade-planning requests. +- `references/upgrading-to-gpt-5p6-sol.md` -> GPT-5.6 Sol/family migration judgment, compatibility gates, optional feature boundaries, and validation. +- `references/prompting-guide.md` -> bundled GPT-5.6 prompting fallback plus the live Prompting Best Practices extraction contract. + +## Quality rules + +- Treat OpenAI docs as the source of truth; avoid speculation. +- For Codex self-knowledge, follow the source route above instead of relying on remembered behavior. +- Keep migration changes narrow and behavior-preserving. +- Prefer prompt-only upgrades when possible. +- Avoid inventing pricing, availability, parameters, API changes, or breaking changes. +- Keep quotes short and within policy limits; prefer paraphrase with citations. +- If multiple pages differ, call out the difference and cite both. +- If official docs and verified callable current-session behavior disagree, state the conflict before making broad claims or edits. +- If docs do not cover the user’s need, say so and offer next steps. + +## Tooling notes + +- Use MCP doc tools before web search for OpenAI-related markdown docs. The Codex manual flow is the exception: follow the Codex self-knowledge source procedure for broad Codex synthesis. +- 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. diff --git a/plugins/openai-developers/skills/openai-docs/agents/openai.yaml b/plugins/openai-developers/skills/openai-docs/agents/openai.yaml new file mode 100644 index 000000000..8bbf03c20 --- /dev/null +++ b/plugins/openai-developers/skills/openai-docs/agents/openai.yaml @@ -0,0 +1,14 @@ +interface: + display_name: "OpenAI Docs" + short_description: "Reference OpenAI docs, Codex self-knowledge, and model migration guidance" + icon_small: "./assets/openai-small.svg" + icon_large: "./assets/openai.png" + default_prompt: "Use OpenAI Docs for official docs lookup, questions about Codex itself or Codex surfaces, model selection, model migration, and prompt-upgrade work." + +dependencies: + tools: + - type: "mcp" + value: "openaiDeveloperDocs" + description: "OpenAI Developer Docs MCP server" + transport: "streamable_http" + url: "https://developers.openai.com/mcp" diff --git a/plugins/openai-developers/skills/openai-docs/assets/openai-small.svg b/plugins/openai-developers/skills/openai-docs/assets/openai-small.svg new file mode 100644 index 000000000..1d075dc04 --- /dev/null +++ b/plugins/openai-developers/skills/openai-docs/assets/openai-small.svg @@ -0,0 +1,3 @@ + + + diff --git a/plugins/openai-developers/skills/openai-docs/assets/openai.png b/plugins/openai-developers/skills/openai-docs/assets/openai.png new file mode 100644 index 000000000..e9b9eb80c Binary files /dev/null and b/plugins/openai-developers/skills/openai-docs/assets/openai.png differ diff --git a/plugins/openai-developers/skills/openai-docs/references/latest-model.md b/plugins/openai-developers/skills/openai-docs/references/latest-model.md new file mode 100644 index 000000000..b3b173d94 --- /dev/null +++ b/plugins/openai-developers/skills/openai-docs/references/latest-model.md @@ -0,0 +1,40 @@ +# Latest model guide + +This file is a curated helper. Every recommendation here must be verified against current OpenAI docs before it is repeated to a user. + +## Current model map + +| Model ID | Use for | +| --- | --- | +| `gpt-5.6` | Latest/default GPT-5.6 alias; routes to Sol | +| `gpt-5.6-sol` | Flagship GPT-5.6 tier for hardest quality-first, coding, and reasoning workflows | +| `gpt-5.6-terra` | Mini-like GPT-5.6 tier for balanced cost, latency, and quality | +| `gpt-5.6-luna` | Nano-like GPT-5.6 tier for high-throughput, simple, or strict-latency tasks | +| `gpt-5.5` | Previous default text and reasoning model; use for existing GPT-5.5 integrations | +| `gpt-5.4` | Older default text and reasoning model; use for existing GPT-5.4 integrations | +| `gpt-5.4-mini` | Older lower-cost testing and lighter production workflows | +| `gpt-5.4-nano` | Older high-throughput simple tasks and classification | +| `gpt-4.1-mini` | Cheaper no-reasoning text | +| `gpt-4.1-nano` | Fastest and cheapest no-reasoning text | +| `gpt-5.3-codex` | Agentic coding, code editing, and tool-heavy coding workflows | +| `gpt-5.1-codex-mini` | Cheaper coding workflows | +| `gpt-image-2` | Best image generation and edit quality | +| `gpt-image-1.5` | Less expensive image generation and edit quality | +| `gpt-image-1-mini` | Cost-optimized image generation | +| `gpt-4o-mini-tts` | Text-to-speech | +| `gpt-4o-mini-transcribe` | Speech-to-text, fast and cost-efficient | +| `gpt-realtime-1.5` | Realtime voice and multimodal sessions | +| `gpt-realtime-mini` | Cheaper realtime sessions | +| `gpt-audio` | Chat Completions audio input and output | +| `gpt-audio-mini` | Cheaper Chat Completions audio workflows | +| `sora-2` | Faster iteration and draft video generation | +| `sora-2-pro` | Higher-quality production video | +| `omni-moderation-latest` | Text and image moderation | +| `text-embedding-3-large` | Higher-quality retrieval embeddings; default in this skill because no best-specific row exists | +| `text-embedding-3-small` | Lower-cost embeddings | + +## Maintenance notes + +- GPT-5.6 Pro is a Responses reasoning mode on the base model, not a separate `gpt-5.6-pro` slug. Verify the live model guide before recommending its request shape. +- This file will drift unless it is periodically re-verified against current OpenAI docs. +- If this file conflicts with current docs, the docs win. diff --git a/plugins/openai-developers/skills/openai-docs/references/prompting-guide.md b/plugins/openai-developers/skills/openai-docs/references/prompting-guide.md new file mode 100644 index 000000000..a9d407c99 --- /dev/null +++ b/plugins/openai-developers/skills/openai-docs/references/prompting-guide.md @@ -0,0 +1,287 @@ +## Retrieve the live GPT-5.6 prompting guidance + +Use the OpenAI Docs MCP to fetch the live GPT-5.6 prompting guidance from: + +https://developers.openai.com/api/docs/guides/model-guidance?model=gpt-5.6#prompting-best-practices + +Read only the `## Prompting Best Practices` section, stopping at the next H2 heading. The URL anchor points to the section visually, but the Docs MCP may return the full page, so explicitly extract only that section. + +Treat the live section as the canonical model-specific prompting guidance. Use the local guidance below only for skill-specific migration judgment: deciding what to preserve, remove, rewrite, or test when adapting an existing prompt stack to GPT-5.6. + +## Skill-specific migration judgment + +GPT-5.6 works best when prompts define the outcome, important constraints, available evidence, and completion bar, then leave room for the model to choose an efficient path. Compared with earlier GPT-5 models, many applications can use shorter prompts and smaller tool sets without losing quality. + +Do not carry over every instruction from an older prompt stack. Legacy prompts often repeat rules, prescribe unnecessary steps, expose irrelevant tools, or include examples that no longer change behavior. With GPT-5.6, this can encourage extra exploration, repeated validation, and larger accumulated context. + +Start with the smallest prompt and tool set that passes your evals. Add an instruction, example, or tool only when it fixes a measured failure mode. + +## Simplify prompts first + +When migrating an existing prompt, remove redundant scaffolding before adding new GPT-5.6-specific instructions. + +Trim: + +- repeated statements of the same rule; +- generic “be thorough,” “be concise,” or “think step by step” language; +- examples that do not change behavior; +- process instructions for behavior the model already performs reliably; +- tools and tool descriptions unrelated to the task. + +Keep: + +- the user-visible outcome; +- success criteria and stopping conditions; +- safety, business, evidence, and permission constraints; +- tool-routing rules when the correct route is not obvious; +- required output shape and validation requirements. + +Review the remaining instructions for contradictions. GPT-5-class models follow prompt contracts closely, so conflicting rules can create more instability than missing detail. + +## Outcome-first prompts and stopping conditions + +Describe the destination rather than prescribing every step. GPT-5.6 can usually choose an efficient search, tool, or reasoning path when the prompt states what good looks like. + +Prefer: + + Resolve the customer's issue end to end. + + Success means: + - make the eligibility decision from available policy and account evidence + - complete any allowed action before responding + - return completed_actions, customer_message, and blockers + - if required evidence is missing, ask for the smallest missing field + +Avoid unnecessary absolute rules. Use ALWAYS, NEVER, must, and only for true invariants such as safety rules, required fields, or actions that should never happen. For judgment calls, such as when to search, ask, use a tool, or keep iterating, prefer decision rules. + +Preserve explicit user values. When the correct value is implicit, provide decision criteria and let the model reason from context or schema. Avoid universal defaults, keyword maps, and broad semantic shortcuts. + +Add stopping conditions: + + Resolve the request in the fewest useful tool loops, but do not let loop + minimization outrank correctness, required evidence, calculations, or + required citations. + + After each result, ask whether the core request can now be answered with + useful evidence. If yes, answer. If required evidence is still missing, + name the missing fact and use the smallest useful fallback. + +## Personality, collaboration, and response length + +GPT-5.6 is efficient, direct, and more compressed than recent models. For customer-facing assistants and collaborative products, define both personality and collaboration style. + +- Personality controls tone, warmth, directness, formality, humor, empathy, and polish. +- Collaboration style controls when the model asks questions, makes assumptions, takes initiative, explains tradeoffs, checks work, and handles uncertainty. + +Keep both short. Personality should shape the user experience; collaboration instructions should shape task behavior. Neither should replace clear goals, success criteria, tool rules, or stopping conditions. + +Use concrete writing controls: + + Lead with the conclusion. Include the evidence needed to support it, any + material caveat, and the next action. Keep all required facts, decisions, + caveats, and next steps. Trim introductions, repetition, generic reassurance, + and optional background first. + +Avoid generic “be brief,” “keep it short,” or “use minimal text” instructions. GPT-5.6 is already biased toward compression, and generic brevity can make it omit required evidence or parts of an artifact. + +For customer-facing tone, prefer concrete guidance: + + Be direct and tactful. Acknowledge friction specifically when relevant. + Avoid canned reassurance and unnecessary sign-offs. + +Avoid blanket language rules such as “always respond in the user's language” unless that is truly the product requirement. Specify the intended output language and when it should change. + +For editing, rewriting, summaries, and customer-facing drafts, tell the model what to preserve: + + Preserve the requested artifact, length, structure, genre, and factual claims + first. Improve clarity, flow, and correctness without adding new claims, + sections, or a more promotional tone unless requested. + +## Autonomy and permissions + +GPT-5.6 can be proactive and persistent. Define which level of action each request authorizes. + + For requests to answer, explain, review, diagnose, or plan, inspect the + relevant materials and report the result. Do not implement changes unless + the request also asks for them. + + For requests to change, build, or fix, make the requested in-scope local + changes and run relevant non-destructive validation without asking first. + + Require confirmation for external writes, destructive actions, purchases, + or a material expansion of scope. + +Specify which local actions are safe without approval, such as reading files, inspecting logs, searching, editing in-scope code, and running non-destructive tests. + +Avoid repeating “ask first” throughout the prompt. Repetition can cause unnecessary permission checks even for safe, expected actions. + +For long-running work, define the current layer of work. Distinguish research, design, implementation, review, and external coordination so the model does not silently move from one layer to another. + +## Tool routing + +Expose only task-relevant tools. Tool descriptions should state what the tool does, when to use it, important return fields, and error behavior. + +When correctness depends on prerequisite retrieval or lookup, say so: + + Before taking an action, resolve required discovery, retrieval, and + validation steps. Do not skip a prerequisite because the intended final + state seems obvious. + +When several reads are independent, parallelize them. When one result determines the next action, keep the work sequential. After parallel retrieval, synthesize before acting. + +If a tool returns empty, partial, or suspiciously narrow results, try one or two meaningful fallbacks before concluding that no result exists. + +## Programmatic Tool Calling + +Programmatic Tool Calling is useful when code can reduce large, structured intermediate results before they return to model context. + +Use it for: + +- filtering, joining, sorting, ranking, deduplication, and aggregation; +- batching across many similar records; +- repeated deterministic validation; +- large structured results that can be reduced to a compact schema. + +Prefer direct tool calls when: + +- one call is sufficient; +- intermediate outputs are already small; +- each result may change the next decision; +- an action requires approval; +- the final answer must preserve citations or native artifacts; +- the workflow requires semantic judgment between calls. + +Do not rely on generic instructions such as “use Programmatic Tool Calling efficiently.” State the bounded stage, eligible tools, output schema, retry limit, stop condition, and handoff back to direct model judgment. + + Use Programmatic Tool Calling only for the bounded record-reduction stage. + Call only the documented read-only tools. Filter and deduplicate the + intermediate results, then emit exactly the required compact schema with + evidence fields. Retry transient failures at most twice. Use direct tool + calls for approval, semantic judgment, citations, and final validation. + +Evaluate the final user-visible answer, not only the program result. Lower tokens, latency, calls, or turns are improvements only when the final answer still meets the required quality bar. + +## Grounding, citations, and retrieval budgets + +For grounded answers, citation behavior should be part of the prompt. Define what needs support, what counts as enough evidence, and how to behave when evidence is missing. Absence of evidence should not automatically become a factual “no.” + + For ordinary Q&A, start with one broad search using short, discriminative + keywords. If the top results contain enough support for the core request, + answer from those results. + + Make another retrieval call only when a required fact, owner, date, ID, or + source is missing; the user asked for exhaustive coverage or comparison; a + specific artifact must be read; or an important claim would otherwise be + unsupported. + + Do not search again only to improve phrasing, add examples, or support + nonessential detail. + +For research and synthesis: + +- cite only retrieved sources; +- attach citations to the claims they support; +- label inference separately from directly supported facts; +- state conflicts between sources; +- narrow the answer or report missing evidence instead of guessing. + +For creative drafting, distinguish source-backed facts from creative wording. Do not invent names, metrics, dates, roadmap status, customer outcomes, or product capabilities to make a draft sound stronger. + +## Long-running workflows and state + +For multi-step or tool-heavy tasks, prompt for a short visible preamble before the first tool call, then sparse outcome-based updates at major phase changes. Do not ask the model to narrate routine tool calls. + + Before tool calls for a multi-step task, send a one- or two-sentence + user-visible update that states the first step. During the task, update only + when a major phase begins or a finding changes the plan. Each update should + state one concrete outcome and the next step. + +Preserve assistant phase values when replaying history so the model can distinguish commentary from the final answer. If using previous_response_id, prior assistant state is preserved automatically. If replaying history manually, preserve each original phase value unchanged. + +Compact after major milestones rather than every turn. Keep the prompt functionally consistent after compaction and treat compacted items as opaque state. + +Persisted reasoning is useful when the objective, assumptions, and priorities remain stable across turns. Use current-turn behavior when earlier reasoning is no longer relevant. Do not treat persisted reasoning as an always-on optimization: stale reasoning can add tokens, increase latency, and anchor the model to an outdated approach. + +Prompt caching also affects prompt construction. Keep reusable prefixes stable and avoid unnecessary churn in large system prompts. Use explicit cache breakpoints only when they improve measured cache behavior and cost for the workload. + +## Reasoning effort + +Treat reasoning effort as a last-mile tuning knob, not the first response to a weak result. + +- Preserve the current GPT-5.5 or GPT-5.4 reasoning effort as the baseline. +- Test the same setting and one level lower on representative tasks. +- Use low for latency-sensitive work when it preserves quality. +- Use medium as a balanced starting point. +- Use high or xhigh only when evals show a meaningful gain. +- Reserve max for the hardest quality-first workloads; do not recommend it globally. + +Before increasing reasoning effort, check whether the prompt is missing a success criterion, dependency rule, tool-routing rule, or verification loop. + +## Frontend and visual tasks + +GPT-5.6 has stronger layout, visual hierarchy, and design judgment. Still provide product context, preserve the existing design system, and name the states and constraints that matter. + +For incremental frontend changes: + +- inspect and preserve existing design tokens, components, and patterns; +- do not add extra features or decorative UI unless requested; +- preserve responsive behavior and expected states; +- render and inspect the result before finalizing. + +For vision, computer use, localization, or OCR tasks where spatial precision matters, choose image detail intentionally. Use original detail for large, dense, or coordinate-sensitive images when the extra input cost and latency are justified. + +## Check work before finishing + +Give GPT-5.6 access to tools that can validate the output, and state what validation matters. + +For coding: + + After making changes, run the most relevant validation available: + - targeted tests for changed behavior + - type checks or lint checks when applicable + - build checks for affected packages + - a minimal smoke test when full validation is too expensive + + If validation cannot be run, explain why and describe the next best check. + +For visual artifacts: + + Render the artifact before finalizing. Inspect layout, clipping, spacing, + missing content, and visual consistency. Revise until the rendered output + matches the requirements. + +For implementation plans, include requirements, named resources or files, state transitions or data flow, validation checks, failure behavior, privacy or security considerations, and open questions that materially affect implementation. + +## Suggested prompt structure + +Use this structure as a starting point for complex prompts. Keep each section short. Add detail only where it changes behavior. + + Role: [the model's function and context] + + Personality: [tone and collaboration style] + + Goal: [user-visible outcome] + + Success criteria: [what must be true before the final answer] + + Constraints: [policy, safety, business, evidence, and side-effect limits] + + Tools: [which tools to use, when, and what not to use] + + Output: [sections, length, format, and tone] + + Stop rules: [when to retry, fallback, abstain, ask, or stop] + +## Prompt migration workflow + +When moving an existing application to GPT-5.6: + +1. Switch the model and preserve the current reasoning effort. +2. Run representative evals before changing the prompt. +3. Remove obsolete scaffolding, repeated instructions, and irrelevant tools. +4. Add only the smallest targeted instruction that fixes a measured regression. +5. Re-run evals after each prompt or reasoning change. + +Do not rewrite a working prompt stack all at once. Otherwise you cannot tell whether a behavior change came from the model, reasoning setting, prompt, tool set, or runtime. + +When a prompt regresses, debug it with a small set of real traces. Identify the failure mode, find the instruction or contradiction that likely caused it, make a surgical edit, and rerun the same cases. diff --git a/plugins/openai-developers/skills/openai-docs/references/upgrade-guide.md b/plugins/openai-developers/skills/openai-docs/references/upgrade-guide.md new file mode 100644 index 000000000..8134bc6d5 --- /dev/null +++ b/plugins/openai-developers/skills/openai-docs/references/upgrade-guide.md @@ -0,0 +1,22 @@ +# Model upgrade guidance + +Use this file only as a bundled routing fallback when the live migration guide cannot be fetched. + +For latest, current, default, or unspecified-model upgrades: + +1. Run `scripts/resolve-latest-model-info`. +2. Fetch the returned `migrationGuideUrl` and `promptingGuideUrl` exactly. +3. Treat the live guides as canonical. +4. If remote retrieval fails, disclose that bundled fallback guidance is being used. + +For an explicit GPT-5.6 Sol or GPT-5.6-family migration: + +1. Preserve the user's explicit target; do not run the latest-model resolver. +2. Fetch the live GPT-5.6 model guidance: + + https://developers.openai.com/api/docs/guides/model-guidance?model=gpt-5.6 + +3. Read `references/upgrading-to-gpt-5p6-sol.md` for skill-specific migration judgment. +4. Read `references/prompting-guide.md` only when prompt changes are needed. + +For another explicit model target, preserve that target and fetch its current official guidance. Do not reuse GPT-5.6-specific defaults, API shapes, or compatibility rules for a different model. diff --git a/plugins/openai-developers/skills/openai-docs/references/upgrading-to-gpt-5p6-sol.md b/plugins/openai-developers/skills/openai-docs/references/upgrading-to-gpt-5p6-sol.md new file mode 100644 index 000000000..4cff5124d --- /dev/null +++ b/plugins/openai-developers/skills/openai-docs/references/upgrading-to-gpt-5p6-sol.md @@ -0,0 +1,448 @@ +# Upgrading to GPT-5.6 Sol + +Use this guide when the user asks to migrate an existing OpenAI API integration, repository, prompt stack, agent, model router, or model picker to GPT-5.6 Sol or the GPT-5.6 family. + +The default explicit target is `gpt-5.6-sol`. The alias `gpt-5.6` routes to Sol; use it only when the repository intentionally prefers family aliases. Do not treat every old model usage as a Sol candidate: GPT-5.6 is a family with different cost, latency, context, and quality roles. + +Before changing code, use the OpenAI Docs MCP to fetch the current live GPT-5.6 model guidance: + +https://developers.openai.com/api/docs/guides/model-guidance?model=gpt-5.6 + +For prompt changes, also read only the `## Prompting Best Practices` section from: + +https://developers.openai.com/api/docs/guides/model-guidance?model=gpt-5.6#prompting-best-practices + +Treat live docs as canonical for current model IDs, parameters, limits, pricing, and feature availability. This file supplies migration judgment: where to look, what can break, what to preserve, what not to adopt automatically, and how to validate the result. + +## Core principle + +Do not perform a blind model-string replacement. + +First preserve the behavior, latency class, cost class, reasoning level, endpoint contract, tool semantics, cache behavior, and output contract of each usage site. Then make the smallest safe migration. Adopt new GPT-5.6 capabilities only when they solve a measured problem or the user explicitly asks for them. + +A model upgrade alone does not authorize adding reasoning fields, changing request schemas, or rewriting tests. Only add explicit reasoning when the old effective behavior is established and omission would change behavior on GPT-5.6. + +The main 5.6 migration hazards are: + +- choosing Sol for workloads that were intentionally mini, nano, low-cost, or latency-sensitive; +- inheriting 5.6's default `medium` reasoning where the old effective effort was `none`; +- using Chat Completions with function tools without explicitly setting effective reasoning to `none`; +- losing prompt-cache hits when a stable prefix is followed by a changing suffix; +- increasing image or PDF input tokens because omitted or `auto` detail behaves differently; +- applying new cache, persisted-reasoning, Pro, Programmatic Tool Calling, or multi-agent fields to routes that do not support them; +- updating model strings but forgetting registries, allowlists, pricing metadata, capability flags, tests, and UI model pickers. + +## Migration posture + +Classify every usage site before editing: + +1. `simple Sol migration` + - One flagship model usage. + - Same endpoint and request shape can remain. + - Reasoning effort is explicit or its old effective value is known. + - No cache, vision, file, tool, or parser behavior needs implementation changes. +2. `tier-aware family migration` + - The repository exposes multiple model roles, model choices, fallbacks, routers, pricing data, or capability metadata. + - Map each role to Sol, Terra, or Luna instead of replacing everything with Sol. +3. `compatibility migration` + - The safe move requires parameter, endpoint, cache, state, tool-loop, or multimodal-detail changes. + - Make these changes only when implementation work is inside the user's requested scope. Otherwise report the exact blocker and smallest follow-up. +4. `prompt migration` + - The API shape can remain, but representative traces show a prompt-specific regression. + - Make a surgical prompt edit tied to that failure; do not rewrite a working prompt stack wholesale. + - When the task is to update prompting guidance, edit the directly tied prompt surface only. Do not modify runtime request code, model schemas, or tests unless the prompt change requires it. +5. `optional feature adoption` + - Pro mode, persisted reasoning, explicit caching, Programmatic Tool Calling, or multi-agent behavior is being added deliberately. + - Keep this separate from the baseline migration so its effect can be measured. +6. `leave unchanged` + - Historical examples, documentation about old models, snapshots, fixtures, eval baselines, comparison code, intentionally pinned fallbacks, unsupported providers, or ambiguous usages. + +When intent is unclear, prefer leaving a usage unchanged and list it for confirmation over silently changing its role. + +## Inventory before editing + +Search for more than literal model IDs. Inventory: + +- model strings, aliases, environment variables, CLI flags, config defaults, and deployment settings; +- SDK calls to Responses, Chat Completions, Batch, or provider adapters; +- reasoning settings, token budgets, sampling settings, and latency timeouts; +- function tools, hosted tools, structured outputs, response parsers, and replay logic; +- system, developer, user, and tool-description prompts tied to each usage; +- routers, fallbacks, model allowlists, enums, regexes, validation schemas, and capability maps; +- model picker UI, display labels, descriptions, context limits, pricing metadata, and provider catalogs; +- prompt-cache keys, retention options, stable-prefix construction, and cache metrics; +- image, PDF, file, OCR, and computer-use inputs; +- tests, fixtures, snapshots, evals, analytics labels, billing tables, and docs. + +When changing a default model, search every active default surface: runtime config, environment/config files, setup docs, tests, CLI defaults, and deployment examples. Update them together. + +For each usage site, record: + +- source model and why it appears to be used; +- endpoint and SDK/client surface; +- prompt surface; +- effective reasoning effort, including defaults; +- latency, cost, context, and quality role; +- tools, structured outputs, caching, state replay, and multimodal inputs; +- downstream parsers or user-visible contracts; +- migration class and validation plan. + +## Choose the target model by role + +Use this as a starting map, then validate against the repository's workload: + +| Existing role | Starting GPT-5.6 target | Reason | +| --- | --- | --- | +| Unsuffixed GPT-5 flagship, GPT-5.5, or GPT-5.4 flagship | `gpt-5.6-sol` | Sol is the flagship-equivalent tier. | +| Mini model, balanced lower-cost route, or medium-throughput worker | `gpt-5.6-terra` | Terra is the mini-like tier. | +| Nano model, classification, extraction, routing, high-volume, or strict-latency route | `gpt-5.6-luna` | Luna is the nano-like tier. | +| GPT-4.1 or GPT-4o latency-sensitive flow | Evaluate Luna and Terra first; use Sol only if quality requires it | A flagship replacement can change latency and cost materially. | +| Reasoning-heavy or hardest quality-first flow | Start with Sol at the old effective effort | Preserve the reasoning contract before tuning. | +| Old Pro usage | Sol plus `reasoning.mode: "pro"`, only if the user wants Pro behavior | GPT-5.6 Pro is a mode, not a separate model slug. | +| Router, fallback, or model picker | Add the family by role | Do not collapse a multi-model design into Sol. | +| Third-party or provider-specific model | Leave unchanged unless the user explicitly requests provider migration | Model-name similarity is not a safe mapping. | + +Important limits to check in live docs: + +- Sol and Terra have roughly 1.05M context and 128K maximum output. +- Luna has a smaller 400K context and 128K maximum output. +- Sol and Terra long-context requests above 272K input tokens can change pricing for the full request. + +Do not invent prices, limits, or capability flags. Fetch them from current docs before updating a registry or UI. + +For model pickers and registries, preserve existing model entries by default. Add GPT-5.6 Sol, Terra, and Luna as new options unless the user explicitly asks to replace or remove older models. Do not invent pricing, context limits, capabilities, or metadata unless confirmed from canonical docs. + +If using the `gpt-5.6` alias, record the returned `response.model` during validation. Do not assume an alias and an explicit Sol slug appear identically in dashboards, rate-limit configuration, analytics, or billing metadata. + +## Preserve effective reasoning before tuning + +GPT-5.6 supports `none`, `low`, `medium`, `high`, `xhigh`, and `max`. If omitted, GPT-5.6 defaults to `medium`. + +This is a behavioral migration hazard: + +- GPT-5.5 commonly defaulted to `medium`. +- GPT-5.4, mini, and nano usages commonly defaulted to `none`. +- A previously omitted setting can therefore become slower, more expensive, and incompatible with Chat Completions function tools after the model swap. + +For each usage: + +1. If effort is explicit, preserve it for the first 5.6 run when supported. +2. If effort is omitted and the old effective default is known, add it explicitly only when GPT-5.6's omitted default would change behavior. If both old and new omitted defaults are the same, keep it omitted. +3. If the old effective value is unknown, do not guess. Flag it and compare the old behavior with 5.6 at the likely baseline. +4. After the baseline passes, test the same setting and one lower on representative tasks. +5. Use `xhigh` or `max` only for hard quality-first workloads where evals show a meaningful gain. + +Do not globally recommend `max`. Before increasing effort, check whether the actual failure is a missing success criterion, dependency rule, tool-routing rule, state-replay bug, or validation loop. + +Use the field shape that belongs to the endpoint. + +Responses: + +```json +{ + "model": "gpt-5.6-sol", + "reasoning": { "effort": "none" } +} +``` + +Chat Completions: + +```json +{ + "model": "gpt-5.6-sol", + "reasoning_effort": "none" +} +``` + +## Chat Completions and function tools + +This is the most important endpoint-specific check. + +For GPT-5.6, function tools in Chat Completions are compatible only with effective reasoning `none`. Reasoning with tools should use the Responses API. + +Because GPT-5.6 defaults to `medium`, this combination is unsafe: + +```json +{ + "model": "gpt-5.6-luna", + "tools": [{ "type": "function", "function": { "...": "..." } }] +} +``` + +For a latency-sensitive Chat Completions flow that must keep function tools, explicitly preserve `none`: + +```json +{ + "model": "gpt-5.6-luna", + "reasoning_effort": "none", + "tools": [{ "type": "function", "function": { "...": "..." } }] +} +``` + +If the application needs both reasoning and tools: + +- migrate that flow to Responses when implementation changes are in scope; +- otherwise report it as a compatibility blocker; +- do not hide the incompatibility by removing tools, dropping required reasoning, or changing the workload's behavior without approval. + +If the live API rejects the intended `none` path, treat it as a current API compatibility issue and report the exact request and error rather than inventing a workaround. + +## Responses API and conversation state + +Prefer Responses for reasoning, tools, multi-turn agents, and new 5.6 capabilities. + +For ordinary multi-turn Responses calls, preserve the repository's existing state strategy. Do not add persisted reasoning merely because it exists. + +If deliberately enabling persisted reasoning: + +- use `reasoning.context: "all_turns"` only when the objective and assumptions remain stable; +- prefer `previous_response_id` when the server can carry state; +- when replaying manually, preserve every prior user input and every relevant output item, not only assistant text; +- with `store: false` or ZDR, request and replay `reasoning.encrypted_content`; +- use current-turn behavior when old reasoning may be stale or misleading. + +For manual replay, preserve item types, IDs, call IDs, caller metadata, and assistant phase values exactly. Incomplete replay can silently reduce quality or break tool continuation. + +## Prompt caching + +Do not assume old cache-hit behavior survives the model swap. + +GPT-5.6 implicit caching places a managed breakpoint near the latest user or tool message and no longer relies on 128-token rounding. A prompt with a large stable prefix followed by a changing suffix can therefore lose cache hits even when the stable prefix itself has not changed. + +Audit: + +- large reusable system/developer prompts; +- dynamic suffixes appended to otherwise stable prompts; +- changing timestamps, request IDs, user-specific values, or tool lists in the prefix; +- cache keys, retention settings, and cache dashboards; +- token accounting that assumes reads only and ignores writes. + +Migration rules: + +- keep reusable prefixes stable; +- do not churn large system prompts unnecessarily; +- compare old and new `cached_tokens`, `cache_write_tokens`, latency, and cost; +- use explicit cache breakpoints only when a measured workload has a stable boundary that implicit caching misses; +- do not globally convert every prompt to explicit caching; +- do not send 5.6-only cache fields to older routes in a mixed-model system. + +When old and GPT-5.6 routes share a request builder, isolate GPT-5.6-only fields instead of applying them globally. + +The new top-level request shape uses `prompt_cache_options`, for example: + +```json +{ + "prompt_cache_options": { + "mode": "explicit", + "ttl": "30m" + } +} +``` + +Place explicit breakpoints at the actual stable rendered boundary using `prompt_cache_breakpoint`. Preserve `prompt_cache_key` when the application already uses it. Treat the older `prompt_cache_retention` shape as deprecated and verify the live docs before rewriting it. + +Cache writes cost more than ordinary uncached input, so a lower hit rate can be both slower and more expensive. + +## Images, PDFs, files, and long context + +GPT-5.6 can change token and latency behavior without any prompt change: + +- for image inputs, omitted or `auto` image detail can preserve original dimensions; +- for PDF/file inputs in Responses, omitted or `input_file.detail: "auto"` can use high page-image detail; +- Chat Completions file inputs do not expose the same detail control; +- long-context Sol and Terra requests can cross pricing thresholds; +- Luna's smaller context can break workloads that fit in Sol or Terra. + +For multimodal or long-context usages: + +1. Measure input tokens and latency before and after. +2. Make detail explicit when cost or latency matters. +3. Resize images or use lower detail when the task does not need original spatial precision. +4. Keep original/high detail for dense, coordinate-sensitive, OCR, localization, or visual-inspection tasks where it materially improves quality. +5. Test worst-case context lengths, not only typical requests. + +Do not claim a capability was removed based only on a missing metadata flag. Verify against current docs and a representative request. + +## Structured outputs, parsers, and tool contracts + +Keep output contracts explicit: + +- preserve JSON schemas, required fields, enums, refusal handling, and parser expectations; +- preserve tool names, parameter schemas, call IDs, and retry behavior; +- keep citations, evidence fields, or native artifacts when downstream consumers require them; +- validate that the final answer still satisfies the contract, not merely that a tool call succeeded. + +Do not fix a failing migration by weakening a schema, deleting required behavior, removing routes, dropping tools, or changing business logic unless the user explicitly asked for that product change. + +## Optional: Pro mode + +Do not enable Pro mode during a baseline migration unless the old usage was Pro-like or the user explicitly asks for it. + +GPT-5.6 Pro uses the base model with a reasoning mode: + +```json +{ + "model": "gpt-5.6-sol", + "reasoning": { + "mode": "pro", + "effort": "medium" + } +} +``` + +Rules: + +- use Responses, not Chat Completions; +- do not search for or invent a separate `gpt-5.6-pro` slug; +- supported Pro efforts begin at `medium`; +- mode and effort are separate decisions; +- compare task quality, total latency, and actual billed token usage against standard mode. + +If migrating a legacy Pro slug, make the mode change explicit and evaluate it separately from ordinary Sol migration. + +## Optional: Programmatic Tool Calling + +Programmatic Tool Calling is not a required part of moving to GPT-5.6. Add it only when code can reduce large structured intermediate results before they return to model context. + +Good candidates: + +- bounded read-only filtering, joining, sorting, ranking, deduplication, and aggregation; +- batching many similar records; +- repeated deterministic validation; +- map-reduce style retrieval with a compact result schema. + +Poor candidates: + +- one direct tool call; +- adaptive workflows where each result changes the next decision; +- write, approval, or side-effecting flows; +- citation-heavy or native-artifact flows; +- semantic judgment that should remain visible to the model. + +Request-shape requirements: + +```json +{ + "tools": [ + { "type": "programmatic_tool_calling" }, + { + "type": "function", + "name": "lookup_records", + "allowed_callers": ["programmatic"] + } + ] +} +``` + +Do not nest `programmatic_tool_calling` under another `tools` property. When enabled, the host must handle `program`, program-issued `function_call`, `function_call_output`, and `program_output` items. Preserve the original `call_id` and `caller` when returning function results. + +Constrain the stage, eligible read-only tools, output schema, retry limit, and handoff back to direct judgment. Validate the final user-visible answer; a correct program result can still become an incorrect final answer. + +## Optional: multi-agent beta + +Do not enable multi-agent behavior during a baseline migration unless the application already has a clear parallelizable workflow and the user asks for it. + +Enabling it requires: + +- the `OpenAI-Beta: responses_multi_agent=v1` header; +- `multi_agent: { "enabled": true, "max_concurrent_subagents": 3 }`; +- handling `multi_agent_call`, `multi_agent_call_output`, and `agent_message` items; +- executing ordinary developer-defined function calls from any agent and returning all required outputs; +- preserving new items for replay and tracing; +- checking incompatibilities with compaction, reasoning summaries, and tool-call limits in current docs. + +Cap concurrency. Do not let a migration task create unbounded subagents, duplicate work, or finish without a final synthesis. + +## Prompt migration judgment + +After the model and API baseline is working, run representative traces before editing prompts. Change prompts only for measured failures. + +For GPT-5.6, prefer: + +- shorter, outcome-oriented prompts; +- explicit success criteria, dependencies, stopping conditions, and completion boundaries; +- preserved user-provided values; +- decision criteria for implicit choices instead of universal defaults or keyword maps; +- explicit autonomy and permission boundaries; +- explicit tool routing, resource links, breadcrumbs, and expected tool choice; +- staged plans, current-layer awareness, and concise handoffs for long work; +- real validation before declaring completion. + +Avoid: + +- generic `be brief`, `be thorough`, or `think step by step` instructions; +- blanket language instructions that can cause unwanted language switching; +- repeating `ask first` until safe local work becomes blocked; +- giant prompt rewrites that make the source of a regression impossible to identify; +- telling the model to minimize tool loops when correctness, evidence, or required validation needs more work. + +For coding or agentic migrations, add concrete preservation and verification rules: + +``` +Preserve existing functionality, routes, outputs, and user-visible behavior. +Do not delete or disable required behavior merely to make the build pass. +Before finishing, run the relevant build, tests, type checks, render or smoke +checks, and report the evidence. +``` + +For long-running work, define the current layer: research, design, implementation, review, or external coordination. Do not let the model silently move to another layer. + +## Upgrade workflow + +1. Fetch current live 5.6 docs and the Prompting Best Practices section. +2. Inventory every usage site and its adjacent prompt, config, registry, parser, and test surfaces. +3. Classify each usage by role and migration class. +4. Choose Sol, Terra, or Luna by the existing workload's role. +5. Preserve the old effective reasoning effort explicitly. +6. Run the compatibility gates: + - endpoint and SDK support; + - Chat Completions plus function tools; + - cache topology and cache fields; + - context length and long-context cost; + - image, PDF, and file detail; + - structured outputs and parsers; + - Responses state replay and tool continuation; + - mixed-model routing and unsupported new fields. +7. Apply the smallest safe model, config, registry, and prompt changes. +8. Do not add optional Pro, persisted reasoning, PTC, explicit caching, or multi-agent behavior unless needed and measurable. +9. Run existing tests and representative evals. +10. Report changed, unchanged, blocked, and confirmation-needed sites separately. + +## Validation matrix + +Prefer a controlled comparison: + +1. old model + old prompt + old settings; +2. GPT-5.6 target + same prompt + preserved effective reasoning; +3. GPT-5.6 target + same prompt + one lower effort; +4. GPT-5.6 target + the smallest prompt or API fix required by a measured failure; +5. optional feature treatment, isolated from the baseline. + +Measure what matters for the workflow: + +- task success and user-visible quality; +- structured-output validity and parser success; +- tool choice, tool arguments, retries, loop count, and completion rate; +- TTFT, end-to-end latency, timeout rate, and concurrency behavior; +- input, output, reasoning, cached, and cache-write tokens; +- cost per successful task; +- long-context, compaction, and replay behavior; +- image/PDF token use and visual/OCR accuracy; +- completeness, preserved behavior, citations, and validation evidence. + +For model routers and pickers, test at least one representative workload for each role. Verify that the cheapest or fastest tier is not accidentally used for quality-critical work and that Sol is not accidentally used for every workload. + +## Required final report + +Return: + +- `Current usage inventory`: each model site, endpoint, role, prompt surface, and old effective reasoning. +- `Target mapping`: Sol, Terra, Luna, unchanged, or confirmation-needed, with the reason. +- `Changes made`: model strings, reasoning settings, prompts, registries, metadata, tests, and API-shape changes. +- `Compatibility checks`: Chat Completions/tools, caching, state replay, multimodal detail, context/cost, schemas, and mixed-model routing. +- `Prompt changes`: each surgical edit and the failure mode it addresses. +- `Validation`: commands, evals, traces, before/after measurements, and remaining gaps. +- `Unchanged sites`: historical, pinned, ambiguous, or intentionally role-specific usages. +- `Blockers and open questions`: exact issue, why it is unsafe to guess, and the smallest next step. + +Never say the migration is complete merely because model strings changed. It is complete only when the affected behavior and contracts have been validated or the remaining gaps are stated explicitly. diff --git a/plugins/openai-developers/skills/openai-docs/scripts/fetch-codex-manual.mjs b/plugins/openai-developers/skills/openai-docs/scripts/fetch-codex-manual.mjs new file mode 100644 index 000000000..b2605520d --- /dev/null +++ b/plugins/openai-developers/skills/openai-docs/scripts/fetch-codex-manual.mjs @@ -0,0 +1,598 @@ +#!/usr/bin/env node +import { + access, + mkdir, + readFile, + rename, + rm, + stat, + writeFile, +} from "node:fs/promises"; +import { constants as fsConstants } from "node:fs"; +import { execFile } from "node:child_process"; +import { createHash } from "node:crypto"; +import path from "node:path"; +import process from "node:process"; +import { pathToFileURL } from "node:url"; +import { inspect, promisify } from "node:util"; + +const DEFAULT_MANUAL_URL = "https://developers.openai.com/codex/codex-manual.md"; +const DEFAULT_CACHE_DIR_NAME = "openai-docs-cache"; +const CACHE_FILE_NAME = "codex-manual.md"; +const OUTLINE_FILE_NAME = "codex-manual.outline.md"; +const HASH_HEADER = "x-content-sha256"; +const USER_AGENT = "codex-openai-docs"; +const execFileAsync = promisify(execFile); + +class ManualFetchError extends Error { + constructor(message, options) { + super(message, options); + this.name = "ManualFetchError"; + } +} + +const sha256 = (value) => createHash("sha256").update(value).digest("hex"); + +const withTimeout = async (promiseFactory, timeoutMs) => { + const controller = new AbortController(); + const timeout = setTimeout(() => controller.abort(), timeoutMs); + try { + return await promiseFactory(controller.signal); + } finally { + clearTimeout(timeout); + } +}; + +const proxyConfigured = () => + process.env.HTTP_PROXY || + process.env.HTTPS_PROXY || + process.env.http_proxy || + process.env.https_proxy; + +const responseHeaders = (headers) => ({ + get(name) { + return headers.get(name.toLowerCase()) ?? null; + }, +}); + +const makeResponse = ({ body, headers, status }) => ({ + headers: responseHeaders(headers), + ok: status >= 200 && status < 300, + status, + async text() { + return body; + }, +}); + +const parseCurlHeaders = (rawHeaders) => { + const normalized = rawHeaders.replace(/\r\n/g, "\n").trim(); + const blocks = normalized.split(/\n\n+/).filter(Boolean); + const headerBlock = [...blocks] + .reverse() + .find((block) => block.startsWith("HTTP/")); + + if (!headerBlock) { + throw new ManualFetchError("curl did not return HTTP response headers."); + } + + const [statusLine, ...lines] = headerBlock.split("\n"); + const statusMatch = /^HTTP\/\S+\s+(\d{3})/.exec(statusLine); + if (!statusMatch) { + throw new ManualFetchError( + `Could not parse HTTP status from curl response: ${statusLine}` + ); + } + + const headers = new Map(); + lines.forEach((line) => { + const separator = line.indexOf(":"); + if (separator === -1) return; + const name = line.slice(0, separator).trim().toLowerCase(); + const value = line.slice(separator + 1).trim(); + headers.set(name, value); + }); + + return { + headers, + status: Number(statusMatch[1]), + }; +}; + +const tempFilePath = (cacheDir, suffix) => + path.join( + cacheDir, + `.fetch-codex-manual-${process.pid}-${Date.now()}-${Math.random() + .toString(16) + .slice(2)}${suffix}` + ); + +const requestManualWithCurl = async (url, { cacheDir, method, timeoutMs }) => { + const headerPath = tempFilePath(cacheDir, ".headers"); + const bodyPath = tempFilePath(cacheDir, ".body"); + const curlNames = + process.platform === "win32" ? ["curl.exe", "curl"] : ["curl"]; + const args = [ + "--silent", + "--show-error", + "--location", + "--dump-header", + headerPath, + "--output", + bodyPath, + "--user-agent", + USER_AGENT, + "--max-time", + String(Math.max(1, Math.ceil(timeoutMs / 1000))), + ]; + + if (method === "HEAD") { + args.push("--head"); + } else { + args.push("--request", method); + } + args.push(url); + + let lastError; + for (const curlName of curlNames) { + try { + await execFileAsync(curlName, args, { windowsHide: true }); + const [rawHeaders, body] = await Promise.all([ + readFile(headerPath, "utf8"), + readFile(bodyPath, "utf8"), + ]); + const { headers, status } = parseCurlHeaders(rawHeaders); + return makeResponse({ body, headers, status }); + } catch (error) { + lastError = error; + if (error?.code !== "ENOENT") break; + } finally { + await Promise.all([ + rm(headerPath, { force: true }), + rm(bodyPath, { force: true }), + ]); + } + } + + if (lastError?.code === "ENOENT") { + throw new ManualFetchError("curl is unavailable in this environment.", { + cause: lastError, + }); + } + throw new ManualFetchError(`${method} ${url} could not be fetched.`, { + cause: lastError, + }); +}; + +const requestManualWithFetch = async (url, { method, timeoutMs }) => { + if (typeof fetch !== "function") { + throw new ManualFetchError( + "Native fetch is unavailable in this Node runtime." + ); + } + + return withTimeout( + (signal) => + fetch(url, { + method, + headers: { "User-Agent": USER_AGENT }, + signal, + }), + timeoutMs + ); +}; + +const requestManual = async (url, { cacheDir, method, timeoutMs }) => { + const preferCurl = Boolean(proxyConfigured()) || typeof fetch !== "function"; + const transports = preferCurl + ? [ + () => requestManualWithCurl(url, { cacheDir, method, timeoutMs }), + () => requestManualWithFetch(url, { method, timeoutMs }), + ] + : [ + () => requestManualWithFetch(url, { method, timeoutMs }), + () => requestManualWithCurl(url, { cacheDir, method, timeoutMs }), + ]; + + let lastError; + for (const transport of transports) { + try { + const response = await transport(); + if (!response.ok) { + throw new ManualFetchError( + `${method} ${url} failed with HTTP ${response.status}.` + ); + } + return response; + } catch (error) { + lastError = error; + } + } + + throw new ManualFetchError(`${method} ${url} could not be fetched.`, { + cause: lastError, + }); +}; + +const readHeaderSha = (response) => { + const value = response.headers.get(HASH_HEADER); + if (!value || !/^[a-f0-9]{64}$/i.test(value)) { + throw new ManualFetchError(`Manual response is missing ${HASH_HEADER}.`); + } + return value.toLowerCase(); +}; + +const nearestExistingParent = async (target) => { + let current = target; + while (true) { + try { + const info = await stat(current); + return info.isDirectory() ? current : null; + } catch (error) { + if (error?.code !== "ENOENT") return null; + } + + const parent = path.dirname(current); + if (parent === current) return null; + current = parent; + } +}; + +const usableCacheDir = async (cacheDir) => { + if (!cacheDir) return null; + const resolved = path.resolve(cacheDir); + + try { + const info = await stat(resolved); + if (!info.isDirectory()) return null; + } catch (error) { + if (error?.code !== "ENOENT") return null; + } + + const parent = await nearestExistingParent(resolved); + if (!parent) return null; + + try { + await access(parent, fsConstants.W_OK | fsConstants.X_OK); + } catch { + return null; + } + + return resolved; +}; + +const defaultCacheDirCandidates = () => { + const candidates = []; + const seen = new Set(); + const pushCandidate = (candidate) => { + if (!candidate || seen.has(candidate)) return; + seen.add(candidate); + candidates.push(candidate); + }; + + [process.env.TMPDIR, process.env.TEMP, process.env.TMP].forEach((baseDir) => { + if (baseDir) { + pushCandidate(path.join(baseDir, DEFAULT_CACHE_DIR_NAME)); + } + }); + + if (process.platform !== "win32") { + pushCandidate(`/private/tmp/${DEFAULT_CACHE_DIR_NAME}`); + pushCandidate(`/tmp/${DEFAULT_CACHE_DIR_NAME}`); + } + + return candidates; +}; + +const resolveCacheDir = async (cacheDir) => { + if (cacheDir) { + return usableCacheDir(cacheDir); + } + + for (const candidate of defaultCacheDirCandidates()) { + const usable = await usableCacheDir(candidate); + if (usable) return usable; + } + + return null; +}; + +const cacheFilePath = (cacheDir) => path.join(cacheDir, CACHE_FILE_NAME); + +const outlineFilePath = (cacheDir) => path.join(cacheDir, OUTLINE_FILE_NAME); + +const manualLines = (manual) => { + const lines = manual.replace(/\r\n/g, "\n").split("\n"); + if (lines[lines.length - 1] === "") lines.pop(); + return lines; +}; + +const sectionTitle = (rawTitle) => + rawTitle.replace(/\s+#+\s*$/, "").replace(/\s+/g, " ").trim(); + +const buildOutline = (manual) => { + const lines = manualLines(manual); + const headings = []; + let inFence = false; + + lines.forEach((line, index) => { + if (/^\s*(```|~~~)/.test(line)) { + inFence = !inFence; + return; + } + if (inFence) return; + + const match = /^(#{1,6})\s+(.+?)\s*$/.exec(line); + if (!match) return; + + const level = match[1].length; + if (level < 2 || level > 3) return; + + headings.push({ + level, + title: sectionTitle(match[2]), + startLine: index + 1, + endLine: lines.length, + }); + }); + + for (let index = 0; index < headings.length; index += 1) { + const heading = headings[index]; + const nextPeer = headings + .slice(index + 1) + .find((candidate) => candidate.level <= heading.level); + if (nextPeer) { + heading.endLine = nextPeer.startLine - 1; + } + } + + if (headings.length === 0) { + return { + headingCount: 0, + lineCount: lines.length, + text: "No markdown headings found.", + }; + } + + const minLevel = Math.min(...headings.map((heading) => heading.level)); + return { + headingCount: headings.length, + lineCount: lines.length, + text: headings + .map((heading) => { + const indent = " ".repeat(heading.level - minLevel); + return `${indent}- ${heading.title} (lines ${heading.startLine}-${heading.endLine})`; + }) + .join("\n"), + }; +}; + +const outlineMarkdown = (outline) => `# Codex Manual Outline\n\n${outline.text}\n`; + +const manualStatusLine = (status) => + status.cacheStatus === "hit" + ? "Manual status: local manual was already current." + : "Manual status: local manual was updated."; + +const formatResult = ({ status, outlineText }) => + [ + `Manual path: ${status.manualPath}`, + `Outline path: ${status.outlinePath}`, + manualStatusLine(status), + "", + outlineText, + ].join("\n"); + +const readCachedManual = async (cacheDir, expectedSha256) => { + try { + const manual = await readFile(cacheFilePath(cacheDir), "utf8"); + return sha256(manual) === expectedSha256 ? manual : null; + } catch { + return null; + } +}; + +const writeCachedManual = async (cacheDir, manual) => { + await mkdir(cacheDir, { recursive: true }); + const tmpPath = tempFilePath(cacheDir, `.${CACHE_FILE_NAME}.tmp`); + await writeFile(tmpPath, manual, "utf8"); + await rename(tmpPath, cacheFilePath(cacheDir)); +}; + +const writeOutline = async (cacheDir, outlineText) => { + await mkdir(cacheDir, { recursive: true }); + const tmpPath = tempFilePath(cacheDir, `.${OUTLINE_FILE_NAME}.tmp`); + await writeFile(tmpPath, outlineText, "utf8"); + await rename(tmpPath, outlineFilePath(cacheDir)); +}; + +const fetchCodexManual = async ({ + manualUrl = DEFAULT_MANUAL_URL, + cacheDir, + timeoutMs = 30000, +} = {}) => { + const resolvedCacheDir = await resolveCacheDir(cacheDir); + if (!resolvedCacheDir) { + throw new ManualFetchError( + "Manual cache directory is unavailable; pass --cache-dir to override or use OpenAI Docs MCP fallback." + ); + } + await mkdir(resolvedCacheDir, { recursive: true }); + + const headResponse = await requestManual(manualUrl, { + cacheDir: resolvedCacheDir, + method: "HEAD", + timeoutMs, + }); + const expectedSha256 = readHeaderSha(headResponse); + const manualPath = cacheFilePath(resolvedCacheDir); + const outlinePath = outlineFilePath(resolvedCacheDir); + const checkedAt = new Date().toISOString(); + + const cachedManual = await readCachedManual(resolvedCacheDir, expectedSha256); + if (cachedManual !== null) { + const outline = buildOutline(cachedManual); + const outlineText = outlineMarkdown(outline); + await writeOutline(resolvedCacheDir, outlineText); + + return { + outlineText, + status: { + manualUrl, + headerSha256: expectedSha256, + fetchedManualSha256: expectedSha256, + manualHashMatches: true, + cacheStatus: "hit", + cacheDir: resolvedCacheDir, + manualPath, + outlinePath, + checkedAt, + lineCount: outline.lineCount, + headingCount: outline.headingCount, + }, + }; + } + + const getResponse = await requestManual(manualUrl, { + cacheDir: resolvedCacheDir, + method: "GET", + timeoutMs, + }); + const getHeaderSha256 = readHeaderSha(getResponse); + if (getHeaderSha256 !== expectedSha256) { + throw new ManualFetchError( + `${HASH_HEADER} changed between HEAD and GET for ${manualUrl}.` + ); + } + + const manualText = await getResponse.text(); + const actualSha256 = sha256(manualText); + const manualHashMatches = actualSha256 === expectedSha256; + if (!manualHashMatches) { + throw new ManualFetchError( + `${HASH_HEADER} did not match the fetched manual body for ${manualUrl}.` + ); + } + + await writeCachedManual(resolvedCacheDir, manualText); + const outline = buildOutline(manualText); + const outlineText = outlineMarkdown(outline); + await writeOutline(resolvedCacheDir, outlineText); + + return { + outlineText, + status: { + manualUrl, + headerSha256: expectedSha256, + fetchedManualSha256: actualSha256, + manualHashMatches, + cacheStatus: "updated", + cacheDir: resolvedCacheDir, + manualPath, + outlinePath, + checkedAt, + lineCount: outline.lineCount, + headingCount: outline.headingCount, + }, + }; +}; + +const parseArgs = (argv) => { + const args = { + manualUrl: DEFAULT_MANUAL_URL, + cacheDir: undefined, + timeoutMs: 30000, + statusJson: false, + }; + + for (let index = 0; index < argv.length; index += 1) { + const arg = argv[index]; + if (arg === "--manual-url") { + args.manualUrl = argv[++index]; + } else if (arg === "--cache-dir") { + args.cacheDir = argv[++index]; + } else if (arg === "--timeout-ms") { + args.timeoutMs = Number(argv[++index]); + } else if (arg === "--status-json") { + args.statusJson = true; + } else { + throw new ManualFetchError(`Unknown argument: ${arg}`); + } + } + + if (!args.manualUrl) { + throw new ManualFetchError("--manual-url cannot be empty."); + } + if (!Number.isFinite(args.timeoutMs) || args.timeoutMs <= 0) { + throw new ManualFetchError("--timeout-ms must be a positive number."); + } + + return args; +}; + +const main = async () => { + const args = parseArgs(process.argv.slice(2)); + const { outlineText, status } = await fetchCodexManual(args); + + process.stdout.write(formatResult({ status, outlineText })); + + if (args.statusJson) { + console.error(JSON.stringify(status)); + } +}; + +const envProxyHint = () => { + if (proxyConfigured()) { + return "Hint: proxy env vars are present. This helper prefers `curl` in proxied sessions; if requests still fail, verify `curl` is installed and the proxy configuration is valid."; + } + if (typeof fetch !== "function") { + return "Hint: native fetch is unavailable in this Node runtime. Install `curl` or use a newer Node version to fetch the manual."; + } + if (process.platform === "win32") { + return "Hint: on Windows, pass a cache dir under `%TEMP%` or `%TMP%`."; + } + return null; +}; + +const formatErrorDetails = (error) => { + const details = inspect(error, { + breakLength: 120, + colors: false, + compact: false, + depth: 8, + }); + if (!error?.cause) { + return details; + } + + return `${details}\n\nCause:\n${inspect(error.cause, { + breakLength: 120, + colors: false, + compact: false, + depth: 8, + })}`; +}; + +const isCliEntrypoint = () => { + const entrypoint = process.argv[1]; + if (!entrypoint) { + return false; + } + + return pathToFileURL(entrypoint).href === import.meta.url; +}; + +if (isCliEntrypoint()) { + main().catch((error) => { + console.error(`Error: ${error.message}`); + const hint = envProxyHint(); + if (hint) { + console.error(hint); + } + console.error(""); + console.error("Details:"); + console.error(formatErrorDetails(error)); + process.exitCode = 1; + }); +} + +export { DEFAULT_MANUAL_URL, fetchCodexManual }; diff --git a/plugins/openai-developers/skills/openai-docs/scripts/resolve-latest-model-info b/plugins/openai-developers/skills/openai-docs/scripts/resolve-latest-model-info new file mode 100755 index 000000000..1190cba98 --- /dev/null +++ b/plugins/openai-developers/skills/openai-docs/scripts/resolve-latest-model-info @@ -0,0 +1,31 @@ +#!/bin/sh +set -eu + +SCRIPT_DIR=$(CDPATH= cd -- "$(dirname -- "$0")" && pwd) +SCRIPT_PATH="$SCRIPT_DIR/resolve-latest-model-info.cjs" + +if [ -n "${NODE:-}" ] && [ -x "$NODE" ]; then + "$NODE" "$SCRIPT_PATH" "$@" + exit $? +fi + +if command -v node >/dev/null 2>&1; then + node "$SCRIPT_PATH" "$@" + exit $? +fi + +for CANDIDATE in \ + "$HOME/.cache/codex-runtimes/codex-primary-runtime/dependencies/node/bin/node" \ + "$HOME/.cache/codex-runtimes/codex-primary-runtime/dependencies/bin/node" \ + "/opt/homebrew/bin/node" \ + "/usr/local/bin/node" \ + "/usr/bin/node" +do + if [ -x "$CANDIDATE" ]; then + "$CANDIDATE" "$SCRIPT_PATH" "$@" + exit $? + fi +done + +echo "No usable Node runtime found for resolve-latest-model-info.cjs" >&2 +exit 127 diff --git a/plugins/openai-developers/skills/openai-docs/scripts/resolve-latest-model-info.cjs b/plugins/openai-developers/skills/openai-docs/scripts/resolve-latest-model-info.cjs new file mode 100644 index 000000000..498e19d25 --- /dev/null +++ b/plugins/openai-developers/skills/openai-docs/scripts/resolve-latest-model-info.cjs @@ -0,0 +1,165 @@ +#!/usr/bin/env node + +// Keep this entrypoint CommonJS-safe when the skill is copied into a type=module repo. + +const fs = require("node:fs/promises"); +const path = require("node:path"); + +const DEFAULT_URL = + "https://developers.openai.com/api/docs/guides/latest-model.md"; +const DEFAULT_BASE_URL = "https://developers.openai.com"; + +function parseArgs(argv) { + const args = { + source: process.env.LATEST_MODEL_URL || DEFAULT_URL, + baseUrl: process.env.LATEST_MODEL_BASE_URL || DEFAULT_BASE_URL, + }; + + for (let i = 2; i < argv.length; i += 1) { + const arg = argv[i]; + if (arg === "--source" || arg === "--url") { + args.source = argv[i + 1]; + i += 1; + } else if (arg === "--base-url") { + args.baseUrl = argv[i + 1]; + i += 1; + } + } + + return args; +} + +async function readSource(source) { + if (source.startsWith("file://")) { + return fs.readFile(new URL(source), "utf8"); + } + + if (!/^https?:\/\//.test(source)) { + return fs.readFile(path.resolve(source), "utf8"); + } + + let lastError; + for (let attempt = 1; attempt <= 3; attempt += 1) { + try { + const response = await fetch(source, { + headers: { accept: "text/markdown,text/plain,*/*" }, + }); + + if (response.ok) { + return response.text(); + } + + lastError = new Error("failed to fetch " + source + ": " + response.status); + if (response.status < 500 && response.status !== 429) { + break; + } + } catch (error) { + lastError = error; + } + + if (attempt < 3) { + await new Promise((resolve) => setTimeout(resolve, 250 * attempt)); + } + } + + throw lastError; +} + +function parseIndentedInfo(lines, startIndex) { + const info = {}; + + for (let i = startIndex + 1; i < lines.length; i += 1) { + const line = lines[i]; + if (!line.trim()) { + continue; + } + + const match = line.match(/^ {2}([A-Za-z][A-Za-z0-9_-]*):\s*(.+?)\s*$/); + if (!match) { + break; + } + + info[match[1]] = match[2].replace(/^["']|["']$/g, ""); + } + + return info; +} + +function parseFlatInfo(block) { + const info = {}; + + for (const line of block.split(/\r?\n/)) { + const match = line.match(/^\s*([A-Za-z][A-Za-z0-9_-]*):\s*(.+?)\s*$/); + if (match) { + info[match[1]] = match[2].replace(/^["']|["']$/g, ""); + } + } + + return info; +} + +function extractLatestModelInfo(markdown) { + const lines = markdown.split(/\r?\n/); + const latestModelInfoIndex = lines.findIndex((line) => + /^latestModelInfo:\s*$/.test(line) + ); + + if (latestModelInfoIndex >= 0) { + return parseIndentedInfo(lines, latestModelInfoIndex); + } + + const commentMatch = markdown.match( + //m + ); + if (commentMatch) { + return parseFlatInfo(commentMatch[1]); + } + + return undefined; +} + +function modelToSkillSlug(model) { + return model.trim().replace(/\./g, "p"); +} + +function absoluteUrl(baseUrl, value) { + return new URL(value, baseUrl).toString(); +} + +function normalizeInfo(info, baseUrl) { + const model = info?.model?.trim(); + const migrationGuide = info?.migrationGuide?.trim(); + const promptingGuide = info?.promptingGuide?.trim(); + + if (!model || !migrationGuide || !promptingGuide) { + throw new Error( + "latestModelInfo must include model, migrationGuide, and promptingGuide" + ); + } + + return { + model, + modelSlug: modelToSkillSlug(model), + migrationGuideUrl: absoluteUrl(baseUrl, migrationGuide), + promptingGuideUrl: absoluteUrl(baseUrl, promptingGuide), + }; +} + +async function main() { + const { source, baseUrl } = parseArgs(process.argv); + const markdown = await readSource(source); + const info = extractLatestModelInfo(markdown); + + if (!info) { + throw new Error(`latestModelInfo block not found in ${source}`); + } + + process.stdout.write( + `${JSON.stringify(normalizeInfo(info, baseUrl), null, 2)}\n` + ); +} + +main().catch((error) => { + console.error(error.message); + process.exit(1); +}); diff --git a/plugins/openai-developers/tests/openai-platform-api-key.test.mjs b/plugins/openai-developers/tests/openai-platform-api-key.test.mjs index dc393594f..b1fc8a9e7 100644 --- a/plugins/openai-developers/tests/openai-platform-api-key.test.mjs +++ b/plugins/openai-developers/tests/openai-platform-api-key.test.mjs @@ -28,6 +28,10 @@ const EVALS = path.resolve( const PLUGIN_MANIFEST = path.resolve(__dirname, "../.codex-plugin/plugin.json"); const MCP_MANIFEST = path.resolve(__dirname, "../.mcp.json"); const MCP_SERVER = path.resolve(__dirname, "../mcp/server.mjs"); +const BUNDLED_OPENAI_DOCS_SKILL = path.resolve( + __dirname, + "../skills/openai-docs/SKILL.md", +); const OPENAI_DOCS_SKILL = path.resolve( __dirname, "../../../skills/skills/openai-docs/SKILL.md", @@ -576,9 +580,11 @@ test("eval matrix includes local picker boundary and two-field joke app use case }); test("openai-docs defers to API key skill for implementation tasks", (t) => { - const docsSkillPaths = [OPENAI_DOCS_SKILL, APPLIED_OPENAI_DOCS_SKILL].filter( - fs.existsSync, - ); + const docsSkillPaths = [ + BUNDLED_OPENAI_DOCS_SKILL, + OPENAI_DOCS_SKILL, + APPLIED_OPENAI_DOCS_SKILL, + ].filter(fs.existsSync); if (docsSkillPaths.length === 0) { t.skip("monorepo OpenAI docs skill paths are not available in this repository"); return;