Skip to content

Commit d64cf26

Browse files
author
tianzhen.wtz
committed
init readme2
1 parent 1080bcb commit d64cf26

File tree

4 files changed

+79
-13
lines changed

4 files changed

+79
-13
lines changed

‎README.md

Lines changed: 68 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,71 @@
1-
# Alibaba Cloud DMS MCP Server
1+
<!-- 顶部语言切换 -->
22

3-
A Model Context Protocol server for Alibaba Cloud DMS(Data Management).
3+
<p align="center">English | <a href="/doc/README-zh-cn.md">中文</a><br></p>
4+
5+
6+
# AlibabaCloud DMS MCP Server
7+
8+
**AI-powered unified data management gateway** that supports connection to over 30+ data sources, serving as a multi-cloud universal data MCP Server to address cross-source data secure access in one-stop solution.
9+
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.
12+
13+
<img src="images/architecture-0508.jpg" alt="Ding" width="60%">
414

5-
This server facilitates unified metadata access and cross-engine data querying for large language models working with diverse database ecosystems.
615

716
---
817

9-
## Overview
10-
**DMS MCP Server** provides:
11-
- Standardized interface for database metadata operations
18+
## Core Features
19+
Provides AI with a unified **data access layer** and **metadata access layer**, solving through standardized interfaces:
20+
- Maintenance costs caused by data source fragmentation
21+
- Compatibility issues between heterogeneous protocols
22+
- Security risks from uncontrolled account permissions and non-auditable operations
23+
24+
Key features via MCP include:
25+
- **NL2SQL**: Execute SQL via natural language to obtain data results
26+
- **Code Generation**: Retrieve schema information through this service to generate DAO code or perform structural analysis
27+
- **Data Retrieval**: Automatically route SQL to accurate data sources for business support
28+
- **Security**: Fine-grained access control and auditability
29+
1230

1331
---
1432

15-
## Configuration
16-
Download from Github
17-
```shell
33+
## Supported Data Sources
34+
| DataSource/Tool | **NL2SQL** *nlsql* | **Execute script** *executeScript* | **Show schema** *getTableDetailInfo* | **Access control** *default* | **Audit log** *default* |
35+
|-----------------------|--------------------|------------------------------------|--------------------------------------|-----------------------------|------------------------|
36+
| MySQL | ✅ | ✅ | ✅ | ✅ | ✅ |
37+
| MariaDB | ✅ | ✅ | ✅ | ✅ | ✅ |
38+
| PostgreSQL | ✅ | ✅ | ✅ | ✅ | ✅ |
39+
| Oracle | ✅ | ✅ | ✅ | ✅ | ✅ |
40+
| SQLServer | ✅ | ✅ | ✅ | ✅ | ✅ |
41+
| Redis | ✅ | ✅ | ✅ | ✅ | ✅ |
42+
| MongoDB | ✅ | ✅ | ✅ | ✅ | ✅ |
43+
| StarRocks | ✅ | ✅ | ✅ | ✅ | ✅ |
44+
| Clickhouse | ✅ | ✅ | ✅ | ✅ | ✅ |
45+
| SelectDB | ✅ | ✅ | ✅ | ✅ | ✅ |
46+
| DB2 | ✅ | ✅ | ✅ | ✅ | ✅ |
47+
| OceanBase | ✅ | ✅ | ✅ | ✅ | ✅ |
48+
| Gauss | ✅ | ✅ | ✅ | ✅ | ✅ |
49+
| BigQuery | ✅ | ✅ | ✅ | ✅ | ✅ |
50+
| PolarDB | ✅ | ✅ | ✅ | ✅ | ✅ |
51+
| PolarDB-X | ✅ | ✅ | ✅ | ✅ | ✅ |
52+
| AnalyticDB | ✅ | ✅ | ✅ | ✅ | ✅ |
53+
| Lindorm | ✅ | ✅ | ✅ | ✅ | ✅ |
54+
| TableStore | ✅ | ✅ | ✅ | ✅ | ✅ |
55+
| Maxcompute | ✅ | ✅ | ✅ | ✅ | ✅ |
56+
| Hologres | ✅ | ✅ | ✅ | ✅ | ✅ |
57+
58+
---
59+
60+
## Getting Started
61+
### Download the Code
62+
```bash
1863
git clone https://github.com/aliyun/alibabacloud-dms-mcp-server.git
1964
```
20-
Add the following configuration to the MCP client configuration file:
21-
```json5
65+
66+
### Configure MCP Client
67+
Add the following content to the configuration file:
68+
```json
2269
"mcpServers": {
2370
"dms-mcp-server": {
2471
"command": "uv",
@@ -31,11 +78,20 @@ Add the following configuration to the MCP client configuration file:
3178
"env": {
3279
"ALIBABA_CLOUD_ACCESS_KEY_ID": "access_id",
3380
"ALIBABA_CLOUD_ACCESS_KEY_SECRET": "access_key",
34-
"ALIBABA_CLOUD_SECURITY_TOKEN": "sts_security_token" // optional, required when using STS Token
81+
"ALIBABA_CLOUD_SECURITY_TOKEN": "sts_security_token optional, required when using STS Token"
3582
}
3683
}
3784
}
3885
```
3986

87+
---
88+
89+
## Contact us
90+
91+
For any questions or suggestions, join the[Alibaba Cloud DMS MCP Group](https://h5.dingtalk.com/circle/joinCircle.html?corpId=dinga0bc5ccf937dad26bc961a6cb783455b&token=2f373e6778dcde124e1d3f22119a325b&groupCode=v1,k1) (DingTalk Group ID: 113455011677) .
92+
93+
<img src="images/ding-en.jpg" alt="Ding" width="40%">
94+
95+
4096
## License
4197
This project is licensed under the Apache 2.0 License.

‎doc/README-zh-cn.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
<!-- 顶部语言切换 -->
2+
3+
<p align="center"><a href="../README.md">English</a> | 中文<br></p>
4+
15
# AlibabaCloud DMS MCP Server
26

37
**AI 首选的统一数据管理网关，支持30多种数据源**连接的多云通用数据MCP Server，一站式解决**跨源数据安全访问**。
48

59
- 支持阿里云全系：RDS、PolarDB、ADB系列、Lindorm系列、TableStore系列、Maxcompute系列。
610
- 支持主流数据库/数仓：MySQL、MariaDB、PostgreSQL、Oracle、SQLServer、Redis、MongoDB、StarRocks、Clickhouse、SelectDB、DB2、OceanBase、Gauss、BigQuery等。
711

8-
![architecture](images/architecture-0508.jpg)
12+
<img src="../images/architecture-0508.jpg" alt="Ding" width="60%">
913

1014
---
1115

@@ -79,6 +83,12 @@ git clone https://github.com/aliyun/alibabacloud-dms-mcp-server.git
7983

8084
---
8185

86+
## Contact us
87+
88+
如果您有使用问题或建议, 请加入[Alibaba Cloud DMS MCP讨论组](https://h5.dingtalk.com/circle/joinCircle.html?corpId=dinga0bc5ccf937dad26bc961a6cb783455b&token=2f373e6778dcde124e1d3f22119a325b&groupCode=v1,k1) (钉钉群号: 113455011677) 进行讨论.
89+
90+
<img src="../images/ding-en.jpg" alt="Ding" width="40%">
91+
8292

8393
## License
8494
This project is licensed under the Apache 2.0 License.

‎images/ding-en.jpg

188 KB
Loading

‎images/ding-zh-cn.jpg

191 KB
Loading

0 commit comments

Comments
 (0)