article
README
🚀 MCP 服务器
MCP 服务器是一款实现模型上下文协议(Model Context Protocol)的实用工具,它能将大语言模型(LLM)与 Firebolt 数据仓库无缝连接。借助该协议,AI 代理可自主查询数据、生成见解,还能访问 Firebolt 的文档、SQL 参考和函数列表等资源。
🚀 快速开始
步骤一:下载代码
git clone https://github.com/firebolt/mcp-server.git
cd mcp-server
步骤二:安装依赖
go mod tidy
步骤三:运行示例
# 启动开发服务器
go run main.go --help
✨ 主要特性
LLM 集成
- 直接将 AI 模型与 Firebolt 数据仓库连接。
- 提供任务特定能力(工具)。
- 提供可引用的数据资源。
- 提供预定义的提示指令。
功能模块
- 工具
firebolt_docs:访问 Firebolt 文档。firebolt_connect:建立与 Firebolt 引擎和数据库的连接。firebolt_query:执行 SQL 查询。
- 资源
- 文档文章列表。
- 账户、数据库、引擎信息。
- 提示
- 指示模型以 Firebolt 专家的身份进行响应。
📦 安装指南
方式一:Docker 安装
# 拉取镜像
docker pull firebolt/mcp-server:latest
# 运行容器
docker run -it --rm firebolt/mcp-server:latest
方式二:二进制安装
1. 下载最新版本
访问 Firebolt 官网 下载对应平台的二进制文件。
2. 解压并运行
# 解压文件
tar -xzf mcp-server_{version}_{platform}.tar.gz
# 运行服务器
./mcp-server --help
配置参数
- --bind-address:指定绑定地址,默认为
0.0.0.0。 - --port:指定监听端口,默认为
12345。 - --log-level:设置日志级别,可选值为 debug、info、warning、error,默认为 info。
- --config-file:指定配置文件路径。
💻 使用示例
配置示例
# 启动服务器并指定配置文件
./mcp-server --config-file config.yaml
配置文件格式
bind_address: "0.0.0.0"
port: 12345
log_level: "info"
enable_metrics: true
metrics_port: 9001
📚 详细文档
环境变量配置
可以通过设置以下环境变量来覆盖默认配置: | 属性 | 详情 | |------|------| | FIREBOLT_MCP_BIND_ADDR | 绑定地址,默认值为 "0.0.0.0" | | FIREBOLT_MCP_PORT | 监听端口,默认值为 12345 | | FIREBOLT_MCP_LOG_LEVEL | 日志级别,默认值为 "info" | | FIREBOLT_MCP_METRICS | 是否启用度量,默认值为 true | | FIREBOLT_MCP_METRICS_PORT | 度量端口,默认值为 9001 |
扩展阅读
问题反馈
如有任何问题或建议,请联系:
- 邮箱:support@firebolt.com
- 电话:+1 (501) 222-3333
📄 许可证
本项目遵循 MIT License,代码和文档均可自由使用、修改和分发。
微信扫一扫