{"record":{"id":"00a932b28c5f8222","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-00a932","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/cloudhealthcare/cloudhealthcaregetdicomstoremetrics/cloudhealthcaregetdicomstoremetrics.go","lineNumber":69,"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 := buildParams(false)\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\ntype Tool struct {\n\ttools.BaseTool[Config]","sourceCodeStart":51,"sourceCodeEnd":87,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/cloudhealthcare/cloudhealthcaregetdicomstoremetrics/cloudhealthcaregetdicomstoremetrics.go#L51-L87","documentation":"Thrown by Config.Initialize when the cloudhealthcare-get-dicom-store-metrics tool is defined with an empty Description. A description is mandatory so MCP clients can display the tool's purpose. Initialization aborts before the tool is registered.","triggerScenarios":"Calling Initialize on a Config with Description == \"\" (field omitted in YAML or left unset in code).","commonSituations":"Missing description key in the tool YAML; generating configs from templates that skip optional-looking fields; empty-string description from automation.","solutions":["Add a non-empty description to the tool's YAML config","Set cfg.Description before Initialize","Add startup validation to surface missing descriptions early"],"exampleFix":"# before\nkind: cloud-healthcare-get-dicom-store-metrics\n# after\nkind: cloud-healthcare-get-dicom-store-metrics\ndescription: Fetches metrics for a DICOM store in Cloud Healthcare","handlingStrategy":"validation","validationCode":"if cfg.Description == \"\" {\n    return fmt.Errorf(\"tool %q requires a description\", cfg.Name)\n}","typeGuard":null,"tryCatchPattern":null,"preventionTips":["Document the description field as mandatory in tool templates","Add a config linter for empty description strings","Review YAML diffs for dropped fields"],"tags":["go","config","validation","mcp-toolbox"],"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"}