Add schema description, enum values to tool description (#51)

* Add schema description, enum values to tool description

* don't add schema description when it is same as parameter description.

Author: logan-querypie

main_test.go

@@ -114,4 +114,46 @@ func TestIntegration(t *testing.T) {
 	assert.Equal(t, "string", pointParam["type"])
 	assert.Contains(t, pointParam["description"].(string), "Point (latitude, longitude)")
 	assert.Contains(t, pointTool.InputSchema.Required, "point", "Point parameter should be required")
+
+	var zoneTool struct {
+		Name        string
+		Description string
+		InputSchema struct {
+			Type       string                 `json:"type"`
+			Properties map[string]interface{} `json:"properties"`
+			Required   []string               `json:"required"`
+		}
+	}
+
+	foundZoneTool := false
+	for _, tool := range response.Result.Tools {
+		if tool.Name == "zone" {
+			foundZoneTool = true
+			err := json.Unmarshal(tool.InputSchema, &zoneTool.InputSchema)
+			require.NoError(t, err)
+			zoneTool.Name = tool.Name
+			zoneTool.Description = tool.Description
+			break
+		}
+	}
+
+	require.True(t, foundZoneTool, "Expected to find zone tool")
+	assert.Equal(t, "zone", zoneTool.Name)
+	assert.Contains(t, zoneTool.Description, "Returns metadata about a given zone")
+
+	// Verify zone tool has proper parameter schema
+	assert.Equal(t, "object", zoneTool.InputSchema.Type)
+	assert.Contains(t, zoneTool.InputSchema.Properties, "zoneId", "Zone tool should have 'zoneId' parameter")
+
+	typeParam := zoneTool.InputSchema.Properties["type"].(map[string]interface{})
+	assert.Equal(t, "string", typeParam["type"])
+	assert.Contains(t, typeParam["description"].(string), "Zone type")
+	assert.Contains(t, typeParam["description"].(string), "Allowed values: land, marine, ")
+	assert.Contains(t, zoneTool.InputSchema.Required, "type", "type parameter should be required")
+
+	zoneIdParam := zoneTool.InputSchema.Properties["zoneId"].(map[string]interface{})
+	assert.Equal(t, "string", zoneIdParam["type"])
+	assert.Contains(t, zoneIdParam["description"].(string), "NWS public zone/county identifier")
+	assert.Contains(t, zoneIdParam["description"].(string), "UGC identifier for a NWS")
+	assert.Contains(t, zoneTool.InputSchema.Required, "zoneId", "zoneId parameter should be required")
 }

mcp/server.go

@@ -15,7 +15,9 @@ import (
 	"strings"
 
 	"github.com/pb33f/libopenapi"
+	"github.com/pb33f/libopenapi/datamodel/high/base"
 	v3 "github.com/pb33f/libopenapi/datamodel/high/v3"
+	"gopkg.in/yaml.v3"
 
 	"github.com/loopwork-ai/emcee/internal"
 	"github.com/loopwork-ai/emcee/jsonrpc"
@@ -293,8 +295,11 @@ func (s *Server) handleToolsList(request *ToolsListRequest) (*ToolsListResponse,
 							if paramSchema.Pattern != "" {
 								schema["pattern"] = paramSchema.Pattern
 							}
+							// Add enum values to description if they exist
+							schema["description"] = buildSchemaDescription(param.Description, paramSchema)
+						} else {
+							schema["description"] = param.Description
 						}
-						schema["description"] = param.Description
 						inputSchema.Properties[param.Name] = schema
 						if param.Required != nil && *param.Required {
 							inputSchema.Required = append(inputSchema.Required, param.Name)
@@ -317,8 +322,11 @@ func (s *Server) handleToolsList(request *ToolsListRequest) (*ToolsListResponse,
 							if paramSchema.Pattern != "" {
 								schema["pattern"] = paramSchema.Pattern
 							}
+							// Add enum values to description if they exist
+							schema["description"] = buildSchemaDescription(param.Description, paramSchema)
+						} else {
+							schema["description"] = param.Description
 						}
-						schema["description"] = param.Description
 						inputSchema.Properties[param.Name] = schema
 						if param.Required != nil && *param.Required {
 							inputSchema.Required = append(inputSchema.Required, param.Name)
@@ -341,9 +349,11 @@ func (s *Server) handleToolsList(request *ToolsListRequest) (*ToolsListResponse,
 									if len(propSchema.Type) > 0 {
 										schemaType = propSchema.Type[0]
 									}
+									// Add enum values to description if they exist
+									description := buildSchemaDescription("", propSchema)
 									inputSchema.Properties[propName] = map[string]interface{}{
 										"type":        schemaType,
-										"description": propSchema.Description,
+										"description": description,
 									}
 								}
 							}
@@ -672,3 +682,43 @@ func (s *Server) findOperationByToolName(toolName string) (method, path string,
 	}
 	return "", "", nil, nil, false
 }
+
+// buildSchemaDescription builds a description string from parameter and schema descriptions, and enum values
+func buildSchemaDescription(paramDesc string, paramSchema *base.Schema) string {
+	description := paramDesc
+
+	if paramSchema.Description != "" {
+		if description != "" && description != paramSchema.Description {
+			description = fmt.Sprintf("%s. %s", description, paramSchema.Description)
+		} else {
+			description = paramSchema.Description
+		}
+	}
+
+	var enumValues []string
+	if len(paramSchema.Enum) > 0 {
+		enumValues = getEnumValues(paramSchema.Enum)
+	}
+
+	if len(enumValues) > 0 {
+		if description != "" {
+			description = fmt.Sprintf("%s (Allowed values: %s)", description, strings.Join(enumValues, ", "))
+		} else {
+			description = fmt.Sprintf("Allowed values: %s", strings.Join(enumValues, ", "))
+		}
+	}
+
+	return description
+}
+
+// getEnumValues extracts enum values from a schema's enum field
+func getEnumValues(enum []*yaml.Node) []string {
+	if len(enum) == 0 {
+		return nil
+	}
+	values := make([]string, len(enum))
+	for i, v := range enum {
+		values[i] = v.Value
+	}
+	return values
+}