feat: Fix #412 add optional details data to function tool execution (#413)

Author: seratch

.changeset/easy-rivers-build.md

@@ -0,0 +1,6 @@
+---
+'@openai/agents-realtime': patch
+'@openai/agents-core': patch
+---
+
+feat: Fix #412 add optional details data to function tool execution

packages/agents-core/src/runImplementation.ts

@@ -741,6 +741,7 @@ export async function executeFunctionToolCalls<TContext = UnknownContext>(
           const result = await toolRun.tool.invoke(
             state._context,
             toolRun.toolCall.arguments,
+            { toolCall: toolRun.toolCall },
           );
           // Use string data for tracing and event emitter
           const stringResult = toSmartString(result);

packages/agents-core/src/tool.ts

@@ -17,6 +17,7 @@ import { getCurrentSpan } from './tracing';
 import { RunToolApprovalItem, RunToolCallOutputItem } from './items';
 import { toSmartString } from './utils/smartString';
 import * as ProviderData from './types/providerData';
+import * as protocol from './types/protocol';
 
 /**
  * A function that determines if a tool call should be approved.
@@ -67,6 +68,7 @@ export type FunctionTool<
   invoke: (
     runContext: RunContext<Context>,
     input: string,
+    details?: { toolCall: protocol.FunctionCallItem },
   ) => Promise<string | Result>;
 
   /**
@@ -411,6 +413,7 @@ type ToolExecuteFunction<
 > = (
   input: ToolExecuteArgument<TParameters>,
   context?: RunContext<Context>,
+  details?: { toolCall: protocol.FunctionCallItem },
 ) => Promise<unknown> | unknown;
 
 /**
@@ -591,6 +594,7 @@ export function tool<
   async function _invoke(
     runContext: RunContext<Context>,
     input: string,
+    details?: { toolCall: protocol.FunctionCallItem },
   ): Promise<Result> {
     const [error, parsed] = await safeExecute(() => parser(input));
     if (error !== null) {
@@ -608,7 +612,7 @@ export function tool<
       logger.debug(`Invoking tool ${name} with input ${input}`);
     }
 
-    const result = await options.execute(parsed, runContext);
+    const result = await options.execute(parsed, runContext, details);
     const stringResult = toSmartString(result);
 
     if (logger.dontLogToolData) {
@@ -623,8 +627,9 @@ export function tool<
   async function invoke(
     runContext: RunContext<Context>,
     input: string,
+    details?: { toolCall: protocol.FunctionCallItem },
   ): Promise<string | Result> {
-    return _invoke(runContext, input).catch<string>((error) => {
+    return _invoke(runContext, input, details).catch<string>((error) => {
       if (toolErrorFunction) {
         const currentSpan = getCurrentSpan();
         currentSpan?.setError({

packages/agents-realtime/src/realtimeSession.ts

@@ -486,7 +486,9 @@ export class RealtimeSession<
     });
 
     this.#context.context.history = JSON.parse(JSON.stringify(this.#history)); // deep copy of the history
-    const result = await tool.invoke(this.#context, toolCall.arguments);
+    const result = await tool.invoke(this.#context, toolCall.arguments, {
+      toolCall,
+    });
     let stringResult: string;
     if (isBackgroundResult(result)) {
       // Don't generate a new response, just send the result