mcpField
P
polardbx-mcp

polardbx-mcp

Local
github.com/aliyunDatabases4Updated 18w ago
Repository

About polardbx-mcp

polardbx-mcp is an MCP server for AI agents accessing Alibaba Cloud PolarDB-X databases. It provides SQL, status, and command tools, plus table-schema resources.

Key features

  1. 01Run PolarDB-X SQL queries
  2. 02Inspect database status
  3. 03Show PolarDB-X SQL commands
  4. 04Provide table-schema resources
  5. 05Expose column names and data types

Use cases

  1. 01Query PolarDB-X data through an agent
  2. 02Check PolarDB-X database status
  3. 03Retrieve table columns and data types

MCP support

The MCP server provides clients with PolarDB-X query, status, and command tools, along with table-schema resources containing column names and data types.

#database#aliyun#alibaba#polardb#polardb-x

Configuration

Local server config is the same for every client. Copy it into your client’s MCP config file.

mcp.json · Universal config
{
  "mcpServers": {
    "alibabacloud-polardbx": {
      "command": "npx",
      "args": [
        "-y",
        "polardbx-mcp"
      ],
      "env": {
        "POLARDB_X_HOST": "<POLARDB_X_HOST>",
        "POLARDB_X_PORT": "<POLARDB_X_PORT>",
        "POLARDB_X_USER": "<POLARDB_X_USER>",
        "POLARDB_X_PASSWORD": "<POLARDB_X_PASSWORD>",
        "POLARDB_X_DATABASE": "<POLARDB_X_DATABASE>"
      }
    }
  }
}
Run commandnpx -y polardbx-mcp
Environment variables to set
POLARDB_X_HOST
POLARDB_X_PORT
POLARDB_X_USER
POLARDB_X_PASSWORDSecret
POLARDB_X_DATABASE

Local servers need a runtime on your machine (e.g. Node.js 18+). Config file locations differ by client; see your client’s docs.

Packages
npmpolardbx-mcp

Tools

No tool list yet

Local servers expose tools only once running on your machine, and the maintainer has not provided a tool list.

Details

From the project README

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
  1. 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
  1. 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

Comments

Markdown supported

New to MCP?

From what the protocol is to installing your first server, these answers cover most first questions.

An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.