MySQL Server MCP 服务器使用说明

项目简介

'mcp-mysql-server' 是一个基于 Model Context Protocol (MCP) 构建的服务器，它允许大型语言模型 (LLM) 通过标准化的 MCP 协议与 MySQL 数据库进行交互。该服务器提供了一系列工具，使 LLM 能够安全地连接到 MySQL 数据库，并执行各种数据库操作，例如查询数据、执行 SQL 语句以及获取表结构信息。

主要功能点

数据库连接管理：支持 LLM 通过 'connect_db' 工具安全地连接到 MySQL 数据库。
数据查询：通过 'query' 工具执行 'SELECT' 查询，并返回查询结果。
数据操作：通过 'execute' 工具执行 'INSERT'、'UPDATE' 和 'DELETE' 等数据操作语句。
表结构管理：提供 'list_tables' 工具列出数据库中的所有表，以及 'describe_table' 工具获取指定表的结构信息。
安全性：使用预处理语句防止 SQL 注入，并通过环境变量安全地管理数据库凭据。
错误处理：提供详细的错误信息，帮助开发者快速定位和解决问题。

安装步骤

安装 Node.js 和 npm: 确保你的环境中已安装 Node.js 和 npm (Node Package Manager)。
安装 mcp-mysql-server: 你可以通过 npm 全局安装 'mcp-mysql-server'，以便在任何地方运行它。
```
npm install -g @f4ww4z/mcp-mysql-server
```
或者，你也可以选择不全局安装，直接在项目中使用 'npx' 运行。

服务器配置

MCP 客户端需要配置以下 JSON 格式信息来启动和连接 'mcp-mysql-server'。请根据你的 MySQL 数据库配置修改 'env' 字段中的参数。

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["@f4ww4z/mcp-mysql-server"],
      "env": {
        "MYSQL_HOST": "your_host",        // MySQL 服务器地址，例如：localhost 或 127.0.0.1
        "MYSQL_USER": "your_user",        // MySQL 用户名
        "MYSQL_PASSWORD": "your_password",    // MySQL 密码
        "MYSQL_DATABASE": "your_database"    // 默认连接的 MySQL 数据库名
      }
    }
  }
}

基本使用方法

启动服务器: 在终端中运行 'mcp-mysql-server' 命令，服务器将在 stdio 上监听 MCP 请求。如果你是全局安装的，可以直接运行 'mcp-mysql-server'。如果选择局部安装或使用 npx，请确保在包含 'node_modules' 的目录下或者使用 'npx @f4ww4z/mcp-mysql-server' 启动。
配置 MCP 客户端: 在你的 MCP 客户端应用中，配置上述服务器信息。客户端会根据配置连接到 'mcp-mysql-server'。

使用工具: 通过 MCP 客户端提供的 API (例如 'use_mcp_tool') 调用服务器提供的工具。例如，使用 'connect_db' 工具建立数据库连接后，可以使用 'query' 或 'execute' 工具执行 SQL 语句。

示例 (使用 'query' 工具查询数据):

use_mcp_tool({
  server_name: "mysql",
  tool_name: "query",
  arguments: {
    sql: "SELECT * FROM your_table WHERE condition = ?",
    params: ["your_value"]
  }
});

注意: 在执行任何数据库操作之前，请务必先使用 'connect_db' 工具成功建立数据库连接。数据库连接信息需要在 MCP 客户端配置的 'env' 字段中正确设置。

关键词