Syucream Lightdash MCP Server

🚀 lightdash-mcp-server

A server supporting MCP (Model Context Protocol), connecting to Lightdash.

This server provides MCP access compatible with the Lightdash API, allowing AI assistants to interact with your Lightdash data through a standardized interface.

✨ Features

Available tools:

• list_projects - List all projects in the organization
• get_project - Get detailed information about 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 in a project
• get_catalog - Get the catalog information of a project
• get_metrics_catalog - Get the metrics catalog of a project
• get_charts_as_code - Get charts as code
• get_dashboards_as_code - Get dashboards as code

🚀 Quick Start

📦 Installation

npm install lightdash-mcp-server

Configuration

Create a .env file containing 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, refer to the examples directory. To run the examples:

# Set the required environment variables
export EXAMPLES_CLIENT_LIGHTDASH_API_KEY=your_api_key
export EXAMPLES_CLIENT_LIGHTDASH_PROJECT_UUID=your_project_uuid

# Run the examples
npm run examples

🔧 Technical Details

Available Scripts

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

Contribution Guidelines

1. Fork the repository
2. Create a feature branch
3. Run tests and code checks: npm run lint
4. Commit your changes
5. Push to the branch
6. Create a pull request