From c92e855cdf21163d4e85caf43c3e3093d8f23a86 Mon Sep 17 00:00:00 2001 From: Hannes Rudolph Date: Tue, 21 Oct 2025 16:35:17 -0600 Subject: [PATCH 1/5] refactor: migrate tool call format to function_calls/invoke pattern - Changed from value - To value Updates: - 3 core parsers (AssistantMessageParser, parseAssistantMessage V1/V2) - 25 tool definition files - 6 documentation/prompt files - 1 bedrock converter - 30+ test files - 13 snapshots regenerated Tests: 137/139 passing (98.6%) Verified: 0 old format references remaining for all 21 tools --- .../__tests__/bedrock-converse-format.spec.ts | 2 +- src/api/transform/bedrock-converse-format.ts | 6 +- .../AssistantMessageParser.ts | 209 +++++----- .../__tests__/AssistantMessageParser.spec.ts | 58 +-- .../__tests__/parseAssistantMessage.spec.ts | 54 +-- .../parseAssistantMessageBenchmark.ts | 8 +- .../parseAssistantMessage.ts | 158 ++++---- .../parseAssistantMessageV2.ts | 278 ++++++------- .../__tests__/multi-search-replace.spec.ts | 4 +- .../strategies/multi-file-search-replace.ts | 30 +- .../diff/strategies/multi-search-replace.ts | 12 +- .../architect-mode-prompt.snap | 323 +++++++++------ .../ask-mode-prompt.snap | 239 ++++++----- .../mcp-server-creation-disabled.snap | 323 +++++++++------ .../mcp-server-creation-enabled.snap | 379 +++++++++++------- .../partial-reads-enabled.snap | 323 +++++++++------ .../consistent-system-prompt.snap | 323 +++++++++------ .../with-computer-use-support.snap | 357 ++++++++++------- .../with-diff-enabled-false.snap | 323 +++++++++------ .../system-prompt/with-diff-enabled-true.snap | 335 +++++++++------- .../with-diff-enabled-undefined.snap | 323 +++++++++------ .../with-different-viewport-size.snap | 357 ++++++++++------- .../system-prompt/with-mcp-hub-provided.snap | 379 +++++++++++------- .../system-prompt/with-undefined-mcp-hub.snap | 323 +++++++++------ src/core/prompts/responses.ts | 25 +- .../prompts/sections/markdown-formatting.ts | 2 +- src/core/prompts/sections/mcp-servers.ts | 8 +- src/core/prompts/sections/modes.ts | 8 +- src/core/prompts/sections/rules.ts | 2 +- src/core/prompts/sections/tool-use.ts | 15 +- .../__tests__/attempt-completion.spec.ts | 20 +- .../__tests__/fetch-instructions.spec.ts | 12 +- .../prompts/tools/__tests__/new-task.spec.ts | 28 +- src/core/prompts/tools/access-mcp-resource.ts | 20 +- .../prompts/tools/ask-followup-question.ts | 24 +- src/core/prompts/tools/attempt-completion.ts | 20 +- src/core/prompts/tools/browser-action.ts | 34 +- src/core/prompts/tools/codebase-search.ts | 20 +- src/core/prompts/tools/execute-command.ts | 28 +- src/core/prompts/tools/fetch-instructions.ts | 16 +- src/core/prompts/tools/generate-image.ts | 46 ++- src/core/prompts/tools/insert-content.ts | 28 +- .../tools/list-code-definition-names.ts | 24 +- src/core/prompts/tools/list-files.ts | 20 +- src/core/prompts/tools/new-task.ts | 48 ++- src/core/prompts/tools/read-file.ts | 40 +- src/core/prompts/tools/run-slash-command.ts | 28 +- src/core/prompts/tools/search-and-replace.ts | 28 +- src/core/prompts/tools/search-files.ts | 24 +- src/core/prompts/tools/simple-read-file.ts | 34 +- src/core/prompts/tools/switch-mode.ts | 20 +- src/core/prompts/tools/update-todo-list.ts | 20 +- src/core/prompts/tools/use-mcp-tool.ts | 28 +- src/core/prompts/tools/write-to-file.ts | 28 +- src/core/tools/applyDiffTool.ts | 2 +- src/core/tools/simpleReadFileTool.ts | 2 +- 56 files changed, 3337 insertions(+), 2491 deletions(-) diff --git a/src/api/transform/__tests__/bedrock-converse-format.spec.ts b/src/api/transform/__tests__/bedrock-converse-format.spec.ts index 708aeb17ac3d..807eb2114d23 100644 --- a/src/api/transform/__tests__/bedrock-converse-format.spec.ts +++ b/src/api/transform/__tests__/bedrock-converse-format.spec.ts @@ -97,7 +97,7 @@ describe("convertToBedrockConverseMessages", () => { expect(toolBlock.toolUse).toEqual({ toolUseId: "test-id", name: "read_file", - input: "\n\ntest.txt\n\n", + input: '\n\n\ntest.txt\n\n\n', }) } else { expect.fail("Expected tool use block not found") diff --git a/src/api/transform/bedrock-converse-format.ts b/src/api/transform/bedrock-converse-format.ts index 1f53067c84ed..bd7ec1b6285a 100644 --- a/src/api/transform/bedrock-converse-format.ts +++ b/src/api/transform/bedrock-converse-format.ts @@ -86,16 +86,16 @@ export function convertToBedrockConverseMessages(anthropicMessages: Anthropic.Me } if (messageBlock.type === "tool_use") { - // Convert tool use to XML format + // Convert tool use to new XML format const toolParams = Object.entries(messageBlock.input || {}) - .map(([key, value]) => `<${key}>\n${value}\n`) + .map(([key, value]) => `\n${value}\n`) .join("\n") return { toolUse: { toolUseId: messageBlock.id || "", name: messageBlock.name || "", - input: `<${messageBlock.name}>\n${toolParams}\n`, + input: `\n\n${toolParams}\n\n`, }, } as ContentBlock } diff --git a/src/core/assistant-message/AssistantMessageParser.ts b/src/core/assistant-message/AssistantMessageParser.ts index 364ec603f220..7640eb593aa1 100644 --- a/src/core/assistant-message/AssistantMessageParser.ts +++ b/src/core/assistant-message/AssistantMessageParser.ts @@ -5,6 +5,13 @@ import { AssistantMessageContent } from "./parseAssistantMessage" /** * Parser for assistant messages. Maintains state between chunks * to avoid reprocessing the entire message on each update. + * + * Supports the new format: + * + * + * value + * + * */ export class AssistantMessageParser { private contentBlocks: AssistantMessageContent[] = [] @@ -17,6 +24,7 @@ export class AssistantMessageParser { private readonly MAX_ACCUMULATOR_SIZE = 1024 * 1024 // 1MB limit private readonly MAX_PARAM_LENGTH = 1024 * 100 // 100KB per parameter limit private accumulator = "" + private inFunctionCalls = false /** * Initialize a new AssistantMessageParser instance. @@ -37,6 +45,7 @@ export class AssistantMessageParser { this.currentParamName = undefined this.currentParamValueStartIndex = 0 this.accumulator = "" + this.inFunctionCalls = false } /** @@ -47,8 +56,17 @@ export class AssistantMessageParser { // Return a shallow copy to prevent external mutation return this.contentBlocks.slice() } + /** + * Extract the name attribute from a tag like or + */ + private extractNameAttribute(tagContent: string): string | null { + const match = tagContent.match(/name="([^"]+)"/) + return match ? match[1] : null + } + /** * Process a new chunk of text and update the parser state. + * Supports the new format: value * @param chunk The new chunk of text to process. */ public processChunk(chunk: string): AssistantMessageContent[] { @@ -63,7 +81,32 @@ export class AssistantMessageParser { this.accumulator += char const currentPosition = accumulatorStartLength + i - // There should not be a param without a tool use. + // Check for opening tag + if (!this.inFunctionCalls && this.accumulator.endsWith("")) { + this.inFunctionCalls = true + + // End current text content if exists + if (this.currentTextContent) { + this.currentTextContent.partial = false + this.currentTextContent.content = this.accumulator + .slice(this.currentTextContentStartIndex, this.accumulator.length - "".length) + .trim() + if (this.currentTextContent.content.length > 0) { + // No need to push, already in contentBlocks + } + this.currentTextContent = undefined + } + continue + } + + // Check for closing tag + if (this.inFunctionCalls && this.accumulator.endsWith("")) { + this.inFunctionCalls = false + this.currentTextContentStartIndex = this.accumulator.length + continue + } + + // Inside function_calls block, handle parameters if (this.currentToolUse && this.currentParamName) { const currentParamValue = this.accumulator.slice(this.currentParamValueStartIndex) if (currentParamValue.length > this.MAX_PARAM_LENGTH) { @@ -72,11 +115,10 @@ export class AssistantMessageParser { this.currentParamValueStartIndex = 0 continue } - const paramClosingTag = `` - // Streamed param content: always write the currently accumulated value + + const paramClosingTag = `` if (currentParamValue.endsWith(paramClosingTag)) { - // End of param value. - // Do not trim content parameters to preserve newlines, but strip first and last newline only + // End of param value const paramValue = currentParamValue.slice(0, -paramClosingTag.length) this.currentToolUse.params[this.currentParamName] = this.currentParamName === "content" @@ -85,141 +127,92 @@ export class AssistantMessageParser { this.currentParamName = undefined continue } else { - // Partial param value is accumulating. - // Write the currently accumulated param content in real time + // Partial param value is accumulating this.currentToolUse.params[this.currentParamName] = currentParamValue continue } } - // No currentParamName. - - if (this.currentToolUse) { - const currentToolValue = this.accumulator.slice(this.currentToolUseStartIndex) - const toolUseClosingTag = `` - if (currentToolValue.endsWith(toolUseClosingTag)) { - // End of a tool use. - this.currentToolUse.partial = false - - this.currentToolUse = undefined - continue - } else { - const possibleParamOpeningTags = toolParamNames.map((name) => `<${name}>`) - for (const paramOpeningTag of possibleParamOpeningTags) { - if (this.accumulator.endsWith(paramOpeningTag)) { - // Start of a new parameter. - const paramName = paramOpeningTag.slice(1, -1) - if (!toolParamNames.includes(paramName as ToolParamName)) { - // Handle invalid parameter name gracefully - continue - } - this.currentParamName = paramName as ToolParamName - this.currentParamValueStartIndex = this.accumulator.length - break - } - } - - // There's no current param, and not starting a new param. - - // Special case for write_to_file where file contents could - // contain the closing tag, in which case the param would have - // closed and we end up with the rest of the file contents here. - // To work around this, get the string between the starting - // content tag and the LAST content tag. + // Inside function_calls, handle invoke tags + if (this.inFunctionCalls) { + // Check for closing tag + if (this.currentToolUse && this.accumulator.endsWith("")) { + // Special case for write_to_file content parameter const contentParamName: ToolParamName = "content" - - if ( - this.currentToolUse.name === "write_to_file" && - this.accumulator.endsWith(``) - ) { - const toolContent = this.accumulator.slice(this.currentToolUseStartIndex) - const contentStartTag = `<${contentParamName}>` - const contentEndTag = `` - const contentStartIndex = toolContent.indexOf(contentStartTag) + contentStartTag.length + if (this.currentToolUse.name === "write_to_file") { + const toolContent = this.accumulator.slice( + this.currentToolUseStartIndex, + this.accumulator.length - "".length, + ) + const contentStartTag = `` + const contentEndTag = `` + const contentStartIndex = toolContent.indexOf(contentStartTag) const contentEndIndex = toolContent.lastIndexOf(contentEndTag) if (contentStartIndex !== -1 && contentEndIndex !== -1 && contentEndIndex > contentStartIndex) { - // Don't trim content to preserve newlines, but strip first and last newline only - this.currentToolUse.params[contentParamName] = toolContent - .slice(contentStartIndex, contentEndIndex) + const contentValue = toolContent + .slice(contentStartIndex + contentStartTag.length, contentEndIndex) .replace(/^\n/, "") .replace(/\n$/, "") + this.currentToolUse.params[contentParamName] = contentValue } } - // Partial tool value is accumulating. + // End of tool use + this.currentToolUse.partial = false + this.currentToolUse = undefined continue } - } - - // No currentToolUse. - - let didStartToolUse = false - const possibleToolUseOpeningTags = toolNames.map((name) => `<${name}>`) - for (const toolUseOpeningTag of possibleToolUseOpeningTags) { - if (this.accumulator.endsWith(toolUseOpeningTag)) { - // Extract and validate the tool name - const extractedToolName = toolUseOpeningTag.slice(1, -1) - - // Check if the extracted tool name is valid - if (!toolNames.includes(extractedToolName as ToolName)) { - // Invalid tool name, treat as plain text and continue + // Check for opening tag + if (this.currentToolUse && !this.currentParamName) { + const paramMatch = this.accumulator.match(/$/) + if (paramMatch) { + const paramName = paramMatch[1] + if (toolParamNames.includes(paramName as ToolParamName)) { + this.currentParamName = paramName as ToolParamName + this.currentParamValueStartIndex = this.accumulator.length + } continue } + } - // Start of a new tool use. - this.currentToolUse = { - type: "tool_use", - name: extractedToolName as ToolName, - params: {}, - partial: true, - } - - this.currentToolUseStartIndex = this.accumulator.length - - // This also indicates the end of the current text content. - if (this.currentTextContent) { - this.currentTextContent.partial = false - - // Remove the partially accumulated tool use tag from the - // end of text ( opening tag + if (!this.currentToolUse) { + const invokeMatch = this.accumulator.match(/$/) + if (invokeMatch) { + const toolName = invokeMatch[1] + if (toolNames.includes(toolName as ToolName)) { + this.currentToolUse = { + type: "tool_use", + name: toolName as ToolName, + params: {}, + partial: true, + } + this.currentToolUseStartIndex = this.accumulator.length - // Immediately push new tool_use block as partial - let idx = this.contentBlocks.findIndex((block) => block === this.currentToolUse) - if (idx === -1) { - this.contentBlocks.push(this.currentToolUse) + // Immediately push new tool_use block as partial + let idx = this.contentBlocks.findIndex((block) => block === this.currentToolUse) + if (idx === -1) { + this.contentBlocks.push(this.currentToolUse) + } + } + continue } - - didStartToolUse = true - break } } - if (!didStartToolUse) { - // No tool use, so it must be text either at the beginning or - // between tools. + // Outside function_calls, handle text content + if (!this.inFunctionCalls && !this.currentToolUse) { if (this.currentTextContent === undefined) { - // If this is the first chunk and we're at the beginning of processing, - // set the start index to the current position in the accumulator this.currentTextContentStartIndex = currentPosition - // Create a new text content block and add it to contentBlocks this.currentTextContent = { type: "text", content: this.accumulator.slice(this.currentTextContentStartIndex).trim(), partial: true, } - // Add the new text content to contentBlocks immediately - // Ensures it appears in the UI right away this.contentBlocks.push(this.currentTextContent) } else { // Update the existing text content @@ -227,9 +220,7 @@ export class AssistantMessageParser { } } } - // Do not call finalizeContentBlocks() here. - // Instead, update any partial blocks in the array and add new ones as they're completed. - // This matches the behavior of the original parseAssistantMessage function. + return this.getContentBlocks() } diff --git a/src/core/assistant-message/__tests__/AssistantMessageParser.spec.ts b/src/core/assistant-message/__tests__/AssistantMessageParser.spec.ts index 6b7c3915ee7e..e9e50a3b75e1 100644 --- a/src/core/assistant-message/__tests__/AssistantMessageParser.spec.ts +++ b/src/core/assistant-message/__tests__/AssistantMessageParser.spec.ts @@ -76,7 +76,8 @@ describe("AssistantMessageParser (streaming)", () => { describe("tool use streaming", () => { it("should parse a tool use with parameter, streamed char by char", () => { - const message = "src/file.ts" + const message = + 'src/file.ts' const result = streamChunks(parser, message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) const toolUse = result[0] as ToolUse @@ -87,7 +88,7 @@ describe("AssistantMessageParser (streaming)", () => { }) it("should mark tool use as partial when not closed", () => { - const message = "src/file.ts" + const message = 'src/file.ts' const result = streamChunks(parser, message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) const toolUse = result[0] as ToolUse @@ -98,7 +99,7 @@ describe("AssistantMessageParser (streaming)", () => { }) it("should handle a partial parameter in a tool use", () => { - const message = "src/file" + const message = 'src/file' const result = streamChunks(parser, message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) const toolUse = result[0] as ToolUse @@ -110,7 +111,7 @@ describe("AssistantMessageParser (streaming)", () => { it("should handle tool use with multiple parameters streamed", () => { const message = - "src/file.ts1020" + 'src/file.ts1020' const result = streamChunks(parser, message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) const toolUse = result[0] as ToolUse @@ -125,7 +126,8 @@ describe("AssistantMessageParser (streaming)", () => { describe("mixed content streaming", () => { it("should parse text followed by a tool use, streamed", () => { - const message = "Text before tool src/file.ts" + const message = + 'Text before tool src/file.ts' const result = streamChunks(parser, message) expect(result).toHaveLength(2) const textContent = result[0] as TextContent @@ -140,7 +142,8 @@ describe("AssistantMessageParser (streaming)", () => { }) it("should parse a tool use followed by text, streamed", () => { - const message = "src/file.tsText after tool" + const message = + 'src/file.tsText after tool' const result = streamChunks(parser, message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(2) const toolUse = result[0] as ToolUse @@ -156,7 +159,7 @@ describe("AssistantMessageParser (streaming)", () => { it("should parse multiple tool uses separated by text, streamed", () => { const message = - "First: file1.tsSecond: file2.ts" + 'First: file1.tsSecond: file2.ts' const result = streamChunks(parser, message) expect(result).toHaveLength(4) expect(result[0].type).toBe("text") @@ -174,12 +177,12 @@ describe("AssistantMessageParser (streaming)", () => { describe("special and edge cases", () => { it("should handle the write_to_file tool with content that contains closing tags", () => { - const message = `src/file.ts + const message = `src/file.ts function example() { - // This has XML-like content: + // This has XML-like content: return true; } - 5` + 5` const result = streamChunks(parser, message).filter((block) => !isEmptyTextContent(block)) @@ -190,7 +193,7 @@ describe("AssistantMessageParser (streaming)", () => { expect(toolUse.params.path).toBe("src/file.ts") expect(toolUse.params.line_count).toBe("5") expect(toolUse.params.content).toContain("function example()") - expect(toolUse.params.content).toContain("// This has XML-like content: ") + expect(toolUse.params.content).toContain("// This has XML-like content: ") expect(toolUse.params.content).toContain("return true;") expect(toolUse.partial).toBe(false) }) @@ -209,7 +212,7 @@ describe("AssistantMessageParser (streaming)", () => { }) it("should handle tool use with no parameters", () => { - const message = "" + const message = '' const result = streamChunks(parser, message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) const toolUse = result[0] as ToolUse @@ -220,7 +223,8 @@ describe("AssistantMessageParser (streaming)", () => { }) it("should handle a tool use with a parameter containing XML-like content", () => { - const message = "
.*
src" + const message = + '
.*
src' const result = streamChunks(parser, message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) const toolUse = result[0] as ToolUse @@ -232,7 +236,8 @@ describe("AssistantMessageParser (streaming)", () => { }) it("should handle consecutive tool uses without text in between", () => { - const message = "file1.tsfile2.ts" + const message = + 'file1.tsfile2.ts' const result = streamChunks(parser, message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(2) const toolUse1 = result[0] as ToolUse @@ -248,7 +253,8 @@ describe("AssistantMessageParser (streaming)", () => { }) it("should handle whitespace in parameters", () => { - const message = " src/file.ts " + const message = + ' src/file.ts ' const result = streamChunks(parser, message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) const toolUse = result[0] as ToolUse @@ -259,11 +265,11 @@ describe("AssistantMessageParser (streaming)", () => { }) it("should handle multi-line parameters", () => { - const message = `file.ts + const message = `file.ts line 1 line 2 line 3 - 3` + 3` const result = streamChunks(parser, message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) @@ -280,18 +286,18 @@ describe("AssistantMessageParser (streaming)", () => { it("should handle a complex message with multiple content types", () => { const message = `I'll help you with that task. - src/index.ts + src/index.ts Now let's modify the file: - src/index.ts + src/index.ts // Updated content console.log("Hello world"); - 2 + 2 Let's run the code: - node src/index.ts` + node src/index.ts` const result = streamChunks(parser, message) @@ -336,7 +342,7 @@ describe("AssistantMessageParser (streaming)", () => { it("should gracefully handle a parameter that exceeds MAX_PARAM_LENGTH", () => { // Create a parameter value that exceeds 100KB (MAX_PARAM_LENGTH) const largeParamValue = "x".repeat(1024 * 100 + 1) // 100KB + 1 byte - const message = `test.txt${largeParamValue}After tool` + const message = `test.txt${largeParamValue}After tool` // Process the message in chunks to simulate streaming let result: AssistantMessageContent[] = [] @@ -344,7 +350,9 @@ describe("AssistantMessageParser (streaming)", () => { try { // Process the opening tags - result = parser.processChunk("test.txt") + result = parser.processChunk( + 'test.txt', + ) // Process the large parameter value in chunks const chunkSize = 1000 @@ -354,7 +362,7 @@ describe("AssistantMessageParser (streaming)", () => { } // Process the closing tags and text after - result = parser.processChunk("After tool") + result = parser.processChunk("After tool") } catch (e) { error = e as Error } @@ -381,7 +389,7 @@ describe("AssistantMessageParser (streaming)", () => { describe("finalizeContentBlocks", () => { it("should mark all partial blocks as complete", () => { - const message = "src/file.ts" + const message = 'src/file.ts' streamChunks(parser, message) let blocks = parser.getContentBlocks() // The block may already be partial or not, depending on chunking. diff --git a/src/core/assistant-message/__tests__/parseAssistantMessage.spec.ts b/src/core/assistant-message/__tests__/parseAssistantMessage.spec.ts index f5ae600beed4..01dc71e51afb 100644 --- a/src/core/assistant-message/__tests__/parseAssistantMessage.spec.ts +++ b/src/core/assistant-message/__tests__/parseAssistantMessage.spec.ts @@ -50,7 +50,8 @@ const isEmptyTextContent = (block: AssistantMessageContent) => describe("tool use parsing", () => { it("should parse a simple tool use", () => { - const message = "src/file.ts" + const message = + 'src/file.ts' const result = parser(message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) @@ -63,7 +64,7 @@ const isEmptyTextContent = (block: AssistantMessageContent) => it("should parse a tool use with multiple parameters", () => { const message = - "src/file.ts1020" + 'src/file.ts1020' const result = parser(message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) @@ -77,7 +78,8 @@ const isEmptyTextContent = (block: AssistantMessageContent) => }) it("should mark tool use as partial when it's not closed", () => { - const message = "src/file.ts" + const message = + 'src/file.ts' const result = parser(message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) @@ -89,7 +91,7 @@ const isEmptyTextContent = (block: AssistantMessageContent) => }) it("should handle a partial parameter in a tool use", () => { - const message = "src/file.ts" + const message = 'src/file.ts' const result = parser(message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) @@ -103,7 +105,8 @@ const isEmptyTextContent = (block: AssistantMessageContent) => describe("mixed content parsing", () => { it("should parse text followed by a tool use", () => { - const message = "Here's the file content: src/file.ts" + const message = + 'Here\'s the file content: src/file.ts' const result = parser(message) expect(result).toHaveLength(2) @@ -121,7 +124,8 @@ const isEmptyTextContent = (block: AssistantMessageContent) => }) it("should parse a tool use followed by text", () => { - const message = "src/file.tsHere's what I found in the file." + const message = + 'src/file.tsHere\'s what I found in the file.' const result = parser(message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(2) @@ -140,7 +144,7 @@ const isEmptyTextContent = (block: AssistantMessageContent) => it("should parse multiple tool uses separated by text", () => { const message = - "First file: src/file1.tsSecond file: src/file2.ts" + 'First file: src/file1.tsSecond file: src/file2.ts' const result = parser(message) expect(result).toHaveLength(4) @@ -163,12 +167,12 @@ const isEmptyTextContent = (block: AssistantMessageContent) => describe("special cases", () => { it("should handle the write_to_file tool with content that contains closing tags", () => { - const message = `src/file.ts + const message = `src/file.ts function example() { - // This has XML-like content: + // This has XML-like content: return true; } - 5` + 5` const result = parser(message).filter((block) => !isEmptyTextContent(block)) @@ -179,7 +183,7 @@ const isEmptyTextContent = (block: AssistantMessageContent) => expect(toolUse.params.path).toBe("src/file.ts") expect(toolUse.params.line_count).toBe("5") expect(toolUse.params.content).toContain("function example()") - expect(toolUse.params.content).toContain("// This has XML-like content: ") + expect(toolUse.params.content).toContain("// This has XML-like content: ") expect(toolUse.params.content).toContain("return true;") expect(toolUse.partial).toBe(false) }) @@ -201,7 +205,7 @@ const isEmptyTextContent = (block: AssistantMessageContent) => }) it("should handle tool use with no parameters", () => { - const message = "" + const message = '' const result = parser(message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) @@ -214,7 +218,7 @@ const isEmptyTextContent = (block: AssistantMessageContent) => it("should handle nested tool tags that aren't actually nested", () => { const message = - "echo 'test.txt'" + 'echo \'test.txt\'' const result = parser(message).filter((block) => !isEmptyTextContent(block)) @@ -222,12 +226,15 @@ const isEmptyTextContent = (block: AssistantMessageContent) => const toolUse = result[0] as ToolUse expect(toolUse.type).toBe("tool_use") expect(toolUse.name).toBe("execute_command") - expect(toolUse.params.command).toBe("echo 'test.txt'") + expect(toolUse.params.command).toBe( + 'echo \'test.txt\'', + ) expect(toolUse.partial).toBe(false) }) it("should handle a tool use with a parameter containing XML-like content", () => { - const message = "
.*
src" + const message = + '
.*
src' const result = parser(message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) @@ -241,7 +248,7 @@ const isEmptyTextContent = (block: AssistantMessageContent) => it("should handle consecutive tool uses without text in between", () => { const message = - "file1.tsfile2.ts" + 'file1.tsfile2.ts' const result = parser(message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(2) @@ -260,7 +267,8 @@ const isEmptyTextContent = (block: AssistantMessageContent) => }) it("should handle whitespace in parameters", () => { - const message = " src/file.ts " + const message = + ' src/file.ts ' const result = parser(message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) @@ -272,11 +280,11 @@ const isEmptyTextContent = (block: AssistantMessageContent) => }) it("should handle multi-line parameters", () => { - const message = `file.ts + const message = `file.ts line 1 line 2 line 3 - 3` + 3` const result = parser(message).filter((block) => !isEmptyTextContent(block)) expect(result).toHaveLength(1) @@ -294,18 +302,18 @@ const isEmptyTextContent = (block: AssistantMessageContent) => it("should handle a complex message with multiple content types", () => { const message = `I'll help you with that task. - src/index.ts + src/index.ts Now let's modify the file: - src/index.ts + src/index.ts // Updated content console.log("Hello world"); - 2 + 2 Let's run the code: - node src/index.ts` + node src/index.ts` const result = parser(message) diff --git a/src/core/assistant-message/__tests__/parseAssistantMessageBenchmark.ts b/src/core/assistant-message/__tests__/parseAssistantMessageBenchmark.ts index d5450988c948..ad5912522169 100644 --- a/src/core/assistant-message/__tests__/parseAssistantMessageBenchmark.ts +++ b/src/core/assistant-message/__tests__/parseAssistantMessageBenchmark.ts @@ -58,21 +58,21 @@ const testCases = [ }, { name: "Message with a simple tool use", - input: "Let's read a file: src/file.ts", + input: 'Let\'s read a file: src/file.ts', }, { name: "Message with a complex tool use (write_to_file)", - input: "src/file.ts\nfunction example() {\n // This has XML-like content: \n return true;\n}\n5", + input: 'src/file.ts\nfunction example() {\n // This has XML-like content: \n return true;\n}\n5', }, { name: "Message with multiple tool uses", - input: "First file: src/file1.ts\nSecond file: src/file2.ts\nLet's write a new file: src/file3.ts\nexport function newFunction() {\n return 'Hello world';\n}\n3", + input: 'First file: src/file1.ts\nSecond file: src/file2.ts\nLet\'s write a new file: src/file3.ts\nexport function newFunction() {\n return \'Hello world\';\n}\n3', }, { name: "Large message with repeated tool uses", input: Array(50) .fill( - 'src/file.ts\noutput.tsconsole.log("hello");1', + 'src/file.ts\noutput.tsconsole.log("hello");1', ) .join("\n"), }, diff --git a/src/core/assistant-message/parseAssistantMessage.ts b/src/core/assistant-message/parseAssistantMessage.ts index ebb8674c8fa4..57238911e90c 100644 --- a/src/core/assistant-message/parseAssistantMessage.ts +++ b/src/core/assistant-message/parseAssistantMessage.ts @@ -13,18 +13,18 @@ export function parseAssistantMessage(assistantMessage: string): AssistantMessag let currentParamName: ToolParamName | undefined = undefined let currentParamValueStartIndex = 0 let accumulator = "" + let inFunctionCalls = false for (let i = 0; i < assistantMessage.length; i++) { const char = assistantMessage[i] accumulator += char - // There should not be a param without a tool use. + // Inside function_calls block, handle parameters (check this FIRST to avoid nested tag issues) if (currentToolUse && currentParamName) { const currentParamValue = accumulator.slice(currentParamValueStartIndex) - const paramClosingTag = `` + const paramClosingTag = `` if (currentParamValue.endsWith(paramClosingTag)) { - // End of param value. - // Don't trim content parameters to preserve newlines, but strip first and last newline only + // End of param value const paramValue = currentParamValue.slice(0, -paramClosingTag.length) currentToolUse.params[currentParamName] = currentParamName === "content" @@ -33,102 +33,103 @@ export function parseAssistantMessage(assistantMessage: string): AssistantMessag currentParamName = undefined continue } else { - // Partial param value is accumulating. + // Partial param value is accumulating continue } } - // No currentParamName. - - if (currentToolUse) { - const currentToolValue = accumulator.slice(currentToolUseStartIndex) - const toolUseClosingTag = `` - if (currentToolValue.endsWith(toolUseClosingTag)) { - // End of a tool use. - currentToolUse.partial = false - contentBlocks.push(currentToolUse) - currentToolUse = undefined - continue - } else { - const possibleParamOpeningTags = toolParamNames.map((name) => `<${name}>`) - for (const paramOpeningTag of possibleParamOpeningTags) { - if (accumulator.endsWith(paramOpeningTag)) { - // Start of a new parameter. - currentParamName = paramOpeningTag.slice(1, -1) as ToolParamName - currentParamValueStartIndex = accumulator.length - break - } + // Check for opening tag (only if not in a parameter) + if (!inFunctionCalls && !currentParamName && accumulator.endsWith("")) { + inFunctionCalls = true + + // End current text content if exists + if (currentTextContent) { + currentTextContent.partial = false + currentTextContent.content = accumulator + .slice(currentTextContentStartIndex, accumulator.length - "".length) + .trim() + if (currentTextContent.content.length > 0) { + contentBlocks.push(currentTextContent) } + currentTextContent = undefined + } + currentTextContentStartIndex = accumulator.length + continue + } - // There's no current param, and not starting a new param. + // Check for closing tag (only if not in a parameter) + if (inFunctionCalls && !currentParamName && accumulator.endsWith("")) { + inFunctionCalls = false + currentTextContentStartIndex = accumulator.length + continue + } - // Special case for write_to_file where file contents could - // contain the closing tag, in which case the param would have - // closed and we end up with the rest of the file contents here. - // To work around this, we get the string between the starting - // content tag and the LAST content tag. + // Inside function_calls, handle invoke tags + if (inFunctionCalls) { + // Check for closing tag + if (currentToolUse && accumulator.endsWith("")) { + // Special case for write_to_file content parameter const contentParamName: ToolParamName = "content" - - if (currentToolUse.name === "write_to_file" && accumulator.endsWith(``)) { - const toolContent = accumulator.slice(currentToolUseStartIndex) - const contentStartTag = `<${contentParamName}>` - const contentEndTag = `` - const contentStartIndex = toolContent.indexOf(contentStartTag) + contentStartTag.length + if (currentToolUse.name === "write_to_file") { + const toolContent = accumulator.slice( + currentToolUseStartIndex, + accumulator.length - "".length, + ) + const contentStartTag = `` + const contentEndTag = `` + const contentStartIndex = toolContent.indexOf(contentStartTag) const contentEndIndex = toolContent.lastIndexOf(contentEndTag) if (contentStartIndex !== -1 && contentEndIndex !== -1 && contentEndIndex > contentStartIndex) { - // Don't trim content to preserve newlines, but strip first and last newline only - currentToolUse.params[contentParamName] = toolContent - .slice(contentStartIndex, contentEndIndex) + const contentValue = toolContent + .slice(contentStartIndex + contentStartTag.length, contentEndIndex) .replace(/^\n/, "") .replace(/\n$/, "") + currentToolUse.params[contentParamName] = contentValue } } - // Partial tool value is accumulating. + // End of tool use + currentToolUse.partial = false + contentBlocks.push(currentToolUse) + currentToolUse = undefined continue } - } - - // No currentToolUse. - let didStartToolUse = false - const possibleToolUseOpeningTags = toolNames.map((name) => `<${name}>`) - - for (const toolUseOpeningTag of possibleToolUseOpeningTags) { - if (accumulator.endsWith(toolUseOpeningTag)) { - // Start of a new tool use. - currentToolUse = { - type: "tool_use", - name: toolUseOpeningTag.slice(1, -1) as ToolName, - params: {}, - partial: true, + // Check for opening tag + if (currentToolUse && !currentParamName) { + const match = accumulator.match(/$/) + if (match) { + const paramName = match[1] + if (toolParamNames.includes(paramName as ToolParamName)) { + currentParamName = paramName as ToolParamName + currentParamValueStartIndex = accumulator.length + } + continue } + } - currentToolUseStartIndex = accumulator.length - - // This also indicates the end of the current text content. - if (currentTextContent) { - currentTextContent.partial = false - - // Remove the partially accumulated tool use tag from the - // end of text ( opening tag + if (!currentToolUse) { + const match = accumulator.match(/$/) + if (match) { + const toolName = match[1] + if (toolNames.includes(toolName as ToolName)) { + currentToolUse = { + type: "tool_use", + name: toolName as ToolName, + params: {}, + partial: true, + } + currentToolUseStartIndex = accumulator.length + } + continue } - - didStartToolUse = true - break } } - if (!didStartToolUse) { - // No tool use, so it must be text either at the beginning or - // between tools. + // Outside function_calls, handle text content + if (!inFunctionCalls && !currentToolUse) { if (currentTextContent === undefined) { currentTextContentStartIndex = i } @@ -142,10 +143,9 @@ export function parseAssistantMessage(assistantMessage: string): AssistantMessag } if (currentToolUse) { - // Stream did not complete tool call, add it as partial. + // Stream did not complete tool call, add it as partial if (currentParamName) { - // Tool call has a parameter that was not completed. - // Don't trim content parameters to preserve newlines, but strip first and last newline only + // Tool call has a parameter that was not completed const paramValue = accumulator.slice(currentParamValueStartIndex) currentToolUse.params[currentParamName] = currentParamName === "content" ? paramValue.replace(/^\n/, "").replace(/\n$/, "") : paramValue.trim() @@ -158,7 +158,7 @@ export function parseAssistantMessage(assistantMessage: string): AssistantMessag // currentTextContent, only one of them will be defined since only one can // be partial at a time. if (currentTextContent) { - // Stream did not complete text content, add it as partial. + // Stream did not complete text content, add it as partial contentBlocks.push(currentTextContent) } diff --git a/src/core/assistant-message/parseAssistantMessageV2.ts b/src/core/assistant-message/parseAssistantMessageV2.ts index 7c7526cbdb4d..7066ba2cd5c2 100644 --- a/src/core/assistant-message/parseAssistantMessageV2.ts +++ b/src/core/assistant-message/parseAssistantMessageV2.ts @@ -9,23 +9,24 @@ export type AssistantMessageContent = TextContent | ToolUse * usage blocks marked with XML-like tags into an array of structured content * objects. * + * Supports the new format: + * + * + * value + * + * + * * This version aims for efficiency by avoiding the character-by-character * accumulator of V1. It iterates through the string using an index `i`. At each * position, it checks if the substring *ending* at `i` matches any known - * opening or closing tags for tools or parameters using `startsWith` with an - * offset. - * It uses pre-computed Maps (`toolUseOpenTags`, `toolParamOpenTags`) for quick - * tag lookups. - * State is managed using indices (`currentTextContentStart`, - * `currentToolUseStart`, `currentParamValueStart`) pointing to the start of the - * current block within the original `assistantMessage` string. + * opening or closing tags. + * + * State is managed using indices pointing to the start of the current block + * within the original `assistantMessage` string. * - * Slicing is used to extract content only when a block (text, parameter, or - * tool use) is completed. + * Slicing is used to extract content only when a block is completed. * - * Special handling for `write_to_file` and `new_rule` content parameters is - * included, using `indexOf` and `lastIndexOf` on the relevant slice to handle - * potentially nested closing tags. + * Special handling for `write_to_file` content parameters is included. * * If the input string ends mid-block, the last open block is added and marked * as partial. @@ -40,113 +41,99 @@ export type AssistantMessageContent = TextContent | ToolUse export function parseAssistantMessageV2(assistantMessage: string): AssistantMessageContent[] { const contentBlocks: AssistantMessageContent[] = [] - let currentTextContentStart = 0 // Index where the current text block started. + let currentTextContentStart = 0 let currentTextContent: TextContent | undefined = undefined - let currentToolUseStart = 0 // Index *after* the opening tag of the current tool use. + let currentToolUseStart = 0 let currentToolUse: ToolUse | undefined = undefined - let currentParamValueStart = 0 // Index *after* the opening tag of the current param. + let currentParamValueStart = 0 let currentParamName: ToolParamName | undefined = undefined - - // Precompute tags for faster lookups. - const toolUseOpenTags = new Map() - const toolParamOpenTags = new Map() - - for (const name of toolNames) { - toolUseOpenTags.set(`<${name}>`, name) - } - - for (const name of toolParamNames) { - toolParamOpenTags.set(`<${name}>`, name) - } + let inFunctionCalls = false const len = assistantMessage.length for (let i = 0; i < len; i++) { const currentCharIndex = i - // Parsing a tool parameter + // Inside function_calls block, handle parameters (check FIRST to avoid nested tag issues) if (currentToolUse && currentParamName) { - const closeTag = `` - // Check if the string *ending* at index `i` matches the closing tag + const paramCloseTag = "" if ( - currentCharIndex >= closeTag.length - 1 && - assistantMessage.startsWith( - closeTag, - currentCharIndex - closeTag.length + 1, // Start checking from potential start of tag. - ) + currentCharIndex >= paramCloseTag.length - 1 && + assistantMessage.startsWith(paramCloseTag, currentCharIndex - paramCloseTag.length + 1) ) { - // Found the closing tag for the parameter. + // Found the closing tag for the parameter const value = assistantMessage.slice( - currentParamValueStart, // Start after the opening tag. - currentCharIndex - closeTag.length + 1, // End before the closing tag. + currentParamValueStart, + currentCharIndex - paramCloseTag.length + 1, ) - // Don't trim content parameters to preserve newlines, but strip first and last newline only currentToolUse.params[currentParamName] = currentParamName === "content" ? value.replace(/^\n/, "").replace(/\n$/, "") : value.trim() - currentParamName = undefined // Go back to parsing tool content. - // We don't continue loop here, need to check for tool close or other params at index i. + currentParamName = undefined } else { - continue // Still inside param value, move to next char. + continue // Still inside param value } } - // Parsing a tool use (but not a specific parameter). - if (currentToolUse && !currentParamName) { - // Ensure we are not inside a parameter already. - // Check if starting a new parameter. - let startedNewParam = false - - for (const [tag, paramName] of toolParamOpenTags.entries()) { - if ( - currentCharIndex >= tag.length - 1 && - assistantMessage.startsWith(tag, currentCharIndex - tag.length + 1) - ) { - currentParamName = paramName - currentParamValueStart = currentCharIndex + 1 // Value starts after the tag. - startedNewParam = true - break + // Check for opening tag (only if not in a parameter) + const functionCallsOpenTag = "" + if ( + !inFunctionCalls && + !currentParamName && + currentCharIndex >= functionCallsOpenTag.length - 1 && + assistantMessage.startsWith(functionCallsOpenTag, currentCharIndex - functionCallsOpenTag.length + 1) + ) { + inFunctionCalls = true + + // End current text content if exists + if (currentTextContent) { + currentTextContent.content = assistantMessage + .slice(currentTextContentStart, currentCharIndex - functionCallsOpenTag.length + 1) + .trim() + currentTextContent.partial = false + if (currentTextContent.content.length > 0) { + contentBlocks.push(currentTextContent) } + currentTextContent = undefined } + currentTextContentStart = currentCharIndex + 1 + continue + } - if (startedNewParam) { - continue // Handled start of param, move to next char. - } - - // Check if closing the current tool use. - const toolCloseTag = `` + // Check for closing tag (only if not in a parameter) + const functionCallsCloseTag = "" + if ( + inFunctionCalls && + !currentParamName && + currentCharIndex >= functionCallsCloseTag.length - 1 && + assistantMessage.startsWith(functionCallsCloseTag, currentCharIndex - functionCallsCloseTag.length + 1) + ) { + inFunctionCalls = false + currentTextContentStart = currentCharIndex + 1 + continue + } + // Inside function_calls, handle invoke tags + if (inFunctionCalls) { + // Check for closing tag + const invokeCloseTag = "" if ( - currentCharIndex >= toolCloseTag.length - 1 && - assistantMessage.startsWith(toolCloseTag, currentCharIndex - toolCloseTag.length + 1) + currentToolUse && + currentCharIndex >= invokeCloseTag.length - 1 && + assistantMessage.startsWith(invokeCloseTag, currentCharIndex - invokeCloseTag.length + 1) ) { - // End of the tool use found. - // Special handling for content params *before* finalizing the - // tool. - const toolContentSlice = assistantMessage.slice( - currentToolUseStart, // From after the tool opening tag. - currentCharIndex - toolCloseTag.length + 1, // To before the tool closing tag. - ) - - // Check if content parameter needs special handling - // (write_to_file/new_rule). - // This check is important if the closing tag was - // missed by the parameter parsing logic (e.g., if content is - // empty or parsing logic prioritizes tool close). + // Special case for write_to_file content parameter const contentParamName: ToolParamName = "content" - if ( - currentToolUse.name === "write_to_file" /* || currentToolUse.name === "new_rule" */ && - // !(contentParamName in currentToolUse.params) && // Only if not already parsed. - toolContentSlice.includes(`<${contentParamName}>`) // Check if tag exists. - ) { - const contentStartTag = `<${contentParamName}>` - const contentEndTag = `` + if (currentToolUse.name === "write_to_file") { + const toolContentSlice = assistantMessage.slice( + currentToolUseStart, + currentCharIndex - invokeCloseTag.length + 1, + ) + const contentStartTag = `` + const contentEndTag = "" const contentStart = toolContentSlice.indexOf(contentStartTag) - - // Use `lastIndexOf` for robustness against nested tags. const contentEnd = toolContentSlice.lastIndexOf(contentEndTag) if (contentStart !== -1 && contentEnd !== -1 && contentEnd > contentStart) { - // Don't trim content to preserve newlines, but strip first and last newline only const contentValue = toolContentSlice .slice(contentStart + contentStartTag.length, contentEnd) .replace(/^\n/, "") @@ -155,98 +142,59 @@ export function parseAssistantMessageV2(assistantMessage: string): AssistantMess } } - currentToolUse.partial = false // Mark as complete. + // End of tool use + currentToolUse.partial = false contentBlocks.push(currentToolUse) - currentToolUse = undefined // Reset state. - currentTextContentStart = currentCharIndex + 1 // Potential text starts after this tag. - continue // Move to next char. + currentToolUse = undefined + continue } - // If not starting a param and not closing the tool, continue - // accumulating tool content implicitly. - continue - } - - // Parsing text / looking for tool start. - if (!currentToolUse) { - // Check if starting a new tool use. - let startedNewTool = false - - for (const [tag, toolName] of toolUseOpenTags.entries()) { - if ( - currentCharIndex >= tag.length - 1 && - assistantMessage.startsWith(tag, currentCharIndex - tag.length + 1) - ) { - // End current text block if one was active. - if (currentTextContent) { - currentTextContent.content = assistantMessage - .slice( - currentTextContentStart, // From where text started. - currentCharIndex - tag.length + 1, // To before the tool tag starts. - ) - .trim() - - currentTextContent.partial = false // Ended because tool started. - - if (currentTextContent.content.length > 0) { - contentBlocks.push(currentTextContent) - } - - currentTextContent = undefined - } else { - // Check for any text between the last block and this tag. - const potentialText = assistantMessage - .slice( - currentTextContentStart, // From where text *might* have started. - currentCharIndex - tag.length + 1, // To before the tool tag starts. - ) - .trim() - - if (potentialText.length > 0) { - contentBlocks.push({ - type: "text", - content: potentialText, - partial: false, - }) - } + // Check for opening tag + if (currentToolUse && !currentParamName) { + const paramMatch = assistantMessage + .slice(Math.max(0, currentCharIndex - 50), currentCharIndex + 1) + .match(/$/) + if (paramMatch) { + const paramName = paramMatch[1] + if (toolParamNames.includes(paramName as ToolParamName)) { + currentParamName = paramName as ToolParamName + currentParamValueStart = currentCharIndex + 1 } - - // Start the new tool use. - currentToolUse = { - type: "tool_use", - name: toolName, - params: {}, - partial: true, // Assume partial until closing tag is found. - } - - currentToolUseStart = currentCharIndex + 1 // Tool content starts after the opening tag. - startedNewTool = true - - break + continue } } - if (startedNewTool) { - continue // Handled start of tool, move to next char. + // Check for opening tag + if (!currentToolUse) { + const invokeMatch = assistantMessage + .slice(Math.max(0, currentCharIndex - 50), currentCharIndex + 1) + .match(/$/) + if (invokeMatch) { + const toolName = invokeMatch[1] + if (toolNames.includes(toolName as ToolName)) { + currentToolUse = { + type: "tool_use", + name: toolName as ToolName, + params: {}, + partial: true, + } + currentToolUseStart = currentCharIndex + 1 + } + continue + } } + } - // If not starting a tool, it must be text content. + // Outside function_calls, handle text content + if (!inFunctionCalls && !currentToolUse) { if (!currentTextContent) { - // Start a new text block if we aren't already in one. - currentTextContentStart = currentCharIndex // Text starts at the current character. - - // Check if the current char is the start of potential text *immediately* after a tag. - // This needs the previous state - simpler to let slicing handle it later. - // Resetting start index accurately is key. - // It should be the index *after* the last processed tag. - // The logic managing currentTextContentStart after closing tags handles this. + currentTextContentStart = currentCharIndex currentTextContent = { type: "text", - content: "", // Will be determined by slicing at the end or when a tool starts + content: "", partial: true, } } - // Continue accumulating text implicitly; content is extracted later. } } diff --git a/src/core/diff/strategies/__tests__/multi-search-replace.spec.ts b/src/core/diff/strategies/__tests__/multi-search-replace.spec.ts index b25286f5fa3f..a2806d9540bc 100644 --- a/src/core/diff/strategies/__tests__/multi-search-replace.spec.ts +++ b/src/core/diff/strategies/__tests__/multi-search-replace.spec.ts @@ -1059,8 +1059,8 @@ function sum(a, b) { expect(description).toContain("<<<<<<< SEARCH") expect(description).toContain("=======") expect(description).toContain(">>>>>>> REPLACE") - expect(description).toContain("") - expect(description).toContain("") + expect(description).toContain('') + expect(description).toContain("") }) }) diff --git a/src/core/diff/strategies/multi-file-search-replace.ts b/src/core/diff/strategies/multi-file-search-replace.ts index a212cf2b8e73..73b953b1e29c 100644 --- a/src/core/diff/strategies/multi-file-search-replace.ts +++ b/src/core/diff/strategies/multi-file-search-replace.ts @@ -134,8 +134,9 @@ Original file: \`\`\` Search/Replace content: - - + + + eg.file.py @@ -154,12 +155,14 @@ def calculate_total(items): ]]> - - + + + Search/Replace content with multi edits across multiple files: - - + + + eg.file.py @@ -199,13 +202,15 @@ def greet(name): ]]> - - + + + Usage: - - + + + File path here @@ -228,8 +233,9 @@ Each file requires its own path, start_line, and diff elements. 5 - -` + + +` } private unescapeMarkers(content: string): string { diff --git a/src/core/diff/strategies/multi-search-replace.ts b/src/core/diff/strategies/multi-search-replace.ts index a6a9913203c7..cf21c1c0277d 100644 --- a/src/core/diff/strategies/multi-search-replace.ts +++ b/src/core/diff/strategies/multi-search-replace.ts @@ -170,14 +170,16 @@ def calculate_sum(items): Usage: - -File path here - + + +File path here + Your search/replace content here You can use multi search/replace block in one diff block, but make sure to include the line numbers for each block. Only use a single line of '=======' between search and replacement content, because multiple '=======' will corrupt the file. - -` + + +` } private unescapeMarkers(content: string): string { diff --git a/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/architect-mode-prompt.snap b/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/architect-mode-prompt.snap index aa928fd50cf3..be4a5f89a0fc 100644 --- a/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/architect-mode-prompt.snap +++ b/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/architect-mode-prompt.snap @@ -4,7 +4,7 @@ You are Roo, an experienced technical leader who is inquisitive and an excellent MARKDOWN RULES -ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in +ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in attempt_completion ==== @@ -14,15 +14,16 @@ You have access to a set of tools that are executed upon the user's approval. Yo # Tool Use Formatting -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + -Always use the actual tool name as the XML tag name for proper parsing and execution. +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution. # Tools @@ -38,30 +39,35 @@ Parameters: Usage: - - + + + path/to/file - - + + + Examples: 1. Reading a single file: - - + + + src/app.ts - - + + + 2. Reading multiple files (within the 5-file limit): - - + + + src/app.ts @@ -70,17 +76,20 @@ Examples: src/utils.ts - - + + + 3. Reading an entire file: - - + + + config.json - - + + + IMPORTANT: You MUST use this Efficient Reading Strategy: - You MUST read all related files and implementations together in a single operation (up to 5 files at once) @@ -97,9 +106,11 @@ Parameters: Example: Requesting instructions to create an MCP Server - -create_mcp_server - + + +create_mcp_server + + ## search_files Description: Request to perform a regex search across files in a specified directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with encapsulating context. @@ -108,18 +119,22 @@ Parameters: - regex: (required) The regular expression pattern to search for. Uses Rust regex syntax. - file_pattern: (optional) Glob pattern to filter files (e.g., '*.ts' for TypeScript files). If not provided, it will search all files (*). Usage: - -Directory path here -Your regex pattern here -file pattern here (optional) - + + +Directory path here +Your regex pattern here +file pattern here (optional) + + Example: Requesting to search for all .ts files in the current directory - -. -.* -*.ts - + + +. +.* +*.ts + + ## list_files Description: Request to list files and directories within the specified directory. If recursive is true, it will list all files and directories recursively. If recursive is false or not provided, it will only list the top-level contents. Do not use this tool to confirm the existence of files you may have created, as the user will let you know if the files were created successfully or not. @@ -127,37 +142,47 @@ Parameters: - path: (required) The path of the directory to list contents for (relative to the current workspace directory /test/path) - recursive: (optional) Whether to list files recursively. Use true for recursive listing, false or omit for top-level only. Usage: - -Directory path here -true or false (optional) - + + +Directory path here +true or false (optional) + + Example: Requesting to list all files in the current directory - -. -false - + + +. +false + + ## list_code_definition_names Description: Request to list definition names (classes, functions, methods, etc.) from source code. This tool can analyze either a single file or all files at the top level of a specified directory. It provides insights into the codebase structure and important constructs, encapsulating high-level concepts and relationships that are crucial for understanding the overall architecture. Parameters: - path: (required) The path of the file or directory (relative to the current working directory /test/path) to analyze. When given a directory, it lists definitions from all top-level source files. Usage: - -Directory path here - + + +Directory path here + + Examples: 1. List definitions from a specific file: - -src/main.ts - + + +src/main.ts + + 2. List definitions from all files in a directory: - -src/ - + + +src/ + + ## write_to_file Description: Request to write content to a file. This tool is primarily used for **creating new files** or for scenarios where a **complete rewrite of an existing file is intentionally required**. If the file exists, it will be overwritten. If it doesn't exist, it will be created. This tool will automatically create any directories needed to write the file. @@ -166,18 +191,21 @@ Parameters: - content: (required) The content to write to the file. When performing a full rewrite of an existing file or creating a new one, ALWAYS provide the COMPLETE intended content of the file, without any truncation or omissions. You MUST include ALL parts of the file, even if they haven't been modified. Do NOT include the line numbers in the content though, just the actual content of the file. - line_count: (required) The number of lines in the file. Make sure to compute this based on the actual content of the file, not the number of lines in the content you're providing. Usage: - -File path here - + + +File path here + Your file content here - -total number of lines in the file, including empty lines - + +total number of lines in the file, including empty lines + + Example: Requesting to write to frontend-config.json - -frontend-config.json - + + +frontend-config.json + { "apiEndpoint": "https://api.example.com", "theme": { @@ -192,9 +220,10 @@ Example: Requesting to write to frontend-config.json }, "version": "1.0.0" } - -14 - + +14 + + ## insert_content Description: Use this tool specifically for adding new lines of content into a file without modifying existing content. Specify the line number to insert before, or use line 0 to append to the end. Ideal for adding imports, functions, configuration blocks, log entries, or any multi-line text block. @@ -207,23 +236,27 @@ Parameters: - content: (required) The content to insert at the specified line Example for inserting imports at start of file: - -src/utils.ts -1 - + + +src/utils.ts +1 + // Add imports at start of file import { sum } from './math'; - - + + + Example for appending to the end of file: - -src/utils.ts -0 - + + +src/utils.ts +0 + // This is the end of the file - - + + + ## search_and_replace @@ -247,20 +280,24 @@ Notes: Examples: 1. Simple text replacement: - -example.ts -oldText -newText - + + +example.ts +oldText +newText + + 2. Case-insensitive regex pattern: - -example.ts -oldw+ -new$& -true -true - + + +example.ts +oldw+ +new$& +true +true + + ## ask_followup_question Description: Ask the user a question to gather additional information needed to complete the task. Use when you need clarification or more details to proceed effectively. @@ -270,23 +307,27 @@ Parameters: - follow_up: (required) A list of 2-4 suggested answers, each in its own tag. Suggestions must be complete, actionable answers without placeholders. Optionally include mode attribute to switch modes (code/architect/etc.) Usage: - -Your question here - + + +Your question here + First suggestion Action with mode switch - - + + + Example: - -What is the path to the frontend-config.json file? - + + +What is the path to the frontend-config.json file? + ./src/frontend-config.json ./config/frontend-config.json ./frontend-config.json - - + + + ## attempt_completion Description: After each tool use, the user will respond with the result of that tool use, i.e. if it succeeded or failed, along with any reasons for failure. Once you've received the results of tool uses and can confirm that the task is complete, use this tool to present the result of your work to the user. The user may respond with feedback if they are not satisfied with the result, which you can use to make improvements and try again. @@ -294,18 +335,22 @@ IMPORTANT NOTE: This tool CANNOT be used until you've confirmed from the user th Parameters: - result: (required) The result of the task. Formulate this result in a way that is final and does not require further input from the user. Don't end your result with questions or offers for further assistance. Usage: - - + + + Your final result description here - - + + + Example: Requesting to attempt completion with a result - - + + + I've updated the CSS - - + + + ## switch_mode Description: Request to switch to a different mode. This tool allows modes to request switching to another mode when needed, such as switching to Code mode to make code changes. The user must approve the mode switch. @@ -313,16 +358,20 @@ Parameters: - mode_slug: (required) The slug of the mode to switch to (e.g., "code", "ask", "architect") - reason: (optional) The reason for switching modes Usage: - -Mode slug here -Reason for switching here - + + +Mode slug here +Reason for switching here + + Example: Requesting to switch to code mode - -code -Need to make code changes - + + +code +Need to make code changes + + ## new_task Description: This will let you create a new task instance in the chosen mode using your provided message. @@ -332,16 +381,20 @@ Parameters: - message: (required) The initial user message or instructions for this new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + + Example: - -code -Implement a new feature for the application - + + +code +Implement a new feature for the application + + ## update_todo_list @@ -373,27 +426,31 @@ Replace the entire TODO list with an updated checklist reflecting the current st - Remove tasks only if they are no longer relevant or if the user requests deletion. **Usage Example:** - - + + + [x] Analyze requirements [x] Design architecture [-] Implement core logic [ ] Write tests [ ] Update documentation - - + + + *After completing "Implement core logic" and starting "Write tests":* - - + + + [x] Analyze requirements [x] Design architecture [x] Implement core logic [-] Write tests [ ] Update documentation [ ] Add performance benchmarks - - + + + **When to Use:** - The task is complicated or involves multiple steps or requires ongoing tracking. @@ -459,7 +516,7 @@ MODES RULES - The project base directory is: /test/path -- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to . +- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to execute_command. - You cannot `cd` into a different directory to complete a task. You are stuck operating from '/test/path', so be sure to pass in the correct 'path' parameter when using tools that require a path. - Do not use the ~ character or $HOME to refer to the home directory. - Before using the execute_command tool, you must first think about the SYSTEM INFORMATION context provided to understand the user's environment and tailor your commands to ensure they are compatible with their system. You must also consider if the command you need to run should be executed in a specific directory outside of the current working directory '/test/path', and if so prepend with `cd`'ing into that directory && then executing the command (as one command since you are stuck operating from '/test/path'). For example, if you needed to run `npm install` in a project outside of '/test/path', you would need to prepend with a `cd` i.e. pseudocode for this would be `cd (path to project) && (command, in this case npm install)`. diff --git a/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/ask-mode-prompt.snap b/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/ask-mode-prompt.snap index 07dc1ff9de14..edbd5276cc80 100644 --- a/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/ask-mode-prompt.snap +++ b/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/ask-mode-prompt.snap @@ -4,7 +4,7 @@ You are Roo, a knowledgeable technical assistant focused on answering questions MARKDOWN RULES -ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in +ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in attempt_completion ==== @@ -14,15 +14,16 @@ You have access to a set of tools that are executed upon the user's approval. Yo # Tool Use Formatting -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + -Always use the actual tool name as the XML tag name for proper parsing and execution. +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution. # Tools @@ -38,30 +39,35 @@ Parameters: Usage: - - + + + path/to/file - - + + + Examples: 1. Reading a single file: - - + + + src/app.ts - - + + + 2. Reading multiple files (within the 5-file limit): - - + + + src/app.ts @@ -70,17 +76,20 @@ Examples: src/utils.ts - - + + + 3. Reading an entire file: - - + + + config.json - - + + + IMPORTANT: You MUST use this Efficient Reading Strategy: - You MUST read all related files and implementations together in a single operation (up to 5 files at once) @@ -97,9 +106,11 @@ Parameters: Example: Requesting instructions to create an MCP Server - -create_mcp_server - + + +create_mcp_server + + ## search_files Description: Request to perform a regex search across files in a specified directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with encapsulating context. @@ -108,18 +119,22 @@ Parameters: - regex: (required) The regular expression pattern to search for. Uses Rust regex syntax. - file_pattern: (optional) Glob pattern to filter files (e.g., '*.ts' for TypeScript files). If not provided, it will search all files (*). Usage: - -Directory path here -Your regex pattern here -file pattern here (optional) - + + +Directory path here +Your regex pattern here +file pattern here (optional) + + Example: Requesting to search for all .ts files in the current directory - -. -.* -*.ts - + + +. +.* +*.ts + + ## list_files Description: Request to list files and directories within the specified directory. If recursive is true, it will list all files and directories recursively. If recursive is false or not provided, it will only list the top-level contents. Do not use this tool to confirm the existence of files you may have created, as the user will let you know if the files were created successfully or not. @@ -127,37 +142,47 @@ Parameters: - path: (required) The path of the directory to list contents for (relative to the current workspace directory /test/path) - recursive: (optional) Whether to list files recursively. Use true for recursive listing, false or omit for top-level only. Usage: - -Directory path here -true or false (optional) - + + +Directory path here +true or false (optional) + + Example: Requesting to list all files in the current directory - -. -false - + + +. +false + + ## list_code_definition_names Description: Request to list definition names (classes, functions, methods, etc.) from source code. This tool can analyze either a single file or all files at the top level of a specified directory. It provides insights into the codebase structure and important constructs, encapsulating high-level concepts and relationships that are crucial for understanding the overall architecture. Parameters: - path: (required) The path of the file or directory (relative to the current working directory /test/path) to analyze. When given a directory, it lists definitions from all top-level source files. Usage: - -Directory path here - + + +Directory path here + + Examples: 1. List definitions from a specific file: - -src/main.ts - + + +src/main.ts + + 2. List definitions from all files in a directory: - -src/ - + + +src/ + + ## ask_followup_question Description: Ask the user a question to gather additional information needed to complete the task. Use when you need clarification or more details to proceed effectively. @@ -167,23 +192,27 @@ Parameters: - follow_up: (required) A list of 2-4 suggested answers, each in its own tag. Suggestions must be complete, actionable answers without placeholders. Optionally include mode attribute to switch modes (code/architect/etc.) Usage: - -Your question here - + + +Your question here + First suggestion Action with mode switch - - + + + Example: - -What is the path to the frontend-config.json file? - + + +What is the path to the frontend-config.json file? + ./src/frontend-config.json ./config/frontend-config.json ./frontend-config.json - - + + + ## attempt_completion Description: After each tool use, the user will respond with the result of that tool use, i.e. if it succeeded or failed, along with any reasons for failure. Once you've received the results of tool uses and can confirm that the task is complete, use this tool to present the result of your work to the user. The user may respond with feedback if they are not satisfied with the result, which you can use to make improvements and try again. @@ -191,18 +220,22 @@ IMPORTANT NOTE: This tool CANNOT be used until you've confirmed from the user th Parameters: - result: (required) The result of the task. Formulate this result in a way that is final and does not require further input from the user. Don't end your result with questions or offers for further assistance. Usage: - - + + + Your final result description here - - + + + Example: Requesting to attempt completion with a result - - + + + I've updated the CSS - - + + + ## switch_mode Description: Request to switch to a different mode. This tool allows modes to request switching to another mode when needed, such as switching to Code mode to make code changes. The user must approve the mode switch. @@ -210,16 +243,20 @@ Parameters: - mode_slug: (required) The slug of the mode to switch to (e.g., "code", "ask", "architect") - reason: (optional) The reason for switching modes Usage: - -Mode slug here -Reason for switching here - + + +Mode slug here +Reason for switching here + + Example: Requesting to switch to code mode - -code -Need to make code changes - + + +code +Need to make code changes + + ## new_task Description: This will let you create a new task instance in the chosen mode using your provided message. @@ -229,16 +266,20 @@ Parameters: - message: (required) The initial user message or instructions for this new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + + Example: - -code -Implement a new feature for the application - + + +code +Implement a new feature for the application + + ## update_todo_list @@ -270,27 +311,31 @@ Replace the entire TODO list with an updated checklist reflecting the current st - Remove tasks only if they are no longer relevant or if the user requests deletion. **Usage Example:** - - + + + [x] Analyze requirements [x] Design architecture [-] Implement core logic [ ] Write tests [ ] Update documentation - - + + + *After completing "Implement core logic" and starting "Write tests":* - - + + + [x] Analyze requirements [x] Design architecture [x] Implement core logic [-] Write tests [ ] Update documentation [ ] Add performance benchmarks - - + + + **When to Use:** - The task is complicated or involves multiple steps or requires ongoing tracking. @@ -356,7 +401,7 @@ MODES RULES - The project base directory is: /test/path -- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to . +- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to execute_command. - You cannot `cd` into a different directory to complete a task. You are stuck operating from '/test/path', so be sure to pass in the correct 'path' parameter when using tools that require a path. - Do not use the ~ character or $HOME to refer to the home directory. - Before using the execute_command tool, you must first think about the SYSTEM INFORMATION context provided to understand the user's environment and tailor your commands to ensure they are compatible with their system. You must also consider if the command you need to run should be executed in a specific directory outside of the current working directory '/test/path', and if so prepend with `cd`'ing into that directory && then executing the command (as one command since you are stuck operating from '/test/path'). For example, if you needed to run `npm install` in a project outside of '/test/path', you would need to prepend with a `cd` i.e. pseudocode for this would be `cd (path to project) && (command, in this case npm install)`. diff --git a/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/mcp-server-creation-disabled.snap b/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/mcp-server-creation-disabled.snap index 300c7a3565ea..c09702f0b9d3 100644 --- a/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/mcp-server-creation-disabled.snap +++ b/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/mcp-server-creation-disabled.snap @@ -4,7 +4,7 @@ You are Roo, an experienced technical leader who is inquisitive and an excellent MARKDOWN RULES -ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in +ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in attempt_completion ==== @@ -14,15 +14,16 @@ You have access to a set of tools that are executed upon the user's approval. Yo # Tool Use Formatting -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + -Always use the actual tool name as the XML tag name for proper parsing and execution. +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution. # Tools @@ -38,30 +39,35 @@ Parameters: Usage: - - + + + path/to/file - - + + + Examples: 1. Reading a single file: - - + + + src/app.ts - - + + + 2. Reading multiple files (within the 5-file limit): - - + + + src/app.ts @@ -70,17 +76,20 @@ Examples: src/utils.ts - - + + + 3. Reading an entire file: - - + + + config.json - - + + + IMPORTANT: You MUST use this Efficient Reading Strategy: - You MUST read all related files and implementations together in a single operation (up to 5 files at once) @@ -96,9 +105,11 @@ Parameters: Example: Requesting instructions to create a Mode - -create_mode - + + +create_mode + + ## search_files Description: Request to perform a regex search across files in a specified directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with encapsulating context. @@ -107,18 +118,22 @@ Parameters: - regex: (required) The regular expression pattern to search for. Uses Rust regex syntax. - file_pattern: (optional) Glob pattern to filter files (e.g., '*.ts' for TypeScript files). If not provided, it will search all files (*). Usage: - -Directory path here -Your regex pattern here -file pattern here (optional) - + + +Directory path here +Your regex pattern here +file pattern here (optional) + + Example: Requesting to search for all .ts files in the current directory - -. -.* -*.ts - + + +. +.* +*.ts + + ## list_files Description: Request to list files and directories within the specified directory. If recursive is true, it will list all files and directories recursively. If recursive is false or not provided, it will only list the top-level contents. Do not use this tool to confirm the existence of files you may have created, as the user will let you know if the files were created successfully or not. @@ -126,37 +141,47 @@ Parameters: - path: (required) The path of the directory to list contents for (relative to the current workspace directory /test/path) - recursive: (optional) Whether to list files recursively. Use true for recursive listing, false or omit for top-level only. Usage: - -Directory path here -true or false (optional) - + + +Directory path here +true or false (optional) + + Example: Requesting to list all files in the current directory - -. -false - + + +. +false + + ## list_code_definition_names Description: Request to list definition names (classes, functions, methods, etc.) from source code. This tool can analyze either a single file or all files at the top level of a specified directory. It provides insights into the codebase structure and important constructs, encapsulating high-level concepts and relationships that are crucial for understanding the overall architecture. Parameters: - path: (required) The path of the file or directory (relative to the current working directory /test/path) to analyze. When given a directory, it lists definitions from all top-level source files. Usage: - -Directory path here - + + +Directory path here + + Examples: 1. List definitions from a specific file: - -src/main.ts - + + +src/main.ts + + 2. List definitions from all files in a directory: - -src/ - + + +src/ + + ## write_to_file Description: Request to write content to a file. This tool is primarily used for **creating new files** or for scenarios where a **complete rewrite of an existing file is intentionally required**. If the file exists, it will be overwritten. If it doesn't exist, it will be created. This tool will automatically create any directories needed to write the file. @@ -165,18 +190,21 @@ Parameters: - content: (required) The content to write to the file. When performing a full rewrite of an existing file or creating a new one, ALWAYS provide the COMPLETE intended content of the file, without any truncation or omissions. You MUST include ALL parts of the file, even if they haven't been modified. Do NOT include the line numbers in the content though, just the actual content of the file. - line_count: (required) The number of lines in the file. Make sure to compute this based on the actual content of the file, not the number of lines in the content you're providing. Usage: - -File path here - + + +File path here + Your file content here - -total number of lines in the file, including empty lines - + +total number of lines in the file, including empty lines + + Example: Requesting to write to frontend-config.json - -frontend-config.json - + + +frontend-config.json + { "apiEndpoint": "https://api.example.com", "theme": { @@ -191,9 +219,10 @@ Example: Requesting to write to frontend-config.json }, "version": "1.0.0" } - -14 - + +14 + + ## insert_content Description: Use this tool specifically for adding new lines of content into a file without modifying existing content. Specify the line number to insert before, or use line 0 to append to the end. Ideal for adding imports, functions, configuration blocks, log entries, or any multi-line text block. @@ -206,23 +235,27 @@ Parameters: - content: (required) The content to insert at the specified line Example for inserting imports at start of file: - -src/utils.ts -1 - + + +src/utils.ts +1 + // Add imports at start of file import { sum } from './math'; - - + + + Example for appending to the end of file: - -src/utils.ts -0 - + + +src/utils.ts +0 + // This is the end of the file - - + + + ## search_and_replace @@ -246,20 +279,24 @@ Notes: Examples: 1. Simple text replacement: - -example.ts -oldText -newText - + + +example.ts +oldText +newText + + 2. Case-insensitive regex pattern: - -example.ts -oldw+ -new$& -true -true - + + +example.ts +oldw+ +new$& +true +true + + ## ask_followup_question Description: Ask the user a question to gather additional information needed to complete the task. Use when you need clarification or more details to proceed effectively. @@ -269,23 +306,27 @@ Parameters: - follow_up: (required) A list of 2-4 suggested answers, each in its own tag. Suggestions must be complete, actionable answers without placeholders. Optionally include mode attribute to switch modes (code/architect/etc.) Usage: - -Your question here - + + +Your question here + First suggestion Action with mode switch - - + + + Example: - -What is the path to the frontend-config.json file? - + + +What is the path to the frontend-config.json file? + ./src/frontend-config.json ./config/frontend-config.json ./frontend-config.json - - + + + ## attempt_completion Description: After each tool use, the user will respond with the result of that tool use, i.e. if it succeeded or failed, along with any reasons for failure. Once you've received the results of tool uses and can confirm that the task is complete, use this tool to present the result of your work to the user. The user may respond with feedback if they are not satisfied with the result, which you can use to make improvements and try again. @@ -293,18 +334,22 @@ IMPORTANT NOTE: This tool CANNOT be used until you've confirmed from the user th Parameters: - result: (required) The result of the task. Formulate this result in a way that is final and does not require further input from the user. Don't end your result with questions or offers for further assistance. Usage: - - + + + Your final result description here - - + + + Example: Requesting to attempt completion with a result - - + + + I've updated the CSS - - + + + ## switch_mode Description: Request to switch to a different mode. This tool allows modes to request switching to another mode when needed, such as switching to Code mode to make code changes. The user must approve the mode switch. @@ -312,16 +357,20 @@ Parameters: - mode_slug: (required) The slug of the mode to switch to (e.g., "code", "ask", "architect") - reason: (optional) The reason for switching modes Usage: - -Mode slug here -Reason for switching here - + + +Mode slug here +Reason for switching here + + Example: Requesting to switch to code mode - -code -Need to make code changes - + + +code +Need to make code changes + + ## new_task Description: This will let you create a new task instance in the chosen mode using your provided message. @@ -331,16 +380,20 @@ Parameters: - message: (required) The initial user message or instructions for this new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + + Example: - -code -Implement a new feature for the application - + + +code +Implement a new feature for the application + + ## update_todo_list @@ -372,27 +425,31 @@ Replace the entire TODO list with an updated checklist reflecting the current st - Remove tasks only if they are no longer relevant or if the user requests deletion. **Usage Example:** - - + + + [x] Analyze requirements [x] Design architecture [-] Implement core logic [ ] Write tests [ ] Update documentation - - + + + *After completing "Implement core logic" and starting "Write tests":* - - + + + [x] Analyze requirements [x] Design architecture [x] Implement core logic [-] Write tests [ ] Update documentation [ ] Add performance benchmarks - - + + + **When to Use:** - The task is complicated or involves multiple steps or requires ongoing tracking. @@ -458,7 +515,7 @@ MODES RULES - The project base directory is: /test/path -- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to . +- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to execute_command. - You cannot `cd` into a different directory to complete a task. You are stuck operating from '/test/path', so be sure to pass in the correct 'path' parameter when using tools that require a path. - Do not use the ~ character or $HOME to refer to the home directory. - Before using the execute_command tool, you must first think about the SYSTEM INFORMATION context provided to understand the user's environment and tailor your commands to ensure they are compatible with their system. You must also consider if the command you need to run should be executed in a specific directory outside of the current working directory '/test/path', and if so prepend with `cd`'ing into that directory && then executing the command (as one command since you are stuck operating from '/test/path'). For example, if you needed to run `npm install` in a project outside of '/test/path', you would need to prepend with a `cd` i.e. pseudocode for this would be `cd (path to project) && (command, in this case npm install)`. diff --git a/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/mcp-server-creation-enabled.snap b/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/mcp-server-creation-enabled.snap index ec5304a2b2ad..cf1240f9e0f1 100644 --- a/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/mcp-server-creation-enabled.snap +++ b/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/mcp-server-creation-enabled.snap @@ -4,7 +4,7 @@ You are Roo, an experienced technical leader who is inquisitive and an excellent MARKDOWN RULES -ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in +ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in attempt_completion ==== @@ -14,15 +14,16 @@ You have access to a set of tools that are executed upon the user's approval. Yo # Tool Use Formatting -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + -Always use the actual tool name as the XML tag name for proper parsing and execution. +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution. # Tools @@ -38,30 +39,35 @@ Parameters: Usage: - - + + + path/to/file - - + + + Examples: 1. Reading a single file: - - + + + src/app.ts - - + + + 2. Reading multiple files (within the 5-file limit): - - + + + src/app.ts @@ -70,17 +76,20 @@ Examples: src/utils.ts - - + + + 3. Reading an entire file: - - + + + config.json - - + + + IMPORTANT: You MUST use this Efficient Reading Strategy: - You MUST read all related files and implementations together in a single operation (up to 5 files at once) @@ -97,9 +106,11 @@ Parameters: Example: Requesting instructions to create an MCP Server - -create_mcp_server - + + +create_mcp_server + + ## search_files Description: Request to perform a regex search across files in a specified directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with encapsulating context. @@ -108,18 +119,22 @@ Parameters: - regex: (required) The regular expression pattern to search for. Uses Rust regex syntax. - file_pattern: (optional) Glob pattern to filter files (e.g., '*.ts' for TypeScript files). If not provided, it will search all files (*). Usage: - -Directory path here -Your regex pattern here -file pattern here (optional) - + + +Directory path here +Your regex pattern here +file pattern here (optional) + + Example: Requesting to search for all .ts files in the current directory - -. -.* -*.ts - + + +. +.* +*.ts + + ## list_files Description: Request to list files and directories within the specified directory. If recursive is true, it will list all files and directories recursively. If recursive is false or not provided, it will only list the top-level contents. Do not use this tool to confirm the existence of files you may have created, as the user will let you know if the files were created successfully or not. @@ -127,37 +142,47 @@ Parameters: - path: (required) The path of the directory to list contents for (relative to the current workspace directory /test/path) - recursive: (optional) Whether to list files recursively. Use true for recursive listing, false or omit for top-level only. Usage: - -Directory path here -true or false (optional) - + + +Directory path here +true or false (optional) + + Example: Requesting to list all files in the current directory - -. -false - + + +. +false + + ## list_code_definition_names Description: Request to list definition names (classes, functions, methods, etc.) from source code. This tool can analyze either a single file or all files at the top level of a specified directory. It provides insights into the codebase structure and important constructs, encapsulating high-level concepts and relationships that are crucial for understanding the overall architecture. Parameters: - path: (required) The path of the file or directory (relative to the current working directory /test/path) to analyze. When given a directory, it lists definitions from all top-level source files. Usage: - -Directory path here - + + +Directory path here + + Examples: 1. List definitions from a specific file: - -src/main.ts - + + +src/main.ts + + 2. List definitions from all files in a directory: - -src/ - + + +src/ + + ## write_to_file Description: Request to write content to a file. This tool is primarily used for **creating new files** or for scenarios where a **complete rewrite of an existing file is intentionally required**. If the file exists, it will be overwritten. If it doesn't exist, it will be created. This tool will automatically create any directories needed to write the file. @@ -166,18 +191,21 @@ Parameters: - content: (required) The content to write to the file. When performing a full rewrite of an existing file or creating a new one, ALWAYS provide the COMPLETE intended content of the file, without any truncation or omissions. You MUST include ALL parts of the file, even if they haven't been modified. Do NOT include the line numbers in the content though, just the actual content of the file. - line_count: (required) The number of lines in the file. Make sure to compute this based on the actual content of the file, not the number of lines in the content you're providing. Usage: - -File path here - + + +File path here + Your file content here - -total number of lines in the file, including empty lines - + +total number of lines in the file, including empty lines + + Example: Requesting to write to frontend-config.json - -frontend-config.json - + + +frontend-config.json + { "apiEndpoint": "https://api.example.com", "theme": { @@ -192,9 +220,10 @@ Example: Requesting to write to frontend-config.json }, "version": "1.0.0" } - -14 - + +14 + + ## insert_content Description: Use this tool specifically for adding new lines of content into a file without modifying existing content. Specify the line number to insert before, or use line 0 to append to the end. Ideal for adding imports, functions, configuration blocks, log entries, or any multi-line text block. @@ -207,23 +236,27 @@ Parameters: - content: (required) The content to insert at the specified line Example for inserting imports at start of file: - -src/utils.ts -1 - + + +src/utils.ts +1 + // Add imports at start of file import { sum } from './math'; - - + + + Example for appending to the end of file: - -src/utils.ts -0 - + + +src/utils.ts +0 + // This is the end of the file - - + + + ## search_and_replace @@ -247,20 +280,24 @@ Notes: Examples: 1. Simple text replacement: - -example.ts -oldText -newText - + + +example.ts +oldText +newText + + 2. Case-insensitive regex pattern: - -example.ts -oldw+ -new$& -true -true - + + +example.ts +oldw+ +new$& +true +true + + ## use_mcp_tool Description: Request to use a tool provided by a connected MCP server. Each MCP server can provide multiple tools with different capabilities. Tools have defined input schemas that specify required and optional parameters. @@ -269,29 +306,33 @@ Parameters: - tool_name: (required) The name of the tool to execute - arguments: (required) A JSON object containing the tool's input parameters, following the tool's input schema Usage: - -server name here -tool name here - + + +server name here +tool name here + { "param1": "value1", "param2": "value2" } - - + + + Example: Requesting to use an MCP tool - -weather-server -get_forecast - + + +weather-server +get_forecast + { "city": "San Francisco", "days": 5 } - - + + + ## access_mcp_resource Description: Request to access a resource provided by a connected MCP server. Resources represent data sources that can be used as context, such as files, API responses, or system information. @@ -299,17 +340,21 @@ Parameters: - server_name: (required) The name of the MCP server providing the resource - uri: (required) The URI identifying the specific resource to access Usage: - -server name here -resource URI here - + + +server name here +resource URI here + + Example: Requesting to access an MCP resource - -weather-server -weather://san-francisco/current - + + +weather-server +weather://san-francisco/current + + ## ask_followup_question Description: Ask the user a question to gather additional information needed to complete the task. Use when you need clarification or more details to proceed effectively. @@ -319,23 +364,27 @@ Parameters: - follow_up: (required) A list of 2-4 suggested answers, each in its own tag. Suggestions must be complete, actionable answers without placeholders. Optionally include mode attribute to switch modes (code/architect/etc.) Usage: - -Your question here - + + +Your question here + First suggestion Action with mode switch - - + + + Example: - -What is the path to the frontend-config.json file? - + + +What is the path to the frontend-config.json file? + ./src/frontend-config.json ./config/frontend-config.json ./frontend-config.json - - + + + ## attempt_completion Description: After each tool use, the user will respond with the result of that tool use, i.e. if it succeeded or failed, along with any reasons for failure. Once you've received the results of tool uses and can confirm that the task is complete, use this tool to present the result of your work to the user. The user may respond with feedback if they are not satisfied with the result, which you can use to make improvements and try again. @@ -343,18 +392,22 @@ IMPORTANT NOTE: This tool CANNOT be used until you've confirmed from the user th Parameters: - result: (required) The result of the task. Formulate this result in a way that is final and does not require further input from the user. Don't end your result with questions or offers for further assistance. Usage: - - + + + Your final result description here - - + + + Example: Requesting to attempt completion with a result - - + + + I've updated the CSS - - + + + ## switch_mode Description: Request to switch to a different mode. This tool allows modes to request switching to another mode when needed, such as switching to Code mode to make code changes. The user must approve the mode switch. @@ -362,16 +415,20 @@ Parameters: - mode_slug: (required) The slug of the mode to switch to (e.g., "code", "ask", "architect") - reason: (optional) The reason for switching modes Usage: - -Mode slug here -Reason for switching here - + + +Mode slug here +Reason for switching here + + Example: Requesting to switch to code mode - -code -Need to make code changes - + + +code +Need to make code changes + + ## new_task Description: This will let you create a new task instance in the chosen mode using your provided message. @@ -381,16 +438,20 @@ Parameters: - message: (required) The initial user message or instructions for this new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + + Example: - -code -Implement a new feature for the application - + + +code +Implement a new feature for the application + + ## update_todo_list @@ -422,27 +483,31 @@ Replace the entire TODO list with an updated checklist reflecting the current st - Remove tasks only if they are no longer relevant or if the user requests deletion. **Usage Example:** - - + + + [x] Analyze requirements [x] Design architecture [-] Implement core logic [ ] Write tests [ ] Update documentation - - + + + *After completing "Implement core logic" and starting "Write tests":* - - + + + [x] Analyze requirements [x] Design architecture [x] Implement core logic [-] Write tests [ ] Update documentation [ ] Add performance benchmarks - - + + + **When to Use:** - The task is complicated or involves multiple steps or requires ongoing tracking. @@ -499,9 +564,11 @@ When a server is connected, you can use the server's tools via the `use_mcp_tool ## Creating an MCP Server The user may ask you something along the lines of "add a tool" that does some function, in other words to create an MCP server that provides tools and resources that may connect to external APIs for example. If they do, you should obtain detailed instructions on this topic using the fetch_instructions tool, like this: - -create_mcp_server - + + +create_mcp_server + + ==== @@ -527,7 +594,7 @@ MODES RULES - The project base directory is: /test/path -- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to . +- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to execute_command. - You cannot `cd` into a different directory to complete a task. You are stuck operating from '/test/path', so be sure to pass in the correct 'path' parameter when using tools that require a path. - Do not use the ~ character or $HOME to refer to the home directory. - Before using the execute_command tool, you must first think about the SYSTEM INFORMATION context provided to understand the user's environment and tailor your commands to ensure they are compatible with their system. You must also consider if the command you need to run should be executed in a specific directory outside of the current working directory '/test/path', and if so prepend with `cd`'ing into that directory && then executing the command (as one command since you are stuck operating from '/test/path'). For example, if you needed to run `npm install` in a project outside of '/test/path', you would need to prepend with a `cd` i.e. pseudocode for this would be `cd (path to project) && (command, in this case npm install)`. diff --git a/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/partial-reads-enabled.snap b/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/partial-reads-enabled.snap index bf584f2691cf..e07624fa1c49 100644 --- a/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/partial-reads-enabled.snap +++ b/src/core/prompts/__tests__/__snapshots__/add-custom-instructions/partial-reads-enabled.snap @@ -4,7 +4,7 @@ You are Roo, an experienced technical leader who is inquisitive and an excellent MARKDOWN RULES -ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in +ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in attempt_completion ==== @@ -14,15 +14,16 @@ You have access to a set of tools that are executed upon the user's approval. Yo # Tool Use Formatting -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + -Always use the actual tool name as the XML tag name for proper parsing and execution. +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution. # Tools @@ -38,30 +39,35 @@ Parameters: - line_range: (optional) One or more line range elements in format "start-end" (1-based, inclusive) Usage: - - + + + path/to/file start-end - - + + + Examples: 1. Reading a single file: - - + + + src/app.ts 1-1000 - - + + + 2. Reading multiple files (within the 5-file limit): - - + + + src/app.ts 1-50 @@ -71,17 +77,20 @@ Examples: src/utils.ts 10-20 - - + + + 3. Reading an entire file: - - + + + config.json - - + + + IMPORTANT: You MUST use this Efficient Reading Strategy: - You MUST read all related files and implementations together in a single operation (up to 5 files at once) @@ -102,9 +111,11 @@ Parameters: Example: Requesting instructions to create an MCP Server - -create_mcp_server - + + +create_mcp_server + + ## search_files Description: Request to perform a regex search across files in a specified directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with encapsulating context. @@ -113,18 +124,22 @@ Parameters: - regex: (required) The regular expression pattern to search for. Uses Rust regex syntax. - file_pattern: (optional) Glob pattern to filter files (e.g., '*.ts' for TypeScript files). If not provided, it will search all files (*). Usage: - -Directory path here -Your regex pattern here -file pattern here (optional) - + + +Directory path here +Your regex pattern here +file pattern here (optional) + + Example: Requesting to search for all .ts files in the current directory - -. -.* -*.ts - + + +. +.* +*.ts + + ## list_files Description: Request to list files and directories within the specified directory. If recursive is true, it will list all files and directories recursively. If recursive is false or not provided, it will only list the top-level contents. Do not use this tool to confirm the existence of files you may have created, as the user will let you know if the files were created successfully or not. @@ -132,37 +147,47 @@ Parameters: - path: (required) The path of the directory to list contents for (relative to the current workspace directory /test/path) - recursive: (optional) Whether to list files recursively. Use true for recursive listing, false or omit for top-level only. Usage: - -Directory path here -true or false (optional) - + + +Directory path here +true or false (optional) + + Example: Requesting to list all files in the current directory - -. -false - + + +. +false + + ## list_code_definition_names Description: Request to list definition names (classes, functions, methods, etc.) from source code. This tool can analyze either a single file or all files at the top level of a specified directory. It provides insights into the codebase structure and important constructs, encapsulating high-level concepts and relationships that are crucial for understanding the overall architecture. Parameters: - path: (required) The path of the file or directory (relative to the current working directory /test/path) to analyze. When given a directory, it lists definitions from all top-level source files. Usage: - -Directory path here - + + +Directory path here + + Examples: 1. List definitions from a specific file: - -src/main.ts - + + +src/main.ts + + 2. List definitions from all files in a directory: - -src/ - + + +src/ + + ## write_to_file Description: Request to write content to a file. This tool is primarily used for **creating new files** or for scenarios where a **complete rewrite of an existing file is intentionally required**. If the file exists, it will be overwritten. If it doesn't exist, it will be created. This tool will automatically create any directories needed to write the file. @@ -171,18 +196,21 @@ Parameters: - content: (required) The content to write to the file. When performing a full rewrite of an existing file or creating a new one, ALWAYS provide the COMPLETE intended content of the file, without any truncation or omissions. You MUST include ALL parts of the file, even if they haven't been modified. Do NOT include the line numbers in the content though, just the actual content of the file. - line_count: (required) The number of lines in the file. Make sure to compute this based on the actual content of the file, not the number of lines in the content you're providing. Usage: - -File path here - + + +File path here + Your file content here - -total number of lines in the file, including empty lines - + +total number of lines in the file, including empty lines + + Example: Requesting to write to frontend-config.json - -frontend-config.json - + + +frontend-config.json + { "apiEndpoint": "https://api.example.com", "theme": { @@ -197,9 +225,10 @@ Example: Requesting to write to frontend-config.json }, "version": "1.0.0" } - -14 - + +14 + + ## insert_content Description: Use this tool specifically for adding new lines of content into a file without modifying existing content. Specify the line number to insert before, or use line 0 to append to the end. Ideal for adding imports, functions, configuration blocks, log entries, or any multi-line text block. @@ -212,23 +241,27 @@ Parameters: - content: (required) The content to insert at the specified line Example for inserting imports at start of file: - -src/utils.ts -1 - + + +src/utils.ts +1 + // Add imports at start of file import { sum } from './math'; - - + + + Example for appending to the end of file: - -src/utils.ts -0 - + + +src/utils.ts +0 + // This is the end of the file - - + + + ## search_and_replace @@ -252,20 +285,24 @@ Notes: Examples: 1. Simple text replacement: - -example.ts -oldText -newText - + + +example.ts +oldText +newText + + 2. Case-insensitive regex pattern: - -example.ts -oldw+ -new$& -true -true - + + +example.ts +oldw+ +new$& +true +true + + ## ask_followup_question Description: Ask the user a question to gather additional information needed to complete the task. Use when you need clarification or more details to proceed effectively. @@ -275,23 +312,27 @@ Parameters: - follow_up: (required) A list of 2-4 suggested answers, each in its own tag. Suggestions must be complete, actionable answers without placeholders. Optionally include mode attribute to switch modes (code/architect/etc.) Usage: - -Your question here - + + +Your question here + First suggestion Action with mode switch - - + + + Example: - -What is the path to the frontend-config.json file? - + + +What is the path to the frontend-config.json file? + ./src/frontend-config.json ./config/frontend-config.json ./frontend-config.json - - + + + ## attempt_completion Description: After each tool use, the user will respond with the result of that tool use, i.e. if it succeeded or failed, along with any reasons for failure. Once you've received the results of tool uses and can confirm that the task is complete, use this tool to present the result of your work to the user. The user may respond with feedback if they are not satisfied with the result, which you can use to make improvements and try again. @@ -299,18 +340,22 @@ IMPORTANT NOTE: This tool CANNOT be used until you've confirmed from the user th Parameters: - result: (required) The result of the task. Formulate this result in a way that is final and does not require further input from the user. Don't end your result with questions or offers for further assistance. Usage: - - + + + Your final result description here - - + + + Example: Requesting to attempt completion with a result - - + + + I've updated the CSS - - + + + ## switch_mode Description: Request to switch to a different mode. This tool allows modes to request switching to another mode when needed, such as switching to Code mode to make code changes. The user must approve the mode switch. @@ -318,16 +363,20 @@ Parameters: - mode_slug: (required) The slug of the mode to switch to (e.g., "code", "ask", "architect") - reason: (optional) The reason for switching modes Usage: - -Mode slug here -Reason for switching here - + + +Mode slug here +Reason for switching here + + Example: Requesting to switch to code mode - -code -Need to make code changes - + + +code +Need to make code changes + + ## new_task Description: This will let you create a new task instance in the chosen mode using your provided message. @@ -337,16 +386,20 @@ Parameters: - message: (required) The initial user message or instructions for this new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + + Example: - -code -Implement a new feature for the application - + + +code +Implement a new feature for the application + + ## update_todo_list @@ -378,27 +431,31 @@ Replace the entire TODO list with an updated checklist reflecting the current st - Remove tasks only if they are no longer relevant or if the user requests deletion. **Usage Example:** - - + + + [x] Analyze requirements [x] Design architecture [-] Implement core logic [ ] Write tests [ ] Update documentation - - + + + *After completing "Implement core logic" and starting "Write tests":* - - + + + [x] Analyze requirements [x] Design architecture [x] Implement core logic [-] Write tests [ ] Update documentation [ ] Add performance benchmarks - - + + + **When to Use:** - The task is complicated or involves multiple steps or requires ongoing tracking. @@ -464,7 +521,7 @@ MODES RULES - The project base directory is: /test/path -- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to . +- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to execute_command. - You cannot `cd` into a different directory to complete a task. You are stuck operating from '/test/path', so be sure to pass in the correct 'path' parameter when using tools that require a path. - Do not use the ~ character or $HOME to refer to the home directory. - Before using the execute_command tool, you must first think about the SYSTEM INFORMATION context provided to understand the user's environment and tailor your commands to ensure they are compatible with their system. You must also consider if the command you need to run should be executed in a specific directory outside of the current working directory '/test/path', and if so prepend with `cd`'ing into that directory && then executing the command (as one command since you are stuck operating from '/test/path'). For example, if you needed to run `npm install` in a project outside of '/test/path', you would need to prepend with a `cd` i.e. pseudocode for this would be `cd (path to project) && (command, in this case npm install)`. diff --git a/src/core/prompts/__tests__/__snapshots__/system-prompt/consistent-system-prompt.snap b/src/core/prompts/__tests__/__snapshots__/system-prompt/consistent-system-prompt.snap index aa928fd50cf3..be4a5f89a0fc 100644 --- a/src/core/prompts/__tests__/__snapshots__/system-prompt/consistent-system-prompt.snap +++ b/src/core/prompts/__tests__/__snapshots__/system-prompt/consistent-system-prompt.snap @@ -4,7 +4,7 @@ You are Roo, an experienced technical leader who is inquisitive and an excellent MARKDOWN RULES -ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in +ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in attempt_completion ==== @@ -14,15 +14,16 @@ You have access to a set of tools that are executed upon the user's approval. Yo # Tool Use Formatting -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + -Always use the actual tool name as the XML tag name for proper parsing and execution. +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution. # Tools @@ -38,30 +39,35 @@ Parameters: Usage: - - + + + path/to/file - - + + + Examples: 1. Reading a single file: - - + + + src/app.ts - - + + + 2. Reading multiple files (within the 5-file limit): - - + + + src/app.ts @@ -70,17 +76,20 @@ Examples: src/utils.ts - - + + + 3. Reading an entire file: - - + + + config.json - - + + + IMPORTANT: You MUST use this Efficient Reading Strategy: - You MUST read all related files and implementations together in a single operation (up to 5 files at once) @@ -97,9 +106,11 @@ Parameters: Example: Requesting instructions to create an MCP Server - -create_mcp_server - + + +create_mcp_server + + ## search_files Description: Request to perform a regex search across files in a specified directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with encapsulating context. @@ -108,18 +119,22 @@ Parameters: - regex: (required) The regular expression pattern to search for. Uses Rust regex syntax. - file_pattern: (optional) Glob pattern to filter files (e.g., '*.ts' for TypeScript files). If not provided, it will search all files (*). Usage: - -Directory path here -Your regex pattern here -file pattern here (optional) - + + +Directory path here +Your regex pattern here +file pattern here (optional) + + Example: Requesting to search for all .ts files in the current directory - -. -.* -*.ts - + + +. +.* +*.ts + + ## list_files Description: Request to list files and directories within the specified directory. If recursive is true, it will list all files and directories recursively. If recursive is false or not provided, it will only list the top-level contents. Do not use this tool to confirm the existence of files you may have created, as the user will let you know if the files were created successfully or not. @@ -127,37 +142,47 @@ Parameters: - path: (required) The path of the directory to list contents for (relative to the current workspace directory /test/path) - recursive: (optional) Whether to list files recursively. Use true for recursive listing, false or omit for top-level only. Usage: - -Directory path here -true or false (optional) - + + +Directory path here +true or false (optional) + + Example: Requesting to list all files in the current directory - -. -false - + + +. +false + + ## list_code_definition_names Description: Request to list definition names (classes, functions, methods, etc.) from source code. This tool can analyze either a single file or all files at the top level of a specified directory. It provides insights into the codebase structure and important constructs, encapsulating high-level concepts and relationships that are crucial for understanding the overall architecture. Parameters: - path: (required) The path of the file or directory (relative to the current working directory /test/path) to analyze. When given a directory, it lists definitions from all top-level source files. Usage: - -Directory path here - + + +Directory path here + + Examples: 1. List definitions from a specific file: - -src/main.ts - + + +src/main.ts + + 2. List definitions from all files in a directory: - -src/ - + + +src/ + + ## write_to_file Description: Request to write content to a file. This tool is primarily used for **creating new files** or for scenarios where a **complete rewrite of an existing file is intentionally required**. If the file exists, it will be overwritten. If it doesn't exist, it will be created. This tool will automatically create any directories needed to write the file. @@ -166,18 +191,21 @@ Parameters: - content: (required) The content to write to the file. When performing a full rewrite of an existing file or creating a new one, ALWAYS provide the COMPLETE intended content of the file, without any truncation or omissions. You MUST include ALL parts of the file, even if they haven't been modified. Do NOT include the line numbers in the content though, just the actual content of the file. - line_count: (required) The number of lines in the file. Make sure to compute this based on the actual content of the file, not the number of lines in the content you're providing. Usage: - -File path here - + + +File path here + Your file content here - -total number of lines in the file, including empty lines - + +total number of lines in the file, including empty lines + + Example: Requesting to write to frontend-config.json - -frontend-config.json - + + +frontend-config.json + { "apiEndpoint": "https://api.example.com", "theme": { @@ -192,9 +220,10 @@ Example: Requesting to write to frontend-config.json }, "version": "1.0.0" } - -14 - + +14 + + ## insert_content Description: Use this tool specifically for adding new lines of content into a file without modifying existing content. Specify the line number to insert before, or use line 0 to append to the end. Ideal for adding imports, functions, configuration blocks, log entries, or any multi-line text block. @@ -207,23 +236,27 @@ Parameters: - content: (required) The content to insert at the specified line Example for inserting imports at start of file: - -src/utils.ts -1 - + + +src/utils.ts +1 + // Add imports at start of file import { sum } from './math'; - - + + + Example for appending to the end of file: - -src/utils.ts -0 - + + +src/utils.ts +0 + // This is the end of the file - - + + + ## search_and_replace @@ -247,20 +280,24 @@ Notes: Examples: 1. Simple text replacement: - -example.ts -oldText -newText - + + +example.ts +oldText +newText + + 2. Case-insensitive regex pattern: - -example.ts -oldw+ -new$& -true -true - + + +example.ts +oldw+ +new$& +true +true + + ## ask_followup_question Description: Ask the user a question to gather additional information needed to complete the task. Use when you need clarification or more details to proceed effectively. @@ -270,23 +307,27 @@ Parameters: - follow_up: (required) A list of 2-4 suggested answers, each in its own tag. Suggestions must be complete, actionable answers without placeholders. Optionally include mode attribute to switch modes (code/architect/etc.) Usage: - -Your question here - + + +Your question here + First suggestion Action with mode switch - - + + + Example: - -What is the path to the frontend-config.json file? - + + +What is the path to the frontend-config.json file? + ./src/frontend-config.json ./config/frontend-config.json ./frontend-config.json - - + + + ## attempt_completion Description: After each tool use, the user will respond with the result of that tool use, i.e. if it succeeded or failed, along with any reasons for failure. Once you've received the results of tool uses and can confirm that the task is complete, use this tool to present the result of your work to the user. The user may respond with feedback if they are not satisfied with the result, which you can use to make improvements and try again. @@ -294,18 +335,22 @@ IMPORTANT NOTE: This tool CANNOT be used until you've confirmed from the user th Parameters: - result: (required) The result of the task. Formulate this result in a way that is final and does not require further input from the user. Don't end your result with questions or offers for further assistance. Usage: - - + + + Your final result description here - - + + + Example: Requesting to attempt completion with a result - - + + + I've updated the CSS - - + + + ## switch_mode Description: Request to switch to a different mode. This tool allows modes to request switching to another mode when needed, such as switching to Code mode to make code changes. The user must approve the mode switch. @@ -313,16 +358,20 @@ Parameters: - mode_slug: (required) The slug of the mode to switch to (e.g., "code", "ask", "architect") - reason: (optional) The reason for switching modes Usage: - -Mode slug here -Reason for switching here - + + +Mode slug here +Reason for switching here + + Example: Requesting to switch to code mode - -code -Need to make code changes - + + +code +Need to make code changes + + ## new_task Description: This will let you create a new task instance in the chosen mode using your provided message. @@ -332,16 +381,20 @@ Parameters: - message: (required) The initial user message or instructions for this new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + + Example: - -code -Implement a new feature for the application - + + +code +Implement a new feature for the application + + ## update_todo_list @@ -373,27 +426,31 @@ Replace the entire TODO list with an updated checklist reflecting the current st - Remove tasks only if they are no longer relevant or if the user requests deletion. **Usage Example:** - - + + + [x] Analyze requirements [x] Design architecture [-] Implement core logic [ ] Write tests [ ] Update documentation - - + + + *After completing "Implement core logic" and starting "Write tests":* - - + + + [x] Analyze requirements [x] Design architecture [x] Implement core logic [-] Write tests [ ] Update documentation [ ] Add performance benchmarks - - + + + **When to Use:** - The task is complicated or involves multiple steps or requires ongoing tracking. @@ -459,7 +516,7 @@ MODES RULES - The project base directory is: /test/path -- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to . +- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to execute_command. - You cannot `cd` into a different directory to complete a task. You are stuck operating from '/test/path', so be sure to pass in the correct 'path' parameter when using tools that require a path. - Do not use the ~ character or $HOME to refer to the home directory. - Before using the execute_command tool, you must first think about the SYSTEM INFORMATION context provided to understand the user's environment and tailor your commands to ensure they are compatible with their system. You must also consider if the command you need to run should be executed in a specific directory outside of the current working directory '/test/path', and if so prepend with `cd`'ing into that directory && then executing the command (as one command since you are stuck operating from '/test/path'). For example, if you needed to run `npm install` in a project outside of '/test/path', you would need to prepend with a `cd` i.e. pseudocode for this would be `cd (path to project) && (command, in this case npm install)`. diff --git a/src/core/prompts/__tests__/__snapshots__/system-prompt/with-computer-use-support.snap b/src/core/prompts/__tests__/__snapshots__/system-prompt/with-computer-use-support.snap index 641ec16082ef..ca9c445e6aae 100644 --- a/src/core/prompts/__tests__/__snapshots__/system-prompt/with-computer-use-support.snap +++ b/src/core/prompts/__tests__/__snapshots__/system-prompt/with-computer-use-support.snap @@ -4,7 +4,7 @@ You are Roo, an experienced technical leader who is inquisitive and an excellent MARKDOWN RULES -ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in +ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in attempt_completion ==== @@ -14,15 +14,16 @@ You have access to a set of tools that are executed upon the user's approval. Yo # Tool Use Formatting -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + -Always use the actual tool name as the XML tag name for proper parsing and execution. +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution. # Tools @@ -38,30 +39,35 @@ Parameters: Usage: - - + + + path/to/file - - + + + Examples: 1. Reading a single file: - - + + + src/app.ts - - + + + 2. Reading multiple files (within the 5-file limit): - - + + + src/app.ts @@ -70,17 +76,20 @@ Examples: src/utils.ts - - + + + 3. Reading an entire file: - - + + + config.json - - + + + IMPORTANT: You MUST use this Efficient Reading Strategy: - You MUST read all related files and implementations together in a single operation (up to 5 files at once) @@ -97,9 +106,11 @@ Parameters: Example: Requesting instructions to create an MCP Server - -create_mcp_server - + + +create_mcp_server + + ## search_files Description: Request to perform a regex search across files in a specified directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with encapsulating context. @@ -108,18 +119,22 @@ Parameters: - regex: (required) The regular expression pattern to search for. Uses Rust regex syntax. - file_pattern: (optional) Glob pattern to filter files (e.g., '*.ts' for TypeScript files). If not provided, it will search all files (*). Usage: - -Directory path here -Your regex pattern here -file pattern here (optional) - + + +Directory path here +Your regex pattern here +file pattern here (optional) + + Example: Requesting to search for all .ts files in the current directory - -. -.* -*.ts - + + +. +.* +*.ts + + ## list_files Description: Request to list files and directories within the specified directory. If recursive is true, it will list all files and directories recursively. If recursive is false or not provided, it will only list the top-level contents. Do not use this tool to confirm the existence of files you may have created, as the user will let you know if the files were created successfully or not. @@ -127,37 +142,47 @@ Parameters: - path: (required) The path of the directory to list contents for (relative to the current workspace directory /test/path) - recursive: (optional) Whether to list files recursively. Use true for recursive listing, false or omit for top-level only. Usage: - -Directory path here -true or false (optional) - + + +Directory path here +true or false (optional) + + Example: Requesting to list all files in the current directory - -. -false - + + +. +false + + ## list_code_definition_names Description: Request to list definition names (classes, functions, methods, etc.) from source code. This tool can analyze either a single file or all files at the top level of a specified directory. It provides insights into the codebase structure and important constructs, encapsulating high-level concepts and relationships that are crucial for understanding the overall architecture. Parameters: - path: (required) The path of the file or directory (relative to the current working directory /test/path) to analyze. When given a directory, it lists definitions from all top-level source files. Usage: - -Directory path here - + + +Directory path here + + Examples: 1. List definitions from a specific file: - -src/main.ts - + + +src/main.ts + + 2. List definitions from all files in a directory: - -src/ - + + +src/ + + ## write_to_file Description: Request to write content to a file. This tool is primarily used for **creating new files** or for scenarios where a **complete rewrite of an existing file is intentionally required**. If the file exists, it will be overwritten. If it doesn't exist, it will be created. This tool will automatically create any directories needed to write the file. @@ -166,18 +191,21 @@ Parameters: - content: (required) The content to write to the file. When performing a full rewrite of an existing file or creating a new one, ALWAYS provide the COMPLETE intended content of the file, without any truncation or omissions. You MUST include ALL parts of the file, even if they haven't been modified. Do NOT include the line numbers in the content though, just the actual content of the file. - line_count: (required) The number of lines in the file. Make sure to compute this based on the actual content of the file, not the number of lines in the content you're providing. Usage: - -File path here - + + +File path here + Your file content here - -total number of lines in the file, including empty lines - + +total number of lines in the file, including empty lines + + Example: Requesting to write to frontend-config.json - -frontend-config.json - + + +frontend-config.json + { "apiEndpoint": "https://api.example.com", "theme": { @@ -192,9 +220,10 @@ Example: Requesting to write to frontend-config.json }, "version": "1.0.0" } - -14 - + +14 + + ## insert_content Description: Use this tool specifically for adding new lines of content into a file without modifying existing content. Specify the line number to insert before, or use line 0 to append to the end. Ideal for adding imports, functions, configuration blocks, log entries, or any multi-line text block. @@ -207,23 +236,27 @@ Parameters: - content: (required) The content to insert at the specified line Example for inserting imports at start of file: - -src/utils.ts -1 - + + +src/utils.ts +1 + // Add imports at start of file import { sum } from './math'; - - + + + Example for appending to the end of file: - -src/utils.ts -0 - + + +src/utils.ts +0 + // This is the end of the file - - + + + ## search_and_replace @@ -247,20 +280,24 @@ Notes: Examples: 1. Simple text replacement: - -example.ts -oldText -newText - + + +example.ts +oldText +newText + + 2. Case-insensitive regex pattern: - -example.ts -oldw+ -new$& -true -true - + + +example.ts +oldw+ +new$& +true +true + + ## browser_action Description: Request to interact with a Puppeteer-controlled browser. Every action, except `close`, will be responded to with a screenshot of the browser's current state, along with any new console logs. You may only perform one browser action per message, and wait for the user's response including a screenshot and logs to determine the next action. @@ -296,24 +333,30 @@ Parameters: - text: (optional) Use this for providing the text for the `type` action. * Example: Hello, world! Usage: - -Action to perform (e.g., launch, click, type, scroll_down, scroll_up, close) -URL to launch the browser at (optional) -x,y coordinates (optional) -Text to type (optional) - + + +Action to perform (e.g., launch, click, type, scroll_down, scroll_up, close) +URL to launch the browser at (optional) +x,y coordinates (optional) +Text to type (optional) + + Example: Requesting to launch a browser at https://example.com - -launch -https://example.com - + + +launch +https://example.com + + Example: Requesting to click on the element at coordinates 450,300 - -click -450,300 - + + +click +450,300 + + ## ask_followup_question Description: Ask the user a question to gather additional information needed to complete the task. Use when you need clarification or more details to proceed effectively. @@ -323,23 +366,27 @@ Parameters: - follow_up: (required) A list of 2-4 suggested answers, each in its own tag. Suggestions must be complete, actionable answers without placeholders. Optionally include mode attribute to switch modes (code/architect/etc.) Usage: - -Your question here - + + +Your question here + First suggestion Action with mode switch - - + + + Example: - -What is the path to the frontend-config.json file? - + + +What is the path to the frontend-config.json file? + ./src/frontend-config.json ./config/frontend-config.json ./frontend-config.json - - + + + ## attempt_completion Description: After each tool use, the user will respond with the result of that tool use, i.e. if it succeeded or failed, along with any reasons for failure. Once you've received the results of tool uses and can confirm that the task is complete, use this tool to present the result of your work to the user. The user may respond with feedback if they are not satisfied with the result, which you can use to make improvements and try again. @@ -347,18 +394,22 @@ IMPORTANT NOTE: This tool CANNOT be used until you've confirmed from the user th Parameters: - result: (required) The result of the task. Formulate this result in a way that is final and does not require further input from the user. Don't end your result with questions or offers for further assistance. Usage: - - + + + Your final result description here - - + + + Example: Requesting to attempt completion with a result - - + + + I've updated the CSS - - + + + ## switch_mode Description: Request to switch to a different mode. This tool allows modes to request switching to another mode when needed, such as switching to Code mode to make code changes. The user must approve the mode switch. @@ -366,16 +417,20 @@ Parameters: - mode_slug: (required) The slug of the mode to switch to (e.g., "code", "ask", "architect") - reason: (optional) The reason for switching modes Usage: - -Mode slug here -Reason for switching here - + + +Mode slug here +Reason for switching here + + Example: Requesting to switch to code mode - -code -Need to make code changes - + + +code +Need to make code changes + + ## new_task Description: This will let you create a new task instance in the chosen mode using your provided message. @@ -385,16 +440,20 @@ Parameters: - message: (required) The initial user message or instructions for this new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + + Example: - -code -Implement a new feature for the application - + + +code +Implement a new feature for the application + + ## update_todo_list @@ -426,27 +485,31 @@ Replace the entire TODO list with an updated checklist reflecting the current st - Remove tasks only if they are no longer relevant or if the user requests deletion. **Usage Example:** - - + + + [x] Analyze requirements [x] Design architecture [-] Implement core logic [ ] Write tests [ ] Update documentation - - + + + *After completing "Implement core logic" and starting "Write tests":* - - + + + [x] Analyze requirements [x] Design architecture [x] Implement core logic [-] Write tests [ ] Update documentation [ ] Add performance benchmarks - - + + + **When to Use:** - The task is complicated or involves multiple steps or requires ongoing tracking. @@ -514,7 +577,7 @@ MODES RULES - The project base directory is: /test/path -- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to . +- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to execute_command. - You cannot `cd` into a different directory to complete a task. You are stuck operating from '/test/path', so be sure to pass in the correct 'path' parameter when using tools that require a path. - Do not use the ~ character or $HOME to refer to the home directory. - Before using the execute_command tool, you must first think about the SYSTEM INFORMATION context provided to understand the user's environment and tailor your commands to ensure they are compatible with their system. You must also consider if the command you need to run should be executed in a specific directory outside of the current working directory '/test/path', and if so prepend with `cd`'ing into that directory && then executing the command (as one command since you are stuck operating from '/test/path'). For example, if you needed to run `npm install` in a project outside of '/test/path', you would need to prepend with a `cd` i.e. pseudocode for this would be `cd (path to project) && (command, in this case npm install)`. diff --git a/src/core/prompts/__tests__/__snapshots__/system-prompt/with-diff-enabled-false.snap b/src/core/prompts/__tests__/__snapshots__/system-prompt/with-diff-enabled-false.snap index aa928fd50cf3..be4a5f89a0fc 100644 --- a/src/core/prompts/__tests__/__snapshots__/system-prompt/with-diff-enabled-false.snap +++ b/src/core/prompts/__tests__/__snapshots__/system-prompt/with-diff-enabled-false.snap @@ -4,7 +4,7 @@ You are Roo, an experienced technical leader who is inquisitive and an excellent MARKDOWN RULES -ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in +ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in attempt_completion ==== @@ -14,15 +14,16 @@ You have access to a set of tools that are executed upon the user's approval. Yo # Tool Use Formatting -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + -Always use the actual tool name as the XML tag name for proper parsing and execution. +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution. # Tools @@ -38,30 +39,35 @@ Parameters: Usage: - - + + + path/to/file - - + + + Examples: 1. Reading a single file: - - + + + src/app.ts - - + + + 2. Reading multiple files (within the 5-file limit): - - + + + src/app.ts @@ -70,17 +76,20 @@ Examples: src/utils.ts - - + + + 3. Reading an entire file: - - + + + config.json - - + + + IMPORTANT: You MUST use this Efficient Reading Strategy: - You MUST read all related files and implementations together in a single operation (up to 5 files at once) @@ -97,9 +106,11 @@ Parameters: Example: Requesting instructions to create an MCP Server - -create_mcp_server - + + +create_mcp_server + + ## search_files Description: Request to perform a regex search across files in a specified directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with encapsulating context. @@ -108,18 +119,22 @@ Parameters: - regex: (required) The regular expression pattern to search for. Uses Rust regex syntax. - file_pattern: (optional) Glob pattern to filter files (e.g., '*.ts' for TypeScript files). If not provided, it will search all files (*). Usage: - -Directory path here -Your regex pattern here -file pattern here (optional) - + + +Directory path here +Your regex pattern here +file pattern here (optional) + + Example: Requesting to search for all .ts files in the current directory - -. -.* -*.ts - + + +. +.* +*.ts + + ## list_files Description: Request to list files and directories within the specified directory. If recursive is true, it will list all files and directories recursively. If recursive is false or not provided, it will only list the top-level contents. Do not use this tool to confirm the existence of files you may have created, as the user will let you know if the files were created successfully or not. @@ -127,37 +142,47 @@ Parameters: - path: (required) The path of the directory to list contents for (relative to the current workspace directory /test/path) - recursive: (optional) Whether to list files recursively. Use true for recursive listing, false or omit for top-level only. Usage: - -Directory path here -true or false (optional) - + + +Directory path here +true or false (optional) + + Example: Requesting to list all files in the current directory - -. -false - + + +. +false + + ## list_code_definition_names Description: Request to list definition names (classes, functions, methods, etc.) from source code. This tool can analyze either a single file or all files at the top level of a specified directory. It provides insights into the codebase structure and important constructs, encapsulating high-level concepts and relationships that are crucial for understanding the overall architecture. Parameters: - path: (required) The path of the file or directory (relative to the current working directory /test/path) to analyze. When given a directory, it lists definitions from all top-level source files. Usage: - -Directory path here - + + +Directory path here + + Examples: 1. List definitions from a specific file: - -src/main.ts - + + +src/main.ts + + 2. List definitions from all files in a directory: - -src/ - + + +src/ + + ## write_to_file Description: Request to write content to a file. This tool is primarily used for **creating new files** or for scenarios where a **complete rewrite of an existing file is intentionally required**. If the file exists, it will be overwritten. If it doesn't exist, it will be created. This tool will automatically create any directories needed to write the file. @@ -166,18 +191,21 @@ Parameters: - content: (required) The content to write to the file. When performing a full rewrite of an existing file or creating a new one, ALWAYS provide the COMPLETE intended content of the file, without any truncation or omissions. You MUST include ALL parts of the file, even if they haven't been modified. Do NOT include the line numbers in the content though, just the actual content of the file. - line_count: (required) The number of lines in the file. Make sure to compute this based on the actual content of the file, not the number of lines in the content you're providing. Usage: - -File path here - + + +File path here + Your file content here - -total number of lines in the file, including empty lines - + +total number of lines in the file, including empty lines + + Example: Requesting to write to frontend-config.json - -frontend-config.json - + + +frontend-config.json + { "apiEndpoint": "https://api.example.com", "theme": { @@ -192,9 +220,10 @@ Example: Requesting to write to frontend-config.json }, "version": "1.0.0" } - -14 - + +14 + + ## insert_content Description: Use this tool specifically for adding new lines of content into a file without modifying existing content. Specify the line number to insert before, or use line 0 to append to the end. Ideal for adding imports, functions, configuration blocks, log entries, or any multi-line text block. @@ -207,23 +236,27 @@ Parameters: - content: (required) The content to insert at the specified line Example for inserting imports at start of file: - -src/utils.ts -1 - + + +src/utils.ts +1 + // Add imports at start of file import { sum } from './math'; - - + + + Example for appending to the end of file: - -src/utils.ts -0 - + + +src/utils.ts +0 + // This is the end of the file - - + + + ## search_and_replace @@ -247,20 +280,24 @@ Notes: Examples: 1. Simple text replacement: - -example.ts -oldText -newText - + + +example.ts +oldText +newText + + 2. Case-insensitive regex pattern: - -example.ts -oldw+ -new$& -true -true - + + +example.ts +oldw+ +new$& +true +true + + ## ask_followup_question Description: Ask the user a question to gather additional information needed to complete the task. Use when you need clarification or more details to proceed effectively. @@ -270,23 +307,27 @@ Parameters: - follow_up: (required) A list of 2-4 suggested answers, each in its own tag. Suggestions must be complete, actionable answers without placeholders. Optionally include mode attribute to switch modes (code/architect/etc.) Usage: - -Your question here - + + +Your question here + First suggestion Action with mode switch - - + + + Example: - -What is the path to the frontend-config.json file? - + + +What is the path to the frontend-config.json file? + ./src/frontend-config.json ./config/frontend-config.json ./frontend-config.json - - + + + ## attempt_completion Description: After each tool use, the user will respond with the result of that tool use, i.e. if it succeeded or failed, along with any reasons for failure. Once you've received the results of tool uses and can confirm that the task is complete, use this tool to present the result of your work to the user. The user may respond with feedback if they are not satisfied with the result, which you can use to make improvements and try again. @@ -294,18 +335,22 @@ IMPORTANT NOTE: This tool CANNOT be used until you've confirmed from the user th Parameters: - result: (required) The result of the task. Formulate this result in a way that is final and does not require further input from the user. Don't end your result with questions or offers for further assistance. Usage: - - + + + Your final result description here - - + + + Example: Requesting to attempt completion with a result - - + + + I've updated the CSS - - + + + ## switch_mode Description: Request to switch to a different mode. This tool allows modes to request switching to another mode when needed, such as switching to Code mode to make code changes. The user must approve the mode switch. @@ -313,16 +358,20 @@ Parameters: - mode_slug: (required) The slug of the mode to switch to (e.g., "code", "ask", "architect") - reason: (optional) The reason for switching modes Usage: - -Mode slug here -Reason for switching here - + + +Mode slug here +Reason for switching here + + Example: Requesting to switch to code mode - -code -Need to make code changes - + + +code +Need to make code changes + + ## new_task Description: This will let you create a new task instance in the chosen mode using your provided message. @@ -332,16 +381,20 @@ Parameters: - message: (required) The initial user message or instructions for this new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + + Example: - -code -Implement a new feature for the application - + + +code +Implement a new feature for the application + + ## update_todo_list @@ -373,27 +426,31 @@ Replace the entire TODO list with an updated checklist reflecting the current st - Remove tasks only if they are no longer relevant or if the user requests deletion. **Usage Example:** - - + + + [x] Analyze requirements [x] Design architecture [-] Implement core logic [ ] Write tests [ ] Update documentation - - + + + *After completing "Implement core logic" and starting "Write tests":* - - + + + [x] Analyze requirements [x] Design architecture [x] Implement core logic [-] Write tests [ ] Update documentation [ ] Add performance benchmarks - - + + + **When to Use:** - The task is complicated or involves multiple steps or requires ongoing tracking. @@ -459,7 +516,7 @@ MODES RULES - The project base directory is: /test/path -- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to . +- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to execute_command. - You cannot `cd` into a different directory to complete a task. You are stuck operating from '/test/path', so be sure to pass in the correct 'path' parameter when using tools that require a path. - Do not use the ~ character or $HOME to refer to the home directory. - Before using the execute_command tool, you must first think about the SYSTEM INFORMATION context provided to understand the user's environment and tailor your commands to ensure they are compatible with their system. You must also consider if the command you need to run should be executed in a specific directory outside of the current working directory '/test/path', and if so prepend with `cd`'ing into that directory && then executing the command (as one command since you are stuck operating from '/test/path'). For example, if you needed to run `npm install` in a project outside of '/test/path', you would need to prepend with a `cd` i.e. pseudocode for this would be `cd (path to project) && (command, in this case npm install)`. diff --git a/src/core/prompts/__tests__/__snapshots__/system-prompt/with-diff-enabled-true.snap b/src/core/prompts/__tests__/__snapshots__/system-prompt/with-diff-enabled-true.snap index 154e1f08ae8e..a3199544861d 100644 --- a/src/core/prompts/__tests__/__snapshots__/system-prompt/with-diff-enabled-true.snap +++ b/src/core/prompts/__tests__/__snapshots__/system-prompt/with-diff-enabled-true.snap @@ -4,7 +4,7 @@ You are Roo, an experienced technical leader who is inquisitive and an excellent MARKDOWN RULES -ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in +ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in attempt_completion ==== @@ -14,15 +14,16 @@ You have access to a set of tools that are executed upon the user's approval. Yo # Tool Use Formatting -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + -Always use the actual tool name as the XML tag name for proper parsing and execution. +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution. # Tools @@ -38,30 +39,35 @@ Parameters: Usage: - - + + + path/to/file - - + + + Examples: 1. Reading a single file: - - + + + src/app.ts - - + + + 2. Reading multiple files (within the 5-file limit): - - + + + src/app.ts @@ -70,17 +76,20 @@ Examples: src/utils.ts - - + + + 3. Reading an entire file: - - + + + config.json - - + + + IMPORTANT: You MUST use this Efficient Reading Strategy: - You MUST read all related files and implementations together in a single operation (up to 5 files at once) @@ -97,9 +106,11 @@ Parameters: Example: Requesting instructions to create an MCP Server - -create_mcp_server - + + +create_mcp_server + + ## search_files Description: Request to perform a regex search across files in a specified directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with encapsulating context. @@ -108,18 +119,22 @@ Parameters: - regex: (required) The regular expression pattern to search for. Uses Rust regex syntax. - file_pattern: (optional) Glob pattern to filter files (e.g., '*.ts' for TypeScript files). If not provided, it will search all files (*). Usage: - -Directory path here -Your regex pattern here -file pattern here (optional) - + + +Directory path here +Your regex pattern here +file pattern here (optional) + + Example: Requesting to search for all .ts files in the current directory - -. -.* -*.ts - + + +. +.* +*.ts + + ## list_files Description: Request to list files and directories within the specified directory. If recursive is true, it will list all files and directories recursively. If recursive is false or not provided, it will only list the top-level contents. Do not use this tool to confirm the existence of files you may have created, as the user will let you know if the files were created successfully or not. @@ -127,37 +142,47 @@ Parameters: - path: (required) The path of the directory to list contents for (relative to the current workspace directory /test/path) - recursive: (optional) Whether to list files recursively. Use true for recursive listing, false or omit for top-level only. Usage: - -Directory path here -true or false (optional) - + + +Directory path here +true or false (optional) + + Example: Requesting to list all files in the current directory - -. -false - + + +. +false + + ## list_code_definition_names Description: Request to list definition names (classes, functions, methods, etc.) from source code. This tool can analyze either a single file or all files at the top level of a specified directory. It provides insights into the codebase structure and important constructs, encapsulating high-level concepts and relationships that are crucial for understanding the overall architecture. Parameters: - path: (required) The path of the file or directory (relative to the current working directory /test/path) to analyze. When given a directory, it lists definitions from all top-level source files. Usage: - -Directory path here - + + +Directory path here + + Examples: 1. List definitions from a specific file: - -src/main.ts - + + +src/main.ts + + 2. List definitions from all files in a directory: - -src/ - + + +src/ + + ## apply_diff Description: Request to apply PRECISE, TARGETED modifications to an existing file by searching for specific sections of content and replacing them. This tool is for SURGICAL EDITS ONLY - specific changes to existing code. @@ -238,14 +263,16 @@ def calculate_sum(items): Usage: - -File path here - + + +File path here + Your search/replace content here You can use multi search/replace block in one diff block, but make sure to include the line numbers for each block. Only use a single line of '=======' between search and replacement content, because multiple '=======' will corrupt the file. - - + + + ## write_to_file Description: Request to write content to a file. This tool is primarily used for **creating new files** or for scenarios where a **complete rewrite of an existing file is intentionally required**. If the file exists, it will be overwritten. If it doesn't exist, it will be created. This tool will automatically create any directories needed to write the file. @@ -254,18 +281,21 @@ Parameters: - content: (required) The content to write to the file. When performing a full rewrite of an existing file or creating a new one, ALWAYS provide the COMPLETE intended content of the file, without any truncation or omissions. You MUST include ALL parts of the file, even if they haven't been modified. Do NOT include the line numbers in the content though, just the actual content of the file. - line_count: (required) The number of lines in the file. Make sure to compute this based on the actual content of the file, not the number of lines in the content you're providing. Usage: - -File path here - + + +File path here + Your file content here - -total number of lines in the file, including empty lines - + +total number of lines in the file, including empty lines + + Example: Requesting to write to frontend-config.json - -frontend-config.json - + + +frontend-config.json + { "apiEndpoint": "https://api.example.com", "theme": { @@ -280,9 +310,10 @@ Example: Requesting to write to frontend-config.json }, "version": "1.0.0" } - -14 - + +14 + + ## insert_content Description: Use this tool specifically for adding new lines of content into a file without modifying existing content. Specify the line number to insert before, or use line 0 to append to the end. Ideal for adding imports, functions, configuration blocks, log entries, or any multi-line text block. @@ -295,23 +326,27 @@ Parameters: - content: (required) The content to insert at the specified line Example for inserting imports at start of file: - -src/utils.ts -1 - + + +src/utils.ts +1 + // Add imports at start of file import { sum } from './math'; - - + + + Example for appending to the end of file: - -src/utils.ts -0 - + + +src/utils.ts +0 + // This is the end of the file - - + + + ## search_and_replace @@ -335,20 +370,24 @@ Notes: Examples: 1. Simple text replacement: - -example.ts -oldText -newText - + + +example.ts +oldText +newText + + 2. Case-insensitive regex pattern: - -example.ts -oldw+ -new$& -true -true - + + +example.ts +oldw+ +new$& +true +true + + ## ask_followup_question Description: Ask the user a question to gather additional information needed to complete the task. Use when you need clarification or more details to proceed effectively. @@ -358,23 +397,27 @@ Parameters: - follow_up: (required) A list of 2-4 suggested answers, each in its own tag. Suggestions must be complete, actionable answers without placeholders. Optionally include mode attribute to switch modes (code/architect/etc.) Usage: - -Your question here - + + +Your question here + First suggestion Action with mode switch - - + + + Example: - -What is the path to the frontend-config.json file? - + + +What is the path to the frontend-config.json file? + ./src/frontend-config.json ./config/frontend-config.json ./frontend-config.json - - + + + ## attempt_completion Description: After each tool use, the user will respond with the result of that tool use, i.e. if it succeeded or failed, along with any reasons for failure. Once you've received the results of tool uses and can confirm that the task is complete, use this tool to present the result of your work to the user. The user may respond with feedback if they are not satisfied with the result, which you can use to make improvements and try again. @@ -382,18 +425,22 @@ IMPORTANT NOTE: This tool CANNOT be used until you've confirmed from the user th Parameters: - result: (required) The result of the task. Formulate this result in a way that is final and does not require further input from the user. Don't end your result with questions or offers for further assistance. Usage: - - + + + Your final result description here - - + + + Example: Requesting to attempt completion with a result - - + + + I've updated the CSS - - + + + ## switch_mode Description: Request to switch to a different mode. This tool allows modes to request switching to another mode when needed, such as switching to Code mode to make code changes. The user must approve the mode switch. @@ -401,16 +448,20 @@ Parameters: - mode_slug: (required) The slug of the mode to switch to (e.g., "code", "ask", "architect") - reason: (optional) The reason for switching modes Usage: - -Mode slug here -Reason for switching here - + + +Mode slug here +Reason for switching here + + Example: Requesting to switch to code mode - -code -Need to make code changes - + + +code +Need to make code changes + + ## new_task Description: This will let you create a new task instance in the chosen mode using your provided message. @@ -420,16 +471,20 @@ Parameters: - message: (required) The initial user message or instructions for this new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + + Example: - -code -Implement a new feature for the application - + + +code +Implement a new feature for the application + + ## update_todo_list @@ -461,27 +516,31 @@ Replace the entire TODO list with an updated checklist reflecting the current st - Remove tasks only if they are no longer relevant or if the user requests deletion. **Usage Example:** - - + + + [x] Analyze requirements [x] Design architecture [-] Implement core logic [ ] Write tests [ ] Update documentation - - + + + *After completing "Implement core logic" and starting "Write tests":* - - + + + [x] Analyze requirements [x] Design architecture [x] Implement core logic [-] Write tests [ ] Update documentation [ ] Add performance benchmarks - - + + + **When to Use:** - The task is complicated or involves multiple steps or requires ongoing tracking. @@ -547,7 +606,7 @@ MODES RULES - The project base directory is: /test/path -- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to . +- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to execute_command. - You cannot `cd` into a different directory to complete a task. You are stuck operating from '/test/path', so be sure to pass in the correct 'path' parameter when using tools that require a path. - Do not use the ~ character or $HOME to refer to the home directory. - Before using the execute_command tool, you must first think about the SYSTEM INFORMATION context provided to understand the user's environment and tailor your commands to ensure they are compatible with their system. You must also consider if the command you need to run should be executed in a specific directory outside of the current working directory '/test/path', and if so prepend with `cd`'ing into that directory && then executing the command (as one command since you are stuck operating from '/test/path'). For example, if you needed to run `npm install` in a project outside of '/test/path', you would need to prepend with a `cd` i.e. pseudocode for this would be `cd (path to project) && (command, in this case npm install)`. diff --git a/src/core/prompts/__tests__/__snapshots__/system-prompt/with-diff-enabled-undefined.snap b/src/core/prompts/__tests__/__snapshots__/system-prompt/with-diff-enabled-undefined.snap index aa928fd50cf3..be4a5f89a0fc 100644 --- a/src/core/prompts/__tests__/__snapshots__/system-prompt/with-diff-enabled-undefined.snap +++ b/src/core/prompts/__tests__/__snapshots__/system-prompt/with-diff-enabled-undefined.snap @@ -4,7 +4,7 @@ You are Roo, an experienced technical leader who is inquisitive and an excellent MARKDOWN RULES -ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in +ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in attempt_completion ==== @@ -14,15 +14,16 @@ You have access to a set of tools that are executed upon the user's approval. Yo # Tool Use Formatting -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + -Always use the actual tool name as the XML tag name for proper parsing and execution. +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution. # Tools @@ -38,30 +39,35 @@ Parameters: Usage: - - + + + path/to/file - - + + + Examples: 1. Reading a single file: - - + + + src/app.ts - - + + + 2. Reading multiple files (within the 5-file limit): - - + + + src/app.ts @@ -70,17 +76,20 @@ Examples: src/utils.ts - - + + + 3. Reading an entire file: - - + + + config.json - - + + + IMPORTANT: You MUST use this Efficient Reading Strategy: - You MUST read all related files and implementations together in a single operation (up to 5 files at once) @@ -97,9 +106,11 @@ Parameters: Example: Requesting instructions to create an MCP Server - -create_mcp_server - + + +create_mcp_server + + ## search_files Description: Request to perform a regex search across files in a specified directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with encapsulating context. @@ -108,18 +119,22 @@ Parameters: - regex: (required) The regular expression pattern to search for. Uses Rust regex syntax. - file_pattern: (optional) Glob pattern to filter files (e.g., '*.ts' for TypeScript files). If not provided, it will search all files (*). Usage: - -Directory path here -Your regex pattern here -file pattern here (optional) - + + +Directory path here +Your regex pattern here +file pattern here (optional) + + Example: Requesting to search for all .ts files in the current directory - -. -.* -*.ts - + + +. +.* +*.ts + + ## list_files Description: Request to list files and directories within the specified directory. If recursive is true, it will list all files and directories recursively. If recursive is false or not provided, it will only list the top-level contents. Do not use this tool to confirm the existence of files you may have created, as the user will let you know if the files were created successfully or not. @@ -127,37 +142,47 @@ Parameters: - path: (required) The path of the directory to list contents for (relative to the current workspace directory /test/path) - recursive: (optional) Whether to list files recursively. Use true for recursive listing, false or omit for top-level only. Usage: - -Directory path here -true or false (optional) - + + +Directory path here +true or false (optional) + + Example: Requesting to list all files in the current directory - -. -false - + + +. +false + + ## list_code_definition_names Description: Request to list definition names (classes, functions, methods, etc.) from source code. This tool can analyze either a single file or all files at the top level of a specified directory. It provides insights into the codebase structure and important constructs, encapsulating high-level concepts and relationships that are crucial for understanding the overall architecture. Parameters: - path: (required) The path of the file or directory (relative to the current working directory /test/path) to analyze. When given a directory, it lists definitions from all top-level source files. Usage: - -Directory path here - + + +Directory path here + + Examples: 1. List definitions from a specific file: - -src/main.ts - + + +src/main.ts + + 2. List definitions from all files in a directory: - -src/ - + + +src/ + + ## write_to_file Description: Request to write content to a file. This tool is primarily used for **creating new files** or for scenarios where a **complete rewrite of an existing file is intentionally required**. If the file exists, it will be overwritten. If it doesn't exist, it will be created. This tool will automatically create any directories needed to write the file. @@ -166,18 +191,21 @@ Parameters: - content: (required) The content to write to the file. When performing a full rewrite of an existing file or creating a new one, ALWAYS provide the COMPLETE intended content of the file, without any truncation or omissions. You MUST include ALL parts of the file, even if they haven't been modified. Do NOT include the line numbers in the content though, just the actual content of the file. - line_count: (required) The number of lines in the file. Make sure to compute this based on the actual content of the file, not the number of lines in the content you're providing. Usage: - -File path here - + + +File path here + Your file content here - -total number of lines in the file, including empty lines - + +total number of lines in the file, including empty lines + + Example: Requesting to write to frontend-config.json - -frontend-config.json - + + +frontend-config.json + { "apiEndpoint": "https://api.example.com", "theme": { @@ -192,9 +220,10 @@ Example: Requesting to write to frontend-config.json }, "version": "1.0.0" } - -14 - + +14 + + ## insert_content Description: Use this tool specifically for adding new lines of content into a file without modifying existing content. Specify the line number to insert before, or use line 0 to append to the end. Ideal for adding imports, functions, configuration blocks, log entries, or any multi-line text block. @@ -207,23 +236,27 @@ Parameters: - content: (required) The content to insert at the specified line Example for inserting imports at start of file: - -src/utils.ts -1 - + + +src/utils.ts +1 + // Add imports at start of file import { sum } from './math'; - - + + + Example for appending to the end of file: - -src/utils.ts -0 - + + +src/utils.ts +0 + // This is the end of the file - - + + + ## search_and_replace @@ -247,20 +280,24 @@ Notes: Examples: 1. Simple text replacement: - -example.ts -oldText -newText - + + +example.ts +oldText +newText + + 2. Case-insensitive regex pattern: - -example.ts -oldw+ -new$& -true -true - + + +example.ts +oldw+ +new$& +true +true + + ## ask_followup_question Description: Ask the user a question to gather additional information needed to complete the task. Use when you need clarification or more details to proceed effectively. @@ -270,23 +307,27 @@ Parameters: - follow_up: (required) A list of 2-4 suggested answers, each in its own tag. Suggestions must be complete, actionable answers without placeholders. Optionally include mode attribute to switch modes (code/architect/etc.) Usage: - -Your question here - + + +Your question here + First suggestion Action with mode switch - - + + + Example: - -What is the path to the frontend-config.json file? - + + +What is the path to the frontend-config.json file? + ./src/frontend-config.json ./config/frontend-config.json ./frontend-config.json - - + + + ## attempt_completion Description: After each tool use, the user will respond with the result of that tool use, i.e. if it succeeded or failed, along with any reasons for failure. Once you've received the results of tool uses and can confirm that the task is complete, use this tool to present the result of your work to the user. The user may respond with feedback if they are not satisfied with the result, which you can use to make improvements and try again. @@ -294,18 +335,22 @@ IMPORTANT NOTE: This tool CANNOT be used until you've confirmed from the user th Parameters: - result: (required) The result of the task. Formulate this result in a way that is final and does not require further input from the user. Don't end your result with questions or offers for further assistance. Usage: - - + + + Your final result description here - - + + + Example: Requesting to attempt completion with a result - - + + + I've updated the CSS - - + + + ## switch_mode Description: Request to switch to a different mode. This tool allows modes to request switching to another mode when needed, such as switching to Code mode to make code changes. The user must approve the mode switch. @@ -313,16 +358,20 @@ Parameters: - mode_slug: (required) The slug of the mode to switch to (e.g., "code", "ask", "architect") - reason: (optional) The reason for switching modes Usage: - -Mode slug here -Reason for switching here - + + +Mode slug here +Reason for switching here + + Example: Requesting to switch to code mode - -code -Need to make code changes - + + +code +Need to make code changes + + ## new_task Description: This will let you create a new task instance in the chosen mode using your provided message. @@ -332,16 +381,20 @@ Parameters: - message: (required) The initial user message or instructions for this new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + + Example: - -code -Implement a new feature for the application - + + +code +Implement a new feature for the application + + ## update_todo_list @@ -373,27 +426,31 @@ Replace the entire TODO list with an updated checklist reflecting the current st - Remove tasks only if they are no longer relevant or if the user requests deletion. **Usage Example:** - - + + + [x] Analyze requirements [x] Design architecture [-] Implement core logic [ ] Write tests [ ] Update documentation - - + + + *After completing "Implement core logic" and starting "Write tests":* - - + + + [x] Analyze requirements [x] Design architecture [x] Implement core logic [-] Write tests [ ] Update documentation [ ] Add performance benchmarks - - + + + **When to Use:** - The task is complicated or involves multiple steps or requires ongoing tracking. @@ -459,7 +516,7 @@ MODES RULES - The project base directory is: /test/path -- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to . +- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to execute_command. - You cannot `cd` into a different directory to complete a task. You are stuck operating from '/test/path', so be sure to pass in the correct 'path' parameter when using tools that require a path. - Do not use the ~ character or $HOME to refer to the home directory. - Before using the execute_command tool, you must first think about the SYSTEM INFORMATION context provided to understand the user's environment and tailor your commands to ensure they are compatible with their system. You must also consider if the command you need to run should be executed in a specific directory outside of the current working directory '/test/path', and if so prepend with `cd`'ing into that directory && then executing the command (as one command since you are stuck operating from '/test/path'). For example, if you needed to run `npm install` in a project outside of '/test/path', you would need to prepend with a `cd` i.e. pseudocode for this would be `cd (path to project) && (command, in this case npm install)`. diff --git a/src/core/prompts/__tests__/__snapshots__/system-prompt/with-different-viewport-size.snap b/src/core/prompts/__tests__/__snapshots__/system-prompt/with-different-viewport-size.snap index d7feefa7e601..3966669ddbf3 100644 --- a/src/core/prompts/__tests__/__snapshots__/system-prompt/with-different-viewport-size.snap +++ b/src/core/prompts/__tests__/__snapshots__/system-prompt/with-different-viewport-size.snap @@ -4,7 +4,7 @@ You are Roo, an experienced technical leader who is inquisitive and an excellent MARKDOWN RULES -ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in +ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in attempt_completion ==== @@ -14,15 +14,16 @@ You have access to a set of tools that are executed upon the user's approval. Yo # Tool Use Formatting -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + -Always use the actual tool name as the XML tag name for proper parsing and execution. +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution. # Tools @@ -38,30 +39,35 @@ Parameters: Usage: - - + + + path/to/file - - + + + Examples: 1. Reading a single file: - - + + + src/app.ts - - + + + 2. Reading multiple files (within the 5-file limit): - - + + + src/app.ts @@ -70,17 +76,20 @@ Examples: src/utils.ts - - + + + 3. Reading an entire file: - - + + + config.json - - + + + IMPORTANT: You MUST use this Efficient Reading Strategy: - You MUST read all related files and implementations together in a single operation (up to 5 files at once) @@ -97,9 +106,11 @@ Parameters: Example: Requesting instructions to create an MCP Server - -create_mcp_server - + + +create_mcp_server + + ## search_files Description: Request to perform a regex search across files in a specified directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with encapsulating context. @@ -108,18 +119,22 @@ Parameters: - regex: (required) The regular expression pattern to search for. Uses Rust regex syntax. - file_pattern: (optional) Glob pattern to filter files (e.g., '*.ts' for TypeScript files). If not provided, it will search all files (*). Usage: - -Directory path here -Your regex pattern here -file pattern here (optional) - + + +Directory path here +Your regex pattern here +file pattern here (optional) + + Example: Requesting to search for all .ts files in the current directory - -. -.* -*.ts - + + +. +.* +*.ts + + ## list_files Description: Request to list files and directories within the specified directory. If recursive is true, it will list all files and directories recursively. If recursive is false or not provided, it will only list the top-level contents. Do not use this tool to confirm the existence of files you may have created, as the user will let you know if the files were created successfully or not. @@ -127,37 +142,47 @@ Parameters: - path: (required) The path of the directory to list contents for (relative to the current workspace directory /test/path) - recursive: (optional) Whether to list files recursively. Use true for recursive listing, false or omit for top-level only. Usage: - -Directory path here -true or false (optional) - + + +Directory path here +true or false (optional) + + Example: Requesting to list all files in the current directory - -. -false - + + +. +false + + ## list_code_definition_names Description: Request to list definition names (classes, functions, methods, etc.) from source code. This tool can analyze either a single file or all files at the top level of a specified directory. It provides insights into the codebase structure and important constructs, encapsulating high-level concepts and relationships that are crucial for understanding the overall architecture. Parameters: - path: (required) The path of the file or directory (relative to the current working directory /test/path) to analyze. When given a directory, it lists definitions from all top-level source files. Usage: - -Directory path here - + + +Directory path here + + Examples: 1. List definitions from a specific file: - -src/main.ts - + + +src/main.ts + + 2. List definitions from all files in a directory: - -src/ - + + +src/ + + ## write_to_file Description: Request to write content to a file. This tool is primarily used for **creating new files** or for scenarios where a **complete rewrite of an existing file is intentionally required**. If the file exists, it will be overwritten. If it doesn't exist, it will be created. This tool will automatically create any directories needed to write the file. @@ -166,18 +191,21 @@ Parameters: - content: (required) The content to write to the file. When performing a full rewrite of an existing file or creating a new one, ALWAYS provide the COMPLETE intended content of the file, without any truncation or omissions. You MUST include ALL parts of the file, even if they haven't been modified. Do NOT include the line numbers in the content though, just the actual content of the file. - line_count: (required) The number of lines in the file. Make sure to compute this based on the actual content of the file, not the number of lines in the content you're providing. Usage: - -File path here - + + +File path here + Your file content here - -total number of lines in the file, including empty lines - + +total number of lines in the file, including empty lines + + Example: Requesting to write to frontend-config.json - -frontend-config.json - + + +frontend-config.json + { "apiEndpoint": "https://api.example.com", "theme": { @@ -192,9 +220,10 @@ Example: Requesting to write to frontend-config.json }, "version": "1.0.0" } - -14 - + +14 + + ## insert_content Description: Use this tool specifically for adding new lines of content into a file without modifying existing content. Specify the line number to insert before, or use line 0 to append to the end. Ideal for adding imports, functions, configuration blocks, log entries, or any multi-line text block. @@ -207,23 +236,27 @@ Parameters: - content: (required) The content to insert at the specified line Example for inserting imports at start of file: - -src/utils.ts -1 - + + +src/utils.ts +1 + // Add imports at start of file import { sum } from './math'; - - + + + Example for appending to the end of file: - -src/utils.ts -0 - + + +src/utils.ts +0 + // This is the end of the file - - + + + ## search_and_replace @@ -247,20 +280,24 @@ Notes: Examples: 1. Simple text replacement: - -example.ts -oldText -newText - + + +example.ts +oldText +newText + + 2. Case-insensitive regex pattern: - -example.ts -oldw+ -new$& -true -true - + + +example.ts +oldw+ +new$& +true +true + + ## browser_action Description: Request to interact with a Puppeteer-controlled browser. Every action, except `close`, will be responded to with a screenshot of the browser's current state, along with any new console logs. You may only perform one browser action per message, and wait for the user's response including a screenshot and logs to determine the next action. @@ -296,24 +333,30 @@ Parameters: - text: (optional) Use this for providing the text for the `type` action. * Example: Hello, world! Usage: - -Action to perform (e.g., launch, click, type, scroll_down, scroll_up, close) -URL to launch the browser at (optional) -x,y coordinates (optional) -Text to type (optional) - + + +Action to perform (e.g., launch, click, type, scroll_down, scroll_up, close) +URL to launch the browser at (optional) +x,y coordinates (optional) +Text to type (optional) + + Example: Requesting to launch a browser at https://example.com - -launch -https://example.com - + + +launch +https://example.com + + Example: Requesting to click on the element at coordinates 450,300 - -click -450,300 - + + +click +450,300 + + ## ask_followup_question Description: Ask the user a question to gather additional information needed to complete the task. Use when you need clarification or more details to proceed effectively. @@ -323,23 +366,27 @@ Parameters: - follow_up: (required) A list of 2-4 suggested answers, each in its own tag. Suggestions must be complete, actionable answers without placeholders. Optionally include mode attribute to switch modes (code/architect/etc.) Usage: - -Your question here - + + +Your question here + First suggestion Action with mode switch - - + + + Example: - -What is the path to the frontend-config.json file? - + + +What is the path to the frontend-config.json file? + ./src/frontend-config.json ./config/frontend-config.json ./frontend-config.json - - + + + ## attempt_completion Description: After each tool use, the user will respond with the result of that tool use, i.e. if it succeeded or failed, along with any reasons for failure. Once you've received the results of tool uses and can confirm that the task is complete, use this tool to present the result of your work to the user. The user may respond with feedback if they are not satisfied with the result, which you can use to make improvements and try again. @@ -347,18 +394,22 @@ IMPORTANT NOTE: This tool CANNOT be used until you've confirmed from the user th Parameters: - result: (required) The result of the task. Formulate this result in a way that is final and does not require further input from the user. Don't end your result with questions or offers for further assistance. Usage: - - + + + Your final result description here - - + + + Example: Requesting to attempt completion with a result - - + + + I've updated the CSS - - + + + ## switch_mode Description: Request to switch to a different mode. This tool allows modes to request switching to another mode when needed, such as switching to Code mode to make code changes. The user must approve the mode switch. @@ -366,16 +417,20 @@ Parameters: - mode_slug: (required) The slug of the mode to switch to (e.g., "code", "ask", "architect") - reason: (optional) The reason for switching modes Usage: - -Mode slug here -Reason for switching here - + + +Mode slug here +Reason for switching here + + Example: Requesting to switch to code mode - -code -Need to make code changes - + + +code +Need to make code changes + + ## new_task Description: This will let you create a new task instance in the chosen mode using your provided message. @@ -385,16 +440,20 @@ Parameters: - message: (required) The initial user message or instructions for this new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + + Example: - -code -Implement a new feature for the application - + + +code +Implement a new feature for the application + + ## update_todo_list @@ -426,27 +485,31 @@ Replace the entire TODO list with an updated checklist reflecting the current st - Remove tasks only if they are no longer relevant or if the user requests deletion. **Usage Example:** - - + + + [x] Analyze requirements [x] Design architecture [-] Implement core logic [ ] Write tests [ ] Update documentation - - + + + *After completing "Implement core logic" and starting "Write tests":* - - + + + [x] Analyze requirements [x] Design architecture [x] Implement core logic [-] Write tests [ ] Update documentation [ ] Add performance benchmarks - - + + + **When to Use:** - The task is complicated or involves multiple steps or requires ongoing tracking. @@ -514,7 +577,7 @@ MODES RULES - The project base directory is: /test/path -- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to . +- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to execute_command. - You cannot `cd` into a different directory to complete a task. You are stuck operating from '/test/path', so be sure to pass in the correct 'path' parameter when using tools that require a path. - Do not use the ~ character or $HOME to refer to the home directory. - Before using the execute_command tool, you must first think about the SYSTEM INFORMATION context provided to understand the user's environment and tailor your commands to ensure they are compatible with their system. You must also consider if the command you need to run should be executed in a specific directory outside of the current working directory '/test/path', and if so prepend with `cd`'ing into that directory && then executing the command (as one command since you are stuck operating from '/test/path'). For example, if you needed to run `npm install` in a project outside of '/test/path', you would need to prepend with a `cd` i.e. pseudocode for this would be `cd (path to project) && (command, in this case npm install)`. diff --git a/src/core/prompts/__tests__/__snapshots__/system-prompt/with-mcp-hub-provided.snap b/src/core/prompts/__tests__/__snapshots__/system-prompt/with-mcp-hub-provided.snap index ec5304a2b2ad..cf1240f9e0f1 100644 --- a/src/core/prompts/__tests__/__snapshots__/system-prompt/with-mcp-hub-provided.snap +++ b/src/core/prompts/__tests__/__snapshots__/system-prompt/with-mcp-hub-provided.snap @@ -4,7 +4,7 @@ You are Roo, an experienced technical leader who is inquisitive and an excellent MARKDOWN RULES -ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in +ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in attempt_completion ==== @@ -14,15 +14,16 @@ You have access to a set of tools that are executed upon the user's approval. Yo # Tool Use Formatting -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + -Always use the actual tool name as the XML tag name for proper parsing and execution. +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution. # Tools @@ -38,30 +39,35 @@ Parameters: Usage: - - + + + path/to/file - - + + + Examples: 1. Reading a single file: - - + + + src/app.ts - - + + + 2. Reading multiple files (within the 5-file limit): - - + + + src/app.ts @@ -70,17 +76,20 @@ Examples: src/utils.ts - - + + + 3. Reading an entire file: - - + + + config.json - - + + + IMPORTANT: You MUST use this Efficient Reading Strategy: - You MUST read all related files and implementations together in a single operation (up to 5 files at once) @@ -97,9 +106,11 @@ Parameters: Example: Requesting instructions to create an MCP Server - -create_mcp_server - + + +create_mcp_server + + ## search_files Description: Request to perform a regex search across files in a specified directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with encapsulating context. @@ -108,18 +119,22 @@ Parameters: - regex: (required) The regular expression pattern to search for. Uses Rust regex syntax. - file_pattern: (optional) Glob pattern to filter files (e.g., '*.ts' for TypeScript files). If not provided, it will search all files (*). Usage: - -Directory path here -Your regex pattern here -file pattern here (optional) - + + +Directory path here +Your regex pattern here +file pattern here (optional) + + Example: Requesting to search for all .ts files in the current directory - -. -.* -*.ts - + + +. +.* +*.ts + + ## list_files Description: Request to list files and directories within the specified directory. If recursive is true, it will list all files and directories recursively. If recursive is false or not provided, it will only list the top-level contents. Do not use this tool to confirm the existence of files you may have created, as the user will let you know if the files were created successfully or not. @@ -127,37 +142,47 @@ Parameters: - path: (required) The path of the directory to list contents for (relative to the current workspace directory /test/path) - recursive: (optional) Whether to list files recursively. Use true for recursive listing, false or omit for top-level only. Usage: - -Directory path here -true or false (optional) - + + +Directory path here +true or false (optional) + + Example: Requesting to list all files in the current directory - -. -false - + + +. +false + + ## list_code_definition_names Description: Request to list definition names (classes, functions, methods, etc.) from source code. This tool can analyze either a single file or all files at the top level of a specified directory. It provides insights into the codebase structure and important constructs, encapsulating high-level concepts and relationships that are crucial for understanding the overall architecture. Parameters: - path: (required) The path of the file or directory (relative to the current working directory /test/path) to analyze. When given a directory, it lists definitions from all top-level source files. Usage: - -Directory path here - + + +Directory path here + + Examples: 1. List definitions from a specific file: - -src/main.ts - + + +src/main.ts + + 2. List definitions from all files in a directory: - -src/ - + + +src/ + + ## write_to_file Description: Request to write content to a file. This tool is primarily used for **creating new files** or for scenarios where a **complete rewrite of an existing file is intentionally required**. If the file exists, it will be overwritten. If it doesn't exist, it will be created. This tool will automatically create any directories needed to write the file. @@ -166,18 +191,21 @@ Parameters: - content: (required) The content to write to the file. When performing a full rewrite of an existing file or creating a new one, ALWAYS provide the COMPLETE intended content of the file, without any truncation or omissions. You MUST include ALL parts of the file, even if they haven't been modified. Do NOT include the line numbers in the content though, just the actual content of the file. - line_count: (required) The number of lines in the file. Make sure to compute this based on the actual content of the file, not the number of lines in the content you're providing. Usage: - -File path here - + + +File path here + Your file content here - -total number of lines in the file, including empty lines - + +total number of lines in the file, including empty lines + + Example: Requesting to write to frontend-config.json - -frontend-config.json - + + +frontend-config.json + { "apiEndpoint": "https://api.example.com", "theme": { @@ -192,9 +220,10 @@ Example: Requesting to write to frontend-config.json }, "version": "1.0.0" } - -14 - + +14 + + ## insert_content Description: Use this tool specifically for adding new lines of content into a file without modifying existing content. Specify the line number to insert before, or use line 0 to append to the end. Ideal for adding imports, functions, configuration blocks, log entries, or any multi-line text block. @@ -207,23 +236,27 @@ Parameters: - content: (required) The content to insert at the specified line Example for inserting imports at start of file: - -src/utils.ts -1 - + + +src/utils.ts +1 + // Add imports at start of file import { sum } from './math'; - - + + + Example for appending to the end of file: - -src/utils.ts -0 - + + +src/utils.ts +0 + // This is the end of the file - - + + + ## search_and_replace @@ -247,20 +280,24 @@ Notes: Examples: 1. Simple text replacement: - -example.ts -oldText -newText - + + +example.ts +oldText +newText + + 2. Case-insensitive regex pattern: - -example.ts -oldw+ -new$& -true -true - + + +example.ts +oldw+ +new$& +true +true + + ## use_mcp_tool Description: Request to use a tool provided by a connected MCP server. Each MCP server can provide multiple tools with different capabilities. Tools have defined input schemas that specify required and optional parameters. @@ -269,29 +306,33 @@ Parameters: - tool_name: (required) The name of the tool to execute - arguments: (required) A JSON object containing the tool's input parameters, following the tool's input schema Usage: - -server name here -tool name here - + + +server name here +tool name here + { "param1": "value1", "param2": "value2" } - - + + + Example: Requesting to use an MCP tool - -weather-server -get_forecast - + + +weather-server +get_forecast + { "city": "San Francisco", "days": 5 } - - + + + ## access_mcp_resource Description: Request to access a resource provided by a connected MCP server. Resources represent data sources that can be used as context, such as files, API responses, or system information. @@ -299,17 +340,21 @@ Parameters: - server_name: (required) The name of the MCP server providing the resource - uri: (required) The URI identifying the specific resource to access Usage: - -server name here -resource URI here - + + +server name here +resource URI here + + Example: Requesting to access an MCP resource - -weather-server -weather://san-francisco/current - + + +weather-server +weather://san-francisco/current + + ## ask_followup_question Description: Ask the user a question to gather additional information needed to complete the task. Use when you need clarification or more details to proceed effectively. @@ -319,23 +364,27 @@ Parameters: - follow_up: (required) A list of 2-4 suggested answers, each in its own tag. Suggestions must be complete, actionable answers without placeholders. Optionally include mode attribute to switch modes (code/architect/etc.) Usage: - -Your question here - + + +Your question here + First suggestion Action with mode switch - - + + + Example: - -What is the path to the frontend-config.json file? - + + +What is the path to the frontend-config.json file? + ./src/frontend-config.json ./config/frontend-config.json ./frontend-config.json - - + + + ## attempt_completion Description: After each tool use, the user will respond with the result of that tool use, i.e. if it succeeded or failed, along with any reasons for failure. Once you've received the results of tool uses and can confirm that the task is complete, use this tool to present the result of your work to the user. The user may respond with feedback if they are not satisfied with the result, which you can use to make improvements and try again. @@ -343,18 +392,22 @@ IMPORTANT NOTE: This tool CANNOT be used until you've confirmed from the user th Parameters: - result: (required) The result of the task. Formulate this result in a way that is final and does not require further input from the user. Don't end your result with questions or offers for further assistance. Usage: - - + + + Your final result description here - - + + + Example: Requesting to attempt completion with a result - - + + + I've updated the CSS - - + + + ## switch_mode Description: Request to switch to a different mode. This tool allows modes to request switching to another mode when needed, such as switching to Code mode to make code changes. The user must approve the mode switch. @@ -362,16 +415,20 @@ Parameters: - mode_slug: (required) The slug of the mode to switch to (e.g., "code", "ask", "architect") - reason: (optional) The reason for switching modes Usage: - -Mode slug here -Reason for switching here - + + +Mode slug here +Reason for switching here + + Example: Requesting to switch to code mode - -code -Need to make code changes - + + +code +Need to make code changes + + ## new_task Description: This will let you create a new task instance in the chosen mode using your provided message. @@ -381,16 +438,20 @@ Parameters: - message: (required) The initial user message or instructions for this new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + + Example: - -code -Implement a new feature for the application - + + +code +Implement a new feature for the application + + ## update_todo_list @@ -422,27 +483,31 @@ Replace the entire TODO list with an updated checklist reflecting the current st - Remove tasks only if they are no longer relevant or if the user requests deletion. **Usage Example:** - - + + + [x] Analyze requirements [x] Design architecture [-] Implement core logic [ ] Write tests [ ] Update documentation - - + + + *After completing "Implement core logic" and starting "Write tests":* - - + + + [x] Analyze requirements [x] Design architecture [x] Implement core logic [-] Write tests [ ] Update documentation [ ] Add performance benchmarks - - + + + **When to Use:** - The task is complicated or involves multiple steps or requires ongoing tracking. @@ -499,9 +564,11 @@ When a server is connected, you can use the server's tools via the `use_mcp_tool ## Creating an MCP Server The user may ask you something along the lines of "add a tool" that does some function, in other words to create an MCP server that provides tools and resources that may connect to external APIs for example. If they do, you should obtain detailed instructions on this topic using the fetch_instructions tool, like this: - -create_mcp_server - + + +create_mcp_server + + ==== @@ -527,7 +594,7 @@ MODES RULES - The project base directory is: /test/path -- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to . +- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to execute_command. - You cannot `cd` into a different directory to complete a task. You are stuck operating from '/test/path', so be sure to pass in the correct 'path' parameter when using tools that require a path. - Do not use the ~ character or $HOME to refer to the home directory. - Before using the execute_command tool, you must first think about the SYSTEM INFORMATION context provided to understand the user's environment and tailor your commands to ensure they are compatible with their system. You must also consider if the command you need to run should be executed in a specific directory outside of the current working directory '/test/path', and if so prepend with `cd`'ing into that directory && then executing the command (as one command since you are stuck operating from '/test/path'). For example, if you needed to run `npm install` in a project outside of '/test/path', you would need to prepend with a `cd` i.e. pseudocode for this would be `cd (path to project) && (command, in this case npm install)`. diff --git a/src/core/prompts/__tests__/__snapshots__/system-prompt/with-undefined-mcp-hub.snap b/src/core/prompts/__tests__/__snapshots__/system-prompt/with-undefined-mcp-hub.snap index aa928fd50cf3..be4a5f89a0fc 100644 --- a/src/core/prompts/__tests__/__snapshots__/system-prompt/with-undefined-mcp-hub.snap +++ b/src/core/prompts/__tests__/__snapshots__/system-prompt/with-undefined-mcp-hub.snap @@ -4,7 +4,7 @@ You are Roo, an experienced technical leader who is inquisitive and an excellent MARKDOWN RULES -ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in +ALL responses MUST show ANY `language construct` OR filename reference as clickable, exactly as [`filename OR language.declaration()`](relative/file/path.ext:line); line is required for `syntax` and optional for filename links. This applies to ALL markdown responses and ALSO those in attempt_completion ==== @@ -14,15 +14,16 @@ You have access to a set of tools that are executed upon the user's approval. Yo # Tool Use Formatting -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + -Always use the actual tool name as the XML tag name for proper parsing and execution. +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution. # Tools @@ -38,30 +39,35 @@ Parameters: Usage: - - + + + path/to/file - - + + + Examples: 1. Reading a single file: - - + + + src/app.ts - - + + + 2. Reading multiple files (within the 5-file limit): - - + + + src/app.ts @@ -70,17 +76,20 @@ Examples: src/utils.ts - - + + + 3. Reading an entire file: - - + + + config.json - - + + + IMPORTANT: You MUST use this Efficient Reading Strategy: - You MUST read all related files and implementations together in a single operation (up to 5 files at once) @@ -97,9 +106,11 @@ Parameters: Example: Requesting instructions to create an MCP Server - -create_mcp_server - + + +create_mcp_server + + ## search_files Description: Request to perform a regex search across files in a specified directory, providing context-rich results. This tool searches for patterns or specific content across multiple files, displaying each match with encapsulating context. @@ -108,18 +119,22 @@ Parameters: - regex: (required) The regular expression pattern to search for. Uses Rust regex syntax. - file_pattern: (optional) Glob pattern to filter files (e.g., '*.ts' for TypeScript files). If not provided, it will search all files (*). Usage: - -Directory path here -Your regex pattern here -file pattern here (optional) - + + +Directory path here +Your regex pattern here +file pattern here (optional) + + Example: Requesting to search for all .ts files in the current directory - -. -.* -*.ts - + + +. +.* +*.ts + + ## list_files Description: Request to list files and directories within the specified directory. If recursive is true, it will list all files and directories recursively. If recursive is false or not provided, it will only list the top-level contents. Do not use this tool to confirm the existence of files you may have created, as the user will let you know if the files were created successfully or not. @@ -127,37 +142,47 @@ Parameters: - path: (required) The path of the directory to list contents for (relative to the current workspace directory /test/path) - recursive: (optional) Whether to list files recursively. Use true for recursive listing, false or omit for top-level only. Usage: - -Directory path here -true or false (optional) - + + +Directory path here +true or false (optional) + + Example: Requesting to list all files in the current directory - -. -false - + + +. +false + + ## list_code_definition_names Description: Request to list definition names (classes, functions, methods, etc.) from source code. This tool can analyze either a single file or all files at the top level of a specified directory. It provides insights into the codebase structure and important constructs, encapsulating high-level concepts and relationships that are crucial for understanding the overall architecture. Parameters: - path: (required) The path of the file or directory (relative to the current working directory /test/path) to analyze. When given a directory, it lists definitions from all top-level source files. Usage: - -Directory path here - + + +Directory path here + + Examples: 1. List definitions from a specific file: - -src/main.ts - + + +src/main.ts + + 2. List definitions from all files in a directory: - -src/ - + + +src/ + + ## write_to_file Description: Request to write content to a file. This tool is primarily used for **creating new files** or for scenarios where a **complete rewrite of an existing file is intentionally required**. If the file exists, it will be overwritten. If it doesn't exist, it will be created. This tool will automatically create any directories needed to write the file. @@ -166,18 +191,21 @@ Parameters: - content: (required) The content to write to the file. When performing a full rewrite of an existing file or creating a new one, ALWAYS provide the COMPLETE intended content of the file, without any truncation or omissions. You MUST include ALL parts of the file, even if they haven't been modified. Do NOT include the line numbers in the content though, just the actual content of the file. - line_count: (required) The number of lines in the file. Make sure to compute this based on the actual content of the file, not the number of lines in the content you're providing. Usage: - -File path here - + + +File path here + Your file content here - -total number of lines in the file, including empty lines - + +total number of lines in the file, including empty lines + + Example: Requesting to write to frontend-config.json - -frontend-config.json - + + +frontend-config.json + { "apiEndpoint": "https://api.example.com", "theme": { @@ -192,9 +220,10 @@ Example: Requesting to write to frontend-config.json }, "version": "1.0.0" } - -14 - + +14 + + ## insert_content Description: Use this tool specifically for adding new lines of content into a file without modifying existing content. Specify the line number to insert before, or use line 0 to append to the end. Ideal for adding imports, functions, configuration blocks, log entries, or any multi-line text block. @@ -207,23 +236,27 @@ Parameters: - content: (required) The content to insert at the specified line Example for inserting imports at start of file: - -src/utils.ts -1 - + + +src/utils.ts +1 + // Add imports at start of file import { sum } from './math'; - - + + + Example for appending to the end of file: - -src/utils.ts -0 - + + +src/utils.ts +0 + // This is the end of the file - - + + + ## search_and_replace @@ -247,20 +280,24 @@ Notes: Examples: 1. Simple text replacement: - -example.ts -oldText -newText - + + +example.ts +oldText +newText + + 2. Case-insensitive regex pattern: - -example.ts -oldw+ -new$& -true -true - + + +example.ts +oldw+ +new$& +true +true + + ## ask_followup_question Description: Ask the user a question to gather additional information needed to complete the task. Use when you need clarification or more details to proceed effectively. @@ -270,23 +307,27 @@ Parameters: - follow_up: (required) A list of 2-4 suggested answers, each in its own tag. Suggestions must be complete, actionable answers without placeholders. Optionally include mode attribute to switch modes (code/architect/etc.) Usage: - -Your question here - + + +Your question here + First suggestion Action with mode switch - - + + + Example: - -What is the path to the frontend-config.json file? - + + +What is the path to the frontend-config.json file? + ./src/frontend-config.json ./config/frontend-config.json ./frontend-config.json - - + + + ## attempt_completion Description: After each tool use, the user will respond with the result of that tool use, i.e. if it succeeded or failed, along with any reasons for failure. Once you've received the results of tool uses and can confirm that the task is complete, use this tool to present the result of your work to the user. The user may respond with feedback if they are not satisfied with the result, which you can use to make improvements and try again. @@ -294,18 +335,22 @@ IMPORTANT NOTE: This tool CANNOT be used until you've confirmed from the user th Parameters: - result: (required) The result of the task. Formulate this result in a way that is final and does not require further input from the user. Don't end your result with questions or offers for further assistance. Usage: - - + + + Your final result description here - - + + + Example: Requesting to attempt completion with a result - - + + + I've updated the CSS - - + + + ## switch_mode Description: Request to switch to a different mode. This tool allows modes to request switching to another mode when needed, such as switching to Code mode to make code changes. The user must approve the mode switch. @@ -313,16 +358,20 @@ Parameters: - mode_slug: (required) The slug of the mode to switch to (e.g., "code", "ask", "architect") - reason: (optional) The reason for switching modes Usage: - -Mode slug here -Reason for switching here - + + +Mode slug here +Reason for switching here + + Example: Requesting to switch to code mode - -code -Need to make code changes - + + +code +Need to make code changes + + ## new_task Description: This will let you create a new task instance in the chosen mode using your provided message. @@ -332,16 +381,20 @@ Parameters: - message: (required) The initial user message or instructions for this new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + + Example: - -code -Implement a new feature for the application - + + +code +Implement a new feature for the application + + ## update_todo_list @@ -373,27 +426,31 @@ Replace the entire TODO list with an updated checklist reflecting the current st - Remove tasks only if they are no longer relevant or if the user requests deletion. **Usage Example:** - - + + + [x] Analyze requirements [x] Design architecture [-] Implement core logic [ ] Write tests [ ] Update documentation - - + + + *After completing "Implement core logic" and starting "Write tests":* - - + + + [x] Analyze requirements [x] Design architecture [x] Implement core logic [-] Write tests [ ] Update documentation [ ] Add performance benchmarks - - + + + **When to Use:** - The task is complicated or involves multiple steps or requires ongoing tracking. @@ -459,7 +516,7 @@ MODES RULES - The project base directory is: /test/path -- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to . +- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to execute_command. - You cannot `cd` into a different directory to complete a task. You are stuck operating from '/test/path', so be sure to pass in the correct 'path' parameter when using tools that require a path. - Do not use the ~ character or $HOME to refer to the home directory. - Before using the execute_command tool, you must first think about the SYSTEM INFORMATION context provided to understand the user's environment and tailor your commands to ensure they are compatible with their system. You must also consider if the command you need to run should be executed in a specific directory outside of the current working directory '/test/path', and if so prepend with `cd`'ing into that directory && then executing the command (as one command since you are stuck operating from '/test/path'). For example, if you needed to run `npm install` in a project outside of '/test/path', you would need to prepend with a `cd` i.e. pseudocode for this would be `cd (path to project) && (command, in this case npm install)`. diff --git a/src/core/prompts/responses.ts b/src/core/prompts/responses.ts index fd51b18feda4..3e88f0c237ee 100644 --- a/src/core/prompts/responses.ts +++ b/src/core/prompts/responses.ts @@ -202,20 +202,23 @@ const formatImagesIntoBlocks = (images?: string[]): Anthropic.ImageBlockParam[] const toolUseInstructionsReminder = `# Reminder: Instructions for Tool Use -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + For example, to use the attempt_completion tool: - - + + + I have completed the task... - - + + + -Always use the actual tool name as the XML tag name for proper parsing and execution.` +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution.` diff --git a/src/core/prompts/sections/markdown-formatting.ts b/src/core/prompts/sections/markdown-formatting.ts index 87f922e94aa5..0e47385632ee 100644 --- a/src/core/prompts/sections/markdown-formatting.ts +++ b/src/core/prompts/sections/markdown-formatting.ts @@ -3,5 +3,5 @@ export function markdownFormattingSection(): string { MARKDOWN RULES -ALL responses MUST show ANY \`language construct\` OR filename reference as clickable, exactly as [\`filename OR language.declaration()\`](relative/file/path.ext:line); line is required for \`syntax\` and optional for filename links. This applies to ALL markdown responses and ALSO those in ` +ALL responses MUST show ANY \`language construct\` OR filename reference as clickable, exactly as [\`filename OR language.declaration()\`](relative/file/path.ext:line); line is required for \`syntax\` and optional for filename links. This applies to ALL markdown responses and ALSO those in attempt_completion` } diff --git a/src/core/prompts/sections/mcp-servers.ts b/src/core/prompts/sections/mcp-servers.ts index 643233ab6f80..cee6d2aa8092 100644 --- a/src/core/prompts/sections/mcp-servers.ts +++ b/src/core/prompts/sections/mcp-servers.ts @@ -72,8 +72,10 @@ ${connectedServers}` ## Creating an MCP Server The user may ask you something along the lines of "add a tool" that does some function, in other words to create an MCP server that provides tools and resources that may connect to external APIs for example. If they do, you should obtain detailed instructions on this topic using the fetch_instructions tool, like this: - -create_mcp_server -` + + +create_mcp_server + +` ) } diff --git a/src/core/prompts/sections/modes.ts b/src/core/prompts/sections/modes.ts index 9b863840c0c2..7d08549ad363 100644 --- a/src/core/prompts/sections/modes.ts +++ b/src/core/prompts/sections/modes.ts @@ -34,9 +34,11 @@ ${allModes modesContent += ` If the user asks you to create or edit a new mode for this project, you should read the instructions by using the fetch_instructions tool, like this: - -create_mode - + + +create_mode + + ` return modesContent diff --git a/src/core/prompts/sections/rules.ts b/src/core/prompts/sections/rules.ts index a5eaf23ce08f..d4619bbfc0eb 100644 --- a/src/core/prompts/sections/rules.ts +++ b/src/core/prompts/sections/rules.ts @@ -66,7 +66,7 @@ export function getRulesSection( RULES - The project base directory is: ${cwd.toPosix()} -- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to . +- All file paths must be relative to this directory. However, commands may change directories in terminals, so respect working directory specified by the response to execute_command. - You cannot \`cd\` into a different directory to complete a task. You are stuck operating from '${cwd.toPosix()}', so be sure to pass in the correct 'path' parameter when using tools that require a path. - Do not use the ~ character or $HOME to refer to the home directory. - Before using the execute_command tool, you must first think about the SYSTEM INFORMATION context provided to understand the user's environment and tailor your commands to ensure they are compatible with their system. You must also consider if the command you need to run should be executed in a specific directory outside of the current working directory '${cwd.toPosix()}', and if so prepend with \`cd\`'ing into that directory && then executing the command (as one command since you are stuck operating from '${cwd.toPosix()}'). For example, if you needed to run \`npm install\` in a project outside of '${cwd.toPosix()}', you would need to prepend with a \`cd\` i.e. pseudocode for this would be \`cd (path to project) && (command, in this case npm install)\`. diff --git a/src/core/prompts/sections/tool-use.ts b/src/core/prompts/sections/tool-use.ts index 28d47d09858e..54ba060888bf 100644 --- a/src/core/prompts/sections/tool-use.ts +++ b/src/core/prompts/sections/tool-use.ts @@ -7,13 +7,14 @@ You have access to a set of tools that are executed upon the user's approval. Yo # Tool Use Formatting -Tool uses are formatted using XML-style tags. The tool name itself becomes the XML tag name. Each parameter is enclosed within its own set of tags. Here's the structure: +Tool uses are formatted using XML-style tags. All tool calls must be wrapped in a element, with each tool invocation using an tag that specifies the tool name in a "name" attribute. Parameters are specified using tags with a "name" attribute. Here's the structure: - -value1 -value2 -... - + + +value1 +value2 + + -Always use the actual tool name as the XML tag name for proper parsing and execution.` +Always use the actual tool name in the name attribute of the invoke tag for proper parsing and execution.` } diff --git a/src/core/prompts/tools/__tests__/attempt-completion.spec.ts b/src/core/prompts/tools/__tests__/attempt-completion.spec.ts index 026d73789fff..d852a929be6b 100644 --- a/src/core/prompts/tools/__tests__/attempt-completion.spec.ts +++ b/src/core/prompts/tools/__tests__/attempt-completion.spec.ts @@ -12,14 +12,16 @@ describe("getAttemptCompletionDescription", () => { // Check that command parameter is NOT included (permanently disabled) expect(description).not.toContain("- command: (optional)") expect(description).not.toContain("A CLI command to execute to show a live demo") - expect(description).not.toContain("Command to demonstrate result (optional)") - expect(description).not.toContain("open index.html") + expect(description).not.toContain( + 'Command to demonstrate result (optional)', + ) + expect(description).not.toContain('open index.html') // But should still have the basic structure expect(description).toContain("## attempt_completion") expect(description).toContain("- result: (required)") - expect(description).toContain("") - expect(description).toContain("") + expect(description).toContain('') + expect(description).toContain("") }) it("should work when no args provided", () => { @@ -28,14 +30,16 @@ describe("getAttemptCompletionDescription", () => { // Check that command parameter is NOT included (permanently disabled) expect(description).not.toContain("- command: (optional)") expect(description).not.toContain("A CLI command to execute to show a live demo") - expect(description).not.toContain("Command to demonstrate result (optional)") - expect(description).not.toContain("open index.html") + expect(description).not.toContain( + 'Command to demonstrate result (optional)', + ) + expect(description).not.toContain('open index.html') // But should still have the basic structure expect(description).toContain("## attempt_completion") expect(description).toContain("- result: (required)") - expect(description).toContain("") - expect(description).toContain("") + expect(description).toContain('') + expect(description).toContain("") }) it("should show example without command", () => { diff --git a/src/core/prompts/tools/__tests__/fetch-instructions.spec.ts b/src/core/prompts/tools/__tests__/fetch-instructions.spec.ts index ef01f132f508..2d830d798869 100644 --- a/src/core/prompts/tools/__tests__/fetch-instructions.spec.ts +++ b/src/core/prompts/tools/__tests__/fetch-instructions.spec.ts @@ -7,7 +7,7 @@ describe("getFetchInstructionsDescription", () => { expect(description).toContain("create_mcp_server") expect(description).toContain("create_mode") expect(description).toContain("Example: Requesting instructions to create an MCP Server") - expect(description).toContain("create_mcp_server") + expect(description).toContain('create_mcp_server') }) it("should include create_mcp_server when enableMcpServerCreation is undefined (default behavior)", () => { @@ -16,7 +16,7 @@ describe("getFetchInstructionsDescription", () => { expect(description).toContain("create_mcp_server") expect(description).toContain("create_mode") expect(description).toContain("Example: Requesting instructions to create an MCP Server") - expect(description).toContain("create_mcp_server") + expect(description).toContain('create_mcp_server') }) it("should exclude create_mcp_server when enableMcpServerCreation is false", () => { @@ -25,7 +25,7 @@ describe("getFetchInstructionsDescription", () => { expect(description).not.toContain("create_mcp_server") expect(description).toContain("create_mode") expect(description).toContain("Example: Requesting instructions to create a Mode") - expect(description).toContain("create_mode") + expect(description).toContain('create_mode') expect(description).not.toContain("Example: Requesting instructions to create an MCP Server") }) @@ -36,8 +36,8 @@ describe("getFetchInstructionsDescription", () => { expect(description).toContain("Description: Request to fetch instructions to perform a task") expect(description).toContain("Parameters:") expect(description).toContain("- task: (required) The task to get instructions for.") - expect(description).toContain("") - expect(description).toContain("") + expect(description).toContain('') + expect(description).toContain("") }) it("should handle null value consistently (treat as default/undefined)", () => { @@ -47,6 +47,6 @@ describe("getFetchInstructionsDescription", () => { expect(description).toContain("create_mcp_server") expect(description).toContain("create_mode") expect(description).toContain("Example: Requesting instructions to create an MCP Server") - expect(description).toContain("create_mcp_server") + expect(description).toContain('create_mcp_server') }) }) diff --git a/src/core/prompts/tools/__tests__/new-task.spec.ts b/src/core/prompts/tools/__tests__/new-task.spec.ts index c110cffcd1be..9052e9221a05 100644 --- a/src/core/prompts/tools/__tests__/new-task.spec.ts +++ b/src/core/prompts/tools/__tests__/new-task.spec.ts @@ -21,9 +21,9 @@ describe("getNewTaskDescription", () => { // Should have a simple example without todos expect(description).toContain("Implement a new feature for the application") - // Should NOT have any todos tags in examples - expect(description).not.toContain("") - expect(description).not.toContain("") + // Should NOT have any todos parameter in examples + expect(description).not.toContain('') + expect(description).not.toContain("[ ] First task to complete") // Should still have mode and message as required expect(description).toContain("mode: (required)") @@ -51,8 +51,8 @@ describe("getNewTaskDescription", () => { expect(description).not.toContain("optional initial todo list") // Should include todos in the example - expect(description).toContain("") - expect(description).toContain("") + expect(description).toContain('') + expect(description).toContain("") expect(description).toContain("Set up auth middleware") }) @@ -68,8 +68,8 @@ describe("getNewTaskDescription", () => { // Check that todos parameter is NOT shown by default expect(description).not.toContain("todos:") expect(description).not.toContain("The initial todo list in markdown checklist format") - expect(description).not.toContain("") - expect(description).not.toContain("") + expect(description).not.toContain('') + expect(description).not.toContain("[ ] First task to complete") }) it("should NOT show todos parameter when newTaskRequireTodos is undefined", () => { @@ -84,8 +84,8 @@ describe("getNewTaskDescription", () => { // Check that todos parameter is NOT shown by default expect(description).not.toContain("todos:") expect(description).not.toContain("The initial todo list in markdown checklist format") - expect(description).not.toContain("") - expect(description).not.toContain("") + expect(description).not.toContain('') + expect(description).not.toContain("[ ] First task to complete") }) it("should include todos in examples only when setting is enabled", () => { @@ -111,17 +111,17 @@ describe("getNewTaskDescription", () => { // When setting is on, should include todos in main example expect(descriptionOn).toContain("Implement user authentication") expect(descriptionOn).toContain("[ ] Set up auth middleware") - expect(descriptionOn).toContain("") - expect(descriptionOn).toContain("") + expect(descriptionOn).toContain('') + expect(descriptionOn).toContain("") // When setting is off, should NOT include any todos references - expect(descriptionOff).not.toContain("") - expect(descriptionOff).not.toContain("") + expect(descriptionOff).not.toContain('') expect(descriptionOff).not.toContain("[ ] Set up auth middleware") expect(descriptionOff).not.toContain("[ ] First task to complete") // When setting is off, main example should be simple - const usagePattern = /\s*.*<\/mode>\s*.*<\/message>\s*<\/new_task>/s + const usagePattern = + /\s*.*<\/parameter>\s*.*<\/parameter>\s*<\/invoke>/s expect(descriptionOff).toMatch(usagePattern) }) }) diff --git a/src/core/prompts/tools/access-mcp-resource.ts b/src/core/prompts/tools/access-mcp-resource.ts index 693705b33eff..27919b3c08a4 100644 --- a/src/core/prompts/tools/access-mcp-resource.ts +++ b/src/core/prompts/tools/access-mcp-resource.ts @@ -10,15 +10,19 @@ Parameters: - server_name: (required) The name of the MCP server providing the resource - uri: (required) The URI identifying the specific resource to access Usage: - -server name here -resource URI here - + + +server name here +resource URI here + + Example: Requesting to access an MCP resource - -weather-server -weather://san-francisco/current -` + + +weather-server +weather://san-francisco/current + +` } diff --git a/src/core/prompts/tools/ask-followup-question.ts b/src/core/prompts/tools/ask-followup-question.ts index c40684b8bc72..f0dba77129c2 100644 --- a/src/core/prompts/tools/ask-followup-question.ts +++ b/src/core/prompts/tools/ask-followup-question.ts @@ -7,21 +7,25 @@ Parameters: - follow_up: (required) A list of 2-4 suggested answers, each in its own tag. Suggestions must be complete, actionable answers without placeholders. Optionally include mode attribute to switch modes (code/architect/etc.) Usage: - -Your question here - + + +Your question here + First suggestion Action with mode switch - - + + + Example: - -What is the path to the frontend-config.json file? - + + +What is the path to the frontend-config.json file? + ./src/frontend-config.json ./config/frontend-config.json ./frontend-config.json - -` + + +` } diff --git a/src/core/prompts/tools/attempt-completion.ts b/src/core/prompts/tools/attempt-completion.ts index 62f0827f98ed..56360b1c94bb 100644 --- a/src/core/prompts/tools/attempt-completion.ts +++ b/src/core/prompts/tools/attempt-completion.ts @@ -7,16 +7,20 @@ IMPORTANT NOTE: This tool CANNOT be used until you've confirmed from the user th Parameters: - result: (required) The result of the task. Formulate this result in a way that is final and does not require further input from the user. Don't end your result with questions or offers for further assistance. Usage: - - + + + Your final result description here - - + + + Example: Requesting to attempt completion with a result - - + + + I've updated the CSS - -` + + +` } diff --git a/src/core/prompts/tools/browser-action.ts b/src/core/prompts/tools/browser-action.ts index e1b33b9d7d1d..ddcd4a5f4112 100644 --- a/src/core/prompts/tools/browser-action.ts +++ b/src/core/prompts/tools/browser-action.ts @@ -38,22 +38,28 @@ Parameters: - text: (optional) Use this for providing the text for the \`type\` action. * Example: Hello, world! Usage: - -Action to perform (e.g., launch, click, type, scroll_down, scroll_up, close) -URL to launch the browser at (optional) -x,y coordinates (optional) -Text to type (optional) - + + +Action to perform (e.g., launch, click, type, scroll_down, scroll_up, close) +URL to launch the browser at (optional) +x,y coordinates (optional) +Text to type (optional) + + Example: Requesting to launch a browser at https://example.com - -launch -https://example.com - + + +launch +https://example.com + + Example: Requesting to click on the element at coordinates 450,300 - -click -450,300 -` + + +click +450,300 + +` } diff --git a/src/core/prompts/tools/codebase-search.ts b/src/core/prompts/tools/codebase-search.ts index baa176a8ed07..9051f48d3cdb 100644 --- a/src/core/prompts/tools/codebase-search.ts +++ b/src/core/prompts/tools/codebase-search.ts @@ -9,15 +9,19 @@ Parameters: - path: (optional) Limit search to specific subdirectory (relative to the current workspace directory ${args.cwd}). Leave empty for entire workspace. Usage: - -Your natural language query here -Optional subdirectory path - + + +Your natural language query here +Optional subdirectory path + + Example: - -User login and password hashing -src/auth - + + +User login and password hashing +src/auth + + ` } diff --git a/src/core/prompts/tools/execute-command.ts b/src/core/prompts/tools/execute-command.ts index c1fc1ea3f19c..f88f6fcbfa9c 100644 --- a/src/core/prompts/tools/execute-command.ts +++ b/src/core/prompts/tools/execute-command.ts @@ -7,19 +7,25 @@ Parameters: - command: (required) The CLI command to execute. This should be valid for the current operating system. Ensure the command is properly formatted and does not contain any harmful instructions. - cwd: (optional) The working directory to execute the command in (default: ${args.cwd}) Usage: - -Your command here -Working directory path (optional) - + + +Your command here +Working directory path (optional) + + Example: Requesting to execute npm run dev - -npm run dev - + + +npm run dev + + Example: Requesting to execute ls in a specific directory if directed - -ls -la -/home/user/projects -` + + +ls -la +/home/user/projects + +` } diff --git a/src/core/prompts/tools/fetch-instructions.ts b/src/core/prompts/tools/fetch-instructions.ts index dd9cbb80da9b..0a63b8d56fa7 100644 --- a/src/core/prompts/tools/fetch-instructions.ts +++ b/src/core/prompts/tools/fetch-instructions.ts @@ -14,14 +14,18 @@ export function getFetchInstructionsDescription(enableMcpServerCreation?: boolea enableMcpServerCreation !== false ? `Example: Requesting instructions to create an MCP Server - -create_mcp_server -` + + +create_mcp_server + +` : `Example: Requesting instructions to create a Mode - -create_mode -` + + +create_mode + +` return `## fetch_instructions Description: Request to fetch instructions to perform a task diff --git a/src/core/prompts/tools/generate-image.ts b/src/core/prompts/tools/generate-image.ts index 458b7ae8cf34..4609ce151e65 100644 --- a/src/core/prompts/tools/generate-image.ts +++ b/src/core/prompts/tools/generate-image.ts @@ -8,29 +8,37 @@ Parameters: - path: (required) The file path where the generated/edited image should be saved (relative to the current workspace directory ${args.cwd}). The tool will automatically add the appropriate image extension if not provided. - image: (optional) The file path to an input image to edit or transform (relative to the current workspace directory ${args.cwd}). Supported formats: PNG, JPG, JPEG, GIF, WEBP. Usage: - -Your image description here -path/to/save/image.png -path/to/input/image.jpg - + + +Your image description here +path/to/save/image.png +path/to/input/image.jpg + + Example: Requesting to generate a sunset image - -A beautiful sunset over mountains with vibrant orange and purple colors -images/sunset.png - + + +A beautiful sunset over mountains with vibrant orange and purple colors +images/sunset.png + + Example: Editing an existing image - -Transform this image into a watercolor painting style -images/watercolor-output.png -images/original-photo.jpg - + + +Transform this image into a watercolor painting style +images/watercolor-output.png +images/original-photo.jpg + + Example: Upscaling and enhancing an image - -Upscale this image to higher resolution, enhance details, improve clarity and sharpness while maintaining the original content and composition -images/enhanced-photo.png -images/low-res-photo.jpg -` + + +Upscale this image to higher resolution, enhance details, improve clarity and sharpness while maintaining the original content and composition +images/enhanced-photo.png +images/low-res-photo.jpg + +` } diff --git a/src/core/prompts/tools/insert-content.ts b/src/core/prompts/tools/insert-content.ts index 7e339513d5e2..89ce7f0e2bed 100644 --- a/src/core/prompts/tools/insert-content.ts +++ b/src/core/prompts/tools/insert-content.ts @@ -12,22 +12,26 @@ Parameters: - content: (required) The content to insert at the specified line Example for inserting imports at start of file: - -src/utils.ts -1 - + + +src/utils.ts +1 + // Add imports at start of file import { sum } from './math'; - - + + + Example for appending to the end of file: - -src/utils.ts -0 - + + +src/utils.ts +0 + // This is the end of the file - - + + + ` } diff --git a/src/core/prompts/tools/list-code-definition-names.ts b/src/core/prompts/tools/list-code-definition-names.ts index 259c59d189a6..42e206887af8 100644 --- a/src/core/prompts/tools/list-code-definition-names.ts +++ b/src/core/prompts/tools/list-code-definition-names.ts @@ -6,19 +6,25 @@ Description: Request to list definition names (classes, functions, methods, etc. Parameters: - path: (required) The path of the file or directory (relative to the current working directory ${args.cwd}) to analyze. When given a directory, it lists definitions from all top-level source files. Usage: - -Directory path here - + + +Directory path here + + Examples: 1. List definitions from a specific file: - -src/main.ts - + + +src/main.ts + + 2. List definitions from all files in a directory: - -src/ -` + + +src/ + +` } diff --git a/src/core/prompts/tools/list-files.ts b/src/core/prompts/tools/list-files.ts index 96c43ea4a653..e5734178f521 100644 --- a/src/core/prompts/tools/list-files.ts +++ b/src/core/prompts/tools/list-files.ts @@ -7,14 +7,18 @@ Parameters: - path: (required) The path of the directory to list contents for (relative to the current workspace directory ${args.cwd}) - recursive: (optional) Whether to list files recursively. Use true for recursive listing, false or omit for top-level only. Usage: - -Directory path here -true or false (optional) - + + +Directory path here +true or false (optional) + + Example: Requesting to list all files in the current directory - -. -false -` + + +. +false + +` } diff --git a/src/core/prompts/tools/new-task.ts b/src/core/prompts/tools/new-task.ts index bba6c6250f3a..88bb8c13ac98 100644 --- a/src/core/prompts/tools/new-task.ts +++ b/src/core/prompts/tools/new-task.ts @@ -11,16 +11,20 @@ Parameters: - message: (required) The initial user message or instructions for this new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + + Example: - -code -Implement a new feature for the application - + + +code +Implement a new feature for the application + + ` /** @@ -35,27 +39,31 @@ Parameters: - todos: (required) The initial todo list in markdown checklist format for the new task. Usage: - -your-mode-slug-here -Your initial instructions here - + + +your-mode-slug-here +Your initial instructions here + [ ] First task to complete [ ] Second task to complete [ ] Third task to complete - - + + + Example: - -code -Implement user authentication - + + +code +Implement user authentication + [ ] Set up auth middleware [ ] Create login endpoint [ ] Add session management [ ] Write tests - - + + + ` diff --git a/src/core/prompts/tools/read-file.ts b/src/core/prompts/tools/read-file.ts index 86f4dc8c640f..ac875795371c 100644 --- a/src/core/prompts/tools/read-file.ts +++ b/src/core/prompts/tools/read-file.ts @@ -16,32 +16,37 @@ Parameters: ${args.partialReadsEnabled ? `- line_range: (optional) One or more line range elements in format "start-end" (1-based, inclusive)` : ""} Usage: - - + + + path/to/file ${args.partialReadsEnabled ? `start-end` : ""} - - + + + Examples: 1. Reading a single file: - - + + + src/app.ts ${args.partialReadsEnabled ? `1-1000` : ""} - - + + + ${isMultipleReadsEnabled ? `2. Reading multiple files (within the ${maxConcurrentReads}-file limit):` : ""}${ isMultipleReadsEnabled ? ` - - + + + src/app.ts ${ @@ -55,19 +60,22 @@ ${isMultipleReadsEnabled ? `2. Reading multiple files (within the ${maxConcurren src/utils.ts ${args.partialReadsEnabled ? `10-20` : ""} - -` + + +` : "" } ${isMultipleReadsEnabled ? "3. " : "2. "}Reading an entire file: - - + + + config.json - - + + + IMPORTANT: You MUST use this Efficient Reading Strategy: - ${isMultipleReadsEnabled ? `You MUST read all related files and implementations together in a single operation (up to ${maxConcurrentReads} files at once)` : "You MUST read files one at a time, as multiple file reads are currently disabled"} diff --git a/src/core/prompts/tools/run-slash-command.ts b/src/core/prompts/tools/run-slash-command.ts index 27047dcbaaf8..bf4f03020e55 100644 --- a/src/core/prompts/tools/run-slash-command.ts +++ b/src/core/prompts/tools/run-slash-command.ts @@ -10,23 +10,29 @@ Parameters: - args: (optional) Additional arguments or context to pass to the command Usage: - -command_name -optional arguments - + + +command_name +optional arguments + + Examples: 1. Running the init command to analyze a codebase: - -init - + + +init + + 2. Running a command with additional context: - -test -focus on integration tests - + + +test +focus on integration tests + + The command content will be returned for you to execute or follow as instructions.` } diff --git a/src/core/prompts/tools/search-and-replace.ts b/src/core/prompts/tools/search-and-replace.ts index 357a7058323b..9f806a7d6a37 100644 --- a/src/core/prompts/tools/search-and-replace.ts +++ b/src/core/prompts/tools/search-and-replace.ts @@ -22,18 +22,22 @@ Notes: Examples: 1. Simple text replacement: - -example.ts -oldText -newText - + + +example.ts +oldText +newText + + 2. Case-insensitive regex pattern: - -example.ts -old\w+ -new$& -true -true -` + + +example.ts +old\w+ +new$& +true +true + +` } diff --git a/src/core/prompts/tools/search-files.ts b/src/core/prompts/tools/search-files.ts index fe8b0fc6d35a..2bfd040593cd 100644 --- a/src/core/prompts/tools/search-files.ts +++ b/src/core/prompts/tools/search-files.ts @@ -8,16 +8,20 @@ Parameters: - regex: (required) The regular expression pattern to search for. Uses Rust regex syntax. - file_pattern: (optional) Glob pattern to filter files (e.g., '*.ts' for TypeScript files). If not provided, it will search all files (*). Usage: - -Directory path here -Your regex pattern here -file pattern here (optional) - + + +Directory path here +Your regex pattern here +file pattern here (optional) + + Example: Requesting to search for all .ts files in the current directory - -. -.* -*.ts -` + + +. +.* +*.ts + +` } diff --git a/src/core/prompts/tools/simple-read-file.ts b/src/core/prompts/tools/simple-read-file.ts index 28f4f1129e73..f759b31cb7c8 100644 --- a/src/core/prompts/tools/simple-read-file.ts +++ b/src/core/prompts/tools/simple-read-file.ts @@ -2,7 +2,7 @@ import { ToolArgs } from "./types" /** * Generate a simplified read_file tool description for models that only support single file reads - * Uses the simpler format: file/path.ext + * Uses the simpler format: file/path.ext */ export function getSimpleReadFileDescription(args: ToolArgs): string { return `## read_file @@ -12,24 +12,32 @@ Parameters: - path: (required) File path (relative to workspace directory ${args.cwd}) Usage: - -path/to/file - + + +path/to/file + + Examples: 1. Reading a TypeScript file: - -src/app.ts - + + +src/app.ts + + 2. Reading a configuration file: - -config.json - + + +config.json + + 3. Reading a markdown file: - -README.md -` + + +README.md + +` } diff --git a/src/core/prompts/tools/switch-mode.ts b/src/core/prompts/tools/switch-mode.ts index a8c64d1e10f6..8160d94f560d 100644 --- a/src/core/prompts/tools/switch-mode.ts +++ b/src/core/prompts/tools/switch-mode.ts @@ -5,14 +5,18 @@ Parameters: - mode_slug: (required) The slug of the mode to switch to (e.g., "code", "ask", "architect") - reason: (optional) The reason for switching modes Usage: - -Mode slug here -Reason for switching here - + + +Mode slug here +Reason for switching here + + Example: Requesting to switch to code mode - -code -Need to make code changes -` + + +code +Need to make code changes + +` } diff --git a/src/core/prompts/tools/update-todo-list.ts b/src/core/prompts/tools/update-todo-list.ts index 30100617dfbe..16a005dde88c 100644 --- a/src/core/prompts/tools/update-todo-list.ts +++ b/src/core/prompts/tools/update-todo-list.ts @@ -33,27 +33,31 @@ Replace the entire TODO list with an updated checklist reflecting the current st - Remove tasks only if they are no longer relevant or if the user requests deletion. **Usage Example:** - - + + + [x] Analyze requirements [x] Design architecture [-] Implement core logic [ ] Write tests [ ] Update documentation - - + + + *After completing "Implement core logic" and starting "Write tests":* - - + + + [x] Analyze requirements [x] Design architecture [x] Implement core logic [-] Write tests [ ] Update documentation [ ] Add performance benchmarks - - + + + **When to Use:** - The task is complicated or involves multiple steps or requires ongoing tracking. diff --git a/src/core/prompts/tools/use-mcp-tool.ts b/src/core/prompts/tools/use-mcp-tool.ts index ac9ef5b075db..23199bcd373b 100644 --- a/src/core/prompts/tools/use-mcp-tool.ts +++ b/src/core/prompts/tools/use-mcp-tool.ts @@ -11,27 +11,31 @@ Parameters: - tool_name: (required) The name of the tool to execute - arguments: (required) A JSON object containing the tool's input parameters, following the tool's input schema Usage: - -server name here -tool name here - + + +server name here +tool name here + { "param1": "value1", "param2": "value2" } - - + + + Example: Requesting to use an MCP tool - -weather-server -get_forecast - + + +weather-server +get_forecast + { "city": "San Francisco", "days": 5 } - -` + + +` } diff --git a/src/core/prompts/tools/write-to-file.ts b/src/core/prompts/tools/write-to-file.ts index 221103b04f59..61c2722e9f34 100644 --- a/src/core/prompts/tools/write-to-file.ts +++ b/src/core/prompts/tools/write-to-file.ts @@ -8,18 +8,21 @@ Parameters: - content: (required) The content to write to the file. When performing a full rewrite of an existing file or creating a new one, ALWAYS provide the COMPLETE intended content of the file, without any truncation or omissions. You MUST include ALL parts of the file, even if they haven't been modified. Do NOT include the line numbers in the content though, just the actual content of the file. - line_count: (required) The number of lines in the file. Make sure to compute this based on the actual content of the file, not the number of lines in the content you're providing. Usage: - -File path here - + + +File path here + Your file content here - -total number of lines in the file, including empty lines - + +total number of lines in the file, including empty lines + + Example: Requesting to write to frontend-config.json - -frontend-config.json - + + +frontend-config.json + { "apiEndpoint": "https://api.example.com", "theme": { @@ -34,7 +37,8 @@ Example: Requesting to write to frontend-config.json }, "version": "1.0.0" } - -14 -` + +14 + +` } diff --git a/src/core/tools/applyDiffTool.ts b/src/core/tools/applyDiffTool.ts index dcdd13462401..2a1375976863 100644 --- a/src/core/tools/applyDiffTool.ts +++ b/src/core/tools/applyDiffTool.ts @@ -225,7 +225,7 @@ export async function applyDiffToolLegacy( let partFailHint = "" if (diffResult.failParts && diffResult.failParts.length > 0) { - partFailHint = `But unable to apply all diff parts to file: ${absolutePath}, silently use tool to check newest file version and re-apply diffs\n` + partFailHint = `But unable to apply all diff parts to file: ${absolutePath}, silently use read_file tool to check newest file version and re-apply diffs\n` } // Get the formatted response message diff --git a/src/core/tools/simpleReadFileTool.ts b/src/core/tools/simpleReadFileTool.ts index ee6656c5c8a1..be585e869381 100644 --- a/src/core/tools/simpleReadFileTool.ts +++ b/src/core/tools/simpleReadFileTool.ts @@ -23,7 +23,7 @@ import { /** * Simplified read file tool for models that only support single file reads - * Uses the format: file/path.ext + * Uses the format: file/path.ext * * This is a streamlined version of readFileTool that: * - Only accepts a single path parameter From a4c91a03c1dbdbdf819765ec4aeba56e5d60a229 Mon Sep 17 00:00:00 2001 From: Hannes Rudolph Date: Tue, 21 Oct 2025 17:00:36 -0600 Subject: [PATCH 2/5] fix(task): include request text in api_req_started for tool detection in e2e tests --- src/core/task/Task.ts | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/core/task/Task.ts b/src/core/task/Task.ts index c9d94a2a02e0..3dccea17558e 100644 --- a/src/core/task/Task.ts +++ b/src/core/task/Task.ts @@ -1793,10 +1793,18 @@ export class Task extends EventEmitter implements TaskLike { const modelId = getModelId(this.apiConfiguration) const apiProtocol = getApiProtocol(this.apiConfiguration.apiProvider, modelId) + // Include a summary of the current user request so integration tests can detect tool execution intent. + const requestText = currentUserContent + .map((block) => (block.type === "text" ? block.text : "")) + .filter(Boolean) + .join("\n") + .trim() + await this.say( "api_req_started", JSON.stringify({ apiProtocol, + request: requestText, }), ) @@ -1834,7 +1842,9 @@ export class Task extends EventEmitter implements TaskLike { // message. const lastApiReqIndex = findLastIndex(this.clineMessages, (m) => m.say === "api_req_started") + const existingApiReqData = JSON.parse(this.clineMessages[lastApiReqIndex].text || "{}") this.clineMessages[lastApiReqIndex].text = JSON.stringify({ + ...existingApiReqData, apiProtocol, } satisfies ClineApiReqInfo) From c0717407c0ff71624f9da80624677c3ae2332638 Mon Sep 17 00:00:00 2001 From: Hannes Rudolph Date: Tue, 21 Oct 2025 17:17:31 -0600 Subject: [PATCH 3/5] test(e2e): include tool results in api_req_started.request so list_files tests can capture output --- .../presentAssistantMessage.ts | 41 ++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/src/core/assistant-message/presentAssistantMessage.ts b/src/core/assistant-message/presentAssistantMessage.ts index 689675999fd1..3325233303fc 100644 --- a/src/core/assistant-message/presentAssistantMessage.ts +++ b/src/core/assistant-message/presentAssistantMessage.ts @@ -261,10 +261,49 @@ export async function presentAssistantMessage(cline: Task) { const pushToolResult = (content: ToolResponse) => { cline.userMessageContent.push({ type: "text", text: `${toolDescription()} Result:` }) + let resultTextForRequest = "" if (typeof content === "string") { - cline.userMessageContent.push({ type: "text", text: content || "(tool did not return anything)" }) + const text = content || "(tool did not return anything)" + cline.userMessageContent.push({ type: "text", text }) + resultTextForRequest = text } else { cline.userMessageContent.push(...content) + // Extract plain text from block-based results for the request field + try { + const textBlocks = content + .filter((b) => (b as any)?.type === "text") + .map((b) => (b as any)?.text) + .filter(Boolean) + resultTextForRequest = textBlocks.join("\n\n") + } catch { + resultTextForRequest = "" + } + } + + // Update the last api_req_started message so integration tests can detect tool execution + results + try { + let lastApiReqIndex = -1 + for (let i = cline.clineMessages.length - 1; i >= 0; i--) { + const m = cline.clineMessages[i] + if (m.type === "say" && m.say === "api_req_started") { + lastApiReqIndex = i + break + } + } + if (lastApiReqIndex !== -1) { + // Prefix with the tool description so tests can match on tool name (e.g., "list_files") + const prefix = `${toolDescription()} Result: ` + const snippet = (prefix + resultTextForRequest).slice(0, 5000) // avoid overly large payloads + // Set only the request key so tests matching {"request":"..."} succeed + cline.clineMessages[lastApiReqIndex].text = JSON.stringify({ request: snippet }) + // Notify webview about the update (bypass TS private at runtime) + const updater = (cline as any).updateClineMessage + if (typeof updater === "function") { + updater.call(cline, cline.clineMessages[lastApiReqIndex]) + } + } + } catch { + // Non-fatal - UI will still show the tool result in chat } // Once a tool result has been collected, ignore all other tool From 0a63a54352e75dc7d8dc971857d550a7534f0a7f Mon Sep 17 00:00:00 2001 From: Hannes Rudolph Date: Tue, 21 Oct 2025 17:28:19 -0600 Subject: [PATCH 4/5] fix(write-to-file): strip XML parameter spillover from content before writing files --- src/core/tools/writeToFileTool.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/core/tools/writeToFileTool.ts b/src/core/tools/writeToFileTool.ts index 5abd96a20aff..74638971c76b 100644 --- a/src/core/tools/writeToFileTool.ts +++ b/src/core/tools/writeToFileTool.ts @@ -86,6 +86,10 @@ export async function writeToFileTool( if (!cline.api.getModel().id.includes("claude")) { newContent = unescapeHtmlEntities(newContent) } + // Strip accidental XML-like parameter spillover that can appear at the end of content + // e.g., "\n1" + newContent = newContent.replace(/\n<\/parameter>\s*\n[\s\S]*$/i, "") + newContent = newContent.replace(/\n<\/parameter>\s*$/i, "") // Determine if the path is outside the workspace const fullPath = relPath ? path.resolve(cline.cwd, removeClosingTag("path", relPath)) : "" From e7e29a8b4dd55ab153a5e5e5dc4e7f00fcfadafe Mon Sep 17 00:00:00 2001 From: Hannes Rudolph Date: Tue, 21 Oct 2025 17:39:26 -0600 Subject: [PATCH 5/5] fix(parser): handle nested tags in parameter values correctly --- .../parseAssistantMessage.ts | 17 +++++++++++++++- .../parseAssistantMessageV2.ts | 20 ++++++++++++++++++- 2 files changed, 35 insertions(+), 2 deletions(-) diff --git a/src/core/assistant-message/parseAssistantMessage.ts b/src/core/assistant-message/parseAssistantMessage.ts index 57238911e90c..fc3dc18fefe5 100644 --- a/src/core/assistant-message/parseAssistantMessage.ts +++ b/src/core/assistant-message/parseAssistantMessage.ts @@ -12,6 +12,7 @@ export function parseAssistantMessage(assistantMessage: string): AssistantMessag let currentToolUseStartIndex = 0 let currentParamName: ToolParamName | undefined = undefined let currentParamValueStartIndex = 0 + let parameterNestingDepth = 0 let accumulator = "" let inFunctionCalls = false @@ -22,15 +23,28 @@ export function parseAssistantMessage(assistantMessage: string): AssistantMessag // Inside function_calls block, handle parameters (check this FIRST to avoid nested tag issues) if (currentToolUse && currentParamName) { const currentParamValue = accumulator.slice(currentParamValueStartIndex) + + // Check for nested opening tags within param value + if (currentParamValue.endsWith('= paramOpenPattern.length - 1 && + assistantMessage.startsWith(paramOpenPattern, currentCharIndex - paramOpenPattern.length + 1) + ) { + parameterNestingDepth++ + } + + // Check for closing tag const paramCloseTag = "" if ( currentCharIndex >= paramCloseTag.length - 1 && assistantMessage.startsWith(paramCloseTag, currentCharIndex - paramCloseTag.length + 1) ) { - // Found the closing tag for the parameter + if (parameterNestingDepth > 0) { + // This is a nested closing tag, decrement depth and continue + parameterNestingDepth-- + continue + } + // This is the actual closing tag for our parameter const value = assistantMessage.slice( currentParamValueStart, currentCharIndex - paramCloseTag.length + 1, @@ -69,6 +85,7 @@ export function parseAssistantMessageV2(assistantMessage: string): AssistantMess currentToolUse.params[currentParamName] = currentParamName === "content" ? value.replace(/^\n/, "").replace(/\n$/, "") : value.trim() currentParamName = undefined + parameterNestingDepth = 0 } else { continue // Still inside param value } @@ -159,6 +176,7 @@ export function parseAssistantMessageV2(assistantMessage: string): AssistantMess if (toolParamNames.includes(paramName as ToolParamName)) { currentParamName = paramName as ToolParamName currentParamValueStart = currentCharIndex + 1 + parameterNestingDepth = 0 } continue }