{"record":{"id":"70bc885bf81c6744","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-70bc88","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/cloudstorage/cloudstoragegetbucketiampolicy/cloudstoragegetbucketiampolicy.go","lineNumber":68,"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\tBucket           *string                `yaml:\"bucket,omitempty\"`\n}\n\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\tif cfg.Bucket != nil && *cfg.Bucket == \"\" {\n\t\treturn nil, fmt.Errorf(\"bucket cannot be empty for tool %q\", cfg.Name)\n\t}\n\n\tallParameters := parameters.Parameters{}\n\tif cfg.Bucket == nil {\n\t\tallParameters = append(allParameters, parameters.NewStringParameter(bucketKey, \"Name of the Cloud Storage bucket whose IAM policy should be returned.\"))\n\t}\n\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: allParameters.Manifest(), AuthRequired: cfg.AuthRequired},\n\t\t\tallParameters,\n\t\t),\n\t}, nil","sourceCodeStart":50,"sourceCodeEnd":86,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/cloudstorage/cloudstoragegetbucketiampolicy/cloudstoragegetbucketiampolicy.go#L50-L86","documentation":"Configuration-time validation in Initialize: the cloudstorage-get-bucket-iam-policy tool entry in tools.yaml omits its description, which is required for the tool manifest shown to the LLM.","triggerScenarios":"tools.yaml declares a cloudstorage-get-bucket-iam-policy tool without a description or with description: \"\".","commonSituations":"Omitting description when adding IAM tools to a config; YAML nesting mistakes; programmatic config building without setting Description.","solutions":["Add a non-empty description field to the tool config","Ensure description is indented inside the tool mapping","Set Description in Go before calling Initialize"],"exampleFix":"// before\ntools:\n  get-bucket-iam-policy:\n    kind: cloudstorage-get-bucket-iam-policy\n    source: my-gcs\n// after\ntools:\n  get-bucket-iam-policy:\n    kind: cloudstorage-get-bucket-iam-policy\n    source: my-gcs\n    description: Get the IAM policy of a Cloud Storage bucket","handlingStrategy":"validation","validationCode":"if cfg.Description == \"\" {\n    return errors.New(\"get-bucket-iam-policy: description is required\")\n}","typeGuard":null,"tryCatchPattern":"if err := startToolbox(); err != nil {\n    if strings.Contains(err.Error(), \"description is required\") {\n        // add description to the tool config\n    }\n    log.Fatal(err)\n}","preventionTips":["Treat description as a required field for every tool","CI-check tools.yaml for empty required strings","Fix YAML indentation so description belongs to the tool"],"tags":["go","mcp-toolbox","configuration","validation"],"backgroundTag":"missing-required-argument","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"}