Add schema validation to require set_output tool if outputMode is json; require spawn_agents tool if subagents array is non-empty

Author: jahooma

common/src/__tests__/agent-validation.test.ts

@@ -760,6 +760,35 @@ describe('Agent Validation', () => {
       }
     })
 
+    test('should reject set_output tool without json output mode', () => {
+      const {
+        DynamicAgentTemplateSchema,
+      } = require('../types/dynamic-agent-template')
+
+      const agentConfig = {
+        id: 'test-agent',
+        version: '1.0.0',
+        displayName: 'Test Agent',
+        parentPrompt: 'Testing',
+        model: 'claude-3-5-sonnet-20241022',
+        outputMode: 'last_message' as const, // Not json
+        toolNames: ['end_turn', 'set_output'], // Has set_output
+        subagents: [],
+        systemPrompt: 'Test',
+        instructionsPrompt: 'Test',
+        stepPrompt: 'Test',
+      }
+
+      const result = DynamicAgentTemplateSchema.safeParse(agentConfig)
+      expect(result.success).toBe(false)
+      if (!result.success) {
+        const errorMessage = result.error.issues[0]?.message || ''
+        expect(errorMessage).toContain(
+          "'set_output' tool requires outputMode to be 'json'",
+        )
+      }
+    })
+
     test('should validate that handleSteps is a generator function', async () => {
       const agentTemplates = {
         'test-agent.ts': {

common/src/__tests__/dynamic-agent-template-schema.test.ts

@@ -281,6 +281,91 @@ describe('DynamicAgentConfigSchema', () => {
       const result = DynamicAgentTemplateSchema.safeParse(template)
       expect(result.success).toBe(true)
     })
+
+    it('should reject template with set_output tool but non-json outputMode', () => {
+      const template = {
+        ...validBaseTemplate,
+        outputMode: 'last_message' as const,
+        toolNames: ['end_turn', 'set_output'], // set_output without json mode
+      }
+
+      const result = DynamicAgentTemplateSchema.safeParse(template)
+      expect(result.success).toBe(false)
+      if (!result.success) {
+        const setOutputError = result.error.issues.find((issue) =>
+          issue.message.includes(
+            "'set_output' tool requires outputMode to be 'json'",
+          ),
+        )
+        expect(setOutputError).toBeDefined()
+        expect(setOutputError?.message).toContain(
+          "'set_output' tool requires outputMode to be 'json'",
+        )
+      }
+    })
+
+    it('should reject template with set_output tool and all_messages outputMode', () => {
+      const template = {
+        ...validBaseTemplate,
+        outputMode: 'all_messages' as const,
+        toolNames: ['end_turn', 'set_output'], // set_output without json mode
+      }
+
+      const result = DynamicAgentTemplateSchema.safeParse(template)
+      expect(result.success).toBe(false)
+      if (!result.success) {
+        const setOutputError = result.error.issues.find((issue) =>
+          issue.message.includes(
+            "'set_output' tool requires outputMode to be 'json'",
+          ),
+        )
+        expect(setOutputError).toBeDefined()
+      }
+    })
+
+    it('should reject template with non-empty subagents but missing spawn_agents tool', () => {
+      const template = {
+        ...validBaseTemplate,
+        subagents: ['researcher', 'file-picker'], // Non-empty subagents
+        toolNames: ['end_turn', 'read_files'], // Missing spawn_agents
+      }
+
+      const result = DynamicAgentTemplateSchema.safeParse(template)
+      expect(result.success).toBe(false)
+      if (!result.success) {
+        const spawnAgentsError = result.error.issues.find((issue) =>
+          issue.message.includes(
+            "Non-empty subagents array requires the 'spawn_agents' tool",
+          ),
+        )
+        expect(spawnAgentsError).toBeDefined()
+        expect(spawnAgentsError?.message).toContain(
+          "Non-empty subagents array requires the 'spawn_agents' tool",
+        )
+      }
+    })
+
+    it('should accept template with non-empty subagents and spawn_agents tool', () => {
+      const template = {
+        ...validBaseTemplate,
+        subagents: ['researcher', 'file-picker'],
+        toolNames: ['end_turn', 'spawn_agents'],
+      }
+
+      const result = DynamicAgentTemplateSchema.safeParse(template)
+      expect(result.success).toBe(true)
+    })
+
+    it('should accept template with empty subagents and no spawn_agents tool', () => {
+      const template = {
+        ...validBaseTemplate,
+        subagents: [], // Empty subagents
+        toolNames: ['end_turn', 'read_files'], // No spawn_agents needed
+      }
+
+      const result = DynamicAgentTemplateSchema.safeParse(template)
+      expect(result.success).toBe(true)
+    })
   })
 
   describe('Edge Cases', () => {

common/src/types/dynamic-agent-template.ts

@@ -179,4 +179,35 @@ export const DynamicAgentTemplateSchema = DynamicAgentConfigSchema.extend({
       path: ['toolNames'],
     },
   )
+  .refine(
+    (data) => {
+      // If 'set_output' tool is included, outputMode must be 'json'
+      if (data.toolNames.includes('set_output') && data.outputMode !== 'json') {
+        return false
+      }
+      return true
+    },
+    {
+      message:
+        "'set_output' tool requires outputMode to be 'json'. Change outputMode to 'json' or remove 'set_output' from toolNames.",
+      path: ['outputMode'],
+    },
+  )
+  .refine(
+    (data) => {
+      // If subagents array is non-empty, 'spawn_agents' tool must be included
+      if (
+        data.subagents.length > 0 &&
+        !data.toolNames.includes('spawn_agents')
+      ) {
+        return false
+      }
+      return true
+    },
+    {
+      message:
+        "Non-empty subagents array requires the 'spawn_agents' tool. Add 'spawn_agents' to toolNames or remove subagents.",
+      path: ['toolNames'],
+    },
+  )
 export type DynamicAgentTemplate = z.infer<typeof DynamicAgentTemplateSchema>