Dremio MCP

🚀 Dremio Model Context Protocol (MCP) Server Documentation

Dremio MCP Server serves as a bridge between large language models and the Dremio data lake analytics platform. It enables LLMs to access real - time data and metadata via the Model Context Protocol, thereby enhancing analytical capabilities.

🚀 Quick Start

📦 Installation

Download the Code

Clone the repository:

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

Run the Server

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

Initial Setup

MCP Server Configuration File

By default, it is located at $HOME/.config/dremioai/config.yaml and can be specified using the --config-file parameter.

Format

# Dremio configuration: URI, PAT, and optional project ID
dremio:
    uri: https://... # Dremio URI
    pat: "@~/ws/tokens/idl.token" # PAT can be loaded from a file using the @ prefix
    # Project ID (only when using cloud services)
    project_id: ...

# Tool mode: Specify the mode in which the server runs
tools:
    server_mode: FOR_DATA_PATTERNS # Default mode, supporting dataset analysis

Mode Explanation

1. FOR_DATA_PATTERNS - Allows LLMs to analyze data tables and data, discovering data relationships.
2. FOR_SELF - Used for system self - checks, including workload analysis, etc.
3. FOR_PROMETHEUS - Enhances monitoring capabilities if Prometheus is integrated. Multiple modes can be separated by commas.

LLM (Claude) Configuration File

Edit the Claude desktop configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json Add the following content:

{
  "globalShortcut": "",
  "mcpServers": {
    "Dremio": {
      "command": "uv",
      "args": [
        "run",
        "--directory", "<Top - level Git directory>",
        "dremio-mcp-server",
        "run"
      ]
    }
  }
}

📚 Documentation

1. Architecture: A detailed overview of the MCP server architecture, including component interactions and data flow.
2. Tools: A comprehensive guide covering:
   • Tool classification and types
   • Usage examples
   • Development specifications
3. Settings: A complete configuration reference, including:
   • Dremio connection parameters
   • Tool configuration
   • Integration support

Other Information

This repository aims to encourage contributions in an open - source environment, including adding features, reporting issues, and making fixes. It is not an official support part of the Dremio product.

Contribution Guidelines

Please refer to CONTRIBUTING.md for:

• Setting up the development environment
• How to contribute
• Coding style guidelines
• Documentation requirements