Improve system prompt to add project env context.

Author: ericdallo

resources/prompts/additional_system_info.md

@@ -1,4 +1,4 @@
-# Project Environment Context
+## Project Environment Context
 
 Workspaces: {workspaceRoots}
 

resources/prompts/agent_behavior.md

@@ -1,24 +1,26 @@
+# ECA — Editor Code Assistant
+
 You are ECA (Editor Code Assistant), an AI coding assistant that operates on an editor.
 
 You are pair programming with a USER to solve their coding task. Each time the USER sends a message, we may automatically attach some context information about their current state, such as passed contexts, rules defined by USER, project structure, and more. This information may or may not be relevant to the coding task, it is up for you to decide.
 
 You are an agent - please keep going until the user's query is completely resolved, before ending your turn and yielding back to the user. Only terminate your turn when you are sure that the problem is solved. Autonomously resolve the query to the best of your ability before coming back to the user.
 
-<edit_file_instructions>
+## Edit file instructions
+
 NEVER show the code edits or new files to the user - only call the proper tool. The system will apply and display the edits.
 For each file, give a short description of what needs to be edited, then use the available tool. You can use the tool multiple times in a response, and you can keep writing text after using a tool. Prefer multiple tool calls for specific code block changes instead of one big call changing the whole file or unnecessary parts of the code.
-</edit_file_instructions>
 
-<communication>
+## Communication
+
 The chat is markdown mode.
 When using markdown in assistant messages, use backticks to format file, directory, function, and class names.
 Pay attention to the language name after the code block backticks start, use the full language name like 'javascript' instead of 'js'.
-</communication>
 
-<tool_calling>
+## Tool calling
+
 You have tools at your disposal to solve the coding task. Follow these rules regarding tool calls:
 1. ALWAYS follow the tool call schema exactly as specified and make sure to provide all necessary parameters.
 2. If you need additional information that you can get via tool calls, prefer that over asking the user.
 3. If you are not sure about file content or codebase structure pertaining to the user's request, use your tools to read files and gather the relevant information: do NOT guess or make up an answer.
 4. You have the capability to call multiple tools in a single response, batch your tool calls together for optimal performance.
-</tool_calling>

src/eca/features/prompt.clj

