feat: support for AGENTS.md (#7717)

* feat: support for AGENTS.md

* chore: rules source display name cleanup

* refactor: use constant

---------

Co-authored-by: Dallin Romney <[email protected]>

Author: sestinj

core/config/markdown/loadMarkdownRules.ts

@@ -3,11 +3,13 @@ import {
   markdownToRule,
 } from "@continuedev/config-yaml";
 import { IDE, RuleWithSource } from "../..";
-import { findUriInDirs } from "../../util/uri";
+import { findUriInDirs, joinPathsToUri } from "../../util/uri";
 import { getAllDotContinueDefinitionFiles } from "../loadLocalAssistants";
 
+export const SUPPORTED_AGENT_FILES = ["AGENTS.md", "AGENT.md", "CLAUDE.md"];
 /**
  * Loads rules from markdown files in the .continue/rules directory
+ * and agent files (AGENTS.md, AGENT.md, CLAUDE.md) at workspace root
  */
 export async function loadMarkdownRules(ide: IDE): Promise<{
   rules: RuleWithSource[];
@@ -16,6 +18,38 @@ export async function loadMarkdownRules(ide: IDE): Promise<{
   const errors: ConfigValidationError[] = [];
   const rules: RuleWithSource[] = [];
 
+  // First, try to load agent files from workspace root
+  const workspaceDirs = await ide.getWorkspaceDirs();
+
+  for (const workspaceDir of workspaceDirs) {
+    let agentFileFound = false;
+    for (const fileName of SUPPORTED_AGENT_FILES) {
+      try {
+        const agentFilePath = joinPathsToUri(workspaceDir, fileName);
+        const agentContent = await ide.readFile(agentFilePath);
+
+        const rule = markdownToRule(agentContent, {
+          uriType: "file",
+          fileUri: agentFilePath,
+        });
+        rules.push({
+          ...rule,
+          source: "agent-file",
+          ruleFile: agentFilePath,
+          alwaysApply: true,
+        });
+        agentFileFound = true;
+        break; // Use the first found agent file in this workspace
+      } catch (e) {
+        // File doesn't exist or can't be read, continue to next file
+      }
+    }
+
+    if (agentFileFound) {
+      break; // Use agent file from first workspace that has one
+    }
+  }
+
   try {
     // Get all .md files from .continue/rules
     const markdownFiles = await getAllDotContinueDefinitionFiles(

core/core.ts

@@ -1239,6 +1239,9 @@ export class Core {
         if (
           uri.endsWith(".continuerc.json") ||
           uri.endsWith(".prompt") ||
+          uri.endsWith("AGENTS.md") ||
+          uri.endsWith("AGENT.md") ||
+          uri.endsWith("CLAUDE.md") ||
           uri.endsWith(SYSTEM_PROMPT_DOT_FILE) ||
           (uri.includes(".continue") &&
             (uri.endsWith(".yaml") || uri.endsWith("yml"))) ||

core/index.d.ts

@@ -1811,7 +1811,8 @@ export type RuleSource =
   | "rules-block"
   | "colocated-markdown"
   | "json-systemMessage"
-  | ".continuerules";
+  | ".continuerules"
+  | "agent-file";
 
 export interface RuleWithSource {
   name?: string;

core/llm/rules/rules-utils.ts

@@ -0,0 +1,46 @@
+import { RuleWithSource } from "../..";
+import { getLastNPathParts } from "../../util/uri";
+
+export function getRuleDisplayName(rule: RuleWithSource): string {
+  if (rule.name) {
+    return rule.name;
+  }
+  return getRuleSourceDisplayName(rule);
+}
+
+export function getRuleSourceDisplayName(rule: RuleWithSource): string {
+  switch (rule.source) {
+    case ".continuerules":
+      return "Project rules";
+    case "default-chat":
+      return "Default chat system message";
+    case "default-plan":
+      return "Default plan mode system message";
+    case "default-agent":
+      return "Default agent system message";
+    case "json-systemMessage":
+      return "System Message (JSON)";
+    case "model-options-agent":
+      return "Base System Agent Message";
+    case "model-options-plan":
+      return "Base System Plan Message";
+    case "model-options-chat":
+      return "Base System Chat Message";
+    case "agent-file":
+      if (rule.ruleFile) {
+        return getLastNPathParts(rule.ruleFile, 2);
+      } else {
+        return "Agent file";
+      }
+    case "colocated-markdown":
+      if (rule.ruleFile) {
+        return getLastNPathParts(rule.ruleFile, 2);
+      } else {
+        return "rules.md";
+      }
+    case "rules-block":
+      return "Rules Block";
+    default:
+      return rule.source;
+  }
+}

gui/src/components/mainInput/belowMainInput/RulesPeek.tsx

@@ -1,6 +1,6 @@
 import { DocumentTextIcon, GlobeAltIcon } from "@heroicons/react/24/outline";
 import { RuleWithSource } from "core";
-import { getLastNPathParts } from "core/util/uri";
+import { getRuleSourceDisplayName } from "core/llm/rules/rules-utils";
 import { ComponentType, useMemo, useState } from "react";
 import ToggleDiv from "../../ToggleDiv";
 
@@ -13,36 +13,6 @@ interface RulesPeekItemProps {
   rule: RuleWithSource;
 }
 
-// Convert technical source to user-friendly text
-const getSourceLabel = (rule: RuleWithSource): string => {
-  switch (rule.source) {
-    case "default-chat":
-      return "Default Chat";
-    case "default-agent":
-      return "Default Agent";
-    case "model-options-chat":
-      return "Model Chat Options";
-    case "model-options-plan":
-      return "Model Plan Options";
-    case "model-options-agent":
-      return "Model Agent Options";
-    case "rules-block":
-      return "Rules Block";
-    case "colocated-markdown":
-      if (rule.ruleFile) {
-        return getLastNPathParts(rule.ruleFile, 2);
-      } else {
-        return "rules.md";
-      }
-    case "json-systemMessage":
-      return "System Message";
-    case ".continuerules":
-      return "Project Rules";
-    default:
-      return rule.source;
-  }
-};
-
 export function RulesPeekItem({ rule }: RulesPeekItemProps) {
   const isGlobal = rule.alwaysApply ?? !rule.globs;
   const [expanded, setExpanded] = useState(false);
@@ -102,7 +72,7 @@ export function RulesPeekItem({ rule }: RulesPeekItemProps) {
         )}
       </div>
       <div className="mt-1 pl-6 pr-2 text-xs text-gray-500">
-        Source: {getSourceLabel(rule)}
+        Source: {getRuleSourceDisplayName(rule)}
       </div>
     </div>
   );

gui/src/pages/config/sections/RulesSection.tsx

@@ -4,7 +4,6 @@ import {
   BookmarkIcon as BookmarkOutline,
   EyeIcon,
   PencilIcon,
-  PlusIcon,
 } from "@heroicons/react/24/outline";
 import { BookmarkIcon as BookmarkSolid } from "@heroicons/react/24/solid";
 import {
@@ -19,11 +18,12 @@ import {
   DEFAULT_PLAN_SYSTEM_MESSAGE,
   DEFAULT_SYSTEM_MESSAGES_URL,
 } from "core/llm/defaultSystemMessages";
+import { getRuleDisplayName } from "core/llm/rules/rules-utils";
 import { useContext, useMemo } from "react";
 import HeaderButtonWithToolTip from "../../../components/gui/HeaderButtonWithToolTip";
 import Switch from "../../../components/gui/Switch";
 import { useMainEditor } from "../../../components/mainInput/TipTapEditor";
-import { Button, Card, EmptyState, useFontSize } from "../../../components/ui";
+import { Card, EmptyState, useFontSize } from "../../../components/ui";
 import { useAuth } from "../../../context/Auth";
 import { IdeMessengerContext } from "../../../context/IdeMessenger";
 import { useBookmarkedSlashCommands } from "../../../hooks/useBookmarkedSlashCommands";
@@ -167,27 +167,7 @@ const RuleCard: React.FC<RuleCardProps> = ({ rule }) => {
   };
 
   const title = useMemo(() => {
-    if (rule.name) {
-      return rule.name;
-    } else {
-      if (rule.source === ".continuerules") {
-        return "Project rules";
-      } else if (rule.source === "default-chat") {
-        return "Default chat system message";
-      } else if (rule.source === "default-agent") {
-        return "Default agent system message";
-      } else if (rule.source === "json-systemMessage") {
-        return "JSON systemMessage)";
-      } else if (rule.source === "model-options-agent") {
-        return "Base System Agent Message";
-      } else if (rule.source === "model-options-plan") {
-        return "Base System Plan Message";
-      } else if (rule.source === "model-options-chat") {
-        return "Base System Chat Message";
-      } else {
-        return "Agent rule";
-      }
-    }
+    return getRuleDisplayName(rule);
   }, [rule]);
 
   function onClickExpand() {