Skip to main content

mcp-server-postgresql: A PostgreSQL MCP Server

The Model Context Protocol (MCP) is an open protocol that enables seamless integration between LLM applications and external data sources and tools. Whether you're building an AI-powered IDE, enhancing a chat interface, or creating custom AI workflows, MCP provides a standardized way to connect LLMs with the context they need.

This repository is an example of how to create an MCP server for managing PostgreSQL databases.

PyPI version

Overview

A Model Context Protocol server for interacting with PostgreSQL. It provides tools for executing queries, creating tables, inserting rows of data, and retrieving results.

Components

Tools

The server implements the following tools:

  • execute_query: Execute an arbitrary SQL query

    • Takes a query string
    • Returns results for SELECT-like statements, or a success message for others
  • create_table: Create a new table

    • Takes a name and a schema (column definitions)
    • Creates the specified table
  • insert_data: Insert a row of data into a table

    • Takes a table name and a data dict of column values
    • Inserts the specified row
  • fetch_data: Fetch data by executing a SELECT query

    • Takes a query string
    • Returns matching rows as a result set

Configuration

The server connects to PostgreSQL using the following environment variables (all are required):

  • PG_HOST: PostgreSQL host
  • PG_PORT: PostgreSQL port
  • PG_USER: PostgreSQL user
  • PG_PASSWORD: PostgreSQL password
  • PG_DATABASE: PostgreSQL database name

If any of these variables are missing, the server will raise an error during startup. Make sure to set each of these before running the server.

Quickstart

Claude Desktop

On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json
On Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "postgresql": {
    "command": "uvx",
    "args": [
      "mcp-server-postgresql"
    ]
  }
}

Development

Building and Publishing

To prepare the package for distribution:

  1. Sync dependencies and update lockfile:
uv sync
  1. Build package distributions:
uv build

This will create source and wheel distributions in the dist/ directory.

  1. Publish to PyPI:
uv publish

Note: You'll need to set PyPI credentials via environment variables or command flags:

  • Token: --token or UV_PUBLISH_TOKEN
  • Or username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

Debugging

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

npx @modelcontextprotocol/inspector uv --directory $(PWD) run mcp-server-postgresql

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

Metadata

Release files for mcp-server-postgresql 0.1.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mcp-server-postgresql 0.1.9
File Size Uploaded
mcp_server_postgresql-0.1.9.tar.gz 16.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mcp-server-postgresql 0.1.9
File Interpreter ABI Platform
mcp_server_postgresql-0.1.9-py3-none-any.whl Python 3 none any Details

Total release size: 20.7 kB

Release files / mcp_server_postgresql-0.1.9.tar.gz

Download URL mcp_server_postgresql-0.1.9.tar.gz
Size 16.0 kB
Tags Source
SHA-256 checksum
How to use checksums
ad02281aed2c64ac2ba4389ff83eee66b722d9ec993d9397a1f1c1fb61f72c3d
BLAKE2b-256 checksum
How to use checksums
63a4559553c520573c28108fc65a392a7393b935e542c6367cae3b37648a2a9b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.5.26

Release files / mcp_server_postgresql-0.1.9-py3-none-any.whl

Download URL mcp_server_postgresql-0.1.9-py3-none-any.whl
Size 4.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
75e148cde0d7033319edb632d4fad01ec62332023f2b405f43956e53518d4300
BLAKE2b-256 checksum
How to use checksums
bd40832bc329371021a37b0474352e7d252696eeafa46bad40043ac124654e6c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.5.26

Release history Release notifications | RSS feed

This release

0.1.9 This release

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page