{"record":{"id":"fca0103159e92a22","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-fca010","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/falkordb/falkordblistgraphs/falkordblistgraphs.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\tparams := parameters.Parameters{}\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\nvar _ tools.Tool = Tool{}\n\ntype Tool struct {","sourceCodeStart":49,"sourceCodeEnd":85,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/falkordb/falkordblistgraphs/falkordblistgraphs.go#L49-L85","documentation":"Config.Initialize for the falkordb-listgraphs tool checks that `cfg.Description` is set; a description is required for every tool because it is published in the tool manifest consumed by LLM clients. An empty description aborts Initialize with this error.","triggerScenarios":"A `falkordb-listgraphs` tool entry in tools.yaml with the `description` field absent or empty.","commonSituations":"Adding a no-parameter tool and assuming description is optional for simple tools; scaffolding tools quickly in CI and filling descriptions later; YAML anchors that resolve to empty strings.","solutions":["Add a non-empty `description` field to the falkordb-listgraphs tool","Verify indentation places description inside the tool mapping","Regenerate or hand-write the description and reload the config","Confirm via the toolbox tool list that the error is gone"],"exampleFix":"// before (tools.yaml)\ntools:\n  list-graphs:\n    kind: falkordb-listgraphs\n    source: falkordb\n// after\ntools:\n  list-graphs:\n    kind: falkordb-listgraphs\n    source: falkordb\n    description: Lists all graphs available in the FalkorDB database.","handlingStrategy":"validation","validationCode":"if t.Description == \"\" {\n    return fmt.Errorf(\"tool %q (falkordb-listgraphs) requires a description\", t.Name)\n}","typeGuard":"func hasNonEmptyDesc(t ToolEntry) bool { return len(strings.TrimSpace(t.Description)) > 0 }","tryCatchPattern":"if _, err := cfg.Initialize(ctx); err != nil {\n    if strings.Contains(err.Error(), \"description is required\") {\n        return fmt.Errorf(\"missing description; see tool named in error: %w\", err)\n    }\n    return err\n}","preventionTips":["Never omit description even for parameterless tools like listgraphs","Enforce tool.description presence with a JSON/YAML schema check in CI","Document required fields in your internal tools.yaml template","Initialize all tools in a unit test to fail fast on missing metadata"],"tags":["go","configuration","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"}