dbt-investigator
README.md
# Data Quality Agent
[](https://github.com/ARAVINDHRAJA123/data-quality-agent/actions/workflows/ci.yml)
An agentic AI system that automatically investigates dbt test failures, traces the root cause through BigQuery lineage, and generates a plain-English incident report ā cutting investigation time from hours to minutes.
š [Sample incident report](docs/sample_report.md)
---
## Architecture

---
## What it does
When a dbt test fails you normally get a cryptic error message. This agent:
1. **Fetches the failing rows** from BigQuery ā sees the actual bad data
2. **Reads the dbt manifest** ā understands the full lineage graph
3. **Traces upstream** ā profiles columns in parent models and source tables
4. **Identifies the root cause** ā finds where the bad data entered the pipeline
5. **Writes an incident report** ā plain-English root cause, lineage trace, recommended fix, severity
```
not_null_fct_transactions_merchant failed (23 rows)
ā
ā¼
Agent fetches failing rows ā reads fct lineage ā traces to int_ ā traces to stg_ ā checks raw source
ā
ā¼
Root cause: 23 rows in raw.bank_transactions have NULL narration.
Merchant extraction returns NULL when narration is NULL.
Fix: Add COALESCE(narration, '') in stg_bank__transactions.
Severity: HIGH
```
---
## Three trigger modes
### 1 ā CLI
```bash
python agent.py \
--test not_null_fct_transactions_merchant \
--model fct_transactions \
--column merchant \
--verbose
```
### 2 ā Webhook (Airflow or any HTTP caller)
```bash
python server.py # starts on port 5051
curl -X POST http://localhost:5051/investigate \
-H "Content-Type: application/json" \
-d '{"test_name": "not_null_fct_transactions_merchant", "model": "fct_transactions", "column": "merchant"}'
```
Point your Airflow DAG's `on_failure_callback` at this endpoint.
### 3 ā MCP (any AI client)
The MCP server exposes three tools to any MCP-compatible client ā Claude Code, OpenClaw (ChatGPT / Gemini / any client), Cursor, Zed:
| Tool | What it does |
|---|---|
| `investigate_failure` | Full agentic investigation ā incident report |
| `list_failures` | List failing tests from run_results.json |
| `get_report` | Read a saved incident report |
**Claude Code:**
```bash
claude mcp add -s user \
-e GCP_PROJECT=your-project \
-e BQ_LOCATION=asia-south1 \
-e DBT_MANIFEST_PATH=/path/to/dbt_bank/target/manifest.json \
-e DBT_RUN_RESULTS_PATH=/path/to/dbt_bank/target/run_results.json \
-e GEMINI_API_KEY=your-key \
dbt-investigator \
-- /path/to/venv/bin/python /path/to/mcp_server.py
```
**OpenClaw (ChatGPT, Gemini, or any other client):**
```bash
openclaw mcp set dbt-investigator '{
"command": "/path/to/venv/bin/python",
"args": ["/path/to/mcp_server.py"],
"cwd": "/path/to/data-quality-agent",
"env": {
"GCP_PROJECT": "your-project",
"GEMINI_API_KEY": "your-key",
"DBT_MANIFEST_PATH": "/path/to/manifest.json",
"DBT_RUN_RESULTS_PATH": "/path/to/run_results.json"
}
}'
openclaw mcp probe # ā dbt-investigator: 3 tools ā
```
---
## Agent tools
| Tool | What the agent calls |
|---|---|
| `get_failing_rows` | Queries BigQuery for actual bad rows |
| `get_model_lineage` | Reads manifest.json for upstream/downstream |
| `get_model_sql` | Gets compiled SQL for any model |
| `get_column_profile` | null count, distinct count, min, max |
| `run_query` | Custom read-only BQ investigation |
| `get_source_freshness` | Checks staleness of source tables |
| `write_report` | Writes the final incident report |
**Safety wall:** all BigQuery queries are read-only (SELECT/WITH only). DML/DDL rejected before execution.
---
## Setup
```bash
git clone https://github.com/ARAVINDHRAJA123/data-quality-agent.git
cd data-quality-agent
python3 -m venv venv && source venv/bin/activate
pip install -r requirements.txt
# Auth
gcloud auth application-default login
# Set environment
export GCP_PROJECT=your-project
export BQ_LOCATION=asia-south1
export DBT_MANIFEST_PATH=/path/to/dbt_bank/target/manifest.json
export DBT_RUN_RESULTS_PATH=/path/to/dbt_bank/target/run_results.json
# LLM (pick one)
export GEMINI_API_KEY=your-key # free
export ANTHROPIC_API_KEY=your-key # paid
```
Generate the manifest first (from your dbt project):
```bash
cd /path/to/dbt_project && dbt compile
# manifest.json is now at target/manifest.json
```
---
## Stack
- **Claude / Gemini** ā LLM provider (auto-detected, free Gemini supported)
- **BigQuery** ā data warehouse (GCP)
- **dbt manifest.json** ā lineage graph and compiled SQL
- **FastMCP** ā MCP server (any AI client)
- **Flask** ā webhook server (Airflow integration)
- **pytest** ā test suite
---
## Project structure
```
data-quality-agent/
āāā agent.py ā agentic investigation loop (Claude + Gemini)
āāā server.py ā Flask webhook server
āāā mcp_server.py ā FastMCP server (any MCP client)
āāā report.py ā incident report formatter
āāā tools/
ā āāā bq_tools.py ā BigQuery: failing rows, queries, freshness
ā āāā dbt_tools.py ā manifest: lineage, SQL, test results
āāā tests/
ā āāā test_tools.py ā 11 unit tests (no BQ/LLM needed)
āāā reports/ ā saved incident reports (markdown)
āāā requirements.txt
```
This server cannot be deployed
Maintenance
ActivityStale
ResponsivenessNo issues