fix: openapi revamp: tell the LLM the names of the tools it should use

Signed-off-by: Grant Linville <grant@acorn.io>

Author: g-linville

pkg/engine/openapi.go

@@ -43,7 +43,7 @@ func (e *Engine) runOpenAPIRevamp(tool types.Tool, input string) (*Return, error
 			return nil, fmt.Errorf("failed to load OpenAPI file %s: %w", source, err)
 		}
 
-		opList, err := openapi.List(t, filter)
+		opList, err := openapi.List(t, filter, "getSchema"+strings.TrimPrefix(tool.Name, "listOperations"))
 		if err != nil {
 			return nil, fmt.Errorf("failed to list operations: %w", err)
 		}
@@ -66,7 +66,7 @@ func (e *Engine) runOpenAPIRevamp(tool types.Tool, input string) (*Return, error
 			} else if !match {
 				// Report to the LLM that the operation was not found
 				return &Return{
-					Result: ptr(fmt.Sprintf("operation %s not found", operation)),
+					Result: ptr(fmt.Sprintf("ERROR: operation %s not found", operation)),
 				}, nil
 			}
 		}
@@ -85,14 +85,14 @@ func (e *Engine) runOpenAPIRevamp(tool types.Tool, input string) (*Return, error
 			defaultHost = u.Scheme + "://" + u.Hostname()
 		}
 
-		schema, _, found, err := openapi.GetSchema(operation, defaultHost, t)
+		schema, _, found, err := openapi.GetSchema(operation, defaultHost, "runOperation"+strings.TrimPrefix(tool.Name, "getSchema"), t)
 		if err != nil {
 			return nil, fmt.Errorf("failed to get schema: %w", err)
 		}
 		if !found {
 			// Report to the LLM that the operation was not found
 			return &Return{
-				Result: ptr(fmt.Sprintf("operation %s not found", operation)),
+				Result: ptr(fmt.Sprintf("ERROR: operation %s not found", operation)),
 			}, nil
 		}
 
@@ -115,7 +115,7 @@ func (e *Engine) runOpenAPIRevamp(tool types.Tool, input string) (*Return, error
 			} else if !match {
 				// Report to the LLM that the operation was not found
 				return &Return{
-					Result: ptr(fmt.Sprintf("operation %s not found", operation)),
+					Result: ptr(fmt.Sprintf("ERROR: operation %s not found", operation)),
 				}, nil
 			}
 		}
@@ -134,13 +134,13 @@ func (e *Engine) runOpenAPIRevamp(tool types.Tool, input string) (*Return, error
 			defaultHost = u.Scheme + "://" + u.Hostname()
 		}
 
-		result, found, err := openapi.Run(operation, defaultHost, args, t, e.Env)
+		result, found, err := openapi.Run(operation, defaultHost, args, tool.Name, t, e.Env)
 		if err != nil {
 			return nil, fmt.Errorf("failed to run operation %s: %w", operation, err)
 		} else if !found {
 			// Report to the LLM that the operation was not found
 			return &Return{
-				Result: ptr(fmt.Sprintf("operation %s not found", operation)),
+				Result: ptr(fmt.Sprintf("ERROR: operation %s not found", operation)),
 			}, nil
 		}
 

pkg/openapi/getschema.go

@@ -42,9 +42,14 @@ func GetSupportedSecurityTypes() []string {
 	return supportedSecurityTypes
 }
 
+type argsWithMessage struct {
+	Arguments *openapi3.Schema
+	Message   string `json:"message"`
+}
+
 // GetSchema returns the JSONSchema and OperationInfo for a particular OpenAPI operation.
 // Return values in order: JSONSchema (string), OperationInfo, found (bool), error.
-func GetSchema(operationID, defaultHost string, t *openapi3.T) (string, OperationInfo, bool, error) {
+func GetSchema(operationID, defaultHost, runToolName string, t *openapi3.T) (string, OperationInfo, bool, error) {
 	arguments := &openapi3.Schema{
 		Type:       &openapi3.Types{"object"},
 		Properties: openapi3.Schemas{},
@@ -227,7 +232,12 @@ func GetSchema(operationID, defaultHost string, t *openapi3.T) (string, Operatio
 					}
 				}
 
-				argumentsJSON, err := json.MarshalIndent(arguments, "", "    ")
+				withMessage := argsWithMessage{
+					Arguments: arguments,
+					Message:   fmt.Sprintf("You can use the %s tool to run this operation.", runToolName),
+				}
+
+				argumentsJSON, err := json.MarshalIndent(withMessage, "", "    ")
 				if err != nil {
 					return "", OperationInfo{}, false, err
 				}

pkg/openapi/list.go

@@ -1,13 +1,15 @@
 package openapi
 
 import (
+	"fmt"
 	"path/filepath"
 	"strings"
 
 	"github.com/getkin/kin-openapi/openapi3"
 )
 
 type OperationList struct {
+	Message    string               `json:"message"`
 	Operations map[string]Operation `json:"operations"`
 }
 
@@ -21,7 +23,7 @@ const (
 	NoFilter = "<none>"
 )
 
-func List(t *openapi3.T, filter string) (OperationList, error) {
+func List(t *openapi3.T, filter, getSchemaToolName string) (OperationList, error) {
 	operations := make(map[string]Operation)
 	for _, pathItem := range t.Paths.Map() {
 		for _, operation := range pathItem.Operations() {
@@ -51,7 +53,10 @@ func List(t *openapi3.T, filter string) (OperationList, error) {
 		}
 	}
 
-	return OperationList{Operations: operations}, nil
+	return OperationList{
+		Message:    fmt.Sprintf("You can get the schema for these operations using the %s tool.", getSchemaToolName),
+		Operations: operations,
+	}, nil
 }
 
 func MatchFilters(filters []string, operationID string) (bool, error) {

pkg/openapi/run.go

@@ -20,7 +20,7 @@ import (
 
 const RunTool = "run"
 
-func Run(operationID, defaultHost, args string, t *openapi3.T, envs []string) (string, bool, error) {
+func Run(operationID, defaultHost, args, runToolName string, t *openapi3.T, envs []string) (string, bool, error) {
 	envMap := make(map[string]string, len(envs))
 	for _, e := range envs {
 		k, v, _ := strings.Cut(e, "=")
@@ -30,7 +30,7 @@ func Run(operationID, defaultHost, args string, t *openapi3.T, envs []string) (s
 	if args == "" {
 		args = "{}"
 	}
-	schemaJSON, opInfo, found, err := GetSchema(operationID, defaultHost, t)
+	schemaJSON, opInfo, found, err := GetSchema(operationID, defaultHost, runToolName, t)
 	if err != nil || !found {
 		return "", false, err
 	}