lightdash-mcp-server

lightdash-mcp-server

site icon
2025.03.27 13
JavaScript数据分析API 集成开发效率数据库
lightdash-mcp-server 是一个基于 MCP(Model Context Protocol)协议的服务器,用于访问 Lightdash 的 API。它提供了一个标准化的接口,允许 AI 助手通过 MCP 协议与 Lightdash 数据进行交互。该服务器支持多种工具,包括列出项目、获取项目详情、列出空间、图表、仪表板等,以及获取自定义指标和目录信息。适用于需要与 Lightdash 数据交互的开发场景,特别是那些希望通过 AI 助手自动化处理 Lightdash 数据的用户。
View on GitHub

Overview

基本能力

产品定位

lightdash-mcp-server 是一个基于 MCP 协议的服务器,用于标准化访问 Lightdash 的 API,使 AI 助手能够通过 MCP 协议与 Lightdash 数据进行交互。

核心功能

  • 列出 Lightdash 组织中的所有项目
  • 获取特定项目的详细信息
  • 列出项目中的所有空间
  • 列出项目中的所有图表
  • 列出项目中的所有仪表板
  • 获取项目的自定义指标
  • 获取项目的目录信息
  • 获取项目的指标目录
  • 以代码形式获取项目的图表
  • 以代码形式获取项目的仪表板

适用场景

  • 需要通过 AI 助手自动化处理 Lightdash 数据的开发场景
  • 需要与 Lightdash 数据进行标准化交互的应用开发

工具列表

  • 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: 以代码形式获取项目的仪表板

常见问题解答

使用教程

使用依赖

无明确前置依赖,但需要 Node.js 环境。

安装教程

通过 Smithery 安装

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

手动安装

npm install lightdash-mcp-server

配置

需要配置以下环境变量: - LIGHTDASH_API_KEY: 您的 Lightdash PAT - LIGHTDASH_API_URL: API 基础 URL

使用方法

  1. 启动 MCP 服务器
npx lightdash-mcp-server

或运行已安装的模块

  1. 编辑 MCP 配置 JSON
...
    "lightdash": {
      "command": "npx",
      "args": [
        "-y",
        "lightdash-mcp-server"
      ],
      "env": {
        "LIGHTDASH_API_KEY": "<your PAT>",
        "LIGHTDASH_API_URL": "https://<your base url>"
      }
    },
...

调试方式

无明确调试命令,但可以使用以下开发脚本: - npm run dev: 以开发模式启动服务器,支持热重载 - npm run examples: 运行示例脚本

许可证

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