工具

工具让智能体能够采取行动：例如获取数据、运行代码、调用外部 API，甚至使用计算机。SDK 支持五类工具：

• 由OpenAI托管的工具：与模型一起在 OpenAI 服务器上运行。
• 本地运行时工具：在你的环境中运行（计算机操作、shell、apply patch）。
• 工具调用：将任意 Python 函数封装为工具。
• Agents as tools：将智能体暴露为可调用工具，无需完整的任务转移。
• 实验性：Codex 工具：通过一次工具调用运行工作区范围的 Codex 任务。

由OpenAI托管的工具

在使用 OpenAIResponsesModel 时，OpenAI 提供了一些内置工具：

• WebSearchTool 让智能体进行网络检索。
• 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 + skills

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_..."}。

要点如下：

• 托管 shell 可通过 Responses API 的 shell 工具使用。
• container_auto 会为该请求创建容器；container_reference 会复用已有容器。
• container_auto 也可以包含 file_ids 和 memory_limit。
• environment.skills 接受 skill 引用和内联 skill 包。
• 在托管环境下，不要在 ShellTool 上设置 executor、needs_approval 或 on_approval。
• network_policy 支持 disabled 和 allowlist 模式。
• 在 allowlist 模式下，network_policy.domain_secrets 可按名称注入域范围的 secret。
• 完整示例请参见 examples/tools/container_shell_skill_reference.py 和 examples/tools/container_shell_inline_skill.py。
• OpenAI 平台指南：Shell 和 Skills。

本地运行时工具

本地运行时工具在你的环境中执行，并且需要你提供实现：

• ComputerTool：实现 Computer 或 AsyncComputer 接口以启用 GUI/浏览器自动化。
• ShellTool：适用于本地执行与托管容器执行的最新 shell 工具。
• LocalShellTool：遗留的 local-shell 集成。
• ApplyPatchTool：实现 ApplyPatchEditor 以在本地应用 diff。
• 使用 ShellTool(environment={"type": "local", "skills": [...]}) 可启用本地 shell 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（或你可以提供描述）
• 函数输入的 schema 会从函数参数自动创建
• 每个输入的描述取自函数的 docstring，除非禁用

我们使用 Python 的 inspect 模块提取函数签名，并结合 griffe 解析 docstring，同时使用 pydantic 创建 schema。

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()

1. 你可以使用任意 Python 类型作为函数参数，并且函数可以是同步或异步。
2. 如果存在 docstring，会用于捕获描述与参数描述。
3. 函数可选地接受 context（必须是第一个参数）。你也可以设置覆盖项，例如工具名称、描述、使用哪种 docstring 风格等。
4. 你可以将装饰后的函数传入工具列表。

展开以查看输出

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"
}

从工具调用返回图片或文件

除了返回文本输出外，你还可以将一张或多张图片或文件作为工具调用的输出返回。为此，你可以返回以下任意类型：

• 图片：ToolOutputImage（或 TypedDict 版本 ToolOutputImageDict）
• 文件：ToolOutputFileContent（或 TypedDict 版本 ToolOutputFileContentDict）
• 文本：字符串或可字符串化对象，或 ToolOutputText（或 TypedDict 版本 ToolOutputTextDict）

自定义工具调用

有时，你不想把 Python 函数作为工具使用。你也可以直接创建一个 FunctionTool。你需要提供：

• name
• description
• params_json_schema，即参数的 JSON schema
• on_invoke_tool，一个异步函数，它接收 ToolContext 和以 JSON 字符串形式提供的参数，并返回工具输出（例如文本、结构化工具输出对象或输出列表）。

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 解析

如前所述，我们会自动解析函数签名以提取工具的 schema，并解析 docstring 以提取工具及各个参数的描述。补充说明如下：

1. 签名解析通过 inspect 模块完成。我们使用类型注解理解参数类型，并动态构建一个 Pydantic 模型来表示整体 schema。它支持大多数类型，包括 Python 基元类型、Pydantic 模型、TypedDict 等。
2. 我们使用 griffe 解析 docstring。支持的 docstring 格式包括 google、sphinx 和 numpy。我们会尝试自动检测 docstring 格式，但这只是尽力而为；你也可以在调用 function_tool 时显式设置。你还可以将 use_docstring_info 设为 False 来禁用 docstring 解析。

