chore: [ML-1425]: Added a create_follow_up_prompt tool to generate prompt events based on the action_data (#217)

* 1a33cd chore: [ML-1425]: Added readme

* d77cf7 chore: [ML-1397]: updated prompt

* bd7e7b chore: [ML-1425]: Added a create_follow_up_prompt tool to generate prompt events based on the action_data

* f2ce07 chore: [ML-1425]: Added a create_follow_up_prompt tool to generate prompt events based on the action_data

Author: Saranya-jena

README.md

@@ -648,6 +648,52 @@ Environment variables are prefixed with `HARNESS_`:
 
 The server uses a Harness API key for authentication. This can be set via the `HARNESS_API_KEY` environment variable.
 
+### Using the create_follow_up_prompt Tool to generate actionable prompt events
+
+The `create_follow_up_prompt` tool allows you to generate actionable prompt events that appear as buttons in the UI. These buttons can navigate users to specific pages within the Harness platform.
+
+Here's how to use it:
+
+```json
+{
+  "actions": [
+    {
+      "text": "Button Text",
+      "action": "OPEN_ENTITY_NEW_TAB",
+      "data": {
+        "pageName": "PAGE_NAME",
+        "metadata": {
+          "<KEY>": "<VALUE>"
+        }
+      }
+    }
+  ]
+}
+```
+
+#### Parameters:
+
+- `text`: The text to display on the button
+- `action`: The action to perform (currently supports `OPEN_ENTITY_NEW_TAB`)
+- `data`: Contains navigation information
+  - `pageName`: The page to navigate to (e.g., `ExecutionPipelineView`, `PipelineStudio`, etc.)
+  - `metadata`: Key-value pairs needed for the target page (e.g., `{"executionId": "abc123", "pipelineId": "xyz789"}`)
+
+#### Example:
+
+```go
+actionData := `{"actions": [{"text": "View Pipeline", "action": "OPEN_ENTITY_NEW_TAB", "data": {"pageName": "PipelineStudio", "metadata": {"id": "pipeline-id"}}}]}`
+```
+
+#### Alternative: Quick Prompts
+
+If you provide an array of strings instead of the actions object, these strings will be added to the message box as quick prompts that users can click on:
+
+```go
+// Add quick prompts to the message box
+quickPrompts := `["Show me pipeline details", "List recent executions", "Analyze performance"]`
+```
+
 ## Notes for Local Testing
 
 There might be certain tools that are not added in external mode or vice-versa, for local testing, following changes in `pkg/harness/tools.go` need to be done in mcp-server code to enable that certain tool in both internal and external modes.

pkg/harness/event/types/simpleaction.go

@@ -8,11 +8,11 @@ const (
 )
 
 type ActionWrapper struct {
-	Prompts []string `json:"prompts"`
+	Prompts interface{} `json:"prompts"`
 }
 
 // NewActionEvent uses strings and makes simple selectable actions in the UI (always displayed last)
-func NewActionEvent(actions []string, opts ...event.CustomEventOption) event.CustomEvent {
+func NewActionEvent(actions interface{}, opts ...event.CustomEventOption) event.CustomEvent {
 	allOpts := append([]event.CustomEventOption{event.WithDisplayOrder(ActionDisplayOrder)}, opts...)
 	wrapper := ActionWrapper{Prompts: actions}
 	return event.NewCustomEvent("prompt", wrapper, allOpts...)

pkg/harness/prompts/prompts.go

@@ -29,7 +29,9 @@ func RegisterPrompts(mcpServer *server.MCPServer) {
 		p.NewPrompt().SetName("pipeline_summarizer").
 			SetDescription("Summarize a Harness pipeline's structure, purpose, and behavior.").
 			SetResultDescription("Comprehensive pipeline summary with key details.").
-			SetText(`{"standard": "I need you to summarise the pipeline with the input pipeline identifier.\n\n1. **What to do?**\n   - Fetch any required metadata or definitions for the pipeline.\n   - Analyze its configuration and structure.\n   - Make the necessary tool calls to get the pipeline related details.\n   - Produce a concise, accurate summary of the pipeline's design and behavior.\n\n2. **Tools to call to get a complete overview of pipeline**\n   - get_pipeline\n   - get_pipeline_summary\n   - list_pipelines\n   - get_environment\n   - get_service\n   - list_settings (with category as NOTIFICATIONS)\n   - get_secret\n   - list_triggers\n\n3. **Must-have details in the output** (acceptance criteria):\n   - **Purpose and Objective**: What this pipeline is designed to accomplish (e.g. \"Builds and deploys a Node.js microservice to staging and production.\")\n   - **High-Level Architecture**: Major components and phases (build, test, security scanning, deployment).\n   - **Environment Flow**: How the execution moves through environments.\n   - **Key Technologies**: Languages, frameworks, deployment targets, and tools used.\n   - **Trigger Conditions**: What events start the pipeline (Git commits, manual triggers, schedules).\n   - **Approval Gates**: Any manual approvals required, and who must sign off.\n   - **Dependencies**: External dependencies such as environments, infrastructures, connectors, services, other pipelines this one relies on, etc with their ids if available.\n   - **Success Criteria**: What defines a successful run.\n\n4. **Output format**\n   Return the following data ONLY in a markdown format, DO NOT use JSON literals:\n   {\n     \"purpose\":       string,\n     \"architecture\":  string,\n     \"environment\":   string,\n     \"technologies\":  string[],\n     \"triggers\":      string[],\n     \"approvals\":     string[],\n     \"dependencies\":  string[],\n     \"success_criteria\": string,\n     \"past_execution_details\": string[]\n   }"}`).
+			SetText(`{
+				"standard": "I need you to summarise the pipeline with the input pipeline identifier.\n    1. What to do?\n       - Fetch any required metadata or definitions for the pipeline.\n       - Analyze its configuration and structure.\n       - Make the necessary tool calls to get the pipeline related details.\n       - Before making any tool call, for all other tool calls you MUST send a message on what tool you are going to call and why.\n       - Produce a concise, accurate summary of the pipeline's design and behavior.\n    2. Tools to call to get a complete overview of pipeline:\n       - get_pipeline\n       - get_pipeline_summary\n       - list_pipelines\n       - get_environment\n       - get_service\n       - list_settings (with category as NOTIFICATIONS)\n       - get_secret\n       - list_triggers\n       - list_executions\n       - create_follow_up_prompt\n    3. Must-have details in the summary (acceptance criteria):\n       - Purpose and Objective: What this pipeline is designed to accomplish (e.g. 'Builds and deploys a Node.js microservice to staging and production.')\n       - High-Level Architecture: Major components and phases (build, test, security scanning, deployment).\n       - Environment Flow: How the execution moves through environments.\n       - Key Technologies: Languages, frameworks, deployment targets, and tools used.\n       - Trigger Conditions: What events start the pipeline (Git commits, manual triggers, schedules).\n       - Approval Gates: Any manual approvals required, and who must sign off.\n       - Dependencies: External dependencies such as environments, infrastructures, connectors, services, other pipelines this one relies on, etc with their ids if available.\n       - Success Criteria: What defines a successful run.\n    4. Instructions for calling create_follow_up_prompt tool:\n       Follow these steps in order:\n       a. Make a tool call to list_executions to fetch the execution ID of the latest execution of the given pipeline\n       b. Make a tool call to create_follow_up_prompt with these parameters:\n          - action_data: The following JSON data stringified:\n            {\"actions\": [\n              {\n                \"text\": \"View Latest Execution\",\n                \"action\": \"OPEN_ENTITY_NEW_TAB\",\n                \"data\": {\n                  \"pageName\": \"ExecutionPipelineView\",\n                  \"metadata\": {\n                     \"executionId\": \"executionId-value\",\n                     \"pipelineId\": \"pipeline-id\"\n                  }\n                }\n              },\n              {\n                \"text\": \"View Pipeline\",\n                \"action\": \"OPEN_ENTITY_NEW_TAB\",\n                \"data\": {\n                  \"pageName\": \"PipelineStudio\",\n                  \"metadata\": {\n                     \"id\": \"pipeline-id\"\n                  }\n                }\n              }\n            ]}\n          - Replace \"executionId-value\" with the actual execution ID from the list_executions response\n          - Replace \"pipeline-id\" with the pipeline identifier\n          - If there are no executions available, MUST use this JSON data instead(with only option view pipeline):\n            {\"actions\": [\n              {\n                \"text\": \"View Pipeline\",\n                \"action\": \"OPEN_ENTITY_NEW_TAB\",\n                \"data\": {\n                  \"pageName\": \"PIPELINE_STUDIO\",\n                  \"metadata\": {\n                     \"id\": \"pipeline-id\"\n                  }\n                }\n              }\n            ]}\n\n    5. Output format:\n       Return the following summary data ONLY in a markdown format, DO NOT use JSON literals:\n       {\n         \"### Purpose\":       string,\n         \"### Architecture\":  string,\n         \"### Environment\":   string,\n         \"### Technologies\":  string[],\n         \"### Triggers\":      string[],\n         \"### Approvals\":     string[],\n         \"### Dependencies\":  string[],\n         \"### Success Criteria\": string,\n         \"### Past Execution Details\": string[]\n       } \n       Return the tool response exactly as received, in markdown format. DO NOT use JSON literals. The pipeline summary should the final response."
+			  }`).
 			Build())
 
 	p.AddPrompts(prompts, mcpServer)

pkg/harness/tools/pipelines.go

@@ -4,11 +4,13 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"strings"
 
 	"github.com/harness/harness-mcp/client"
 	"github.com/harness/harness-mcp/client/dto"
 	"github.com/harness/harness-mcp/cmd/harness-mcp-server/config"
 	"github.com/harness/harness-mcp/pkg/harness/common"
+	"github.com/harness/harness-mcp/pkg/harness/event/types"
 	"github.com/mark3labs/mcp-go/mcp"
 	"github.com/mark3labs/mcp-go/server"
 )
@@ -390,6 +392,76 @@ func GetPipelineSummaryTool(config *config.Config, client *client.PipelineServic
 		}
 }
 
+type ActionData struct {
+	Actions []struct {
+		Text   string `json:"text"`
+		Action string `json:"action"`
+		Data   struct {
+			PageName string            `json:"pageName"`
+			Metadata map[string]string `json:"metadata"`
+		} `json:"data"`
+	} `json:"actions"`
+}
+
+func CreateFollowUpPromptTool(config *config.Config, client *client.PipelineService) (tool mcp.Tool, handler server.ToolHandlerFunc) {
+	return mcp.NewTool("create_follow_up_prompt",
+			mcp.WithDescription("Creates a follow up prompt event with the specified data."),
+			mcp.WithString("action_data",
+				mcp.Required(),
+				mcp.Description("A JSON string in one of these formats: 1) An array of action objects: {\"actions\": [{\"text\": \"Button Text\", \"action\": \"OPEN_ENTITY_NEW_TAB\", \"data\": {\"pageName\": \"PAGE_NAME\", \"metadata\": {\"<KEY>\": \"<VALUE>\"}}}]} OR 2) just a single string action without any array: \"Action1\""),
+			),
+		),
+		func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
+			actionDataStr, err := RequiredParam[string](request, "action_data")
+			if err != nil {
+				return mcp.NewToolResultError(err.Error()), nil
+			}
+
+			// Parse action data into actionStrings (array of JSON strings)
+			var actionStrings []string
+			var actionObject interface{}
+
+			// Check if the input is a plain text message (not JSON)
+			if !strings.HasPrefix(strings.TrimSpace(actionDataStr), "{") && !strings.HasPrefix(strings.TrimSpace(actionDataStr), "[") {
+				actionStrings = append(actionStrings, actionDataStr)
+				actionObject = actionStrings
+			} else {
+				// Try to parse as JSON
+				var actionString string
+				// First try if it's already a JSON string
+				if err := json.Unmarshal([]byte(actionDataStr), &actionString); err == nil {
+					actionStrings = append(actionStrings, actionString)
+					actionObject = actionStrings
+				} else {
+					// Try if it's a wrapper with "actions" field
+					var actionDataWrapper ActionData
+
+					if err := json.Unmarshal([]byte(actionDataStr), &actionDataWrapper); err == nil {
+						// Convert each action to a stringified JSON
+						actionObject = actionDataWrapper.Actions
+					} else {
+						return mcp.NewToolResultError(fmt.Sprintf("Failed to parse action data: %v", err)), nil
+					}
+
+				}
+			}
+
+			// Create a custom event with the stringified action data
+			promptEvent := types.NewActionEvent(actionObject)
+
+			// Create an embedded resource from the event
+			resource, err := promptEvent.CreateEmbeddedResource()
+			if err != nil {
+				return mcp.NewToolResultError(fmt.Sprintf("Failed to create embedded resource: %v", err)), nil
+			}
+
+			// Return the resource as the tool result
+			return &mcp.CallToolResult{
+				Content: []mcp.Content{resource},
+			}, nil
+		}
+}
+
 func ListTriggersTool(config *config.Config, client *client.PipelineService) (tool mcp.Tool, handler server.ToolHandlerFunc) {
 	return mcp.NewTool("list_triggers",
 			mcp.WithDescription("List triggers in a Harness pipeline."),

pkg/modules/core.go

@@ -198,6 +198,7 @@ func RegisterPipelines(config *config.Config, tsg *toolsets.ToolsetGroup) error
 			toolsets.NewServerTool(tools.ListInputSetsTool(config, pipelineClient)),
 			toolsets.NewServerTool(tools.GetPipelineSummaryTool(config, pipelineClient)),
 			toolsets.NewServerTool(tools.ListTriggersTool(config, pipelineClient)),
+			toolsets.NewServerTool(tools.CreateFollowUpPromptTool(config, pipelineClient)),
 		)
 
 	// Add toolset to the group