Mysql MCP Server Qrx

🚀 只讀模型上下文協議（MCP）服務器項目

本項目提供了一個只讀的模型上下文協議（MCP）服務器，該服務器可與 MySQL 和 PostgreSQL 數據庫進行交互。藉助一組定義好的工具，兼容 MCP 的客戶端能夠檢查數據庫架構、檢索元數據並執行只讀 SQL 查詢。此服務器具備可擴展性，且通過強制執行只讀操作來保障安全性。

✨ 主要特性

架構與元數據工具

• get_table_columns：獲取特定表的列定義。
• get_schema：檢索詳細的架構信息，涵蓋表、列、索引和約束，並能提供不同級別的細節。
• get_indexes：獲取特定表或所有表的索引信息。
• get_constraints：檢索特定表或所有表的約束信息（主鍵、外鍵、唯一、檢查）。
• compare_schemas：比較兩個不同數據庫架構的結構（表和列）。
• explain_schema：生成文本格式或結構化（JSON）的數據庫架構描述。
• detect_schema_changes：返回當前架構的快照。（注意：不與特定過去時間進行比較）。
• find_relationships：發現顯式的外鍵關係。可選地嘗試基於命名約定發現隱式關係（謹慎使用）。
• find_navigation_paths：使用顯式外鍵關係通過廣度優先搜索算法查找兩個表之間的路徑。

查詢執行工具

• execute_query：執行給定的只讀 SQL 查詢（SELECT、SHOW、DESCRIBE、EXPLAIN）。
• execute_batch：順序運行多個只讀 SQL 查詢。可以在第一個錯誤時停止或嘗試全部執行。
• prepare_statement：準備並執行帶有參數的只讀 SQL 語句。
• explain_query：在給定的 SQL 語句上執行 EXPLAIN 以顯示查詢執行計劃（文本或 JSON 格式）。
• get_query_history：佔位符工具。服務器端查詢歷史尚未實現。

可視化工具

• visualize_schema：生成架構表示（表、列、關係）為 JSON、DOT（Graphviz）或 Mermaid 語法，適用於創建 ER 圖。

性能工具

• get_performance_metrics：從 MySQL 檢索選定的全球狀態變量（例如，運行時間、線程、查詢）。不提供特定查詢的歷史記錄。

📦 安裝指南

先決條件

• Node.js
• npm
• 對 MySQL 或 PostgreSQL 數據庫的訪問權限

克隆倉庫

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

安裝依賴項

npm install

構建項目

npm run build

此操作將創建一個 build 目錄，其中包含編譯後的代碼。

使用服務器

在項目根目錄或方便的位置創建一個 shell 腳本（例如 mysql-mcp.sh）：

#!/bin/bash
# 設置環境變量（如果不想使用.env文件或要覆蓋）
export MYSQL_HOST=""
export MYSQL_USER=""