{"record":{"id":"3d1ced54ecad4ee0","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-3d1ced","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/utility/wait/wait.go","lineNumber":60,"sourceCode":"\treturn actual, nil\n}\n\ntype Config struct {\n\ttools.ConfigBase `yaml:\",inline\"`\n\tType             string                 `yaml:\"type\" validate:\"required\"`\n\tTimeout          string                 `yaml:\"timeout\" validate:\"required\"`\n\tAnnotations      *tools.ToolAnnotations `yaml:\"annotations,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\tdurationParameter := parameters.NewStringParameter(\"duration\", \"The duration to wait for, specified as a string (e.g., '10s', '2m', '1h').\")\n\tparams := parameters.Parameters{durationParameter}\n\n\tt := 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}\n\treturn t, nil\n}\n\n// validate interface\nvar _ tools.Tool = Tool{}\n","sourceCodeStart":42,"sourceCodeEnd":78,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/utility/wait/wait.go#L42-L78","documentation":"The wait utility tool requires a human-readable description; Config.Initialize rejects configs with an empty Description field. Descriptions are surfaced to LLM clients via the MCP manifest, so an empty one is treated as a misconfiguration and initialization fails.","triggerScenarios":"Declaring a wait tool in tools.yaml without a 'description' field, or providing description: \"\" while calling Config.Initialize (directly or via toolbox config loading).","commonSituations":"Minimal/quickstart configs that omit the description field; programmatically generated configs where the description variable is empty; refactors that removed the field.","solutions":["Add a non-empty 'description' field to the wait tool config in tools.yaml","If constructing Config in Go, set cfg.Description before calling Initialize","Restart toolbox and confirm the tool loads"],"exampleFix":"# before\ntools:\n  wait:\n    kind: wait\n# after\ntools:\n  wait:\n    kind: wait\n    description: Waits for the specified duration before returning","handlingStrategy":"validation","validationCode":"if cfg.Description == \"\" {\n    return fmt.Errorf(\"wait tool %q must set a description\", cfg.Name)\n}","typeGuard":null,"tryCatchPattern":"tool, err := cfg.Initialize(ctx)\nif err != nil && strings.Contains(err.Error(), \"description is required\") {\n    // fix tools.yaml: add non-empty 'description' to the tool entry\n}","preventionTips":["Always include a description for every tool in tools.yaml","Run a config linter/schema check in CI before deploying toolbox configs","Never generate tool configs with empty string fields"],"tags":["go","tool-configuration","validation"],"backgroundTag":"missing-tool-description","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"}