Metabase MCP Server

🚀 Metabase MCP 服務器

Metabase MCP 服務器是一個將 AI 助手與 Metabase 分析平臺集成的模型上下文協議（Model Context Protocol）服務器，它能讓 AI 助手直接與您的分析數據交互，充當了分析平臺與對話式 AI 之間的橋樑。

🚀 快速開始

這個基於 TypeScript 的 MCP 服務器通過整合 Metabase API，使 AI 助手能夠直接交互您的分析數據。針對 Claude 和其他支持 MCP 的 AI 助手設計，您可以按照以下步驟開啟使用：

1. 進行安裝：使用 npm install metabase-mcp-server 完成安裝。
2. 啟動服務器：運行 node index.js 啟動服務器。

✨ 主要特性

• 資源訪問：使用直觀的 metabase:// URI 導航 Metabase 資源。
• 雙重身份驗證方法：支持基於會話和 API Key 的身份驗證。
• 結構化數據訪問：JSON 格式響應，便於 AI 助手消費。
• 詳細日誌記錄：詳細的日誌記錄以方便調試和監控。
• 錯誤處理：強大的錯誤處理和清晰的錯誤消息。

📦 安裝指南

使用 npm 進行安裝：

npm install metabase-mcp-server

💻 使用示例

基礎用法

配置文件示例：

const config = {
  metabaseUrl: 'https://your-metabase-instance.com',
  apiKey: 'your_api_key_here',
  logLevel: 'info'
};

// 初始化服務器
new MetabaseMCPServer(config);

高級用法

使用 Docker 進行容器化部署： 構建鏡像：

docker build -t metabase-mcp-server .

運行容器：

docker run -e METABASE_URL=https://your-metabase.com \
           -e METABASE_API_KEY=your_api_key \
           metabase-mcp-server

📚 詳細文檔

可用工具

該服務器為 AI 助手公開了以下工具：

• list_dashboards：獲取 Metabase 實例中的所有可用儀表板。
• list_cards：獲取所有保存的問題/卡片在 Metabase 中。
• list_databases：查看所有連接的數據庫源。
• execute_card：執行保存的問題並檢索結果，帶可選參數。
• get_dashboard_cards：提取特定儀表板中的所有卡片。
• execute_query：對任何連接的數據庫執行自定義 SQL 查詢。

配置

該服務器支持兩種身份驗證方法：

選項 1: 用戶名和密碼身份驗證

# 必要配置
METABASE_URL=https://your-metabase-instance.com
METABASE_USER_EMAIL=your_email@example.com
METABASE_PASSWORD=your_password

# 可選配置
LOG_LEVEL=info # 選項: debug, info, warn, error, fatal

選項 2: API Key 身份驗證

# 必要配置
METABASE_URL=https://your-metabase-instance.com
METABASE_API_KEY=your_api_key_here

環境變量

以下環境變量會被讀取：

• METABASE_URL：Metabase 實例的 URL 地址（必需）。
• METABASE_API_KEY：訪問 Metabase 的 API Key（僅在使用 API Key 身份驗證時必需）。
• LOG_LEVEL：日誌記錄級別（可選，默認為 info）。

調試

由於 MCP 服務器通過標準輸入輸出進行通信，可以使用 MCP 檢查器 進行調試：

npm run inspector

檢查器將提供一個基於瀏覽器的界面來監控請求和響應。

安全注意事項

⚠️ 重要提示

• 建議在生產環境中使用 API Key 身份驗證。
• 請妥善保管 API Key 和憑證。
• 考慮使用 Docker 密鑰或環境變量而不是硬編碼憑據。
• 應用適當網絡安全性措施以限制對 Metabase 實例的訪問。

貢獻

歡迎貢獻！請隨意提交 Pull Request。

作者：Hyeongjun Yu (@hyeongjun-dev)