Supports configuration via .env files for database credentials and connection settings

Includes CI/CD integration through GitHub Actions workflows

Provides testability with Jest for ensuring server reliability and performance

Provides a read-only query interface to PostgreSQL databases, supporting secure connections via SSH bastion tunnels

Compatible with Supabase + MCP integration, allowing models to query Supabase-managed PostgreSQL databases

Built with TypeScript for type safety and modern JavaScript features

1. Click on "Install Server".

2. Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.

3. In the chat, type @ followed by the MCP server name and your instructions, e.g., "@SQL MCP Server show me the top 10 customers by total orders"

That's it! The server will respond to your query, and you can continue using it as needed.

Here is a step-by-step guide with screenshots.

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