{"record":{"id":"54c886b94d3be576","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-54c886","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/lookergetdimensions/lookergetdimensions.go","lineNumber":73,"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\tparams := lookercommon.GetFieldParameters()\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}\n\n// validate interface\nvar _ tools.Tool = Tool{}\n","sourceCodeStart":55,"sourceCodeEnd":91,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/looker/lookergetdimensions/lookergetdimensions.go#L55-L91","documentation":"looker-get-dimensions Config.Initialize rejects configurations missing a description. The description is published in the MCP tool manifest so clients know what the tool does; an empty description makes initialization fail with this error.","triggerScenarios":"Declaring a looker-get-dimensions tool in tools.yaml without `description`, or building the Config in Go with an empty Description and calling Initialize.","commonSituations":"Omitted YAML field; description nested at the wrong indentation; automated config generators producing empty strings.","solutions":["Add a `description` line to the looker-get-dimensions tool entry.","Verify YAML indentation so the field belongs to the tool block.","Set Description before Initialize when constructing configs in code.","Run `toolbox validate` before deployment."],"exampleFix":"// before\n  get-dimensions:\n    kind: looker-get-dimensions\n    source: my-looker\n// after\n  get-dimensions:\n    kind: looker-get-dimensions\n    source: my-looker\n    description: Retrieves LookML dimension fields for a Looker Explore.","handlingStrategy":"validation","validationCode":"if strings.TrimSpace(cfg.Description) == \"\" {\n    return errors.New(\"tool 'get-dimensions': description is required\")\n}","typeGuard":null,"tryCatchPattern":"tool, err := cfg.Initialize(ctx)\nif err != nil {\n    log.Fatalf(\"invalid looker-get-dimensions config: %v\", err)\n}","preventionTips":["Include a description for every looker-get-dimensions entry.","Add `toolbox validate` to CI pipelines.","Check YAML indentation when editing nested tool blocks.","Set Description explicitly when building Config structs in code."],"tags":["go","looker","mcp-toolbox","config-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"}