Postgresql Products MCP Server

🚀 PostgreSQL Product MCP Server

This is a server based on the Model Context Protocol (MCP) for interacting with a PostgreSQL database containing product information. It allows clients (e.g., AI assistants) to query the database using SQL.

🚀 Quick Start

✨ Features

• A server based on the Model Context Protocol (MCP) that enables interaction with a PostgreSQL database containing product information.
• Allows clients such as AI assistants to query the database using SQL.

📦 Installation

Prerequisites

• Node.js (v18 or higher recommended)
• npm or yarn
• Access to a PostgreSQL database with a products schema.

Steps

1. Clone this repository (or download the source code):

git clone https://github.com/michael7736/postgres-mcp-server.git
cd postgres-mcp-server

2. Install dependencies:

npm install
# or
yarn install

🔧 Build

Compile the TypeScript code to JavaScript:

npm run build
# or
yarn build

This will create an executable file (build/index.js) in the build/ directory.

🛠️ Configuration

This server requires PostgreSQL connection details to be provided via environment variables, which are used when configuring your MCP client settings (e.g., cline_mcp_settings.json or claude_desktop_config.json).

The required environment variables include:

• PGHOST: The hostname of the PostgreSQL server.
• PGPORT: The port number of the PostgreSQL server (default: 5432).
• PGUSER: The username for the database connection.
• PGPASSWORD: The password for the database connection.
• PGDATABASE: The name of the database to connect to.

Example MCP settings configuration:

{
  "mcpServers": {
    "postgres-products": {
      "command": "node",
      "args": ["/path/to/your/postgres-mcp-server/build/index.js"],
      "env": {
        "PGHOST": "your_db_host",
        "PGPORT": "5432",
        "PGUSER": "your_db_user",
        "PGPASSWORD": "your_db_password",
        "PGDATABASE": "your_db_name"
      },
      "disabled": false, // Ensure it is enabled
      "autoApprove": [] // Configure auto - approval if needed
    }
    // ... other servers
  }
}

Replace /path/to/your/postgres-mcp-server/build/index.js with the actual path to the built file on your system and fill in your specific database credentials in the env section.

💻 Usage Examples

Basic Usage

After configuration and running this server through your MCP client, the server provides the following tool:

run_sql_query

Execute a read - only SQL query (SELECT statements only) against the configured product database.

Input Schema:

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "The SQL SELECT query to execute."
    }
  },
  "required": ["query"]
}

Example tool call:

<use_mcp_tool>
  <server_name>postgres-products</server_name>
  <tool_name>run_sql_query</tool_name>
  <arguments>
  {
    "query": "SELECT product_name, stock_quantity FROM products WHERE category = 'Electronics';"
  }
  </arguments>
</use_mcp_tool>