MCP Server Template

🚀 PostgreSQL Model Context Protocol (Model Context Protocol) Server

This server provides read-only access to PostgreSQL databases, enabling Large Language Models (LLMs) to inspect the database schema and execute read-only queries.

🚀 Quick Start

The following sections will introduce the components, usage, and construction methods of this server.

✨ Features

Tools

• query
  • Execute read-only SQL queries against the connected database.
  • Input: sql (string): The SQL query to be executed.
  • All queries are executed within a read-only transaction.

Resources

The server provides schema information for each table:

• Table Schema (postgres://<host>/<table>/schema)
  • JSON schema information for each table.
  • Includes column names and data types.
  • Automatically discovered from database metadata.

💻 Usage Examples

Using with Claude Desktop

To use this server with the Claude Desktop application, add the following configuration to the "mcpServers" section of the claude_desktop_config.json file:

Docker

• When running Docker on macOS, if the server is running on the host network (e.g., localhost), use host.docker.internal.
• Usernames and passwords can be added via the PostgreSQL URL in the format postgresql://user:password@host:port/db-name.

{
  "mcpServers": {
    "postgres": {
      "command": "docker",
      "args": [
        "run", 
        "-i", 
        "--rm", 
        "mcp/postgres", 
        "postgresql://host.docker.internal:5432/mydb"
      ]
    }
  }
}

NPX

{
  "mcpServers": {
    "postgres": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-postgres",
        "postgresql://localhost/mydb"
      ]
    }
  }
}

Replace /mydb with your own database name.

📦 Installation

Building

Docker:

docker build -t mcp/postgres -f src/postgres/Dockerfile .

📄 License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms of the MIT License. For more details, please refer to the LICENSE file in the project repository.