Scansca - MCP Database Connector (under-development)

Scansca - MCP Database Connector (under-development)

site icon
2025.04.15 0
Go数据库连接器自然语言查询数据库
Scansca 是一个自托管的服务器,通过模型上下文协议(MCP)将大型语言模型(LLM)客户端与数据库系统连接起来。它使技术用户能够通过自然语言从多样化的数据环境中获取集成见解。
View on GitHub

Overview

基本能力

产品定位

Scansca 是一个数据库连接器,旨在通过 MCP 协议将 LLM 客户端与多种数据库系统集成,提供自然语言查询和数据库操作的能力。

核心功能

  • 多数据库支持:支持 PostgreSQL(未来将支持 MySQL、SQLite 和 DynamoDB)。
  • MCP 集成:与兼容 MCP 的 LLM 客户端无缝集成。
  • 自动模式发现:通过最小配置暴露数据库结构。
  • 简单 API:提供 RESTful 接口进行数据库操作。
  • Docker 支持:通过 Docker Compose 轻松部署。

适用场景

  • 技术用户需要通过自然语言查询数据库。
  • 需要将 LLM 客户端与多种数据库系统集成的场景。
  • 快速部署和测试数据库连接服务的场景。

工具列表

  • MCP 工具:通过 /mcp/v1/tools 列出可用工具,并通过 /mcp/v1/tools/:name/invoke 调用特定工具。
  • 文档工具:通过 make docs 启动文档服务器,查看详细文档。

常见问题解答

  • 许可证问题:非商业用途免费,商业和政府用途需要单独授权。
  • 数据库支持:目前仅支持 PostgreSQL,未来将扩展更多数据库类型。

使用教程

使用依赖

  • Go 1.22+:确保已安装 Go 1.22 或更高版本。
  • Docker 和 Docker Compose(可选):用于数据库依赖的容器化部署。

安装教程

# 克隆仓库
git clone https://github.com/royceleond/scansca.git
cd scansca

# 安装依赖
make deps

# 启动 PostgreSQL 数据库(可选)
make docker-compose

# 构建并运行服务器
make run

调试方式

# 构建项目
make build

# 运行测试
make test

# 启动服务器
make run

# 启动 PostgreSQL 使用 Docker Compose
make docker-compose

# 停止 Docker Compose 服务
make docker-compose-down

# 启动文档服务器
make docs

许可证

该项目遵循 Other 开源许可条款,请参阅 Other 了解完整条款。