使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现，它允许大型语言模型 (LLM) 通过 MCP 协议访问 MySQL 数据库。该服务器提供数据库表的结构信息以及执行只读 SQL 查询的功能，从而使 LLM 能够理解和利用 MySQL 数据库中的数据。

主要功能点

资源 (Resources) 提供: 将 MySQL 数据库的表结构信息以 JSON 格式作为资源提供给 LLM 客户端，使 LLM 能够了解数据库的 schema。
工具 (Tools) 注册: 注册名为 'mysql_query' 的工具，允许 LLM 客户端通过调用该工具执行只读的 SQL 查询。所有查询都在只读事务中执行，确保数据安全。
易于集成: 设计为可以通过 'npx' 直接运行，方便集成到支持 MCP 协议的 LLM 客户端，如 Claude Desktop。

安装步骤

本 MCP 服务器无需手动安装，可以通过 'npx' 命令直接运行。您需要确保您的环境中已安装 Node.js 和 npm。

服务器配置

要将此 MCP 服务器与 MCP 客户端（例如 Claude Desktop）配合使用，您需要在客户端的 MCP 服务器配置中添加以下 JSON 配置。这段配置定义了客户端如何启动和连接到此 MySQL MCP 服务器。

{
  "mcpServers": {
    "mcp_server_mysql": {
      "command": "npx",
      "args": [
        "-y",
        "@benborla29/mcp-server-mysql"
      ],
      "env": {
        "MYSQL_HOST": "your_mysql_host",  // MySQL 服务器地址，例如 127.0.0.1 或 IP 地址
        "MYSQL_PORT": "3306",            // MySQL 端口号，默认为 3306
        "MYSQL_USER": "your_mysql_user",    // MySQL 用户名
        "MYSQL_PASS": "your_mysql_password",  // MySQL 密码
        "MYSQL_DB": "your_database_name"    // 要连接的 MySQL 数据库名 (留空则访问所有数据库)
      }
    }
  }
}

配置参数说明:

'command': 启动 MCP 服务器的命令，这里使用 'npx' 直接运行 npm 包。
'args': 传递给 'command' 的参数，'-y' 自动确认安装，'@benborla29/mcp-server-mysql' 是要运行的 npm 包名。
'env': 环境变量配置，用于设置 MySQL 数据库连接信息。请务必替换 'your_mysql_host', 'your_mysql_user', 'your_mysql_password', 和 'your_database_name' 为您实际的 MySQL 数据库连接信息。

基本使用方法

将上述 JSON 配置添加到您的 MCP 客户端的配置文件中（例如 Claude Desktop 的 'claude_desktop_config.json'）。
启动您的 MCP 客户端。客户端将根据配置自动连接到此 MySQL MCP 服务器。
在 LLM 客户端中，您可以通过 MCP 协议与此服务器交互：
- 客户端可以请求资源列表，获取数据库中所有表的 schema 信息。
- 客户端可以读取特定表的 schema 资源，获取表的列名和数据类型等详细信息。
- 客户端可以调用 'mysql_query' 工具，并传入 SQL 查询语句，执行对 MySQL 数据库的只读查询并获取结果。

关键词