工具

工具让智能体能够执行操作——获取数据、调用外部 API、执行代码，甚至操作计算机。JavaScript/TypeScript SDK 支持七个类别：

确定由哪个智能体负责该任务并希望为其赋予能力后，请在阅读智能体后阅读本页。如果您仍在不同委派模式之间进行选择，请参阅智能体编排。

1. OpenAI 托管工具——与模型一起在 OpenAI 服务器上运行。（Web 搜索、文件搜索、Code Interpreter、图像生成、工具搜索）
2. 内置执行工具——由 SDK 提供、在模型外部执行的工具。（计算机操作和 apply_patch 在本地运行；shell 可在本地或托管容器中运行）
3. 函数工具——使用 JSON schema 封装任意本地函数，以便 LLM 调用。
4. Agents as tools——将整个智能体公开为可调用工具。
5. MCP 服务器——连接本地或远程 Model Context Protocol 服务器。
6. 沙盒能力——将工作区范围内的 shell、文件系统、技能、记忆或压缩工具连接到 SandboxAgent。
7. 实验性功能：Codex 工具——将 Codex SDK 封装为函数工具，以运行可感知工作区的任务。

---

工具类别

本指南接下来将先介绍各个工具类别，然后总结跨类别的工具选择和提示指南。

1. 托管工具（OpenAI Responses API）

使用 OpenAIResponsesModel 时，可以添加以下内置工具：

工具	类型字符串	用途
Web 搜索	'web_search'	搜索互联网。
文件/检索搜索	'file_search'	查询托管在 OpenAI 上的向量存储。
Code Interpreter	'code_interpreter'	在沙盒环境中运行代码。
图像生成	'image_generation'	根据文本生成图像。
工具搜索	'tool_search'	在运行时加载延迟函数工具、命名空间或可搜索的 MCP 工具。
程序化工具调用	'programmatic_tool_calling'	运行由模型生成的 JavaScript，以协调符合条件的工具。

托管工具

import {
  Agent,
  codeInterpreterTool,
  fileSearchTool,
  imageGenerationTool,
  webSearchTool,
} from '@openai/agents';

const agent = new Agent({
  name: 'Travel assistant',
  tools: [
    webSearchTool({ searchContextSize: 'medium' }),
    fileSearchTool('VS_ID', { maxNumResults: 3 }),
    codeInterpreterTool(),
    imageGenerationTool({ size: '1024x1024' }),
  ],
});

SDK 提供了用于返回托管工具定义的辅助函数：

辅助函数	说明
webSearchTool(options?)	提供适合 JS 的选项，例如 searchContextSize、userLocation 和 filters.allowedDomains。
fileSearchTool(ids, options?)	第一个参数接受一个或多个向量存储 ID，并支持 maxNumResults、includeSearchResults、rankingOptions 和筛选器等选项。
codeInterpreterTool(options?)	未提供 container 时，默认使用自动管理的容器。
imageGenerationTool(options?)	支持 model、size、quality、background、inputFidelity、inputImageMask、moderation、outputCompression、partialImages 和输出格式等图像生成配置。
toolSearchTool(options?)	添加内置 tool_search 辅助工具。可与设置了 deferLoading: true 的延迟函数工具或托管 MCP 工具配合使用。默认支持托管执行，也支持通过 execution: 'client' 和 execute 进行客户端执行。
programmaticToolCallingTool()	启用程序化工具调用。可与 allowedCallers 包含 'programmatic' 的工具配合使用。

这些辅助函数会将适合 JavaScript/TypeScript 的选项名称映射到底层 OpenAI Responses API 工具负载。有关完整的工具 schema，以及排名选项或语义筛选器等高级选项，请参阅 OpenAI 官方工具指南；有关当前的内置工具搜索流程和模型可用性，请参阅官方工具搜索指南；有关模型支持和传输层行为，请参阅官方程序化工具调用指南。

---

2. 内置执行工具

