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 organizationget_project
- Get details of a specific projectlist_spaces
- List all spaces in a projectlist_charts
- List all charts in a projectlist_dashboards
- List all dashboards in a projectget_custom_metrics
- Get custom metrics for a projectget_catalog
- Get catalog for a projectget_metrics_catalog
- Get metrics catalog for a projectget_charts_as_code
- Get charts as code for a projectget_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:
1npx -y @smithery/cli install lightdash-mcp-server --client claude
Manual Installation
1npm install lightdash-mcp-server
Configuration
LIGHTDASH_API_KEY
: Your Lightdash PATLIGHTDASH_API_URL
: The API base URL
Usage
- Start the MCP server.
Directly:
1npx lightdash-mcp-server
Or, run the installed module with node.
- Edit your MCP configuration json:
1... 2 "lightdash": { 3 "command": "npx", 4 "args": [ 5 "-y", 6 "lightdash-mcp-server" 7 ], 8 "env": { 9 "LIGHTDASH_API_KEY": "<your PAT>", 10 "LIGHTDASH_API_URL": "https://<your base url>" 11 } 12 }, 13...
Development
Available Scripts
npm run dev
- Start the server in development mode with hot reloadingnpm run build
- Build the project for productionnpm run start
- Start the production servernpm run lint
- Run linting checks (ESLint and Prettier)npm run fix
- Automatically fix linting issuesnpm 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