Azure Postgresql MCP

🚀 Azure Database for PostgreSQL MCP Server (Preview)

Azure Database for PostgreSQL MCP Server is a server based on the Model Context Protocol (MCP), designed to provide users with the ability to connect to Azure Database for PostgreSQL. The service is currently in preview, and its features are continuously being developed and improved.

🚀 Quick Start

Prerequisites

1. Install a Python environment.
2. Download and install Azure Database for PostgreSQL MCP Server.

Installation Steps

# Create a virtual environment
python -m venv azure_postgres_mcp

# Activate the virtual environment
source azure_postgres_mcp/bin/activate

# Install dependencies
pip install -r requirements.txt

Configure the MCP Client (Claude Desktop)

1. Open the claude_desktop_config.json file.
2. Add the following configuration:

{
    "mcp": {
        "servers": {
            "azure-postgresql-mcp": {
                "command": "<path to the virtual environment>/Scripts/python",
                "args": [
                    "<path to the azure_postgresql_mcp.py file>"
                ],
                "env": {
                    "PGHOST": "<Fully qualified domain name of the Azure Database for PostgreSQL instance>",
                    "PGUSER": "<Username>",
                    "PGPASSWORD": "<Password>",
                    "PGDATABASE": "<Database name>"
                }
            }
        }
    }
}

Configure the MCP Client (Visual Studio Code)

1. Open the Visual Studio Code settings.
2. Enter MCP in the search bar and select to edit the settings.json file.
3. Add the following configuration:

{
    "mcp": {
        "servers": {
            "azure-postgresql-mcp": {
                "command": "<path to the virtual environment>/Scripts/python",
                "args": [
                    "<path to the azure_postgresql_mcp.py file>"
                ],
                "env": {
                    "PGHOST": "<Fully qualified domain name of the Azure Database for PostgreSQL instance>",
                    "PGUSER": "<Username>",
                    "PGPASSWORD": "<Password>",
                    "PGDATABASE": "<Database name>"
                }
            }
        }
    }
}

✨ Features

• Connection Protocol: Supports connecting to Azure Database for PostgreSQL via the Model Context Protocol.
• Toolset: Provides a series of tools and interfaces to facilitate database management and operations for users.
• Authentication: Supports multiple authentication methods, including Microsoft Entra authentication (recommended).

💻 Usage Examples

Use the Microsoft Entra Authentication Method

To connect to the Azure Database for PostgreSQL MCP Server using Microsoft Entra authentication, update the configurations in the claude_desktop_config.json file (Claude Desktop) and the settings.json file (Visual Studio Code):

{
    "azure-postgresql-mcp": {
        "command": "<path to the virtual environment>/Scripts/python",
        "args": [
            "<path to the azure_postgresql_mcp.py file>"
        ],
        "env": {
            "PGHOST": "<Fully qualified domain name of the Azure Database for PostgreSQL instance>",
            "PGUSER": "<Microsoft Entra ID username or system-assigned identifier name of the Azure resource>",
            "AZURE_USE_AAD": "True",
            "AZURE_SUBSCRIPTION_ID": "<Your Azure subscription ID>",
            "AZURE_RESOURCE_GROUP": "<Resource group containing the Azure Database for PostgreSQL instance>"
        }
    }
}

🤝 Contribution Guidelines

The Azure Database for PostgreSQL MCP Server is currently in preview. If you have any questions or suggestions, please refer to the CONTRIBUTING.md file.

📄 License

This project is licensed under the MIT License. For detailed information, please refer to the LICENSE file.