ツール

ツールを使うと、エージェントはデータ取得、コード実行、外部 API 呼び出し、さらにはコンピュータ操作などのアクションを実行できます。 SDK は 5 つのカテゴリーをサポートしています。

OpenAI がホストするツール: OpenAI サーバー上でモデルと並行して実行されます。
ローカル / ランタイム実行ツール: ComputerTool と ApplyPatchTool は常にあなたの環境で実行され、ShellTool はローカルまたはホストされたコンテナで実行できます。
Function Calling: 任意の Python 関数をツールとしてラップします。
Agents as tools: 完全なハンドオフなしで、エージェントを呼び出し可能なツールとして公開します。
実験的機能: Codex ツール: ツール呼び出しからワークスペーススコープの Codex タスクを実行します。

ツール種類の選択

このページをカタログとして使い、次に、制御しているランタイムに合うセクションへ進んでください。

したいこと	開始場所
OpenAI 管理ツール ( Web 検索、ファイル検索、Code Interpreter、ホスト型 MCP、画像生成 ) を使う	Hosted tools
自分のプロセスまたは環境でツールを実行する	Local runtime tools
Python 関数をツールとしてラップする	関数ツール
ハンドオフなしで 1 つのエージェントから別のエージェントを呼び出す	Agents as tools
エージェントからワークスペーススコープの Codex タスクを実行する	Experimental: Codex tool

Hosted tools

OpenAI は OpenAIResponsesModel 使用時に、いくつかの組み込みツールを提供しています。

WebSearchTool は、エージェントが Web 検索を行えるようにします。
FileSearchTool は、OpenAI ベクトルストアから情報を取得できます。
CodeInterpreterTool は、LLM がサンドボックス環境でコードを実行できるようにします。
HostedMCPTool は、リモート MCP サーバーのツールをモデルに公開します。
ImageGenerationTool は、プロンプトから画像を生成します。

高度なホスト型検索オプション:

FileSearchTool は、vector_store_ids と max_num_results に加えて、filters、ranking_options、include_search_results をサポートします。
WebSearchTool は、filters、user_location、search_context_size をサポートします。

from agents import Agent, FileSearchTool, Runner, WebSearchTool

agent = Agent(
    name="Assistant",
    tools=[
        WebSearchTool(),
        FileSearchTool(
            max_num_results=3,
            vector_store_ids=["VECTOR_STORE_ID"],
        ),
    ],
)

async def main():
    result = await Runner.run(agent, "Which coffee shop should I go to, taking into account my preferences and the weather today in SF?")
    print(result.final_output)

ホスト型コンテナ shell + スキル

ShellTool は OpenAI ホスト型コンテナ実行にも対応しています。ローカルランタイムではなく管理されたコンテナでモデルに shell コマンドを実行させたい場合は、このモードを使ってください。

from agents import Agent, Runner, ShellTool, ShellToolSkillReference

csv_skill: ShellToolSkillReference = {
    "type": "skill_reference",
    "skill_id": "skill_698bbe879adc81918725cbc69dcae7960bc5613dadaed377",
    "version": "1",
}

agent = Agent(
    name="Container shell agent",
    model="gpt-5.2",
    instructions="Use the mounted skill when helpful.",
    tools=[
        ShellTool(
            environment={
                "type": "container_auto",
                "network_policy": {"type": "disabled"},
                "skills": [csv_skill],
            }
        )
    ],
)

result = await Runner.run(
    agent,
    "Use the configured skill to analyze CSV files in /mnt/data and summarize totals by region.",
)
print(result.final_output)

後続の実行で既存コンテナを再利用するには、environment={"type": "container_reference", "container_id": "cntr_..."} を設定します。

知っておくべき点:

Hosted shell は Responses API の shell ツール経由で利用できます。
container_auto はリクエスト用にコンテナをプロビジョニングし、container_reference は既存のものを再利用します。
container_auto には file_ids と memory_limit も含められます。
environment.skills はスキル参照とインラインスキルバンドルを受け付けます。
ホスト型環境では、ShellTool に executor、needs_approval、on_approval を設定しないでください。
network_policy は disabled と allowlist モードをサポートします。
allowlist モードでは、network_policy.domain_secrets によりドメインスコープのシークレットを名前で注入できます。
完全なコード例は examples/tools/container_shell_skill_reference.py と examples/tools/container_shell_inline_skill.py を参照してください。
OpenAI プラットフォームガイド: Shell と Skills。

