lightdash-mcp-server
About
lightdash-mcp-server is an MCP (Model Context Protocol) server that provides AI assistants with standardized access to the Lightdash API. It allows users to explore and retrieve data from their Lightdash projects, including projects, spaces, charts, dashboards, and metrics.
Explore
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
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
lightdash-mcp-serverCommand (node, npx, python, etc.)Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
npm install lightdash-mcp-server
export EXAMPLES_CLIENT_LIGHTDASH_API_KEY=your_api_key
export EXAMPLES_CLIENT_LIGHTDASH_PROJECT_UUID=your_project_uuid
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"lightdash-mcp-server": {
"syucream_lightdash-mcp-server": {
"command": "npx",
"args": [
"lightdash-mcp-server"
]
}
}
}
}McpServers
{
"syucream_lightdash-mcp-server": {
"command": "npx",
"args": [
"lightdash-mcp-server"
]
}
}A MCP(Model Context Protocol) server that accesses to Lightdash.
This server provides MCP-compatible access to Lightdash's API, allowing 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
npm install lightdash-mcp-server
Configuration
Create a .env file with your Lightdash API credentials:
LIGHTDASH_API_KEY=your_api_key
LIGHTDASH_API_URL=https://app.lightdash.cloud/api/v1 # or your custom Lightdash instance URL
Usage
1. Start the MCP server:
npx lightdash-mcp-server
2. For example usage, check the examples directory. To run the example:
```bash
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
