SQL Tunnel

🚀 SQL MCP Server (TypeScript)

This project offers a TypeScript-based Model Context Protocol (MCP) Server, enabling language models and other MCP-compatible clients to securely query PostgreSQL databases via SSH bastion tunnels.

🚀 Quick Start

This project provides a TypeScript-based Model Context Protocol (MCP) server, allowing language models and other MCP-compatible clients to securely query PostgreSQL databases through SSH bastion tunnels. It's built for flexible and secure database access, supports AWS RDS read-only transactions, and uses stdin/stdout-based communication, suitable for various use cases, including local, containerized, or AI-driven scenarios.

✨ Features

• 🔒 Secure access to private RDS instances via SSH bastion.
• 🐘 PostgreSQL read-only query engine using the pg library.
• 📡 STDIO-based MCP protocol transmission.
• 🧠 Compatible with memory-bank-mcp-server.
• ⚙️ Easy configuration via .env file or environment variables.
• 🧪 Comprehensive testing with Jest and mocks.

📦 Installation

Clone the repository and install the dependencies:

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

Configuration (Optional .env file)

Create a .env file in the project root directory:

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

Usage

Run the server using npx:

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

When connecting directly without an SSH tunnel, set the appropriate environment variables:

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

💻 Usage Examples

Basic Usage

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

Advanced Usage

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

📚 Documentation

• Architecture
• Domain Model
• Glossary
• Coding Standards
• Tech Stack
• User Guide

📄 License

MIT

Contribution Guidelines

We welcome community contributions! Please check CONTRIBUTING.md for detailed information.

Compatibility

This implementation follows the Model Context Protocol (MCP) and is compatible with the following:

• memory-bank-mcp-server
• Claude Desktop (via STDIO)
• Cursor IDE
• Supabase + MCP Integration