typecheck for tool call strings

Author: charleslien

backend/src/__tests__/main-prompt.integration.test.ts

@@ -83,7 +83,6 @@ describe.skip('mainPrompt (Integration)', () => {
       },
     }
 
-
     spyOn(websocketAction, 'requestToolCall').mockImplementation(
       async (
         ws: WebSocket,
@@ -349,7 +348,7 @@ export function getMessagesSubset(messages: Message[], otherTokens: number) {
       {
         role: 'assistant',
         content: getToolCallString('read_files', {
-          paths: 'src/util/messages.ts',
+          paths: ['src/util/messages.ts'],
         }),
       },
       {
@@ -434,7 +433,7 @@ export function getMessagesSubset(messages: Message[], otherTokens: number) {
         {
           role: 'assistant',
           content: getToolCallString('read_files', {
-            paths: 'packages/backend/src/index.ts',
+            paths: ['packages/backend/src/index.ts'],
           }),
         },
         {

backend/src/templates/base-prompts.ts

@@ -115,17 +115,21 @@ ${getToolCallString('read_files', { paths: ['src/components/foo.tsx'] })}
 
 Now, I'll add the console.log at the beginning of the Foo component:
 
-${getToolCallString('write_file', {
+${getToolCallString('str_replace', {
   path: 'src/components/foo.tsx',
-  content: `// ... existing code ...
-function Foo(props: {
-bar: string
+  replacements: [
+    {
+      old: `function Foo(props: {
+  bar: string
 }) {
-console.log("Foo props:", props);
-// ... rest of the function ...
-}
-// ... existing code ...
 `,
+      new: `function Foo(props: {
+  bar: string
+})
+  console.log("Foo props:", props);
+`,
+    },
+  ],
 })}
 
 Let me check my changes

backend/src/tools/definitions/tool/find-files.ts

@@ -8,7 +8,7 @@ export const findFilesTool = {
   description: `
 Example:
 ${getToolCallString(toolName, {
-  description: 'The implementation of function foo',
+  prompt: 'The implementation of function foo',
 })}
 
 Purpose: Better fulfill the user request by reading files which could contain information relevant to the user's request.

backend/src/tools/definitions/tool/send-agent-message.ts

@@ -18,10 +18,10 @@ Example:
 ${getToolCallString(toolName, {
   target_agent_id: 'PARENT_ID',
   prompt: 'Found 5 authentication-related files',
-  params: JSON.stringify({
+  params: {
     files: ['src/auth.ts', 'src/login.ts'],
     confidence: 0.9,
-  }),
+  },
 })}
     `.trim(),
 } satisfies ToolDescription

backend/src/tools/definitions/tool/spawn-agents-async.ts

@@ -14,7 +14,7 @@ Prefer to use spawn_agents unless you really need this ability to spawn asynchro
 
 Example:
 ${getToolCallString(toolName, {
-  agents: JSON.stringify([
+  agents: [
     {
       agent_type: 'file_picker',
       prompt: 'Find files related to authentication',
@@ -24,7 +24,7 @@ ${getToolCallString(toolName, {
       prompt: 'Research best practices for user authentication',
       params: { keywords: ['authentication', 'nextjs', 'auth0'] },
     },
-  ]),
+  ],
 })}
     `.trim(),
 } satisfies ToolDescription

backend/src/tools/definitions/tool/spawn-agents.ts

@@ -12,13 +12,13 @@ The prompt field is a simple string, while params is a JSON object that gets val
 
 Example:
 ${getToolCallString(toolName, {
-  agents: JSON.stringify([
+  agents: [
     {
       agent_type: 'planner',
       prompt: 'Create a plan for implementing user authentication',
       params: { filePaths: ['src/auth.ts', 'src/user.ts'] },
     },
-  ]),
+  ],
 })}
     `.trim(),
 } satisfies ToolDescription

backend/src/tools/prompts.ts

@@ -96,10 +96,14 @@ However, **DO NOT** narrate the tool or parameter names themselves.
 User: can you update the console logs in example/file.ts?
 Assistant: Sure thing! Let's update that file!
 
-${getToolCallString('write_file', {
+${getToolCallString('str_replace', {
   path: 'path/to/example/file.ts',
-  instructions: 'Update the console logs',
-  content: "console.log('Hello from Buffy!');",
+  replacements: [
+    {
+      old: "console.log('Hello world!');\n",
+      new: "console.log('Hello from Buffy!');\n",
+    },
+  ],
 })}
 
 All done with the update!

common/src/tools/utils.ts

@@ -8,10 +8,13 @@ import { llmToolCallSchema } from './list'
 import { closeXml } from '../util/xml'
 
 import type { StringToolResultPart, ToolName } from './constants'
+import type z from 'zod/v4'
 
 export function getToolCallString<T extends ToolName | (string & {})>(
   toolName: T,
-  params: Record<string, any>,
+  params: T extends ToolName
+    ? z.input<(typeof llmToolCallSchema)[T]['parameters']>
+    : Record<string, any>,
   ...endsAgentStep: T extends ToolName ? [] : [boolean]
 ): string {
   const endsAgentStepValue =

npm-app/src/utils/__tests__/tool-renderers.test.ts

@@ -55,10 +55,13 @@ describe('Tool renderers with XML parser', () => {
     const xml = getToolCallString('write_file', {
       path: 'test.ts',
       content: 'console.log("test");\n',
+      instructions: 'add a console.log statement',
     })
     const output = await processXML(xml)
     const stripped = stripAnsi(output)
-    expect(stripped).toBe('\n\n[Write File]\nEditing file at test.ts...\n\n')
+    expect(stripped).toBe(
+      '\n\n[Write File]\nEditing file at test.ts...\nadd a console.log statement\n\n',
+    )
   })
 
   test('formats read_files tool call', async () => {

npm-app/src/utils/__tests__/xml-stream-parser.test.ts

@@ -47,7 +47,7 @@ describe('createXMLStreamParser', () => {
   test('handles multiple tool calls in sequence', async () => {
     const xml =
       getToolCallString('run_terminal_command', { command: 'ls' }) +
-      getToolCallString('read_files', { paths: 'file.txt' })
+      getToolCallString('read_files', { paths: ['file.txt'] })
     let result = ''
 
     const processor = createXMLStreamParser(toolRenderers)
@@ -78,7 +78,7 @@ describe('createXMLStreamParser', () => {
     const xml =
       getToolCallString('run_terminal_command', { command: 'ls' }) +
       'Some text between tool calls' +
-      getToolCallString('read_files', { paths: 'file.txt' })
+      getToolCallString('read_files', { paths: ['file.txt'] })
     let result = ''
 
     const processor = createXMLStreamParser(toolRenderers)