Instructions (#173)

Author: jahooma

backend/src/__tests__/__snapshots__/tools.test.ts.snap

@@ -41,6 +41,7 @@ Assistant: Sure thing! Let's update that file!
 
 <write_file>
 <path>path/to/example/file.ts</path>
+<instructions>Update the console logs</instructions>
 <content>console.log('Hello from Buffy!');</content>
 </write_file>
 
@@ -391,6 +392,7 @@ Assistant: Sure thing! Let's update that file!
 
 <write_file>
 <path>path/to/example/file.ts</path>
+<instructions>Update the console logs</instructions>
 <content>console.log('Hello from Buffy!');</content>
 </write_file>
 
@@ -484,6 +486,7 @@ Create or edit a file with the given content.
 
 Params:
 - \`path\`: (required) Path to the file relative to the **project root**
+- \`instructions\`: (required) What the change is intended to do in only one sentence.
 - \`content\`: (required) Edit snippet to apply to the file.
 
 #### **IMPORTANT** Edit Snippet
@@ -539,18 +542,21 @@ Notes for editing a file:
 Examples:
 <write_file>
 <path>path/to/file</path>
+<instructions>How the file is being updated</instructions>
 <content>Your file content here</content>
 </write_file>
 
 Example 1 - Simple file creation:
 <write_file>
 <path>new-file.ts</path>
+<instructions>Prints Hello, world</instructions>
 <content>console.log("Hello, world!");</content>
 </write_file>
 
 Example 2 - Editing with placeholder comments:
 <write_file>
 <path>foo.ts</path>
+<instructions>Update foo and remove console.log</instructions>
 <content>// ... existing code ...
 
 function foo() {
@@ -945,6 +951,7 @@ Assistant: Sure thing! Let's update that file!
 
 <write_file>
 <path>path/to/example/file.ts</path>
+<instructions>Update the console logs</instructions>
 <content>console.log('Hello from Buffy!');</content>
 </write_file>
 
@@ -1038,6 +1045,7 @@ Create or edit a file with the given content.
 
 Params:
 - \`path\`: (required) Path to the file relative to the **project root**
+- \`instructions\`: (required) What the change is intended to do in only one sentence.
 - \`content\`: (required) Edit snippet to apply to the file.
 
 #### **IMPORTANT** Edit Snippet
@@ -1093,18 +1101,21 @@ Notes for editing a file:
 Examples:
 <write_file>
 <path>path/to/file</path>
+<instructions>How the file is being updated</instructions>
 <content>Your file content here</content>
 </write_file>
 
 Example 1 - Simple file creation:
 <write_file>
 <path>new-file.ts</path>
+<instructions>Prints Hello, world</instructions>
 <content>console.log("Hello, world!");</content>
 </write_file>
 
 Example 2 - Editing with placeholder comments:
 <write_file>
 <path>foo.ts</path>
+<instructions>Update foo and remove console.log</instructions>
 <content>// ... existing code ...
 
 function foo() {
@@ -1499,6 +1510,7 @@ Assistant: Sure thing! Let's update that file!
 
 <write_file>
 <path>path/to/example/file.ts</path>
+<instructions>Update the console logs</instructions>
 <content>console.log('Hello from Buffy!');</content>
 </write_file>
 
@@ -1592,6 +1604,7 @@ Create or edit a file with the given content.
 
 Params:
 - \`path\`: (required) Path to the file relative to the **project root**
+- \`instructions\`: (required) What the change is intended to do in only one sentence.
 - \`content\`: (required) Edit snippet to apply to the file.
 
 #### **IMPORTANT** Edit Snippet
@@ -1647,18 +1660,21 @@ Notes for editing a file:
 Examples:
 <write_file>
 <path>path/to/file</path>
+<instructions>How the file is being updated</instructions>
 <content>Your file content here</content>
 </write_file>
 
 Example 1 - Simple file creation:
 <write_file>
 <path>new-file.ts</path>
+<instructions>Prints Hello, world</instructions>
 <content>console.log("Hello, world!");</content>
 </write_file>
 
 Example 2 - Editing with placeholder comments:
 <write_file>
 <path>foo.ts</path>
+<instructions>Update foo and remove console.log</instructions>
 <content>// ... existing code ...
 
 function foo() {
@@ -2053,6 +2069,7 @@ Assistant: Sure thing! Let's update that file!
 
 <write_file>
 <path>path/to/example/file.ts</path>
+<instructions>Update the console logs</instructions>
 <content>console.log('Hello from Buffy!');</content>
 </write_file>
 
@@ -2146,6 +2163,7 @@ Create or edit a file with the given content.
 
 Params:
 - \`path\`: (required) Path to the file relative to the **project root**
+- \`instructions\`: (required) What the change is intended to do in only one sentence.
 - \`content\`: (required) Edit snippet to apply to the file.
 
 #### **IMPORTANT** Edit Snippet
@@ -2201,18 +2219,21 @@ Notes for editing a file:
 Examples:
 <write_file>
 <path>path/to/file</path>
+<instructions>How the file is being updated</instructions>
 <content>Your file content here</content>
 </write_file>
 
 Example 1 - Simple file creation:
 <write_file>
 <path>new-file.ts</path>
+<instructions>Prints Hello, world</instructions>
 <content>console.log("Hello, world!");</content>
 </write_file>
 
 Example 2 - Editing with placeholder comments:
 <write_file>
 <path>foo.ts</path>
+<instructions>Update foo and remove console.log</instructions>
 <content>// ... existing code ...
 
 function foo() {

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

@@ -11,7 +11,6 @@ import {
 import * as analytics from 'common/analytics'
 import { TEST_USER_ID } from 'common/constants'
 import { getInitialAgentState } from 'common/types/agent-state'
-import { createWriteFileBlock } from 'common/util/file'
 import { WebSocket } from 'ws'
 
 // Mock imports
@@ -55,10 +54,11 @@ describe('mainPrompt', () => {
 
     // Mock processFileBlock
     spyOn(processFileBlockModule, 'processFileBlock').mockImplementation(
-      async (path, contentPromise, newContent) => {
+      async (path, instructions, contentPromise, newContent) => {
         return {
           tool: 'write_file' as const,
           path,
+          instructions,
           content: newContent,
           patch: undefined,
         }
@@ -303,8 +303,24 @@ describe('mainPrompt', () => {
   })
 
   it('should handle write_file tool call', async () => {
+    const createWriteFileBlock = (
+      filePath: string,
+      instructions: string,
+      content: string
+    ) => {
+      const tagName = 'write_file'
+      return `<${tagName}>
+<path>${filePath}</path>
+<instructions>${instructions}</instructions>
+<content>${content}</content>
+</${tagName}>`
+    }
     // Mock LLM to return a write_file tool call
-    const writeFileBlock = createWriteFileBlock('new-file.txt', 'Hello World')
+    const writeFileBlock = createWriteFileBlock(
+      'new-file.txt',
+      'Added Hello World',
+      'Hello, world!'
+    )
     mockAgentStream(writeFileBlock)
 
     const agentState = getInitialAgentState(mockFileContext)
@@ -334,7 +350,7 @@ describe('mainPrompt', () => {
     }
     expect(params.type).toBe('file')
     expect(params.path).toBe('new-file.txt')
-    expect(params.content).toBe('Hello World')
+    expect(params.content).toBe('Hello, world!')
   })
 
   it('should force end of response after MAX_CONSECUTIVE_ASSISTANT_MESSAGES', async () => {

backend/src/__tests__/process-file-block.test.ts

@@ -66,6 +66,7 @@ describe('processFileBlock', () => {
 
     const result = await processFileBlock(
       'test.ts',
+      undefined,
       Promise.resolve(null),
       newContent,
       [],
@@ -102,6 +103,7 @@ describe('processFileBlock', () => {
 
     const result = await processFileBlock(
       'test.ts',
+      undefined,
       Promise.resolve(oldContent),
       newContent,
       [],
@@ -134,6 +136,7 @@ describe('processFileBlock', () => {
 
     const result = await processFileBlock(
       'test.ts',
+      undefined,
       Promise.resolve(oldContent),
       newContent,
       [],
@@ -203,6 +206,7 @@ function divide(a: number, b: number) {
 
     const result = await processFileBlock(
       'test.ts',
+      undefined,
       Promise.resolve(oldContent),
       newContent,
       [],
@@ -240,6 +244,7 @@ function divide(a: number, b: number) {
 
     const result = await processFileBlock(
       'test.ts',
+      undefined,
       Promise.resolve(oldContent),
       newContent,
       [],
@@ -281,6 +286,7 @@ function divide(a: number, b: number) {
 
     const result = await processFileBlock(
       'test.ts',
+      undefined,
       Promise.resolve(null),
       newContent,
       [],

backend/src/__tests__/tools.test.ts

@@ -10,25 +10,21 @@ describe('getFilteredToolsInstructions', () => {
 
   it('should match snapshot for lite mode', () => {
     const result = getFilteredToolsInstructions('lite')
-
     expect(result).toMatchSnapshot()
   })
 
   it('should match snapshot for normal mode', () => {
     const result = getFilteredToolsInstructions('normal')
-
     expect(result).toMatchSnapshot()
   })
 
   it('should match snapshot for max mode', () => {
     const result = getFilteredToolsInstructions('max')
-
     expect(result).toMatchSnapshot()
   })
 
   it('should match snapshot for experimental mode', () => {
     const result = getFilteredToolsInstructions('experimental')
-
     expect(result).toMatchSnapshot()
   })
 })

backend/src/fast-rewrite.ts

@@ -12,6 +12,7 @@ export async function fastRewrite(
   initialContent: string,
   editSnippet: string,
   filePath: string,
+  instructions: string | undefined,
   clientSessionId: string,
   fingerprintId: string,
   userInputId: string,
@@ -20,7 +21,7 @@ export async function fastRewrite(
 ) {
   const relaceStartTime = Date.now()
   const messageId = generateCompactId('cb-')
-  let response = await promptRelaceAI(initialContent, editSnippet, {
+  let response = await promptRelaceAI(initialContent, editSnippet, instructions, {
     clientSessionId,
     fingerprintId,
     userInputId,

backend/src/llm-apis/relace-api.ts

@@ -18,6 +18,7 @@ const timeoutPromise = (ms: number) =>
 export async function promptRelaceAI(
   initialCode: string,
   editSnippet: string,
+  instructions: string | undefined,
   options: {
     clientSessionId: string
     fingerprintId: string
@@ -48,6 +49,7 @@ export async function promptRelaceAI(
         body: JSON.stringify({
           initialCode,
           editSnippet,
+          ...(instructions ? { instructions } : {}),
           stream: false,
           'relace-metadata': {
             'codebuff-id': messageId,

backend/src/main-prompt.ts

@@ -764,7 +764,7 @@ export const mainPrompt = async (
         fileProcessingPromisesByPath[path].push(Promise.resolve(change))
       }),
       write_file: toolCallback('write_file', (toolCall) => {
-        const { path, content } = toolCall.parameters
+        const { path, instructions, content } = toolCall.parameters
         if (!content) return
 
         // Initialize state for this file path if needed
@@ -790,6 +790,7 @@ export const mainPrompt = async (
 
         const newPromise = processFileBlock(
           path,
+          instructions,
           latestContentPromise,
           fileContentWithoutStartNewline,
           messagesWithUserMessage,

backend/src/process-file-block.ts

@@ -15,6 +15,7 @@ import { countTokens } from './util/token-counter'
 
 export async function processFileBlock(
   path: string,
+  instructions: string | undefined,
   initialContentPromise: Promise<string | null>,
   newContent: string,
   messages: CoreMessage[],
@@ -116,6 +117,7 @@ export async function processFileBlock(
       normalizedInitialContent,
       normalizedEditSnippet,
       path,
+      instructions,
       clientSessionId,
       fingerprintId,
       userInputId,
@@ -141,6 +143,7 @@ export async function processFileBlock(
         normalizedInitialContent,
         updatedEditSnippet,
         path,
+        instructions,
         clientSessionId,
         fingerprintId,
         userInputId,