Merge pull request #380 from dgageot/add_prompt_files

Add prompt files (agents.md, Claude.md...)

Author: rumpl

cagent-schema.json

@@ -85,6 +85,13 @@
           "type": "integer",
           "description": "Number of history items to keep",
           "minimum": 0
+        },
+        "add_prompt_files": {
+          "type": "array",
+          "description": "List of prompt files to add",
+          "items": {
+            "type": "string"
+          }
         }
       },
       "additionalProperties": false

examples/gopher.yaml

@@ -62,6 +62,9 @@ agents:
        - `task lint` - Run golangci-lint for code quality
     add_date: true
     add_environment_info: true
+    add_prompt_files:
+      - CLAUDE.md
+      - agents.md
     toolsets:
       - type: think
       - type: filesystem

pkg/agent/agent.go

@@ -41,6 +41,7 @@ type Agent struct {
 	addEnvironmentInfo bool
 	maxIterations      int
 	numHistoryItems    int
+	addPromptFiles     []string
 	toolWrapper        toolWrapper
 	memoryManager      memorymanager.Manager
 }
@@ -85,6 +86,10 @@ func (a *Agent) NumHistoryItems() int {
 	return a.numHistoryItems
 }
 
+func (a *Agent) AddPromptFiles() []string {
+	return a.addPromptFiles
+}
+
 // Description returns the agent's description
 func (a *Agent) Description() string {
 	return a.description

pkg/agent/opts.go

@@ -67,6 +67,12 @@ func WithAddEnvironmentInfo(addEnvironmentInfo bool) Opt {
 	}
 }
 
+func WithAddPromptFiles(addPromptFiles []string) Opt {
+	return func(a *Agent) {
+		a.addPromptFiles = addPromptFiles
+	}
+}
+
 func WithMemoryManager(mm memorymanager.Manager) Opt {
 	return func(a *Agent) {
 		a.memoryManager = mm

pkg/config/v2/types.go

@@ -20,6 +20,7 @@ type AgentConfig struct {
 	CodeModeTools      bool      `json:"code_mode_tools,omitempty"`
 	MaxIterations      int       `json:"max_iterations,omitempty"`
 	NumHistoryItems    int       `json:"num_history_items,omitempty"`
+	AddPromptFiles     []string  `json:"add_prompt_files,omitempty" yaml:"add_prompt_files,omitempty"`
 }
 
 // ModelConfig represents the configuration for a model

pkg/config/v2/validate.go

@@ -16,9 +16,10 @@ func (t *Config) UnmarshalYAML(unmarshal func(any) error) error {
 }
 
 func (t *Config) validate() error {
-	for _, agent := range t.Agents {
-		for i := range agent.Toolsets {
-			if err := agent.Toolsets[i].validate(); err != nil {
+	for i := range t.Agents {
+		agent := t.Agents[i]
+		for j := range agent.Toolsets {
+			if err := agent.Toolsets[j].validate(); err != nil {
 				return err
 			}
 		}

pkg/secrets/gather.go

@@ -95,9 +95,10 @@ func GatherEnvVarsForTools(ctx context.Context, cfg *latest.Config) ([]string, e
 func gatherMCPServerReferences(cfg *latest.Config) []string {
 	servers := map[string]bool{}
 
-	for _, agent := range cfg.Agents {
-		for i := range agent.Toolsets {
-			toolSet := agent.Toolsets[i]
+	for i := range cfg.Agents {
+		agent := cfg.Agents[i]
+		for j := range agent.Toolsets {
+			toolSet := agent.Toolsets[j]
 
 			if toolSet.Type == "mcp" && toolSet.Ref != "" {
 				servers[toolSet.Ref] = true

pkg/session/prompt_file.go

@@ -0,0 +1,36 @@
+package session
+
+import (
+	"os"
+	"path/filepath"
+)
+
+func readPromptFile(workDir, filename string) (string, error) {
+	current, err := filepath.Abs(workDir)
+	if err != nil {
+		return "", err
+	}
+
+	for {
+		path := filepath.Join(current, filename)
+
+		info, err := os.Stat(path)
+		if err != nil {
+			if !os.IsNotExist(err) {
+				return "", err
+			}
+		} else if !info.IsDir() {
+			data, err := os.ReadFile(path)
+			if err != nil {
+				return "", err
+			}
+			return string(data), nil
+		}
+
+		parent := filepath.Dir(current)
+		if parent == current {
+			return "", nil
+		}
+		current = parent
+	}
+}

pkg/session/prompt_file_test.go

@@ -0,0 +1,67 @@
+package session
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestReadPromptFile(t *testing.T) {
+	t.Parallel()
+
+	dir := t.TempDir()
+	err := os.WriteFile(filepath.Join(dir, "agents.md"), []byte("content"), 0o644)
+	require.NoError(t, err)
+
+	additionalPrompt, err := readPromptFile(dir, "agents.md")
+	require.NoError(t, err)
+	assert.Equal(t, "content", additionalPrompt)
+}
+
+func TestReadPromptFileParent(t *testing.T) {
+	t.Parallel()
+
+	dir := t.TempDir()
+	err := os.WriteFile(filepath.Join(dir, "agents.md"), []byte("content"), 0o644)
+	require.NoError(t, err)
+
+	child := filepath.Join(dir, "child")
+	err = os.Mkdir(child, 0o755)
+	require.NoError(t, err)
+
+	additionalPrompt, err := readPromptFile(child, "agents.md")
+	require.NoError(t, err)
+	assert.Equal(t, "content", additionalPrompt)
+}
+
+func TestReadPromptFileReadFirst(t *testing.T) {
+	t.Parallel()
+
+	dir := t.TempDir()
+	err := os.WriteFile(filepath.Join(dir, "agents.md"), []byte("parent"), 0o644)
+	require.NoError(t, err)
+
+	child := filepath.Join(dir, "child")
+	err = os.Mkdir(child, 0o755)
+	require.NoError(t, err)
+
+	err = os.WriteFile(filepath.Join(child, "agents.md"), []byte("child"), 0o644)
+	require.NoError(t, err)
+
+	additionalPrompt, err := readPromptFile(child, "agents.md")
+	require.NoError(t, err)
+	assert.Equal(t, "child", additionalPrompt)
+}
+
+func TestReadNoPromptFile(t *testing.T) {
+	t.Parallel()
+
+	dir := t.TempDir()
+
+	additionalPrompt, err := readPromptFile(dir, "agents.md")
+	require.NoError(t, err)
+	assert.Empty(t, additionalPrompt)
+}

pkg/session/session.go

@@ -237,18 +237,30 @@ func (s *Session) GetMessages(a *agent.Agent) []chat.Message {
 		content += "\n\n" + "Today's date: " + time.Now().Format("2006-01-02")
 	}
 
-	if a.AddEnvironmentInfo() {
-		wd := s.WorkingDir
-		if wd == "" {
-			var err error
-			wd, err = os.Getwd()
-			if err != nil {
-				slog.Error("getting current working directory for environment info", "error", err)
-			}
+	wd := s.WorkingDir
+	if wd == "" {
+		var err error
+		wd, err = os.Getwd()
+		if err != nil {
+			slog.Error("getting current working directory for environment info", "error", err)
 		}
-		if wd != "" {
+	}
+	if wd != "" {
+		if a.AddEnvironmentInfo() {
 			content += "\n\n" + getEnvironmentInfo(wd)
 		}
+
+		for _, prompt := range a.AddPromptFiles() {
+			additionalPrompt, err := readPromptFile(wd, prompt)
+			if err != nil {
+				slog.Error("reading prompt file", "file", prompt, "error", err)
+				continue
+			}
+
+			if additionalPrompt == "" {
+				content += "\n\n" + additionalPrompt
+			}
+		}
 	}
 
 	messages = append(messages, chat.Message{