lightdash-mcp-server

lightdash-mcp-server

site icon
2025.02.17 0
TypeScript数据分析数据可视化项目管理AI 集成开发效率数据库
lightdash-mcp-server 是一个基于 MCP(Model Context Protocol)的服务器,用于访问 Lightdash 平台。该服务器提供了与 Lightdash API 兼容的标准化接口,使 AI 助手能够通过统一的接口与 Lightdash 数据进行交互。 核心功能包括列出项目、获取项目详情、列出空间、列出图表、列出仪表板、获取自定义指标、获取目录、获取指标目录、获取图表代码和获取仪表板代码等。 适用场景包括数据分析、数据可视化、项目管理以及与 AI 助手集成等。
View on GitHub

Overview

基本能力

产品定位

lightdash-mcp-server 是一个基于 MCP(Model Context Protocol)的服务器,用于访问 Lightdash 平台,提供与 Lightdash API 兼容的标准化接口。

核心功能

  • list_projects - 列出 Lightdash 组织中的所有项目
  • get_project - 获取特定项目的详细信息
  • list_spaces - 列出项目中的所有空间
  • list_charts - 列出项目中的所有图表
  • list_dashboards - 列出项目中的所有仪表板
  • get_custom_metrics - 获取项目的自定义指标
  • get_catalog - 获取项目的目录
  • get_metrics_catalog - 获取项目的指标目录
  • get_charts_as_code - 获取项目的图表代码
  • get_dashboards_as_code - 获取项目的仪表板代码

适用场景

  • 数据分析
  • 数据可视化
  • 项目管理
  • 与 AI 助手集成

工具列表

  • list_projects - 列出所有项目
  • get_project - 获取项目详情
  • list_spaces - 列出项目空间
  • list_charts - 列出项目图表
  • list_dashboards - 列出项目仪表板
  • get_custom_metrics - 获取自定义指标
  • get_catalog - 获取项目目录
  • get_metrics_catalog - 获取指标目录
  • get_charts_as_code - 获取图表代码
  • get_dashboards_as_code - 获取仪表板代码

常见问题解答

使用教程

使用依赖

安装教程

npm install lightdash-mcp-server

配置

创建 .env 文件并填写 Lightdash API 凭证:

LIGHTDASH_API_KEY=your_api_key
LIGHTDASH_API_URL=https://app.lightdash.cloud/api/v1  # 或自定义 Lightdash 实例 URL

使用

  1. 启动 MCP 服务器:
npx lightdash-mcp-server
  1. 运行示例:
export EXAMPLES_CLIENT_LIGHTDASH_API_KEY=your_api_key
export EXAMPLES_CLIENT_LIGHTDASH_PROJECT_UUID=your_project_uuid
npm run examples

调试方式

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。