@@ -61,27 +61,28 @@
 
 (defn contexts-str [refined-contexts repo-map*]
   (multi-str
-   "<contexts description=\"User-Provided Snippet. This content is current and accurate. Treat this as sufficient context for answering the query.\">"
+   "<contexts description=\"User-Provided. This content is current and accurate. Treat this as sufficient context for answering the query.\">"
+   ""
    (reduce
-    (fn [context-str {:keys [type path position content lines-range uri]}]
+    (fn [context-str {:keys [type path position content lines-range uri] :as a}]
       (str context-str (case type
                          :file (if lines-range
-                                 (format "<file line-start=%s line-end=%s path=\"%s\">%s</file>\n"
+                                 (format "<file line-start=%s line-end=%s path=\"%s\">%s</file>\n\n"
                                          (:start lines-range)
                                          (:end lines-range)
                                          path
                                          content)
-                                 (format "<file path=\"%s\">%s</file>\n" path content))
+                                 (format "<file path=\"%s\">%s</file>\n\n" path content))
                          :agents-file (multi-str
                                        (format "<agents-file description=\"Instructions following AGENTS.md spec.\" path=\"%s\">" path)
                                        content
-                                       "</agents-file>\n")
-                         :repoMap (format "<repoMap description=\"Workspaces structure in a tree view, spaces represent file hierarchy\" >%s</repoMap>\n" @repo-map*)
-                         :cursor (format "<cursor description=\"User editor cursor position (line:character)\" path=\"%s\" start=\"%s\" end=\"%s\"/>\n"
+                                       "</agents-file>\n\n")
+                         :repoMap (format "<repoMap description=\"Workspaces structure in a tree view, spaces represent file hierarchy\" >%s</repoMap>\n\n" @repo-map*)
+                         :cursor (format "<cursor description=\"User editor cursor position (line:character)\" path=\"%s\" start=\"%s\" end=\"%s\"/>\n\n"
                                          path
                                          (str (:line (:start position)) ":" (:character (:start position)))
                                          (str (:line (:end position)) ":" (:character (:end position))))
-                         :mcpResource (format "<resource uri=\"%s\">%s</resource>\n" uri content)
+                         :mcpResource (format "<resource uri=\"%s\">%s</resource>\n\n" uri content)
                          "")))
     ""
     refined-contexts)
@@ -91,7 +92,9 @@
   (multi-str
    (eca-chat-prompt behavior config)
    (when (seq rules)
-     ["<rules description=\"Rules defined by user\">\n"
+     ["## Rules"
+      ""
+      "<rules description=\"Rules defined by user\">\n"
       (reduce
        (fn [rule-str {:keys [name content]}]
          (str rule-str (format "<rule name=\"%s\">%s</rule>\n" name content)))
@@ -100,7 +103,9 @@
       "</rules>"])
    ""
    (when (seq refined-contexts)
-     [(contexts-str refined-contexts repo-map*)])
+     ["## Contexts"
+      ""
+      (contexts-str refined-contexts repo-map*)])
    ""
    (replace-vars
     (load-builtin-prompt "additional_system_info.md")

test/eca/features/prompt_test.clj

@@ -15,12 +15,13 @@
                  {:name "rule2" :content "Second rule"}]
           fake-repo-map (delay "TREE")
           behavior "agent"
-          result (prompt/build-chat-instructions refined-contexts rules fake-repo-map behavior {} (h/db))]
+          config {}
+          result (prompt/build-chat-instructions refined-contexts rules fake-repo-map behavior config (h/db))]
       (is (string/includes? result "You are ECA"))
       (is (string/includes? result "<rules description=\"Rules defined by user\">"))
       (is (string/includes? result "<rule name=\"rule1\">First rule</rule>"))
       (is (string/includes? result "<rule name=\"rule2\">Second rule</rule>"))
-      (is (string/includes? result "<contexts description=\"User-Provided Snippet. This content is current and accurate. Treat this as sufficient context for answering the query.\">"))
+      (is (string/includes? result "<contexts description=\"User-Provided. This content is current and accurate. Treat this as sufficient context for answering the query.\">"))
       (is (string/includes? result "<file path=\"foo.clj\">(ns foo)</file>"))
       (is (string/includes? result "<file line-start=1 line-end=1 path=\"bar.clj\">(def a 1)</file>"))
       (is (string/includes? result "<repoMap description=\"Workspaces structure in a tree view, spaces represent file hierarchy\" >TREE</repoMap>"))
@@ -36,15 +37,16 @@
                  {:name "rule2" :content "Second rule"}]
           fake-repo-map (delay "TREE")
           behavior "plan"
-          result (prompt/build-chat-instructions refined-contexts rules fake-repo-map behavior {} (h/db))]
+          config {}
+          result (prompt/build-chat-instructions refined-contexts rules fake-repo-map behavior config (h/db))]
       (is (string/includes? result "You are ECA"))
       (is (string/includes? result "<rules description=\"Rules defined by user\">"))
       (is (string/includes? result "<rule name=\"rule1\">First rule</rule>"))
       (is (string/includes? result "<rule name=\"rule2\">Second rule</rule>"))
-      (is (string/includes? result "<contexts description=\"User-Provided Snippet. This content is current and accurate. Treat this as sufficient context for answering the query.\">"))
-      (is (string/includes? result "<file path=\"foo.clj\">(ns foo)</file>"))
-      (is (string/includes? result "<file line-start=1 line-end=1 path=\"bar.clj\">(def a 1)</file>"))
-      (is (string/includes? result "<repoMap description=\"Workspaces structure in a tree view, spaces represent file hierarchy\" >TREE</repoMap>"))
-      (is (string/includes? result "<resource uri=\"custom://my-resource\">some-cool-content</resource>"))
-      (is (string/includes? result "</contexts>"))
-      (is (string? result)))))
+            (is (string/includes? result "<contexts description=\"User-Provided. This content is current and accurate. Treat this as sufficient context for answering the query.\">"))
+            (is (string/includes? result "<file path=\"foo.clj\">(ns foo)</file>"))
+            (is (string/includes? result "<file line-start=1 line-end=1 path=\"bar.clj\">(def a 1)</file>"))
+            (is (string/includes? result "<repoMap description=\"Workspaces structure in a tree view, spaces represent file hierarchy\" >TREE</repoMap>"))
+            (is (string/includes? result "<resource uri=\"custom://my-resource\">some-cool-content</resource>"))
+            (is (string/includes? result "</contexts>"))
+            (is (string? result)))))