PostgreSQL MCP server

PostgreSQL-MCP is a PostgreSQL database interface service based on the MCP framework. It provides simple and easy-to-use tools for PostgreSQL database operations, allowing you to interact with your PostgreSQL databases through a consistent interface.

Installation

To install PostgreSQL-MCP, follow these steps:

1. Clone the repository
2. Create a virtual environment and install dependencies:

cd postgresql-mcp
python -m venv .venv
source .venv/bin/activate  # Linux/Mac
# or
.venv\Scripts\activate  # Windows
pip install -e .

Usage

Configuration

You can configure the database connection through environment variables or command-line parameters.

Using Environment Variables

# Configure through environment variables
export POSTGRES_HOST=localhost
export POSTGRES_PORT=5432
export POSTGRES_USER=postgres
export POSTGRES_PASSWORD=postgres
export POSTGRES_DATABASE=postgres

# Start the service
python postgresql-mcp.py

Using Command-line Parameters

python postgresql-mcp.py --host localhost --port 5432 --user postgres --password postgres --database postgres

Key Features

PostgreSQL-MCP provides several core functionalities:

• Execute Query: Run SQL queries on your PostgreSQL database
• List Tables: View all tables in a specified schema
• Describe Table: Get detailed table structure information
• List Schemas: Display all schemas in the database

Important Notes

Before using PostgreSQL-MCP, make sure that your PostgreSQL server is running and accessible with the credentials you've provided.

How to add this MCP server to Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > MCP and click "Add new global MCP server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.