使用说明

项目简介

MySQL MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为 AI 助手提供安全可控的 MySQL 数据库访问能力。通过此服务器,LLM 客户端可以列出数据库中的表,读取表数据,并执行 SQL 查询,从而实现数据库的探索和分析。

主要功能点

  • 列出 MySQL 表: 将数据库中的表作为资源暴露给 LLM 客户端。
  • 读取表数据: 允许 LLM 客户端读取指定表的内容。
  • 执行 SQL 查询: 提供工具让 LLM 客户端执行 SQL 查询,并返回结果。
  • 安全访问控制: 通过环境变量管理数据库连接信息,保障数据库安全。
  • 详细日志记录: 记录服务器操作,方便审计和问题排查。

安装步骤

  1. 确保你的 Python 环境已安装 pip。
  2. 打开终端或命令提示符。
  3. 运行命令 'pip install mysql-mcp-server' 安装 MySQL MCP Server。

服务器配置

为了让 MCP 客户端(例如 Claude Desktop)连接到 MySQL MCP Server,你需要配置客户端的 'claude_desktop_config.json' 文件。在 'mcpServers' 字段中添加以下配置:

{
  "mcpServers": {
    "mysql": {
      "command": "uv",
      "args": [
        "--directory",
        "path/to/mysql_mcp_server",
        "run",
        "mysql_mcp_server"
      ],
      "env": {
        "MYSQL_HOST": "你的MySQL主机地址",  // 例如:localhost, 127.0.0.1
        "MYSQL_USER": "你的MySQL用户名",    // 具有读取数据库权限的用户名
        "MYSQL_PASSWORD": "你的MySQL密码",  // 对应用户的密码
        "MYSQL_DATABASE": "你的MySQL数据库名" // 要访问的数据库名称
      }
    }
  }
}

注意:

  • 将 'path/to/mysql_mcp_server' 替换为 'mysql-mcp-server' 包的安装路径。通常情况下,如果是全局安装,可以尝试直接使用 'mysql_mcp_server' 作为目录名,或者你可以将 'mysql-mcp-server' 安装目录的绝对路径填入。
  • 确保替换 'MYSQL_HOST', 'MYSQL_USER', 'MYSQL_PASSWORD', 和 'MYSQL_DATABASE' 为你实际的 MySQL 数据库连接信息。

基本使用方法

  1. 启动 MySQL MCP Server。 如果使用 Claude Desktop,它会自动根据配置启动。如果独立运行,请在终端中执行 'python -m mysql_mcp_server' 命令。
  2. 在 MCP 客户端中,配置并连接到名为 "mysql" 的 MCP 服务器。
  3. 客户端可以通过 MCP 协议请求列出资源(MySQL 表),读取资源内容,或调用工具(执行 SQL 查询)来与 MySQL 数据库进行交互。

信息

分类

数据库与文件