Skip to content

Commit 4c821b0

Browse files
author
依诺
committed
Update README
1 parent e059392 commit 4c821b0

File tree

3 files changed

+18
-6
lines changed

3 files changed

+18
-6
lines changed

README.md

Lines changed: 12 additions & 0 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 = mydb@192.168.1.100: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 |

doc/README-zh-cn.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ DMS MCP Server 现在支持两种使用模式。
4141

4242
**典型提问示例:**
4343
- 获取所有名称为test的数据库列表
44-
- 获取 xxxhost:xxxport 实例中 test_db 数据库的详细信息。
44+
- 获取 myHost:myPort 实例中 test_db 数据库的详细信息。
4545
- test_db 数据库下有哪些表?
46-
- 使用nl2sql工具,使用test_db 数据库回答“今天的用户访问量是多少?”
46+
- 使用工具, 查询test_db 库的数据,回答“今天的用户访问量是多少?”
4747

4848

4949
### 模式二:单数据库模式
@@ -58,9 +58,9 @@ CONNECTION_STRING = mydb@192.168.1.100:3306
5858

5959
**典型提问示例:**
6060
- 我有哪些表?
61-
- 查看test_table表的字段结构
62-
- 获取test_table表的前20条数据
63-
- 使用askDatabase工具,回答“今天的用户访问量是多少?”
61+
- 查看test_table 表的字段结构
62+
- 获取test_table 表的前20条数据
63+
- 使用工具,回答“今天的用户访问量是多少?”
6464

6565
---
6666

src/alibabacloud_dms_mcp_server/server.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ async def list_tables( # Renamed from listTable to follow convention
255255
raise
256256

257257
async def get_meta_table_detail_info(
258-
table_guid: str = Field(description="Unique table identifier (format: dmsTableId.schemaName.tableName)")
258+
table_guid: str = Field(description="Unique table identifier (format: dmsTableId.schemaName.tableName),Example: IDB_1567890.mySchema.myTable")
259259
) -> TableDetail:
260260
client = create_client()
261261
req = dms_enterprise_20181101_models.GetMetaTableDetailInfoRequest(table_guid=table_guid)

0 commit comments

Comments
 (0)