Merge pull request #198 from docker/add-post-command-tips

austin5456 · web-flow · commit a1cb7e51ce7d · 2025-10-27T10:31:03.000-04:00
diff --git a/cmd/docker-mcp/catalog/ls.go b/cmd/docker-mcp/catalog/ls.go
@@ -6,10 +6,13 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/docker/cli/cli/command"
+
+	"github.com/docker/mcp-gateway/cmd/docker-mcp/hints"
 	"github.com/docker/mcp-gateway/pkg/telemetry"
 )
 
-func Ls(ctx context.Context, format Format) error {
+func Ls(ctx context.Context, dockerCli command.Cli, format Format) error {
 	// Initialize telemetry
 	telemetry.Init()
 
@@ -32,13 +35,13 @@ func Ls(ctx context.Context, format Format) error {
 		}
 		fmt.Println(string(data))
 	} else {
-		humanPrintCatalog(*cfg)
+		humanPrintCatalog(dockerCli, *cfg)
 	}
 
 	return nil
 }
 
-func humanPrintCatalog(cfg Config) {
+func humanPrintCatalog(dockerCli command.Cli, cfg Config) {
 	if len(cfg.Catalogs) == 0 {
 		fmt.Println("No catalogs configured.")
 		return
@@ -47,4 +50,9 @@ func humanPrintCatalog(cfg Config) {
 	for name, catalog := range cfg.Catalogs {
 		fmt.Printf("%s: %s\n", name, catalog.DisplayName)
 	}
+	if hints.Enabled(dockerCli) {
+		hints.TipCyan.Print("Tip: To browse a catalog's servers, use ")
+		hints.TipCyanBoldItalic.Print("docker mcp catalog show <catalog-name>")
+		fmt.Println()
+	}
 }
diff --git a/cmd/docker-mcp/catalog/show.go b/cmd/docker-mcp/catalog/show.go
@@ -9,10 +9,12 @@ import (
 	"strings"
 	"time"
 
+	"github.com/docker/cli/cli/command"
 	"github.com/mikefarah/yq/v4/pkg/yqlib"
 	"github.com/moby/term"
 	"gopkg.in/yaml.v3"
 
+	"github.com/docker/mcp-gateway/cmd/docker-mcp/hints"
 	"github.com/docker/mcp-gateway/pkg/yq"
 )
 
@@ -53,7 +55,7 @@ func SupportedFormats() string {
 	return strings.Join(quoted, ", ")
 }
 
-func Show(ctx context.Context, name string, format Format, mcpOAuthDcrEnabled bool) error {
+func Show(ctx context.Context, dockerCli command.Cli, name string, format Format, mcpOAuthDcrEnabled bool) error {
 	cfg, err := ReadConfigWithDefaultCatalog(ctx)
 	if err != nil {
 		return err
@@ -153,6 +155,12 @@ func Show(ctx context.Context, name string, format Format, mcpOAuthDcrEnabled bo
 	fmt.Printf("  %s\n", strings.Repeat("─", headerLineWidth))
 	fmt.Printf("  %d servers total\n", serverCount)
 	fmt.Println()
+	if hints.Enabled(dockerCli) {
+		hints.TipCyan.Print("Tip: To view server details, use ")
+		hints.TipCyanBoldItalic.Print("docker mcp server inspect <server-name>")
+		hints.TipCyan.Print(". To add servers, use ")
+		hints.TipCyanBoldItalic.Println("docker mcp server enable <server-name>")
+	}
 
 	return nil
 }
diff --git a/cmd/docker-mcp/client/connect.go b/cmd/docker-mcp/client/connect.go
@@ -3,9 +3,13 @@ package client
 import (
 	"context"
 	"fmt"
+
+	"github.com/docker/cli/cli/command"
+
+	"github.com/docker/mcp-gateway/cmd/docker-mcp/hints"
 )
 
-func Connect(ctx context.Context, cwd string, config Config, vendor string, global, quiet bool) error {
+func Connect(ctx context.Context, dockerCli command.Cli, cwd string, config Config, vendor string, global, quiet bool) error {
 	if vendor == vendorCodex {
 		if !global {
 			return fmt.Errorf("codex only supports global configuration. Re-run with --global or -g")
@@ -33,5 +37,11 @@ func Connect(ctx context.Context, cwd string, config Config, vendor string, glob
 		return err
 	}
 	fmt.Printf("You might have to restart '%s'.\n", vendor)
+	if hints.Enabled(dockerCli) {
+		hints.TipCyan.Print("Tip: Your client is now connected! Use ")
+		hints.TipCyanBoldItalic.Print("docker mcp tools ls")
+		hints.TipCyan.Println(" to see your available tools")
+		fmt.Println()
+	}
 	return nil
 }
diff --git a/cmd/docker-mcp/commands/catalog.go b/cmd/docker-mcp/commands/catalog.go
@@ -23,7 +23,7 @@ func catalogCommand(dockerCli command.Cli) *cobra.Command {
 	cmd.AddCommand(bootstrapCatalogCommand())
 	cmd.AddCommand(importCatalogCommand())
 	cmd.AddCommand(exportCatalogCommand())
-	cmd.AddCommand(lsCatalogCommand())
+	cmd.AddCommand(lsCatalogCommand(dockerCli))
 	cmd.AddCommand(rmCatalogCommand())
 	cmd.AddCommand(updateCatalogCommand(dockerCli))
 	cmd.AddCommand(showCatalogCommand(dockerCli))
@@ -86,7 +86,7 @@ cannot be exported as it is managed by Docker.`,
 	}
 }
 
-func lsCatalogCommand() *cobra.Command {
+func lsCatalogCommand(dockerCli command.Cli) *cobra.Command {
 	var opts struct {
 		Format catalog.Format
 	}
@@ -101,7 +101,7 @@ func lsCatalogCommand() *cobra.Command {
   # List catalogs in JSON format
   docker mcp catalog ls --format=json`,
 		RunE: func(cmd *cobra.Command, _ []string) error {
-			return catalog.Ls(cmd.Context(), opts.Format)
+			return catalog.Ls(cmd.Context(), dockerCli, opts.Format)
 		},
 	}
 	flags := cmd.Flags()
@@ -165,7 +165,7 @@ If no name is provided, shows the Docker official catalog.`,
 			}
 
 			mcpOAuthDcrEnabled := isMcpOAuthDcrFeatureEnabled(dockerCli)
-			return catalog.Show(cmd.Context(), name, opts.Format, mcpOAuthDcrEnabled)
+			return catalog.Show(cmd.Context(), dockerCli, name, opts.Format, mcpOAuthDcrEnabled)
 		},
 	}
 	flags := cmd.Flags()
diff --git a/cmd/docker-mcp/commands/client.go b/cmd/docker-mcp/commands/client.go
@@ -5,21 +5,21 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/spf13/pflag"
-
+	"github.com/docker/cli/cli/command"
 	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
 
 	"github.com/docker/mcp-gateway/cmd/docker-mcp/client"
 )
 
-func clientCommand(cwd string) *cobra.Command {
+func clientCommand(dockerCli command.Cli, cwd string) *cobra.Command {
 	cfg := client.ReadConfig()
 	cmd := &cobra.Command{
 		Use:   fmt.Sprintf("client (Supported: %s)", strings.Join(client.GetSupportedMCPClients(*cfg), ", ")),
 		Short: "Manage MCP clients",
 	}
 	cmd.AddCommand(listClientCommand(cwd, *cfg))
-	cmd.AddCommand(connectClientCommand(cwd, *cfg))
+	cmd.AddCommand(connectClientCommand(dockerCli, cwd, *cfg))
 	cmd.AddCommand(disconnectClientCommand(cwd, *cfg))
 	cmd.AddCommand(manualClientCommand())
 	return cmd
@@ -44,7 +44,7 @@ func listClientCommand(cwd string, cfg client.Config) *cobra.Command {
 	return cmd
 }
 
-func connectClientCommand(cwd string, cfg client.Config) *cobra.Command {
+func connectClientCommand(dockerCli command.Cli, cwd string, cfg client.Config) *cobra.Command {
 	var opts struct {
 		Global bool
 		Quiet  bool
@@ -54,7 +54,7 @@ func connectClientCommand(cwd string, cfg client.Config) *cobra.Command {
 		Short: fmt.Sprintf("Connect the Docker MCP Toolkit to a client. Supported clients: %s", strings.Join(client.GetSupportedMCPClients(cfg), " ")),
 		Args:  cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
-			return client.Connect(cmd.Context(), cwd, cfg, args[0], opts.Global, opts.Quiet)
+			return client.Connect(cmd.Context(), dockerCli, cwd, cfg, args[0], opts.Global, opts.Quiet)
 		},
 	}
 	flags := cmd.Flags()
diff --git a/cmd/docker-mcp/commands/root.go b/cmd/docker-mcp/commands/root.go
@@ -71,7 +71,7 @@ func Root(ctx context.Context, cwd string, dockerCli command.Cli) *cobra.Command
 	dockerClient := docker.NewClient(dockerCli)
 
 	cmd.AddCommand(catalogCommand(dockerCli))
-	cmd.AddCommand(clientCommand(cwd))
+	cmd.AddCommand(clientCommand(dockerCli, cwd))
 	cmd.AddCommand(configCommand(dockerClient))
 	cmd.AddCommand(featureCommand(dockerCli))
 	cmd.AddCommand(gatewayCommand(dockerClient, dockerCli))
@@ -80,7 +80,7 @@ func Root(ctx context.Context, cwd string, dockerCli command.Cli) *cobra.Command
 	cmd.AddCommand(registryCommand())
 	cmd.AddCommand(secretCommand(dockerClient))
 	cmd.AddCommand(serverCommand(dockerClient, dockerCli))
-	cmd.AddCommand(toolsCommand(dockerClient))
+	cmd.AddCommand(toolsCommand(dockerClient, dockerCli))
 	cmd.AddCommand(versionCommand())
 
 	if os.Getenv("DOCKER_MCP_SHOW_HIDDEN") == "1" {
diff --git a/cmd/docker-mcp/commands/server.go b/cmd/docker-mcp/commands/server.go
@@ -8,6 +8,7 @@ import (
 	"github.com/docker/cli/cli/command"
 	"github.com/spf13/cobra"
 
+	"github.com/docker/mcp-gateway/cmd/docker-mcp/hints"
 	"github.com/docker/mcp-gateway/cmd/docker-mcp/server"
 	"github.com/docker/mcp-gateway/pkg/config"
 	"github.com/docker/mcp-gateway/pkg/docker"
@@ -42,6 +43,11 @@ func serverCommand(docker docker.Client, dockerCli command.Cli) *cobra.Command {
 				fmt.Fprintln(cmd.OutOrStdout(), "No server is enabled")
 			} else {
 				fmt.Fprintln(cmd.OutOrStdout(), strings.Join(list, ", "))
+				if hints.Enabled(dockerCli) {
+					hints.TipCyan.Fprint(cmd.OutOrStdout(), "Tip: To use these servers, connect to a client (IE: claude/cursor) with ")
+					hints.TipCyanBoldItalic.Fprintln(cmd.OutOrStdout(), "docker mcp client connect <client-name>")
+					fmt.Fprintln(cmd.OutOrStdout(), "")
+				}
 			}
 
 			return nil
@@ -57,7 +63,7 @@ func serverCommand(docker docker.Client, dockerCli command.Cli) *cobra.Command {
 		Args:    cobra.MinimumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			mcpOAuthDcrEnabled := isMcpOAuthDcrFeatureEnabled(dockerCli)
-			return server.Enable(cmd.Context(), docker, args, mcpOAuthDcrEnabled)
+			return server.Enable(cmd.Context(), docker, dockerCli, args, mcpOAuthDcrEnabled)
 		},
 	})
 
@@ -68,7 +74,7 @@ func serverCommand(docker docker.Client, dockerCli command.Cli) *cobra.Command {
 		Args:    cobra.MinimumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			mcpOAuthDcrEnabled := isMcpOAuthDcrFeatureEnabled(dockerCli)
-			return server.Disable(cmd.Context(), docker, args, mcpOAuthDcrEnabled)
+			return server.Disable(cmd.Context(), docker, dockerCli, args, mcpOAuthDcrEnabled)
 		},
 	})
 
diff --git a/cmd/docker-mcp/commands/tools.go b/cmd/docker-mcp/commands/tools.go
@@ -1,13 +1,14 @@
 package commands
 
 import (
+	"github.com/docker/cli/cli/command"
 	"github.com/spf13/cobra"
 
 	"github.com/docker/mcp-gateway/cmd/docker-mcp/tools"
 	"github.com/docker/mcp-gateway/pkg/docker"
 )
 
-func toolsCommand(docker docker.Client) *cobra.Command {
+func toolsCommand(docker docker.Client, dockerCli command.Cli) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "tools",
 		Short: "Manage tools",
@@ -30,7 +31,7 @@ func toolsCommand(docker docker.Client) *cobra.Command {
 		Short:   "List tools",
 		Args:    cobra.NoArgs,
 		RunE: func(cmd *cobra.Command, _ []string) error {
-			return tools.List(cmd.Context(), version, gatewayArgs, verbose, "list", "", format)
+			return tools.List(cmd.Context(), dockerCli, version, gatewayArgs, verbose, "list", "", format)
 		},
 	})
 
@@ -39,7 +40,7 @@ func toolsCommand(docker docker.Client) *cobra.Command {
 		Short: "Count tools",
 		Args:  cobra.NoArgs,
 		RunE: func(cmd *cobra.Command, _ []string) error {
-			return tools.List(cmd.Context(), version, gatewayArgs, verbose, "count", "", format)
+			return tools.List(cmd.Context(), dockerCli, version, gatewayArgs, verbose, "count", "", format)
 		},
 	})
 
@@ -48,7 +49,7 @@ func toolsCommand(docker docker.Client) *cobra.Command {
 		Short: "Inspect a tool",
 		Args:  cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
-			return tools.List(cmd.Context(), version, gatewayArgs, verbose, "inspect", args[0], format)
+			return tools.List(cmd.Context(), dockerCli, version, gatewayArgs, verbose, "inspect", args[0], format)
 		},
 	})
 	cmd.AddCommand(&cobra.Command{
diff --git a/cmd/docker-mcp/hints/hints.go b/cmd/docker-mcp/hints/hints.go
@@ -0,0 +1,31 @@
+package hints
+
+import (
+	"github.com/docker/cli/cli/command"
+	"github.com/fatih/color"
+)
+
+func Enabled(dockerCli command.Cli) bool {
+	configFile := dockerCli.ConfigFile()
+	if configFile == nil || configFile.Plugins == nil {
+		return true
+	}
+
+	pluginConfig, ok := configFile.Plugins["-x-cli-hints"]
+	if !ok {
+		return true
+	}
+
+	enabledValue, exists := pluginConfig["enabled"]
+	if !exists {
+		return true
+	}
+
+	return enabledValue == "true"
+}
+
+var (
+	TipCyan           = color.New(color.FgCyan)
+	TipCyanBoldItalic = color.New(color.FgCyan, color.Bold, color.Italic)
+	TipGreen          = color.New(color.FgGreen)
+)
diff --git a/cmd/docker-mcp/server/enable.go b/cmd/docker-mcp/server/enable.go
@@ -5,23 +5,25 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/docker/cli/cli/command"
 	"gopkg.in/yaml.v3"
 
+	"github.com/docker/mcp-gateway/cmd/docker-mcp/hints"
 	"github.com/docker/mcp-gateway/pkg/catalog"
 	"github.com/docker/mcp-gateway/pkg/config"
 	"github.com/docker/mcp-gateway/pkg/docker"
 	"github.com/docker/mcp-gateway/pkg/oauth"
 )
 
-func Disable(ctx context.Context, docker docker.Client, serverNames []string, mcpOAuthDcrEnabled bool) error {
-	return update(ctx, docker, nil, serverNames, mcpOAuthDcrEnabled)
+func Disable(ctx context.Context, docker docker.Client, dockerCli command.Cli, serverNames []string, mcpOAuthDcrEnabled bool) error {
+	return update(ctx, docker, dockerCli, nil, serverNames, mcpOAuthDcrEnabled)
 }
 
-func Enable(ctx context.Context, docker docker.Client, serverNames []string, mcpOAuthDcrEnabled bool) error {
-	return update(ctx, docker, serverNames, nil, mcpOAuthDcrEnabled)
+func Enable(ctx context.Context, docker docker.Client, dockerCli command.Cli, serverNames []string, mcpOAuthDcrEnabled bool) error {
+	return update(ctx, docker, dockerCli, serverNames, nil, mcpOAuthDcrEnabled)
 }
 
-func update(ctx context.Context, docker docker.Client, add []string, remove []string, mcpOAuthDcrEnabled bool) error {
+func update(ctx context.Context, docker docker.Client, dockerCli command.Cli, add []string, remove []string, mcpOAuthDcrEnabled bool) error {
 	// Read registry.yaml that contains which servers are enabled.
 	registryYAML, err := config.ReadRegistry(ctx, docker)
 	if err != nil {
@@ -94,5 +96,21 @@ func update(ctx context.Context, docker docker.Client, add []string, remove []st
 		return fmt.Errorf("writing registry config: %w", err)
 	}
 
+	if len(add) > 0 && hints.Enabled(dockerCli) {
+		hints.TipCyan.Print("Tip: ")
+		hints.TipGreen.Print("✓")
+		hints.TipCyan.Print(" Server enabled. To view all enabled servers, use ")
+		hints.TipCyanBoldItalic.Println("docker mcp server ls")
+		fmt.Println()
+	}
+
+	if len(remove) > 0 && hints.Enabled(dockerCli) {
+		hints.TipCyan.Print("Tip: ")
+		hints.TipGreen.Print("✓")
+		hints.TipCyan.Print(" Server disabled. To see remaining enabled servers, use ")
+		hints.TipCyanBoldItalic.Println("docker mcp server ls")
+		fmt.Println()
+	}
+
 	return nil
 }
diff --git a/cmd/docker-mcp/server/server_test.go b/cmd/docker-mcp/server/server_test.go
diff --git a/cmd/docker-mcp/tools/list.go b/cmd/docker-mcp/tools/list.go

Original file line number	Diff line number	Diff line change
`@@ -6,10 +6,13 @@ import (`
`6`	`6`	`"fmt"`
`7`	`7`	`"time"`
`8`	`8`
	`9`	`+ "github.com/docker/cli/cli/command"`
	`10`	`+`
	`11`	`+ "github.com/docker/mcp-gateway/cmd/docker-mcp/hints"`
`9`	`12`	`"github.com/docker/mcp-gateway/pkg/telemetry"`
`10`	`13`	`)`
`11`	`14`
`12`		`-func Ls(ctx context.Context, format Format) error {`
	`15`	`+func Ls(ctx context.Context, dockerCli command.Cli, format Format) error {`
`13`	`16`	`// Initialize telemetry`
`14`	`17`	`telemetry.Init()`
`15`	`18`
`@@ -32,13 +35,13 @@ func Ls(ctx context.Context, format Format) error {`
`32`	`35`	`}`
`33`	`36`	`fmt.Println(string(data))`
`34`	`37`	`} else {`
`35`		`- humanPrintCatalog(*cfg)`
	`38`	`+ humanPrintCatalog(dockerCli, *cfg)`
`36`	`39`	`}`
`37`	`40`
`38`	`41`	`return nil`
`39`	`42`	`}`
`40`	`43`
`41`		`-func humanPrintCatalog(cfg Config) {`
	`44`	`+func humanPrintCatalog(dockerCli command.Cli, cfg Config) {`
`42`	`45`	`if len(cfg.Catalogs) == 0 {`
`43`	`46`	`fmt.Println("No catalogs configured.")`
`44`	`47`	`return`
`@@ -47,4 +50,9 @@ func humanPrintCatalog(cfg Config) {`
`47`	`50`	`for name, catalog := range cfg.Catalogs {`
`48`	`51`	`fmt.Printf("%s: %s\n", name, catalog.DisplayName)`
`49`	`52`	`}`
	`53`	`+ if hints.Enabled(dockerCli) {`
	`54`	`+ hints.TipCyan.Print("Tip: To browse a catalog's servers, use ")`
	`55`	`+ hints.TipCyanBoldItalic.Print("docker mcp catalog show <catalog-name>")`
	`56`	`+ fmt.Println()`
	`57`	`+ }`
`50`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ func catalogCommand(dockerCli command.Cli) *cobra.Command {`
`23`	`23`	`cmd.AddCommand(bootstrapCatalogCommand())`
`24`	`24`	`cmd.AddCommand(importCatalogCommand())`
`25`	`25`	`cmd.AddCommand(exportCatalogCommand())`
`26`		`- cmd.AddCommand(lsCatalogCommand())`
	`26`	`+ cmd.AddCommand(lsCatalogCommand(dockerCli))`
`27`	`27`	`cmd.AddCommand(rmCatalogCommand())`
`28`	`28`	`cmd.AddCommand(updateCatalogCommand(dockerCli))`
`29`	`29`	`cmd.AddCommand(showCatalogCommand(dockerCli))`
@@ -86,7 +86,7 @@ cannot be exported as it is managed by Docker.`,
`86`	`86`	`}`
`87`	`87`	`}`
`88`	`88`
`89`		`-func lsCatalogCommand() *cobra.Command {`
	`89`	`+func lsCatalogCommand(dockerCli command.Cli) *cobra.Command {`
`90`	`90`	`var opts struct {`
`91`	`91`	`Format catalog.Format`
`92`	`92`	`}`
`@@ -101,7 +101,7 @@ func lsCatalogCommand() *cobra.Command {`
`101`	`101`	`# List catalogs in JSON format`
`102`	`102`	docker mcp catalog ls --format=json`,
`103`	`103`	`RunE: func(cmd *cobra.Command, _ []string) error {`
`104`		`- return catalog.Ls(cmd.Context(), opts.Format)`
	`104`	`+ return catalog.Ls(cmd.Context(), dockerCli, opts.Format)`
`105`	`105`	`},`
`106`	`106`	`}`
`107`	`107`	`flags := cmd.Flags()`
@@ -165,7 +165,7 @@ If no name is provided, shows the Docker official catalog.`,
`165`	`165`	`}`
`166`	`166`
`167`	`167`	`mcpOAuthDcrEnabled := isMcpOAuthDcrFeatureEnabled(dockerCli)`
`168`		`- return catalog.Show(cmd.Context(), name, opts.Format, mcpOAuthDcrEnabled)`
	`168`	`+ return catalog.Show(cmd.Context(), dockerCli, name, opts.Format, mcpOAuthDcrEnabled)`
`169`	`169`	`},`
`170`	`170`	`}`
`171`	`171`	`flags := cmd.Flags()`