{"record":{"id":"f00bb00d81cf38c5","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-f00bb0","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/firestorequery/firestorequery.go","lineNumber":91,"sourceCode":"\tAnalyzeQuery   bool           `yaml:\"analyzeQuery\"` // Analyze query (boolean, not parameterizable)\n\n\t// Parameters for template substitution\n\tParameters  parameters.Parameters  `yaml:\"parameters\"`\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// Set default limit if not specified\n\tif cfg.Limit == \"\" {\n\t\tcfg.Limit = fmt.Sprintf(\"%d\", defaultLimit)\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: cfg.Parameters.Manifest(), AuthRequired: cfg.AuthRequired},\n\t\t\tcfg.Parameters,\n\t\t),\n\t}, nil\n}\n\n// validate interface","sourceCodeStart":73,"sourceCodeEnd":109,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/firestore/firestorequery/firestorequery.go#L73-L109","documentation":"Config.Initialize for firestore-query rejects configs lacking a description. The description is mandatory MCP metadata; Initialize returns this error before parameter setup (including the default limit) when cfg.Description is empty.","triggerScenarios":"A firestore-query tool config with no `description:` field or an empty string value.","commonSituations":"Configs generated from templates where description was left blank; users assuming optional fields are all optional.","solutions":["Add a non-empty `description:` to the firestore-query tool config.","Ensure any env-var interpolation for description yields a non-empty value."],"exampleFix":"// before\n  query:\n    kind: firestore-query\n    source: my-fs\n// after\n  query:\n    kind: firestore-query\n    source: my-fs\n    description: Run a query against a Firestore collection with filters and ordering","handlingStrategy":"validation","validationCode":"if strings.TrimSpace(cfg.Description) == \"\" {\n\treturn errors.New(\"firestore-query tool requires a non-empty description\")\n}","typeGuard":null,"tryCatchPattern":"tool, err := cfg.Initialize(ctx)\nif err != nil {\n\treturn fmt.Errorf(\"invalid firestore-query config: %w\", err)\n}","preventionTips":["Always author a meaningful description alongside filters/limit config.","Automate a schema check on tool YAML requiring `description`.","Treat tool init errors as config errors, not runtime errors, in alerting."],"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"}