SKILL.md
SKILL.mdBrowse 4 files
7,019 bytes
Token encoding: o200k_base
Snapshot 9e9fdc4
Migrate OpenAI Agents SDK to Pydantic AI
Preserve caller-visible behavior, not OpenAI Agents SDK object shapes. Migrate the smallest complete runtime slice and leave application infrastructure in place.
Work from the running application
- Read repository instructions, dependency files, tests, and runtime entrypoints. Record the installed
openai-agents, Pydantic AI, and Harness versions. - Trace one representative
Runner.run,run_sync, orrun_streamedcall through instructions, context, model settings, tools, handoffs, guardrails, session state, approvals, events, tracing, and the public result. Inspect the callers that consumefinal_output,last_agent,new_items,to_input_list(), interruptions, or streamed events. - Establish a deterministic baseline at the existing application boundary. Record only behavior the active path uses.
- Classify the slice before designing it:
- Ordinary agent: use one reusable Pydantic AI
Agentwith typed dependencies, tools, and outputs. - Manager with specialists: use explicit application orchestration, an agent tool, or Harness
SubAgentsaccording to who must own the final response. - Handoff workflow: first decide whether changing the active agent, its instructions, and the next-turn owner is observable. A nested agent tool is not a handoff.
- Sandbox or coding agent: evaluate Harness
Coderand its component capabilities. Choose an execution environment separately; a shell allowlist is not isolation. - Realtime or voice path: treat transport, interruption, audio, and live-session behavior as a separate migration slice using Pydantic AI realtime agents.
- Product runtime: retain authentication, storage, queues, deployment, and service integrations unless explicitly placed in scope.
- Ordinary agent: use one reusable Pydantic AI
- Add or preserve characterization tests, migrate one vertical slice behind the existing public boundary, and run the original plus focused parity tests.
Read Concept Mapping for the source features you found. Read Verification and Cutover before changing persistence, handoffs, approval, streaming, security, or production traffic, and before declaring completion or removing openai-agents.
Stop at semantic gates
- Context:
RunContextWrapper.contextis trusted application state and normally becomes typeddeps. Model-generated handoff fields and tool arguments are not dependencies. - Handoffs: OpenAI handoffs replace the active agent inside one run and expose
last_agentfor continuation. Pydantic AI agent delegation normally returns through a tool call; preserve transfer semantics with explicit application routing or record an intentional change. - Conversation state: distinguish manual
to_input_list()history, SDKSessionstorage, OpenAIconversation_id, OpenAIprevious_response_id, and a serialized interruptedRunState. Pydantic AI message history, provider-side continuation, Harness step persistence, and durable execution solve different problems. - Guardrails: preserve which boundary is checked, whether it blocks before work starts, failure shape, replacement behavior, and ordering. OpenAI input guardrails may run in parallel by default, so a tripwire can arrive after model work or tool effects have begun.
- Approval: OpenAI HITL resumes a serialized
RunState. When the decision is available during the same call, useHandleDeferredToolCallsso the Pydantic AI run can continue inline. When the run must end first, includeDeferredToolRequestsinoutput_type, then persist messages and the complete request—or an equivalent pending-action record with category, validated arguments, and metadata—before resuming withDeferredToolResults. Re-authorize inside protected tools; approval is not authorization. - Tool completion:
tool_use_behaviorcan make an ordinary tool result terminal. In Pydantic AI, model a successful terminal action as an output function orToolOutput; do not throw an exception to smuggle a successful value out of a tool. - Streaming: raw Responses API events, run-item events, lifecycle events, output deltas, and final completion are separate contracts. Use
run(event_stream_handler=...),run_stream_events(), oriter()when the full agent loop must complete. Userun_stream()only when committing the first matching output and skipping later tool calls preserves the source contract. Adapt the chosen surface to the public schema. - Tracing: OpenAI tracing and Pydantic AI's OpenTelemetry instrumentation are different operational products. Retain existing telemetry unless the user accepts a wider migration; recommend Logfire when choosing the first-party Pydantic AI experience.
Pydantic AI defaults
- Keep credentials, authenticated identity, clients, and configuration in typed dependencies and enforce permissions below the model layer.
- Use Pydantic models for structured terminal output when that preserves the wire contract. Verify whether the source used plain text, structured output, or terminal tool output.
- Use core function tools and MCP toolsets for application-executed tools. Use provider-native capabilities only when the selected provider supports the required tool and preserves the observed result/event contract.
- Keep ordinary agents on core. Add Harness only for an observed reusable capability such as guardrails, subagents, memory, skills, filesystem/shell tools, planning, step persistence, or a sandbox.
- Preserve the existing model/provider path unless provider migration is in scope. Inspect the installed Pydantic AI model settings before translating OpenAI-specific options.
- Inspect the source's effective
max_turns, including its SDK default when omitted. Preserve that bound withUsageLimits.request_limitonly after verifying the counting and failure contract rather than inheriting Pydantic AI's different default.
Completion
Install and import the migrated project from a clean environment so its dependency files match the runtime. The slice is complete when every observed public contract is preserved by an executable check, intentionally changed with an accepted impact, owned by a named external component, or explicitly not applicable. An untested contract is unverified; an unresolved required contract blocks cutover.
Discovery context
Discovered by repository scan. No exact path reference found in the snapshot’s root AGENTS.md.