set_output: include optional data field to appease openai

Author: jahooma

common/src/tools/params/tool/set-output.ts

@@ -7,13 +7,17 @@ import type { $ToolParams } from '../../constants'
 const toolName = 'set_output'
 const endsAgentStep = false
 const inputSchema = z
-  .looseObject({})
+  .looseObject({
+    data: z.record(z.string(), z.any()).optional(),
+  })
   .describe(
     'JSON object to set as the agent output. This completely replaces any previous output. If the agent was spawned, this value will be passed back to its parent. If the agent has an outputSchema defined, the output will be validated against it.',
   )
 const description = `
 Subagents must use this tool as it is the only way to report any findings. Nothing else you write will be visible to the user/parent agent.
 
+Note that the output schema is provided dynamically in a user prompt further down in the conversation. Be sure to follow what the latest output schema is when using this tool.
+
 Please set the output with all the information and analysis you want to pass on. If you just want to send a simple message, use an object with the key "message" and value of the message you want to send.
 Example:
 ${$getNativeToolCallExampleString({

packages/agent-runtime/src/tools/handlers/tool/set-output.ts

@@ -28,6 +28,7 @@ export const handleSetOutput = (async (params: {
 }): Promise<{ output: CodebuffToolOutput<ToolName> }> => {
   const { previousToolCallFinished, toolCall, agentState, logger } = params
   const output = toolCall.input
+  let { data } = output ?? {}
 
   await previousToolCallFinished
 
@@ -42,23 +43,29 @@ export const handleSetOutput = (async (params: {
   if (agentTemplate?.outputSchema) {
     try {
       agentTemplate.outputSchema.parse(output)
+      data = output
     } catch (error) {
-      const errorMessage = `Output validation error: Output failed to match the output schema and was ignored. You might want to try again! Issues: ${error}`
-      logger.error(
-        {
-          output,
-          agentType: agentState.agentType,
-          agentId: agentState.agentId,
-          error,
-        },
-        'set_output validation error',
-      )
-      return { output: jsonToolResult({ message: errorMessage }) }
+      try {
+        // Fallback to the 'data' field if the whole output object is not valid
+        agentTemplate.outputSchema.parse(data)
+      } catch (error2) {
+        const errorMessage = `Output validation error: Output failed to match the output schema and was ignored. You might want to try again! Issues: ${error}`
+        logger.error(
+          {
+            output,
+            agentType: agentState.agentType,
+            agentId: agentState.agentId,
+            error,
+          },
+          'set_output validation error',
+        )
+        return { output: jsonToolResult({ message: errorMessage }) }
+      }
     }
   }
 
   // Set the output (completely replaces previous output)
-  agentState.output = output
+  agentState.output = data
 
   return { output: jsonToolResult({ message: 'Output set' }) }
 }) satisfies CodebuffToolHandlerFunction<ToolName>