{"record":{"id":"087aa350370798cb","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-087aa3","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/firestore/firestoregetrules/firestoregetrules.go","lineNumber":67,"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\t// No parameters needed for this tool\n\tparams := parameters.Parameters{}\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: 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":49,"sourceCodeEnd":85,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/firestore/firestoregetrules/firestoregetrules.go#L49-L85","documentation":"Config.Initialize for firestore-get-rules rejects configs with an empty description. The description is required metadata for the tool's MCP manifest, so Initialize fails immediately when cfg.Description is \"\".","triggerScenarios":"A tool config of kind firestore-get-rules without a `description:` field or with an empty one.","commonSituations":"Omitting description because the tool takes no parameters and was assumed metadata-free; YAML templating that left the field blank.","solutions":["Add a non-empty `description:` to the firestore-get-rules tool config.","Check env-var/templated values feeding the description resolve to a non-empty string."],"exampleFix":"// before\n  get_rules:\n    kind: firestore-get-rules\n    source: my-fs\n// after\n  get_rules:\n    kind: firestore-get-rules\n    source: my-fs\n    description: Fetch the current Firestore security rules","handlingStrategy":"validation","validationCode":"if strings.TrimSpace(cfg.Description) == \"\" {\n\treturn errors.New(\"firestore-get-rules tool requires a non-empty description\")\n}","typeGuard":null,"tryCatchPattern":"tool, err := cfg.Initialize(ctx)\nif err != nil {\n\tlog.Printf(\"invalid tool config: %v\", err)\n\treturn err\n}","preventionTips":["Include a description even for zero-parameter tools.","Add a config linter asserting all tool entries have non-empty descriptions.","Code-review new tool YAML entries against a required-fields checklist."],"tags":["firestore","config","missing-field"],"backgroundTag":"missing-description-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"}