这些工具内置于 SDK 中，但执行发生在模型响应之外：

• 计算机操作——实现 Computer 接口并将其传递给 computerTool()。它始终基于您提供的本地 Computer 实现运行。
• Shell——提供本地 Shell 实现，或使用 shellTool({ environment }) 配置托管容器环境。
• 应用补丁——实现 Editor 接口并将其传递给 applyPatchTool()。它始终基于您提供的本地 Editor 实现运行。
• 沙盒 shell 和文件系统工具——当操作应在沙盒工作区内运行时，在 SandboxAgent 上使用 shell()、filesystem()、skills()、memory() 或 compaction()。

工具调用仍由模型请求，但工作由您的应用程序或配置的执行环境完成。

沙盒能力工具不同于进程级内置工具：它们绑定到当前 SandboxAgent 运行所使用的实时沙盒会话。如果工具应在智能体的隔离工作区中运行，而不是在您的应用程序进程中运行，请使用快速入门。

内置执行工具

import {
  Agent,
  applyPatchTool,
  computerTool,
  shellTool,
  Computer,
  Editor,
  Shell,
} from '@openai/agents';

const computer: Computer = {
  environment: 'browser',
  dimensions: [1024, 768],
  screenshot: async () => '',
  click: async () => {},
  doubleClick: async () => {},
  scroll: async () => {},
  type: async () => {},
  wait: async () => {},
  move: async () => {},
  keypress: async () => {},
  drag: async () => {},
};

const shell: Shell = {
  run: async () => ({
    output: [
      {
        stdout: '',
        stderr: '',
        outcome: { type: 'exit', exitCode: 0 },
      },
    ],
  }),
};

const editor: Editor = {
  createFile: async () => ({ status: 'completed' }),
  updateFile: async () => ({ status: 'completed' }),
  deleteFile: async () => ({ status: 'completed' }),
};

const agent = new Agent({
  name: 'Local tools agent',
  model: 'gpt-5.4',
  tools: [
    computerTool({ computer }),
    shellTool({ shell, needsApproval: true }),
    applyPatchTool({ editor, needsApproval: true }),
  ],
});

计算机工具细节

computerTool() 接受以下任一项：

• 具体的 Computer 实例。
• 为每次运行创建 Computer 的初始化函数。
• 当您需要运行范围内的设置和清理时，使用包含 { create, dispose } 的提供程序对象。

若要使用 OpenAI 当前的计算机操作路径，请设置支持计算机操作的模型，例如 gpt-5.4。显式指定请求模型时，SDK 会发送 GA 内置 computer 工具格式。如果有效模型仍来自已存储提示或其他较旧的集成，除非您通过 modelSettings.toolChoice: 'computer' 显式选择 GA 路径，否则 SDK 会保留旧版 computer_use_preview 传输格式以确保兼容性。

GA 计算机调用可在一次 computer_call 中包含批量的 actions[]。SDK 会按顺序执行这些操作，针对每个操作评估 needsApproval，并将最终屏幕截图作为工具输出返回。如果您使用 interruption.rawItem 构建审批 UI，请在存在 actions 时读取它，否则针对旧版预览项回退到 action。

当高影响的计算机操作需要暂停以供用户审核时，请使用 needsApproval；如果您希望确认或拒绝为计算机调用报告的待处理安全检查，请使用 onSafetyCheck。有关模型端指南和迁移详情，请参阅 OpenAI 官方计算机操作指南及其迁移说明。

Shell 工具细节

shellTool() 有两种模式：

• 本地模式：提供 shell，还可提供 environment: { type: 'local', skills }，并通过 needsApproval 和 onApproval 自动处理审批。
• 托管容器模式：提供 environment，并将 type 设置为 'container_auto' 或 'container_reference'。

在本地模式下，environment.skills 允许您根据 name、description 和文件系统 path 挂载本地技能。

在托管容器模式下，使用以下任一方式配置 shellTool({ environment })：

