{"record":{"id":"e102af9a4674a2bb","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-e102af","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/cloudhealthcaregetfhirstore/cloudhealthcaregetfhirstore.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/cloudhealthcaregetfhirstore/cloudhealthcaregetfhirstore.go#L51-L87","documentation":"Config.Initialize for cloudhealthcaregetfhirstore requires a non-empty Description; because Config embeds the shared base where name may be set independently, a tool declared without a description fails fast at initialization. This guarantees every registered tool exposes an LLM-facing description.","triggerScenarios":"Calling Initialize on a Config whose Description field is empty — typically a tools.yaml entry that omits the 'description' field, or YAML indentation that puts description under the wrong key.","commonSituations":"Hand-written tools.yaml missing description; description typo'd (e.g. 'descriptions'); programmatic Config construction leaving Description zero-valued; prebuilt-config regeneration dropping the field.","solutions":["Add a 'description' field to the tool's entry in tools.yaml.","Check YAML key spelling/indentation so the description lands in the tool's mapping.","When building Config in Go, set Description before calling Initialize.","Validate config with the toolbox CLI (config check/startup parse) before deploying."],"exampleFix":"// before (tools.yaml)\n  get-fhir-store:\n    kind: cloudhealthcare-get-fhir-store\n    source: my-healthcare-source\n// after\n  get-fhir-store:\n    kind: cloudhealthcare-get-fhir-store\n    source: my-healthcare-source\n    description: Gets a FHIR store by name from a Cloud Healthcare dataset.","handlingStrategy":"validation","validationCode":"if strings.TrimSpace(cfg.Description) == \"\" {\n    return errors.New(\"tool 'cloudhealthcare-get-fhir-store' is missing a description\")\n}","typeGuard":"func hasDescription(cfg Config) bool { return cfg.Description != \"\" }","tryCatchPattern":"tool, err := cfg.Initialize(ctx)\nif err != nil && strings.Contains(err.Error(), \"description is required\") {\n    return nil, fmt.Errorf(\"tools.yaml: add a description for tool %q\", cfg.Name)\n}","preventionTips":["Always include a description line for every tool in tools.yaml","Lint YAML configs for required tool fields in CI","Watch for near-miss key names like 'descriptions' or wrong indentation","Use schema validation on tools.yaml before deploy"],"tags":["configuration","validation","yaml","cloud-healthcare"],"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"}