SQL Tunnel

🚀 SQL MCP 服務器（TypeScript）

該項目提供了一種基於 TypeScript 的模型上下文協議（MCP）服務器，支持語言模型和其他 MCP 兼容客戶端通過 SSH 跳板隧道安全查詢 PostgreSQL 數據庫。它專為靈活且安全的數據庫訪問而設計，支持 AWS RDS 只讀事務，採用基於 stdin/stdout 的通信方式，適用於本地、容器化或 AI 驅動等多種場景。

🚀 快速開始

克隆倉庫並安裝依賴項：

git clone https://github.com/your-org/sql-mcp-server.git
cd sql-mcp-server
npm install
npm run build

配置（可選 .env 文件）

在項目根目錄中創建一個 .env 文件：

DB_USER=postgres
DB_PASS=yourpassword
DB_HOST=localhost
DB_PORT=5432
DB_NAME=mydatabase
USE_SSH_TUNNEL=true
SSH_BASTION_HOST=bastion.example.com
SSH_BASTION_USER=ec2-user
SSH_PRIVATE_KEY_PATH=~/.ssh/id_rsa

使用

使用 npx 運行服務器：

npx -y @modelcontextprotocol/server-postgres postgresql://<user>:<pass>@localhost:5433/<dbname>

無需 SSH 隧道直接連接時，請設置適當的環境變量：

DB_HOST=rds-host.amazonaws.com DB_PORT=5432 npx -y @modelcontextprotocol/server-postgres postgresql://<user>:<pass>@rds-host.amazonaws.com/<dbname>

✨ 主要特性

• 🔒 通過 SSH 跳板實現對私有 RDS 實例的安全訪問
• 🐘 使用 pg 庫的 PostgreSQL 只讀查詢引擎
• 📡 基於 STDIO 的 MCP 協議傳輸
• 🧠 與 memory-bank-mcp-server 兼容
• ⚙️ 通過 .env 文件或環境變量輕鬆配置
• 🧪 使用 Jest 和模擬進行全面測試

💻 使用示例

基礎用法

示例輸入

{
  "type": "call_tool",
  "params": {
    "name": "query",
    "arguments": {
      "sql": "SELECT * FROM users LIMIT 10"
    }
  }
}

示例輸出

{
  "content": [
    {
      "type": "text",
      "text": "[{\"id\":1,\"name\":\"Alice\"}]"
    }
  ],
  "isError": false
}

📚 詳細文檔

• 架構
• 領域模型
• 術語表
• 編碼標準
• 技術棧
• 用戶指南

📄 許可證

本項目採用 MIT 許可證。

貢獻指南

我們歡迎社區貢獻！請查看 CONTRIBUTING.md 以獲取詳細信息。

兼容性

此實現遵循模型上下文協議（MCP），並已與以下內容兼容：

• memory-bank-mcp-server
• Claude Desktop（通過 STDIO）
• Cursor IDE
• Supabase + MCP 集成