Scansca - MCP 数据库连接器 (开发中)

Scansca 是一个可自托管的服务器，它通过模型上下文协议 (MCP) 将大型语言模型 (LLM) 客户端与数据库系统连接起来。它使技术用户能够使用自然语言从不同的数据环境中获得集成的见解。

特性

• 多数据库支持: 连接到 PostgreSQL (MySQL、SQLite 和 DynamoDB 即将推出)
• MCP 集成: 与 MCP 兼容的 LLM 客户端无缝集成
• 自动模式发现: 以最小的配置公开数据库结构
• 简单 API: 用于数据库操作的 RESTful 接口
• Docker 就绪: 使用 Docker Compose 轻松部署

快速开始

前提条件

• Go 1.22+
• Docker 和 Docker Compose (可选，用于数据库依赖项)

安装

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

# 安装依赖
make deps

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

# 构建并运行服务器
make run

基本用法

注册数据库

curl -X POST http://localhost:8080/api/v1/databases \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-postgres",
    "type": "postgresql",
    "connection_string": "postgres://scansca_user:scansca_password@localhost:5432/scansca"
  }'

执行查询

curl -X POST http://localhost:8080/api/v1/query \
  -H "Content-Type: application/json" \
  -d '{
    "database": "my-postgres",
    "query": "SELECT current_database(), current_user"
  }'

与 LLM 客户端一起使用

对于 MCP 兼容的 LLM 客户端，Scansca 在以下端点公开：

GET  /mcp/v1/tools               # 列出可用工具
POST /mcp/v1/tools/:name/invoke  # 调用特定工具

文档

通过运行以下命令查看文档：

make docs

这将在端口 8080 上启动一个文档服务器（可以使用 DOCS_PORT 配置）。

有关更多信息，请参阅在线文档。

架构

┌──────────────────────────┐
│      MCP 客户端           │
│  (LLM, CLI, 应用程序)  │
└──────────────┬───────────┘
               │
               ▼
┌──────────────────────────┐
│    Scansca MCP 服务器     │  用于数据库操作和 MCP 协议支持的 HTTP API
│                           │
├──────────────────────────┤
│    数据库连接器    │  用于不同数据库系统的统一接口
└──────────────┬───────────┘
               │
               ▼
┌──────────────────────────┐
│      数据库服务器     │
│  (Postgres, MySQL 等)   │
└──────────────────────────┘

开发

# 构建项目
make build

# 运行测试
make test

# 启动服务器
make run

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

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

# 启动文档服务器
make docs

项目结构

scansca/
├── cmd/          # 应用程序入口点
├── config/       # 配置文件
├── docker/       # Docker 配置
├── docs/         # 文档
├── internal/     # 私有实现
│   ├── db/       # 数据库连接和模型
│   ├── server/   # HTTP 服务器和 API
│   └── mcp/      # MCP 协议实现
└── Makefile      # 构建自动化

许可证

本项目根据 Scansca 软件许可证 授权，该许可证允许：

• 免费用于非商业目的、非营利组织和小型实体（收入/资产低于 10,000 美元）
• 商业和政府用途需要获得作者的单独许可

请参阅 LICENSE 文件以获取完整详细信息。

贡献

欢迎贡献！请随时提交 Pull Request。