{"record":{"id":"c36cb14be3c70739","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-c36cb1","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/cloudloggingadmin/cloudloggingadminlistlognames/cloudloggingadminlistlognames.go","lineNumber":67,"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\tlimitDescription := fmt.Sprintf(\"Maximum number of log entries to return. Default: %d.\", defaultLimit)\n\tparams := parameters.Parameters{\n\t\tparameters.NewIntParameter(\"limit\", limitDescription, parameters.WithIntRequired(false)),\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: params.Manifest(), AuthRequired: cfg.AuthRequired},\n\t\t\tparams,\n\t\t),\n\t}, nil\n}\n\n// validate interface","sourceCodeStart":49,"sourceCodeEnd":85,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/cloudloggingadmin/cloudloggingadminlistlognames/cloudloggingadminlistlognames.go#L49-L85","documentation":"Config.Initialize for the cloudloggingadmin-list-log-names tool validates that a non-empty description was provided, since tool descriptions are surfaced to the LLM to decide when to use the tool. An empty description makes the config invalid and initialization fails immediately.","triggerScenarios":"Defining a cloudloggingadmin-list-log-names tool in the YAML config without a `description` field, or with `description: \"\"`.","commonSituations":"Minimal example configs copied without the description key; programmatically generated tool configs where description defaulted to empty; YAML key typo (`descriptions:` or wrong indentation) leaving the field unset.","solutions":["Add a non-empty `description` field to the tool definition in the config.","Check the YAML indentation so `description` is nested under the tool, not a sibling.","Verify the key spelling is exactly `description` (singular).","Re-run the toolbox; the error names the tool so fix that specific entry."],"exampleFix":"// before\ntools:\n  list-log-names:\n    kind: cloudloggingadmin-list-log-names\n    source: my-logging\n// after\ntools:\n  list-log-names:\n    kind: cloudloggingadmin-list-log-names\n    source: my-logging\n    description: List Cloud Logging log names for a project.","handlingStrategy":"validation","validationCode":"// shell check before applying a toolbox config\nyq '.tools[] | select(.kind == \"cloudloggingadmin-list-log-names\") | select(.description == null or .description == \"\") | error(\"missing description\")' config.yaml","typeGuard":null,"tryCatchPattern":null,"preventionTips":["Always include a description for every tool definition","Add a config lint step in CI checking required tool fields","Watch for YAML indentation and key typos (description vs descriptions)","Document required fields in your config template"],"tags":["go","config","validation","cloud-logging"],"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"}