ローカルランタイムツール

ローカルランタイムツールは、モデル応答自体の外側で実行されます。モデルは呼び出しタイミングを決定しますが、実際の処理はアプリケーションまたは設定済み実行環境が行います。

ComputerTool と ApplyPatchTool は、常にあなたが提供するローカル実装を必要とします。ShellTool は両方のモードにまたがります。管理実行が必要なら上記のホスト型コンテナ設定を、独自プロセスでコマンドを実行したいなら以下のローカルランタイム設定を使ってください。

ローカルランタイムツールでは実装の提供が必要です。

ComputerTool: GUI / ブラウザ自動化を有効化するため、Computer または AsyncComputer インターフェースを実装します。
ShellTool: ローカル実行とホスト型コンテナ実行の両方に対応した最新の shell ツールです。
LocalShellTool: 旧来のローカル shell 連携です。
ApplyPatchTool: 差分をローカル適用するため、ApplyPatchEditor を実装します。
ローカル shell スキルは ShellTool(environment={"type": "local", "skills": [...]}) で利用できます。

from agents import Agent, ApplyPatchTool, ShellTool
from agents.computer import AsyncComputer
from agents.editor import ApplyPatchResult, ApplyPatchOperation, ApplyPatchEditor


class NoopComputer(AsyncComputer):
    environment = "browser"
    dimensions = (1024, 768)
    async def screenshot(self): return ""
    async def click(self, x, y, button): ...
    async def double_click(self, x, y): ...
    async def scroll(self, x, y, scroll_x, scroll_y): ...
    async def type(self, text): ...
    async def wait(self): ...
    async def move(self, x, y): ...
    async def keypress(self, keys): ...
    async def drag(self, path): ...


class NoopEditor(ApplyPatchEditor):
    async def create_file(self, op: ApplyPatchOperation): return ApplyPatchResult(status="completed")
    async def update_file(self, op: ApplyPatchOperation): return ApplyPatchResult(status="completed")
    async def delete_file(self, op: ApplyPatchOperation): return ApplyPatchResult(status="completed")


async def run_shell(request):
    return "shell output"


agent = Agent(
    name="Local tools agent",
    tools=[
        ShellTool(executor=run_shell),
        ApplyPatchTool(editor=NoopEditor()),
        # ComputerTool expects a Computer/AsyncComputer implementation; omitted here for brevity.
    ],
)

関数ツール

任意の Python 関数をツールとして使えます。 Agents SDK が自動的にツールを設定します。

ツール名は Python 関数名になります ( または名前を指定できます )
ツール説明は関数の docstring から取得されます ( または説明を指定できます )
関数入力のスキーマは、関数の引数から自動生成されます
無効化しない限り、各入力の説明は関数の docstring から取得されます

関数シグネチャの抽出には Python の inspect モジュールを使用し、docstring の解析には griffe を、スキーマ作成には pydantic を使います。

import json

from typing_extensions import TypedDict, Any

from agents import Agent, FunctionTool, RunContextWrapper, function_tool


class Location(TypedDict):
    lat: float
    long: float

@function_tool  # (1)!
async def fetch_weather(location: Location) -> str:
    # (2)!
    """Fetch the weather for a given location.

    Args:
        location: The location to fetch the weather for.
    """
    # In real life, we'd fetch the weather from a weather API
    return "sunny"


@function_tool(name_override="fetch_data")  # (3)!
def read_file(ctx: RunContextWrapper[Any], path: str, directory: str | None = None) -> str:
    """Read the contents of a file.

    Args:
        path: The path to the file to read.
        directory: The directory to read the file from.
    """
    # In real life, we'd read the file from the file system
    return "<file contents>"


agent = Agent(
    name="Assistant",
    tools=[fetch_weather, read_file],  # (4)!
)

