Agents Lookup

Use cases / Data & analytics

dbt model documentation and test drafts

Generate column descriptions, tests and semantic definitions for dbt models, then have the model owner review before merging.

DifficultyBeginner
Setup time1-2 hours
CategoryData & analytics

The use case

dbt projects often have models with no descriptions and few tests because documenting is tedious. dbt's AI assistant in the dbt platform, now called dbt Wizard, can generate documentation, data tests, semantic models and SQL from the model code and project context. A data engineer reviews descriptions for accuracy, especially business meaning that is not visible in code, and checks that tests reflect real expectations rather than current data. Changes go through a pull request like any other dbt change.

Example workflow

  1. Pick undocumented or untested models
  2. Generate descriptions and tests
  3. Fix business meaning the code cannot show
  4. Run dbt build to check tests
  5. Merge through a pull request

Tools

Risks and guardrails

Sources

Written by Agents Lookup. Credits and official pages for the tools this use case names: