Skip to content

Commit 34e7b19

Browse files
author
wenfeng.wf
committed
Update README.
1 parent 64157c0 commit 34e7b19

File tree

4 files changed

+65
-27
lines changed

4 files changed

+65
-27
lines changed

README.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,42 @@ MCP server for RDS Services via OPENAPI
1010

1111
## Quick Start
1212
### Using [cherry-studio](https://github.com/CherryHQ/cherry-studio) (Recommended)
13-
Install the MCP environment according to [Cherry-Studio's documentation](https://docs.cherry-ai.com/advanced-basic/mcp/install), then configure and use RDS MCP.
14-
Add the following configuration to the MCP client configuration file:
13+
1. Download and install cherry-studio
14+
2. Follow the [documentation](https://docs.cherry-ai.com/cherry-studio/download) to install uv, which is required for the MCP environment
15+
3. Configure and use RDS MCP according to the [documentation](https://docs.cherry-ai.com/advanced-basic/mcp/install). You can quickly import the RDS MCP configuration using the JSON below. Please set ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET to your Alibaba Cloud AK/SK.
16+
17+
> The following error may appear during import, which can be ignored:
18+
> xxx settings.mcp.addServer.importFrom.connectionFailed
19+
20+
<img src="./assets/cherry-config.png" alt="cherry_config"/>
21+
1522
```json5
16-
"mcpServers": {
17-
"rds-openapi-mcp-server": {
18-
"command": "uvx",
19-
"args": [
20-
"alibabacloud-rds-openapi-mcp-server@latest"
21-
],
22-
"env": {
23-
"ALIBABA_CLOUD_ACCESS_KEY_ID": "access_id",
24-
"ALIBABA_CLOUD_ACCESS_KEY_SECRET": "access_key",
25-
"ALIBABA_CLOUD_SECURITY_TOKEN": "sts_security_token" // optional, required when using STS Token
26-
}
27-
}
23+
{
24+
"mcpServers": {
25+
"rds-openapi": {
26+
"name": "rds-openapi",
27+
"type": "stdio",
28+
"description": "",
29+
"isActive": true,
30+
"registryUrl": "",
31+
"command": "uvx",
32+
"args": [
33+
"alibabacloud-rds-openapi-mcp-server@latest"
34+
],
35+
"env": {
36+
"ALIBABA_CLOUD_ACCESS_KEY_ID": "$you_access_id",
37+
"ALIBABA_CLOUD_ACCESS_KEY_SECRET": "$you_access_key"
38+
}
39+
}
40+
}
2841
}
2942
```
3043

44+
4. Finally, click to turn on MCP
45+
<img src="./assets/mcp_turn_on.png" alt="mcp_turn_on"/>
46+
47+
5. You can use the prompt template provided below to enhance your experience.
48+
3149
### Using Cline
3250
Set you env and run mcp server.
3351
```shell

README_CN.md

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,43 @@ RDS OpenAPI MCP服务。
99

1010
## 快速开始
1111
### 使用[cherry-studio](https://github.com/CherryHQ/cherry-studio)(推荐)
12-
根据[Cherry-Studio文档](https://docs.cherry-ai.com/advanced-basic/mcp/install)安装MCP环境后配置使用RDS MCP。 MCP配置文件格式如下:
12+
1. [下载](https://docs.cherry-ai.com/cherry-studio/download)并安装cherry-studio
13+
2. 根据[文档](https://docs.cherry-ai.com/advanced-basic/mcp/install)安装MCP环境所需的uv
14+
3. 根据[文档](https://docs.cherry-ai.com/advanced-basic/mcp/config) 配置和使用RDS MCP,,使用下面的JSON可以快速导入RDS MCP配置。请将`ALIBABA_CLOUD_ACCESS_KEY_ID``ALIBABA_CLOUD_ACCESS_KEY_SECRET`配置成阿里云AKSK。
15+
16+
> 导入时可能会看到以下报错,可以忽略:
17+
> xxx settings.mcp.addServer.importFrom.connectionFailed
18+
19+
<img src="./assets/cherry-config.png" alt="cherry_config"/>
20+
1321
```json5
14-
"mcpServers": {
15-
"rds-openapi-mcp-server": {
16-
"command": "uvx",
17-
"args": [
18-
"alibabacloud-rds-openapi-mcp-server@latest"
19-
],
20-
"env": {
21-
"ALIBABA_CLOUD_ACCESS_KEY_ID": "access_id",
22-
"ALIBABA_CLOUD_ACCESS_KEY_SECRET": "access_key",
23-
"ALIBABA_CLOUD_SECURITY_TOKEN": "sts_security_token" // 可选项,使用sts token鉴权时填写
24-
}
25-
}
22+
{
23+
"mcpServers": {
24+
"rds-openapi": {
25+
"name": "rds-openapi",
26+
"type": "stdio",
27+
"description": "",
28+
"isActive": true,
29+
"registryUrl": "",
30+
"command": "uvx",
31+
"args": [
32+
"alibabacloud-rds-openapi-mcp-server@latest"
33+
],
34+
"env": {
35+
"ALIBABA_CLOUD_ACCESS_KEY_ID": "$you_access_id",
36+
"ALIBABA_CLOUD_ACCESS_KEY_SECRET": "$you_access_key"
37+
}
38+
}
39+
}
2640
}
2741
```
2842

43+
4. 最后点击开启MCP
44+
<img src="./assets/mcp_turn_on.png" alt="mcp_turn_on"/>
45+
46+
5. 您可以使用我们下面提供的提示词模板,提升使用体验。
47+
48+
2949
### 使用Cline
3050
设置环境变量并运行MCP服务
3151
```shell

assets/cherry-config.png

706 KB
Loading

assets/mcp_turn_on.png

181 KB
Loading

0 commit comments

Comments
 (0)