Skip to main content

MCP server for RDS Services via OPENAPI.

Project description

English | 中文

Alibaba Cloud RDS OpenAPI MCP Server

MCP server for RDS Services via OPENAPI

Prerequisites

  1. Install uv from Astral or the GitHub README
  2. Install Python using uv python install 3.12
  3. Alibaba Cloud credentials with access to Alibaba Cloud RDS services

Quick Start

Using cherry-studio (Recommended)

Install the MCP environment according to Cherry-Studio's documentation, then configure and use RDS MCP. Add the following configuration to the MCP client configuration file:

"mcpServers": {
  "rds-openapi-mcp-server": {
    "command": "uvx",
    "args": [
      "alibabacloud-rds-openapi-mcp-server@latest"
    ],
    "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 
    }
  }
}

Using Cline

Set you env and run mcp server.

# 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 

# run mcp server
uvx alibabacloud-rds-openapi-mcp-server@latest

After run mcp server, you will see the following output:

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)

And then configure the Cline.

remote_server = "http://127.0.0.1:8000/sse";

Using Claude

Download from Github

git clone https://github.com/aliyun/alibabacloud-rds-openapi-mcp-server.git

Add the following configuration to the MCP client configuration file:

"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
    }
  }
}

Components

Tools

  • add_tags_to_db_instance: Add tags to an RDS instance.
  • allocate_instance_public_connection: Allocate a public connection for an RDS instance.
  • attach_whitelist_template_to_instance: Attach a whitelist template to an RDS instance.
  • create_db_instance: Create an RDS instance.
  • create_db_instance_account: Create an account for RDS instance.
  • describe_all_whitelist_template: Query the whitelist template list.
  • describe_available_classes: Query available instance classes and storage ranges.
  • describe_available_zones: Query available zones for RDS instances.
  • describe_bills: Query the consumption summary of all product instances or billing items for a user within a specific billing period.
  • describe_db_instance_accounts: Batch retrieves account information for multiple RDS instances.
  • describe_db_instance_attribute: Queries the details of an instance.
  • describe_db_instance_databases: Batch retrieves database information for multiple RDS instances.
  • describe_db_instance_ip_allowlist: Batch retrieves IP allowlist configurations for multiple RDS instances.
  • describe_db_instance_net_info: Batch retrieves network configuration details for multiple RDS instances.
  • describe_db_instance_parameters: Batch retrieves parameter information for multiple RDS instances.
  • describe_db_instance_performance: Queries the performance data of an instance.
  • describe_db_instances: Queries instances.
  • describe_error_logs: Queries the error log of an instance.
  • describe_instance_linked_whitelist_template: Query the whitelist template list.
  • describe_slow_log_records: Query slow log records for an RDS instance.
  • describe_vpcs: Query VPC list.
  • describe_vswitches: Query VSwitch list.
  • modify_security_ips: Modify RDS instance security IP whitelist.
  • get_current_time: Get the current time.
  • modify_db_instance_description: Modify RDS instance descriptions.
  • modify_db_instance_spec: Modify RDS instance specifications.
  • modify_parameter: Modify RDS instance parameters.
  • restart_db_instance: Restart an RDS instance.

Resources

None at this time

Prompts

# 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.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the Apache 2.0 License.

Contact Information

For any questions or concerns, please contact us through the DingTalk group:106730017609

store

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alibabacloud_rds_openapi_mcp_server-1.7.7.tar.gz (20.6 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file alibabacloud_rds_openapi_mcp_server-1.7.7.tar.gz.

File metadata

File hashes

Hashes for alibabacloud_rds_openapi_mcp_server-1.7.7.tar.gz
Algorithm Hash digest
SHA256 647e133e3b9db0fe8cc9270393f2bd8da4eb56f5c64d1e0db03b63bc035eeaa1
MD5 31b66dac678c6c2e7bc0f54a06717bfb
BLAKE2b-256 ad4a1e66298713fdfec945641e4833bf1fdda2e15821dd0559cb8a858e21a3e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for alibabacloud_rds_openapi_mcp_server-1.7.7.tar.gz:

Publisher: publish-to-pypi.yml on aliyun/alibabacloud-rds-openapi-mcp-server

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file alibabacloud_rds_openapi_mcp_server-1.7.7-py3-none-any.whl.

File metadata

File hashes

Hashes for alibabacloud_rds_openapi_mcp_server-1.7.7-py3-none-any.whl
Algorithm Hash digest
SHA256 a9e61700917ba77f805f6df758edfba8b76ba0d42354b666fd3784c9458c3199
MD5 42cd2df0ee9512aee648c4ccfb7d41c8
BLAKE2b-256 e44eb9f63688496854aba4f233597f84f61d53b0c67f4a0ac24a7462b5f2b1fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for alibabacloud_rds_openapi_mcp_server-1.7.7-py3-none-any.whl:

Publisher: publish-to-pypi.yml on aliyun/alibabacloud-rds-openapi-mcp-server

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page