关键词

数据库访问LLM集成SQL查询数据管理AI工具

使用说明

项目简介

DB Guard 是一款为数据库提供AI接入能力的工具，它作为一个 MCP 服务器，允许大型语言模型 (LLM) 通过标准化的 Model Context Protocol (MCP) 协议，以工具调用的方式安全、可扩展地访问和操作数据库。

主要功能点

  • 数据库连接管理: 支持多种数据库连接配置和连接池管理。
  • 支持多种数据库: 目前已支持 Oracle 和 MySQL 数据库。
  • MCP Server 接口: 提供 MCP Server 服务，允许 LLM 客户端通过 SSE 等协议调用工具。
  • API 接口: 提供 RESTful API，方便直接进行数据库操作和管理。
  • 数据库元数据查询: 支持查询数据库表信息、表结构信息，并维护表和字段的注释。
  • SQL 执行: 支持执行查询和更新 SQL 语句。

安装步骤

  1. 环境准备: 确保已安装 JDK 17 或更高版本。
  2. 代码下载: 从 GitHub 仓库克隆代码到本地： 
    git clone https://github.com/ChoyRunYu/db-guard.git
cd db-guard
  3. 项目构建: 使用 Maven 构建项目： 
    mvn clean install
  4. 启动服务: 运行 Spring Boot 应用： 
    mvn spring-boot:run
    服务默认监听在 8083 端口。

服务器配置

MCP 客户端需要配置以下信息以连接到 DB Guard MCP 服务器。以下是 JSON 格式的配置示例，请根据实际情况调整 JAR 文件名和路径。

{
  "serverName": "db-guard-mcp-server",
  "command": "java",
  "args": [
    "-jar",
    "target/db-guard-0.0.1-SNAPSHOT.jar"
  ]
}
  • 'serverName': MCP 服务器的名称，可以自定义，用于在客户端标识服务器。
  • 'command': 启动服务器的命令，这里使用 'java' 命令。
  • 'args': 传递给 'java' 命令的参数列表：
    • '-jar': 指定运行 JAR 文件。
    • 'target/db-guard-0.0.1-SNAPSHOT.jar': DB Guard 服务构建后的 JAR 文件路径。请确保此路径与实际 JAR 文件位置一致（通常在 'target' 目录下，版本号可能会有差异）。

基本使用方法

  1. 启动 DB Guard 服务器：按照安装步骤启动 DB Guard 服务。

  2. 配置 MCP 客户端: 在 LLM 客户端中，配置上述服务器信息，建立与 DB Guard MCP 服务器的连接。

  3. 工具调用: LLM 可以通过 MCP 协议调用 DB Guard 提供的工具，例如：

    • 'queryDatabaseResource': 获取数据库连接资源列表。
    • 'queryTables': 获取指定数据库的所有表名。
    • 'queryTableField': 获取指定数据表的字段详情。
    • 'querySql': 执行 SQL 查询语句。
    • 'updateSql': 执行 SQL 更新语句。

    具体的工具名称、描述和参数信息，请参考 'src/main/java/cn/com/choy/dbguard/service/McpService.java' 文件中的 '@Tool' 注解。

  4. SSE 路径: DB Guard MCP Server 的 SSE (Server-Sent Events) 路径为 'localhost:8083/sse'，MCP 客户端可能需要配置此路径进行连接。

信息

分类

数据库与文件

访问项目