Skip to content

Commit 03bb017

Browse files
author
依诺
committed
Update README
1 parent fcfc3d1 commit 03bb017

File tree

1 file changed

+43
-20
lines changed

1 file changed

+43
-20
lines changed

README.md

Lines changed: 43 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,38 @@
55

66
# AlibabaCloud DMS MCP Server
77

8-
**AI-powered unified data management gateway** that supports connection to over 40+ data sources, serving as a multi-cloud universal data MCP Server to address cross-source data secure access in one-stop solution.
8+
**AI-Era Data Security Access Gateway |Intelligent Data Query Engine|Supports 40+ Data Sources**
99

10-
- Supports full Alibaba Cloud series: RDS, PolarDB, ADB series, Lindorm series, TableStore series, MaxCompute series.
11-
- Supports mainstream databases/warehouses: MySQL, MariaDB, PostgreSQL, Oracle, SQLServer, Redis, MongoDB, StarRocks, Clickhouse, SelectDB, DB2, OceanBase, Gauss, BigQuery, etc.
10+
---
1211

13-
<img src="images/architecture-0508.jpg" alt="Architecture" width="60%">
12+
## Core Features
13+
**Secure Access**
14+
- **Account and Password Security Management**:Safely manage database account passwords without manual maintenance, effectively preventing sensitive information leakage.
15+
- **Fine-grained Permission Control**:Supports instance, database, table, field, and row-level access control, precisely restricting caller permissions to prevent unauthorized operations and ensure data security.
16+
- **High-risk SQL Identification and Blocking**: Built-in rich rule engine that identifies and blocks potential high-risk SQL in real time to mitigate security risks.
17+
- **SQL Audit Trail**: Records all SQL operation logs, supporting full traceability and compliance audits to meet regulatory requirements.
1418

15-
[//]: # (<img src="https://dms-static.oss-cn-hangzhou.aliyuncs.com/mcp-readme/architecture-0508.jpg" alt="Architecture" width="60%">)
19+
**Intelligent Data Inquiry**
20+
- **Built-in NL2SQL Algorithm**: Based on natural language input questions, it intelligently matches data tables, understands business semantics within tables, generates and executes SQL queries, and quickly obtains results.
21+
- **Personalized Knowledge Base**: Built-in metadata and [knowledge base](https://help.aliyun.com/zh/dms/knowledge-base-management?) for data inquiry, supports custom business knowledge and query patterns to build tailored intelligent data inquiry capabilities aligned with business scenarios.
1622

23+
**Multi-data Source Support**
24+
- **Wide Range of Data Source Support**: Supports over 40 mainstream databases/data warehouses, enabling unified access and integration from multiple sources.
25+
- **Unified Management Across Environments**: Supports centralized management of database instances across development, testing, and production environments to improve operational efficiency.
26+
- **Seamless Integration Across Platforms**: Covers major cloud platforms such as Alibaba Cloud and AWS, as well as self-built databases/data warehouses, effectively reducing maintenance costs.
1727

1828
---
1929

20-
## Core Features
21-
Provides AI with a unified **data access layer** and **metadata access layer**, solving through standardized interfaces:
22-
- Maintenance costs caused by data source fragmentation
23-
- Compatibility issues between heterogeneous protocols
24-
- Security risks from uncontrolled account permissions and non-auditable operations
25-
26-
Key features via MCP include:
27-
- **NL2SQL**: Execute SQL via natural language to obtain data results
28-
- **Code Generation**: Retrieve schema information through this service to generate DAO code or perform structural analysis
29-
- **Data Retrieval**: Automatically route SQL to accurate data sources for business support
30-
- **Security**: Fine-grained access control and auditability
31-
- **Data Migration**: Configure data migration tasks
30+
## Supported Ecosystem
31+
- Supports all Alibaba Cloud data sources: RDS, PolarDB, ADB series, Lindorm series, TableStore series, Maxcompute series.
32+
- Supports mainstream databases/data warehouses: MySQL, MariaDB, PostgreSQL, Oracle, SQLServer, Redis, MongoDB, StarRocks, Clickhouse, SelectDB, DB2, OceanBase, Gauss, BigQuery, etc.
33+
---
34+
35+
## Core Architecture
36+
<img src="images/architecture-0508.jpg" alt="Architecture" width="60%">
37+
38+
[//]: # (<img src="https://dms-static.oss-cn-hangzhou.aliyuncs.com/mcp-readme/architecture-0508.jpg" alt="Architecture" width="60%">)
39+
3240

3341
---
3442

@@ -51,7 +59,7 @@ You are a company DBA who needs to manage and access various types of database i
5159
### Mode Two: Single Database Mode
5260
- Directly specify the target database by configuring the `CONNECTION_STRING` parameter in the server (format: `dbName@host:port`).
5361
- Suitable for scenarios that focus on accessing a single database.
54-
#### Scenario Example:
62+
#### Scenario Example 1:
5563
You are a developer who frequently accesses a fixed database (e.g., `mydb@192.168.1.100:3306`) for development and testing. Set the `CONNECTION_STRING` parameter in the DMS MCP Server configuration as follows:
5664
```ini
5765
CONNECTION_STRING = mydb@192.168.1.100:3306
@@ -64,6 +72,21 @@ Afterward, every time the service starts, the DMS MCP Server will directly acces
6472
- Retrieve the first 20 rows from the `test_table` table.
6573
- Use a tool to answer: "What is today's user traffic?"
6674

75+
#### Scenario Example 2:
76+
You are a data analyst at an e-commerce company, needing to frequently query and analyze business data such as orders, users, and products. The company's core business database is located at ecommerce@10.20.30.40:3306.
77+
78+
Configure the following parameters in DMS MCP Server:
79+
```ini
80+
CONNECTION_STRING = ecommerce@10.20.30.40:3306
81+
```
82+
Simply ask questions in natural language, and DMS MCP will parse the question into SQL and return the results.
83+
84+
**Typical Question Examples:**
85+
- What is the total number of orders today?
86+
- How are the order counts ranked by province?
87+
- What is the number of new users each day over the past 7 days?
88+
- Which product category has the highest sales revenue?
89+
6790
---
6891
## Tool List
6992
| Tool Name | Description | Applicable Mode |
@@ -115,9 +138,9 @@ Afterward, every time the service starts, the DMS MCP Server will directly acces
115138

116139
---
117140
## Prerequisites
118-
- uv is installed
141+
- [uv](https://docs.astral.sh/uv/getting-started/installation/) is installed
119142
- Python 3.10+ is installed
120-
- An AK/SK or STS Token with access rights to Alibaba Cloud DMS(AliyunDMSFullAccess)
143+
- An [AK/SK](https://www.alibabacloud.com/help/en/doc-detail/116811.html) or [STS Token](https://www.alibabacloud.com/help/en/ram/product-overview/what-is-sts) with access rights to Alibaba Cloud DMS(AliyunDMSFullAccess).Add permission operations, see [Authorization Management](https://www.alibabacloud.com/help/en/ram/user-guide/authorization-management/).
121144

122145
---
123146
## Pre-configuration

0 commit comments

Comments
 (0)