基本能力
产品定位
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 安装
bash
npx -y @smithery/cli install lightdash-mcp-server --client claude
手动安装
bash
npm install lightdash-mcp-server
配置
需要配置以下环境变量:
- LIGHTDASH_API_KEY
: 您的 Lightdash PAT
- LIGHTDASH_API_URL
: API 基础 URL
使用方法
-
启动 MCP 服务器
bash
npx lightdash-mcp-server
或运行已安装的模块 -
编辑 MCP 配置 JSON
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
: 运行示例脚本