{"record":{"id":"3faecdb9437f18cc","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-3faecd","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/sqlite/sqlitesql/sqlitesql.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/sqlite/sqlitesql/sqlitesql.go#L52-L88","documentation":"The sqlite-sql tool (parameterized SQL) requires a non-empty `description` in its config; Config.Initialize returns this error when cfg.Description is empty. The description is what the LLM sees in the tool manifest, so it cannot be blank.","triggerScenarios":"A `sqlite-sql` tool in tools.yaml lacking a `description:` key or having it set to \"\"; template substitution producing an empty description.","commonSituations":"Omitting description when scaffolding many similar tools; misindented YAML key; migration of configs from a version/variant where description was optional.","solutions":["Add a descriptive, non-empty `description:` to the sqlite-sql tool config.","Verify YAML structure so description lands in the tool's Config struct.","Check templated values render non-empty."],"exampleFix":"# before\nkind: sqlite-sql\nsource: my-sqlite\nstatement: SELECT * FROM users WHERE id = ?\n# after\nkind: sqlite-sql\nsource: my-sqlite\ndescription: \"Fetch a user by id.\"\nstatement: SELECT * FROM users WHERE id = ?","handlingStrategy":"validation","validationCode":"yq '.tools[] | select(.kind == \"sqlite-sql\") | select(.description == null or .description == \"\")' tools.yaml","typeGuard":"func validToolConfig(c sqlite.Config) error {\n    if c.Description == \"\" { return errors.New(\"description is required\") }\n    return nil\n}","tryCatchPattern":"tool, err := cfg.Initialize(ctx)\nif err != nil {\n    return fmt.Errorf(\"invalid sqlite-sql tool %q: %w\", cfg.Name, err)\n}","preventionTips":["Treat description as required in your config templates.","Lint tools.yaml in CI for required fields.","Verify templated/anchored YAML fields resolve to non-empty values."],"tags":["go","config","validation","sqlite"],"backgroundTag":"missing-required-config-field","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"}