for tool in agent.tools:
    if isinstance(tool, FunctionTool):
        print(tool.name)
        print(tool.description)
        print(json.dumps(tool.params_json_schema, indent=2))
        print()

関数引数には任意の Python 型を使え、関数は sync / async のどちらでも構いません。
docstring が存在する場合、説明と引数説明の取得に使われます。
関数はオプションで context を受け取れます ( 必ず先頭引数 )。また、ツール名、説明、使用する docstring スタイルなどの上書きも設定できます。
デコレートされた関数をツール一覧に渡せます。

出力を表示

fetch_weather
Fetch the weather for a given location.
{
"$defs": {
  "Location": {
    "properties": {
      "lat": {
        "title": "Lat",
        "type": "number"
      },
      "long": {
        "title": "Long",
        "type": "number"
      }
    },
    "required": [
      "lat",
      "long"
    ],
    "title": "Location",
    "type": "object"
  }
},
"properties": {
  "location": {
    "$ref": "#/$defs/Location",
    "description": "The location to fetch the weather for."
  }
},
"required": [
  "location"
],
"title": "fetch_weather_args",
"type": "object"
}

fetch_data
Read the contents of a file.
{
"properties": {
  "path": {
    "description": "The path to the file to read.",
    "title": "Path",
    "type": "string"
  },
  "directory": {
    "anyOf": [
      {
        "type": "string"
      },
      {
        "type": "null"
      }
    ],
    "default": null,
    "description": "The directory to read the file from.",
    "title": "Directory"
  }
},
"required": [
  "path"
],
"title": "fetch_data_args",
"type": "object"
}

関数ツールからの画像 / ファイル返却

テキスト出力の返却に加えて、関数ツールの出力として 1 つまたは複数の画像 / ファイルを返せます。そのためには、次のいずれかを返します。

画像: ToolOutputImage ( または TypedDict 版の ToolOutputImageDict )
ファイル: ToolOutputFileContent ( または TypedDict 版の ToolOutputFileContentDict )
テキスト: 文字列または文字列化可能オブジェクト、または ToolOutputText ( または TypedDict 版の ToolOutputTextDict )

カスタム関数ツール

Python 関数をツールとして使いたくない場合もあります。その場合は、必要に応じて FunctionTool を直接作成できます。以下の提供が必要です。

name
description
params_json_schema ( 引数用 JSON スキーマ )
on_invoke_tool ( ToolContext と JSON 文字列の引数を受け取り、ツール出力 ( 例: テキスト、構造化ツール出力オブジェクト、または出力リスト ) を返す async 関数 )

from typing import Any

from pydantic import BaseModel

from agents import RunContextWrapper, FunctionTool



def do_some_work(data: str) -> str:
    return "done"


class FunctionArgs(BaseModel):
    username: str
    age: int


async def run_function(ctx: RunContextWrapper[Any], args: str) -> str:
    parsed = FunctionArgs.model_validate_json(args)
    return do_some_work(data=f"{parsed.username} is {parsed.age} years old")


tool = FunctionTool(
    name="process_user",
    description="Processes extracted user data",
    params_json_schema=FunctionArgs.model_json_schema(),
    on_invoke_tool=run_function,
)

引数と docstring の自動解析

前述のとおり、ツールのスキーマ抽出のために関数シグネチャを自動解析し、ツールおよび個別引数の説明抽出のために docstring を解析します。注意点は以下です。

シグネチャ解析は inspect モジュールで行います。引数型の理解には型アノテーションを用い、全体スキーマを表現する Pydantic モデルを動的に構築します。Python プリミティブ、Pydantic モデル、TypedDict など多くの型をサポートします。
docstring 解析には griffe を使用します。対応フォーマットは google、sphinx、numpy です。docstring フォーマットは自動検出を試みますがベストエフォートであり、function_tool 呼び出し時に明示指定できます。use_docstring_info を False に設定して docstring 解析を無効化することもできます。

スキーマ抽出コードは agents.function_schema にあります。

Pydantic Field による引数の制約と説明

