Add client discovery function and endpoint (#632)

Author: eleftherias

docs/server/docs.go

@@ -1,5 +1,28 @@
 components:
   schemas:
+    client.MCPClient:
+      description: ClientType is the type of MCP client
+      type: string
+      x-enum-varnames:
+      - RooCode
+      - Cline
+      - Cursor
+      - VSCodeInsider
+      - VSCode
+      - ClaudeCode
+    client.MCPClientStatus:
+      properties:
+        client_type:
+          $ref: '#/components/schemas/client.MCPClient'
+        installed:
+          description: Installed indicates whether the client is installed on the
+            system
+          type: boolean
+        registered:
+          description: Registered indicates whether the client is registered in the
+            ToolHive configuration
+          type: boolean
+      type: object
     permissions.NetworkPermissions:
       description: Network defines network permissions
       properties:
@@ -259,6 +282,14 @@ components:
         target:
           type: string
       type: object
+    v1.clientStatusResponse:
+      properties:
+        clients:
+          items:
+            $ref: '#/components/schemas/client.MCPClientStatus'
+          type: array
+          uniqueItems: false
+      type: object
     v1.createRequest:
       description: Request to create a new server
       properties:
@@ -433,6 +464,19 @@ paths:
       summary: Get OpenAPI specification
       tags:
       - system
+  /api/v1beta/discovery/clients:
+    get:
+      description: List all clients compatible with ToolHive and their status
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/v1.clientStatusResponse'
+          description: OK
+      summary: List all clients status
+      tags:
+      - discovery
   /api/v1beta/registry:
     get:
       description: Get a list of the current registries

docs/server/swagger.json

@@ -114,10 +114,11 @@ func Serve(
 	}
 
 	routers := map[string]http.Handler{
-		"/health":              v1.HealthcheckRouter(),
-		"/api/v1beta/version":  v1.VersionRouter(),
-		"/api/v1beta/servers":  v1.ServerRouter(manager, rt, debugMode),
-		"/api/v1beta/registry": v1.RegistryRouter(),
+		"/health":               v1.HealthcheckRouter(),
+		"/api/v1beta/version":   v1.VersionRouter(),
+		"/api/v1beta/servers":   v1.ServerRouter(manager, rt, debugMode),
+		"/api/v1beta/registry":  v1.RegistryRouter(),
+		"/api/v1beta/discovery": v1.DiscoveryRouter(),
 	}
 
 	// Only mount docs router if enabled

docs/server/swagger.yaml

@@ -0,0 +1,48 @@
+package v1
+
+import (
+	"encoding/json"
+	"net/http"
+
+	"github.com/go-chi/chi/v5"
+
+	"github.com/stacklok/toolhive/pkg/client"
+)
+
+// DiscoveryRoutes defines the routes for the client discovery API.
+type DiscoveryRoutes struct{}
+
+// DiscoveryRouter creates a new router for the client discovery API.
+func DiscoveryRouter() http.Handler {
+	routes := DiscoveryRoutes{}
+
+	r := chi.NewRouter()
+	r.Get("/clients", routes.discoverClients)
+	return r
+}
+
+// discoverClients
+//
+//	@Summary		List all clients status
+//	@Description	List all clients compatible with ToolHive and their status
+//	@Tags			discovery
+//	@Produce		json
+//	@Success		200	{object}	clientStatusResponse
+//	@Router			/api/v1beta/discovery/clients [get]
+func (*DiscoveryRoutes) discoverClients(w http.ResponseWriter, _ *http.Request) {
+	clients, err := client.GetClientStatus()
+	if err != nil {
+		http.Error(w, "Failed to get client status", http.StatusInternalServerError)
+	}
+
+	err = json.NewEncoder(w).Encode(clientStatusResponse{Clients: clients})
+	if err != nil {
+		http.Error(w, "Failed to encode client status", http.StatusInternalServerError)
+		return
+	}
+}
+
+// clientStatusResponse represents the response for the client discovery
+type clientStatusResponse struct {
+	Clients []client.MCPClientStatus `json:"clients"`
+}

pkg/api/server.go

@@ -51,17 +51,19 @@ type mcpClientConfig struct {
 	ClientType           MCPClient
 	Description          string
 	RelPath              []string
+	SettingsFile         string
 	PlatformPrefix       map[string][]string
 	MCPServersPathPrefix string
 	Extension            Extension
 }
 
 var supportedClientIntegrations = []mcpClientConfig{
 	{
-		ClientType:  RooCode,
-		Description: "VS Code Roo Code extension",
+		ClientType:   RooCode,
+		Description:  "VS Code Roo Code extension",
+		SettingsFile: "mcp_settings.json",
 		RelPath: []string{
-			"Code", "User", "globalStorage", "rooveterinaryinc.roo-cline", "settings", "mcp_settings.json",
+			"Code", "User", "globalStorage", "rooveterinaryinc.roo-cline", "settings",
 		},
 		PlatformPrefix: map[string][]string{
 			"linux":   {".config"},
@@ -72,10 +74,11 @@ var supportedClientIntegrations = []mcpClientConfig{
 		Extension:            JSON,
 	},
 	{
-		ClientType:  Cline,
-		Description: "VS Code Cline extension",
+		ClientType:   Cline,
+		Description:  "VS Code Cline extension",
+		SettingsFile: "cline_mcp_settings.json",
 		RelPath: []string{
-			"Code", "User", "globalStorage", "saoudrizwan.claude-dev", "settings", "cline_mcp_settings.json",
+			"Code", "User", "globalStorage", "saoudrizwan.claude-dev", "settings",
 		},
 		PlatformPrefix: map[string][]string{
 			"linux":   {".config"},
@@ -86,10 +89,11 @@ var supportedClientIntegrations = []mcpClientConfig{
 		Extension:            JSON,
 	},
 	{
-		ClientType:  VSCodeInsider,
-		Description: "Visual Studio Code Insiders",
+		ClientType:   VSCodeInsider,
+		Description:  "Visual Studio Code Insiders",
+		SettingsFile: "settings.json",
 		RelPath: []string{
-			"Code - Insiders", "User", "settings.json",
+			"Code - Insiders", "User",
 		},
 		PlatformPrefix: map[string][]string{
 			"linux":   {".config"},
@@ -100,10 +104,11 @@ var supportedClientIntegrations = []mcpClientConfig{
 		Extension:            JSON,
 	},
 	{
-		ClientType:  VSCode,
-		Description: "Visual Studio Code",
+		ClientType:   VSCode,
+		Description:  "Visual Studio Code",
+		SettingsFile: "settings.json",
 		RelPath: []string{
-			"Code", "User", "settings.json",
+			"Code", "User",
 		},
 		MCPServersPathPrefix: "/mcp/servers",
 		PlatformPrefix: map[string][]string{
@@ -116,15 +121,17 @@ var supportedClientIntegrations = []mcpClientConfig{
 	{
 		ClientType:           Cursor,
 		Description:          "Cursor editor",
+		SettingsFile:         "mcp.json",
 		MCPServersPathPrefix: "/mcpServers",
-		RelPath:              []string{".cursor", "mcp.json"},
+		RelPath:              []string{".cursor"},
 		Extension:            JSON,
 	},
 	{
 		ClientType:           ClaudeCode,
 		Description:          "Claude Code CLI",
+		SettingsFile:         ".claude.json",
 		MCPServersPathPrefix: "/mcpServers",
-		RelPath:              []string{".claude.json"},
+		RelPath:              []string{},
 		Extension:            JSON,
 	},
 }
@@ -216,7 +223,7 @@ func retrieveConfigFilesMetadata(filters []MCPClient) ([]ConfigFile, error) {
 			continue
 		}
 
-		path := buildConfigFilePath(cfg.RelPath, cfg.PlatformPrefix, []string{home})
+		path := buildConfigFilePath(cfg.SettingsFile, cfg.RelPath, cfg.PlatformPrefix, []string{home})
 
 		err := validateConfigFileExists(path)
 		if err != nil {
@@ -239,11 +246,12 @@ func retrieveConfigFilesMetadata(filters []MCPClient) ([]ConfigFile, error) {
 	return configFiles, nil
 }
 
-func buildConfigFilePath(relPath []string, platformPrefix map[string][]string, path []string) string {
+func buildConfigFilePath(settingsFile string, relPath []string, platformPrefix map[string][]string, path []string) string {
 	if prefix, ok := platformPrefix[runtime.GOOS]; ok {
 		path = append(path, prefix...)
 	}
 	path = append(path, relPath...)
+	path = append(path, settingsFile)
 	return filepath.Clean(filepath.Join(path...))
 }
 

pkg/api/v1/discovery.go

@@ -21,28 +21,32 @@ func createMockClientConfigs() []mcpClientConfig {
 		{
 			ClientType:           VSCode,
 			Description:          "Visual Studio Code (Mock)",
-			RelPath:              []string{"mock_vscode", "settings.json"},
+			RelPath:              []string{"mock_vscode"},
+			SettingsFile:         "settings.json",
 			MCPServersPathPrefix: "/mcp/servers",
 			Extension:            JSON,
 		},
 		{
 			ClientType:           Cursor,
 			Description:          "Cursor editor (Mock)",
-			RelPath:              []string{"mock_cursor", "mcp.json"},
+			RelPath:              []string{"mock_cursor"},
+			SettingsFile:         "mcp.json",
 			MCPServersPathPrefix: "/mcpServers",
 			Extension:            JSON,
 		},
 		{
 			ClientType:           RooCode,
 			Description:          "VS Code Roo Code extension (Mock)",
-			RelPath:              []string{"mock_roo", "mcp_settings.json"},
+			RelPath:              []string{"mock_roo"},
+			SettingsFile:         "mcp_settings.json",
 			MCPServersPathPrefix: "/mcpServers",
 			Extension:            JSON,
 		},
 		{
 			ClientType:           ClaudeCode,
 			Description:          "Claude Code CLI (Mock)",
-			RelPath:              []string{"mock_claude", ".claude.json"},
+			RelPath:              []string{"mock_claude"},
+			SettingsFile:         ".claude.json",
 			MCPServersPathPrefix: "/mcpServers",
 			Extension:            JSON,
 		},
@@ -208,7 +212,8 @@ func TestFindClientConfigs(t *testing.T) {
 		invalidClient := mcpClientConfig{
 			ClientType:           "invalid",
 			Description:          "Invalid client",
-			RelPath:              []string{".cursor", "invalid.json"},
+			RelPath:              []string{".cursor"},
+			SettingsFile:         "invalid.json",
 			MCPServersPathPrefix: "/mcpServers",
 			Extension:            JSON,
 		}
@@ -404,10 +409,10 @@ func createTestConfigFiles(t *testing.T, homeDir string) {
 	// Create test config files for each mock client configuration
 	for _, cfg := range supportedClientIntegrations {
 		// Build the full path for the config file
-		configDir := filepath.Join(homeDir, filepath.Join(cfg.RelPath[:len(cfg.RelPath)-1]...))
+		configDir := filepath.Join(homeDir, filepath.Join(cfg.RelPath...))
 		err := os.MkdirAll(configDir, 0755)
 		if err == nil {
-			configPath := filepath.Join(configDir, cfg.RelPath[len(cfg.RelPath)-1])
+			configPath := filepath.Join(configDir, cfg.SettingsFile)
 			validJSON := `{"mcpServers": {}, "mcp": {"servers": {}}}`
 			err = os.WriteFile(configPath, []byte(validJSON), 0644)
 			require.NoError(t, err)

pkg/client/config.go

@@ -0,0 +1,77 @@
+package client
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"runtime"
+
+	"github.com/stacklok/toolhive/pkg/config"
+)
+
+// MCPClientStatus represents the status of a supported MCP client
+type MCPClientStatus struct {
+	// ClientType is the type of MCP client
+	ClientType MCPClient `json:"client_type"`
+
+	// Installed indicates whether the client is installed on the system
+	Installed bool `json:"installed"`
+
+	// Registered indicates whether the client is registered in the ToolHive configuration
+	Registered bool `json:"registered"`
+}
+
+// GetClientStatus returns the installation status of all supported MCP clients
+func GetClientStatus() ([]MCPClientStatus, error) {
+	var statuses []MCPClientStatus
+
+	// Get home directory
+	home, err := os.UserHomeDir()
+	if err != nil {
+		return nil, fmt.Errorf("failed to get home directory: %w", err)
+	}
+
+	// Get app configuration to check for registered clients
+	appConfig := config.GetConfig()
+	registeredClients := make(map[string]bool)
+
+	// Create a map of registered clients for quick lookup
+	for _, client := range appConfig.Clients.RegisteredClients {
+		registeredClients[client] = true
+	}
+
+	for _, cfg := range supportedClientIntegrations {
+		status := MCPClientStatus{
+			ClientType: cfg.ClientType,
+			Installed:  false, // start with assuming client is not installed
+			Registered: registeredClients[string(cfg.ClientType)],
+		}
+
+		// Determine path to check based on configuration
+		var pathToCheck string
+		if len(cfg.RelPath) == 0 {
+			// If RelPath is empty, look at just the settings file
+			pathToCheck = filepath.Join(home, cfg.SettingsFile)
+		} else {
+			// Otherwise build the directory path using RelPath
+			pathToCheck = buildConfigDirectoryPath(cfg.RelPath, cfg.PlatformPrefix, []string{home})
+		}
+
+		// Check if the path exists
+		if _, err := os.Stat(pathToCheck); err == nil {
+			status.Installed = true
+		}
+
+		statuses = append(statuses, status)
+	}
+
+	return statuses, nil
+}
+
+func buildConfigDirectoryPath(relPath []string, platformPrefix map[string][]string, path []string) string {
+	if prefix, ok := platformPrefix[runtime.GOOS]; ok {
+		path = append(path, prefix...)
+	}
+	path = append(path, relPath...)
+	return filepath.Clean(filepath.Join(path...))
+}