Merge pull request #1546 from dgageot/cagent-new-2

Fix and improve `cagent new`

Author: dgageot

cmd/root/new.go

@@ -27,9 +27,17 @@ func newNewCmd() *cobra.Command {
 	var flags newFlags
 
 	cmd := &cobra.Command{
-		Use:     "new",
-		Short:   "Create a new agent configuration",
-		Long:    `Create a new agent configuration by asking questions and generating a YAML file`,
+		Use:   "new [description]",
+		Short: "Create a new agent configuration",
+		Long: `Create a new agent configuration interactively.
+
+The agent builder will ask questions about what you want the agent to do,
+then generate a YAML configuration file you can use with 'cagent run'.
+
+Optionally provide a description as an argument to skip the initial prompt.`,
+		Example: `  cagent new
+  cagent new "a web scraper that extracts product prices"
+  cagent new --model openai/gpt-4o "a code reviewer agent"`,
 		GroupID: "core",
 		RunE:    flags.runNewCommand,
 	}
@@ -50,6 +58,11 @@ func (f *newFlags) runNewCommand(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
+	defer func() {
+		// Use a fresh context for cleanup since the original may be canceled
+		cleanupCtx := context.WithoutCancel(ctx)
+		_ = t.StopToolSets(cleanupCtx)
+	}()
 
 	rt, err := runtime.New(t)
 	if err != nil {

pkg/creator/agent.go

@@ -1,3 +1,5 @@
+// Package creator provides functionality to create agent configurations interactively.
+// It generates a special agent that helps users build their own agent YAML files.
 package creator
 
 import (
@@ -7,6 +9,8 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/goccy/go-yaml"
+
 	"github.com/docker/cagent/pkg/config"
 	"github.com/docker/cagent/pkg/config/latest"
 	"github.com/docker/cagent/pkg/team"
@@ -18,95 +22,153 @@ import (
 //go:embed instructions.txt
 var agentBuilderInstructions string
 
-type fsToolset struct {
-	tools.ToolSet
-	originalWriteFileHandler tools.ToolHandler
-	path                     string
-}
-
-func (f *fsToolset) Tools(ctx context.Context) ([]tools.Tool, error) {
-	innerTools, err := f.ToolSet.Tools(ctx)
-	if err != nil {
-		return nil, err
-	}
-
-	for i, tool := range innerTools {
-		if tool.Name == builtin.ToolNameWriteFile {
-			f.originalWriteFileHandler = tool.Handler
-			innerTools[i].Handler = f.customWriteFileHandler
-		}
-	}
+// Constants for the creator agent configuration.
+const (
+	creatorAgentName      = "root"
+	creatorAgentModel     = "auto"
+	creatorWelcomeMessage = "Hello! I'm here to create agents for you.\n\nCan you explain to me what the agent will be used for?"
+)
 
-	return innerTools, nil
-}
+// Agent creates and returns a team configured for the agent builder functionality.
+// The agent builder helps users create their own agent configurations interactively.
+//
+// Parameters:
+//   - ctx: Context for the operation
+//   - runConfig: Runtime configuration including working directory and environment
+//   - modelNameOverride: Optional model override (empty string uses auto-selection)
+//
+// Returns the configured team or an error if configuration fails.
+func Agent(ctx context.Context, runConfig *config.RuntimeConfig, modelNameOverride string) (*team.Team, error) {
+	instructions := buildInstructions(ctx, runConfig)
 
-func (f *fsToolset) customWriteFileHandler(ctx context.Context, toolCall tools.ToolCall) (*tools.ToolCallResult, error) {
-	var args struct {
-		Path    string `json:"path"`
-		Content string `json:"content"`
-	}
-	if err := json.Unmarshal([]byte(toolCall.Function.Arguments), &args); err != nil {
-		return nil, fmt.Errorf("failed to parse arguments: %w", err)
+	configYAML, err := buildCreatorConfigYAML(instructions)
+	if err != nil {
+		return nil, fmt.Errorf("building creator config: %w", err)
 	}
 
-	f.path = args.Path
+	registry := createToolsetRegistry(runConfig.WorkingDir)
 
-	return f.originalWriteFileHandler(ctx, toolCall)
+	return teamloader.Load(
+		ctx,
+		config.NewBytesSource("creator", configYAML),
+		runConfig,
+		teamloader.WithModelOverrides([]string{modelNameOverride}),
+		teamloader.WithToolsetRegistry(registry),
+	)
 }
 
-func Agent(ctx context.Context, runConfig *config.RuntimeConfig, modelNameOverride string) (*team.Team, error) {
+// buildInstructions creates the full instruction set for the creator agent,
+// including provider-specific model configuration examples.
+func buildInstructions(ctx context.Context, runConfig *config.RuntimeConfig) string {
 	usableProviders := config.AvailableProviders(ctx, runConfig.ModelsGateway, runConfig.EnvProvider())
 
-	// Provide soft guidance to prefer the selected providers
-	instructions := agentBuilderInstructions
-	instructions += "\n\nPreferred model providers to use: " + strings.Join(usableProviders, ", ")
-	instructions += ". You must always use one or more of the following model configurations: \n"
+	var b strings.Builder
+	b.WriteString(agentBuilderInstructions)
+	b.WriteString("\n\nPreferred model providers to use: ")
+	b.WriteString(strings.Join(usableProviders, ", "))
+	b.WriteString(". You must always use one or more of the following model configurations: \n")
 
 	for _, provider := range usableProviders {
 		model := config.DefaultModels[provider]
 		maxTokens := config.PreferredMaxTokens(provider)
-		instructions += fmt.Sprintf(`
+		fmt.Fprintf(&b, `
 		models:
 			%s:
 				provider: %s
 				model: %s
-				max_tokens: %d\n`, provider, provider, model, maxTokens)
+				max_tokens: %d
+`, provider, provider, model, *maxTokens)
 	}
 
-	// Define a new agent configuration
-	newAgentConfig := latest.Config{
-		Agents: []latest.AgentConfig{{
-			Name:           "root",
-			WelcomeMessage: "Hello! I'm here to create agents for you.\n\nCan you explain to me what the agent will be used for?",
-			Instruction:    instructions,
-			Model:          "auto",
-			Toolsets: []latest.Toolset{
-				{Type: "shell"},
-				{Type: "filesystem"},
-			},
-		}},
+	return b.String()
+}
+
+// buildCreatorConfigYAML generates the YAML configuration for the creator agent.
+// It uses yaml.MapSlice to ensure proper indentation of multi-line strings.
+func buildCreatorConfigYAML(instructions string) ([]byte, error) {
+	// Define available toolsets for the creator agent
+	toolsets := []map[string]any{
+		{"type": "shell"},
+		{"type": "filesystem"},
 	}
 
-	configAsJSON, err := json.Marshal(newAgentConfig)
-	if err != nil {
-		return nil, fmt.Errorf("marshalling config: %w", err)
+	// Build the root agent configuration
+	rootAgent := yaml.MapSlice{
+		{Key: "model", Value: creatorAgentModel},
+		{Key: "welcome_message", Value: creatorWelcomeMessage},
+		{Key: "instruction", Value: instructions},
+		{Key: "toolsets", Value: toolsets},
 	}
 
-	// Custom tool registry to include fsToolset
-	fsToolset := fsToolset{
-		ToolSet: builtin.NewFilesystemTool(runConfig.WorkingDir),
+	// Build the full config structure
+	agentsConfig := yaml.MapSlice{
+		{Key: creatorAgentName, Value: rootAgent},
+	}
+
+	fullConfig := yaml.MapSlice{
+		{Key: "agents", Value: agentsConfig},
+	}
+
+	return yaml.Marshal(fullConfig)
+}
+
+// createToolsetRegistry creates a custom toolset registry that wraps the filesystem
+// toolset to track file paths written by the agent.
+func createToolsetRegistry(workingDir string) *teamloader.ToolsetRegistry {
+	tracker := &fileWriteTracker{
+		ToolSet: builtin.NewFilesystemTool(workingDir),
 	}
 
 	registry := teamloader.NewDefaultToolsetRegistry()
 	registry.Register("filesystem", func(context.Context, latest.Toolset, string, *config.RuntimeConfig) (tools.ToolSet, error) {
-		return &fsToolset, nil
+		return tracker, nil
 	})
 
-	return teamloader.Load(
-		ctx,
-		config.NewBytesSource("creator", configAsJSON),
-		runConfig,
-		teamloader.WithModelOverrides([]string{modelNameOverride}),
-		teamloader.WithToolsetRegistry(registry),
-	)
+	return registry
+}
+
+// fileWriteTracker wraps a filesystem toolset to track files written by the agent.
+// This allows the creator to know what files were created during the session.
+type fileWriteTracker struct {
+	tools.ToolSet
+	originalWriteFileHandler tools.ToolHandler
+	path                     string
+}
+
+// Tools returns the available tools, wrapping the write_file tool to track paths.
+func (t *fileWriteTracker) Tools(ctx context.Context) ([]tools.Tool, error) {
+	innerTools, err := t.ToolSet.Tools(ctx)
+	if err != nil {
+		return nil, err
+	}
+
+	for i, tool := range innerTools {
+		if tool.Name == builtin.ToolNameWriteFile {
+			t.originalWriteFileHandler = tool.Handler
+			innerTools[i].Handler = t.trackWriteFile
+		}
+	}
+
+	return innerTools, nil
+}
+
+// trackWriteFile intercepts write_file calls to track the path being written.
+func (t *fileWriteTracker) trackWriteFile(ctx context.Context, toolCall tools.ToolCall) (*tools.ToolCallResult, error) {
+	var args struct {
+		Path    string `json:"path"`
+		Content string `json:"content"`
+	}
+	if err := json.Unmarshal([]byte(toolCall.Function.Arguments), &args); err != nil {
+		return nil, fmt.Errorf("failed to parse write_file arguments: %w", err)
+	}
+
+	t.path = args.Path
+
+	return t.originalWriteFileHandler(ctx, toolCall)
+}
+
+// LastWrittenPath returns the path of the last file written by the agent.
+// Returns an empty string if no file has been written yet.
+func (t *fileWriteTracker) LastWrittenPath() string {
+	return t.path
 }