返回 MCP 目录
public公开dns本地运行

mcp-server-sql

一个基于Spring Boot的SQL服务应用,提供SQL查询和更新功能,支持结果导出为CSV文件,是Spring AI MCP框架的组成部分。

article

README

🚀 mcp-server-Sql

这是一个基于Spring Boot的SQL服务应用,可执行SQL查询并将结果写入文件。作为Spring AI MCP(模型、聊天、提示)框架的一部分,它提供了强大的SQL查询和更新操作功能,为数据处理和管理提供便利。

🚀 快速开始

配置数据库

application.yml文件中配置您的数据库连接信息:

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai
    username: your_username
    password: your_password

构建项目

mvn clean package

运行应用

java -jar target/mcp-server-Sql-1.0-SNAPSHOT.jar

✨ 主要特性

  • 执行SQL查询并将结果写入CSV文件
  • 执行SQL更新操作(INSERT, UPDATE, DELETE)并返回影响的行数
  • 支持自定义数据库连接配置
  • 集成Spring AI MCP框架,可作为AI工具使用

📦 安装指南

配置数据库

application.yml文件中配置数据库连接信息,示例如下:

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai
    username: your_username
    password: your_password

构建项目

使用以下命令构建项目:

mvn clean package

运行应用

通过以下命令运行应用:

java -jar target/mcp-server-Sql-1.0-SNAPSHOT.jar

💻 使用示例

基础用法

执行SQL查询

{
  "sql": "SELECT * FROM users",
  "outputPath": "./output/users.csv"
}

执行SQL更新操作

{
  "sql": "UPDATE users SET name='John' WHERE id=1",
  "outputPath": "./output/update_result.txt"
}

🔧 技术细节

技术栈

  • Java 17
  • Spring Boot 3.4.3
  • Spring AI 1.0.0 - M6
  • MySQL 8.0
  • HikariCP 连接池
  • Lombok

📄 许可证

暂未提供相关许可证信息。

⚠️ 重要提示

  • 确保输出目录存在或有权限创建。
  • SQL查询结果将以CSV格式保存。
  • 更新操作结果将包含影响的行数和执行时间。
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端