feat: add search_and_replace tool for batch text replacements (#9549)

Co-authored-by: daniel-lxs <[email protected]>

Author: hannesrudolph

packages/types/src/tool.ts

@@ -20,6 +20,7 @@ export const toolNames = [
 	"write_to_file",
 	"apply_diff",
 	"insert_content",
+	"search_and_replace",
 	"search_files",
 	"list_files",
 	"list_code_definition_names",

src/core/assistant-message/NativeToolCallParser.ts

@@ -635,6 +635,15 @@ export class NativeToolCallParser {
 					}
 					break
 
+				case "search_and_replace":
+					if (args.path !== undefined && args.operations !== undefined && Array.isArray(args.operations)) {
+						nativeArgs = {
+							path: args.path,
+							operations: args.operations,
+						} as NativeArgsFor<TName>
+					}
+					break
+
 				case "ask_followup_question":
 					if (args.question !== undefined && args.follow_up !== undefined) {
 						nativeArgs = {

src/core/assistant-message/presentAssistantMessage.ts

@@ -17,6 +17,7 @@ import { shouldUseSingleFileRead, TOOL_PROTOCOL } from "@roo-code/types"
 import { writeToFileTool } from "../tools/WriteToFileTool"
 import { applyDiffTool } from "../tools/MultiApplyDiffTool"
 import { insertContentTool } from "../tools/InsertContentTool"
+import { searchAndReplaceTool } from "../tools/SearchAndReplaceTool"
 import { listCodeDefinitionNamesTool } from "../tools/ListCodeDefinitionNamesTool"
 import { searchFilesTool } from "../tools/SearchFilesTool"
 import { browserActionTool } from "../tools/BrowserActionTool"
@@ -379,6 +380,8 @@ export async function presentAssistantMessage(cline: Task) {
 						}]`
 					case "insert_content":
 						return `[${block.name} for '${block.params.path}']`
+					case "search_and_replace":
+						return `[${block.name} for '${block.params.path}']`
 					case "list_files":
 						return `[${block.name} for '${block.params.path}']`
 					case "list_code_definition_names":
@@ -677,7 +680,14 @@ export async function presentAssistantMessage(cline: Task) {
 			}
 
 			// Validate tool use before execution.
-			const { mode, customModes } = (await cline.providerRef.deref()?.getState()) ?? {}
+			const {
+				mode,
+				customModes,
+				experiments: stateExperiments,
+				apiConfiguration,
+			} = (await cline.providerRef.deref()?.getState()) ?? {}
+			const modelInfo = cline.api.getModel()
+			const includedTools = modelInfo?.info?.includedTools
 
 			try {
 				validateToolUse(
@@ -686,6 +696,8 @@ export async function presentAssistantMessage(cline: Task) {
 					customModes ?? [],
 					{ apply_diff: cline.diffEnabled },
 					block.params,
+					stateExperiments,
+					includedTools,
 				)
 			} catch (error) {
 				cline.consecutiveMistakeCount++
@@ -806,6 +818,16 @@ export async function presentAssistantMessage(cline: Task) {
 						toolProtocol,
 					})
 					break
+				case "search_and_replace":
+					await checkpointSaveAndMark(cline)
+					await searchAndReplaceTool.handle(cline, block as ToolUse<"search_and_replace">, {
+						askApproval,
+						handleError,
+						pushToolResult,
+						removeClosingTag,
+						toolProtocol,
+					})
+					break
 				case "read_file":
 					// Check if this model should use the simplified single-file read tool
 					// Only use simplified tool for XML protocol - native protocol works with standard tool

src/core/prompts/tools/native-tools/apply_diff.ts

@@ -11,7 +11,7 @@ const DIFF_PARAMETER_DESCRIPTION = `A string containing one or more search/repla
 [new content to replace with]
 >>>>>>> REPLACE`
 
-export const apply_diff_single_file = {
+export const apply_diff = {
 	type: "function",
 	function: {
 		name: "apply_diff",

src/core/prompts/tools/native-tools/index.ts

@@ -1,5 +1,6 @@
 import type OpenAI from "openai"
 import accessMcpResource from "./access_mcp_resource"
+import { apply_diff } from "./apply_diff"
 import askFollowupQuestion from "./ask_followup_question"
 import attemptCompletion from "./attempt_completion"
 import browserAction from "./browser_action"
@@ -13,11 +14,11 @@ import listFiles from "./list_files"
 import newTask from "./new_task"
 import { createReadFileTool } from "./read_file"
 import runSlashCommand from "./run_slash_command"
+import searchAndReplace from "./search_and_replace"
 import searchFiles from "./search_files"
 import switchMode from "./switch_mode"
 import updateTodoList from "./update_todo_list"
 import writeToFile from "./write_to_file"
-import { apply_diff_single_file } from "./apply_diff"
 
 export { getMcpServerTools } from "./mcp_server"
 export { convertOpenAIToolToAnthropic, convertOpenAIToolsToAnthropic } from "./converters"
@@ -31,7 +32,7 @@ export { convertOpenAIToolToAnthropic, convertOpenAIToolsToAnthropic } from "./c
 export function getNativeTools(partialReadsEnabled: boolean = true): OpenAI.Chat.ChatCompletionTool[] {
 	return [
 		accessMcpResource,
-		apply_diff_single_file,
+		apply_diff,
 		askFollowupQuestion,
 		attemptCompletion,
 		browserAction,
@@ -45,6 +46,7 @@ export function getNativeTools(partialReadsEnabled: boolean = true): OpenAI.Chat
 		newTask,
 		createReadFileTool(partialReadsEnabled),
 		runSlashCommand,
+		searchAndReplace,
 		searchFiles,
 		switchMode,
 		updateTodoList,

src/core/prompts/tools/native-tools/search_and_replace.ts

@@ -0,0 +1,44 @@
+import type OpenAI from "openai"
+
+const SEARCH_AND_REPLACE_DESCRIPTION = `Apply precise, targeted modifications to an existing file using search and replace operations. This tool is for surgical edits only; provide an array of operations where each operation specifies the exact text to search for and what to replace it with. The search text must exactly match the existing content, including whitespace and indentation.`
+
+const search_and_replace = {
+	type: "function",
+	function: {
+		name: "search_and_replace",
+		description: SEARCH_AND_REPLACE_DESCRIPTION,
+		parameters: {
+			type: "object",
+			properties: {
+				path: {
+					type: "string",
+					description: "The path of the file to modify, relative to the current workspace directory.",
+				},
+				operations: {
+					type: "array",
+					description: "Array of search and replace operations to perform on the file.",
+					items: {
+						type: "object",
+						properties: {
+							search: {
+								type: "string",
+								description:
+									"The exact text to find in the file. Must match exactly, including whitespace.",
+							},
+							replace: {
+								type: "string",
+								description: "The text to replace the search text with.",
+							},
+						},
+						required: ["search", "replace"],
+					},
+					minItems: 1,
+				},
+			},
+			required: ["path", "operations"],
+			additionalProperties: false,
+		},
+	},
+} satisfies OpenAI.Chat.ChatCompletionTool
+
+export default search_and_replace