Aws Rds Mysql MCP Server Amazonq Cli

🚀 Amazon Q CLI與MySQL MCP服務器集成

本項目提供了將AWS RDS MySQL MCP服務器與Amazon Q CLI集成的全面指南，藉助Amazon Q的對話界面，實現通過自然語言與數據庫進行交互。

🚀 快速開始

本項目展示瞭如何配置Amazon Q CLI以與FastMCP MySQL服務器協同工作，讓你能夠通過Amazon Q的聊天界面，使用自然語言命令與AWS RDS MySQL數據庫進行交互。

✨ 主要特性

• 自然語言交互：藉助Amazon Q的對話界面，使用自然語言命令與AWS RDS MySQL數據庫進行交互。
• 多配置模式：支持工作區配置和全局配置兩種MCP配置模式。
• 安全可靠：具備輸入驗證、操作限制、連接超時、環境隔離和錯誤處理等安全特性。
• 操作豐富：支持SELECT、INSERT、UPDATE、DELETE、CREATE、SHOW、DESCRIBE等多種數據庫操作。

📦 安裝指南

1. 安裝Amazon Q CLI

請按照以下安裝指南進行操作：

• 參考文檔：安裝Amazon Q開發者CLI

2. 創建虛擬環境

# 創建隔離的虛擬環境
python3 -m venv venv-mcp

# 激活虛擬環境
# Linux/macOS:
source venv-mcp/bin/activate

3. 安裝依賴項

pip3 install fastmcp pymysql boto3 python-dotenv

4. 環境配置

# 複製示例環境文件
cp .env.example .env

# 使用實際配置編輯.env文件

配置你的.env文件：

# AWS配置
AWS_REGION=us-east-1
BEDROCK_MODEL_ID=anthropic.claude-3-haiku-20240307-v1:0

# MySQL數據庫配置
RDS_HOST=your-mysql-host.amazonaws.com
RDS_PORT=3306
RDS_USER=your-username
RDS_PASS=your-password
RDS_DB=your-database-name

⚠️ 重要提示

• 切勿將.env文件提交到版本控制中。
• 將.env添加到你的.gitignore文件中。
• 在生產環境中使用AWS IAM角色。
• 定期輪換數據庫憑證。

🔧 技術細節

MCP配置選項

Amazon Q CLI支持兩種MCP配置模式（我們將實現全局配置）：

工作區配置

• 作用域：特定目錄
• 位置：工作目錄中的/.amazonq/mcp.json
• 使用方法：必須從配置目錄運行Q CLI命令

全局配置（推薦）

• 作用域：系統級訪問
• 位置：~/.aws/amazonq/mcp.json
• 使用方法：可從任何目錄運行Q CLI命令
• 優點：系統重啟後配置仍然有效

全局MCP設置（推薦）

1. 創建配置目錄

# 創建Amazon Q配置目錄
mkdir -p ~/.aws/amazonq

2. 創建MCP配置文件

創建~/.aws/amazonq/mcp.json，內容如下：

{
  "mcpServers": {
    "rds_mysql_server": {
      "command": "/absolute/path/to/your/venv-mcp/bin/python3",
      "args": [
        "/absolute/path/to/your/fastmcp_server.py"
      ],
      "env": {},
      "timeout": 120000,
      "disabled": false
    }
  }
}

重要提示：請將路徑替換為你實際的絕對路徑：

• /absolute/path/to/your/venv-mcp/bin/python3
• /absolute/path/to/your/fastmcp_server.py

3. 驗證配置

q mcp list

預期輸出：

workspace:
  /.amazonq/mcp.json
    (empty)

global:
  /home/username/.aws/amazonq/mcp.json
    • rds_mysql_server /path/to/venv-mcp/bin/python3

💻 使用示例

啟動Amazon Q聊天

q chat

數據庫交互示例

# 自然語言查詢
"Show me all tables in the database"
"Create a users table with id, name, and email columns"
"Find all records in the users table"
"Insert a new user with name 'John Doe' and email 'john@example.com' in users table"
"Show the structure of the users table"

📚 詳細文檔

支持的操作

故障排除

常見問題

1. 未找到MCP服務器
   • 驗證mcp.json中的絕對路徑。
   • 確保虛擬環境已正確創建。
   • 檢查文件權限。
2. 數據庫連接失敗
   • 驗證.env配置。
   • 測試數據庫連接性。
   • 檢查防火牆設置。
3. 權限被拒絕
   • 驗證AWS憑證。
   • 檢查數據庫用戶權限。
   • 確保使用了正確的IAM角色。

調試命令

# 直接測試MCP服務器
python3 fastmcp_server.py

# 驗證環境變量
echo $AWS_REGION

# 檢查Q CLI配置
q mcp list
q chat --debug

配置管理

更新MCP服務器

1. 停止所有正在運行的Q聊天會話。
2. 更新fastmcp_server.py或配置。
3. 重新啟動Q聊天：q chat

禁用MCP服務器

{
  "mcpServers": {
    "rds_mysql_server": {
      "disabled": true
    }
  }
}

性能優化

• 連接池：重用數據庫連接。
• 查詢緩存：緩存頻繁訪問的數據。
• 超時管理：根據查詢複雜度優化超時值。
• 資源監控：監控CPU和內存使用情況。

下一步計劃

1. 擴展功能：添加自定義工具以實現特定業務邏輯。
2. 多數據庫支持：配置多個數據庫連接。
3. 高級安全：實現基於角色的訪問控制。
4. 監控：設置日誌記錄和性能監控。
5. 自動化：為團隊環境創建部署腳本。

⚠️ 重要提示

此配置通過Amazon Q CLI的自然語言界面為你提供對MySQL數據庫的持久、系統級訪問。在處理數據庫憑證和連接時，請始終遵循安全最佳實踐。