Syucream Lightdash MCP Server

🚀 lightdash-mcp-server

lightdash-mcp-server 是一個支持 MCP（模型上下文協議） 的服務器，它能夠連接到 Lightdash。該服務器提供與 Lightdash API 兼容的 MCP 訪問權限，允許 AI 助手通過標準化接口與您的 Lightdash 數據進行交互，為數據處理和分析帶來便利。

✨ 主要特性

本服務器提供了豐富的可用工具，具體如下：

• 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 - 以代碼形式獲取儀表盤

🚀 快速開始

📦 安裝指南

使用以下命令安裝 lightdash-mcp-server：

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

2. 查看示例用法，請參考 examples 目錄。要運行示例，首先設置所需的環境變量，然後運行示例腳本：

# 設置所需的環境變量
export EXAMPLES_CLIENT_LIGHTDASH_API_KEY=your_api_key
export EXAMPLES_CLIENT_LIGHTDASH_PROJECT_UUID=your_project_uuid

# 運行示例
npm run examples

🔧 技術細節

開發

可用腳本

• npm run dev - 以開發模式啟動服務器，支持熱重載
• npm run build - 構建項目以便生產使用
• npm run start - 啟動生產服務器
• npm run lint - 運行代碼檢查（ESLint 和 Prettier）
• npm run fix - 自動修復代碼格式問題
• npm run examples - 運行示例腳本

貢獻指南

1. 分叉倉庫
2. 創建功能分支
3. 運行測試和代碼檢查：npm run lint
4. 提交更改
5. 推送到分支
6. 創建拉取請求