{"record":{"id":"8bb4581aa1a62d15","repo":"googleapis/mcp-toolbox","slug":"description-is-required-for-tool-q-8bb458","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/postgres/postgresexecutesql/postgresexecutesql.go","lineNumber":66,"sourceCode":"\tRunSQL(context.Context, string, []any) (any, error)\n}\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\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\tallParameters := parameters.Parameters{\n\t\tparameters.NewStringParameter(\"sql\", \"The sql to execute.\"),\n\t}\n\n\treturn Tool{\n\t\tBaseTool: tools.NewBaseTool(\n\t\t\tcfg,\n\t\t\ttools.GetAnnotationsOrDefault(cfg.Annotations, tools.NewDestructiveAnnotations),\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\nvar _ tools.Tool = Tool{}\n\ntype Tool struct {","sourceCodeStart":48,"sourceCodeEnd":84,"githubUrl":"https://github.com/googleapis/mcp-toolbox/blob/8cc6e09de2ad7b8bffc77751799585a1401a48eb/internal/tools/postgres/postgresexecutesql/postgresexecutesql.go#L48-L84","documentation":"postgres-execute-sql's Config.Initialize requires a non-empty Description, consistent with all tool configs. The description is required for the tool manifest exposed to MCP clients; an empty one aborts initialization immediately.","triggerScenarios":"Initializing a postgresexecutesql.Config with Description == \"\" — typically a tools.yaml entry for postgres-execute-sql missing the description field.","commonSituations":"Omitting or misspelling description in YAML; empty-string description; building Config programmatically without setting Description; deserialization issues leaving the field zero-valued.","solutions":["Add a non-empty description to the postgres-execute-sql tool config.","Set cfg.Description in Go before calling Initialize.","Check YAML indentation/key spelling so description deserializes correctly."],"exampleFix":"# before\n  execute-sql:\n    kind: postgres-execute-sql\n    source: my-postgres\n# after\n  execute-sql:\n    kind: postgres-execute-sql\n    source: my-postgres\n    description: Executes arbitrary SQL against the Postgres database.","handlingStrategy":"validation","validationCode":"if cfg.Description == \"\" {\n    return errors.New(\"postgres-execute-sql tool requires a non-empty description\")\n}","typeGuard":"func hasDescription(c postgresexecutesql.Config) bool { return c.Description != \"\" }","tryCatchPattern":"tool, err := cfg.Initialize(context.Background())\nif err != nil && strings.Contains(err.Error(), \"description is required\") {\n    cfg.Description = \"Execute SQL against Postgres.\"\n    tool, err = cfg.Initialize(context.Background())\n}","preventionTips":["Include a description for every tool in tools.yaml.","Enforce description presence with a CI config linter.","Derive descriptions from prebuilt config examples rather than writing from scratch."],"tags":["go","postgres","config-validation","tool-configuration"],"backgroundTag":"missing-required-config-field","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"}