Alibaba Cloud RDS OpenAPI MCP Server

英語 | 中国語

Alibaba Cloud RDS OpenAPI MCP サーバー

OPENAPI 経由で RDS サービスを利用する MCP サーバー

前提条件

1. Astral または GitHub の READMEから uv をインストールします
2. uv python install 3.12 を使用して Python をインストールします
3. Alibaba Cloud RDS サービスにアクセスできる Alibaba Cloud 認証情報

クイックスタート

cherry-studio を使用する（推奨）

1. cherry-studio をダウンロードしてインストールします
2. MCP 環境に必要な uv をインストールするため、ドキュメントに従います
3. ドキュメントに従って RDS MCP を設定し、使用します。以下の JSON を使用すると、RDS MCP の設定をすばやくインポートできます。ALIBABA_CLOUD_ACCESS_KEY_ID と ALIBABA_CLOUD_ACCESS_KEY_SECRET には、Alibaba Cloud の AK/SK を設定してください。

インポート時に次のエラーが表示される場合がありますが、無視してかまいません： xxx settings.mcp.addServer.importFrom.connectionFailed

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

4. 最後に、クリックして MCP をオンにします

   

5. 以下のプロンプトテンプレートを使用すると、より快適に利用できます。

Cline を使用する

環境変数を設定して MCP サーバーを実行します。

# set env
export SERVER_TRANSPORT=sse;
export SERVER_HOST=127.0.0.1; # Default: 127.0.0.1. API_KEY is required when binding to a non-loopback host.
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; # Required when SERVER_HOST is not a loopback address.
export ENABLE_WRITE_TOOLS=false; # Set true only when intentionally exposing write-capable tools on a non-loopback host.
export ALLOW_HEADER_CREDENTIALS=false; # Default false. Set true only in trusted deployments that require per-request credentials.

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

MCP サーバーを実行すると、次の出力が表示されます：

INFO:     Started server process [91594]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

その後、Cline を設定します。

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

API_KEY が設定されている場合、MCP クライアントは Authorization: Bearer <API_KEY> を送信する必要があります。

Qwen の使用中に 401 Incorrect API key provided エラーが発生した場合は、解決方法についてドキュメントを参照してください。

Claude を使用する

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（Database Autonomy Service）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：単一の SELECT 文に対して EXPLAIN を実行し、実行計画を返します。
• show_engine_innodb_status：sql show engine innodb status を実行し、sql の結果を返します。
• show_create_table：検証済みのデータベース識別子とテーブル識別子に対して SHOW CREATE TABLE を実行します。
• show_largest_table：ストレージ使用量が最も多い上位数件のテーブルを照会します。
• show_largest_table_fragment：テーブルフラグメントが最も大きいテーブルを照会します。
• query_sql：単一の読み取り専用 SQL 文（SELECT、SHOW、DESCRIBE、または EXPLAIN）を実行し、sql の結果を返します。

ツールセット

ツールセットは利用可能な MCP ツールをグループ化したもので、必要なものだけを有効にできます。サーバーの起動時に、次のいずれかを使用してツールセットを設定します。

• コマンドライン：--toolsets パラメーター
• 環境変数：MCP_TOOLSETS

利用可能なツールセット

ツールセットとその機能の一覧は次のとおりです。

• rds：標準のマネージド RDS サービス向けのすべてのツールを有効にします

• rds_custom_read：RDS Custom 向けの読み取り専用ツールを有効にします。

• rds_custom_all：RDS Custom 向けの読み取りおよび書き込みのすべてのツールを有効にします。

形式

ツールセット名をカンマ区切りで指定します（カンマの前後にスペースは入れません）。

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 グループが自動的に読み込まれます。

リソース

現時点ではありません

スキル

このプロジェクトでは、スキルを通じて RDS Copilot の機能を拡張できます。利用可能なスキルは 2 つです。

• alibabacloud-rds-copilot：RDS AI Assistant API を呼び出し、インテリジェントな質疑応答、SQL の最適化、トラブルシューティングを行います。
• alibabacloud-rds-instances-manage：このプロジェクトの OpenAPI ツール と SQL ツール を スクリプト／CLI として公開し、OpenClaw、Claude Code などのプラットフォームで利用できるようにします。モデルは alibabacloud-rds-instances-manage list と alibabacloud-rds-instances-manage run <tool_name> '<JSON args>' を実行して、RDS インスタンスを管理します（インスタンスの照会、モニタリング、スローログ、パラメーター、読み取り専用 SQL の実行など）。パッケージをインストールすると、alibabacloud-rds-instances-manage コマンドを利用できるようになります。スキルディレクトリは skill/alibabacloud-rds-instances-manage/ です。

スキルの使用方法について詳しくは、スキルのドキュメントをご覧ください。

プロンプト

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

セキュリティデプロイガイド

MCP エンドポイントをパブリックインターネットに公開しないでください。このサーバーは Alibaba Cloud RDS OpenAPI ツールを呼び出すことができ、機密性の高いクラウド認証情報を使用する場合もあるため、インターネットに公開された MCP エンドポイントは重大なセキュリティリスクを引き起こす可能性があります。

MCP サーバーをローカルのループバックアドレスでのみ実行することを強く推奨します。

export SERVER_HOST=127.0.0.1

ループバック以外のアドレスを使用する必要がある場合は、信頼できるプライベートネットワーク内に制限し、ネットワークアクセス制御を適用して、API_KEY を設定してください。また、明示的に必要な場合を除き、書き込み可能なツールを有効にしないでください。

コントリビューション

コントリビューションを歓迎します。お気軽にプルリクエストを送信してください。

1. リポジトリをフォークします
2. フィーチャーブランチを作成します（git checkout -b feature/amazing-feature）
3. 変更をコミットします（git commit -m 'Add some amazing feature'）
4. ブランチにプッシュします（git push origin feature/amazing-feature）
5. プルリクエストを作成します

ライセンス

このプロジェクトは Apache 2.0 ライセンスの下でライセンスされています。

お問い合わせ

ご質問やご不明な点がございましたら、DingTalk グループまでお問い合わせください：106730017609