{"record":{"id":"5574155a180637dc","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-557415","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/cloudhealthcaregetfhirstoremetrics/cloudhealthcaregetfhirstoremetrics.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/cloudhealthcaregetfhirstoremetrics/cloudhealthcaregetfhirstoremetrics.go#L51-L87","documentation":"Identical guard to error 1182 but in cloudhealthcaregetfhirstoremetrics: Initialize rejects Config values with an empty Description. The metrics tool must describe to the LLM what store metrics it fetches, so a description is mandatory at init time.","triggerScenarios":"Initializing a cloudhealthcare-get-fhir-store-metrics tool whose Config.Description is empty — missing 'description' key in tools.yaml or unset field in programmatic config.","commonSituations":"Omitting description when copying another tool's config block; YAML indentation putting description outside the tool mapping; templated config generation dropping empty fields.","solutions":["Add a meaningful 'description' to the tool's config entry.","Fix YAML indentation/key spelling so Description parses.","Set Description when constructing Config in code.","Run a config validation/startup dry-run before deployment."],"exampleFix":"// before\n  get-fhir-store-metrics:\n    kind: cloudhealthcare-get-fhir-store-metrics\n    source: my-healthcare-source\n// after\n  get-fhir-store-metrics:\n    kind: cloudhealthcare-get-fhir-store-metrics\n    source: my-healthcare-source\n    description: Gets metrics for FHIR stores in a Cloud Healthcare dataset.","handlingStrategy":"validation","validationCode":"if strings.TrimSpace(cfg.Description) == \"\" {\n    return errors.New(\"tool 'cloudhealthcare-get-fhir-store-metrics' is missing a description\")\n}","typeGuard":"func descriptionPresent(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(\"add description for %q in tools.yaml\", cfg.Name)\n}","preventionTips":["Never copy a tool config block without including its description","Validate required fields in CI via YAML schema checks","Set descriptions when constructing Config programmatically","Run a startup dry-run to surface init errors early"],"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"}