Skip to main content

Model Context Protocol (MCP) server for Metabase - Connect AI assistants like Claude and Cursor to your Metabase analytics platform

Project description

Metabase MCP Server - Connect AI Assistants to Your Metabase Analytics 🚀

Python 3.12+ License: MIT FastMCP

A high-performance Model Context Protocol (MCP) server for Metabase, enabling AI assistants like Claude, Cursor, and other MCP clients to interact seamlessly with your Metabase instance. Query databases, execute SQL, manage dashboards, and automate analytics workflows with natural language through AI-powered database operations.

Perfect for: Data analysts, developers, and teams looking to integrate AI assistants with their Metabase business intelligence platform for automated SQL queries, dashboard management, and data exploration.

✨ Key Features

🗄️ Database Operations

  • List Databases: Browse all configured Metabase databases
  • Table Discovery: Explore tables with metadata and descriptions
  • Field Inspection: Get detailed field/column information with smart pagination

📊 Query & Analytics

  • SQL Execution: Run native SQL queries with parameter support and templating
  • Card Management: Execute, create, and manage Metabase questions/cards
  • Collection Organization: Create and manage collections for better organization
  • Natural Language Queries: Let AI assistants translate questions into SQL

🔐 Authentication & Security

  • API Key Support: Secure authentication via Metabase API keys (recommended)
  • Session-based Auth: Alternative email/password authentication
  • Environment Variables: Secure credential management via .env files

🤖 AI Assistant Integration

  • Claude Desktop: Native integration with Anthropic's Claude AI
  • Cursor IDE: Seamless integration for AI-assisted development
  • Any MCP Client: Compatible with all Model Context Protocol clients

🚀 Quick Start

Prerequisites

  • Python 3.12+
  • Metabase instance with API access
  • uv package manager (recommended) or pip

Installation

Using uv (Recommended)

# Install uv if not already installed
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone the repository
git clone https://github.com/yourusername/metabase-mcp.git
cd metabase-mcp

# Install dependencies
uv sync

Using pip

# Clone and install
git clone https://github.com/yourusername/metabase-mcp.git
cd metabase-mcp
pip install -r requirements.txt

⚙️ Configuration

Create a .env file with your Metabase credentials:

cp .env.example .env

Configuration Options

Option 1: API Key Authentication (Recommended)

METABASE_URL=https://your-metabase-instance.com
METABASE_API_KEY=your-api-key-here

Option 2: Email/Password Authentication

METABASE_URL=https://your-metabase-instance.com
METABASE_USER_EMAIL=your-email@example.com
METABASE_PASSWORD=your-password

Optional: Custom Host/Port for SSE/HTTP

HOST=localhost  # Default: 0.0.0.0
PORT=9000      # Default: 8000

Usage

Run the Server

# STDIO transport (default)
uv run python server.py

# SSE transport (uses HOST=0.0.0.0, PORT=8000 by default)
uv run python server.py --sse

# HTTP transport (uses HOST=0.0.0.0, PORT=8000 by default)
uv run python server.py --http

# Custom host and port via environment variables
HOST=localhost PORT=9000 uv run python server.py --sse
HOST=192.168.1.100 PORT=8080 uv run python server.py --http

# Set environment variables persistently
export HOST=localhost
export PORT=9000
uv run python server.py --sse

FastMCP CLI Integration

# Run with FastMCP CLI
fastmcp run server.py

# Install as Claude Desktop MCP server
fastmcp install server.py -n "Metabase MCP"

Cursor Integration

You can manually configure Cursor by editing your Cursor settings. Example configurations are available in the config/ directory.

For SSE transport: You must start the server before using Cursor:

uv run python server.py --sse 8000

Claude Integration

After running uv sync, you can find the Python executable at /path/to/repo/.venv/bin/python. To integrate with Claude, add or update the configuration file at ~/Library/Application\ Support/Claude/claude_desktop_config.json:

{
    "mcpServers": {
        "metabase-mcp-server": {
            "command": "/path/to/repo/.venv/bin/python",
            "args": ["/path/to/repo/server.py"]
        }
    }
}