ツール引数に制約 ( 例: 数値の min / max、文字列の長さやパターン ) と説明を追加するには、Pydantic の Field を使えます。Pydantic と同様に、デフォルトベース ( arg: int = Field(..., ge=1) ) と Annotated ( arg: Annotated[int, Field(..., ge=1)] ) の両形式をサポートします。生成される JSON スキーマとバリデーションにはこれらの制約が含まれます。

from typing import Annotated
from pydantic import Field
from agents import function_tool

# Default-based form
@function_tool
def score_a(score: int = Field(..., ge=0, le=100, description="Score from 0 to 100")) -> str:
    return f"Score recorded: {score}"

# Annotated form
@function_tool
def score_b(score: Annotated[int, Field(..., ge=0, le=100, description="Score from 0 to 100")]) -> str:
    return f"Score recorded: {score}"

関数ツールのタイムアウト

非同期関数ツールでは、@function_tool(timeout=...) で呼び出しごとのタイムアウトを設定できます。

import asyncio
from agents import Agent, Runner, function_tool


@function_tool(timeout=2.0)
async def slow_lookup(query: str) -> str:
    await asyncio.sleep(10)
    return f"Result for {query}"


agent = Agent(
    name="Timeout demo",
    instructions="Use tools when helpful.",
    tools=[slow_lookup],
)

タイムアウト到達時のデフォルト動作は timeout_behavior="error_as_result" で、モデル可視のタイムアウトメッセージ ( 例: Tool 'slow_lookup' timed out after 2 seconds. ) を送信します。

タイムアウト処理は次のように制御できます。

timeout_behavior="error_as_result" ( デフォルト ): モデルにタイムアウトメッセージを返し、復旧できるようにします。
timeout_behavior="raise_exception": ToolTimeoutError を送出して run を失敗させます。
timeout_error_function=...: error_as_result 使用時のタイムアウトメッセージをカスタマイズします。

import asyncio
from agents import Agent, Runner, ToolTimeoutError, function_tool


@function_tool(timeout=1.5, timeout_behavior="raise_exception")
async def slow_tool() -> str:
    await asyncio.sleep(5)
    return "done"


agent = Agent(name="Timeout hard-fail", tools=[slow_tool])

try:
    await Runner.run(agent, "Run the tool")
except ToolTimeoutError as e:
    print(f"{e.tool_name} timed out in {e.timeout_seconds} seconds")

Note

タイムアウト設定は async @function_tool ハンドラーでのみサポートされます。

関数ツールでのエラー処理

@function_tool で関数ツールを作成する際、failure_error_function を渡せます。これはツール呼び出しがクラッシュした場合に LLM へ返すエラーレスポンスを提供する関数です。

デフォルトでは ( つまり何も渡さない場合 )、default_tool_error_function が実行され、LLM にエラー発生を伝えます。
独自エラー関数を渡した場合はそれが実行され、レスポンスが LLM に送信されます。
None を明示的に渡した場合、ツール呼び出しエラーはすべて再送出され、あなたが処理します。これは、モデルが不正な JSON を生成した場合の ModelBehaviorError や、コードがクラッシュした場合の UserError などです。

from agents import function_tool, RunContextWrapper
from typing import Any

def my_custom_error_function(context: RunContextWrapper[Any], error: Exception) -> str:
    """A custom function to provide a user-friendly error message."""
    print(f"A tool call failed with the following error: {error}")
    return "An internal server error occurred. Please try again later."

@function_tool(failure_error_function=my_custom_error_function)
def get_user_profile(user_id: str) -> str:
    """Fetches a user profile from a mock API.
     This function demonstrates a 'flaky' or failing API call.
    """
    if user_id == "user_123":
        return "User profile for user_123 successfully retrieved."
    else:
        raise ValueError(f"Could not retrieve profile for user_id: {user_id}. API returned an error.")

FunctionTool オブジェクトを手動作成する場合は、on_invoke_tool 関数内でエラーを処理する必要があります。

Agents as tools

一部のワークフローでは、制御をハンドオフする代わりに、中央エージェントが専門エージェント群をエージェントオーケストレーションしたい場合があります。これは、エージェントをツールとしてモデリングすることで実現できます。

