Merge pull request #1397 from otaviof/RHTAP-5997

RHTAP-5997: MCP Notes Tool

Author: openshift-merge-bot[bot]

pkg/deployer/helm.go

@@ -147,6 +147,8 @@ func (h *Helm) Verify() error {
 	return nil
 }
 
+// VerifyWithRetry attempts to verify the Helm deployment multiple times with a
+// delay between retries.
 func (h *Helm) VerifyWithRetry() error {
 	var err error
 	var retries = 3
@@ -178,6 +180,19 @@ func (h *Helm) VisitReleaseResources(
 	})
 }
 
+// GetNotes retrieves the latest release (version 0) of the Helm chart, printing
+// out the notes from the info section.
+func (h *Helm) GetNotes() (string, error) {
+	c := action.NewGet(h.actionCfg)
+	c.Version = 0
+
+	res, err := c.Run(h.chart.Name())
+	if err != nil {
+		return "", err
+	}
+	return res.Info.Notes, nil
+}
+
 // NewHelm creates a new Helm instance, setting up the Helm action configuration
 // to be used on subsequent interactions. The Helm instance is bound to a single
 // Helm Chart.

pkg/mcpserver/instructions.md

@@ -67,3 +67,4 @@ I will guide you with suggestions for the next logical action in my responses. L
 The installer has finished successfully and all components are running as expected.
 
 - Use `tssc_status` to view the overall installer status.
+- Use `tssc_notes` to retrieve instructions on how to connect to a service (product) deployed by the installer. You must provide the product name.

pkg/mcptools/deploytools.go

