fix: added spawnerPrompt to parent instruction

brandonkachen · brandonkachen · commit c78660ddd874 · 2026-01-10T13:51:23.000-08:00
diff --git a/packages/agent-runtime/src/templates/__tests__/strings.test.ts b/packages/agent-runtime/src/templates/__tests__/strings.test.ts
@@ -0,0 +1,295 @@
+import { TEST_AGENT_RUNTIME_IMPL } from '@codebuff/common/testing/impl/agent-runtime'
+import { describe, test, expect, mock } from 'bun:test'
+import { z } from 'zod/v4'
+
+import { getAgentPrompt } from '../strings'
+
+import type { AgentTemplate } from '../types'
+import type { AgentState } from '@codebuff/common/types/session-state'
+import type { ProjectFileContext } from '@codebuff/common/util/file'
+
+/** Create a mock logger using bun:test mock() for better test consistency */
+const createMockLogger = () => ({
+  debug: mock(() => {}),
+  info: mock(() => {}),
+  warn: mock(() => {}),
+  error: mock(() => {}),
+})
+
+const createMockFileContext = (): ProjectFileContext => ({
+  projectRoot: '/test',
+  cwd: '/test',
+  fileTree: [],
+  fileTokenScores: {},
+  knowledgeFiles: {},
+  gitChanges: {
+    status: '',
+    diff: '',
+    diffCached: '',
+    lastCommitMessages: '',
+  },
+  changesSinceLastChat: {},
+  shellConfigFiles: {},
+  agentTemplates: {},
+  customToolDefinitions: {},
+  systemInfo: {
+    platform: 'test',
+    shell: 'test',
+    nodeVersion: 'test',
+    arch: 'test',
+    homedir: '/home/test',
+    cpus: 1,
+  },
+})
+
+const createMockAgentState = (agentType: string): AgentState => ({
+  agentId: 'test-agent-id',
+  agentType,
+  runId: 'test-run-id',
+  parentId: undefined,
+  messageHistory: [],
+  output: undefined,
+  stepsRemaining: 10,
+  creditsUsed: 0,
+  directCreditsUsed: 0,
+  childRunIds: [],
+  ancestorRunIds: [],
+  contextTokenCount: 0,
+  agentContext: {},
+})
+
+const createMockAgentTemplate = (
+  overrides: Partial<AgentTemplate> = {},
+): AgentTemplate => ({
+  id: 'test-agent',
+  displayName: 'Test Agent',
+  model: 'gpt-4o-mini',
+  inputSchema: {},
+  outputMode: 'last_message',
+  includeMessageHistory: false,
+  inheritParentSystemPrompt: false,
+  mcpServers: {},
+  toolNames: [],
+  spawnableAgents: [],
+  systemPrompt: '',
+  instructionsPrompt: 'Test instructions',
+  stepPrompt: '',
+  ...overrides,
+})
+
+describe('getAgentPrompt', () => {
+  describe('spawnerPrompt inclusion in instructionsPrompt', () => {
+    test('includes spawnerPrompt for each spawnable agent with spawnerPrompt defined', async () => {
+      const filePickerTemplate = createMockAgentTemplate({
+        id: 'file-picker',
+        displayName: 'File Picker',
+        spawnerPrompt: 'Spawn to find relevant files in a codebase',
+      })
+
+      const codeSearcherTemplate = createMockAgentTemplate({
+        id: 'code-searcher',
+        displayName: 'Code Searcher',
+        spawnerPrompt: 'Mechanically runs multiple code search queries',
+      })
+
+      const mainAgentTemplate = createMockAgentTemplate({
+        id: 'main-agent',
+        displayName: 'Main Agent',
+        spawnableAgents: ['file-picker', 'code-searcher'],
+        instructionsPrompt: 'Main agent instructions.',
+      })
+
+      const agentTemplates: Record<string, AgentTemplate> = {
+        'main-agent': mainAgentTemplate,
+        'file-picker': filePickerTemplate,
+        'code-searcher': codeSearcherTemplate,
+      }
+
+      const result = await getAgentPrompt({
+        agentTemplate: mainAgentTemplate,
+        promptType: { type: 'instructionsPrompt' },
+        fileContext: createMockFileContext(),
+        agentState: createMockAgentState('main-agent'),
+        agentTemplates,
+        additionalToolDefinitions: async () => ({}),
+        logger: createMockLogger(),
+        apiKey: TEST_AGENT_RUNTIME_IMPL.apiKey,
+        databaseAgentCache: TEST_AGENT_RUNTIME_IMPL.databaseAgentCache,
+        fetchAgentFromDatabase: TEST_AGENT_RUNTIME_IMPL.fetchAgentFromDatabase,
+      })
+
+      expect(result).toBeDefined()
+      expect(result).toContain('You can spawn the following agents:')
+      expect(result).toContain('- file-picker: Spawn to find relevant files in a codebase')
+      expect(result).toContain('- code-searcher: Mechanically runs multiple code search queries')
+    })
+
+    test('includes only agent name when spawnerPrompt is not defined', async () => {
+      const agentWithoutSpawnerPrompt = createMockAgentTemplate({
+        id: 'no-prompt-agent',
+        displayName: 'No Prompt Agent',
+        // spawnerPrompt is not defined
+      })
+
+      const mainAgentTemplate = createMockAgentTemplate({
+        id: 'main-agent',
+        displayName: 'Main Agent',
+        spawnableAgents: ['no-prompt-agent'],
+        instructionsPrompt: 'Main agent instructions.',
+      })
+
+      const agentTemplates: Record<string, AgentTemplate> = {
+        'main-agent': mainAgentTemplate,
+        'no-prompt-agent': agentWithoutSpawnerPrompt,
+      }
+
+      const result = await getAgentPrompt({
+        agentTemplate: mainAgentTemplate,
+        promptType: { type: 'instructionsPrompt' },
+        fileContext: createMockFileContext(),
+        agentState: createMockAgentState('main-agent'),
+        agentTemplates,
+        additionalToolDefinitions: async () => ({}),
+        logger: createMockLogger(),
+        apiKey: TEST_AGENT_RUNTIME_IMPL.apiKey,
+        databaseAgentCache: TEST_AGENT_RUNTIME_IMPL.databaseAgentCache,
+        fetchAgentFromDatabase: TEST_AGENT_RUNTIME_IMPL.fetchAgentFromDatabase,
+      })
+
+      expect(result).toBeDefined()
+      expect(result).toContain('You can spawn the following agents:')
+      expect(result).toContain('- no-prompt-agent')
+      // Should not have a colon after the agent name when there's no spawnerPrompt
+      expect(result).not.toContain('- no-prompt-agent:')
+    })
+
+    test('handles mix of agents with and without spawnerPrompt', async () => {
+      const agentWithPrompt = createMockAgentTemplate({
+        id: 'with-prompt',
+        displayName: 'Agent With Prompt',
+        spawnerPrompt: 'This agent has a description',
+      })
+
+      const agentWithoutPrompt = createMockAgentTemplate({
+        id: 'without-prompt',
+        displayName: 'Agent Without Prompt',
+        // spawnerPrompt is not defined
+      })
+
+      const mainAgentTemplate = createMockAgentTemplate({
+        id: 'main-agent',
+        displayName: 'Main Agent',
+        spawnableAgents: ['with-prompt', 'without-prompt'],
+        instructionsPrompt: 'Main agent instructions.',
+      })
+
+      const agentTemplates: Record<string, AgentTemplate> = {
+        'main-agent': mainAgentTemplate,
+        'with-prompt': agentWithPrompt,
+        'without-prompt': agentWithoutPrompt,
+      }
+
+      const result = await getAgentPrompt({
+        agentTemplate: mainAgentTemplate,
+        promptType: { type: 'instructionsPrompt' },
+        fileContext: createMockFileContext(),
+        agentState: createMockAgentState('main-agent'),
+        agentTemplates,
+        additionalToolDefinitions: async () => ({}),
+        logger: createMockLogger(),
+        apiKey: TEST_AGENT_RUNTIME_IMPL.apiKey,
+        databaseAgentCache: TEST_AGENT_RUNTIME_IMPL.databaseAgentCache,
+        fetchAgentFromDatabase: TEST_AGENT_RUNTIME_IMPL.fetchAgentFromDatabase,
+      })
+
+      expect(result).toBeDefined()
+      expect(result).toContain('- with-prompt: This agent has a description')
+      expect(result).toContain('- without-prompt')
+      expect(result).not.toContain('- without-prompt:')
+    })
+
+    test('does not include spawnable agents section when no spawnable agents defined', async () => {
+      const mainAgentTemplate = createMockAgentTemplate({
+        id: 'main-agent',
+        displayName: 'Main Agent',
+        spawnableAgents: [],
+        instructionsPrompt: 'Main agent instructions.',
+      })
+
+      const agentTemplates: Record<string, AgentTemplate> = {
+        'main-agent': mainAgentTemplate,
+      }
+
+      const result = await getAgentPrompt({
+        agentTemplate: mainAgentTemplate,
+        promptType: { type: 'instructionsPrompt' },
+        fileContext: createMockFileContext(),
+        agentState: createMockAgentState('main-agent'),
+        agentTemplates,
+        additionalToolDefinitions: async () => ({}),
+        logger: createMockLogger(),
+        apiKey: TEST_AGENT_RUNTIME_IMPL.apiKey,
+        databaseAgentCache: TEST_AGENT_RUNTIME_IMPL.databaseAgentCache,
+        fetchAgentFromDatabase: TEST_AGENT_RUNTIME_IMPL.fetchAgentFromDatabase,
+      })
+
+      expect(result).toBeDefined()
+      expect(result).not.toContain('You can spawn the following agents:')
+    })
+
+    test('does not include spawnable agents for non-instructionsPrompt types', async () => {
+      const filePickerTemplate = createMockAgentTemplate({
+        id: 'file-picker',
+        displayName: 'File Picker',
+        spawnerPrompt: 'Spawn to find relevant files in a codebase',
+      })
+
+      const mainAgentTemplate = createMockAgentTemplate({
+        id: 'main-agent',
+        displayName: 'Main Agent',
+        spawnableAgents: ['file-picker'],
+        systemPrompt: 'System prompt content.',
+        stepPrompt: 'Step prompt content.',
+      })
+
+      const agentTemplates: Record<string, AgentTemplate> = {
+        'main-agent': mainAgentTemplate,
+        'file-picker': filePickerTemplate,
+      }
+
+      // Test systemPrompt - should not include spawnable agents
+      const systemResult = await getAgentPrompt({
+        agentTemplate: mainAgentTemplate,
+        promptType: { type: 'systemPrompt' },
+        fileContext: createMockFileContext(),
+        agentState: createMockAgentState('main-agent'),
+        agentTemplates,
+        additionalToolDefinitions: async () => ({}),
+        logger: createMockLogger(),
+        apiKey: TEST_AGENT_RUNTIME_IMPL.apiKey,
+        databaseAgentCache: TEST_AGENT_RUNTIME_IMPL.databaseAgentCache,
+        fetchAgentFromDatabase: TEST_AGENT_RUNTIME_IMPL.fetchAgentFromDatabase,
+      })
+
+      expect(systemResult).toBeDefined()
+      expect(systemResult).not.toContain('You can spawn the following agents:')
+
+      // Test stepPrompt - should not include spawnable agents
+      const stepResult = await getAgentPrompt({
+        agentTemplate: mainAgentTemplate,
+        promptType: { type: 'stepPrompt' },
+        fileContext: createMockFileContext(),
+        agentState: createMockAgentState('main-agent'),
+        agentTemplates,
+        additionalToolDefinitions: async () => ({}),
+        logger: createMockLogger(),
+        apiKey: TEST_AGENT_RUNTIME_IMPL.apiKey,
+        databaseAgentCache: TEST_AGENT_RUNTIME_IMPL.databaseAgentCache,
+        fetchAgentFromDatabase: TEST_AGENT_RUNTIME_IMPL.fetchAgentFromDatabase,
+      })
+
+      expect(stepResult).toBeDefined()
+      expect(stepResult).not.toContain('You can spawn the following agents:')
+    })
+  })
+})
diff --git a/packages/agent-runtime/src/templates/strings.ts b/packages/agent-runtime/src/templates/strings.ts
@@ -202,8 +202,21 @@ export async function getAgentPrompt<T extends StringField>(
       }
     } else if (spawnableAgents.length > 0) {
       // For non-inherited tools, agents are already defined as tools with full schemas,
-      // so we just list the available agent IDs here
-      addendum += `\n\nYou can spawn the following agents: ${spawnableAgents.join(', ')}.`
+      // so we add the spawnerPrompt for each agent
+      const agentDescriptions = await Promise.all(
+        spawnableAgents.map(async (agentType) => {
+          const template = await getAgentTemplate({
+            ...params,
+            agentId: agentType,
+            localAgentTemplates: agentTemplates,
+          })
+          if (template?.spawnerPrompt) {
+            return `- ${agentType}: ${template.spawnerPrompt}`
+          }
+          return `- ${agentType}`
+        }),
+      )
+      addendum += `\n\nYou can spawn the following agents:\n\n${agentDescriptions.join('\n')}`
     }
 
     // Add output schema information if defined
