📌Overview

Purpose: The Lightdash MCP Server aims to provide a standardized interface for AI assistants to access and interact with Lightdash data via the Model Context Protocol (MCP).

Overview: This server facilitates MCP-compatible access to the Lightdash API, allowing seamless integration for applications that use AI to manage and analyze data within Lightdash.

Key Features:

Project Management: Offers tools like list_projects and get_project to manage and retrieve information about projects in the Lightdash organization, enhancing data accessibility.
Data Cataloging: Includes functions such as get_catalog, get_metrics_catalog, and get_custom_metrics to allow users to easily access and organize key metrics and custom data, thereby streamlining analytics tasks.
Chart and Dashboard Handling: Features methods like list_charts, list_dashboards, get_charts_as_code, and get_dashboards_as_code for comprehensive interaction with charts and dashboards in projects, enabling better visualization and management of data insights.

lightdash-mcp-server

A MCP (Model Context Protocol) server that provides MCP-compatible access to Lightdash's API. It allows AI assistants to interact with your Lightdash data through a standardized interface.

Features

Available tools:

list_projects - List all projects in the Lightdash organization
get_project - Get details of a specific project
list_spaces - List all spaces in a project
list_charts - List all charts in a project
list_dashboards - List all dashboards in a project
get_custom_metrics - Get custom metrics for a project
get_catalog - Get catalog for a project
get_metrics_catalog - Get metrics catalog for a project
get_charts_as_code - Get charts as code for a project
get_dashboards_as_code - Get dashboards as code for a project

Quick Start

Installation

Installing via Smithery

To install Lightdash MCP Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install lightdash-mcp-server --client claude

Manual Installation

npm install lightdash-mcp-server

Configuration

Set the following environment variables:

LIGHTDASH_API_KEY: Your Lightdash PAT (Personal Access Token)
LIGHTDASH_API_URL: The API base URL

Usage

Start the MCP server.

Directly with npx:

npx lightdash-mcp-server

Or run the installed module with node.

Configure your MCP JSON configuration:

{
  ...
  "lightdash": {
    "command": "npx",
    "args": [
      "-y",
      "lightdash-mcp-server"
    ],
    "env": {
      "LIGHTDASH_API_KEY": "<your PAT>",
      "LIGHTDASH_API_URL": "https://<your base url>"
    }
  },
  ...
}

Development

Available Scripts

npm run dev - Start the server in development mode with hot reloading
npm run build - Build the project for production
npm run start - Start the production server
npm run lint - Run linting checks (ESLint and Prettier)
npm run fix - Automatically fix linting issues
npm run examples - Run the example scripts

Contributing

Fork the repository
Create your feature branch
Run tests and linting: npm run lint
Commit your changes
Push to the branch
Create a Pull Request