Mysql Read Only

🚀 MCP 服務器：MySQL 實現指南

本指南詳細介紹了 MCP 服務器基於 MySQL 的實現方法，涵蓋安裝、配置、測試、故障排除、貢獻等方面，助您輕鬆搭建和使用 MCP 服務器。

🚀 快速開始

本指南將幫助您完成 MCP 服務器的安裝、配置、測試等操作，讓您快速上手使用。

📦 安裝指南

使用 Smithery 進行安裝

smithery install @benborla/mcp-server-mysql

使用 MCP Get 進行安裝

mcp-get install @benborla/mcp-server-mysql

📚 詳細文檔

配置說明

根據文檔中提供的配置選項，您可以選擇以下方式設置環境變量：

設置 PATH 環境變量（可選）

export PATH="/path/to/node/bin:$PATH"

配置示例

{
  "env": {
    "NODE_OPTIONS": "--loader ts-node/index",
    "PATH": "/path/to/node/bin:/usr/bin:/bin"
  }
}

測試指南

數據庫準備

1. 創建測試用戶和數據庫

CREATE USER 'mcp_test'@'localhost' IDENTIFIED BY 'mcp_test_password';
GRANT ALL PRIVILEGES ON mcp_test.* TO 'mcp_test'@'localhost';
FLUSH PRIVILEGES;

2. 運行數據庫腳本

pnpm run setup:test:db

3. 創建測試環境文件 在項目根目錄下創建.env.test文件：

MYSQL_HOST=127.0.0.1
MYSQL_PORT=3306
MYSQL_USER=mcp_test
MYSQL_PASS=mcp_test_password
MYSQL_DB=mcp_test

更新 package.json

在 package.json 中添加以下腳本：

{
  "scripts": {
    "setup:test:db": "ts-node scripts/setup-test-db.ts",
    "pretest": "pnpm run setup:test:db",
    "test": "vitest run",
    "test:watch": "vitest",
    "test:coverage": "vitest run --coverage"
  }
}

執行測試

# 初始化測試環境
pnpm run setup:test:db

# 運行所有測試
pnpm test

故障排除

使用 Smithery 進行診斷

smithery status @benborla/mcp-server-mysql
smithery diagnose @benborla/mcp-server-mysql
smithery logs @benborla/mcp-server-mysql

常見問題

1. 連接問題
   • 確認 MySQL 服務器運行狀態。
   • 檢查用戶權限設置。
2. 性能問題
   • 調整數據庫配置參數。
   • 使用更高效的數據查詢方式。
3. 版本兼容性
   • 確保 Node.js 和相關工具的版本與項目要求一致。

貢獻指南

代碼倉庫訪問

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

開發環境設置

1. 克隆倉庫：

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

2. 安裝依賴：

pnpm install

3. 啟動開發服務器：

pnpm dev

文檔參考

• 官方文檔：MCP 服務器文檔
• 社區支持：GitHub 倉庫

通過以上步驟，您可以輕鬆完成 MCP 服務器的安裝、配置和測試工作。如果有任何問題，請隨時參考官方文檔或聯繫社區尋求幫助。