PostgreSQL

by divyanshu-vashu

184 downloads
Not rated
GitHub

Description

# PostgreSQL A Model Context Protocol server that provides read-only access to PostgreSQL databases. This server enables LLMs to inspect database schemas and execute read-only queries. ## Components ### Tools - **query** - Execute read-only SQL queries against the connected…

About

# PostgreSQL A Model Context Protocol server that provides read-only access to PostgreSQL databases. This server enables LLMs to inspect database schemas and execute read-only queries. ## Components ### Tools - **query** - Execute read-only SQL queries against the connected database - Input: `sql` (string): The SQL…

Details

Author
divyanshu-vashu
Downloads
184
Categories
Database

- Execute read‑only SQL queries via the query tool.
- Automatically discover and expose JSON table schemas.
- Schemas include column names and data types.
- All queries run inside a READ ONLY transaction.
- Supports Docker and NPX deployment.
- MIT licensed.

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:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name PostgreSQL
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Configure the server in the mcpServers section of claude_desktop_config.json. Use either Docker (docker run -i --rm mcp/postgres postgresql://...) or NPX (npx -y @modelcontextprotocol/server-postgres). Provide a PostgreSQL connection URL, optionally including username and password.

Claude Desktop / Cursor

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

{
    "mcpServers": {
        "postgresql": {
            "MCP-SERVER-PG": {
                "command": "docker",
                "args": [
                    "build",
                    "-t",
                    "mcp/postgres",
                    "-f",
                    "src/postgres/Dockerfile",
                    "."
                ]
            }
        }
    }
}

McpServers

{
    "MCP-SERVER-PG": {
        "command": "docker",
        "args": [
            "build",
            "-t",
            "mcp/postgres",
            "-f",
            "src/postgres/Dockerfile",
            "."
        ]
    }
}

PostgreSQL

A Model Context Protocol server that provides read-only access to PostgreSQL databases. This server enables LLMs to inspect database schemas and execute read-only queries.

Components

Tools

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

Resources

The server provides schema information for each table in the database:

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

Usage with Claude Desktop

To use this server with the Claude Desktop app, add the following configuration to the "mcpServers" section of your claude_desktop_config.json:

Docker

when running docker on macos, use host.docker.internal if the server is running on the host network (eg localhost)
username/password can be added to the postgresql url with 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.

Building

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, please see the LICENSE file in the project repository.

No reviews yet — be the first

Sign in to leave a review

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

Email sign in

No reviews posted yet.