zaj-MySQL-MCP

zaj-MySQL-MCP

site icon
2025.03.03 0
JavaScript数据库交互业务智能分析数据库
zaj-MySQL-MCP 是一个基于 Model Context Protocol (MCP) 的服务器实现,专门用于与 MySQL 数据库进行交互。它提供了数据库查询、表管理、业务数据分析以及自动生成业务洞察备忘录等功能。该服务器支持通过 SQL 查询来读取和修改数据库内容,同时能够分析数据库结构并生成业务洞察,适用于需要数据库交互和业务智能分析的场景。
View on GitHub

Overview

基本能力

产品定位

zaj-MySQL-MCP 是一个专为 MySQL 数据库设计的 MCP 服务器,旨在通过标准化的协议提供数据库交互和业务智能分析能力。

核心功能

  • 数据库查询:支持执行 SELECT、INSERT、UPDATE、DELETE 等 SQL 查询。
  • 表管理:创建和管理数据库表。
  • 数据库结构分析:列出所有表或查看特定表的结构信息。
  • 业务洞察生成:自动生成并存储业务洞察,更新到备忘录资源。

适用场景

  • 需要与 MySQL 数据库进行交互的应用开发。
  • 业务数据分析,自动生成业务洞察报告。
  • 数据库结构的管理和维护。

工具列表

  • Query Tools
  • read_query:执行 SELECT 查询,返回查询结果。
  • write_query:执行 INSERT、UPDATE 或 DELETE 查询,返回受影响的行数。
  • create_table:创建新表,返回创建确认。
  • Schema Tools
  • list_tables:列出数据库中的所有表。
  • describe_table:查看特定表的结构信息。
  • Analysis Tools
  • append_insight:添加业务洞察到备忘录资源。

常见问题解答

  • 如何配置数据库连接? 通过 .env 文件配置数据库连接信息,包括主机、端口、用户名、密码和数据库名。
  • 如何启动服务器? 克隆仓库后,安装依赖,构建并运行服务器。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。
  2. 确保已安装 MySQL 数据库并运行。

安装教程

  1. 克隆仓库: bash git clone https://github.com/zajTools/zaj-MySQL-MCP.git cd zaj-MySQL-MCP
  2. 配置 .env 文件: bash cp .env.example .env # 编辑 .env 文件,填入数据库连接信息
  3. 安装依赖: bash npm install
  4. 构建服务器: bash npm run build
  5. 运行服务器: bash node build/index.js

调试方式

  1. 确保服务器已正确启动并连接到数据库。
  2. 使用提供的工具进行查询或分析,例如: bash # 列出所有表 curl -X POST http://localhost:3000/list_tables
  3. 检查返回结果是否符合预期。

许可证

该项目遵循 MIT 开源许可条款。