Add support for Goose client (#1718)

Fix #1524

Author: eleftherias

cmd/thv/app/client.go

@@ -54,6 +54,7 @@ Valid clients:
   - claude-code: Claude Code CLI
   - cline: Cline extension for VS Code
   - cursor: Cursor editor
+  - goose: Goose AI agent
   - lm-studio: LM Studio application
   - roo-code: Roo Code extension for VS Code
   - vscode: Visual Studio Code
@@ -78,6 +79,7 @@ Valid clients:
   - claude-code: Claude Code CLI
   - cline: Cline extension for VS Code
   - cursor: Cursor editor
+  - goose: Goose AI agent
   - lm-studio: LM Studio application
   - roo-code: Roo Code extension for VS Code
   - vscode: Visual Studio Code
@@ -185,12 +187,12 @@ func clientRegisterCmdFunc(cmd *cobra.Command, args []string) error {
 	// Validate the client type
 	switch clientType {
 	case "roo-code", "cline", "cursor", "claude-code", "vscode-insider", "vscode", "windsurf", "windsurf-jetbrains",
-		"amp-cli", "amp-vscode", "amp-vscode-insider", "amp-cursor", "amp-windsurf", "lm-studio":
+		"amp-cli", "amp-vscode", "amp-vscode-insider", "amp-cursor", "amp-windsurf", "lm-studio", "goose":
 		// Valid client type
 	default:
 		return fmt.Errorf(
 			"invalid client type: %s (valid types: roo-code, cline, cursor, claude-code, vscode, vscode-insider, "+
-				"windsurf, windsurf-jetbrains, amp-cli, amp-vscode, amp-vscode-insider, amp-cursor, amp-windsurf, lm-studio)",
+				"windsurf, windsurf-jetbrains, amp-cli, amp-vscode, amp-vscode-insider, amp-cursor, amp-windsurf, lm-studio, goose)",
 			clientType)
 	}
 
@@ -203,12 +205,12 @@ func clientRemoveCmdFunc(cmd *cobra.Command, args []string) error {
 	// Validate the client type
 	switch clientType {
 	case "roo-code", "cline", "cursor", "claude-code", "vscode-insider", "vscode", "windsurf", "windsurf-jetbrains",
-		"amp-cli", "amp-vscode", "amp-vscode-insider", "amp-cursor", "amp-windsurf", "lm-studio":
+		"amp-cli", "amp-vscode", "amp-vscode-insider", "amp-cursor", "amp-windsurf", "lm-studio", "goose":
 		// Valid client type
 	default:
 		return fmt.Errorf(
 			"invalid client type: %s (valid types: roo-code, cline, cursor, claude-code, vscode, vscode-insider, "+
-				"windsurf, windsurf-jetbrains, amp-cli, amp-vscode, amp-vscode-insider, amp-cursor, amp-windsurf, lm-studio)",
+				"windsurf, windsurf-jetbrains, amp-cli, amp-vscode, amp-vscode-insider, amp-cursor, amp-windsurf, lm-studio, goose)",
 			clientType)
 	}
 

docs/cli/thv_client_register.md

@@ -12,6 +12,7 @@ import (
 	"time"
 
 	"github.com/tailscale/hujson"
+	"gopkg.in/yaml.v3"
 
 	"github.com/stacklok/toolhive/pkg/logger"
 	"github.com/stacklok/toolhive/pkg/transport/types"
@@ -52,6 +53,8 @@ const (
 	AmpWindsurf MCPClient = "amp-windsurf"
 	// LMStudio represents the LM Studio application.
 	LMStudio MCPClient = "lm-studio"
+	// Goose represents the Goose AI agent.
+	Goose MCPClient = "goose"
 )
 
 // Extension is extension of the client config file.
@@ -60,6 +63,8 @@ type Extension string
 const (
 	// JSON represents a JSON extension.
 	JSON Extension = "json"
+	// YAML represents a YAML extension.
+	YAML Extension = "yaml"
 )
 
 // mcpClientConfig represents a configuration path for a supported MCP client.
@@ -342,6 +347,26 @@ var supportedClientIntegrations = []mcpClientConfig{
 		IsTransportTypeFieldSupported: true,
 		MCPServersUrlLabel:            "url",
 	},
+	{
+		ClientType:           Goose,
+		Description:          "Goose AI agent",
+		SettingsFile:         "config.yaml",
+		MCPServersPathPrefix: "/extensions",
+		RelPath:              []string{"goose"},
+		PlatformPrefix: map[string][]string{
+			"linux":   {".config"},
+			"darwin":  {".config"},
+			"windows": {"AppData", "Block"},
+		},
+		Extension: YAML,
+		SupportedTransportTypesMap: map[types.TransportType]string{
+			types.TransportTypeStdio:          "sse",
+			types.TransportTypeSSE:            "sse",
+			types.TransportTypeStreamableHTTP: "streamable_http",
+		},
+		IsTransportTypeFieldSupported: true,
+		MCPServersUrlLabel:            "uri",
+	},
 }
 
 // ConfigFile represents a client configuration file
@@ -530,10 +555,19 @@ func (cm *ClientManager) retrieveConfigFileMetadata(clientType MCPClient) (*Conf
 		return nil, err
 	}
 
-	// Create a config updater for this file
-	configUpdater := &JSONConfigUpdater{
-		Path:                 path,
-		MCPServersPathPrefix: clientCfg.MCPServersPathPrefix,
+	// Create a config updater for this file based on the extension
+	var configUpdater ConfigUpdater
+	switch clientCfg.Extension {
+	case YAML:
+		configUpdater = &YAMLConfigUpdater{
+			Path:      path,
+			Converter: &GooseYAMLConverter{},
+		}
+	case JSON:
+		configUpdater = &JSONConfigUpdater{
+			Path:                 path,
+			MCPServersPathPrefix: clientCfg.MCPServersPathPrefix,
+		}
 	}
 
 	// Return the configuration file metadata
@@ -572,11 +606,18 @@ func validateConfigFileFormat(cf *ConfigFile) error {
 		data = []byte("{}") // Default to an empty JSON object if the file is empty
 	}
 
-	// Default to JSON
-	// we don't care about the contents of the file, we just want to validate that it's valid JSON
-	_, err = hujson.Parse(data)
-	if err != nil {
-		return fmt.Errorf("failed to parse JSON for file %s: %w", cf.Path, err)
+	switch cf.Extension {
+	case YAML:
+		var temp interface{}
+		err = yaml.Unmarshal(data, &temp)
+		if err != nil {
+			return fmt.Errorf("failed to parse YAML for file %s: %w", cf.Path, err)
+		}
+	case JSON:
+		_, err = hujson.Parse(data)
+		if err != nil {
+			return fmt.Errorf("failed to parse JSON for file %s: %w", cf.Path, err)
+		}
 	}
 	return nil
 }

docs/cli/thv_client_remove.md

@@ -11,6 +11,7 @@ import (
 	"github.com/gofrs/flock"
 	"github.com/tailscale/hujson"
 	"github.com/tidwall/gjson"
+	"gopkg.in/yaml.v3"
 
 	"github.com/stacklok/toolhive/pkg/logger"
 )
@@ -151,6 +152,137 @@ func (jcu *JSONConfigUpdater) Remove(serverName string) error {
 	return nil
 }
 
+// YAMLConfigUpdater is a ConfigUpdater that is responsible for updating
+// YAML config files using a converter interface for flexibility.
+type YAMLConfigUpdater struct {
+	Path      string
+	Converter YAMLConverter
+}
+
+// Upsert inserts or updates an MCP server in the config.yaml file using the converter
+func (ycu *YAMLConfigUpdater) Upsert(serverName string, data MCPServer) error {
+	// Create a lock file
+	fileLock := flock.New(ycu.Path + ".lock")
+
+	// Create a context with timeout
+	ctx, cancel := context.WithTimeout(context.Background(), lockTimeout)
+	defer cancel()
+
+	// Try to acquire the lock with a timeout
+	locked, err := fileLock.TryLockContext(ctx, 100*time.Millisecond)
+	if err != nil {
+		return fmt.Errorf("failed to acquire lock: %w", err)
+	}
+	if !locked {
+		return fmt.Errorf("failed to acquire lock: timeout after %v", lockTimeout)
+	}
+	defer fileLock.Unlock()
+
+	content, err := os.ReadFile(ycu.Path)
+	if err != nil && !os.IsNotExist(err) {
+		return fmt.Errorf("failed to read file: %w", err)
+	}
+
+	// Use a generic map to preserve all existing fields, not just extensions
+	var config map[string]interface{}
+
+	// If file exists and is not empty, unmarshal existing config into generic map
+	if len(content) > 0 {
+		err = yaml.Unmarshal(content, &config)
+		if err != nil {
+			return fmt.Errorf("failed to parse existing YAML config: %w", err)
+		}
+	} else {
+		// Initialize empty map if file doesn't exist or is empty
+		config = make(map[string]interface{})
+	}
+
+	// Convert MCPServer using the converter
+	entry, err := ycu.Converter.ConvertFromMCPServer(serverName, data)
+	if err != nil {
+		return fmt.Errorf("failed to convert MCPServer: %w", err)
+	}
+
+	// Upsert the entry using the converter
+	err = ycu.Converter.UpsertEntry(config, serverName, entry)
+	if err != nil {
+		return fmt.Errorf("failed to upsert entry: %w", err)
+	}
+
+	// Marshal back to YAML
+	updatedContent, err := yaml.Marshal(config)
+	if err != nil {
+		return fmt.Errorf("failed to marshal YAML: %w", err)
+	}
+
+	// Write back to file
+	if err := os.WriteFile(ycu.Path, updatedContent, 0600); err != nil {
+		return fmt.Errorf("failed to write file: %w", err)
+	}
+
+	logger.Infof("Successfully updated YAML client config file for server %s", serverName)
+	return nil
+}
+
+// Remove removes an entry from the config.yaml file using the converter
+func (ycu *YAMLConfigUpdater) Remove(serverName string) error {
+	// Create a lock file
+	fileLock := flock.New(ycu.Path + ".lock")
+
+	ctx, cancel := context.WithTimeout(context.Background(), lockTimeout)
+	defer cancel()
+
+	// Try to acquire the lock with a timeout
+	locked, err := fileLock.TryLockContext(ctx, 100*time.Millisecond)
+	if err != nil {
+		return fmt.Errorf("failed to acquire lock: %w", err)
+	}
+	if !locked {
+		return fmt.Errorf("failed to acquire lock: timeout after %v", lockTimeout)
+	}
+	defer fileLock.Unlock()
+
+	// Read existing config
+	content, err := os.ReadFile(ycu.Path)
+	if err != nil {
+		if os.IsNotExist(err) {
+			// File doesn't exist, nothing to remove
+			return nil
+		}
+		return fmt.Errorf("failed to read file: %w", err)
+	}
+
+	if len(content) == 0 {
+		// File is empty, nothing to remove
+		return nil
+	}
+
+	// Use a generic map to preserve all existing fields, not just extensions
+	var config map[string]interface{}
+	err = yaml.Unmarshal(content, &config)
+	if err != nil {
+		return fmt.Errorf("failed to parse YAML: %w", err)
+	}
+
+	err = ycu.Converter.RemoveEntry(config, serverName)
+	if err != nil {
+		return fmt.Errorf("failed to remove entry: %w", err)
+	}
+
+	updatedContent, err := yaml.Marshal(config)
+	if err != nil {
+		return fmt.Errorf("failed to marshal YAML: %w", err)
+	}
+
+	// Write back to file
+	if err := os.WriteFile(ycu.Path, updatedContent, 0600); err != nil {
+		return fmt.Errorf("failed to write file: %w", err)
+	}
+
+	logger.Infof("Successfully removed server %s from YAML config file", serverName)
+	return nil
+}
+
 // ensurePathExists ensures that the path exists in the JSON content
 // and returns the updated content.
 // For example: