{"record":{"id":"688c8966277ffec0","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-688c89","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/cloudmonitoring/cloudmonitoring.go","lineNumber":66,"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// Define the parameters internally instead of from the config file.\n\tallParameters := parameters.Parameters{\n\t\tparameters.NewStringParameter(\"projectId\", \"The Id of the Google Cloud project.\", parameters.WithStringRequired(true)),\n\t\tparameters.NewStringParameter(\"query\", \"The promql query to execute.\", parameters.WithStringRequired(true)),\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\n}\n","sourceCodeStart":48,"sourceCodeEnd":84,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/cloudmonitoring/cloudmonitoring.go#L48-L84","documentation":"Config.Initialize for the cloudmonitoring (promql query) tool requires cfg.Description to be non-empty because it populates the MCP tool manifest. An empty description fails initialization immediately with this error.","triggerScenarios":"A tools.yaml entry of kind cloud--monitoring (execute-promql) missing the `description` field or with an empty value.","commonSituations":"Hand-written minimal configs; template generators emitting blank descriptions; YAML indentation placing description outside the tool mapping so it unmarshals empty.","solutions":["Add a non-empty `description:` to the cloud monitoring tool entry.","Confirm the description key is nested under the correct tool.","Re-initialize; the error's %q names the exact tool to fix."],"exampleFix":"// before\n  execute-promql:\n    kind: cloud-monitoring-execute-promql\n    source: my-monitoring-source\n// after\n  execute-promql:\n    kind: cloud-monitoring-execute-promql\n    source: my-monitoring-source\n    description: Executes a PromQL query against Google Cloud Monitoring.","handlingStrategy":"validation","validationCode":"// Go: guard required fields before Initialize\nif strings.TrimSpace(cfg.Description) == \"\" {\n    return nil, fmt.Errorf(\"cloud monitoring tool %q needs a description\", cfg.Name)\n}","typeGuard":null,"tryCatchPattern":"tool, err := cfg.Initialize(ctx)\nif err != nil {\n    log.Fatalf(\"tool init failed (check tools.yaml description field): %v\", err)\n}","preventionTips":["Include description in every cloud-monitoring tool entry.","Validate tools.yaml keys with a schema in CI.","Beware YAML traps: an unquoted empty value (`description:`) unmarshals to \"\" and still fails."],"tags":["go","config","validation","yaml"],"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"}