feat: implement runconfig export/import functionality (#1171) (#1183)

Signed-off-by: Juan Antonio Osorio <[email protected]>

Author: JAORMX

cmd/thv/app/commands.go

@@ -47,6 +47,7 @@ func NewRootCmd(enableUpdates bool) *cobra.Command {
 	rootCmd.AddCommand(proxyCmd)
 	rootCmd.AddCommand(restartCmd)
 	rootCmd.AddCommand(serveCmd)
+	rootCmd.AddCommand(newExportCmd())
 	rootCmd.AddCommand(newVersionCmd())
 	rootCmd.AddCommand(logsCommand())
 	rootCmd.AddCommand(newSecretCommand())

cmd/thv/app/export.go

@@ -0,0 +1,65 @@
+package app
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/spf13/cobra"
+
+	"github.com/stacklok/toolhive/pkg/runner"
+)
+
+func newExportCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:   "export <workload name> <path>",
+		Short: "Export a workload's run configuration to a file",
+		Long: `Export a workload's run configuration to a file for sharing or backup.
+
+	The exported configuration can be used with 'thv run --from-config <path>' to recreate
+	the same workload with identical settings.
+
+	Examples:
+	# Export a workload configuration to a file
+	thv export my-server ./my-server-config.json
+
+	# Export to a specific directory
+	thv export github-mcp /tmp/configs/github-config.json`,
+		Args: cobra.ExactArgs(2),
+		RunE: exportCmdFunc,
+	}
+}
+
+func exportCmdFunc(cmd *cobra.Command, args []string) error {
+	ctx := cmd.Context()
+	workloadName := args[0]
+	outputPath := args[1]
+
+	// Load the saved run configuration
+	runnerInstance, err := runner.LoadState(ctx, workloadName)
+	if err != nil {
+		return fmt.Errorf("failed to load run configuration for workload '%s': %w", workloadName, err)
+	}
+
+	// Ensure the output directory exists
+	outputDir := filepath.Dir(outputPath)
+	if err := os.MkdirAll(outputDir, 0750); err != nil {
+		return fmt.Errorf("failed to create output directory: %w", err)
+	}
+
+	// Create the output file
+	// #nosec G304 - outputPath is provided by the user as a command line argument for export functionality
+	outputFile, err := os.OpenFile(outputPath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600)
+	if err != nil {
+		return fmt.Errorf("failed to create output file: %w", err)
+	}
+	defer outputFile.Close()
+
+	// Write the configuration to the file
+	if err := runnerInstance.Config.WriteJSON(outputFile); err != nil {
+		return fmt.Errorf("failed to write configuration to file: %w", err)
+	}
+
+	fmt.Printf("Successfully exported run configuration for '%s' to '%s'\n", workloadName, outputPath)
+	return nil
+}

cmd/thv/app/run.go

@@ -1,6 +1,7 @@
 package app
 
 import (
+	"context"
 	"fmt"
 	"net"
 	"os"
@@ -10,6 +11,7 @@ import (
 	"github.com/stacklok/toolhive/pkg/container"
 	"github.com/stacklok/toolhive/pkg/groups"
 	"github.com/stacklok/toolhive/pkg/logger"
+	"github.com/stacklok/toolhive/pkg/runner"
 	"github.com/stacklok/toolhive/pkg/workloads"
 )
 
@@ -18,7 +20,7 @@ var runCmd = &cobra.Command{
 	Short: "Run an MCP server",
 	Long: `Run an MCP server with the specified name, image, or protocol scheme.
 
-ToolHive supports three ways to run an MCP server:
+ToolHive supports four ways to run an MCP server:
 
 1. From the registry:
    $ thv run server-name [-- args...]
@@ -39,9 +41,20 @@ ToolHive supports three ways to run an MCP server:
    or go (Golang). For Go, you can also specify local paths starting
    with './' or '../' to build and run local Go projects.
 
+4. From an exported configuration:
+   $ thv run --from-config <path>
+   Runs an MCP server using a previously exported configuration file.
+
 The container will be started with the specified transport mode and
 permission profile. Additional configuration can be provided via flags.`,
-	Args: cobra.MinimumNArgs(1),
+	Args: func(cmd *cobra.Command, args []string) error {
+		// If --from-config is provided, no args are required
+		if runFlags.FromConfig != "" {
+			return nil
+		}
+		// Otherwise, require at least 1 argument
+		return cobra.MinimumNArgs(1)(cmd, args)
+	},
 	RunE: runCmdFunc,
 	// Ignore unknown flags to allow passing flags to the MCP server
 	FParseErrWhitelist: cobra.FParseErrWhitelist{
@@ -67,9 +80,18 @@ func init() {
 func runCmdFunc(cmd *cobra.Command, args []string) error {
 	ctx := cmd.Context()
 
+	// Check if we should load configuration from a file
+	if runFlags.FromConfig != "" {
+		return runFromConfigFile(ctx)
+	}
+
 	// Get the name of the MCP server to run.
 	// This may be a server name from the registry, a container image, or a protocol scheme.
-	serverOrImage := args[0]
+	// When using --from-config, no args are required
+	var serverOrImage string
+	if len(args) > 0 {
+		serverOrImage = args[0]
+	}
 
 	// Process command arguments using os.Args to find everything after --
 	cmdArgs := parseCommandArguments(os.Args)
@@ -178,3 +200,43 @@ func ValidateAndNormaliseHostFlag(host string) (string, error) {
 
 	return "", fmt.Errorf("could not resolve host: %s", host)
 }
+
+// runFromConfigFile loads a run configuration from a file and executes it
+func runFromConfigFile(ctx context.Context) error {
+	// Open and read the configuration file
+	configFile, err := os.Open(runFlags.FromConfig)
+	if err != nil {
+		return fmt.Errorf("failed to open configuration file '%s': %w", runFlags.FromConfig, err)
+	}
+	defer configFile.Close()
+
+	// Deserialize the configuration
+	runConfig, err := runner.ReadJSON(configFile)
+	if err != nil {
+		return fmt.Errorf("failed to parse configuration file: %w", err)
+	}
+
+	// Create container runtime
+	rt, err := container.NewFactory().Create(ctx)
+	if err != nil {
+		return fmt.Errorf("failed to create container runtime: %v", err)
+	}
+
+	// Set the runtime in the config
+	runConfig.Deployer = rt
+
+	// Create workload manager
+	workloadManager := workloads.NewManagerFromRuntime(rt)
+
+	// Run the workload based on foreground flag
+	if runFlags.Foreground {
+		err = workloadManager.RunWorkload(ctx, runConfig)
+	} else {
+		err = workloadManager.RunWorkloadDetached(ctx, runConfig)
+	}
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

cmd/thv/app/run_flags.go

@@ -70,6 +70,9 @@ type RunFlags struct {
 
 	// Tools filter
 	ToolsFilter []string
+
+	// Configuration import
+	FromConfig string
 }
 
 // AddRunFlags adds all the run flags to a command
@@ -155,6 +158,7 @@ func AddRunFlags(cmd *cobra.Command, config *RunFlags) {
 		nil,
 		"Filter MCP server tools (comma-separated list of tool names)",
 	)
+	cmd.Flags().StringVar(&config.FromConfig, "from-config", "", "Load configuration from exported file")
 }
 
 // BuildRunnerConfig creates a runner.RunConfig from the configuration