from agents import Agent, Runner
import asyncio

spanish_agent = Agent(
    name="Spanish agent",
    instructions="You translate the user's message to Spanish",
)

french_agent = Agent(
    name="French agent",
    instructions="You translate the user's message to French",
)

orchestrator_agent = Agent(
    name="orchestrator_agent",
    instructions=(
        "You are a translation agent. You use the tools given to you to translate."
        "If asked for multiple translations, you call the relevant tools."
    ),
    tools=[
        spanish_agent.as_tool(
            tool_name="translate_to_spanish",
            tool_description="Translate the user's message to Spanish",
        ),
        french_agent.as_tool(
            tool_name="translate_to_french",
            tool_description="Translate the user's message to French",
        ),
    ],
)

async def main():
    result = await Runner.run(orchestrator_agent, input="Say 'Hello, how are you?' in Spanish.")
    print(result.final_output)

ツールエージェントのカスタマイズ

agent.as_tool 関数は、エージェントをツール化しやすくするための便利メソッドです。max_turns、run_config、hooks、previous_response_id、conversation_id、session、needs_approval など一般的なランタイムオプションをサポートします。また、parameters、input_builder、include_input_schema による構造化入力にも対応します。高度なオーケストレーション ( 例: 条件付きリトライ、フォールバック動作、複数エージェント呼び出しの連結 ) には、ツール実装内で Runner.run を直接使ってください。

@function_tool
async def run_my_agent() -> str:
    """A tool that runs the agent with custom configs"""

    agent = Agent(name="My agent", instructions="...")

    result = await Runner.run(
        agent,
        input="...",
        max_turns=5,
        run_config=...
    )

    return str(result.final_output)

ツールエージェント向け構造化入力

デフォルトでは Agent.as_tool() は単一文字列入力 ( {"input": "..."} ) を期待しますが、parameters ( Pydantic モデルまたは dataclass 型 ) を渡すことで構造化スキーマを公開できます。

追加オプション:

include_input_schema=True は、生成されるネスト入力に完全な JSON Schema を含めます。
input_builder=... は、構造化ツール引数をネストされたエージェント入力に変換する方法を完全にカスタマイズできます。
RunContextWrapper.tool_input には、ネスト run コンテキスト内で解析済みの構造化ペイロードが含まれます。

from pydantic import BaseModel, Field


class TranslationInput(BaseModel):
    text: str = Field(description="Text to translate.")
    source: str = Field(description="Source language.")
    target: str = Field(description="Target language.")


translator_tool = translator_agent.as_tool(
    tool_name="translate_text",
    tool_description="Translate text between languages.",
    parameters=TranslationInput,
    include_input_schema=True,
)

完全に実行可能な例は examples/agent_patterns/agents_as_tools_structured.py を参照してください。

ツールエージェントの承認ゲート

Agent.as_tool(..., needs_approval=...) は function_tool と同じ承認フローを使用します。承認が必要な場合、run は一時停止し、保留項目が result.interruptions に表示されます。次に result.to_state() を使い、state.approve(...) または state.reject(...) の呼び出し後に再開します。完全な一時停止 / 再開パターンは Human-in-the-loop ガイドを参照してください。

カスタム出力抽出

特定のケースでは、中央エージェントへ返す前にツールエージェントの出力を変更したいことがあります。これは次のような場合に有用です。

サブエージェントのチャット履歴から特定情報 ( 例: JSON ペイロード ) を抽出する。
エージェントの最終回答を変換 / 再整形する ( 例: Markdown をプレーンテキストや CSV に変換 )。
エージェント応答が欠落 / 不正形式の場合に、出力を検証する、またはフォールバック値を提供する。

これは as_tool メソッドに custom_output_extractor 引数を指定することで実現できます。

async def extract_json_payload(run_result: RunResult) -> str:
    # Scan the agent’s outputs in reverse order until we find a JSON-like message from a tool call.
    for item in reversed(run_result.new_items):
        if isinstance(item, ToolCallOutputItem) and item.output.strip().startswith("{"):
            return item.output.strip()
    # Fallback to an empty JSON object if nothing was found
    return "{}"


