polardbx-mcp

What is polardbx-mcp?

polardbx-mcp is a Model Context Protocol (MCP) server that provides tools and resources, allowing AI agents to interact with Alibaba Cloud PolarDB-X databases.

How to use polardbx-mcp?

Install globally via npm (npm install -g polardbx-mcp) or build from source. Configure database connection using environment variables POLARDB_X_HOST, POLARDB_X_PORT, POLARDB_X_USER, POLARDB_X_PASSWORD, and POLARDB_X_DATABASE. Then start the server and configure your MCP client (e.g., Cline) to use the server with the same environment variables.

Key features of polardbx-mcp

• Run SQL queries on PolarDB-X databases
• Inspect PolarDB-X database status
• List all available PolarDB-X SQL commands
• Access table schema information as resources
• Simple npm or source-based installation

Use cases of polardbx-mcp

• Let an AI assistant execute and analyze SQL queries on a PolarDB-X database
• Allow an AI agent to inspect database health and status
• Enable AI tools to explore table schemas for data understanding

FAQ from polardbx-mcp

What tools does polardbx-mcp provide?

It provides three tools: query to run SQL, inspect database status to check database state, and show all commands to list all PolarDB-X SQL commands.

What resources does polardbx-mcp expose?

It exposes table schemas as resources in the format polardbx://<database_name>/<table_name>, providing JSON schema information including column names and data types.

What are the runtime requirements?

polardbx-mcp requires Node.js and npm. For source builds, you also need to install dependencies (npm install) and build the project (npm run build).

How is the database connection configured?

Connection is configured via environment variables: POLARDB_X_HOST, POLARDB_X_PORT, POLARDB_X_USER, POLARDB_X_PASSWORD, and POLARDB_X_DATABASE. These can be set in a .env file or passed directly to the MCP client configuration.

Is authentication supported?

Yes, authentication is handled via the POLARDB_X_USER and POLARDB_X_PASSWORD environment variables. The server uses these credentials to connect to PolarDB-X. No other authentication methods (e.g., OAuth) are mentioned.