Improve the schema

Signed-off-by: David Gageot <david.gageot@docker.com>

Author: dgageot

examples/script_shell.yaml

@@ -15,20 +15,20 @@ agents:
 
           docker_images:
             cmd: "docker images $img"
-            description: "List running Docker containers"
-            required: []
+            description: List running Docker containers
             args:
               img:
-                description: "Docker image to list"
-                type: "string"
+                description: Docker image to list
+                type: string
 
           github_user_repos:
             cmd: "curl -s https://api.github.com/users/$username/repos | jq '.[].name'"
-            description: "List GitHub repositories of the provided user"
+            description: List GitHub repositories of the provided user
+            required: ["username"]
             args:
               username:
-                description: "GitHub username to get the repository list for"
-                type: "string"
+                description: GitHub username to get the repository list for
+                type: string
 
 models:
   openai:

pkg/tools/builtin/script_shell.go

@@ -79,10 +79,13 @@ func (t *ScriptShellTool) Tools(context.Context) ([]tools.Tool, error) {
 			description = fmt.Sprintf("Execute shell command: %s", cfg.Cmd)
 		}
 
-		inputSchema := map[string]any{
+		inputSchema, err := tools.SchemaToMap(map[string]any{
 			"type":       "object",
 			"properties": cfg.Args,
 			"required":   cfg.Required,
+		})
+		if err != nil {
+			return nil, fmt.Errorf("invalid schema for tool %s: %w", toolName, err)
 		}
 
 		toolsList = append(toolsList, tools.Tool{

pkg/tools/builtin/script_shell_test.go

@@ -2,6 +2,7 @@ package builtin
 
 import (
 	"encoding/json"
+	"fmt"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -32,11 +33,11 @@ func TestNewScriptShellTool_ToolNoArg(t *testing.T) {
 	assert.Len(t, allTools, 1)
 
 	schema, err := json.Marshal(allTools[0].Parameters)
+	fmt.Println(string(schema))
 	require.NoError(t, err)
 	assert.JSONEq(t, `{
-	"properties": null,
-	"required": null,
-	"type": "object"
+	"type": "object",
+	"properties": {}
 }`, string(schema))
 }
 
@@ -50,6 +51,7 @@ func TestNewScriptShellTool_Tool(t *testing.T) {
 					"type":        "string",
 				},
 			},
+			Required: []string{"username"},
 		},
 	}
 
@@ -62,13 +64,13 @@ func TestNewScriptShellTool_Tool(t *testing.T) {
 	schema, err := json.Marshal(allTools[0].Parameters)
 	require.NoError(t, err)
 	assert.JSONEq(t, `{
+	"type": "object",
 	"properties": {
 		"username": {
 			"description": "GitHub username to get the repository list for",
 			"type": "string"
 		}
 	},
-	"required": null,
-	"type": "object"
+	"required": ["username"]
 }`, string(schema))
 }

pkg/tools/schema.go

@@ -43,6 +43,9 @@ func SchemaToMap(params any) (map[string]any, error) {
 	if m["properties"] == nil {
 		m["properties"] = map[string]any{}
 	}
+	if m["required"] == nil {
+		delete(m, "required")
+	}
 
 	return m, nil
 }