json_tool = data_agent.as_tool(
    tool_name="get_data_json",
    tool_description="Run the data agent and return only its JSON payload",
    custom_output_extractor=extract_json_payload,
)

ネストされたエージェント run のストリーミング

as_tool に on_stream コールバックを渡すと、ネストされたエージェントから送出されるストリーミングイベントを監視しつつ、ストリーム完了後に最終出力を返せます。

from agents import AgentToolStreamEvent


async def handle_stream(event: AgentToolStreamEvent) -> None:
    # Inspect the underlying StreamEvent along with agent metadata.
    print(f"[stream] {event['agent'].name} :: {event['event'].type}")


billing_agent_tool = billing_agent.as_tool(
    tool_name="billing_helper",
    tool_description="Answer billing questions.",
    on_stream=handle_stream,  # Can be sync or async.
)

期待される動作:

イベント型は StreamEvent["type"] を反映します: raw_response_event、run_item_stream_event、agent_updated_stream_event。
on_stream を指定すると、ネストエージェントは自動でストリーミングモードで実行され、最終出力を返す前にストリームを消費します。
ハンドラーは同期 / 非同期のどちらでもよく、各イベントは到着順に配信されます。
tool_call はモデルツール呼び出し経由で実行された場合に存在し、直接呼び出しでは None の場合があります。
完全な実行可能サンプルは examples/agent_patterns/agents_as_tools_streaming.py を参照してください。

条件付きツール有効化

is_enabled パラメーターを使うと、ランタイムでエージェントツールを条件付きで有効 / 無効にできます。これにより、コンテキスト、ユーザー設定、またはランタイム条件に基づいて、LLM で利用可能なツールを動的にフィルタリングできます。

import asyncio
from agents import Agent, AgentBase, Runner, RunContextWrapper
from pydantic import BaseModel

class LanguageContext(BaseModel):
    language_preference: str = "french_spanish"

def french_enabled(ctx: RunContextWrapper[LanguageContext], agent: AgentBase) -> bool:
    """Enable French for French+Spanish preference."""
    return ctx.context.language_preference == "french_spanish"

# Create specialized agents
spanish_agent = Agent(
    name="spanish_agent",
    instructions="You respond in Spanish. Always reply to the user's question in Spanish.",
)

french_agent = Agent(
    name="french_agent",
    instructions="You respond in French. Always reply to the user's question in French.",
)

# Create orchestrator with conditional tools
orchestrator = Agent(
    name="orchestrator",
    instructions=(
        "You are a multilingual assistant. You use the tools given to you to respond to users. "
        "You must call ALL available tools to provide responses in different languages. "
        "You never respond in languages yourself, you always use the provided tools."
    ),
    tools=[
        spanish_agent.as_tool(
            tool_name="respond_spanish",
            tool_description="Respond to the user's question in Spanish",
            is_enabled=True,  # Always enabled
        ),
        french_agent.as_tool(
            tool_name="respond_french",
            tool_description="Respond to the user's question in French",
            is_enabled=french_enabled,
        ),
    ],
)

async def main():
    context = RunContextWrapper(LanguageContext(language_preference="french_spanish"))
    result = await Runner.run(orchestrator, "How are you?", context=context.context)
    print(result.final_output)

asyncio.run(main())

is_enabled パラメーターは次を受け付けます。

真偽値: True ( 常に有効 ) または False ( 常に無効 )
呼び出し可能関数: (context, agent) を受け取り真偽値を返す関数
非同期関数: 複雑な条件ロジック向けの async 関数

無効化されたツールはランタイムで LLM から完全に隠されるため、次の用途に有用です。

ユーザー権限に基づく機能ゲート
環境別のツール可用性 ( dev vs prod )
異なるツール設定の A/B テスト
ランタイム状態に基づく動的ツールフィルタリング

実験的機能: Codex ツール

codex_tool は Codex CLI をラップし、エージェントがツール呼び出し中にワークスペーススコープのタスク ( shell、ファイル編集、MCP ツール ) を実行できるようにします。この機能は実験的であり、変更される可能性があります。

