Postgres

🚀 Postgres MCP (Research Project)

A Model Control Protocol (MCP) server implemented for the PostgreSQL database. This project provides a simple HTTP interface for interacting with the PostgreSQL database via MCP, allowing read-only queries to be executed and database resources to be explored.

🚀 Quick Start

This project offers an HTTP interface to interact with PostgreSQL databases through MCP, enabling read - only queries and resource exploration.

✨ Features

• An HTTP server compliant with the MCP protocol.
• Execution of read - only SQL queries.
• Listing of database resources.
• Support for environment variables via the .env file.
• Built with the Go language and the Gin Web framework.

📋 Prerequisites

• Go 1.23.6 or a later version.
• A PostgreSQL database.
• Git.

📦 Installation

git clone https://github.com/ipfans/postgres-mcp.git
cd postgres-mcp
go mod download

⚙️ Configuration

You can configure the database connection in two ways:

Using Command - Line Flags

go run cmd/postgres-mcp/main.go -db "postgres://user:password@localhost:5432/dbname"

Using Environment Variables

• Create a .env file in the project root directory.
• Add your database URL:

DATABASE_URL=postgres://user:password@localhost:5432/dbname

💻 Usage Examples

Basic Usage

Start the Server

go run cmd/postgres-mcp/main.go

The server will start on the default port 8080.

Interact with MCP Endpoints

List Database Resources

POST http://localhost:8080/mcp
Content-Type: application/json

{
    "type": "function",
    "name": "resources"
}

Execute a Read - Only Query

POST http://localhost:8080/mcp
Content-Type: application/json

{
    "type": "function",
    "name": "query",
    "arguments": {
        "query": "SELECT * FROM your_table LIMIT 10"
    }
}

📄 License

This project is open - source and licensed under the MIT License.

👥 Contribution

Contributions are welcome! Please feel free to submit pull requests.