{"record":{"id":"885262f7fc66151a","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-885262","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/looker/lookergetconnectiontablecolumns/lookergetconnectiontablecolumns.go","lineNumber":71,"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\tconnParameter := parameters.NewStringParameter(\"conn\", \"The connection containing the tables.\")\n\tdbParameter := parameters.NewStringParameter(\"db\", \"The optional database to search\", parameters.WithStringRequired(false))\n\tschemaParameter := parameters.NewStringParameter(\"schema\", \"The schema containing the tables.\")\n\ttablesParameter := parameters.NewStringParameter(\"tables\", \"A comma separated list of tables containing the columns.\")\n\tparams := parameters.Parameters{connParameter, dbParameter, schemaParameter, tablesParameter}\n\n\t// finish tool setup\n\treturn Tool{\n\t\tBaseTool: tools.NewBaseTool(\n\t\t\tcfg,\n\t\t\ttools.GetAnnotationsOrDefault(cfg.Annotations, tools.NewReadOnlyAnnotations),\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}","sourceCodeStart":53,"sourceCodeEnd":89,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/looker/lookergetconnectiontablecolumns/lookergetconnectiontablecolumns.go#L53-L89","documentation":"Tool registration requires a non-empty `description`, which the toolbox surfaces to LLM clients. `Initialize` for looker-get-connection-table-columns validates the description and fails tool creation when it is empty.","triggerScenarios":"Config.Initialize is called for a looker-get-connection-table-columns tool whose `description` field is missing or \"\".","commonSituations":"Hand-written tools.yaml missing the description key; programmatic Config with zero-valued Description; config templates that drop optional-looking fields.","solutions":["Add a non-empty `description:` to the tool entry in tools.yaml","Set cfg.Description before calling Initialize in Go code","Validate the config file at CI time to catch missing required fields early"],"exampleFix":"// before\ntools:\n  cols:\n    kind: looker-get-connection-table-columns\n    source: my-looker\n// after\ntools:\n  cols:\n    kind: looker-get-connection-table-columns\n    source: my-looker\n    description: Lists columns of tables in a Looker connection.","handlingStrategy":"validation","validationCode":"if cfg.Description == \"\" {\n    return fmt.Errorf(\"tool %q: description is mandatory\", cfg.Name)\n}","typeGuard":null,"tryCatchPattern":"tool, err := cfg.Initialize(ctx)\nif err != nil && strings.Contains(err.Error(), \"description is required\") {\n    return fmt.Errorf(\"fix tools.yaml: %w\", err)\n}","preventionTips":["Never omit `description:` in tool entries","Enforce config validation in CI","Document required fields for custom tool configs"],"tags":["go","looker","config-validation","missing-field"],"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"}