Fix tests

Author: jahooma

.agents/agent-template.d.ts

@@ -43,10 +43,11 @@ export interface AgentConfig {
   // Prompts
   // ============================================================================
 
-  /** Prompt for when to spawn this agent as a subagent. Include the main purpose and use cases. */
+  /** Prompt for when to spawn this agent as a subagent. Include the main purpose and use cases.
+   * This field is key if the agent is a subagent and intended to be spawned. */
   parentPrompt?: string
 
-  /** Background information for the agent. Prefer using instructionsPrompt for agent instructions. */
+  /** Background information for the agent. Fairly optional. Prefer using instructionsPrompt for agent instructions. */
   systemPrompt?: string
 
   /** Instructions for the agent.
@@ -55,29 +56,33 @@ export interface AgentConfig {
   instructionsPrompt?: string
 
   /** Prompt inserted at each agent step. Powerful for changing the agent's behavior,
-   * but prefer instructionsPrompt for most instructions. */
+   * but usually not necessary for smart models. Prefer instructionsPrompt for most instructions. */
   stepPrompt: string
 
-  /** Instructions for specific parent agents on when to spawn this agent as a subagent. */
-  parentInstructions?: Record<SubagentName, string>
-
   // ============================================================================
   // Input and Output
   // ============================================================================
 
-  /** The input schema required to spawn the agent. Provide a prompt string and/or a params object. */
+  /** The input schema required to spawn the agent. Provide a prompt string and/or a params object or none.
+   * 80% of the time you want just a prompt string with a description:
+   * inputSchema: {
+   *   prompt: { type: 'string', description: 'A description of what info would be helpful to the agent' }
+   * }
+   */
   inputSchema?: {
     prompt?: { type: 'string'; description?: string }
     params?: JsonSchema
   }
 
-  /** Whether to include conversation history (defaults to true) */
+  /** Whether to include conversation history. Defaults to false.
+   * Use this if the agent needs to know all the previous messages in the conversation.
+   */
   includeMessageHistory?: boolean
 
   /** How the agent should output a response to its parent (defaults to 'last_message')
    * last_message: The last message from the agent, typcically after using tools.
    * all_messages: All messages from the agent, including tool calls and results.
-   * json: Make the agent output a structured JSON object. Can be used with outputSchema or without if you want freeform json output.
+   * json: Make the agent output a JSON object. Can be used with outputSchema or without if you want freeform json output.
    */
   outputMode?: 'last_message' | 'all_messages' | 'json'
 
@@ -97,14 +102,35 @@ export interface AgentConfig {
    *
    * Or use 'return' to end the turn.
    *
-   * Example:
+   * Example 1:
    * function* handleSteps({ agentStep, prompt, params}) {
    *   const { toolResult } = yield {
    *     toolName: 'read_files',
    *     args: { paths: ['file1.txt', 'file2.txt'] }
    *   }
    *   yield 'STEP_ALL'
    * }
+   *
+   * Example 2:
+   * handleSteps: function* ({ agentState, prompt, params }) {
+   *   while (true) {
+   *     yield {
+   *       toolName: 'spawn_agents',
+   *       args: {
+   *         agents: [
+   *         {
+   *           agent_type: 'thinker',
+   *           prompt: 'Think deeply about the user request',
+   *         },
+   *       ],
+   *     },
+   *   }
+   *   const { toolResult: thinkResult } = yield 'STEP'
+   *   if (thinkResult?.toolName === 'end_turn') {
+   *     break
+   *   }
+   * }
+   * }
    */
   handleSteps?: (
     context: AgentStepContext
@@ -148,8 +174,8 @@ export interface ToolResult {
  */
 export interface AgentStepContext {
   agentState: AgentState
-  prompt: string | undefined
-  params: Record<string, any> | undefined
+  prompt?: string
+  params?: Record<string, any>
 }
 
 /**
@@ -257,7 +283,7 @@ export type ModelName =
   | 'google/gemini-2.5-pro'
   | 'google/gemini-2.5-flash'
   | 'x-ai/grok-4-07-09'
-  | string
+  | (string & {})
 
 // ============================================================================
 // Spawnable Agents
@@ -272,7 +298,7 @@ export type SubagentName =
   | 'researcher'
   | 'thinker'
   | 'reviewer'
-  | string
+  | (string & {})
 
 // ============================================================================
 // Utility Types

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

@@ -12,7 +12,6 @@ describe('DynamicAgentConfigSchema', () => {
   const validBaseTemplate = {
     id: 'test_agent',
     version: '1.0.0',
-    override: false,
     displayName: 'Test Agent',
     parentPrompt: 'A test agent',
     model: 'anthropic/claude-4-sonnet-20250522',
@@ -115,25 +114,13 @@ describe('DynamicAgentConfigSchema', () => {
       expect(result.success).toBe(true)
     })
 
-    it('should validate template with path references', () => {
-      const template = {
-        ...validBaseTemplate,
-        systemPrompt: { path: './system-prompt.md' },
-        instructionsPrompt: { path: './user-input-prompt.md' },
-        stepPrompt: { path: './agent-step-prompt.md' },
-      }
-
-      const result = DynamicAgentConfigSchema.safeParse(template)
-      expect(result.success).toBe(true)
-    })
-
     it('should apply default values', () => {
       const result = DynamicAgentConfigSchema.safeParse(validBaseTemplate)
       expect(result.success).toBe(true)
       if (result.success) {
         expect(result.data.outputMode).toBe('last_message')
         expect(result.data.includeMessageHistory).toBe(true)
-        expect(result.data.toolNames).toEqual(['end_turn'])
+        expect(result.data.toolNames).toEqual([])
         expect(result.data.subagents).toEqual([])
       }
     })
@@ -164,16 +151,6 @@ describe('DynamicAgentConfigSchema', () => {
       expect(result.success).toBe(false)
     })
 
-    it('should reject template with override: true', () => {
-      const template = {
-        ...validBaseTemplate,
-        override: true,
-      }
-
-      const result = DynamicAgentConfigSchema.safeParse(template)
-      expect(result.success).toBe(false)
-    })
-
     it('should reject template with invalid outputMode', () => {
       const template = {
         ...validBaseTemplate,
@@ -217,7 +194,7 @@ describe('DynamicAgentConfigSchema', () => {
     it('should reject template with invalid prompt field structure', () => {
       const template = {
         ...validBaseTemplate,
-        systemPrompt: { invalidField: 'value' }, // Should be { path: string }
+        systemPrompt: { invalidField: 'value' }, // Should be string only
       }
 
       const result = DynamicAgentConfigSchema.safeParse(template)

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

@@ -74,15 +74,6 @@ const HandleStepsSchema = z
     })
   )
   .returns(z.any())
-  .refine(
-    (fn) => {
-      // Check if it's a generator function
-      return fn.constructor.name === 'GeneratorFunction'
-    },
-    {
-      message: 'handleSteps must be a generator function',
-    }
-  )
   .optional()
 
 // Validates the Typescript template file.