{"record":{"id":"b2f36d774b59fdfc","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-b2f36d","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/clickhouse/clickhouselisttables/clickhouselisttables.go","lineNumber":75,"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\tParameters       parameters.Parameters  `yaml:\"parameters\"`\n\tAnnotations      *tools.ToolAnnotations `yaml:\"annotations,omitempty\"`\n}\n\nvar _ tools.ToolConfig = Config{}\n\nfunc (cfg Config) ToolConfigType() string {\n\treturn listTablesType\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\tdatabaseParameter := parameters.NewStringParameter(databaseKey, \"The database to list tables from.\")\n\tparams := parameters.Parameters{databaseParameter}\n\n\tallParameters, paramManifest, err := parameters.ProcessParameters(nil, params)\n\tif err != nil {\n\t\treturn nil, err\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: paramManifest, AuthRequired: cfg.AuthRequired},\n\t\t\tallParameters,\n\t\t),\n\t}, nil","sourceCodeStart":57,"sourceCodeEnd":93,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/clickhouse/clickhouselisttables/clickhouselisttables.go#L57-L93","documentation":"Config.Initialize for clickhouse-list-tables requires a non-empty `description`; the toolbox surfaces tool descriptions to MCP/LLM clients, so an empty one is rejected at load time. This is config validation, not a runtime failure.","triggerScenarios":"A `clickhouse-list-tables` tool entry in YAML without a `description` (or with an empty/misspelled key), or a Config literal with Description unset passed to Initialize in Go tests.","commonSituations":"Trimming configs for brevity and dropping the description; YAML indentation putting the description under the wrong tool; renaming keys during upgrades.","solutions":["Add a meaningful `description` to the tool definition in YAML.","Verify the description key is correctly indented under the right tool.","Set cfg.Description before Initialize when constructing Config in code."],"exampleFix":"// before\ntools:\n  list_tables:\n    source: ch\n// after\ntools:\n  list_tables:\n    source: ch\n    description: List tables in a ClickHouse database.","handlingStrategy":"validation","validationCode":"// Go\nif cfg.Name == \"\" || cfg.Description == \"\" {\n    return errors.New(\"clickhouse-list-tables needs name and description\")\n}\n_, err := cfg.Initialize(context.Background())","typeGuard":null,"tryCatchPattern":null,"preventionTips":["Use a config template that includes description for every tool.","Verify YAML indentation places description inside the intended tool block.","Run config-load smoke tests in CI."],"tags":["clickhouse","config-validation","missing-field","tool-config"],"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"}