• 使用 type: 'container_auto' 为本次运行创建托管容器。
• 使用 type: 'container_reference'，通过 containerId 复用现有容器。

托管的 container_auto 环境支持：

• networkPolicy，包括带有 domainSecrets 的允许列表。
• 用于挂载已上传文件的 fileIds。
• 用于设置容器大小的 memoryLimit。
• skills，可使用 skill_reference 或内联 zip 包。

托管 shell 环境不接受 shell、needsApproval 或 onApproval，因为执行发生在托管容器环境中，而不是本地进程中。

有关完整用法，请参阅 examples/tools/local-shell.ts、examples/tools/container-shell-skill-ref.ts 和 examples/tools/container-shell-inline-skill.ts。

应用补丁工具细节

applyPatchTool() 与 shellTool() 的本地审批流程一致：使用 needsApproval 在编辑文件前暂停；如果您希望通过应用层回调自动批准或拒绝，请使用 onApproval。

---

3. 函数工具

您可以使用 tool() 辅助函数将任意函数转换为工具。

使用 Zod 参数的函数工具

import { tool } from '@openai/agents';
import { z } from 'zod';

const getWeatherTool = tool({
  name: 'get_weather',
  description: 'Get the weather for a given city',
  parameters: z.object({ city: z.string() }),
  async execute({ city }) {
    return `The weather in ${city} is sunny.`;
  },
});

选项参考

字段	必需	说明
name	否	默认为函数名称（例如 get_weather）。
description	是	向 LLM 展示的清晰、易读的说明。
parameters	是	Zod schema 或原始 JSON schema 对象。Zod 参数会自动启用严格模式。
strict	否	为 true（默认值）时，如果参数未通过验证，SDK 将返回模型错误。设置为 false 可启用模糊匹配。
execute	是	(args, context, details) => string | unknown | Promise<...>——您的业务逻辑。非字符串输出会为模型进行序列化。context 是可选的 RunContext；details 包含 toolCall、resumeState 和 signal 等元数据。
allowedCallers	否	仅适用于 Responses 的非空列表，用于控制工具可直接调用、以程序化方式调用，还是同时支持两者。可使用 'direct'、'programmatic' 或同时使用这两个值。
outputSchema	否	仅适用于 Responses 的工具结果 schema。Zod schema 会约束 execute 返回类型，并验证和转换运行时结果；原始 JSON schema 仅描述传输契约。
errorFunction	否	自定义处理程序 (context, error, details) => result，用于将内部错误转换为模型可见的结果。设置 outputSchema 时，结果必须符合该 schema。默认处理程序已禁用，因此会重新抛出原始错误。
timeoutMs	否	每次调用的超时时间，以毫秒为单位。必须大于 0 且小于或等于 2147483647。
timeoutBehavior	否	超时模式：error_as_result 返回模型可见的结果，raise_exception 抛出 ToolTimeoutError。未设置 outputSchema 时默认为 error_as_result，设置后默认为 raise_exception。
timeoutErrorFunction	否	用于 error_as_result 的自定义处理程序 (context, timeoutError, details) => result。设置 outputSchema 时，此处理程序为必需项，且结果必须符合该 schema。
customDataExtractor	否	回调 (context) => Record<string, unknown> | null | undefined，用于将仅供 SDK 使用的元数据附加到生成的 RunToolCallOutputItem.customData。这些数据不会发回模型。
needsApproval	否	执行前要求人工审批。请参阅人机协作。
isEnabled	否	按运行条件公开工具；接受布尔值或谓词。
inputGuardrails	否	在工具执行前运行的护栏；可拒绝或抛出错误。请参阅护栏。
outputGuardrails	否	在工具执行后运行的护栏；可拒绝或抛出错误。请参阅护栏。

SDK 专用自定义数据

当您的应用程序需要在工具结果旁附加渲染提示、内部 ID 或其他与 JSON 兼容的元数据时，请使用 customDataExtractor。该回调接收运行上下文、工具定义、模型工具调用、已解析输入、输出和克隆的原始输出项。返回的数据存储在 RunToolCallOutputItem.customData 和 RunState 中，但不会包含在 history 和模型重放中。