🛠️ Available Tools

Database Operations

Tool Description
list_databases List all configured databases in Metabase
list_tables Get all tables in a specific database with metadata
get_table_fields Retrieve field/column information for a table

Query Operations

Tool Description
execute_query Execute native SQL queries with parameter support
execute_card Run saved Metabase questions/cards

Card Management

Tool Description
list_cards List all saved questions/cards
create_card Create new questions/cards with SQL queries

Collection Management

Tool Description
list_collections Browse all collections
create_collection Create new collections for organization

Transport Methods

The server supports multiple transport methods:

  • STDIO (default): For IDE integration (Cursor, Claude Desktop)
  • SSE: Server-Sent Events for web applications
  • HTTP: Standard HTTP for API access
uv run python server.py                        # STDIO (default)
uv run python server.py --sse                  # SSE (HOST=0.0.0.0, PORT=8000)
uv run python server.py --http                 # HTTP (HOST=0.0.0.0, PORT=8000)
HOST=localhost PORT=9000 uv run python server.py --sse   # Custom host/port

🧪 Development

Setup Development Environment

# Install with dev dependencies
uv sync --group dev

# Or with pip
pip install -r requirements-dev.txt

Code Quality

# Run linting
uv run ruff check .

# Format code
uv run ruff format .

# Type checking
uv run mypy server.py

📚 Usage Examples

Query Examples

# List all databases
databases = await list_databases()

# Execute a SQL query
result = await execute_query(
    database_id=1,
    query="SELECT * FROM users LIMIT 10"
)

# Create and run a card
card = await create_card(
    name="Active Users Report",
    database_id=1,
    query="SELECT COUNT(*) FROM users WHERE active = true",
    collection_id=2
)

📁 Project Structure

metabase-mcp/
├── server.py                 # Main MCP server implementation
├── setup.py                 # Setup and installation script
├── pyproject.toml           # Project configuration and dependencies
├── .env.example             # Environment variables template
└── config/                  # Configuration examples for IDE integration

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

MIT License - see LICENSE file for details

🔗 Resources

🏷️ Keywords & Topics

metabase mcp model-context-protocol claude cursor ai-assistant fastmcp sql database analytics business-intelligence bi data-analysis anthropic llm python automation api data-science query-builder natural-language-sql

⭐ Star History

If you find this project useful, please consider giving it a star! It helps others discover this tool.

🔍 Use Cases

  • Natural Language Database Queries: Ask Claude to query your Metabase databases using plain English
  • Automated Report Generation: Use AI to create and manage Metabase cards and collections
  • Data Exploration: Let AI assistants help you discover insights from your data
  • SQL Query Assistance: Get help writing and optimizing SQL queries through AI
  • Dashboard Management: Automate the creation and organization of Metabase dashboards
  • Data Analysis Workflows: Integrate AI-powered analytics into your development workflow

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

metabase_mcp-1.0.0.tar.gz (36.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

metabase_mcp-1.0.0-py3-none-any.whl (47.6 kB view details)

Uploaded Python 3

File details

Details for the file metabase_mcp-1.0.0.tar.gz.

File metadata

  • Download URL: metabase_mcp-1.0.0.tar.gz
  • Upload date:
  • Size: 36.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.1

File hashes

Hashes for metabase_mcp-1.0.0.tar.gz
Algorithm Hash digest
SHA256 70be05e4e1db626cfd06ffc9e5ec20e8586e4237d1ce379095b16f7c696f3679
MD5 16da067836de650f385f31f4b1ab641b
BLAKE2b-256 16e20c12a3d4e17e54a06c3a645014e2b34f3ba85b603211afad142ea6a32f9c

See more details on using hashes here.

File details

Details for the file metabase_mcp-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for metabase_mcp-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dbf1d838befaf7f088ae559396dcb6d900c252ead3bb956e69c80f62d22dbc38
MD5 93d39446a6673cc6dc7f52c2e960d0fd
BLAKE2b-256 f8ed4d9696b182924900c858947c66508f0ba6e2913ea086530af98cc8d67829

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page