MySQL MCP Server

MySQL & PostgreSQL MCP 服务

概述

本项目提供一个只读的 Model Context Protocol（MCP）服务，用于与 MySQL & PostgreSQL 数据库交互。它允许兼容 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 或 PostgreSQL 数据库

2. 克隆代码库：

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

3. 安装依赖项：

   npm install
   

4. 构建项目：

   npm run build
   

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

5. 使用服务

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

  #!/bin/bash
  # 设置环境变量（如果不使用 .env 或希望覆盖其中的值）
  export MYSQL_HOST=""
  export MYSQL_USER=""
  export MYSQL_PASSWORD=""
  export MYSQL_PORT=""
  
  export PG_HOST=""
  export PG_USER=""
  export PG_PASSWORD=""
  export PG_PORT=""
  export PG_DATABASE=""
  node $(dirname "$0")/build/index.js
  

• 将脚本设为可执行文件：

  chmod +x mysql-mcp.sh
  

• 集成示例（Cursor）

  要将此服务集成到 Cursor 中，可配置客户端运行该服务的执行脚本：

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