函数工具超时

使用 timeoutMs 限制每次函数工具调用的时间。

• timeoutBehavior: 'error_as_result' 向模型返回 Tool '<name>' timed out after <timeoutMs>ms.。未设置 outputSchema 时，这是默认行为。
• timeoutBehavior: 'raise_exception' 抛出 ToolTimeoutError，您可以将其作为运行异常的一部分捕获。
• timeoutErrorFunction 允许您在 error_as_result 模式下自定义超时文本。
• 设置 outputSchema 后，默认行为会变为 raise_exception。若要使用 error_as_result，必须提供返回值与 schema 兼容的 timeoutErrorFunction。
• 超时会中止 details.signal，因此监听取消信号的长时间运行工具可以及时停止。

如果直接调用函数工具，请使用 invokeFunctionTool，以实施与智能体正常运行相同的超时行为。

非严格 JSON schema 工具

如果需要模型猜测无效或不完整的输入，可以在使用原始 JSON schema 时禁用严格模式：

非严格 JSON schema 工具

import { tool } from '@openai/agents';

interface LooseToolInput {
  text: string;
}

const looseTool = tool({
  description: 'Echo input; be forgiving about typos',
  strict: false,
  parameters: {
    type: 'object',
    properties: { text: { type: 'string' } },
    required: ['text'],
    additionalProperties: true,
  },
  execute: async (input) => {
    // because strict is false we need to do our own verification
    if (typeof input !== 'object' || input === null || !('text' in input)) {
      return 'Invalid input. Please try again';
    }
    return (input as LooseToolInput).text;
  },
});

借助工具搜索的延迟工具加载

工具搜索允许模型在运行时仅加载所需的工具定义，而不必预先发送所有 schema。在 SDK 中，这是使用延迟顶层函数工具、toolNamespace() 组以及配置了 deferLoading: true 的托管 MCP 工具的方式。

工具搜索仅适用于 GPT-5.4 以及在 Responses API 中支持该功能的较新模型版本。

借助工具搜索延迟加载工具

import { Agent, tool, toolNamespace, toolSearchTool } from '@openai/agents';
import { z } from 'zod';

const customerIdParams = z.object({
  customerId: z.string().describe('The customer identifier to look up.'),
});

// Keep a standalone deferred tool at the top level when it represents a
// single searchable capability that does not need a shared namespace.
const shippingLookup = tool({
  name: 'get_shipping_eta',
  description: 'Look up a shipment ETA by customer identifier.',
  parameters: customerIdParams,
  deferLoading: true,
  async execute({ customerId }) {
    return {
      customerId,
      eta: '2026-03-07',
      carrier: 'Priority Express',
    };
  },
});

// Group related tools into a namespace when one domain description should
// cover several deferred tools and let tool search load them together.
const crmTools = toolNamespace({
  name: 'crm',
  description: 'CRM tools for customer profile lookups.',
  tools: [
    tool({
      name: 'get_customer_profile',
      description: 'Fetch a basic customer profile.',
      parameters: customerIdParams,
      deferLoading: true,
      async execute({ customerId }) {
        return {
          customerId,
          tier: 'enterprise',
        };
      },
    }),
  ],
});

const agent = new Agent({
  name: 'Operations assistant',
  model: 'gpt-5.4',
  // Mixing namespaced and top-level deferred tools in one request is supported.
  tools: [shippingLookup, ...crmTools, toolSearchTool()],
});

该示例有意混合使用了两种风格：

• shippingLookup 保持在顶层，因为它是一个独立的可搜索能力。
• crmTools 使用 toolNamespace()，因为相关 CRM 工具共享一个高级标签和说明。
• 同一请求支持混用命名空间化和顶层延迟工具；工具搜索可以同时加载 crm 等命名空间路径和 get_shipping_eta 等顶层路径。

