ApsaraDB Agent

Knowledge Q&A for database products

You can ask the agent questions about the features, pricing, and best practices of Alibaba Cloud database products at any time. The agent provides accurate and timely answers based on official documentation and the knowledge base.

Instance diagnosis and analysis

When a database instance experiences performance issues or anomalies, you can use the agent to perform an intelligent diagnosis. It analyzes relevant metrics and logs to help you quickly identify the root cause.

General entry point

Click the icon on the left or right sidebar of the ApsaraDB console to open the ApsaraDB Agent dialog box.

Instance diagnosis entry point

In specific management and O&M scenarios, such as on resource list and instance detail pages, the system provides quick-access entry points to activate the agent. These entry points allow you to diagnose issues or perform operations based on the current context. This feature is currently supported only for cloud-native database PolarDB and ApsaraDB for Tair (Redis-compatible). For more information, see PolarDB AI Assistant and Tair AI Assistant. Support for other products is gradually being rolled out.

1. Go to the Resource Management page on the ApsaraDB console. Find the instance that you want to diagnose and analyze, and click the AI-powered inspection button.

2. In the dialog box that appears on the right, select an Inspection item and a Time range, and then click Start inspection.

   

Supported databases

MCP Server supports the following database engines:

In addition, MCP Server has built-in ApsaraDB Agent capabilities that support knowledge Q&A, intelligent diagnostics, and best practice recommendations for all ApsaraDB database engines.

Get started

1. Clone the project and install it.

   git clone https://github.com/aliyun/alibabacloud-yaochi-db-mcp-server.git
   cd alibabacloud-yaochi-db-mcp-server
   python3 -m venv .venv
   source .venv/bin/activate
   pip install .

2. Verify the installation. Run the following command. If the program enters stdio wait mode with no output, the installation is successful. Press Ctrl+C to exit.

   yaochi-db-mcp-server

3. Add the following configuration to the MCP configuration file of your AI assistant.

   {
     "mcpServers": {
       "yaochi-db": {
         "command": "<project_path>/alibabacloud-yaochi-db-mcp-server/.venv/bin/yaochi-db-mcp-server",
         "env": {
           "ALIBABA_CLOUD_ACCESS_KEY_ID": "<your_access_key_id>",
           "ALIBABA_CLOUD_ACCESS_KEY_SECRET": "<your_access_key_secret>",
           "ALIBABA_CLOUD_REGION_ID": "cn-hangzhou",
           "YAOCHI_ENABLE_WRITE_SQL": "true",
           "YAOCHI_ENABLE_DDL_SQL": "true"
         }
       }
     }
   }

The following table describes the key environment variables.

Security mechanisms

• Temporary accounts: When SQL statements are executed, temporary database accounts are automatically created and destroyed immediately after execution. No persistent credentials are retained.

• SQL security checks: Dangerous operations such as DROP and TRUNCATE are automatically blocked. Comments and multi-statement execution are prohibited.

• Restrictive whitelist: When public access is enabled, only the current IP address (/32) is allowed. Existing security rules are not affected.

• Permission control: DML and DDL operation permissions are precisely controlled through environment variables.