PostgreSQL MCP server

The MCP PostgreSQL Server provides database operations through the Model Context Protocol (MCP), allowing you to perform CRUD operations on user data in a PostgreSQL database with a type-safe interface. It's built with TypeScript and uses Prisma for database interactions.

Installation

Prerequisites

• Node.js and npm
• Docker (for running PostgreSQL)

Setup Steps

1. Clone the repository and install dependencies:

git clone https://github.com/a21071/mcp-postgres.git
cd mcp-postgres
npm install

2. Start the PostgreSQL database using Docker:

docker-compose up -d

3. Run database migrations:

npx prisma migrate dev

4. Build the project:

npm run build

Usage

Starting the Server

Run the MCP server with:

npm start

Available MCP Tools

The server provides several tools for interacting with the PostgreSQL database:

Retrieving User Data

Use the getData tool to fetch user information:

{
  "tableName": "user"
}

Adding a New User

Use the addUserData tool to create a new user:

{
  "email": "[email protected]",
  "name": "John Doe",
  "age": 30
}

Deleting User Data

Use the deleteUserData tool to remove a user by ID, email, or name:

{
  "id": "clxyz...",
  "email": "[email protected]",
  "name": "John Doe"
}

Updating User Information

Use the updateUserData tool to modify user details:

{
  "id": "clxyz...",
  "email": "[email protected]",
  "name": "New Name"
}

Database Schema

The server uses the following Prisma schema for the User model:

model User {
  id        String   @id @default(cuid())
  email     String   @unique
  name      String?
  age       Int?
  createdAt DateTime @default(now())
  posts     Post[]
}

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "mcp-postgres" '{"command":"npm","args":["start"]}'

See the official Claude Code MCP documentation for more details.

For 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 > Tools & Integrations and click "New MCP Server".

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

{
    "mcpServers": {
        "mcp-postgres": {
            "command": "npm",
            "args": [
                "start"
            ]
        }
    }
}

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 explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "mcp-postgres": {
            "command": "npm",
            "args": [
                "start"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect