Cover image
Try Now
2025-04-03

A beginner-friendly MCP server template featuring a PostgreSQL connector with clean, easy-to-understand code. Perfect for developers new to Model Context Protocol who want to experiment and create their own AI tool connectors with minimal setup.

3 years

Works with Finder

2

Github Watches

2

Github Forks

25

Github Stars

Simple PostgreSQL MCP Server

This is a template project for those looking to build their own MCP servers. I designed it to be dead simple to understand and adapt - the code is straightforward with MCP docs attached so you can quickly get up to speed.

What is MCP?

TL;DR - It's a way to write plugins for AI

Model Context Protocol (MCP) is a standard way for LLMs to interact with external tools and data. In a nutshell:

  • Tools allow the LLM to execute commands (like running a database query)
  • Resources are data you can attach to conversations (like attaching a file to a prompt)
  • Prompts are templates that generate consistent LLM instructions

Features

This PostgreSQL MCP server implements:

  1. Tools

    • execute_query - Run SQL queries against your database
    • test_connection - Verify the database connection is working
  2. Resources

    • db://tables - List of all tables in the schema
    • db://tables/{table_name} - Schema information for a specific table
    • db://schema - Complete schema information for all tables in the database
  3. Prompts

    • Query generation templates
    • Analytical query builders
    • Based on the templates in this repo

Prerequisites

  • Python 3.8+
  • uv - Modern Python package manager and installer
  • npx (included with Node.js)
  • PostgreSQL database you can connect to

Quick Setup

  1. Create a virtual environment and install dependencies:

    # Create a virtual environment with uv
    uv venv
    
    # Activate the virtual environment
    source .venv/bin/activate  # On Windows: .venv\Scripts\activate
    
    # Install dependencies
    uv pip install -r requirements.txt
    
  2. Run the server with the MCP Inspector:

    # Replace with YOUR actual database credentials
    npx @modelcontextprotocol/inspector uv --directory . run postgres -e DSN=postgresql://username:password@hostname:port/database -e SCHEMA=public
    

    Note: If this is your first time running npx, you'll be prompted to approve the installation. Type 'y' to proceed.

    After running this command, you'll see the MCP Inspector interface launched in your browser. You should see a message like:

    MCP Inspector is up and running at http://localhost:5173
    

    If the browser doesn't open automatically, copy and paste the URL into your browser. You should see something like this: MCP Inspector Interface

  3. Using the Inspector:

    • Click the "Connect" button in the interface (unless there's an error message in the console on the bottom left)
    • Explore the "Tools", "Resources", and "Prompts" tabs to see available functionality
    • Try clicking on listed commands or typing resource names to retrieve resources and prompts
    • The interface allows you to test queries and see how the MCP server responds
  4. Take a look at the official docs

    Official server developers guide: https://modelcontextprotocol.io/quickstart/server

    More on the inspector: https://modelcontextprotocol.io/docs/tools/inspector

Connect Your AI Tool to the Server

You can configure the MCP server for your AI assistant by creating an MCP configuration file:

{
   "mcpServers": {
      "postgres": {
         "command": "/path/to/uv",
         "args": [
            "--directory",
            "/path/to/simple-psql-mcp",
            "run",
            "postgres"
         ],
         "env": {
            "DSN": "postgresql://username:password@localhost:5432/my-db",
            "SCHEMA": "public"
         }
      }
   }
}

Alternatively, you can generate this config file using the included script:

# Make the script executable
chmod +x generate_mcp_config.sh

# Run the configuration generator
./generate_mcp_config.sh

When prompted, enter your PostgreSQL DSN and schema name.

How to use it

You can now ask the LLM questions about your data in natural language:

  • "What are all the tables in my database?"
  • "Show me the top 5 users by creation date"
  • "Count addresses by state"

For testing, Claude Desktop supports MCP natively and works with all features (tools, resources, and prompts) right out of the box.

Example Database (Optional)

If you don't have a database ready or encounter connection issues, you can use the included example database:

# Make the script executable
chmod +x example-db/create-db.sh

# Run the database setup script
./example-db/create-db.sh

This script creates a Docker container with a PostgreSQL database pre-populated with sample users and addresses tables. After running, you can connect using:

npx @modelcontextprotocol/inspector uv --directory . run postgres -e DSN=postgresql://postgres:postgres@localhost:5432/user_database -e SCHEMA=public

Next Steps

To extend this project with your own MCP servers:

  1. Create a new directory under /src (e.g., /src/my-new-mcp)
  2. Implement your MCP server following the PostgreSQL example
  3. Add your new MCP to pyproject.toml:
[project.scripts]
postgres = "src.postgres:main"
my-new-mcp = "src.my-new-mcp:main"

You can then run your new MCP with:

npx @modelcontextprotocol/inspector uv --directory . run my-new-mcp

Documentation

Security

This is an experimental project meant to empower developers to create their own MCP server. I did minimum to make sure it won't die immediately when you try it, but be careful - it's very easy to run SQL injections with this tool. The server will check if the query starts with SELECT, but beyond that nothing is guaranteed. TL;DR - don't run in production unless you're the founder and there are no paying clients.

License

MIT

相关推荐

  • NiKole Maxwell
  • I craft unique cereal names, stories, and ridiculously cute Cereal Baby images.

  • Emmet Halm
  • Converts Figma frames into front-end code for various mobile frameworks.

  • https://maiplestudio.com
  • Find Exhibitors, Speakers and more

  • Yusuf Emre Yeşilyurt
  • I find academic articles and books for research and literature reviews.

  • https://suefel.com
  • Latest advice and best practices for custom GPT development.

  • Carlos Ferrin
  • Encuentra películas y series en plataformas de streaming.

  • Joshua Armstrong
  • Confidential guide on numerology and astrology, based of GG33 Public information

  • https://zenepic.net
  • Embark on a thrilling diplomatic quest across a galaxy on the brink of war. Navigate complex politics and alien cultures to forge peace and avert catastrophe in this immersive interstellar adventure.

  • https://reddgr.com
  • Delivers concise Python code and interprets non-English comments

  • Elijah Ng Shi Yi
  • Advanced software engineer GPT that excels through nailing the basics.

  • 林乔安妮
  • A fashion stylist GPT offering outfit suggestions for various scenarios.

  • Daren White
  • A supportive coach for mastering all Spanish tenses.

  • ariofarmani
  • Test repository for GitHub MCP server functionality

  • 1Panel-dev
  • 💬 MaxKB is an open-source AI assistant for enterprise. It seamlessly integrates RAG pipelines, supports robust workflows, and provides MCP tool-use capabilities.

  • ShrimpingIt
  • Micropython I2C-based manipulation of the MCP series GPIO expander, derived from Adafruit_MCP230xx

  • Mintplex-Labs
  • The all-in-one Desktop & Docker AI application with built-in RAG, AI agents, No-code agent builder, MCP compatibility, and more.

  • GLips
  • MCP server to provide Figma layout information to AI coding agents like Cursor

    Reviews

    2 (1)
    Avatar
    user_hjBUCLyH
    2025-04-16

    I've been using simple-psql-mcp by NetanelBollag, and it has significantly simplified my interactions with PostgreSQL. The integration was seamless, and the documentation on the GitHub page is clear and helpful. It's a must-have tool for anyone looking to streamline their database management processes. Highly recommended!