Add safeToRunInBrowser option to Agent constructor

Author: seratch

packages/agents-core/src/agent.ts

@@ -217,6 +217,11 @@ export interface AgentConfiguration<
    * to `true`. This ensures that the agent doesn't enter an infinite loop of tool usage.
    */
   resetToolChoice: boolean;
+
+  /**
+   * Whether the agent is safe to run in a browser environment. Defaults to false.
+   */
+  safeToRunInBrowser?: boolean;
 }
 
 export type AgentOptions<
@@ -314,6 +319,7 @@ export class Agent<
   outputType: TOutput = 'text' as TOutput;
   toolUseBehavior: ToolUseBehavior;
   resetToolChoice: boolean;
+  safeToRunInBrowser: boolean;
 
   constructor(config: AgentOptions<TContext, TOutput>) {
     super();
@@ -335,6 +341,7 @@ export class Agent<
     }
     this.toolUseBehavior = config.toolUseBehavior ?? 'run_llm_again';
     this.resetToolChoice = config.resetToolChoice ?? true;
+    this.safeToRunInBrowser = config.safeToRunInBrowser ?? false;
 
     // --- Runtime warning for handoff output type compatibility ---
     if (
@@ -437,7 +444,7 @@ export class Agent<
         additionalProperties: false,
       },
       strict: true,
-      localAgentAsTool: true,
+      safeToRunInBrowser: this.safeToRunInBrowser,
       execute: async (data, context) => {
         if (!isAgentToolInput(data)) {
           throw new ModelBehaviorError('Agent tool called with invalid input');

packages/agents-core/src/tool.ts

@@ -75,11 +75,9 @@ export type FunctionTool<
   needsApproval: ToolApprovalFunction<TParameters>;
 
   /**
-   * Whether the tool is a local agent. If true, the tool is a different agent that will be called
-   * locally. Note that an agent running on web frontend client side does not work for RealtimeAgent.
-   * If the property is absent, it means false.
+   * Whether the tool is safe to run in a browser. If true, the tool can be called from a browser. Default: false
    */
-  localAgentAsTool?: boolean;
+  safeToRunInBrowser?: boolean;
 };
 
 /**
@@ -335,11 +333,9 @@ type StrictToolOptions<
   needsApproval?: boolean | ToolApprovalFunction<TParameters>;
 
   /**
-   * Whether the tool is a local agent. If true, the tool is a different agent that will be called
-   * locally. Note that an agent running on web frontend client side does not work for RealtimeAgent.
-   * If the property is absent, it means false.
+   * Whether the tool is safe to run in a browser. If true, the tool can be called from a browser. Default: false
    */
-  localAgentAsTool?: boolean;
+  safeToRunInBrowser?: boolean;
 };
 
 /**
@@ -389,11 +385,9 @@ type NonStrictToolOptions<
   needsApproval?: boolean | ToolApprovalFunction<TParameters>;
 
   /**
-   * Whether the tool is a local agent. If true, the tool is a different agent that will be called
-   * locally. Note that an agent running on web frontend client side does not work for RealtimeAgent.
-   * If the property is absent, it means false.
+   * Whether the tool is safe to run in a browser. If true, the tool can be called from a browser. Default: false
    */
-  localAgentAsTool?: boolean;
+  safeToRunInBrowser?: boolean;
 };
 
 /**
@@ -518,6 +512,6 @@ export function tool<
     strict: strictMode,
     invoke,
     needsApproval,
-    localAgentAsTool: options.localAgentAsTool,
+    safeToRunInBrowser: options.safeToRunInBrowser,
   };
 }

packages/agents-realtime/src/realtimeAgent.ts

@@ -76,7 +76,7 @@ export class RealtimeAgent<TContext = UnknownContext> extends Agent<
   constructor(config: RealtimeAgentConfiguration<TContext>) {
     if (isBrowserEnvironment() && config.tools) {
       for (const tool of config.tools) {
-        if (tool.type === 'function' && tool.localAgentAsTool === true) {
+        if (tool.type === 'function' && tool.safeToRunInBrowser !== true) {
           throw new UserError(
             `Local agent as a tool detected: ${tool.name}. Please use a tool that makes requests to your server-side agent logic, rather than converting a locally running client-side agent into a tool.`,
           );

packages/agents-realtime/test/realtimeAgent.test.ts

@@ -3,7 +3,7 @@ import { describe, it, expect, vi } from 'vitest';
 import { RealtimeAgent } from '../src/realtimeAgent';
 import { Agent } from '@openai/agents-core';
 
-const mockResponses = [true, false];
+const mockResponses = [true, true, false];
 vi.mock('@openai/agents-core/_shims', async (importOriginal) => {
   return {
     ...(await importOriginal()),
@@ -32,6 +32,24 @@ describe('RealtimeAgent', () => {
     );
   });
 
+  it('accepts safeToRunInBrowser agents as tools (browser)', async () => {
+    const localToolAgent = new Agent({
+      name: 'local_agent',
+      instructions: 'You are a local agent',
+      safeToRunInBrowser: true,
+    });
+    const realtimeAgent = new RealtimeAgent({
+      name: 'A',
+      tools: [
+        localToolAgent.asTool({
+          toolName: 'local_agent tool',
+          toolDescription: 'You are a local agent',
+        }),
+      ],
+    });
+    expect(realtimeAgent).toBeDefined();
+  });
+
   it('does not detect local agents as tools (server)', () => {
     const localToolAgent = new Agent({
       name: 'local_agent',