// AI Platform Drift
openai-agents-python 0.24.0 changes RunConfig.tool_error_formatter signature and RunState schema
OpenAI Agents Python SDK releases · published 2026-11-18 20:33 UTC
WHAT CHANGEDopenai-agents-python 0.24.0 changes RunConfig.tool_error_formatter to receive kind="tool_exception" and an optional error parameter. New RunState snapshots use schema 1.21. The Temporal extra now requires temporalio==1.34.0; the Vercel extra requires vercel-sandbox>=0.7.0,<0.9. New Decisions recipes require OpenAI SDK >=3.26.0,<4.
WHY IT MATTERSCustom error formatters that do not handle the new kind parameter will break. Saved agent graphs from earlier versions cannot resume on 0.24.0 without finishing on their original SDK first. Temporal and Vercel sandbox integrations will fail if dependency versions are outside the new bounds.
WHAT TO DOUpdate custom tool_error_formatter implementations to handle kind="tool_exception" or return None. Finish in-progress saved runs on their original SDK before upgrading, or use unique agent names for new durable runs. Update temporalio to 1.34.0 if using the Temporal extra, and vercel-sandbox to >=0.7.0,<0.9 if using the Vercel extra.
Model-reported confidence 90% (not measured accuracy)
Primary source ↗
written by anthropic/claude-sonnet-4.5
Show the reasoning — raw diff, triage verdict, confidence
RAW DIFF
## v0.24.0 https://github.com/openai/openai-agents-python/releases/tag/v0.24.0 -2026-10-15T02:37:43Z +2026-11-18T19:20:04Z 0.24.0 (2026-10-15) +Key Changes +0.24.0 adds run-wide function error formatting and MCP discovery annotations, and improves recovery, sandbox safety, and tracing. This minor release includes compatibility changes for custom error callbacks and some saved agent graphs. Review the first two highlights before upgrading. +Highlights: + +Update custom error formatters. RunConfig.tool_error_formatter can receive kind="tool_exception" and an optional error. Handle the new kind or return None to retain the default message. Explicit per-tool handlers keep precedence; unconfigured defaults stay unchanged. +Plan upgrades around saved runs. New RunState snapshots use schema 1.21. Finish affected older same-name agent graphs on their original SDK. Keep the agent code and original hook ordering unchanged. Use unique agent names for new durable runs; renaming a saved graph is not a migration. +Recover completed work more reliably. Deferred approval history, completed tool outputs, aliases, and compaction state survive supported recovery paths. Automatic compaction waits for approvals. Redis replaces history atomically on supported standalone clients. Conversations appends respect the 20-item request limit. Reconcile partial writes before retrying. +Harden local execution and display. macOS sandbox commands deny Launch Services requests. Sandbox tools recover from invalid model arguments. Protected mount errors preserve caller exception data while detaching the caught traceback. The realtime demo displays tool content as text. +Honor tracing choices through resume and cleanup. Per-run tracing opt-out applies inside caller traces, and approved resumed tools attach to the resumed agent span. +Use richer integration examples and metadata. MCP tools expose optional mcp_annotations as discovery hints. New Decisions recipes demonstrate classification, routing, and tool review with OpenAI >=3.26.0,<4. They use a separate client, not an Agents model adapter. +Refresh optional dependency locks. The Temporal extra uses temporalio==1.34.0; the Vercel extra supports vercel-sandbox>=0.7.0,<0.9. Core Python and OpenAI SDK minimums are unchanged. + +Thanks to @masasron for reporting the macOS local sandbox issue fixed in #5335. Features expose MCP annotations on converted tools (#5356) (75813f8) @@ docs/sandbox/clients.md, local and hosted clients Optionally note macOS Launch Services denial and document the Vercel >=0.7.0,<0.9 bound. Preserve the existing local-isolation limitations. -Publication timing: publish documentation for new behavior after 0.24.0 is available. These documentation gaps do not block the release. - -Key Changes draft -Key Changes -0.24.0 adds run-wide function error formatting and MCP discovery annotations, and improves recovery, sandbox safety, and tracing. This minor release includes compatibility changes for custom error callbacks and some saved agent graphs. Review the first two highlights before upgrading. -Highlights: - -Update custom error formatters. RunConfig.tool_error_formatter can receive kind="tool_exception" and an optional error. Handle the new kind or return None to retain the default message. Explicit per-tool handlers keep precedence; unconfigured defaults stay unchanged. -Plan upgrades around saved runs. New RunState snapshots use schema 1.21. Finish affected older same-name agent graphs on their original SDK. Keep the agent code and original hook ordering unchanged. Use unique agent names for new durable runs; renaming a saved graph is not a migration. -Recover completed work more reliably. Deferred approval history, completed tool outputs, aliases, and compaction state survive supported recovery paths. Automatic compaction waits for approvals. Redis replaces history atomically on supported standalone clients. Conversations appends respect the 20-item request limit. Reconcile partial writes before retrying. -Harden local execution and display. macOS sandbox commands deny Launch Services requests. Sandbox tools recover from invalid model arguments. Protected mount errors preserve caller exception data while detaching the caught traceback. The realtime demo displays tool content as text. -Honor tracing choices through resume and cleanup. Per-run tracing opt-out applies inside caller traces, and approved resumed tools attach to the resumed agent span. -Use richer integration examples and metadata. MCP tools expose optional mcp_annotations as discovery hints. New Decisions recipes demonstrate classification, routing, and tool review with OpenAI >=3.26.0,<4. They use a separate client, not an Agents model adapter. -Refresh optional dependency locks. The Temporal extra uses temporalio==1.34.0; the Vercel extra supports vercel-sandbox>=0.7.0,<0.9. Core Python and OpenAI SDK minimums are unchanged. - -Thanks to @masasron for reporting the macOS local sandbox issue fixed in #5335. -Notes - -This review covers the exact candidate above, including its release metadata. Changes to main, the candidate, or its API baseline require a fresh release check and approval. +Publication timing: publish documentation for new behavior after 0.24.0 is available. These documentation gaps do not block the release.
HOW IT WAS JUDGED
Triage signals below are model-reported assertions, preserved verbatim; they are not independent arithmetic verification.
| triage verdict | MATERIAL at 0.85, needed 0.5 |
|---|---|
| triage reasoning | Custom error callback signature changed; saved runs incompatible with new schema; dependency and SDK version constraints introduced. |
| signals | breaking API change: RunConfig.tool_error_formatter signature changed · schema migration: RunState snapshots now use schema 1.21 · saved state incompatibility: older agent graphs require finishing on original SDK · dependency version bump: temporalio==1.34.0, vercel-sandbox>=0.7.0,<0.9 · behavior change: automatic compaction now waits for approvals · behavior change: Redis history replacement atomicity, conversation append limits · new required OpenAI SDK floor: >=3.26.0,<4 for Decisions recipes |
| suppression | — |
| triage model | anthropic/claude-haiku-4.5 ($0.00000) |
| writer model | anthropic/claude-sonnet-4.5 ($0.00000) |