{"record":{"id":"5d031f347987aefc","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-5d031f","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/firestorequerycollection/firestorequerycollection.go","lineNumber":116,"sourceCode":"type 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\n// ToolConfigType returns the type of tool configuration\nfunc (cfg Config) ToolConfigType() string {\n\treturn resourceType\n}\n\n// Initialize creates a new Tool instance from the configuration\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// Create parameters\n\tparams := createParameters()\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\nfunc (t Tool) GetSourceName() string {\n\treturn t.Cfg.Source\n}","sourceCodeStart":98,"sourceCodeEnd":134,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/firestore/firestorequerycollection/firestorequerycollection.go#L98-L134","documentation":"Config.Initialize for firestore-querycollection requires a non-empty description, rejecting the config at load time when cfg.Description is empty. Descriptions are part of the tool's MCP manifest exposed to clients.","triggerScenarios":"A firestore-querycollection tool config missing its `description:` field or defining it as an empty string.","commonSituations":"Omitting the field in hand-written YAML; templated configs with unfilled description placeholders.","solutions":["Add a non-empty `description:` field to the firestore-querycollection tool config.","Verify env-var/templated description values are populated at render time."],"exampleFix":"// before\n  query_collection:\n    kind: firestore-querycollection\n    source: my-fs\n// after\n  query_collection:\n    kind: firestore-querycollection\n    source: my-fs\n    description: Query documents from a Firestore collection","handlingStrategy":"validation","validationCode":"if strings.TrimSpace(cfg.Description) == \"\" {\n\treturn errors.New(\"firestore-querycollection tool requires a non-empty description\")\n}","typeGuard":null,"tryCatchPattern":"tool, err := cfg.Initialize(ctx)\nif err != nil {\n\treturn fmt.Errorf(\"tool init failed: %w\", err)\n}","preventionTips":["Include `description` in every firestore-querycollection entry.","Add automated YAML validation in CI catching empty required strings.","When templating configs, assert interpolated fields are non-empty."],"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"}