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)