dbt-docs-mcp

dbt-docs-mcp

用于与 dbt 项目元数据交互的模型上下文协议（MCP）服务，包括 dbt Docs 工件（manifest.json、catalog.json）。此服务公开 dbt 图信息，并允许查询节点详情、模型/列血缘关系以及相关元数据。

主要功能

此服务提供以下工具：

• 搜索 dbt 节点：
  • 按名称查找节点（模型、源、测试等）（search_dbt_node_names）。
  • 根据列名定位节点（search_dbt_column_names）。
  • 在节点的编译后 SQL 代码中搜索（search_dbt_sql_code）。
• 检查节点：
  • 检索任意给定节点唯一 ID 的详细属性（get_dbt_node_attributes）。
• 探索血缘关系：
  • 查找节点的直接上游依赖项（前置节点）（get_dbt_predecessors）。
  • 查找节点的直接下游依赖项（后续节点）（get_dbt_successors）。
• 列级血缘关系：
  • 追溯模型中特定列的所有上游来源（get_column_ancestors）。
  • 追溯模型中特定列的所有下游依赖项（get_column_descendants）。
• 建议的扩展：
  • 允许执行 SQL 查询的工具。
  • 直接从数据库检索表/视图/列元数据的工具。
  • 搜索知识库的工具。

开始使用

1. **前置条件：**确保已安装 Python 和 uv
2. 克隆仓库：

   git clone <repository-url>
   cd dbt-docs-mcp
   

3. 可选：解析 dbt manifest 以获取列级血缘关系：
   • 设置所需的 Python 环境，例如：

   uv sync
   

   • 使用提供的脚本 scripts/create_manifest_cl.py，并提供 dbt manifest、dbt catalog 的路径，以及 schema 和列血缘关系文件所需的输出路径：

   python scripts/create_manifest_cl.py --manifest-path PATH_TO_YOUR_MANIFEST_FILE --catalog-path PATH_TO_YOUR_CATALOG_FILE --schema-mapping-path DESIRED_OUTPUT_PATH_FOR_SCHEMA_MAPPING --manifest-cl-path DESIRED_OUTPUT_PATH_FOR_MANIFEST_CL
   

   • 根据 dbt 项目的规模，生成列级血缘关系可能需要较长时间（数小时）
4. 运行服务：
   • 如果你使用的 MCP 客户端（Claude 桌面版、Cursor 等）支持 mcp.json，配置示例如下：

   {
       "mcpServers": {
           "DBT Docs MCP": {
           "command": "uv",
           "args": [
               "run",
               "--with",
               "networkx,mcp[cli],rapidfuzz,dbt-core,python-decouple,sqlglot,tqdm",
               "mcp",
               "run",
               "/Users/mattijs/repos/dbt-docs-mcp/src/mcp_server.py"
           ],
           "env": {
               "MANIFEST_PATH": "/Users/mattijs/repos/dbt-docs-mcp/inputs/manifest.json",
               "SCHEMA_MAPPING_PATH": "/Users/mattijs/repos/dbt-docs-mcp/outputs/schema_mapping.json",
               "MANIFEST_CL_PATH": "/Users/mattijs/repos/dbt-docs-mcp/outputs/manifest_column_lineage.json"
           }
           }
       }
   }