Dbt Cli MCP

🚀 DBT CLI MCP 服務器

DBT CLI MCP 服務器是一款基於模型上下文協議（Model Context Protocol, MCP）的工具，它能夠增強 dbt (Data Build Tool) 的功能。dbt 是一款流行的命令行工具，主要用於數據構建和測試。

🚀 快速開始

DBT CLI MCP 服務器可增強 dbt 的功能，支持多種 dbt 操作，還能進行配置文件管理和環境變量設置。以下是快速上手的步驟：

✨ 主要特性

• 支持的主要 dbt 操作：涵蓋運行 (run)、測試 (test) 和編譯 (compile) 等操作。
• 配置文件管理：能夠處理 dbt_project.yml 和 profiles.yml 文件，保證項目配置的正確性。
• 環境變量設置：自動配置 DBT_PROFILES_DIR 環境變量，指定 profiles 文件的位置。

📦 安裝指南

依賴工具

• Git：用於克隆代碼倉庫和處理子模塊。
• Python 3.8 或更高版本：確保兼容性。
• pip：用於安裝 Python 包。

克隆倉庫

git clone https://github.com/your-repository.git
cd your-repository

安裝依賴

pip install -r requirements.txt

💻 使用示例

基礎用法

命令行界面 (CLI)

以下是一些示例命令：

• 運行 dbt 項目：

python src/dbt_mcp_server/cli.py run --project-dir /path/to/project

• 測試 dbt 項目：

python src/dbt_mcp_server/cli.py test --project-dir /path/to/project

參數選項

• --project-dir：指定 dbt 項目的根目錄，必須是絕對路徑。
• --profile：指定要使用的 dbt 配置文件中的 profile 名稱。

環境變量

示例環境變量設置：

export DBT_PROFILES_DIR="/path/to/dbt_project"

高級用法

與 MCP 客戶端集成

在 profiles.yml 中定義配置：

jaffle_shop:
  target: dev
  outputs:
    dev:
      type: duckdb
      path: 'jaffle_shop.duckdb'
      threads: 24

📚 詳細文檔

注意事項

⚠️ 重要提示

1. project-dir 必須是包含 dbt_project.yml 和 profiles.yml 的絕對路徑。
2. 要確保 dbt_project.yml 中指定的 profile 名稱與 profiles.yml 中一致。若出現 "找不到配置文件" 錯誤，請檢查路徑是否正確。

開發信息

集成測試

運行所有集成測試：

python integration_tests/run_all.py

運行特定測試：

python integration_tests/test_dbt_run.py

子模塊管理

更新子模塊倉庫：

git submodule update --remote dbt_integration_tests/jaffle_shop_duckdb

初始化子模塊：

git submodule update --init

📄 許可證

本項目採用 MIT 許可證。