DBT CLI MCP 服务器

一个封装了 dbt CLI 工具的模型上下文协议（MCP）服务器，使 AI 编码代理能够通过标准化的 MCP 工具与 dbt 项目交互。

特性

• 通过 MCP 工具执行 dbt 命令
• 支持所有主要的 dbt 操作（运行、测试、编译等）
• 提供命令行接口进行直接交互
• 管理 dbt 项目的环境变量
• 可配置的 dbt 可执行文件路径
• 灵活的 profiles.yml 文件位置配置

安装

先决条件

• Python 3.10 或更高版本
• uv 工具用于 Python 环境管理
• 已安装 dbt CLI

设置

# 克隆仓库并初始化子模块
git clone --recurse-submodules https://github.com/your-repository.git
cd your-repository

# 安装依赖项
pip install -r requirements.txt

使用说明

基本命令

• 运行 dbt 项目：

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

• 编译 dbt 项目：

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

• 测试 dbt 模型：

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

环境变量配置

1. 配置 dbt_project.yml 文件，指定项目信息和使用的 profile：

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

2. 配置 profiles.yml 文件，定义 profile 的具体设置：

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

示例项目结构

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

开发

集成测试

项目包含验证实际 dbt 项目功能的集成测试：

# 运行所有集成测试
python integration_tests/run_all.py

# 运行特定的集成测试
python integration_tests/test_dbt_run.py

测试项目设置

集成测试使用 jaffle_shop_duckdb 项目，该仓库作为 Git 子模块包含在 dbt_integration_tests 目录中。当您使用 --recurse-submodules 克隆仓库时，这将自动初始化。

如果需要更新测试项目的最新版本：

git submodule update --remote dbt_integration_tests/jaffle_shop_duckdb

如果遇到有关 jaffle_shop_duckdb 目录中文件缺失的错误，请初始化子模块：

git submodule update --init

许可证

MIT