Mysql MCP Servers

🚀 MySQL MCP 服務器

本項目提供了一個使用 Model Context Protocol (MCP) 與 MySQL 數據庫進行交互的服務器，專門為 WSL 環境中的 MySQL 數據庫提供便捷接口，助力開發者高效操作數據庫。

🚀 快速開始

本服務器可幫助你通過 MCP 協議與 MySQL 數據庫進行交互。按照以下步驟操作，即可快速開啟服務。

✨ 主要特性

• 表信息獲取：能夠獲取 MySQL 數據庫中的表列表。
• 數據讀取：可從表中讀取數據，最多讀取 100 行。
• SQL 查詢執行：支持執行多種 SQL 查詢，如 SELECT、SHOW TABLES、INSERT、UPDATE、DELETE 等。

📦 安裝指南

先決條件

• Python 3.11 或更高版本
• MySQL 服務器（本地或遠程）
• 虛擬環境（virtualenv）
• Docker（使用 Docker 時）

設置步驟

1. 克隆倉庫：

   git clone <repository-url>
   cd mysql_mcp_server
   

2. 創建虛擬環境並激活：

   python -m venv .venv
   source .venv/bin/activate  # Linux 系統
   

3. 安裝依賴項：

   pip install -r requirements.txt .
   

4. 運行設置腳本以賦予執行權限並運行：

   chmod +x setup.sh
   ./setup.sh
   

運行方法

可以使用以下任意一種方式運行服務器：

1. 直接運行

./run_direct.sh

2. 作為模塊運行

./run_module.sh

3. 使用 Docker 容器運行

# 構建 Docker 鏡像
docker build -t mysql-mcp-server:latest .

# 運行容器
./run_docker.sh

📚 詳細文檔

環境變量

服務器使用以下環境變量連接 MySQL：

MCP 協議

此服務器實現 MCP 協議，並提供以下端點：

• list_resources：獲取數據庫中的表列表
• read_resource：從特定表中讀取數據
• list_tools：列出可用工具
• execute_query：執行 SQL 查詢

WSL 環境注意事項

在 WSL 環境下運行時，需注意文件路徑和網絡配置。請參考文檔中的 WSL 部分以獲取更多信息。

項目結構

src/mysql_mcp_server/
├── __init__.py        # 包初始化文件
├── config/           # 配置相關模塊
│   ├── __init__.py  
│   └── settings.py   # 數據庫配置
├── database/         # 數據庫操作模塊
│   ├── __init__.py  
│   ├── connection.py # 數據庫連接處理
│   └── errors.py     # 錯誤類
├── tools/            # 工具模塊
│   ├── __init__.py  
│   └── sql_tools.py  # SQL 執行工具
└── server.py         # MCP 服務器主文件

🔧 技術細節

測試

使用 Nox 運行測試

1. 安裝 Nox：

   pip install nox
   

2. 運行所有測試：

   nox -s test
   

3. 格式化代碼：

   nox -s format
   

4. 執行代碼檢查：

   nox -s lint
   

直接運行測試

pytest tests/

檢查代碼覆蓋率

pytest --cov=src.mysql_mcp_server tests/

📄 許可證

此項目在 MIT 許可證下開源。