SQL MCP Server (TypeScript)

by MCP-Mirror

304 downloads

Not rated

GitHub

Database

About

SQL MCP Server (TypeScript) is a TypeScript implementation of a Model Context Protocol (MCP) server that enables language models and other MCP-compatible clients to query PostgreSQL databases, with optional SSH bastion tunnel support for secure access to private RDS instances…

Details

Author: MCP-Mirror
Downloads: 304
Categories: Database

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below

Plugin Name SQL MCP Server (TypeScript)

Command (node, npx, python, etc.)

Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

From the repository

Clone the repository, install dependencies with npm install, and build with npm run build. Run the server using npx -y @modelcontextprotocol/server-postgres postgresql://<user>:<pass>@localhost:5433/<dbname>, optionally configuring SSH bastion or direct connection via environment variables or a .env file.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "sql mcp server (typescript)": {
            "t3ta_sql-mcp-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "@modelcontextprotocol/server-postgres",
                    "postgresql://<user>:<pass>@localhost:5433/<dbname>"
                ]
            }
        }
    }
}

McpServers

{
    "t3ta_sql-mcp-server": {
        "command": "npx",
        "args": [
            "-y",
            "@modelcontextprotocol/server-postgres",
            "postgresql://<user>:<pass>@localhost:5433/<dbname>"
        ]
    }
}

SQL MCP Server (TypeScript)

[]()

This project provides a TypeScript implementation of a Model Context Protocol (MCP) server that enables language models and other MCP-compatible clients to query PostgreSQL databases—via SSH bastion tunnels when required.

Built for flexibility and secure database access, it supports AWS RDS with read-only transactions and uses stdin/stdout-based communication, making it suitable for local, containerized, or AI-driven use cases.

Features

- 🔒 SSH bastion support for secure access to private RDS instances via SSH tunnels
- 🐘 PostgreSQL read-only query engine using the pg library
- 📡 STDIO-based MCP protocol transport
- 🧠 Compatible with memory-bank-mcp-server
- ⚙️ Easily configurable via .env or environment variables
- 🧪 Fully testable with Jest and mocks

---

Installation

Clone the repository and install 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:
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>
For direct connection without SSH tunneling, 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>
Sample Input
{

  "type": "call_tool",

  "params": {

    "name": "query",

    "arguments": {

      "sql": "SELECT * FROM users LIMIT 10"

    }

  }

}
Sample Output
{

  "content": [

    {

      "type": "text",

      "text": "[{\"id\":1,\"name\":\"Alice\"}]"

    }

  ],

  "isError": false

}
⸻
Related Docs

	•	Architecture

	•	Domain Models

	•	Glossary

	•	Coding Standards

	•	Tech Stack

	•	User Guide
⸻
License
MIT
⸻
Contribution Guide
We welcome community contributions! Please see CONTRIBUTING.md for details.
⸻
Compatibility
This implementation follows the Model Context Protocol (MCP) and has been tested for compatibility with:

	•	memory-bank-mcp-server

	•	Claude Desktop (via STDIO)

	•	Cursor IDE

	•	Supabase + MCP integration

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

Claude Desktop / Cursor

McpServers

SQL MCP Server (TypeScript)

Features

Installation

Install

More like this

Redis

Sqlite

PostgreSQL

Npx Y convex@latest mcp start

AWS MCP Servers

whatsapp-mcp