gokeep-projects/mysql-mcp-server

🌟 基于Quarkus的轻量级mysql MCP服务

mysql MCP Server 是一个基于 Model Context Protocol (MCP) 标准的高性能服务器实现，专门为mysql数据源提供AI助手交互能力。本项目采用 Quarkus框架 构建，具有以下核心优势：

🚀 核心特性

🎯 支持的工具功能

• 🔍 查询数据库 - 查询数据有哪些
• 📋 查询数据库表 - 查询数据库表有哪些
• 🗺️ 查询表结构 - 查询表结构
• 📝 SQL查询 - 通过SQL语句执行sql查询
• 后续功能根据实际需求和issue持续更新...

🚀 快速开始

📋 环境要求

• Java 17+ - 推荐使用JDK 21 版本或更高，云原生打包需要grallvm版本jdk支持
• Maven 3.8+ - 项目构建工具
• mysql 5.x,6.x,7.x,8.x,9.xx - 支持的mysql版本

🏃‍♂️ 立即运行

• 点击Release下载对应的启动包，如mysql-mcp-server-runner.jar

  [!CAUTION]

  注意：以下示例启动方式默认连接本地127.0.0.1:3306，未设置密码连接，如需要改动地址或设置密码，请参考🔧 启动参数指定参数或环境变量来启动应用

  1. （Anything）mysql-mcp-server-runner.jar 启动方式

  [!NOTE]

  需要依赖本地环境安装JDK21+，但是该包不依赖任何架构，可以在任意架构运行

  java -jar mysql-mcp-server-runner.jar
  #该启动方式默认连接本地http://localhost:9200，未设置密码连接，如需要改动地址或设置密码请参考🔧快速配置指定参数或环境变量
  

  2. （Windows）mysql-mcp-server-runner.exe 启动方式

  ./mysql-mcp-server-runner.exe
  # 或者双击运行均可
  

  3. （Linux） mysql-mcp-server-runner 启动方式

  chmod 755 mysql-mcp-server-runner
  ./mysql-mcp-server-runner
  

🔗 MCP连接

[!NOTE]

启动完成后，会自动启动sse和streamable两种通信方式, 并默认监听 0.0.0.0:29000

sse的endpoint为: /mcp/sse

streamable的endpoint为：/mcp

• streamable: http://{ip}:29000/mcp

• sse: http://{ip}:29000/mcp/sse

🔧 启动参数

[!NOTE]

启动参数非必须的，比如需要连接远程mysql，或者需要设置用户名密码，以下两种启动参数设置，二选一即可

#### 1. 命令行启动参数

mysql.host=<your-es-server-address>
mysql.username=<Your username>
mysql.password=<Your password>
mysql.database=<your db name>

该命令行方式启动示例入下：

java -jar mysql-mcp-server-runner.jar -Dmysql.host=127.0.0.1 -Dmysql.port=3306 -Dmysql.username=<Your username> -Dmysql.password=<Your password> -Dmysql.database=<Your database name>

2. 环境变量设置启动参数

# 临时生效以下环境变量，如果写入/etc/profile，也不用每次指定)：
export MYSQL_HOST=<your-mysql-server-host>
export MYSQL_PORT=<your-mysql-server-port>
export MYSQL_USERNAME=<your-mysql-useranme>
export MYSQL_PASSWORD=<your_password>
export MYSQL_DATABASE=<your_database_name>

该环境变量方式启动示例入下(需要再指定配置，会自动读取环境变量值

java -jar mysql-mcp-server-runner.jar

📦 项目构建

🏗️ 构建选项

本项目基于 Quarkus 构建，提供两种构建模式：

1. JVM模式构建（常用构建方式，无任何工具依赖）

# 清理并打包
./mvnw clean package
或者
mvn clean package

# 生成的文件
# target/mysql-mcp-server-runner.jar
# target/lib/ - 依赖库目录

2. 原生模式构建（如果需要云原生或对性能有极致要求）

# 原生镜像构建（需要安装GraalVM）
./mvnw package -Dnative
或者
mvn package -Dnative

# 生成的文件
# target/mysql-mcp-server-runner
# 特点：启动更快，内存占用更低

📊 性能对比

🛠️ 项目部署

🖥️ 传统部署

1. JVM模式部署

# 上传jar包和lib目录到服务器
scp target/mysql-mcp-server-runner.jar user@server:/opt/
scp -r target/lib user@server:/opt/

# 在服务器上运行
java -jar /opt/mysql-mcp-server-runner.jar

2. 原生模式部署

# 上传原生可执行文件
scp target/mysql-mcp-server-runner user@server:/opt/

# 在服务器上运行
./mysql-mcp-server-runner

🐳 Docker部署

敬请期待，当前版本仅支持传统部署，后续肯定考虑支持，如有需要，可以在issue说出您的需求

🔧 二次开发

📁 项目结构

mysql-mcp-server/
├── src/main/java/org/gokeep/elasticsearch/mcp/server
│   ├── BaseMcpServer.java           # 基础抽象类
│   ├── SqlGe.java          # sql
│   └── MySqlMcpServer.java  # 主服务类
├── src/main/resources/
│   └── application.properties       # 配置文件
├── pom.xml              # Maven配置文件
└── README.md            # 项目文档

🛠️ 添加新工具

要添加新的mysql操作工具，只需在 MysqlMcpServer.java 中添加新方法：

@Tool(description = "CN: 自定义mysql操作\nEN: Custom mysql operation")
public ToolResponse customOperation(
        @ToolArg(description = "参数描述") String param) throws Exception {
    return ToolResponse.success(response);
}

📚 二次开发文档

核心依赖

• Quarkus 3.27.0 - 核心框架
• quarkus-mcp-server-sse 1.6.1 - MCP服务器实现
• quarkus-rest-client-jackson - REST客户端
• Java 21 - 编程语言

配置参考

# 服务器配置
quarkus.http.port=8080

# mysql配置
mysql.host=127.0.0.1
mysql.port=3306
mysql.username=
mysql.password=
mysql.database=

测试工具

# 运行测试
./mvnw test

# 集成测试
./mvnw verify

# 开发模式（支持热部署）
./mvnw quarkus:dev

📄 许可证

本项目采用 [MIT](MIT License) 许可证，支持任何商用和任何修改，无需版权声明

🤝 贡献

欢迎提交Issue和Pull Request来改进这个项目！