项目简介

Firebolt MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,旨在将您的 LLM 应用连接到 Firebolt 数据仓库。通过提供结构化的上下文信息和功能,它使得 LLM 能够更智能地与 Firebolt 数据仓库进行交互,例如执行 SQL 查询、访问文档和管理 Firebolt 资源。

主要功能点

  • LLM 与 Firebolt 数据仓库集成: 直接将您的 AI 助手连接到 Firebolt 数据仓库,让 LLM 具备访问和分析 Firebolt 中数据的能力。
  • SQL 查询执行: 支持 LLM 执行 SQL 查询,直接从 Firebolt 数据仓库获取数据和洞察。
  • Firebolt 文档访问: 允许 LLM 访问全面的 Firebolt 文档,包括 SQL 参考、函数列表等,提升 LLM 对 Firebolt 的理解和应用能力。
  • 账户管理: 通过 Firebolt 服务账户进行身份验证,安全地连接到不同的 Firebolt 引擎和工作区。
  • 多平台支持: 可以运行在任何支持 Go 二进制文件的平台上,并提供官方 Docker 镜像,方便部署。

安装步骤

方式一:使用 Docker 运行

  1. 确保您已安装 Docker。

  2. 打开终端,复制并执行以下命令,替换 'your-client-id' 和 'your-client-secret' 为您的 Firebolt 服务账户凭据。

    docker run \
      --rm \
      -e FIREBOLT_MCP_CLIENT_ID=your-client-id \
      -e FIREBOLT_MCP_CLIENT_SECRET=your-client-secret \
      ghcr.io/firebolt-db/mcp-server:0.2.0

方式二:运行二进制文件

  1. Releases 页面 下载适用于您操作系统的二进制文件。

  2. 解压下载的文件,并在终端中导航到解压目录。

  3. 执行以下命令,替换 'your-client-id' 和 'your-client-secret' 为您的 Firebolt 服务账户凭据。

    ./firebolt-mcp-server \
      --client-id your-client-id \
      --client-secret your-client-secret

服务器配置

以下是 MCP 客户端(例如 Claude Desktop)连接到 Firebolt MCP Server 的配置示例 (JSON 格式)。您需要配置 MCP 服务器的启动命令及其参数,以便 MCP 客户端能够正确连接。

{
  "mcpServers": {
    "firebolt": {
      "command": "docker",  // 或者 "/path/to/firebolt-mcp-server" (如果您使用二进制文件)
      "args": [  // 启动命令的参数,Docker 方式
        "run",
        "-i",
        "--rm",
        "-e", "FIREBOLT_MCP_CLIENT_ID=your-client-id",  // Firebolt 服务账户 Client ID,请替换为您的实际 Client ID
        "-e", "FIREBOLT_MCP_CLIENT_SECRET=your-client-secret", // Firebolt 服务账户 Client Secret,请替换为您的实际 Client Secret
        "ghcr.io/firebolt-db/mcp-server:0.2.0"
      ]
      // 如果您使用二进制文件,可以使用 "env" 字段配置环境变量:
      // "env": {
      //   "FIREBOLT_MCP_CLIENT_ID": "your-client-id",  // Firebolt 服务账户 Client ID,请替换为您的实际 Client ID
      //   "FIREBOLT_MCP_CLIENT_SECRET": "your-client-secret" // Firebolt 服务账户 Client Secret,请替换为您的实际 Client Secret
      // }
    }
  }
}

注意: 请将 'your-client-id' 和 'your-client-secret' 替换为您在 Firebolt 中创建的服务账户的 Client ID 和 Client Secret。具体的配置方法请参考您使用的 MCP 客户端的官方文档 (例如 Claude Desktop, VSCode Copilot Chat, Cursor)。

基本使用方法

  1. 启动 Firebolt MCP Server (按照安装步骤)。
  2. 配置您的 MCP 客户端 (例如 Claude Desktop, VSCode Copilot Chat, Cursor) 连接到 Firebolt MCP Server (参考服务器配置)。
  3. 在 MCP 客户端中,您可以指示 LLM 使用 'firebolt_docs' 工具来查询 Firebolt 文档,使用 'firebolt_connect' 工具来获取 Firebolt 账户、数据库和引擎信息,使用 'firebolt_query' 工具来执行 SQL 查询。
  4. 通过自然语言与 LLM 交互,利用 Firebolt MCP Server 提供的工具和资源,完成与 Firebolt 数据仓库相关的任务。

信息

分类

数据库与文件