# lightdash-mcp-server

> MCP Server

This repository provides a Model Context Protocol (MCP) server for accessing Lightdash data. It enables AI assistants to interact with Lightdash through a standardized interface, offering tools to manage projects,

## Overview

- **Category:** AI
- **Language:** JavaScript
- **Stars:** 26
- **Forks:** 2
- **Owner:** syucream
- **GitHub:** https://github.com/syucream/lightdash-mcp-server
- **Homepage:** https://www.npmjs.com/package/lightdash-mcp-server
- **Created:** 2025-01-01T09:58:01+00:00
- **Updated:** 2025-03-26T16:47:10+00:00
- **Source:** https://model-context-protocol.com/servers/lightdash-model-context-protocol-mcp-server

## Setup

## Setup

### Installation

#### Installing via Smithery

To install Lightdash MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@syucream/lightdash-mcp-server):

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

#### Manual Installation
```bash
npm install lightdash-mcp-server
```

### Configuration

- `LIGHTDASH_API_KEY`: Your Lightdash PAT
- `LIGHTDASH_API_URL`: The API base URL

### Usage

1. Start the MCP server.

Directly:
```bash
npx lightdash-mcp-server
```
Or, run the installed module with node.

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

## Tools

## Available Tools

1. `list_projects` (List all projects in the Lightdash organization)
2. `get_project` (Get details of a specific project)
3. `list_spaces` (List all spaces in a project)
4. `list_charts` (List all charts in a project)
5. `list_dashboards` (List all dashboards in a project)
6. `get_custom_metrics` (Get custom metrics for a project)
7. `get_catalog` (Get catalog for a project)
8. `get_metrics_catalog` (Get metrics catalog for a project)
9. `get_charts_as_code` (Get charts as code for a project)
10. `get_dashboards_as_code` (Get dashboards as code for a project)