MCP 服务器

Mcp Server

将您的 LLM 连接到 Firebolt 的模型上下文协议实现

firebolt-db

开发者工具

README

<h1 align="center">
  <br>
  <a href="https://www.firebolt.io"><img src="https://cdn.prod.website-files.com/5e8a264ceaf4870394477fc7/5e8a264ceaf4879f75477fdd_logo_website.svg" alt="Firebolt" width="300"></a>
  <br>
  MCP 服务器
  <br>
</h1>

<h4 align="center">
一个模型上下文协议的实现，将你的 LLM 连接到 Firebolt 数据仓库
</h4>

<p align="center">
  <a href="#key-features">主要特性</a> |
  <a href="#how-to-use">如何使用</a> |
  <a href="#connecting-your-llm">连接你的 LLM</a> |
  <a href="#architecture">架构</a> |
  <a href="#development">开发</a>
</p>

## 主要特性

**LLM 与 Firebolt 集成**

- 将你的 AI 助手直接连接到你的数据仓库
- 使 AI 代理能够自主查询数据并生成见解
- 为 LLM 提供关于 Firebolt SQL、特性和文档的深入知识

**SQL 查询执行**

- 支持多种查询类型和执行模式
- 直接访问 Firebolt 数据库

**文档访问**

- 授予 LLM 访问全面的 Firebolt 文档、SQL 参考、函数列表等

**账户管理**

- 与 Firebolt 服务账户无缝认证
- 连接到不同的引擎和工作区

**多平台支持**

- 在任何支持 Go 二进制文件的平台上运行
- 提供官方 Docker 镜像，方便部署

## 如何使用

开始之前，请确保你拥有一个 Firebolt [服务账户](https://docs.firebolt.io/Guides/managing-your-organization/service-accounts.html)，其中包含客户端 ID 和客户端密钥。

### 安装 MCP 服务器

你可以通过 Docker 或下载二进制文件来运行 Firebolt MCP 服务器。

#### 选项 1：使用 Docker 运行

[//]: # (x-release-please-start-version)
```bash
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

选项 2：运行二进制文件

# 从以下位置下载适用于你的操作系统的二进制文件：
# https://github.com/firebolt-db/mcp-server/releases/tag/v0.2.0

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

连接你的 LLM

安装 MCP 服务器后，你可以连接各种 LLM 客户端。

以下是 Claude Desktop 的集成示例。对于其他客户端，如 VSCode Copilot Chat 和 Cursor，请参考其官方文档。

Claude Desktop

要使用 Docker 与 Claude Desktop 集成：

打开 Claude 菜单并选择 Settings…。
导航到 Developer > Edit Config。

更新配置文件 (claude_desktop_config.json) 以包含：

{
  "mcpServers": {
    "firebolt": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--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"
      ]
    }
  }
}

要使用 binary 而不是 Docker：

{
  "mcpServers": {
    "firebolt": {
      "command": "/path/to/firebolt-mcp-server",
      "env": {
        "FIREBOLT_MCP_CLIENT_ID": "your-client-id",
        "FIREBOLT_MCP_CLIENT_SECRET": "your-client-secret"
      }
    }
  }
}

保存配置并重启 Claude Desktop。

更多详情：Claude MCP 快速入门指南

GitHub Copilot Chat (VSCode)

要将 MCP 与 VSCode 中的 Copilot Chat 集成，请参考官方文档：

👉 使用模型上下文协议扩展 Copilot Chat

Cursor 编辑器

要在 Cursor 中设置 MCP，请按照他们的指南进行操作：

👉 关于模型上下文协议的 Cursor 文档

架构

Firebolt MCP 服务器实现了模型上下文协议，提供：

工具 - 提供给 LLM 的特定于任务的功能：
- firebolt_docs: 访问 Firebolt 文档
- firebolt_connect: 建立与 Firebolt 引擎和数据库的连接
- firebolt_query: 执行针对 Firebolt 的 SQL 查询
资源 - 可以被 LLM 引用的数据：
- 文档文章
- 账户、数据库、引擎列表
提示 - LLM 的预定义指令：
- Firebolt 专家：提示模型充当 Firebolt 专家

开发

要设置开发环境：

# 克隆此存储库
git clone https://github.com/firebolt-db/mcp-server.git

# 进入存储库
cd mcp-server

# 安装 Task（如果你还没有安装）
go install github.com/go-task/task/v3/cmd/task@latest

# 更新 Go 依赖项
task mod

# 构建应用程序
task build

# 运行测试
tast test