使用工具搜索时：

• 使用 deferLoading: true 标记每个延迟函数工具。
• 当多个相关工具应共享一个领域说明并作为一组加载时，请使用 toolNamespace({ name, description, tools })。
• 如果工具是单个独立能力，并且工具名称本身就是良好的搜索目标，请将其保留在顶层。
• 任何延迟函数工具或托管 MCP 工具使用 deferLoading: true 时，都要将 toolSearchTool() 添加到同一个 tools 数组。
• 将 modelSettings.toolChoice 保持为 'auto'。SDK 不允许按名称强制使用内置 tool_search 工具或延迟函数工具。
• 默认使用托管执行。如果设置 toolSearchTool({ execution: 'client', execute })，标准 run() 循环仅支持内置的 { paths: string[] } 客户端查询格式；自定义客户端 schema 需要使用您自己的 Responses 循环。
• 一个命名空间可以混合使用即时成员和延迟成员。即时成员无需工具搜索即可调用，而同一命名空间中的延迟成员则按需加载。
• 延迟函数工具和 toolNamespace() 仅适用于 Responses。Chat Completions 会拒绝它们，AI SDK 适配器也不支持延迟 Responses 工具加载流程。

---

4. Agents as tools

有时，您希望一个智能体协助另一个智能体，而不是完全交接对话。请使用 agent.asTool()：

如果您仍在 agent.asTool() 和 handoff() 之间进行选择，请在智能体和智能体编排中比较这些模式。

Agents as tools

import { Agent } from '@openai/agents';

const summarizer = new Agent({
  name: 'Summarizer',
  instructions: 'Generate a concise summary of the supplied text.',
});

const summarizerTool = summarizer.asTool({
  toolName: 'summarize_text',
  toolDescription: 'Generate a concise summary of the supplied text.',
});

const mainAgent = new Agent({
  name: 'Research assistant',
  tools: [summarizerTool],
});

SDK 在底层会：

• 创建一个仅包含单个 input 参数的函数工具。
• 调用工具时，使用该输入运行子智能体。
• 返回最后一条消息，或返回由 customOutputExtractor 提取的输出。

当您将智能体作为工具运行时，Agents SDK 会使用默认设置创建运行器，并在函数执行过程中用该运行器运行智能体。如果希望提供任何 runConfig 或 runOptions 属性，可以将它们传递给 asTool() 方法，以自定义运行器的行为。

您还可以通过 asTool() 选项为智能体工具设置 needsApproval 和 isEnabled，从而与人机协作流程和条件式工具可用性集成。

在 customOutputExtractor 中，使用 result.agentToolInvocation 检查当前的 Agent.asTool() 调用。在该回调中，结果始终来自 Agent.asTool()，因此 agentToolInvocation 始终有定义，并公开 toolName、toolCallId 和 toolArguments。使用 result.runContext 获取常规应用上下文和 toolInput。此元数据仅限当前嵌套调用，不会序列化到 RunState 中。

读取智能体工具调用元数据

import { Agent } from '@openai/agents';

const billingAgent = new Agent({
  name: 'Billing Agent',
  instructions: 'Handle billing questions and subscription changes.',
});

const billingTool = billingAgent.asTool({
  toolName: 'billing_agent',
  toolDescription: 'Handles customer billing questions.',
  customOutputExtractor(result) {
    console.log('tool', result.agentToolInvocation.toolName);
    // Direct invoke() calls may not have a model-generated tool call id.
    console.log('call', result.agentToolInvocation.toolCallId);
    console.log('args', result.agentToolInvocation.toolArguments);

    return String(result.finalOutput ?? '');
  },
});

const orchestrator = new Agent({
  name: 'Support Orchestrator',
  instructions: 'Delegate billing questions to the billing agent tool.',
  tools: [billingTool],
});

agent.asTool() 的高级结构化输入选项：

