Provides tools for interacting with Alibaba Cloud's PolarDB-X databases, enabling SQL query execution, database status inspection, and access to table schemas and database structure information.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@PolarDB-X MCP Servershow me the top 5 customers by total orders"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
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-mcpOption 2: Build from source
Clone this repository:
Install dependencies and build:
npm install
npm run buildConfigure 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_nameStart the server:
npm startRelated MCP server: DataWorks MCP Server
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
This server cannot be installed
Resources
Looking for Admin?
Admins can modify the Dockerfile, update the server description, and track usage metrics. If you are the server author, to access the admin panel.