English | 中文
阿里云RDS OpenAPI MCP服务器（Q CLI适配）
备注：此项目是从 阿里云/阿里巴巴云rds openapi-mcp服务器 并已调整为与Amazon Q Developer CLI无缝集成。
通过OPENAPI为RDS服务提供MCP服务器，针对Amazon Q Developer CLI集成进行了优化。
先决条件
- 安装
uv从 星体 或 - 使用以下命令安装Python
uv python install 3.11 - 访问阿里云RDS服务的阿里云凭据
Amazon Q Developer CLI的快速设置
git clone https://github.com/RadiumGu/alibabacloud-rds-openapi-mcp-server-QCLI.git
cd alibabacloud-rds-openapi-mcp-server-QCLI
./setup.sh然后配置您的阿里云凭据并使用提供的 mcp_config.json 使用Amazon Q Developer CLI创建文件。
Q CLI适配
此分叉包括几个专门针对Amazon Q Developer CLI集成的增强功能：
🚀 增强功能
- 预先配置的MCP设置 -准备使用
mcp_config.json适用于Q CLI - 自动设置脚本 -一个命令安装
./setup.sh - 环境模板 -
.env.template便于凭证配置 - 协议遵从 -完整的MCP协议验证和测试
- 优化性能 -针对Q CLI的交互模式进行了优化
📚 其他文件
- Q CLI集成指南 -分步设置说明
- Q CLI使用示例 -常见使用模式和示例
- 配置优化 -性能调优提示
- MCP协议合规性报告 -技术验证细节
🔧 与原版有何不同
- 添加了Q CLI特定的配置文件
- 增强的错误处理和日志记录
- 改进环境变量管理
- 添加了全面的测试套件
- 针对Q CLI的MCP客户端实施进行了优化
快速开始
使用 樱桃工作室 （推荐）
- 下载并安装樱桃工作室
- 跟随 文档 安装MCP环境所需的uv
- 根据配置和使用RDS MCP 文档。您可以使用下面的JSON快速导入RDS MCP配置。请将ALIBA_CLOUD_ACCESS_KEY_ID和ALIBA_CLOUD_ACCESS_KEY_SECRET设置为您的阿里云AK/SK。
导入过程中可能会出现以下错误，可以忽略： xxx设置.cp.addServer.importFrom.connection失败
{
"mcpServers": {
"rds-openapi": {
"name": "rds-openapi",
"type": "stdio",
"description": "",
"isActive": true,
"registryUrl": "",
"command": "uvx",
"args": [
"alibabacloud-rds-openapi-mcp-server@latest"
],
"env": {
"ALIBABA_CLOUD_ACCESS_KEY_ID": "$you_access_id",
"ALIBABA_CLOUD_ACCESS_KEY_SECRET": "$you_access_key"
}
}
}
}- 最后，单击打开MCP
- 您可以使用下面提供的提示模板来增强您的体验。
使用Amazon Q Developer命令行界面
- 克隆存储库：
git clone https://github.com/aliyun/alibabacloud-rds-openapi-mcp-server.git
cd alibabacloud-rds-openapi-mcp-server- 安装
uv从 星体 或
- 使用以下命令安装Python
uv python install 3.11
- 设置虚拟环境：
uv venv
source .venv/bin/activate
uv pip install -e .- 配置您的阿里云凭据：
# Copy the template and edit with your credentials
cp .env.template .env
nano .env编辑 .env 使用您的实际凭据文件：
ALIBABA_CLOUD_ACCESS_KEY_ID=your_actual_access_key_id
ALIBABA_CLOUD_ACCESS_KEY_SECRET=your_actual_access_key_secret
ALIBABA_CLOUD_REGION=cn-hangzhou- 运行MCP服务器：
uv run src/alibabacloud_rds_openapi_mcp_server/server.py- 服务器已在Amazon Q Developer CLI中配置。要启用它，请执行以下操作：
- 编辑 ~/.aws/amazonq/mcp.json - 查找 alibabacloud-rds-openapi-mcp-server 进入 - 改变 "disabled": true 向 "disabled": false
或者，您可以使用提供的 mcp_config.json 文件作为MCP配置的参考。
使用Cline
设置环境并运行mcp服务器。
# set env
export SERVER_TRANSPORT=sse;
export ALIBABA_CLOUD_ACCESS_KEY_ID=$you_access_id;
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=$you_access_key;
export ALIBABA_CLOUD_SECURITY_TOKEN=$you_sts_security_token; # optional, required when using STS Token
export API_KEY=$you_mcp_server_api_key; # Optional, after configuration, requests will undergo API Key authentication.
# run mcp server
uvx alibabacloud-rds-openapi-mcp-server@latest运行mcp-server后，您将看到以下输出：
INFO: Started server process [91594]
INFO: Waiting for application startup.
INFO: Application startup complete.
INFO: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)然后配置Cline。
remote_server = "http://127.0.0.1:8000/sse";如果你遇到 401 Incorrect API key provided 使用Qwen时出错，请参阅 文档 解决方案。使用克劳德
从Github下载
git clone https://github.com/aliyun/alibabacloud-rds-openapi-mcp-server.git将以下配置添加到MCP客户端配置文件中：
{
"mcpServers": {
"rds-openapi-mcp-server": {
"command": "uv",
"args": [
"--directory",
"/path/to/alibabacloud-rds-openapi-mcp-server/src/alibabacloud_rds_openapi_mcp_server",
"run",
"server.py"
],
"env": {
"ALIBABA_CLOUD_ACCESS_KEY_ID": "access_id",
"ALIBABA_CLOUD_ACCESS_KEY_SECRET": "access_key",
"ALIBABA_CLOUD_SECURITY_TOKEN": "sts_security_token",
// optional, required when using STS Token
}
}
}
}组件
OpenAPI 工具
add_tags_to_db_instance：向RDS实例添加标签。allocate_instance_public_connection：为RDS实例分配公共连接。attach_whitelist_template_to_instance：将白名单模板附加到RDS实例。create_db_instance：创建RDS实例。create_db_instance_account：为RDS实例创建一个帐户。describe_all_whitelist_template：查询白名单模板列表。describe_available_classes：查询可用的实例类和存储范围。describe_available_zones：查询RDS实例的可用区域。describe_bills：查询特定计费周期内用户所有产品实例或计费项目的消费汇总。describe_db_instance_accounts：批量检索多个RDS实例的帐户信息。describe_db_instance_attribute：查询实例的详细信息。describe_db_instance_databases：批量检索多个RDS实例的数据库信息。describe_db_instance_ip_allowlist：批量检索多个RDS实例的IP分配列表配置。describe_db_instance_net_info：批量检索多个RDS实例的网络配置详细信息。describe_db_instance_parameters：批量检索多个RDS实例的参数信息。describe_db_instance_performance：查询实例的性能数据。describe_db_instances：查询实例。describe_error_logs：查询实例的错误日志。describe_instance_linked_whitelist_template：查询白名单模板列表。describe_monitor_metrics：使用DAS（数据库自主服务）API查询实例的性能和诊断指标。describe_slow_log_records：查询RDS实例的慢日志记录。describe_sql_insight_statistic：查询SQL日志统计信息，包括SQL成本时间、执行时间和帐户。describe_vpcs：查询VPC列表。describe_vswitches：查询VSwitch列表。modify_security_ips：修改RDS实例安全IP白名单。get_current_time：获取当前时间。modify_db_instance_description：修改RDS实例描述。modify_db_instance_spec：修改RDS实例规范。modify_parameter：修改RDS实例参数。restart_db_instance：重新启动RDS实例。
SQL工具
MCP服务器将自动创建一个只读帐户，执行SQL语句，然后自动删除该帐户。此过程要求MCP服务器可以连接到实例。
explain_sql：执行sqlexplain并返回sql结果。show_engine_innodb_status：执行sqlshow engine innodb status并返回sql结果。show_create_table：执行sqlshow create table并返回sql结果。query_sql：执行只读sql并返回sql结果。
工具集
工具集将可用的MCP工具分组，这样您就可以只启用所需的工具。使用以下任一方式启动服务器时配置工具集：
- 命令行:
--toolsets参数 - 环境变量:
MCP_TOOLSETS
可用工具集
以下是工具集及其功能列表：
- rds：启用标准托管RDS服务的所有工具
- rds_custom_read：启用RDS自定义的只读工具。
- rds_custom_all：启用RDS自定义的完整读写工具。
格式
使用逗号分隔的工具集名称（逗号周围没有空格）：
rds,rds_custom_all例子
# Single toolset
--toolsets rds
# Multiple tools
--toolsets rds,rds_mssql_custom
# Environment variable
export MCP_TOOLSETS=rds,rds_custom_all默认行为
如果未指定工具集，则默认 rds 组是自动加载的。
资源
目前没有
鼓励
# Role
You are a professional Alibaba Cloud RDS Copilot, specializing in providing customers with efficient technical support and solutions for RDS (Relational Database Service). Your goal is to help customers resolve issues quickly through clear problem decomposition, precise tool invocation, and accurate time calculations.
## Skills
### Skill 1: Problem Decomposition and Analysis
- Deeply deconstruct user questions to identify core requirements and potential steps/commands involved.
- Provide clear task breakdowns to ensure each step contributes to the final solution.
- Please organize your answers in a table format as much as possible.
### Skill 2: RDS MCP Tool Invocation
- Proficiently invoke the RDS MCP tool to retrieve database information or execute operations.
- Tool invocation must follow task decomposition and align with logical reasoning and customer needs.
- Select appropriate MCP modules (e.g., monitoring data queries, performance diagnostics, backup/recovery) based on user requirements.
### Skill 3: Time Interpretation and Calculation
- Accurately parse relative time concepts like "today," "yesterday," or "the last hour."
- Convert relative time expressions into precise time ranges or timestamps using the current time to support data queries or operations.
## Constraints
- **Task Decomposition First**: Always provide detailed task breakdowns.
- **Tool Dependency Clarity**: All MCP tool invocations must be justified by clear task requirements and logical reasoning.
- **Time Precision**: Calculate exact time ranges for time-sensitive queries.
- **Professional Focus**: Discuss only Alibaba Cloud RDS-related technical topics.
- **Safety Awareness**: Ensure no operations negatively impact customer databases.用例
mydba
阿里云数据库MyDBA代理(README.md)
- 购买RDS\
- 诊断RDS\
贡献
欢迎投稿！请随时提交拉取请求。
- 分叉存储库
- 创建功能分支(
git checkout -b feature/amazing-feature) - 提交您的更改(
git commit -m 'Add some amazing feature') - 推到分支(
git push origin feature/amazing-feature) - 打开拉取请求
许可证
此项目根据Apache 2.0许可证获得许可。
联系方式
如有任何疑问或疑虑，请通过钉群联系我们：106730017609