• inputBuilder：将结构化工具参数映射到嵌套智能体输入负载。
• includeInputSchema：在嵌套运行中包含输入 JSON schema，以增强 schema 感知行为。
• resumeState：恢复嵌套的序列化 RunState 时，控制上下文协调策略：'merge'（默认）将实时审批/上下文状态合并到序列化状态中；'replace' 改为使用当前运行上下文；'preferSerialized' 则使用未更改的序列化上下文恢复。

智能体工具的流式事件

智能体工具可以将所有嵌套运行事件以流式方式传回您的应用程序。请选择适合工具构建方式的钩子风格：

智能体工具的流式传输

import { Agent } from '@openai/agents';

const billingAgent = new Agent({
  name: 'Billing Agent',
  instructions: 'Answer billing questions and compute simple charges.',
});

const billingTool = billingAgent.asTool({
  toolName: 'billing_agent',
  toolDescription: 'Handles customer billing questions.',
  // onStream: simplest catch-all when you define the tool inline.
  onStream: (event) => {
    console.log(`[onStream] ${event.event.type}`, event);
  },
});

// on(eventName) lets you subscribe selectively (or use '*' for all).
billingTool.on('run_item_stream_event', (event) => {
  console.log('[on run_item_stream_event]', event);
});
billingTool.on('raw_model_stream_event', (event) => {
  console.log('[on raw_model_stream_event]', event);
});

const orchestrator = new Agent({
  name: 'Support Orchestrator',
  instructions: 'Delegate billing questions to the billing agent tool.',
  tools: [billingTool],
});

• 事件类型与 RunStreamEvent['type'] 匹配：raw_model_stream_event、run_item_stream_event、agent_updated_stream_event。
• onStream 是最简单的”全捕获”方式，适合以内联方式声明工具的情况（tools: [agent.asTool({ onStream })]）。如果不需要按事件路由，请使用它。
• on(eventName, handler) 允许您进行选择性订阅（或使用 '*'），最适合需要更细粒度的处理或希望在创建后附加监听器的情况。
• 如果提供 onStream 或任何 on(...) 处理程序，作为工具的智能体会自动以流式模式运行；如果均未提供，则保持非流式路径。
• 处理程序会并行调用，因此缓慢的 onStream 回调不会阻塞 on(...) 处理程序，反之亦然。
• 通过模型工具调用来调用工具时，会提供 toolCallId；直接 invoke() 调用或提供商的特殊行为可能会省略它。

---

5. MCP 服务器

您可以通过 Model Context Protocol（MCP）服务器公开工具，并将其连接到智能体。例如，可以使用 MCPServerStdio 启动并连接到 stdio MCP 服务器：

本地 MCP 服务器

import { Agent, MCPServerStdio } from '@openai/agents';

const server = new MCPServerStdio({
  fullCommand: 'pnpm exec mcp-server-filesystem ./sample_files',
});

await server.connect();

const agent = new Agent({
  name: 'Assistant',
  mcpServers: [server],
});

有关完整示例，请参阅 filesystem-example.ts。此外，如果您正在寻找有关 MCP 服务器工具集成的综合指南，请参阅 MCP 集成了解详情。管理多个服务器（或部分故障）时，请使用 connectMcpServers，并遵循 MCP 集成中的生命周期指南。

---

6. 实验性功能：Codex 工具

@openai/agents-extensions/experimental/codex 提供 codexTool()，这是一个将模型工具调用路由到 Codex SDK 的函数工具，使智能体能够自主运行工作区范围内的任务（shell、文件编辑、MCP 工具）。此接口为实验性功能，可能会发生变化。

请先安装依赖项：

npm install @openai/agents-extensions @openai/codex-sdk

快速开始：

实验性 Codex 工具

import { Agent } from '@openai/agents';
import { codexTool } from '@openai/agents-extensions/experimental/codex';

