metabase-server/README.md at main · imlewc/metabase-server · GitHub

Skip to content

Navigation Menu

Toggle navigation

Sign in

• Product

  • GitHub Copilot Write better code with AI
  • Security Find and fix vulnerabilities
  • Actions Automate any workflow
  • Codespaces Instant dev environments
  • Issues Plan and track work
  • Code Review Manage code changes
  • Discussions Collaborate outside of code
  • Code Search Find more, search less

  Explore

  • All features
  • Documentation
  • GitHub Skills
  • Blog

• Solutions

  By company size

  • Enterprises
  • Small and medium teams
  • Startups
  • Nonprofits

  By use case

  • DevSecOps
  • DevOps
  • CI/CD
  • View all use cases

  By industry

  • Healthcare
  • Financial services
  • Manufacturing
  • Government
  • View all industries

  View all solutions

• Resources

  Topics

  • AI
  • DevOps
  • Security
  • Software Development
  • View all

  Explore

  • Learning Pathways
  • Events & Webinars
  • Ebooks & Whitepapers
  • Customer Stories
  • Partners
  • Executive Insights

• Open Source

  • GitHub Sponsors Fund open source developers

  • The ReadME Project GitHub community articles

  Repositories

  • Topics
  • Trending
  • Collections

• Enterprise

  • Enterprise platform AI-powered developer platform

  Available add-ons

  • Advanced Security Enterprise-grade security features
  • Copilot for business Enterprise-grade AI features
  • Premium Support Enterprise-grade 24/7 support

• Pricing

Search or jump to...

Search code, repositories, users, issues, pull requests...

Search

Clear

Search syntax tips

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted

Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Name

Query

To see all available qualifiers, see our documentation.

Cancel Create saved search

Sign in

Sign up Reseting focus

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert

{{ message }}

imlewc / metabase-server Public

• Notifications You must be signed in to change notification settings

• Fork 1

• Star 6

• Code

• Issues 0

• Pull requests 0

• Actions

• Projects 0

• Security

• Insights

Additional navigation options

• Code
• Issues
• Pull requests
• Actions
• Projects
• Security
• Insights

Files

main

• src

• .gitignore

• Dockerfile

• README.md

• package-lock.json

• package.json

• smithery.yaml

• tsconfig.json

Breadcrumbs

1. metabase-server

/

README.md

Copy path

Blame

Blame

Latest commit

smithery-ai[bot]

Update README

Mar 2, 2025

03f7e2a · Mar 2, 2025

History

History

98 lines (71 loc) · 2.76 KB

Breadcrumbs

1. metabase-server

/

README.md

Top

File metadata and controls

• Preview

• Code

• Blame

98 lines (71 loc) · 2.76 KB

Raw

metabase-server MCP Server

A Model Context Protocol server for Metabase integration.

This is a TypeScript-based MCP server that implements integration with Metabase API. It allows AI assistants to interact with Metabase, providing access to:

• Dashboards, questions/cards, and databases as resources
• Tools for listing and executing Metabase queries
• Ability to view and interact with Metabase data

Features

Resources

• List and access Metabase resources via metabase:// URIs
• Access dashboards, cards/questions, and databases
• JSON content type for structured data access

Tools

• list_dashboards - List all dashboards in Metabase
• list_cards - List all questions/cards in Metabase
• list_databases - List all databases in Metabase
• execute_card - Execute a Metabase question/card and get results
• get_dashboard_cards - Get all cards in a dashboard
• execute_query - Execute a SQL query against a Metabase database

Configuration

Before running the server, you need to set the following environment variables:

# Required environment variables
export METABASE_URL=https://your-metabase-instance.com
export METABASE_USERNAME=your_username
export METABASE_PASSWORD=your_password

You can set these environment variables in your shell profile or use a .env file with a package like dotenv.

Development

Install dependencies:

npm install

Build the server:

npm run build

For development with auto-rebuild:

npm run watch

Installation

To use with Claude Desktop, add the server config:

On MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "metabase-server": {
      "command": "/path/to/metabase-server/build/index.js",
      "env": {
        "METABASE_URL": "https://your-metabase-instance.com",
        "METABASE_USERNAME": "your_username",
        "METABASE_PASSWORD": "your_password"
      }
    }
  }
}

Note: You can also set these environment variables in your system instead of in the config file if you prefer.

Installing via Smithery

To install metabase-server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @imlewc/metabase-server --client claude

Debugging

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the MCP Inspector, which is available as a package script:

npm run inspector

The Inspector will provide a URL to access debugging tools in your browser.

Footer

© 2025 GitHub, Inc.

Footer navigation

• Terms
• Privacy
• Security
• Status
• Docs
• Contact
• Manage cookies
• Do not share my personal information

You can’t perform that action at this time.