This commit is contained in:
commit
07eb6dc053
318 changed files with 339857 additions and 0 deletions
|
|
@ -0,0 +1,71 @@
|
|||
# Codex self-knowledge
|
||||
|
||||
Use this manual-first route only for genuinely broad Codex setup, orientation, customization, troubleshooting, local-state guidance, or system-map synthesis across skills, plugins, MCP, hooks, `AGENTS.md`, automations, and product surfaces. Mixed Chat/Work/Codex comparisons belong to `official-docs.md` instead.
|
||||
|
||||
Narrow Codex documentation questions require official documentation search first, then an actual page open or fetch using an available documentation or official-domain web capability. This includes a single feature such as Codex Goals, a specific setting, documented behavior, exact error, or requested page citation. Search and fetch the exact official topic before inspecting local files or bundled references. Do not fetch the manual, read bundled references, inspect local configuration or caches, or turn a targeted documentation lookup into broad product synthesis. Current or latest model questions follow the model-selection route.
|
||||
|
||||
## Start with the manual
|
||||
|
||||
Reuse a manual path and outline path already established in the same thread when both remain usable and current. Refresh before relying on a path fetched more than about a day ago, obtained from another thread or uncertain source, or missing likely-current information.
|
||||
|
||||
Otherwise, run the bundled manual helper first. Skip it without probing only when policy explicitly makes the session read-only, shell execution unavailable, or every allowed temporary cache location unavailable. Workspace-only write access is not enough: the helper needs an allowed writable temp cache. A guessed sandbox restriction is not evidence that the helper is unavailable.
|
||||
|
||||
Resolve `<skill-dir>` to the actual installed skill directory, then run:
|
||||
|
||||
```bash
|
||||
node <skill-dir>/scripts/fetch-codex-manual.mjs
|
||||
```
|
||||
|
||||
The helper automatically chooses the first usable cache location in this order:
|
||||
|
||||
1. `$TMPDIR/openai-docs-cache`
|
||||
2. `%TEMP%\openai-docs-cache`
|
||||
3. `%TMP%\openai-docs-cache`
|
||||
4. `/private/tmp/openai-docs-cache`
|
||||
5. `/tmp/openai-docs-cache`
|
||||
|
||||
Use an explicit override only when the allowed cache must be selected manually:
|
||||
|
||||
```bash
|
||||
node <skill-dir>/scripts/fetch-codex-manual.mjs --cache-dir <cache-dir>
|
||||
```
|
||||
|
||||
On Windows, `%TEMP%` and `%TMP%` are discovered automatically; `$env:TEMP\openai-docs-cache` is a typical PowerShell override. The helper handles configured HTTP(S) proxies and falls back to `curl` when needed. Do not require a POSIX-only environment prefix or an unnecessary cache override.
|
||||
|
||||
The helper verifies the current source and returns a manual path, outline path, freshness status, and heading outline. Use that outline to locate relevant headings and line ranges, then read or search only the returned manual and outline paths. Do not inspect unrelated repositories, caches, source trees, or local state to establish a public Codex product claim.
|
||||
|
||||
For follow-up questions in the same thread, reuse those fresh paths instead of fetching again. If asked whether the manual is current enough to rely on now, rerun the helper when an allowed temp cache is available and answer from its reported status and returned paths.
|
||||
|
||||
## Fill only genuine documentation gaps
|
||||
|
||||
If the manual answers a claim, stop retrieving sources for that claim. Its official source pages and known anchors are sufficient citation support. Continue the user's broader task when the documentation lookup was only one dependency.
|
||||
|
||||
If the helper was legitimately skipped, actually fails, or the fresh manual lacks a material or likely-current claim, use the narrowest official follow-up. Search the exact topic using an available documentation or approved-domain web capability, then actually open or fetch a clearly relevant official result. A page-specific citation can justify the same narrow follow-up.
|
||||
|
||||
For an undocumented Codex term, mode, acronym, or exact error, first check adjacent manual terminology. Map it to the closest documented concept when possible. If the exact term is material or likely current, perform one targeted official search-and-fetch; if it remains undocumented, say so. Do not expand into internal knowledge bases, private source trees, guessed roadmap details, or account-specific workarounds.
|
||||
|
||||
If official documentation conflicts with a callable capability verified in the current session, explicitly state the conflict and prefer that verified behavior for this environment. Otherwise, resolve unsupported claims with bounded uncertainty or route the user to support, an administrator, or product feedback.
|
||||
|
||||
## Choose the smallest matching Codex surface
|
||||
|
||||
- Prompt or thread context: one-off task constraints.
|
||||
- Repository `AGENTS.md`: durable team conventions, commands, and verification expectations; nested files apply more specifically within their subtree.
|
||||
- Project `.codex/config.toml`: settings for a trusted repository, including sandbox, MCP, hooks, model, and reasoning defaults.
|
||||
- Global config or global guidance: personal defaults across repositories.
|
||||
- Skill: a reusable workflow, optionally with focused references or scripts.
|
||||
- Plugin: an installable bundle of skills, tools, commands, MCP configuration, hooks, apps, assets, or related metadata.
|
||||
- MCP server or app connector: authorized live external data and actions. Use an authenticated connector, not web search or memory, for private Google Docs, Calendar, Slack, GitHub, Notion, or similar workspace data.
|
||||
- Automation: scheduled checks, reminders, monitors, or follow-ups; use an existing-thread heartbeat when continuity matters.
|
||||
- Hook: mechanical enforcement around lifecycle events, tool calls, commands, or edits.
|
||||
|
||||
Split requests that combine one-off, durable, repository-scoped, and recurring behavior instead of forcing them onto a single surface. For example, "always do this, but only for this PR" belongs in the current prompt or thread unless the user explicitly wants persistence or enforcement.
|
||||
|
||||
For a surface recommendation, state what to use, why it fits, what to avoid, and the manual or official documentation supporting the answer.
|
||||
|
||||
For product surfaces, distinguish terminal-first CLI work, editor-attached IDE work, desktop planning or review, hosted cloud execution, in-app browser testing, the user's existing Chrome session, and desktop Computer Use. Keep `config.toml` defaults, `requirements.toml` constraints, and managed or administrator policy separate. An API key does not establish ChatGPT, Codex cloud, connector, or account access.
|
||||
|
||||
For plugin or app failures, check the installed bundle, enabled state, connector authorization, MCP setup, restart or new-thread expectations, and workspace policy before inferring a cause. Route billing, entitlements, undocumented rollout labels, and unsupported access paths to the appropriate support or administrative owner.
|
||||
|
||||
Memory can provide user preferences or context, but explicit prompt instructions win and memory is not a source for current external facts. Sandbox or network denials require narrowly scoped escalation with a clear justification; destructive commands, writes outside the workspace, and broad access changes require explicit approval.
|
||||
|
||||
When a page-specific citation helps, useful official anchors include `concepts/customization#agents-guidance`, `concepts/customization#skills`, `plugins/build#plugin-structure`, `concepts/customization#mcp`, `config-advanced#hooks`, `app/automations#thread-automations`, and `config-reference#configtoml`.
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
# Latest model fallback
|
||||
|
||||
This is a compact, non-authoritative fallback, not a source for current availability, prices, aliases, or defaults. First search for and fetch current official model guidance at `https://developers.openai.com/api/docs/guides/latest-model` and the relevant official model page. The fetched official documentation wins if this snapshot has drifted. Disclose any use of this fallback.
|
||||
|
||||
## Model roles
|
||||
|
||||
| Model ID | Documented workload to verify against the current model page |
|
||||
| --- | --- |
|
||||
| `gpt-6` | GPT-6 family alias; verify its currently documented routing and availability. |
|
||||
| `gpt-6-astra` | Quality-first flagship, reasoning, and difficult coding work. |
|
||||
| `gpt-5.6-terra` | Balanced quality, latency, and cost. |
|
||||
| `gpt-5.6-luna` | Primary choice for faster or cheaper workloads. |
|
||||
|
||||
Use `https://developers.openai.com/api/docs/guides/latest-model/gpt-6-astra.md#migration-quickstart` for an actual GPT-6 migration and `https://developers.openai.com/api/docs/guides/latest-model/gpt-6-astra.md#prompting-best-practices` for requested GPT-6 prompting. Open and read the relevant page before recommending a request shape, reasoning setting, endpoint, tool behavior, or migration.
|
||||
|
||||
## Explicitly requested existing models
|
||||
|
||||
| Model ID | Boundary |
|
||||
| --- | --- |
|
||||
| `gpt-4.1` | Preserve only when the user explicitly requests this model or existing migration target; search and fetch its own current official guide. |
|
||||
| `gpt-5.4` | Preserve only when the user explicitly requests this model or existing migration target; search and fetch its own current official guide. |
|
||||
|
||||
Do not promote a legacy model as the current default, substitute it into an unrelated task, or replace an explicitly requested legacy target with GPT-6 Astra. Recommend a specialized image, audio, realtime, coding, moderation, or embedding model only after verifying the requested modality against current official documentation.
|
||||
|
||||
Verify GPT-6 Pro against current official Responses and model documentation before describing model IDs, reasoning modes, request parameters, or account availability; do not invent a separate `gpt-6-pro` model slug.
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# Local documentation MCP setup and diagnostics
|
||||
|
||||
Use this route only when the user explicitly asks to configure or troubleshoot the official OpenAI documentation MCP server in a supported **local Codex client**. A missing documentation tool during an ordinary documentation request is not a setup request: answer with the root skill's official-domain web fallback without installation, sandbox escalation, configuration changes, or restart.
|
||||
|
||||
## Verify the supported local setup
|
||||
|
||||
1. Search and fetch current official Codex MCP setup documentation when those tools are callable. Otherwise, search and fetch the relevant official OpenAI documentation directly.
|
||||
2. Confirm the documented endpoint is `https://developers.openai.com/mcp` and verify the supported command or configuration against that current documentation before recommending it.
|
||||
3. When the current documentation supports it, the local Codex CLI setup is:
|
||||
|
||||
```sh
|
||||
codex mcp add openaiDeveloperDocs --url https://developers.openai.com/mcp
|
||||
```
|
||||
|
||||
The equivalent documented configuration is:
|
||||
|
||||
```toml
|
||||
[mcp_servers.openaiDeveloperDocs]
|
||||
url = "https://developers.openai.com/mcp"
|
||||
```
|
||||
|
||||
4. Check the supported local client's MCP listing or configuration, its enabled state, relevant workspace/admin policy, and any documented authentication requirement. Verify success from the actual command result, configuration, or a callable documentation-tool search/fetch; never claim installation or access without evidence.
|
||||
5. Recommend a local-client restart or new local session only when current official documentation or observed client behavior requires it. Clearly identify which local client must refresh.
|
||||
|
||||
A skill dependency declaration, configured server, or local-client setup does not make a tool callable in an already running session. In particular, editing a hosted container's local configuration cannot install a tool into the host or model's current tool inventory. Never claim a local command installed the server into a current hosted session.
|
||||
|
||||
Only perform a local installation or configuration change when the user explicitly authorizes that change. Never request sandbox escalation, edit hosted configuration, install a dependency, or ask the user to restart a hosted session merely to answer an ordinary documentation question.
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
# Model migration and prompting
|
||||
|
||||
Use this route for model upgrades, migration planning, model-specific prompting, or latest/current/default prompting guidance. First search current official OpenAI documentation for the exact requested topic and model, then open or fetch the relevant official page using an available documentation or official-domain web capability. Do not run a resolver, open bundled references, or rely on a guide URL before completing that official search and actual page fetch.
|
||||
|
||||
## Choose the target before loading more context
|
||||
|
||||
- **Explicit model target:** Preserve the user's exact requested target, including an explicitly requested GPT-5.5 or GPT-5.6 migration. Do not run the latest-model resolver and do not substitute a newer model. Search for and fetch current guidance for that exact model. A GPT-5.6 migration must not load GPT-6 guidance or references.
|
||||
- **Unspecified, latest, current, or default target:** Search for and fetch `https://developers.openai.com/api/docs/guides/latest-model` first. Use the corresponding `latest-model.md` metadata only when dynamic migration resolution is needed, then run the platform-specific resolver below and preserve its returned model and exact guide URLs.
|
||||
- **Latest/current/default prompting:** Follow the dynamic-target route, then use the returned prompting guide. Do not run the resolver for explicitly named-model prompting.
|
||||
- **Pure model selection:** Use `references/model-selection.md` instead. Do not run the resolver.
|
||||
|
||||
For POSIX shells, invoke the resolver through `sh`, without assuming an executable bit:
|
||||
|
||||
```sh
|
||||
sh <skill-dir>/scripts/resolve-latest-model-info
|
||||
```
|
||||
|
||||
On Windows, use the CommonJS entry point with Node.js 18 or newer:
|
||||
|
||||
```text
|
||||
node <skill-dir>\scripts\resolve-latest-model-info.cjs
|
||||
```
|
||||
|
||||
If the Windows Node runtime is unavailable and `load_workspace_dependencies` is callable, use its returned runtime and retry once. Do not execute the extensionless POSIX wrapper directly on Windows.
|
||||
|
||||
Do not suppress or redirect resolver stdout. Success requires JSON with nonempty `model`, `migrationGuideUrl`, and `promptingGuideUrl` fields. If the command fails or any required field is missing, retry the platform-specific command once, then fall back to current official documentation and finally disclosed bundled references.
|
||||
|
||||
## Retrieve only the guidance this request needs
|
||||
|
||||
Treat returned guide URLs as opaque: fetch those exact URLs without deriving, substituting, or appending a model query. Use an available official documentation or first-party-domain capability to open and read the relevant official page. Retry the exact guide URL when its response contains only a title or no substantive body.
|
||||
|
||||
- Fetch `migrationGuideUrl` for a requested migration or upgrade plan.
|
||||
- Fetch `promptingGuideUrl` only when the user asks for prompting guidance or the migration requires a prompt change. Extract only `## Prompting best practices` through the next H2 heading.
|
||||
- For explicitly named-model prompting, fetch that model's official prompting guidance and extract only `## Prompting best practices` through the next H2 heading. Do not load a migration reference or run the resolver.
|
||||
- For an actual GPT-6 migration or implementation plan, fetch `https://developers.openai.com/api/docs/guides/latest-model/gpt-6-astra.md#migration-quickstart`. For specifically requested GPT-6 prompting, fetch `https://developers.openai.com/api/docs/guides/latest-model/gpt-6-astra.md#prompting-best-practices`. Read `references/upgrading-to-gpt-6-astra.md` only when fetched official guidance does not resolve needed compatibility gates, scoped code changes, tier-aware routing, validation, or other migration-specific judgment. Never load it for documentation-only questions about model tiers, the family alias, Pro mode, reasoning effort, or current guidance when the fetched official documentation already answers them.
|
||||
- Read `references/prompting-guide.md` only when prompting guidance or prompt changes are actually needed and current official guidance is unavailable.
|
||||
- Read `references/upgrade-guide.md` only when current official migration guidance is unavailable. Disclose when a bundled fallback was used.
|
||||
|
||||
## Keep implementation changes scoped
|
||||
|
||||
Change active model defaults and directly related prompt surfaces only when the user requested that work. Update registries, model pickers, capability metadata, routing, pricing, or tests only when they are in scope and current official documentation verifies the relevant values.
|
||||
|
||||
Preserve each workload's cost, latency, quality, reasoning, tool, endpoint, and output-contract role. Do not collapse a tiered router into one flagship model, replace intentionally pinned fallbacks, or rewrite historical examples, fixtures, eval baselines, provider comparisons, or unrelated SDK and authentication configuration.
|
||||
|
||||
If a safe migration requires an endpoint change, request-schema change, tool-handler change, or other implementation outside the requested scope, report the exact compatibility blocker and smallest follow-up instead of silently changing behavior.
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# Model selection
|
||||
|
||||
Use this route for model recommendations, comparisons, and latest/current/default choices when the user is not requesting a migration or prompting guidance.
|
||||
|
||||
1. Search current official OpenAI documentation for the exact requested workload and any explicitly named model; then open or fetch the relevant official page. For current or latest family guidance, use `https://developers.openai.com/api/docs/guides/latest-model`.
|
||||
2. Use any available official documentation or first-party-domain search. Read the actual source; do not make a recommendation from a search snippet, guessed default, or bundled snapshot.
|
||||
3. Match the documented model to the user's requested modality, quality, latency, cost, context, and workload. Distinguish flagship, balanced, high-throughput, coding, audio, image, or other specialized roles only when the fetched current documentation supports the distinction.
|
||||
4. Preserve an explicitly requested model or existing target. Cite the current official page and state uncertainty about availability, pricing, limits, or account access.
|
||||
|
||||
Pure model selection does not require migration metadata. **Do not run the resolver.**
|
||||
|
||||
Read `references/latest-model.md` only when fetched current official sources cannot answer the question. Disclose that bundled fallback guidance was used and may be outdated.
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
# Official documentation, API references, and ChatGPT Work
|
||||
|
||||
Use this route for OpenAI product or API documentation, examples, citations, ChatGPT Work, learning content, mixed Chat/Work/Codex comparisons, and narrow Codex product documentation. Follow the root skill's official-source order and credential boundary.
|
||||
|
||||
An explicit OpenAI documentation question stays documentation-first even when embedded in a broader repository, Promptfoo, agent-evaluation, `PLANS.md`, frontend, tool-use, image, Realtime API, SDK installation, or streaming-debugging task. Search the exact requested official documentation and open or fetch its relevant page before inspecting local files, drafting a plan, running evals, reading bundled references, or invoking the Codex manual. Then use the fetched official source to complete the requested work.
|
||||
|
||||
## Find the smallest useful source
|
||||
|
||||
1. Search the exact topic with a specific, title-like query containing 2-6 essential terms. Prefer an already-available direct official documentation search and page-retrieval capability; search, then fetch or open the best page or section. Otherwise, immediately use official-domain web search and actually open or fetch the result.
|
||||
2. If the results are noisy, narrow the query. When a plausible official documentation URL is available, open or fetch the page instead of relying on search snippets. Use an already available documentation index only when there is no clear search query.
|
||||
3. For API schemas, required fields, parameters, or endpoint shapes, use an already available OpenAPI or specification capability when it directly resolves the question. Otherwise verify the shape against the fetched official API guide or reference.
|
||||
4. Cite the exact official page supporting each consequential claim. Keep examples minimal, paraphrase instead of quoting at length, and state when official sources do not establish a capability, parameter, price, or availability.
|
||||
|
||||
Preserve an explicitly requested model in the search and answer. Search the requested topic directly for model-specific frontend and tool-use prompting, image input or generation, Realtime voice or translation, official Agents SDK installation, Responses streaming errors, and Codex Goals. A specific Codex feature, error, setting, or requested citation is a narrow documentation lookup, not the broad manual-first exception. Current or latest model recommendations follow the model-selection route and the same official search-and-fetch order.
|
||||
|
||||
## ChatGPT Work and mixed surfaces
|
||||
|
||||
Treat a comparison between Chat, Work, and Codex as ChatGPT Work documentation, not broad Codex self-knowledge. Search `learn.chatgpt.com` and open or fetch the relevant official page. Useful starting pages are:
|
||||
|
||||
- `https://learn.chatgpt.com/docs/use-chatgpt`
|
||||
- `https://learn.chatgpt.com/docs/get-started-with-work`
|
||||
|
||||
If someone simply asks an API question from ChatGPT Work, answer the API question from the relevant API guide. Being in Work does not make it a question about the Work product.
|
||||
|
||||
Separate documented user-facing purposes from unsupported claims about underlying models, hard capability boundaries, file or context inheritance, exact UI labels, account entitlements, and rollout availability. When those details cannot be verified, cite the closest allowed official source and state the uncertainty.
|
||||
|
|
@ -0,0 +1,115 @@
|
|||
## Retrieve the live GPT-6 prompting guidance
|
||||
|
||||
Use already-callable official documentation search and fetch, or immediately use official-domain web search and fetch, to retrieve the live GPT-6 prompting guidance from:
|
||||
|
||||
https://developers.openai.com/api/docs/guides/latest-model/gpt-6-astra.md#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 a documentation fetch 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 copy below only when live guidance is unavailable. Keep it identical to the page's `## Prompting best practices` section when refreshing this reference.
|
||||
|
||||
## Prompting best practices
|
||||
|
||||
GPT-6 Astra is more intelligent and capable than prior models like GPT-5.6 Sol, and also exhibits behavior patterns that can be optimized through prompting the model for your use case.
|
||||
|
||||
### GPT-6 Astra behavior
|
||||
|
||||
- [Initiative and follow-through](#initiative-and-follow-through) – The model is designed to be a more effective collaborator and is thus more likely to ask the user a question when additional input could materially change the result. This can cause it to stop when the user may expect it to make reasonable assumptions and persist.
|
||||
- [Instruction following](#instruction-following) – GPT-6 Astra is stronger at general instruction following than our previous models, giving you greater control over its behavior. It can be more sensitive to instructions contained in skills and other files, such as `AGENTS.md`. We **strongly recommend** auditing skills and other files accessible to your model for instructions that could influence its behavior.
|
||||
- [Personality and writing style](#personality-and-writing-style) – The model tends toward detailed, formatted responses and may use recurring phrases across sessions. Specify the writing style and structure your application needs.
|
||||
- [Subagent delegation](#subagent-delegation) – The model may delegate less often than desired for your workflow. Specify when and how much it should use subagents for parallel work.
|
||||
- [Testing and verification](#testing-and-verification) – For coding tasks, the model tends to be thorough in testing before considering a task complete. For smaller tasks, this can result in broader tests than the task requires.
|
||||
|
||||
### Initiative and follow-through
|
||||
|
||||
GPT-6 Astra is generally better than GPT-5.6 Sol and earlier models at staying coherent during long tasks. It is also more likely to ask for clarification where earlier models would make assumptions.
|
||||
|
||||
To encourage more autonomous work, start with this prompt:
|
||||
|
||||
```text
|
||||
You should infer the user's intent and task scope from the instructions and prior conversation context. Your job is to bias towards action and carry the user's intended task to completion.
|
||||
|
||||
When the user expresses intent to perform new work or fix an existing issue, persist until the user's intended goal is complete. Progress autonomously towards the user's goal (e.g. creating isolated worktrees / checkouts if needed, resolving merge conflicts, read-only actions, creating draft PRs etc.) unless they are clearly destructive or irreversible.
|
||||
```
|
||||
|
||||
When the user’s intent is unclear, the model is more likely to ask the user for clarification to proceed. Prompt the model to follow through if the user’s prompt implies authorization:
|
||||
|
||||
```text
|
||||
When the user's prompt indicates a request for action, such as "can you...", "I want to...", "help me..." and similar expressions, treat these as instructions to do the work and take action. Do not stop at acknowledging capability (e.g. "Yes…"), proposing a plan, or offering to continue. Do not settle for a partial or "helpful enough" solution that does not fully satisfy the user's task to save time, effort or tokens. If a task requires sustained work, complete all the necessary work until the intended outcome is fulfilled.
|
||||
```
|
||||
|
||||
Prompt the model to ask for approval only after preparing a concrete, reviewable result. This avoids blocking the task before the model has done the work it can, and often leads to quicker task completion.
|
||||
|
||||
```text
|
||||
Before asking the user clarifying questions, you should complete the work that is already authorized from context and necessary to make the proposed action concrete and reviewable. The user should be approving a concrete, reviewable result. For example, before deploying a change, writing to an external application, merging a PR or publishing a site, do all the required work first so that user approval is the final step. You don't need user permission for reversible tasks, read-only actions, reviews or fixes, or anything for which authorization is provided earlier in the session or strongly implied from the task instruction.
|
||||
|
||||
Do not introduce unsolicited warnings, disclaimers, approval flows, or safety/compliance checklists due to hypothetical risk.
|
||||
```
|
||||
|
||||
The model also likes to ask non-blocking questions as it’s working by default, so adjust these prompts to match the level of autonomy your application needs.
|
||||
|
||||
### Instruction following
|
||||
|
||||
GPT-6 Astra is better able to follow longer instructions, but can also be more sensitive to information in context. For example, unclear or conflicting guidance in a skill file may cause the model to pause and block work early. Make the priority of user instructions and skills explicit.
|
||||
|
||||
```text
|
||||
The user's instructions take precedence over guidelines provided in a skill. If explicit user instructions conflict with a skill's instructions, prioritize the user's instructions.
|
||||
```
|
||||
|
||||
Asking the model to identify the skill and instruction that caused it to pause or change direction can also be effective in providing transparency into model behavior.
|
||||
|
||||
```text
|
||||
If a skill causes you to ask for permission or confirmation, pause, leave requested work unfinished, or diverge from the user's intent, name and link to the exact SKILL.md file you read, quote the relevant instruction, and briefly explain how it applies. Distinguish explicit skill requirements from your interpretation of guidelines.
|
||||
```
|
||||
|
||||
Use this prompt to find silent and conflicting guidance when your application loads many skills and instruction files such as `AGENTS.md`.
|
||||
|
||||
### Personality and writing style
|
||||
|
||||
GPT-6 Astra tends to use lists, tables and Markdown to make responses scannable. If your application needs prose with less formatting, specify that preference.
|
||||
|
||||
```text
|
||||
Default to using clear, concise paragraphs, each developing one main idea. Use lists only when the information is genuinely parallel, sequential, or easier to compare, and avoid nested lists unless the hierarchy cannot be expressed clearly in prose. Use plain, simple language: familiar words, concrete examples, and precise verbs. Prefer active voice and direct statements.
|
||||
|
||||
Make sure to state the main point clearly and early, then develop it with the explanation and detail the reader needs. Let each sentence build on what came before. Develop the points that matter and provide enough support to be useful.
|
||||
```
|
||||
|
||||
For technical communication, the following prompt helps strike a balance between using clear, coherent language while remaining domain appropriate:
|
||||
|
||||
```text
|
||||
Use plain language over jargon, and reference technical details only to the degree that it helps illustrate an idea or your work to the user. Communicate complex concepts in a clear and cohesive manner, and calibrate your writing to the level of background knowledge assumed from the user's prompt and context.
|
||||
```
|
||||
|
||||
To reduce jargon and stock phrases in writing, start with this prompt:
|
||||
|
||||
```text
|
||||
Avoid using slop words or phrases like "Bottom Line:" in conclusions, "delve," "foster," "leverage," "it's worth noting," "importantly," "Question? Answer." or "This isn't about X. It's about Y.", "genuinely" or hyphenated compound descriptions and adjectives. Do not use concluding summary statements such as "In short:..", "The simplest mental model is:...".
|
||||
|
||||
State the intended action directly. Avoid adding what you won't do, what will remain unchanged, or how you'll separate or categorize results. Do not use contrastive framing such as "X, not Y" or "X—not Y" that introduces an unprompted alternative that the user didn't ask about. Avoid invented compound labels like "exact-head checks" and "editorial-row layouts", vague qualifiers, and canned transitions; use plain verbs and prepositions to state the actual relationship directly.
|
||||
```
|
||||
|
||||
### Subagent delegation
|
||||
|
||||
GPT-6 Astra is trained to be able to divide and delegate work to subagents that work in parallel. If you are implementing a multi-agent system in your harness, use the following prompt to tune how much GPT-6 Astra should delegate work:
|
||||
|
||||
```text
|
||||
If at any point you can parallelize work by delegating tasks to another agent (no matter if you are the root or subagent), you should do so using collaboration tools if it could save time or improve quality.
|
||||
```
|
||||
|
||||
Messages between agents may contain grammar or spacing errors. Use this prompt to make inter-agent messages easier to read:
|
||||
|
||||
```text
|
||||
Messages that you send to other agents and your final answer may be read by a human, so ensure they are legible. Always put proper spaces between words and/or numbers.
|
||||
```
|
||||
|
||||
The model tends to respond well to prompting for how and when it should delegate work to subagents, so tune this behavior to fit with your harness and multi-agent implementation.
|
||||
|
||||
### Testing and verification
|
||||
|
||||
For coding tasks, calibrate how much testing and verification a change requires. This can help avoid unnecessary tests or repeated checks for small changes.
|
||||
|
||||
```text
|
||||
Do not write tests for reversible, low-impact changes that mirror the implementation. If you do choose to verify your work with tests, make sure that the tests are meaningful and necessary to verify implementation.
|
||||
|
||||
Run tests appropriate to the change and complete required checks. Once those pass, broaden or repeat testing only when new changes, failures, or unresolved concerns justify it; otherwise, continue toward completing the task.
|
||||
```
|
||||
|
|
@ -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-6 Astra migration:
|
||||
|
||||
1. Preserve the user's explicit target; do not run the latest-model resolver.
|
||||
2. Fetch the live GPT-6 model guidance:
|
||||
|
||||
https://developers.openai.com/api/docs/guides/latest-model/gpt-6-astra.md
|
||||
|
||||
3. Read `references/upgrading-to-gpt-6-astra.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-6-specific defaults, API shapes, or compatibility rules for a different model.
|
||||
|
|
@ -0,0 +1,221 @@
|
|||
# Upgrading to GPT-6 Astra
|
||||
|
||||
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-6 Astra.
|
||||
|
||||
The default explicit target is `gpt-6-astra`. Verify the `gpt-6` family alias's currently documented routing and availability before using it. Do not treat every old model usage as an Astra candidate: retain Terra for balanced work and Luna as the primary faster or cheaper model.
|
||||
|
||||
Before changing code, retrieve the current live GPT-6 model guidance using already-callable official documentation search and fetch, or immediately use official-domain web search and fetch:
|
||||
|
||||
https://developers.openai.com/api/docs/guides/latest-model/gpt-6-astra.md
|
||||
|
||||
For prompt changes, also read only the `## Prompting best practices` section from:
|
||||
|
||||
https://developers.openai.com/api/docs/guides/latest-model/gpt-6-astra.md#prompting-best-practices
|
||||
|
||||
Treat live docs as canonical for current model IDs, parameters, limits, pricing, and feature availability. The skill-specific workflow below covers repository inspection, scope preservation, and validation. The fallback after it includes all non-prompting guidance, including access notices, examples, caveats, and `## Migration quickstart`; the full prompting section is in `references/prompting-guide.md`. When refreshing, preserve all guide content unless it is specific to the website rather than useful to the skill, and record any omission. Remove website metadata and component markup while retaining their readable content. Resolve site-relative links against `https://developers.openai.com` and section-only links against the canonical model-guide URL above.
|
||||
|
||||
## 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-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. Set a supported reasoning effort explicitly to preserve the source model's effective behavior; verify omitted defaults rather than guessing.
|
||||
|
||||
## Migration posture
|
||||
|
||||
Classify every usage site before editing:
|
||||
|
||||
1. `simple Astra 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 Astra, Terra, or Luna instead of replacing everything with Astra.
|
||||
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 target | Reason |
|
||||
| --- | --- | --- |
|
||||
| GPT-5.6 Sol or an earlier flagship | `gpt-6-astra` | Astra is the flagship-equivalent tier. |
|
||||
| Balanced quality, latency, and cost | `gpt-5.6-terra` | Terra is the balanced option. |
|
||||
| Faster or cheaper work, classification, extraction, routing, high-volume, or strict-latency route | `gpt-5.6-luna` | Luna is the primary speed and cost option. |
|
||||
| GPT-4.1 or GPT-4o latency-sensitive flow | Start with Luna; evaluate Terra or Astra if quality requires it | A flagship replacement can change latency and cost materially. |
|
||||
| Reasoning-heavy or hardest quality-first flow | Start with Astra at the old effective effort | Preserve the reasoning contract before tuning. |
|
||||
| Router, fallback, or model picker | Add the family by role | Do not collapse a multi-model design into Astra. |
|
||||
| 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:
|
||||
|
||||
- Each model's context window and maximum output.
|
||||
- Long-context pricing thresholds for each route.
|
||||
- Token pricing for GPT-6.
|
||||
|
||||
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-6 Astra and retain the existing Terra and Luna options unless the user explicitly asks to replace or remove them. Do not invent pricing, context limits, capabilities, or metadata unless confirmed from canonical docs.
|
||||
|
||||
If using the `gpt-6` alias, record the returned `response.model` during validation. Do not assume an alias and an explicit Astra slug appear identically in dashboards, rate-limit configuration, analytics, or billing metadata.
|
||||
|
||||
## 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.
|
||||
|
||||
## Prompt migration judgment
|
||||
|
||||
After the model and API baseline is working, run representative traces before editing prompts. Change prompts only for measured failures. Read `references/prompting-guide.md` for the exact canonical prompting section when prompt changes are needed.
|
||||
|
||||
## Upgrade workflow
|
||||
|
||||
1. Fetch current live GPT-6 docs. Fetch the Prompting Best Practices section only when prompt changes are needed.
|
||||
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 Astra, Terra, or Luna by the existing workload's role.
|
||||
5. Preserve the old effective reasoning effort explicitly when supported; follow the canonical migration guidance for unsupported settings.
|
||||
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, async tools, 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-6 target + same prompt + preserved effective reasoning;
|
||||
3. GPT-6 target + same prompt + one lower supported effort;
|
||||
4. GPT-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;
|
||||
- total 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 Astra 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`: Astra, 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.
|
||||
|
||||
## Introduction
|
||||
|
||||
GPT-6 Astra is our most intelligent model yet, with state-of-the-art performance in computer use, browsing, software engineering, science, and professional work. It excels at carrying out multistep workflows across code, browsers, and professional software. In <a href="https://openai.com/index/gpt-6-astra/" target="_blank" rel="noopener noreferrer">several evaluations</a>, Astra achieves stronger results while using substantially fewer output tokens—delivering a lower estimated API cost per task than earlier models despite its higher per-token pricing.
|
||||
|
||||
GPT-6 Astra is also our most aligned model yet. It excels at exercising care, respecting task boundaries, and communicating transparently. When instructions leave room for interpretation, it uses the context it has to fill in routine gaps and asks focused questions when the answer could change the outcome. It incorporates new requirements, changes course when asked, and answers side questions without losing track of the broader task.
|
||||
|
||||
To build with Astra, set `model` to `gpt-6-astra` in a [Responses API](https://developers.openai.com/api/docs/guides/migrate-to-responses) request.
|
||||
|
||||
## What's new
|
||||
|
||||
- **Async tool calling:** GPT-6 Astra can continue reasoning, call other tools, or answer independent parts of a request while your application runs a tool. Set `async: true` on a function or custom tool and return its result when ready using the original `call_id`. Your application still executes the tool and manages pending work. See [Async tool calling](https://developers.openai.com/api/docs/guides/async-tool-calling) for basic usage and a developer-defined wait-tool pattern.
|
||||
- **Mid-turn steering:** Send additional user instructions while GPT-6 Astra is working, such as a correction or a change in requirements. Over a WebSocket connection, the Responses API preserves completed work and includes the update in a continuation. See [Mid-turn steering](https://developers.openai.com/api/docs/guides/steering) for the event flow and tool-result handling.
|
||||
- **Change reasoning mid-conversation while preserving cache:** Add a `configuration_update` input item to increase reasoning effort for difficult work or reduce it for routine follow-ups without rewriting the original prompt prefix. The updated reasoning effort applies until another `configuration_update` input item overrides it. See [Change reasoning mid-conversation](https://developers.openai.com/api/docs/guides/reasoning#change-reasoning-mid-conversation) for examples and compatibility.
|
||||
- **Misalignment monitoring:** As part of our <a href="https://openai.com/index/path-to-astra/" target="_blank" rel="noopener noreferrer">strengthened safeguards</a> for GPT-6 Astra, our systems asynchronously monitor for misalignment and trigger alerts when necessary. See [Misalignment monitoring](https://developers.openai.com/api/docs/guides/safety-checks/misalignment-monitoring) for more information.
|
||||
- **Limitations:** GPT-6 Astra does not support the `none` reasoning effort. [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) is unavailable for GPT-6 Astra with EU data residency.
|
||||
|
||||
GPT-6 Astra also supports the existing API capabilities available with GPT-5.6, including [computer use](https://developers.openai.com/api/docs/guides/tools-computer-use), [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs), [streaming](https://developers.openai.com/api/docs/guides/streaming-responses), [Programmatic Tool Calling](https://developers.openai.com/api/docs/guides/tools-programmatic-tool-calling), [multi-agent orchestration](https://developers.openai.com/api/docs/guides/responses-multi-agent), [prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching), [persisted reasoning](https://developers.openai.com/api/docs/guides/reasoning#preserve-reasoning-across-calls), [compaction](https://developers.openai.com/api/docs/guides/compaction), and [pro mode](https://developers.openai.com/api/docs/guides/reasoning#reasoning-mode).
|
||||
|
||||
## Migration quickstart
|
||||
|
||||
### Migrate with Codex
|
||||
|
||||
Codex can apply the recommended changes in this guide with the <a href="https://github.com/openai/skills/tree/main/skills/.curated/openai-docs" target="_blank" rel="noopener noreferrer">OpenAI Docs skill</a>.
|
||||
|
||||
```text
|
||||
$openai-docs migrate this project to GPT-6 Astra
|
||||
```
|
||||
|
||||
To use this skill in other coding agents, download it from the <a href="https://github.com/openai/skills/tree/main/skills/.curated/openai-docs" target="_blank" rel="noopener noreferrer">OpenAI skills repository</a>.
|
||||
|
||||
### Update API and model parameters
|
||||
|
||||
Set `model` to `gpt-6-astra`, then check the following:
|
||||
|
||||
- **Reasoning effort:** If you currently use `none` or `minimal`, start with `low` and compare results. Otherwise, preserve your current effective [reasoning effort](https://developers.openai.com/api/docs/guides/reasoning#reasoning-effort). Use `reasoning.effort` in Responses or `reasoning_effort` in Chat Completions.
|
||||
- **Tool calling:** Use the [Responses API](https://developers.openai.com/api/docs/guides/migrate-to-responses#migrating-from-chat-completions). GPT-6 Astra supports Chat Completions, but tool calling requires Responses.
|
||||
- **Unsupported parameters:** Remove `temperature`, `top_p`, and `top_logprobs`. For Chat Completions, also remove `logprobs`. For Responses, remove `message.output_text.logprobs` from `include`.
|
||||
- **Fast mode:** For EU data residency, use Standard processing. GPT-6 Astra does not support `service_tier: "fast"` or `service_tier: "priority"` with EU data residency. Fast mode for GPT-6 Astra does not include a latency SLA. See [Fast mode compatibility](https://developers.openai.com/api/docs/guides/fast-mode#is-fast-mode-compatible-with-data-residency-zero-data-retention-and-a-baa).
|
||||
- **Changing reasoning effort:** If your application changes effort between responses, use `configuration_update` items in standard, single-agent requests. Keep request-level `reasoning.effort` unchanged to preserve the prompt prefix for caching. Check the [compatibility limits](https://developers.openai.com/api/docs/guides/reasoning#change-reasoning-mid-conversation) before adopting this feature.
|
||||
- **Prompt caching:** When migrating from GPT-5.5 or earlier, replace `prompt_cache_retention` with `prompt_cache_options.ttl` set to `"30m"`. Review the [prompt caching changes](https://developers.openai.com/api/docs/guides/prompt-caching#summary-of-model-differences), including cache boundaries and cache-write billing.
|
||||
- **Unnecessary approval pauses:** If you run into issues where the model keeps asking for approval before proceeding, use the [initiative and follow-through guidance](https://developers.openai.com/api/docs/guides/latest-model/gpt-6-astra.md#initiative-and-follow-through) to prompt for more autonomous execution. See the rest of [Prompting best practices](https://developers.openai.com/api/docs/guides/latest-model/gpt-6-astra.md#prompting-best-practices) for guidance on instruction following, writing style, subagent delegation, and testing.
|
||||
Loading…
Add table
Add a link
Reference in a new issue