🚀 Dremio 模型上下文协议（MCP）服务器文档

Dremio MCP 服务器作为连接大型语言模型与 Dremio 数据湖分析平台的桥梁，借助 Model Context Protocol 让 LLM 能够访问实时数据和元数据，极大地增强了分析能力。

🚀 快速开始

Dremio MCP 服务器是连接大型语言模型与 Dremio 数据湖分析平台的关键桥梁，它能让 LLM 通过特定协议访问实时数据和元数据，提升分析能力。下面为你介绍如何快速搭建并使用该服务器。

📦 安装指南

下载代码

克隆仓库到本地，并进入项目目录：

git clone git@github.com:dremio/dremio-mcp.git
cd dremio-mcp

运行服务器

安装依赖并启动服务器：

npm install
uv run --directory . dremio-mcp-server

📚 详细文档

初始设置

MCP 服务器配置文件

MCP 服务器的配置文件默认位于 $HOME/.config/dremioai/config.yaml，你也可以通过 --config-file 参数来指定其他配置文件。

格式

# Dremio 配置：URI、PAT 和可选项目 ID
dremio:
    uri: https://... # Dremio URI
    pat: "@~/ws/tokens/idl.token" # PAT 可从文件加载，使用 @ 前缀
    # 项目 ID（仅在使用云服务时）
    project_id: ...

# 工具模式：指定服务器运行的模式
tools:
    server_mode: FOR_DATA_PATTERNS # 默认模式，支持数据集分析

模式说明

• FOR_DATA_PATTERNS：允许 LLM 对数据表和数据进行分析，发现数据之间的关系。
• FOR_SELF：用于系统的自检，例如工作负载分析等。
• FOR_PROMETHEUS：如果已经集成了 Prometheus，可增强监控能力。

多个模式之间可以使用逗号分隔。

LLM（Claude）配置文件

你需要编辑 Claude 的桌面配置文件：

• macOS 系统：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows 系统：%APPDATA%\Claude\claude_desktop_config.json

添加以下内容：

{
  "globalShortcut": "",
  "mcpServers": {
    "Dremio": {
      "command": "uv",
      "args": [
        "run",
        "--directory", "<顶层 Git 目录>",
        "dremio-mcp-server",
        "run"
      ]
    }
  }
}

进一步文档

• 架构：详细概述了 MCP 服务器的架构，包括组件之间的交互和数据流。
• 工具：提供了全面的指南，涵盖工具的分类与类型、使用示例以及开发规范。
• 设置：是完整的配置参考，包含 Dremio 连接参数、工具配置以及集成支持等内容。

📄 许可证

此仓库旨在在开源环境下促进各方的贡献，包括功能的添加、问题的报告和修复等。但需要注意的是，它并非 Dremio 产品的官方支持部分。

🤝 贡献指南

如果你想为项目做出贡献，请查阅 CONTRIBUTING.md，其中包含以下方面的内容：

• 开发环境的搭建方法。
• 如何进行贡献。
• 编码风格规范。
• 文档要求。