schema 提取的代码位于 agents.function_schema。

使用 Pydantic Field 约束与描述参数

你可以使用 Pydantic 的 Field 为工具参数添加约束（例如数字的最小/最大值、字符串长度或正则模式）以及描述。与 Pydantic 一样，两种形式都支持：基于默认值（arg: int = Field(..., ge=1)）与 Annotated（arg: Annotated[int, Field(..., ge=1)]）。生成的 JSON schema 与校验都会包含这些约束。

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}"

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 类型）来暴露结构化 schema。

其他选项：

• include_input_schema=True 会在生成的嵌套输入中包含完整的 JSON Schema。
• input_builder=... 允许你完全自定义结构化工具参数如何转换为嵌套的智能体输入。
• RunContextWrapper.tool_input 在嵌套运行上下文中包含已解析的结构化载荷。

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 相同的审批流程。如果需要审批，运行会暂停，待处理项会出现在 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,
)

流式传输嵌套智能体运行

向 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) 并返回布尔值的函数
• 异步函数：用于更复杂条件逻辑的异步函数

被禁用的工具在运行时会对 LLM 完全隐藏，因此适用于：

• 基于用户权限的功能开关
• 特定环境下的工具可用性（dev vs prod）
• 针对不同工具配置的 A/B 测试
• 基于运行时状态的动态工具过滤

实验性：Codex 工具

codex_tool 封装了 Codex CLI，使智能体能够在一次工具调用期间运行工作区范围的任务（shell、文件编辑、MCP 工具）。 该接口是实验性的，可能会发生变化。 默认情况下，工具名称为 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,
        )
    ],
)

要点如下：

• 认证：设置 CODEX_API_KEY（推荐）或 OPENAI_API_KEY，或传入 codex_options={"api_key": "..."}。
• 运行时：codex_options.base_url 会覆盖 CLI base URL。
• 二进制解析：设置 codex_options.codex_path_override（或 CODEX_PATH）以固定 CLI 路径。否则 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。
• 输入：工具调用必须在 inputs 中至少包含一项 { "type": "text", "text": ... } 或 { "type": "local_image", "path": ... }。
• Thread 默认值：为 model_reasoning_effort、web_search_mode（优先于遗留的 web_search_enabled）、approval_policy 和 additional_directories 配置 default_thread_options。
• Turn 默认值：为 idle_timeout_seconds 与取消 signal 配置 default_turn_options。
• 安全：将 sandbox_mode 与 working_directory 配对使用；在 Git 仓库之外设置 skip_git_repo_check=True。
• 运行上下文 thread 持久化：use_run_context_thread_id=True 会在运行上下文中存储并复用 thread_id，跨共享该上下文的多次运行生效。这需要可变的运行上下文（例如 dict 或可写对象字段）。
• 运行上下文 key 默认值：对 name="codex"，存储 key 默认为 codex_thread_id；对 name="codex_<suffix>"，默认为 codex_thread_id_<suffix>。设置 run_context_thread_id_key 可覆盖。
• Thread ID 优先级：每次调用的 thread_id 输入优先，其次是运行上下文的 thread_id（若启用），然后是配置的 thread_id 选项。
• 流式传输：on_stream 接收 thread/turn 生命周期事件与条目事件（reasoning、command_execution、mcp_tool_call、file_change、web_search、todo_list 以及 error 条目更新）。
• 输出：结果包括 response、usage 和 thread_id；usage 会添加到 RunContextWrapper.usage。
• 结构：当你需要类型化输出时，output_schema 会强制结构化 Codex 响应。
• 完整可运行示例请参见 examples/tools/codex.py 和 examples/tools/codex_same_thread.py。

工具调用超时

你可以用 @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 并使运行失败。
• 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

超时配置仅支持异步 @function_tool 处理器。

处理工具调用中的错误

当你通过 @function_tool 创建工具调用时，你可以传入 failure_error_function。该函数会在工具调用崩溃时向 LLM 提供错误响应。

• 默认情况下（即你不传任何内容），会运行 default_tool_error_function，告知 LLM 发生了错误。
• 如果你传入自己的错误函数，则会改为运行它，并将响应发送给 LLM。
• 如果你显式传入 None，则任何工具调用错误都会被重新抛出，由你来处理。这可能是 ModelBehaviorError（如果模型生成了无效 JSON）、或 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 函数内处理错误。