MCP SERVER PG

🚀 PostgreSQL

A Model Context Protocol server offering read-only access to connect to a PostgreSQL database. This server enables large language models (LLMs) to inspect the database schema and execute read-only queries.

🚀 Quick Start

✨ Features

Tools

• query
  • Execute read-only SQL queries against the connected database.
  • Input: sql (string): The SQL query to be executed.
  • All queries are executed within a READ ONLY transaction.

Resources

The server provides schema information for each database table:

• Table Schema (postgres://<host>/<table>/schema)
  • JSON schema information for each table.
  • Includes column names and data types.
  • Automatically discovered from the database metadata.

💻 Usage Examples

Usage Instructions (Claude Desktop)

To use this server with the Claude Desktop application, add the following configuration to the "mcpServers" section in the claude_desktop_config.json file:

Docker

⚠️ Important Note

• When running Docker on macOS and the server is running on the host network (e.g., localhost), use host.docker.internal.
• Usernames/passwords can be added to the PostgreSQL URL via postgresql://user:password@host:port/db-name.

{
  "mcpServers": {
    "postgres": {
      "command": "docker",
      "args": [
        "run", 
        "-i", 
        "--rm", 
        "mcp/postgres", 
        "postgresql://host.docker.internal:5432/mydb"
      ]
    }
  }
}

NPX

{
  "mcpServers": {
    "postgres": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-postgres",
        "postgresql://localhost/mydb"
      ]
    }
  }
}

Replace /mydb with your database name.

📦 Installation

Docker

docker build -t mcp/postgres -f src/postgres/Dockerfile .

📄 License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, refer to the LICENSE file in the project repository.