MCP Postgres Server

🚀 MCP PostgreSQL Server

A Model Context Protocol (MCP) server that provides PostgreSQL database operations. This server enables AI models to interact with PostgreSQL databases through a standardized interface.

🚀 Quick Start

✨ Features

• Secure connection handling with automatic cleanup.
• Support for prepared statements to prevent SQL injection.
• Support for PostgreSQL-style ($1, $2) and MySQL-style (?) parameter placeholders.
• Comprehensive error handling and validation.
• TypeScript support.
• Automated connection management.
• Support for PostgreSQL-specific syntax and features.
• Multi-schema support.

📦 Installation

Manual Installation

npm install mcp-postgres-server

Or run directly:

npx mcp-postgres-server

Configuration

The server requires the following environment variables:

{
  "mcpServers": {
    "postgres": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "mcp-postgres-server"],
      "env": {
        "PG_HOST": "your_host",
        "PG_PORT": "5432",
        "PG_USER": "your_user",
        "PG_PASSWORD": "your_password",
        "PG_DATABASE": "your_database"
      }
    }
  }
}

💻 Usage Examples

Basic Usage

The server provides several useful tools for interacting with the PostgreSQL database.

1. connect_db

Establish a connection to the PostgreSQL database using the provided credentials.

use_mcp_tool({
  server_name: "postgres",
  tool_name: "connect_db",
  arguments: {
    host: "localhost",
    port: 5432,
    user: "your_user",
    password: "your_password",
    database: "your_database"
  }
});

2. query

Execute a SELECT query, supporting optional prepared statement parameters. It supports both PostgreSQL-style ($1, $2) and MySQL-style (?) parameter placeholders.

use_mcp_tool({
  server_name: "postgres",
  tool_name: "query",
  arguments: {
    sql: "SELECT * FROM users WHERE id = $1",
    params: [1]
  }
});

3. execute

Execute an INSERT, UPDATE, or DELETE query, supporting optional prepared statement parameters. It supports both PostgreSQL-style ($1, $2) and MySQL-style (?) parameter placeholders.

use_mcp_tool({
  server_name: "postgres",
  tool_name: "execute",
  arguments: {
    sql: "INSERT INTO users (name, email) VALUES ($1, $2)",
    params: ["John Doe", "john@example.com"]
  }
});

4. list_schemas

List all schemas in the database.

use_mcp_tool({
  server_name: "postgres",
  tool_name: "list_schemas",
  arguments: {}
});

5. list_tables

List tables in the database. Accepts an optional schema parameter (default is 'public').

// List tables in the 'public' schema (default)
use_mcp_tool({
  server_name: "postgres",
  tool_name: "list_tables",
  arguments: {}
});

// List tables in a specific schema
use_mcp_tool({
  server_name: "postgres",
  tool_name: "list_tables",
  arguments: {
    schema: "my_schema"
  }
});

6. describe_table

Get the structure of a specific table. Accepts an optional schema parameter (default is 'public').

// Describe a table in the 'public' schema (default)
use_mcp_tool({
  server_name: "postgres",
  tool_name: "describe_table",
  arguments: {
    table: "users"
  }
});

// Describe a table in a specific schema
use_mcp_tool({
  server_name: "postgres",
  tool_name: "describe_table",
  arguments: {
    table: "users",
    schema: "my_schema"
  }
});

🔧 Technical Details

Security

• Use prepared statements to prevent SQL injection.
• Support secure storage of sensitive information such as passwords through environment variables.
• Strengthened authentication mechanisms.

Error Handling

• Clear error return mechanism.
• Detailed error logging.
• Customizable error handling logic.

📄 License

The specific license information is not provided in the original text. If you can provide it, I will add it here.