alibabacloud-dms

This MCP server provides a unified interface to Alibaba Cloud DMS data sources and other supported databases through a natural-language to SQL pipeline. It includes a built-in NL2SQL component that parses user questions, maps them to the appropriate database and table structures, and executes generated SQL queries against the connected data sources. The server exposes a suite of tools for managing data source instances, querying metadata, exploring schemas, executing SQL scripts, and handling data change orders. Developers can ask questions like: “What are the top 10 customers by order value this month?” or “Show me the rows of table orders limited to 20.” The multi-instance mode supports managing multiple database instances across different environments, while the single-database mode focuses on a predefined target database via a connection string. You can use the available tools to add instances, list databases and tables, inspect table details, run scripts, and manage DMS orders and approvals. In practice, this enables secure, audited, and language-driven data access across a broad ecosystem of data sources.

Prerequisites:

• Node.js (LTS version) and npm installed on your machine, or access to a container/docker runtime if deploying via container.
• Internet connectivity to fetch the MCP server package from npm registry.

Installation steps (Node/npx):

1. Ensure Node.js and npm are installed
   • node -v
   • npm -v
2. Install and run the MCP server using npx (no permanent global install needed):
   • npx -y aliyun-alibabacloud-dms-mcp-server
3. If you prefer a persistent install, you can install the package locally:
   • npm install --save aliyun-alibabacloud-dms-mcp-server
   • node node_modules/aliyun-alibabacloud-dms-mcp-server/index.js
4. Configure the server:
   • Provide your DMS connection details, credentials, and environment configurations either via a config file (JSON/YAML) or environment variables as supported by the server (for example, DMS_MCP_CONFIG or DMS_CONNECTION_STRING).
5. Start the server and verify:
   • Ensure the server process is running and accessible via the configured port.
   • Use the built-in tools (addInstance, listInstances, executeScript, etc.) to validate connectivity and basic operations.

Alternative (Docker):

• If a Docker image is provided, pull and run the container: docker run -d --name aliyun-dms-mcp -p 8080:8080 aliyun/alibabacloud-dms-mcp-server:latest
• Then configure environment variables or mounted config files as required by the image (e.g., DMS_CONNECTION_STRING, DMS_MCP_CONFIG).

Prerequisites summary:

• Node.js and npm or Docker
• Access to Alibaba Cloud DMS credentials and endpoint information
• Optional: a configuration file to tailor multi-instance vs single-database modes and tool permissions.

Tips and notes:

• Start with the single-database mode if you have a fixed target database to simplify access control and performance.
• In multi-instance mode, organize instances by environment (prod, staging, dev) to keep access permissions clear.
• Ensure your environment variables (like DMS_CONNECTION_STRING or DMS_MCP_CONFIG) are secured and not leaked in logs.
• The Tool List in the README indicates available actions (addInstance, listInstances, getTableDetailInfo, executeScript, etc.). Use these to build complex queries and data exploration flows.
• If you encounter issues connecting to data sources behind a firewall or VPC, enable Intranet Access Support and verify network routing, TLS configurations, and required ports.
• Enable SQL audit trails if you require full traceability for regulatory compliance.
• Review any dependencies or required secrets (passwords, API keys) and manage them via environment management solutions or secret stores.