@@ -46,13 +46,7 @@ func (d *DeployTools) deployHandler(
 	// error to inform the user about MCP configuration tools.
 	cfg, err := d.cm.GetConfig(ctx)
 	if err != nil {
-		return mcp.NewToolResultError(fmt.Sprintf(`
-The cluster is not configured yet, use the tool %q to identify the cluster
-installation status, and the next actions after that.
-
-> %s`,
-			StatusToolName, err.Error(),
-		)), nil
+		return mcp.NewToolResultError(missingClusterConfigErrorFromErr(err)), nil
 	}
 
 	// Validating the topology as a whole, dependencies and integrations to ensure

pkg/mcptools/notestool.go

@@ -0,0 +1,150 @@
+package mcptools
+
+import (
+	"context"
+	"fmt"
+	"log/slog"
+
+	"github.com/redhat-appstudio/tssc-cli/pkg/config"
+	"github.com/redhat-appstudio/tssc-cli/pkg/constants"
+	"github.com/redhat-appstudio/tssc-cli/pkg/deployer"
+	"github.com/redhat-appstudio/tssc-cli/pkg/flags"
+	"github.com/redhat-appstudio/tssc-cli/pkg/installer"
+	"github.com/redhat-appstudio/tssc-cli/pkg/k8s"
+	"github.com/redhat-appstudio/tssc-cli/pkg/resolver"
+
+	"github.com/mark3labs/mcp-go/mcp"
+	"github.com/mark3labs/mcp-go/server"
+)
+
+// NotesTool a MCP tool to provide connection instructions for products. These
+// products must be completely deployed before its "NOTES.txt" is generated.
+type NotesTool struct {
+	logger *slog.Logger              // application logger
+	flags  *flags.Flags              // global flags
+	kube   *k8s.Kube                 // kubernetes client
+	cm     *config.ConfigMapManager  // cluster configuration
+	tb     *resolver.TopologyBuilder // topology builder
+	job    *installer.Job            // cluster deployment job
+}
+
+var _ Interface = &NotesTool{}
+
+const (
+	// NotesToolName retrieves the connection instruction for a product.
+	NotesToolName = constants.AppName + "_notes"
+)
+
+// notesHandler retrieves the Helm chart notes (NOTES.txt) for a specified Red Hat
+// product. It ensures the product name is provided, checks if the cluster
+// installation is in a "completed" phase, and then uses a Helm client to fetch
+// and return the notes.
+func (n *NotesTool) notesHandler(
+	ctx context.Context,
+	ctr mcp.CallToolRequest,
+) (*mcp.CallToolResult, error) {
+	// Ensure the user has provided the product name.
+	name := ctr.GetString(NameArg, "")
+	if name == "" {
+		return mcp.NewToolResultError(`
+		You must inform the Red Hat product name`,
+		), nil
+	}
+
+	// Check if the cluster is ready. If not, provide instructions on how to
+	// proceed. The installer must be on "completed" status.
+	phase, err := getInstallerPhase(ctx, n.cm, n.tb, n.job)
+	currentStatus := fmt.Sprintf(`
+# Current Status: %q
+
+The cluster is not ready, use the tool %q to check the overall status and general
+directions on how to proceed.`,
+		phase, StatusToolName,
+	)
+	if err != nil {
+		return mcp.NewToolResultText(fmt.Sprintf(`%s
+
+Inspecting the cluster returned the following error:
+
+> %s`,
+			currentStatus, err.Error(),
+		)), nil
+	}
+	if phase != CompletedPhase {
+		return mcp.NewToolResultText(currentStatus), nil
+	}
+
+	dep, err := n.tb.GetCollection().GetProductDependency(name)
+	if err != nil {
+		return mcp.NewToolResultErrorFromErr(
+			fmt.Sprintf(`
+Unable to find the dependency for the informed product name %q`,
+				name,
+			),
+			err,
+		), nil
+	}
+
+	hc, err := deployer.NewHelm(
+		n.logger, n.flags, n.kube, dep.Namespace(), dep.Chart())
+	if err != nil {
+		return mcp.NewToolResultErrorFromErr(
+			fmt.Sprintf(`
+Error trying to instantiate a Helm client for the chart %q on namespace %q.`,
+				dep.Chart().Name(),
+				dep.Namespace(),
+			),
+			err,
+		), nil
+	}
+
+	notes, err := hc.GetNotes()
+	if err != nil {
+		return mcp.NewToolResultErrorFromErr(
+			fmt.Sprintf(`
+Unable to get "NOTES.txt" for the chart %q on namespace %q.`,
+				dep.Chart().Name(),
+				dep.Namespace(),
+			),
+			err,
+		), nil
+	}
+
+	return mcp.NewToolResultText(notes), nil
+}
+
+func (n *NotesTool) Init(s *server.MCPServer) {
+	s.AddTools([]server.ServerTool{{
+		Tool: mcp.NewTool(
+			NotesToolName,
+			mcp.WithDescription(`
+Retrieve the service notes, the initial coordinates to utilize services deployed
+by this installer, from the informed product name.`,
+			),
+			mcp.WithString(
+				NameArg,
+				mcp.Description(`
+The name of the Red Hat product to retrieve connection information.`,
+				),
+			),
+		),
+		Handler: n.notesHandler,
+	}}...)
+}
+
+func NewNotesTool(
+	logger *slog.Logger,
+	f *flags.Flags,
+	kube *k8s.Kube,
+	cm *config.ConfigMapManager,
+	tb *resolver.TopologyBuilder,
+) *NotesTool {
+	return &NotesTool{
+		logger: logger,
+		flags:  f,
+		kube:   kube,
+		cm:     cm,
+		tb:     tb,
+		job:    installer.NewJob(kube),
+	}
+}

pkg/mcptools/status.go

@@ -0,0 +1,60 @@
+package mcptools
+
+import (
+	"context"
+	"errors"
+
+	"github.com/redhat-appstudio/tssc-cli/pkg/config"
+	"github.com/redhat-appstudio/tssc-cli/pkg/installer"
+	"github.com/redhat-appstudio/tssc-cli/pkg/resolver"
+)
+
+func getInstallerPhase(
+	ctx context.Context,
+	cm *config.ConfigMapManager,
+	tb *resolver.TopologyBuilder,
+	job *installer.Job,
+) (string, error) {
+	// Ensure the cluster is configured.
+	cfg, err := cm.GetConfig(ctx)
+	if err != nil {
+		// If config is missing, we are in AwaitingConfigurationPhase.
+		// The specific error will be used by the caller for detailed messaging.
+		return AwaitingConfigurationPhase, err
+	}
+
+	// Given the cluster is configured, inspect the topology to ensure all
+	// dependencies and integrations are resolved.
+	if _, err = tb.Build(ctx, cfg); err != nil {
+		// If topology build fails, we are in AwaitingIntegrationsPhase.
+		// The specific resolver error will be used by the caller for detailed messaging.
+		return AwaitingIntegrationsPhase, err
+	}
+
+	// Given integrations are in place, inspect the current state of the
+	// cluster deployment job.
+	jobState, err := job.GetState(ctx)
+	if err != nil {
+		// If job state cannot be determined, it's an operational error.
+		// Return InstallerErrorPhase with the original error.
+		return InstallerErrorPhase, err
+	}
+
+	// Map the job state to an installer phase.
+	switch jobState {
+	case installer.NotFound:
+		return ReadyToDeployPhase, nil
+	case installer.Deploying, installer.Failed:
+		// Both 'Deploying' and 'Failed' states indicate that the deployment
+		// process is active or has attempted to run, thus falling under
+		// the 'DeployingPhase' for overall status reporting.
+		return DeployingPhase, nil
+	case installer.Done:
+		return CompletedPhase, nil
+	default:
+		// Unrecognized installer state from s.job.GetState.
+		// This is also an operational error.
+		return InstallerErrorPhase,
+			errors.New("unknown installer job state reported by cluster")
+	}
+}