Skip to content

Commit 611e8ce

Browse files
authored
Optimization of README and parameters
Optimization of README and parameters
2 parents c29b27b + cc16701 commit 611e8ce

File tree

5 files changed

+80
-55
lines changed

5 files changed

+80
-55
lines changed

README.md

Lines changed: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ DMS MCP Server currently supports two usage modes.
4141
#### Scenario Example:
4242
You are a company DBA who needs to manage and access various types of database instances (e.g., MySQL, Oracle, PostgreSQL) in production, test, and development environments. With DMS MCP Server, you can achieve unified access and centralized management of these heterogeneous databases.
4343

44+
**Typical Question Examples:**
45+
- Get a list of all databases named `test`.
46+
- Retrieve details of the `test_db` database from the `myHost:myPort` instance.
47+
- What tables are in the `test_db` database?
48+
- Use a tool to query data from the `test_db` database and answer: "What is today's user traffic?"
49+
4450
### Mode Two: Single Database Mode
4551
- Directly specify the target database by configuring the `CONNECTION_STRING` parameter in the server (format: `dbName@host:port`).
4652
- Suitable for scenarios that focus on accessing a single database.
@@ -51,6 +57,12 @@ CONNECTION_STRING = [email protected]:3306
5157
```
5258
Afterward, every time the service starts, the DMS MCP Server will directly access this specified database without needing to switch instances.
5359

60+
**Typical Question Examples:**
61+
- What tables do I have?
62+
- Show the field structure of the `test_table` table.
63+
- Retrieve the first 20 rows from the `test_table` table.
64+
- Use a tool to answer: "What is today's user traffic?"
65+
5466
---
5567
## Tool List
5668
| Tool Name | Description | Applicable Mode |
@@ -76,34 +88,34 @@ Afterward, every time the service starts, the DMS MCP Server will directly acces
7688

7789
## Supported Data Sources
7890
| DataSource/Tool | **NL2SQL** *nlsql* | **Execute script** *executeScript* | **Show schema** *getTableDetailInfo* | **Access control** *default* | **Audit log** *default* |
79-
|-----------------------|--------------------|------------------------------------|--------------------------------------|-----------------------------|------------------------|
80-
| MySQL | | ||||
81-
| MariaDB | | ||||
82-
| PostgreSQL | | ||||
83-
| Oracle | | ||||
84-
| SQLServer | | ||||
85-
| Redis | | ||||
86-
| MongoDB | | ||||
87-
| StarRocks | | ||||
88-
| Clickhouse | | ||||
89-
| SelectDB | | ||||
90-
| DB2 | | ||||
91-
| OceanBase | | ||||
92-
| Gauss | | ||||
93-
| BigQuery | | ||||
94-
| PolarDB | | ||||
95-
| PolarDB-X | | ||||
96-
| AnalyticDB | | ||||
97-
| Lindorm | | ||||
98-
| TableStore | | ||||
99-
| Maxcompute | | ||||
100-
| Hologres | | ||||
91+
|-----------------------|-----------------|---------------------------------|--------------------------------------|-----------------------------|------------------------|
92+
| MySQL ||||||
93+
| MariaDB ||||||
94+
| PostgreSQL ||||||
95+
| Oracle ||||||
96+
| SQLServer ||||||
97+
| Redis | | ||||
98+
| MongoDB | | ||||
99+
| StarRocks ||||||
100+
| Clickhouse ||||||
101+
| SelectDB ||||||
102+
| DB2 ||||||
103+
| OceanBase ||||||
104+
| Gauss ||||||
105+
| BigQuery ||||||
106+
| PolarDB ||||||
107+
| PolarDB-X ||||||
108+
| AnalyticDB ||||||
109+
| Lindorm ||||||
110+
| TableStore | | ||||
111+
| Maxcompute ||||||
112+
| Hologres ||||||
101113

102114
---
103115
## Prerequisites
104116
- uv is installed
105117
- Python 3.10+ is installed
106-
- An AK/SK or STS Token with access rights to Alibaba Cloud DMS
118+
- An AK/SK or STS Token with access rights to Alibaba Cloud DMS(AliyunDMSFullAccess)
107119

108120
---
109121
## Pre-configuration

0 commit comments

Comments
 (0)