MySQL MCP 服务器

概述

本项目提供了一个只读的模型上下文协议 (MCP) 服务器，用于与 MySQL 数据库交互。它允许与 MCP 兼容的客户端通过一组定义的工具来检查数据库模式、检索元数据和执行只读 SQL 查询。该服务器在构建时考虑了可扩展性，并强制执行只读操作以确保安全。

功能 & 已实现的工具

该服务器通过 MCP 公开了一些用于数据库交互的工具。所有工具都设计为只读操作。

模式 & 元数据工具

• get_table_columns: 检索特定表的列定义。
• get_schema: 获取详细的模式信息，包括表、列、索引和约束，具有不同的详细程度。
• get_indexes: 检索特定表或所有表的索引信息。
• get_constraints: 获取特定表或所有表的约束信息（主键、外键、唯一、检查）。
• compare_schemas: 比较两个不同数据库模式的结构（表和列）。
• explain_schema: 生成数据库模式的文本或结构化 (JSON) 描述。
• detect_schema_changes: 返回当前模式的快照。（注意：不与特定的过去时间进行比较）。
• find_relationships: 发现显式外键关系。可以选择性地尝试根据命名约定查找隐式关系（谨慎使用）。
• find_navigation_paths: 使用显式外键关系查找两个表之间的路径（BFS 算法）。

查询执行工具

• execute_query: 执行给定的只读 SQL 查询（SELECT、SHOW、DESCRIBE、EXPLAIN）。
• execute_batch: 顺序运行多个只读 SQL 查询。可以在第一个错误时停止或尝试全部执行。
• prepare_statement: 准备并执行带有参数的只读 SQL 语句。
• explain_query: 对给定的 SQL 语句执行 EXPLAIN，以显示查询执行计划（TEXT 或 JSON 格式）。
• get_query_history: 占位符工具。目前尚未实现服务器端查询历史记录。

可视化工具

• visualize_schema: 以 JSON、DOT (Graphviz) 或 Mermaid 语法生成模式表示（表、列、关系），适用于创建 ER 图。

性能工具

• get_performance_metrics: 从 MySQL 检索选定的全局状态变量（例如，Uptime、Threads、Queries）。不提供特定于查询的历史记录。

安装 & 设置

1. 先决条件：

   • Node.js
   • npm
   • 访问 MySQL 数据库

2. 克隆仓库：

   git clone https://github.com/kaulvimal/mysql-mcp
   cd mysql-mcp-server
   

3. 安装依赖：

   npm install
   

4. 构建项目：

   npm run build
   

   这将创建一个包含已编译代码的 build 目录。

5. 使用服务器

• 在项目根目录或方便的位置创建一个 shell 脚本 (例如，mysql-mcp.sh)：

  #!/bin/bash
  # 设置环境变量 (如果未使用 .env 或想要覆盖)
  # export DB_HOST=localhost
  # export DB_USER=root
  # export DB_PASSWORD=""
  # export DB_PORT=3306
  node $(dirname "$0")/build/index.js
  

• 使脚本可执行：

  chmod +x mysql-mcp.sh
  

• 集成示例 (Cursor)

  要将此服务器与 Cursor 集成，您可以配置客户端以运行服务器的执行脚本：

  {
  "mcpServers": {
  	"mysql-mcp": {
  	"command": "/path/to/your/mysql-mcp.sh" // 替换为您的脚本的实际路径
  	}
  }
  }