What is Alibabacloud Polardbx Mcp Server

polardbx-mcp is a Model Context Protocol (MCP) server designed to facilitate interactions between AI agents and Alibaba Cloud’s PolarDB-X databases. It provides essential tools and resources for executing SQL queries, inspecting database status, and managing schema information.

Use cases

Primarily used for database management tasks, polardbx-mcp enables AI agents to query PolarDB-X databases, gather schema information, and monitor database performance. This is particularly useful in data analysis, machine learning applications, and any scenario where dynamic database interactions are required.

How to use

Users can install polardbx-mcp via npm or build it from source. After installation, configure the PolarDB-X connection parameters in a .env file, and start the server. Clients must then configure their MCP connection settings to point to the running server, specifying the database connection details.

Key features

Key features include executing SQL queries directly on PolarDB-X, retrieving and inspecting database status, and providing detailed schema information for tables. The server offers robust interaction options for managing database resources and commands.

Where to use

polardbx-mcp is ideal for environments requiring integration between AI systems and databases, particularly in cloud-based applications utilizing Alibaba’s PolarDB-X. It’s suitable for data-driven applications, analytics, and scenarios where automated database interactions occur.

polardbx-mcp

A Model Context Protocol (MCP) servers which provides tools and resources, allowing AI agent to interact with Alibaba cloud PolarDB-X databases.

Installation

Option 1: Install from npm

# Install globally
npm install -g polardbx-mcp

# Or install in current project only
npm install polardbx-mcp

Option 2: Build from source

1. Clone this repository:

2. Install dependencies and build:

npm install
npm run build

3. Configure the PolarDB-X connection in environment variable file .env:

POLARDB_X_HOST=your_database_host
POLARDB_X_PORT=your_database_port
POLARDB_X_USER=your_database_user
POLARDB_X_PASSWORD=your_database_password
POLARDB_X_DATABASE=your_database_name

4. Start the server:

npm start

Configuration for MCP Client

Example Cline Configuration if you install from npm:

{
  "mcpServers": {
    "polardbx-mcp": {
      "command": "npx",
      "args": [
        "polardbx-mcp"
      ],
      "env": {
        "POLARDB_X_HOST": "your_database_host",
        "POLARDB_X_PORT": "your_database_port",
        "POLARDB_X_USER": "your_database_user",
        "POLARDB_X_PASSWORD": "your_database_password",
        "POLARDB_X_DATABASE": "your_database_name"
      },
    }
  }
}

Example Cline Configuration if you build from source:

{
  "mcpServers": {
    "polardbx-mcp": {
      "command": "node",
      "args": [
        "path_to_mcp/polardbx-mcp/build/index.js"
      ],
      "env": {
        "POLARDB_X_HOST": "your_database_host",
        "POLARDB_X_PORT": "your_database_port",
        "POLARDB_X_USER": "your_database_user",
        "POLARDB_X_PASSWORD": "your_database_password",
        "POLARDB_X_DATABASE": "your_database_name"
      },
    }
  }
}

MCP Server Components

Tools

• query: Run a SQL query on PolarDB-X
• inspect database status: Inspect the status of PolarDB-X
• show all commands: Show all commands SQL for PolarDB-X

Resources

The server provides schema information for each table in the database:

• Table Schemas (polardbx://<database_name>/<table_name>)
  • JSON schema information for each table
  • Includes column names and data types