Support AGENT.md file if found

Author: ericdallo

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Add support for auto read `AGENT.md` from workspace root and global eca dir, considering as context for chat prompts.
+
 ## 0.26.3
 
 - breaking: Replace configs `ollama host` and `ollama port` with `ollamaApiUrl`.

docs/configuration.md

@@ -237,6 +237,7 @@ interface Config {
     chat?: {
         welcomeMessage: string;
     };
+    agentFileRelativePath: string;
     index?: {
         ignoreFiles: [{
             type: string;
@@ -274,6 +275,7 @@ interface Config {
   "chat" : {
     "welcomeMessage" : "Welcome to ECA!\n\nType '/' for commands\n\n"
   },
+  "agentFileRelativePath": "AGENT.md"
   "index" : {
     "ignoreFiles" : [ {
       "type" : "gitignore"

docs/features.md

@@ -54,6 +54,10 @@ Here are the current supported contexts types:
 - `repoMap`: a summary view of workspaces files and folders, server will calculate this and pass to LLM. Currently, the repo-map includes only the file paths in git.
 - `mcpResource`: resources provided by running MCPs servers.
 
+#### AGENT.md automatic context
+
+ECA will always include if found the `AGENT.md` file (configurable via `agentFileRelativePath` config) as context, searching for both `/project-root/AGENT.md` and `~/.config/eca/AGENT.md`.
+
 ### Commands
 
 ![](./images/commands.png)

src/eca/config.clj

@@ -11,7 +11,9 @@
    [clojure.core.memoize :as memoize]
    [clojure.java.io :as io]
    [clojure.string :as string]
-   [eca.shared :as shared]))
+   [eca.shared :as shared])
+  (:import
+   [java.io File]))
 
 (set! *warn-on-reflection* true)
 
@@ -42,6 +44,7 @@
    :ollama {:useTools true
             :think true}
    :chat {:welcomeMessage "Welcome to ECA!\n\nType '/' for commands\n\n"}
+   :agentFileRelativePath "AGENT.md"
    :customProviders {}
    :index {:ignoreFiles [{:type :gitignore}]}})
 
@@ -64,10 +67,13 @@
 
 (def ^:private config-from-envvar (memoize config-from-envvar*))
 
-(defn ^:private config-from-global-file* []
+(defn global-config-dir ^File []
   (let [xdg-config-home (or (get-env "XDG_CONFIG_HOME")
-                            (io/file (get-property "user.home") ".config"))
-        config-file (io/file xdg-config-home "eca" "config.json")]
+                            (io/file (get-property "user.home") ".config"))]
+    (io/file xdg-config-home "eca")))
+
+(defn ^:private config-from-global-file* []
+  (let [config-file (io/file (global-config-dir) "config.json")]
     (when (.exists config-file)
       (safe-read-json-string (slurp config-file)))))
 

src/eca/features/chat.clj

@@ -109,7 +109,7 @@
         all-models (models/all)
         provider (get-in all-models [model :provider])
         rules (f.rules/all config (:workspace-folders db))
-        refined-contexts (f.context/raw-contexts->refined contexts db)
+        refined-contexts (f.context/raw-contexts->refined contexts db config)
         repo-map* (delay (f.index/repo-map db {:as-string? true}))
         instructions (f.prompt/build-instructions refined-contexts rules repo-map* (or behavior (:chat-default-behavior db)) config)
         past-messages (get-in db [:chats chat-id :messages] [])

src/eca/features/context.clj

@@ -1,6 +1,7 @@
 (ns eca.features.context
   (:require
    [babashka.fs :as fs]
+   [eca.config :as config]
    [eca.features.index :as f.index]
    [eca.features.tools.mcp :as f.mcp]
    [eca.llm-api :as llm-api]
@@ -11,32 +12,52 @@
 
 (def ^:private logger-tag "[CONTEXT]")
 
-(defn raw-contexts->refined [contexts db]
-  (mapcat (fn [{:keys [type path lines-range uri]}]
-            (case (name type)
-              "file" [{:type :file
-                       :path path
-                       :partial (boolean lines-range)
-                       :content (llm-api/refine-file-context path lines-range)}]
-              "directory" (->> (fs/glob path "**")
-                               (remove fs/directory?)
-                               (map (fn [path]
-                                      (let [filename (str (fs/canonicalize path))]
-                                        {:type :file
-                                         :path filename
-                                         :content (llm-api/refine-file-context filename nil)}))))
-              "repoMap" [{:type :repoMap}]
-              "mcpResource" (try
-                              (mapv
-                               (fn [{:keys [text]}]
-                                 {:type :mcpResource
-                                  :uri uri
-                                  :content text})
-                               (:contents (f.mcp/get-resource! uri db)))
-                              (catch Exception e
-                                (logger/warn logger-tag (format "Error getting MCP resource %s: %s" uri (.getMessage e)))
-                                []))))
-          contexts))
+(defn ^:private agents-file-contexts
+  "Search for AGENT.md file both in workspaceRoot and global config dir."
+  [db config]
+  (let [local-agent-files (keep (fn [{:keys [uri]}]
+                                  (let [agent-file (fs/path (shared/uri->filename uri) (:agentFileRelativePath config))]
+                                    (when (fs/readable? agent-file)
+                                      (fs/canonicalize agent-file))))
+                                (:workspace-folders db))
+        global-agent-file (let [agent-file (fs/path (config/global-config-dir) (:agentFileRelativePath config))]
+                            (when (fs/readable? agent-file)
+                              (fs/canonicalize agent-file)))]
+    (mapv (fn [path]
+            {:type :file
+             :path (str path)
+             :partial false
+             :content (llm-api/refine-file-context (str path) nil)})
+          (concat local-agent-files
+                  (when global-agent-file [global-agent-file])))))
+
+(defn raw-contexts->refined [contexts db config]
+  (concat (agents-file-contexts db config)
+          (mapcat (fn [{:keys [type path lines-range uri]}]
+                    (case (name type)
+                      "file" [{:type :file
+                               :path path
+                               :partial (boolean lines-range)
+                               :content (llm-api/refine-file-context path lines-range)}]
+                      "directory" (->> (fs/glob path "**")
+                                       (remove fs/directory?)
+                                       (map (fn [path]
+                                              (let [filename (str (fs/canonicalize path))]
+                                                {:type :file
+                                                 :path filename
+                                                 :content (llm-api/refine-file-context filename nil)}))))
+                      "repoMap" [{:type :repoMap}]
+                      "mcpResource" (try
+                                      (mapv
+                                       (fn [{:keys [text]}]
+                                         {:type :mcpResource
+                                          :uri uri
+                                          :content text})
+                                       (:contents (f.mcp/get-resource! uri db)))
+                                      (catch Exception e
+                                        (logger/warn logger-tag (format "Error getting MCP resource %s: %s" uri (.getMessage e)))
+                                        []))))
+                  contexts)))
 
 (defn ^:private contexts-for [root-filename query config]
   (let [all-files (fs/glob root-filename (str "**" (or query "") "**"))

src/eca/features/prompt.clj

@@ -43,7 +43,7 @@
     rules)
    "</rules>"
    ""
-   "<contexts>"
+   "<contexts description=\"Manually provided by user, usually when provided user knows that your task is related to those files, so consider reliying on it but use tools to read/find any extra files/contexts if really needed.\">"
    (reduce
     (fn [context-str {:keys [type path content partial uri]}]
       (str context-str (case type

test/eca/features/prompt_test.clj

@@ -19,7 +19,7 @@
       (is (string/includes? result "<rules>"))
       (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>"))
+      (is (string/includes? result "<contexts description=\"Manually provided by user, usually when provided user knows that your task is related to those files, so consider reliying on it but use tools to read/find any extra files/contexts if really needed.\">"))
       (is (string/includes? result "<file path=\"foo.clj\">(ns foo)</file>"))
       (is (string/includes? result "<file partial=true path=\"bar.clj\">...\n(def a 1)\n...</file>"))
       (is (string/includes? result "<repoMap description=\"Workspaces structure in a tree view, spaces represent file hierarchy\" >TREE</repoMap>"))
@@ -40,7 +40,7 @@
       (is (string/includes? result "<rules>"))
       (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>"))
+      (is (string/includes? result "<contexts description=\"Manually provided by user, usually when provided user knows that your task is related to those files, so consider reliying on it but use tools to read/find any extra files/contexts if really needed.\">"))
       (is (string/includes? result "<file path=\"foo.clj\">(ns foo)</file>"))
       (is (string/includes? result "<file partial=true path=\"bar.clj\">...\n(def a 1)\n...</file>"))
       (is (string/includes? result "<repoMap description=\"Workspaces structure in a tree view, spaces represent file hierarchy\" >TREE</repoMap>"))