Postgres MCP Server

🚀 Postgres - MCP Server

A PostgreSQL Model Context Protocol Server that enables your LLM (Large Language Model) to interact with its local database.

🚀 Quick Start

This is a PostgreSQL Model Context Protocol Server, allowing your LLM (Large Language Model) to interact with its local database.

⚠️ Important Note

This is still experimental. Do not use it on a real - world database and be cautious with write queries!

📦 Installation

Prerequisites

• Install nodeJS.
• Run npm install to install project dependencies.
• Set the following environment variables:

DATABASE_NAME="Your database name"
DATABASE_USER="Your database user"
DATABASE_PASSWORD="Your database password"
DATABASE_SCHEMA_NAME="Your database schema name" # Usually `public`

💻 Usage Examples

Simple configuration in VSCode, add to settings.json:

{
  "chat.mcp.discovery.enabled": true,
  "mcp": {
    "postgresql-database": {
      "command": "npm",
      "type": "stdio",
      "args": ["start", "--prefix", "/path/to/code/postgres-mcp-server"],
      "env": {
        "CUSTOM_INSTRUCTIONS": "The database name is related to the currently active Git branch and always has the same structure: jira_xxxxx, where jira_xxxxx represents the Jira issue number. This Jira issue number is always used at the beginning of the Git branch. Therefore, you should be able to obtain it from the current branch and generate the database name",
        "DATABASE_NAME": "my-database-name",
        "DATABASE_USER": "my-user",
        "DATABASE_PASSWORD": "my-password",
        "DATABASE_SCHEMA_NAME": "public"
      }
    }
  }
}