export const codexAgent = new Agent({
  name: 'Codex Agent',
  instructions:
    'Use the codex tool to inspect the workspace and answer the question. When skill names, which usually start with `$`, are mentioned, you must rely on the codex tool to use the skill and answer the question.',
  tools: [
    codexTool({
      sandboxMode: 'workspace-write',
      workingDirectory: '/path/to/repo',
      defaultThreadOptions: {
        model: 'gpt-5.4',
        networkAccessEnabled: true,
        webSearchEnabled: false,
      },
    }),
  ],
});

注意事项：

• 身份验证：提供 CODEX_API_KEY（首选）或 OPENAI_API_KEY，也可以传递 codexOptions.apiKey。
• 输入：严格 schema——inputs 必须至少包含一个 { type: 'text', text } 或 { type: 'local_image', path }。
• 安全性：将 sandboxMode 与 workingDirectory 配合使用；如果目录不是 Git 仓库，请设置 skipGitRepoCheck。
• 线程：useRunContextThreadId: true 会在 runContext.context 中读取/存储最新的线程 ID，这有助于在应用状态中跨轮次复用线程。
• 线程 ID 优先级：工具调用的 threadId（如果 schema 中包含）优先级最高，其次是运行上下文线程 ID，最后是 codexTool({ threadId })。
• 运行上下文键：当 name: 'codex' 时，默认为 codexThreadId；对于 name: 'engineer' 等名称，则默认为 codexThreadId_<suffix>（规范化后为 codex_engineer）。
• 可变上下文要求：启用 useRunContextThreadId 时，请将可变对象或 Map 作为 run(..., { context }) 传递。
• 命名：工具名称会规范化到 codex 命名空间中（engineer 会变为 codex_engineer），同一智能体中不允许出现重复的 Codex 工具名称。
• 流式传输：onStream 会映射 Codex 事件（推理、命令执行、MCP 工具调用、文件更改、Web 搜索），以便您记录日志或追踪进度。
• 输出：工具结果包含 response、usage 和 threadId，Codex token 用量也会记录在 RunContext 中。
• 结构：outputSchema 可以是描述符、JSON schema 对象或 Zod 对象。对于 JSON 对象 schema，additionalProperties 必须为 false。

运行上下文线程复用示例：

Codex 运行上下文线程复用

import { Agent, run } from '@openai/agents';
import { codexTool } from '@openai/agents-extensions/experimental/codex';

// Derived from codexTool({ name: 'engineer' }) when runContextThreadIdKey is omitted.
type ExampleContext = {
  codexThreadId_engineer?: string;
};

const agent = new Agent<ExampleContext>({
  name: 'Codex assistant',
  instructions: 'Use the codex tool for workspace tasks.',
  tools: [
    codexTool({
      // `name` is optional for a single Codex tool.
      // We set it so the run-context key is tool-specific and to avoid collisions when adding more Codex tools.
      name: 'engineer',
      // Reuse the same Codex thread across runs that share this context object.
      useRunContextThreadId: true,
      sandboxMode: 'workspace-write',
      workingDirectory: '/path/to/repo',
      defaultThreadOptions: {
        model: 'gpt-5.4',
        approvalPolicy: 'never',
      },
    }),
  ],
});

// The default key for useRunContextThreadId with name=engineer is codexThreadId_engineer.
const context: ExampleContext = {};

// First turn creates (or resumes) a Codex thread and stores the thread ID in context.
await run(agent, 'Inspect src/tool.ts and summarize it.', { context });
// Second turn reuses the same thread because it shares the same context object.
await run(agent, 'Now list refactoring opportunities.', { context });

const threadId = context.codexThreadId_engineer;

---

程序化工具调用

程序化工具调用允许受支持的 Responses 模型生成 JavaScript，在托管执行环境中协调多次工具调用。您的应用程序仍会执行客户端拥有的工具，因此现有的验证、权限、审批、护栏和副作用仍然适用。

程序化工具调用

import { Agent, programmaticToolCallingTool, tool } from '@openai/agents';
import { z } from 'zod';