現在の run を離れずに、メインエージェントが境界のあるワークスペースタスクを Codex に委任したい場合に使用します。デフォルトのツール名は codex です。カスタム名を設定する場合は、codex または codex_ で始まる必要があります。エージェントに複数の Codex ツールを含める場合は、それぞれ一意の名前にする必要があります。

from agents import Agent
from agents.extensions.experimental.codex import ThreadOptions, TurnOptions, codex_tool

agent = Agent(
    name="Codex Agent",
    instructions="Use the codex tool to inspect the workspace and answer the question.",
    tools=[
        codex_tool(
            sandbox_mode="workspace-write",
            working_directory="/path/to/repo",
            default_thread_options=ThreadOptions(
                model="gpt-5.2-codex",
                model_reasoning_effort="low",
                network_access_enabled=True,
                web_search_mode="disabled",
                approval_policy="never",
            ),
            default_turn_options=TurnOptions(
                idle_timeout_seconds=60,
            ),
            persist_session=True,
        )
    ],
)

まず次のオプショングループから始めてください。

実行サーフェス: sandbox_mode と working_directory は Codex が操作できる場所を定義します。これらは組み合わせて設定し、作業ディレクトリが Git リポジトリ内にない場合は skip_git_repo_check=True を設定します。
スレッド既定値: default_thread_options=ThreadOptions(...) は、モデル、推論 effort、承認ポリシー、追加ディレクトリ、ネットワークアクセス、Web 検索モードを設定します。レガシーの web_search_enabled より web_search_mode を優先してください。
ターン既定値: default_turn_options=TurnOptions(...) は、idle_timeout_seconds や任意のキャンセル signal など、ターンごとの動作を設定します。
ツール I/O: ツール呼び出しには最低 1 つの inputs 項目が必要で、{ "type": "text", "text": ... } または { "type": "local_image", "path": ... } を指定します。output_schema を使うと、構造化された Codex 応答を必須にできます。

スレッド再利用と永続化は別々の制御です。

persist_session=True は、同一ツールインスタンスへの繰り返し呼び出しで 1 つの Codex スレッドを再利用します。
use_run_context_thread_id=True は、同じ可変コンテキストオブジェクトを共有する run 間で、run コンテキストにスレッド ID を保存して再利用します。
スレッド ID の優先順位は、呼び出しごとの thread_id、次に ( 有効時 ) run-context thread ID、最後に設定済み thread_id オプションです。
デフォルトの run-context キーは、name="codex" では codex_thread_id、name="codex_<suffix>" では codex_thread_id_<suffix> です。run_context_thread_id_key で上書きできます。

ランタイム設定:

認証: CODEX_API_KEY ( 推奨 ) または OPENAI_API_KEY を設定するか、codex_options={"api_key": "..."} を渡します。
ランタイム: codex_options.base_url は CLI のベース URL を上書きします。
バイナリ解決: CLI パスを固定するには codex_options.codex_path_override ( または CODEX_PATH ) を設定します。それ以外では SDK は PATH から codex を解決し、次に同梱 vendor バイナリへフォールバックします。
環境: codex_options.env はサブプロセス環境を完全に制御します。これを指定した場合、サブプロセスは os.environ を継承しません。
ストリーム制限: codex_options.codex_subprocess_stream_limit_bytes ( または OPENAI_AGENTS_CODEX_SUBPROCESS_STREAM_LIMIT_BYTES ) は stdout / stderr リーダー制限を制御します。有効範囲は 65536 〜 67108864、デフォルトは 8388608 です。
ストリーミング: on_stream は、スレッド / ターンのライフサイクルイベントと項目イベント ( reasoning、command_execution、mcp_tool_call、file_change、web_search、todo_list、error の項目更新 ) を受け取ります。
出力: 結果には response、usage、thread_id が含まれます。usage は RunContextWrapper.usage に追加されます。

参照:

Codex tool API リファレンス
ThreadOptions リファレンス
TurnOptions リファレンス
完全に実行可能なサンプルは examples/tools/codex.py と examples/tools/codex_same_thread.py を参照してください。