lightdash-mcp-server

一个可以访问 Lightdash 的 MCP（模型上下文协议） 服务器。

该服务器提供与 Lightdash API 兼容的 MCP 访问，允许 AI 助手通过标准化接口与您的 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 - 以代码形式获取项目中的仪表板

快速开始

安装

通过 Smithery 安装

要通过 Smithery 自动为 Claude Desktop 安装 Lightdash MCP 服务器：

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

手动安装

npm install lightdash-mcp-server

配置

创建一个包含 Lightdash API 凭证的 .env 文件：

LIGHTDASH_API_KEY=your_api_key
LIGHTDASH_API_URL=https://app.lightdash.cloud  # or your custom Lightdash instance URL

使用

1. 启动 MCP 服务器。

直接启动：

npx lightdash-mcp-server

或者使用 Node 运行已安装的模块。

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 build - 构建生产环境项目
• npm run start - 启动生产服务器
• npm run lint - 运行代码检查 (ESLint 和 Prettier)
• npm run fix - 自动修复代码风格问题
• npm run examples - 运行示例脚本

贡献

1. Fork 仓库
2. 创建功能分支
3. 运行测试和代码检查：npm run lint
4. 提交更改
5. 推送到分支
6. 创建 Pull Request