const getInventory = tool({
  name: 'get_inventory',
  description: 'Return inventory for a SKU.',
  parameters: z.object({ sku: z.string() }),
  allowedCallers: ['programmatic'],
  outputSchema: z.object({
    sku: z.string(),
    availableUnits: z.number(),
  }),
  async execute({ sku }) {
    return { sku, availableUnits: 42 };
  },
});

const getDemand = tool({
  name: 'get_demand',
  description: 'Return requested units for a SKU.',
  parameters: z.object({ sku: z.string() }),
  allowedCallers: ['programmatic'],
  outputSchema: z.object({
    sku: z.string(),
    requestedUnits: z.number(),
  }),
  async execute({ sku }) {
    return { sku, requestedUnits: 31 };
  },
});

const agent = new Agent({
  name: 'Inventory planner',
  model: 'gpt-5.6',
  instructions: `
Use Programmatic Tool Calling to fetch inventory and demand concurrently.
Return the source values and the calculated shortage in the final answer.
  `.trim(),
  tools: [getInventory, getDemand, programmaticToolCallingTool()],
});

设置分为两部分：

1. 将 programmaticToolCallingTool() 添加到智能体。
2. 为生成的程序可以调用的每个工具设置 allowedCallers。

allowedCallers	行为
省略或 ['direct']	模型可以直接调用工具。
['programmatic']	只有生成的程序可以调用工具。
['direct', 'programmatic']	模型或生成的程序都可以调用工具。

SDK 支持由程序化调用方调用通过 tool() 创建的工具、本地或托管的 shellTool()、applyPatchTool()、hostedMcpTool() 和 codeInterpreterTool()。

SDK 会在发送请求前验证配置。仅支持程序化调用的工具需要 programmaticToolCallingTool()。除非请求包含工具搜索或能够提供符合条件工具的已存储提示，否则该辅助函数还要求至少存在一个符合条件的工具。

当函数工具必须返回结构化数据时，请使用 outputSchema。Zod schema 会约束 execute 返回类型，并验证和转换运行时结果。原始 JSON schema 描述传输契约，但不会添加 SDK 端的结果验证。无效的 Zod 结果会引发 InvalidToolOutputError。

Structured outputs 还会改变失败处理方式：

• 默认 errorFunction 已禁用，因此执行错误会被重新抛出。自定义处理程序必须返回与 outputSchema 兼容的值。
• 默认超时行为变为 'raise_exception'。
• 若要使用 'error_as_result'，请提供返回值符合 outputSchema 的 timeoutErrorFunction。
• 输出护栏替换的值也必须符合 outputSchema。

程序化工具调用仅适用于 Responses。Chat Completions、实时智能体和 AI SDK 模型适配器会拒绝这些选项。当符合条件的工具被延迟加载时，工具搜索必须先加载它，后续生成的程序才能调用它。

有关完整示例，请参阅 examples/tools/programmatic-tool-calling.ts。

---

工具策略与最佳实践

工具使用行为

有关如何控制模型必须在何时以及以何种方式使用工具（modelSettings.toolChoice、toolUseBehavior 等），请参阅智能体。

---

最佳实践

• 简短、明确的说明——描述工具的作用以及使用时机。
• 输入验证——尽可能使用 Zod schema 进行严格的 JSON 验证。
• 避免在错误处理程序中产生副作用——errorFunction 应返回有帮助的字符串，而不是抛出错误。
• 每个工具只承担一项职责——小型、可组合的工具有助于模型进行更好的推理。

---

相关指南

• 智能体：定义包含工具的智能体并控制 toolUseBehavior。
• 智能体编排：确定何时使用 Agents as tools，何时使用交接。
• 运行智能体：了解执行流程、流式传输和对话状态。
• 模型：了解托管 OpenAI 模型配置和 Responses 传输方式的选择。
• 护栏：验证工具输入或输出。
• 深入了解 tool() 和各种托管工具类型的 TypeDoc 参考文档。