Alibabacloud Adbpg MCP Server

🚀 AnalyticDB PostgreSQL MCP Server

The AnalyticDB PostgreSQL MCP Server serves as a universal interface between the AI Agent and the AnalyticDB PostgreSQL database, enabling seamless communication between the two. It assists the AI Agent in retrieving database metadata and executing SQL operations.

🚀 Quick Start

📦 Installation

Download

Download from Github:

git clone git@github.com:aliyun/alibabacloud-adbpg-mcp-server.git

MCP Integration

Add the following configuration to the MCP client configuration file:

"mcpServers": {
  "adbpg-mcp-server": {
    "command": "uv",
    "args": [
      "--directory",
      "/path/to/adbpg-mcp-server",
      "run",
      "adbpg-mcp-server"
    ],
    "env": {
      "ADBPG_HOST": "host",
      "ADBPG_PORT": "port",
      "ADBPG_USER": "username",
      "ADBPG_PASSWORD": "password",
      "ADBPG_DATABASE": "database"
    }
  }
}

✨ Features

🛠️ Tools

• execute_select_sql: Execute a SELECT SQL query on the AnalyticDB PostgreSQL server.
• execute_dml_sql: Execute DML (INSERT, UPDATE, DELETE) SQL queries on the AnalyticDB PostgreSQL server.
• execute_ddl_sql: Execute DDL (CREATE, ALTER, DROP) SQL queries on the AnalyticDB PostgreSQL server.
• analyze_table: Collect table statistics.
• explain_query: Obtain the query execution plan.

📚 Resources

Built-in Resources

• adbpg:///schemas: Retrieve all schemas in the database.

Resource Templates

• adbpg:///{schema}/tables: List all tables in a specific schema.
• adbpg:///{schema}/{table}/ddl: Get the DDL of a table.
• adbpg:///{schema}/{table}/statistics: Display table statistics.

🔧 Technical Details

Environment Variables

The MCP server requires the following environment variables to connect to the AnalyticDB PostgreSQL instance:

• ADBPG_HOST: Database host address
• ADBPG_PORT: Database port
• ADBPG_USER: Database username
• ADBPG_PASSWORD: Database password
• ADBPG_DATABASE: Database name

Dependencies

• Python 3.10 or higher
• Required packages:
  • mcp >= 1.4.0
  • psycopg >= 3.1.0
  • python-dotenv >= 1.0.0
  • pydantic >= 2.0.0

💻 Usage Examples

Basic Usage

# Create and activate a virtual environment
uv venv .venv
source .venv/bin/activate  # Linux/Mac
# Or
.venv\Scripts\activate     # Windows

# Install dependencies
uv pip install -e .

# Start the server
uv run adbpg-mcp-server