关键词

MySQL数据库SQLLLM数据访问

使用说明

项目简介

MySQL MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务，旨在为大型语言模型 (LLM) 提供与 MySQL 数据库交互的能力。通过该服务器，LLM 可以执行 SQL 查询、获取数据库表信息，从而实现数据访问和处理等功能。

主要功能点

  • 执行 SQL 查询: 允许 LLM 执行任意 SQL 查询语句，并返回查询结果或执行状态。
  • 列出数据库表: 提供列出数据库中所有表的功能，方便 LLM 了解数据库结构。
  • 描述表结构: 允许 LLM 获取指定表的详细结构信息，包括字段名、数据类型等。

安装步骤

  1. 安装Python环境: 确保你的机器上安装了 Python 3.7 或更高版本。
  2. 安装依赖: 使用pip安装项目依赖。在仓库根目录下（假设 'src/server.py' 在根目录的 'src' 文件夹下），打开终端并执行： 
    pip install mcp-server mysql-connector-python python-dotenv

服务器配置

MCP 客户端需要配置以下信息以连接到 MySQL MCP Server。配置信息为 JSON 格式，请提供给 MCP 客户端：

{
  "serverName": "MySQL-MCP-Server",
  "command": "python",
  "args": ["src/server.py"],
  "transports": ["stdio"]
}

参数说明:

  • 'serverName': 服务器名称，可以自定义。
  • 'command': 启动服务器的命令，这里使用 'python' 解释器。
  • 'args': 启动命令的参数，这里指定服务器脚本的路径 'src/server.py'。
  • 'transports': 服务器支持的传输协议，这里使用 'stdio' 标准输入输出流。

环境变量配置: MySQL MCP Server 依赖以下环境变量连接到 MySQL 数据库，请确保在使用前配置好这些环境变量：

  • 'MYSQL_HOST': MySQL 服务器地址。
  • 'MYSQL_PORT': MySQL 服务器端口，默认为 '3306'。
  • 'MYSQL_USER': MySQL 数据库用户名。
  • 'MYSQL_PASSWORD': MySQL 数据库密码。
  • 'MYSQL_DATABASE': 要连接的 MySQL 数据库名。

你可以在项目根目录下创建 '.env' 文件，并在其中配置这些环境变量，例如：

MYSQL_HOST=your_mysql_host
MYSQL_PORT=3306
MYSQL_USER=your_mysql_user
MYSQL_PASSWORD=your_mysql_password
MYSQL_DATABASE=your_mysql_database

基本使用方法

  1. 确保已安装Python环境和项目依赖，并配置好MySQL数据库连接环境变量。
  2. 启动 MCP 客户端，并配置上述服务器连接信息。
  3. MCP 客户端将可以通过 JSON-RPC 协议与 MySQL MCP Server 通信，并调用预定义的工具 (Tools) 来执行 SQL 查询、列出数据库表、描述表结构等操作，从而实现 LLM 对 MySQL 数据库的访问和控制。

注意: 本服务器实现通过标准输入输出流 (stdio) 与 MCP 客户端通信。MCP 客户端需要支持 stdio 传输协议。

信息

分类

数据库与文件

访问项目