Dbt CLI

🚀 DBT CLI MCP Server

A Model Context Protocol (MCP) server that encapsulates the dbt CLI tool, enabling AI coding agents to interact with dbt projects through the standardized MCP tool.

✨ Features

• Execute dbt commands via the MCP tool.
• Support all major dbt operations (run, test, compile, etc.).
• Provide a command-line interface for direct interaction.
• Manage environment variables for dbt projects.
• Configure the path to the dbt executable file.
• Flexibly configure the location of the profiles.yml file.

📦 Installation

Prerequisites

• Python 3.10 or higher.
• The uv tool for Python environment management.
• The dbt CLI installed.

Setup

# Clone the repository and initialize submodules
git clone --recurse-submodules https://github.com/your-repository.git
cd your-repository

# Install dependencies
pip install -r requirements.txt

💻 Usage Examples

Basic Commands

• Run a dbt project:

python mcp_server.py run --project-dir /path/to/dbt_project

• Compile a dbt project:

python mcp_server.py compile --project-dir /path/to/dbt_project

• Test dbt models:

python mcp_server.py test --project-dir /path/to/dbt_project

Environment Variable Configuration

1. Configure the dbt_project.yml file to specify project information and the profile to use:

name: my_project
version: 1.0
config-version: 2
profiles:
  - my_profile

2. Configure the profiles.yml file to define the specific settings for the profile:

my_profile:
  target: dev
  outputs:
    dev:
      type: duckdb
      path: 'my_project.db'
      threads: 4

Example Project Structure

project_root/
├── dbt_project.yml
├── profiles.yml
└── mcp_server.py

📚 Documentation

Integration Testing

The project includes integration tests that verify the functionality of an actual dbt project:

# Run all integration tests
python integration_tests/run_all.py

# Run specific integration tests
python integration_tests/test_dbt_run.py

Test Project Setup

The integration tests use the jaffle_shop_duckdb project, which is included as a Git submodule in the dbt_integration_tests directory. This will be automatically initialized when you clone the repository with --recurse-submodules.

If you need to update the test project to the latest version:

git submodule update --remote dbt_integration_tests/jaffle_shop_duckdb

If you encounter errors regarding missing files in the jaffle_shop_duckdb directory, initialize the submodules:

git submodule update --init

📄 License

MIT