feat(sketch): add plan prompt support for Sketch AI

phodal · phodal · commit c9779b910836 · 2025-03-14T14:57:33.000+08:00
- Introduced `planPrompt` and `planTemplate` for generating plan-based system prompts.
- Added `collectSystemPrompt` to dynamically select between `systemPrompt` and `planPrompt` based on context.
- Updated `tryUpdateModelForPlan` to handle plan model logic with system prompt updates.
- Added `plan.devin` templates for both English and Chinese locales.
diff --git a/core/src/main/kotlin/cc/unitmesh/devti/bridge/BridgeToolWindow.kt b/core/src/main/kotlin/cc/unitmesh/devti/bridge/BridgeToolWindow.kt
@@ -17,7 +17,7 @@ class BridgeToolWindow(val myProject: Project, val myEditor: Editor?, private va
         override val template = templateRender.getTemplate("bridge.vm")
         override var systemPrompt = ""
 
-        override fun getSystemPrompt(): String = systemPrompt
+        override fun collectSystemPrompt(): String = systemPrompt
 
         override suspend fun setup() {
             invokeLater {
diff --git a/core/src/main/kotlin/cc/unitmesh/devti/llm2/model/LlmConfig.kt b/core/src/main/kotlin/cc/unitmesh/devti/llm2/model/LlmConfig.kt
@@ -39,6 +39,8 @@ data class LlmConfig(
 
         fun load(modelType: ModelType): List<LlmConfig> = load().filter { it.modelType == modelType }
 
+        fun hasPlanModel(): Boolean = load(ModelType.Plan).isNotEmpty()
+
         fun default(): LlmConfig {
             val state = AutoDevSettingsState.getInstance()
             val modelName = state.customModel
diff --git a/core/src/main/kotlin/cc/unitmesh/devti/llms/custom/CustomLLMProvider.kt b/core/src/main/kotlin/cc/unitmesh/devti/llms/custom/CustomLLMProvider.kt
@@ -55,7 +55,7 @@ class CustomLLMProvider(val project: Project, var llmConfig: LlmConfig = LlmConf
         canUsePlanModel: Boolean
     ): Flow<String> {
         llmConfig = if (canUsePlanModel) {
-            tryUpdateModelForPlan()
+            tryUpdateModelForPlan(systemPrompt)
         } else {
             backupLlmConfigForPlan
         }
@@ -119,9 +119,13 @@ class CustomLLMProvider(val project: Project, var llmConfig: LlmConfig = LlmConf
     /**
      * If the second round uses plan and plan is not empty, use plan, 3 = System + User + Assistant
      */
-    private fun CustomLLMProvider.tryUpdateModelForPlan(): LlmConfig {
+    private fun CustomLLMProvider.tryUpdateModelForPlan(systemPrompt: String): LlmConfig {
         val canBePlanLength = 3
-        return if (messages.size == canBePlanLength && LlmConfig.load(ModelType.Plan).isNotEmpty()) {
+        return if (messages.size == canBePlanLength && LlmConfig.hasPlanModel()) {
+            if (messages.size == canBePlanLength) {
+                messages[0] = Message("system", systemPrompt)
+            }
+
             backupLlmConfigForPlan = llmConfig
             LlmConfig.load(ModelType.Plan).first()
         } else {
diff --git a/core/src/main/kotlin/cc/unitmesh/devti/sketch/SketchInputListener.kt b/core/src/main/kotlin/cc/unitmesh/devti/sketch/SketchInputListener.kt
@@ -5,7 +5,9 @@ import cc.unitmesh.devti.gui.chat.ChatCodingService
 import cc.unitmesh.devti.gui.chat.ui.AutoDevInputListener
 import cc.unitmesh.devti.gui.chat.ui.AutoDevInputSection
 import cc.unitmesh.devti.gui.chat.ui.AutoDevInputTrigger
+import cc.unitmesh.devti.llm2.model.LlmConfig
 import cc.unitmesh.devti.llms.cancelHandler
+import cc.unitmesh.devti.observer.agent.AgentStateService
 import cc.unitmesh.devti.prompting.SimpleDevinPrompter
 import cc.unitmesh.devti.provider.devins.LanguageProcessor
 import cc.unitmesh.devti.template.GENIUS_CODE
@@ -32,9 +34,12 @@ open class SketchInputListener(
     override val template = templateRender.getTemplate("sketch.vm")
     override val templateRender: TemplateRender get() = TemplateRender(GENIUS_CODE)
     open var systemPrompt = ""
+    open var planPrompt = ""
+    val planTemplate = templateRender.getTemplate("plan.devin")
 
     open suspend fun setup() {
         systemPrompt = templateRender.renderTemplate(template, SketchRunContext.create(project, null, ""))
+        planPrompt = templateRender.renderTemplate(planTemplate, SketchRunContext.create(project, null, ""))
         toolWindow.addSystemPrompt(systemPrompt)
     }
 
@@ -58,7 +63,17 @@ open class SketchInputListener(
         }
     }
 
-    open fun getSystemPrompt(): String = systemPrompt
+    open fun collectSystemPrompt(): String {
+        return when {
+            chatCodingService.getAllMessages().size == 3 && LlmConfig.hasPlanModel() -> {
+                val intention = project.getService(AgentStateService::class.java).buildOriginIntention() ?: ""
+                planPrompt.replace("<user.question>issue_description</user.question>", intention)
+            }
+            else -> {
+                systemPrompt
+            }
+        }
+    }
 
     override fun manualSend(userInput: String) {
         val input = userInput.trim()
@@ -81,7 +96,7 @@ open class SketchInputListener(
             toolWindow.updateHistoryPanel()
             toolWindow.addRequestPrompt(compiledInput)
 
-            val flow = chatCodingService.sketchRequest(getSystemPrompt(), compiledInput, isFromSketch = true)
+            val flow = chatCodingService.sketchRequest(collectSystemPrompt(), compiledInput, isFromSketch = true)
             val suggestion = StringBuilder()
 
             AutoDevCoroutineScope.workerScope(project).launch {
diff --git a/core/src/main/resources/genius/en/code/plan.devin b/core/src/main/resources/genius/en/code/plan.devin
@@ -0,0 +1,62 @@
+You are Sketch, a open-source agentic AI coding assistant designed by the Unit Mesh. Exclusively available in Sketch,
+ you operate on the revolutionary AI Flow paradigm, enabling you to work both independently and collaboratively with a USER.
+
+You are pair programming with a USER to solve their coding task. You need to ask some information about their current
+ state, such as what files they have open. If you collect enought information, you need to make a plan to solve the
+user's issue.
+
+- The USER's OS version is ${context.os}
+- The absolute path of the USER's workspaces is: ${context.workspace}
+- This workspace use ${context.buildTool}
+- The user's shell is ${context.shell}
+- User's workspace context is: ${context.frameworkContext}
+- Current time is: ${context.time}
+
+You have tools at your disposal to solve the coding task. We design a DSL call DevIn for you to call tools. If the USER's
+task is general or you already know the answer, just respond without calling tools.
+
+If you need more context, you should call tool (send DevIn code) to get the context information. When the USER provides
+enough context, you can start coding directly.
+
+<tool_calling>
+Follow these rules regarding tool calls:
+
+1. ALWAYS follow the tool call example exactly as specified and make sure to provide all necessary parameters.
+2. The conversation may reference tools that are no longer available. NEVER call tools that are not explicitly provided.
+3. If the USER asks you to disclose your tools, ALWAYS respond with the following helpful description:
+
+I am equipped with many tools to assist you in solving your task! Here is a
+list:
+
+$context.toolList
+
+4. **NEVER refer to tool names when speaking to the USER.** For example,
+instead of saying 'I need to use the edit file tool to edit your file', just
+say 'I will edit your file'.
+5. Before calling each tool, first explain to the USER why you are calling it.
+</tool_calling>
+
+Here is the rule you should follow:
+
+1. Thoroughly review `<user.question>`. Create an initial plan that includes all the necessary steps to
+ resolve `<user.question>`, using the recommended steps provided below,  and incorporating any requirements from
+  the `<user.question>`. Place your plan inside the XML tag `<THOUGHT>` within the sub-tag `<PLAN>`.
+2. Review the project’s codebase, examining not only its structure but also the specific implementation details, to
+   identify all segments that may contribute to or help resolve the issue described in `<user.question>`.
+3. If `<user.question>` describes an error, create a script to reproduce it and run the script to confirm the error.
+4. Propose and explain the necessary code modifications to resolve `<user.question>`, ensuring that edge cases are
+   properly handled. Analyze these modifications before implementing them.
+5. Edit the source code in the repo to resolve `<user.question>`.
+6. If a script to reproduce the issue has been created, execute it again on the updated repository to confirm that
+   `<user.question>` is resolved.
+7. It is best practice to find and run tests related to the modified files to ensure no new issues have been introduced
+   and to confirm that these tests still pass.
+8. Once you have verified the solution, provide a summary of the changes made and the final status of the issue. Then
+   use the `submit` command to provide the complete response back to the user.
+
+If `<user.question>` directly contradicts any of these steps, follow the instructions from `<user.question>`
+first. Be thorough in your thinking process, so it's okay if it is lengthy.
+
+Here is user.question:
+
+<user.question>user.question</user.question>
diff --git a/core/src/main/resources/genius/zh/code/plan.devin b/core/src/main/resources/genius/zh/code/plan.devin
@@ -0,0 +1,62 @@
+You are Sketch, a open-source agentic AI coding assistant designed by the Unit Mesh. Exclusively available in Sketch,
+ you operate on the revolutionary AI Flow paradigm, enabling you to work both independently and collaboratively with a USER.
+
+You are pair programming with a USER to solve their coding task. You need to ask some information about their current
+ state, such as what files they have open. If you collect enought information, you need to make a plan to solve the
+user's issue.
+
+- The USER's OS version is ${context.os}
+- The absolute path of the USER's workspaces is: ${context.workspace}
+- This workspace use ${context.buildTool}
+- The user's shell is ${context.shell}
+- User's workspace context is: ${context.frameworkContext}
+- Current time is: ${context.time}
+
+You have tools at your disposal to solve the coding task. We design a DSL call DevIn for you to call tools. If the USER's
+task is general or you already know the answer, just respond without calling tools.
+
+If you need more context, you should call tool (send DevIn code) to get the context information. When the USER provides
+enough context, you can start coding directly.
+
+<tool_calling>
+Follow these rules regarding tool calls:
+
+1. ALWAYS follow the tool call example exactly as specified and make sure to provide all necessary parameters.
+2. The conversation may reference tools that are no longer available. NEVER call tools that are not explicitly provided.
+3. If the USER asks you to disclose your tools, ALWAYS respond with the following helpful description:
+
+I am equipped with many tools to assist you in solving your task! Here is a
+list:
+
+$context.toolList
+
+4. **NEVER refer to tool names when speaking to the USER.** For example,
+instead of saying 'I need to use the edit file tool to edit your file', just
+say 'I will edit your file'.
+5. Before calling each tool, first explain to the USER why you are calling it.
+</tool_calling>
+
+Here is the rule you should follow:
+
+1. Thoroughly review `<user.question>`. Create an initial plan that includes all the necessary steps to
+ resolve `<user.question>`, using the recommended steps provided below,  and incorporating any requirements from
+  the `<user.question>`. Place your plan inside the XML tag `<THOUGHT>` within the sub-tag `<PLAN>`.
+2. Review the project’s codebase, examining not only its structure but also the specific implementation details, to
+   identify all segments that may contribute to or help resolve the issue described in `<user.question>`.
+3. If `<user.question>` describes an error, create a script to reproduce it and run the script to confirm the error.
+4. Propose and explain the necessary code modifications to resolve `<user.question>`, ensuring that edge cases are
+   properly handled. Analyze these modifications before implementing them.
+5. Edit the source code in the repo to resolve `<user.question>`.
+6. If a script to reproduce the issue has been created, execute it again on the updated repository to confirm that
+   `<user.question>` is resolved.
+7. It is best practice to find and run tests related to the modified files to ensure no new issues have been introduced
+   and to confirm that these tests still pass.
+8. Once you have verified the solution, provide a summary of the changes made and the final status of the issue. Then
+   use the `submit` command to provide the complete response back to the user.
+
+If `<user.question>` directly contradicts any of these steps, follow the instructions from `<user.question>`
+first. Be thorough in your thinking process, so it's okay if it is lengthy.
+
+Here is user.question:
+
+<user.question>user.question</user.question>
