SQL数据库自然语言查询服务

一个基于Model Context Protocol (MCP)的生产就绪服务器,通过VS Code扩展使AI助手能够通过自然语言查询与SQL数据库(MySQL、MariaDB、PostgreSQL、SQLite)交互。

  • by ahmad5599
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 ahmad5599/mysql-mcp-server

使用说明

SQL MCP服务器

一个具有VS Code扩展的生产就绪模型上下文协议(MCP)服务器,使AI助手能够通过自然语言查询与SQL数据库(MySQL、MariaDB、PostgreSQL、SQLite)进行交互。

🌟 特性

  • 🎯 MCP SDK集成 –基于 @modelcontextprotocol/sdk v1.18.2,完全支持JSON-RPC
  • 🔌 多数据库支持 MySQL/MariaDB、PostgreSQL和SQLite的统一接口
  • 🛡️ 安全第一 –默认情况下为只读模式,准备语句,标识符净化
  • 🚀 VS代码扩展 –带有配置文件管理的交互式配置向导
  • 📊 结构化日志记录 –多通道日志记录(stderr、磁盘、MCP控制台)
  • 🐳 Docker就绪 –生产优化的集装箱化部署
  • 🧪 已测试 –对所有驾驶员进行全面的集成测试

📋 目录

先决条件

  • Node.js ≥ 20.19.0
  • 以下数据库之一:
    • MySQL≥5.7或MariaDB≥10.3
    • PostgreSQL≥12
    • SQLite≥3.x(捆绑 test.db 包括快速试用)
  • VS Code ≥1.80.0(可选,用于扩展)

安装

服务器安装

选项1:从npm安装(推荐) ```bash npm安装-g@ahmad3244/sql-mcp服务器

或者不安装就使用

npx@ahmad3244/sqlmcp服务器 ```

选项2:从GitHub版本安装 ```bash npm安装https://github.com/ahmad5599/mysql-mcp-server/releases/download/v1.0.0/mysql-mcp-server-1.0.0.tgz ```

选项3:从源代码克隆和构建 ```bash 克隆https://github.com/ahmad5599/mysql-mcp-server.git cd-mysql-mcp服务器 npm安装 npm测试 ```

VS代码扩展安装

选项1:从GitHub版本下载(推荐) ```bash

下载VSIX

wgethttps://github.com/ahmad5599/mysql-mcp-server/releases/download/v1.0.0/sql-mcp-extension-1.0.0.vsix

安装扩展

代码--安装扩展sql-mcp-exptensin-1.0.0.vsix ```

选项2:从源代码构建 ```bash cd扩展名 npm安装 npx-vsce软件包 code--安装扩展名mysql-mcp-expension.vsix ```

快速开始

1.使用SQLite(无需设置)

```bash

如果全局安装

MYSQL_MCP_CONNECTION_STRING=“sqlite:///path/to/database.db“mysql-mcp服务器

使用npx

MYSQL_MCP_CONNECTION_STRING=“sqlite:///path/to/database.dbnpx@ahmad3244/sqlmcp服务器

来源

MYAsync MCP_CONNECION_STRING=“sqlite://$(pwd)/test.db”节点服务器.js ```

2.使用MySQL/MariaDB

```bash MYSQL_MCP_CONNECTION_STRING=“mysql://user:password@本地主机:3306/数据库“npx@ahmad3244/sql-mcp服务器 ```

3.使用PostgreSQL

```bash MYSQL_MCP_CONNECTION_STRING=“postgres://user:password@localhost:5432/数据库“npx@ahmad3244/sql-mcp服务器 ```

4.使用Docker

```bash docker运行--rm\ -e MYIN_MCP_CONNECION_STRING=“mysql://user:pass@host.docker.internal:3306/db”\ ahmad5599/sql-mcp服务器:最新版本 ```

VS代码扩展

安装向导

  1. 打开命令面板:“Ctrl+Shift+P”(Windows/Linux)或“Cmd+Shift+P”(Mac)
  2. 类型: “配置SQL MCP连接”
  3. 按照向导操作:
    • 选择数据库类型(SQLite、MySQL、PostgreSQL)
    • 输入配置文件名称(例如“我的生产数据库”)
    • 输入连接字符串

连接字符串格式

SQLite: ``` sqlite:///absolute/path/to/database.db ```

MySQL/MariaDB: ``` mysql://username:password@主机:端口/数据库 ```

PostgreSQL: ``` postgres://username:password@主机:端口/数据库 ```

在聊天中使用

配置后,在AI聊天中使用MCP工具:

``` #mcp_ahmad_sql-gat_list表 ```

``` #mcp_ahmad_sql-gat_query查询:从用户选择*限制10 ```

有关完整的文档,请参阅完整的README。

测试

```bash npm测试 ```

安全

  • ✅ 默认情况下为只读模式
  • ✅ 预处理语句
  • ✅ 标识符净化
  • ✅ 自动行限制

许可证

MIT许可证-请参阅 许可证 文件以获取详细信息。