{"record":{"id":"f51bfcde3b3fb4f9","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-f51bfc","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/yugabytedbsql/yugabytedbsql.go","lineNumber":70,"sourceCode":"\ttools.ConfigBase   `yaml:\",inline\"`\n\tType               string                 `yaml:\"type\" validate:\"required\"`\n\tSource             string                 `yaml:\"source\" validate:\"required\"`\n\tStatement          string                 `yaml:\"statement\" validate:\"required\"`\n\tParameters         parameters.Parameters  `yaml:\"parameters\"`\n\tTemplateParameters parameters.Parameters  `yaml:\"templateParameters\"`\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\tallParameters, paramManifest, err := parameters.ProcessParameters(cfg.TemplateParameters, cfg.Parameters)\n\tif err != nil {\n\t\treturn nil, err\n\t}\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: paramManifest, AuthRequired: cfg.AuthRequired},\n\t\t\tallParameters,\n\t\t),\n\t}, nil\n}\n\n// validate interface","sourceCodeStart":52,"sourceCodeEnd":88,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/yugabytedbsql/yugabytedbsql.go#L52-L88","documentation":"YugabyteDB SQL tool configs require a non-empty Description; Config.Initialize fails with this error when it is empty. The description is required because it becomes part of the tool manifest consumed by LLM clients.","triggerScenarios":"Declaring a yugabytedbsql tool (e.g. yugabytedb-execute-sql) in tools.yaml without a 'description', or calling Config.Initialize on a Config whose Description is \"\".","commonSituations":"Minimal configs omitting description; programmatic config builders with empty description variables; migrating Postgres tool configs to YugabyteDB and dropping fields.","solutions":["Add a non-empty 'description' field to the tool entry in tools.yaml","Check for YAML typos/indentation that would leave Description unset","When constructing Config in Go, populate Description before Initialize"],"exampleFix":"# before\ntools:\n  yb-sql:\n    kind: yugabytedb-execute-sql\n    source: my-yb\n# after\ntools:\n  yb-sql:\n    kind: yugabytedb-execute-sql\n    source: my-yb\n    description: Executes SQL statements against YugabyteDB","handlingStrategy":"validation","validationCode":"if cfg.Description == \"\" {\n    return fmt.Errorf(\"yugabytedb tool %q requires a description\", cfg.Name)\n}","typeGuard":null,"tryCatchPattern":"tool, err := cfg.Initialize(ctx)\nif err != nil && strings.Contains(err.Error(), \"description is required\") {\n    // add a non-empty 'description' to the yugabytedb tool entry\n}","preventionTips":["Add descriptions to all tool entries, including migrated ones","Schema-validate tools.yaml before deploy","Use config templates with required fields, not optional ones"],"tags":["go","tool-configuration","yugabytedb","validation"],"backgroundTag":"missing-tool-description","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"}