{"record":{"id":"23b31ac514e42d87","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-23b31a","errorCode":null,"errorMessage":"description is required for tool %q","messagePattern":"description is required for tool %q","errorType":"validation","errorClass":null,"httpStatus":null,"severity":"error","filePath":"internal/tools/trino/trinoexecutesql/trinoexecutesql.go","lineNumber":67,"sourceCode":"}\n\ntype Config struct {\n\ttools.ConfigBase `yaml:\",inline\"`\n\tType             string                 `yaml:\"type\" validate:\"required\"`\n\tSource           string                 `yaml:\"source\" validate:\"required\"`\n\tAnnotations      *tools.ToolAnnotations `yaml:\"annotations,omitempty\"`\n}\n\n// validate interface\nvar _ tools.ToolConfig = Config{}\n\nfunc (cfg Config) ToolConfigType() string {\n\treturn resourceType\n}\n\nfunc (cfg Config) Initialize(context.Context) (tools.Tool, error) {\n\tif cfg.Description == \"\" {\n\t\treturn nil, fmt.Errorf(\"description is required for tool %q\", cfg.Name)\n\t}\n\n\tsqlParameter := parameters.NewStringParameter(\"sql\", \"The SQL query to execute against the Trino database.\")\n\tparams := parameters.Parameters{sqlParameter}\n\n\treturn Tool{\n\t\tBaseTool: tools.NewBaseTool(\n\t\t\tcfg,\n\t\t\ttools.GetAnnotationsOrDefault(cfg.Annotations, tools.NewDestructiveAnnotations),\n\t\t\ttools.Manifest{Description: cfg.Description, Parameters: params.Manifest(), AuthRequired: cfg.AuthRequired},\n\t\t\tparams,\n\t\t),\n\t}, nil\n}\n\n// validate interface\nvar _ tools.Tool = Tool{}\n","sourceCodeStart":49,"sourceCodeEnd":85,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/trino/trinoexecutesql/trinoexecutesql.go#L49-L85","documentation":"The trino-execute-sql tool requires a non-empty `description` in its config; Config.Initialize returns this error when cfg.Description is empty. The description is exposed in the tool manifest so LLM clients know what the tool does.","triggerScenarios":"Defining a trino-execute-sql tool in the YAML (or constructing its Config programmatically) without a `description` field, or with an empty string, then decoding/initializing it.","commonSituations":"Omitting the description in tools.yaml; leaving it blank (`description: \"\"`); YAML indentation putting description under the wrong key; generating configs from templates that skip optional-looking fields.","solutions":["Add a `description` field to the trino-execute-sql tool config with a non-empty string describing what the tool does","Check YAML indentation so `description` is a direct child of the tool entry","Ensure the value is not an empty string"],"exampleFix":"// before (tools.yaml)\nexecute_sql:\n  kind: trino-execute-sql\n  source: my-trino\n// after\nexecute_sql:\n  kind: trino-execute-sql\n  source: my-trino\n  description: Executes a SQL query against the Trino database and returns results.","handlingStrategy":"validation","validationCode":"if cfg[\"description\"] == \"\" || cfg[\"description\"] == nil {\n    return errors.New(\"trino-execute-sql tool: description is required\")\n}","typeGuard":null,"tryCatchPattern":"tool, err := cfg.Initialize(ctx)\nif err != nil {\n    if strings.Contains(err.Error(), \"description is required\") {\n        return fmt.Errorf(\"add description for tool %q\", cfg.Name)\n    }\n    return err\n}","preventionTips":["Treat description as mandatory for every tool block","Write a one-line description when first adding a tool","Lint the config for empty required string fields"],"tags":["go","validation","trino","config"],"backgroundTag":"missing-required-argument","analyzedSha":"8cc6e09de2ad7b8bffc77751799585a1401a48eb","analyzedAt":"2026-09-05T01:10:36.887Z","contentChangedAt":"2026-09-05T01:10:36.887Z","schemaVersion":2},"datasetVersion":"2026-09-08T10:18:20.063Z"}