explainx.aijoin newsletter3.01k
databasesanalytics-data

Alibaba Cloud ADB MySQL▌

by aliyun

Effortlessly connect to Alibaba Cloud ADB MySQL for fast SQL queries, query analysis, and easy metadata access with mini

Connects to Alibaba Cloud's Adb MySQL databases for executing SQL queries, analyzing query plans, and retrieving database metadata with minimal configuration requirements

github stars

★ 24

GitHubnpm
Minimal configuration setupWorks with Alibaba Cloud's managed MySQL service

best for

  • / Developers using Alibaba Cloud AnalyticDB for MySQL
  • / Data analysts working with cloud analytics databases
  • / AI applications needing database query capabilities

capabilities

  • / Execute SQL queries on AnalyticDB for MySQL
  • / Retrieve database metadata and schema information
  • / Analyze query execution plans
  • / Connect to remote Alibaba Cloud databases

what it does

Connects AI agents to Alibaba Cloud's AnalyticDB for MySQL databases to execute SQL queries and retrieve database metadata. Requires database credentials but minimal configuration.

about

Alibaba Cloud ADB MySQL is an official MCP server published by aliyun that provides AI assistants with tools and capabilities via the Model Context Protocol. Effortlessly connect to Alibaba Cloud ADB MySQL for fast SQL queries, query analysis, and easy metadata access with mini It is categorized under databases, analytics data.

how to install

You can install Alibaba Cloud ADB MySQL in your AI client of choice. Use the install panel on this page to get one-click setup for Cursor, Claude Desktop, VS Code, and other MCP-compatible clients. This server runs locally on your machine via the stdio transport.

license

Apache-2.0

Alibaba Cloud ADB MySQL is released under the Apache-2.0 license. This is a permissive open-source license, meaning you can freely use, modify, and distribute the software.

readme

AnalyticDB for MySQL MCP Server

AnalyticDB for MySQL MCP Server serves as a universal interface between AI Agents and AnalyticDB for MySQL databases. It enables seamless communication between AI Agents and AnalyticDB for MySQL, helping AI Agents retrieve AnalyticDB for MySQL database metadata and execute SQL operations.

1. MCP Client Configuration

Mode 1: Using Local File

  • Download the GitHub repository

git clone https://github.com/aliyun/alibabacloud-adb-mysql-mcp-server

  • MCP Integration

Add the following configuration to the MCP client configuration file:

{
  "mcpServers": {
    "adb-mysql-mcp-server": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/alibabacloud-adb-mysql-mcp-server",
        "run",
        "adb-mysql-mcp-server"
      ],
      "env": {
        "ADB_MYSQL_HOST": "host",
        "ADB_MYSQL_PORT": "port",
        "ADB_MYSQL_USER": "database_user",
        "ADB_MYSQL_PASSWORD": "database_password",
        "ADB_MYSQL_DATABASE": "database"
      }
    }
  }
}

Mode 2: Using PIP Mode

  • Installation

Install MCP Server using the following package:

pip install adb-mysql-mcp-server

  • MCP Integration

Add the following configuration to the MCP client configuration file:

 {
  "mcpServers": {
    "adb-mysql-mcp-server": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "adb-mysql-mcp-server",
        "adb-mysql-mcp-server"
      ],
      "env": {
        "ADB_MYSQL_HOST": "host",
        "ADB_MYSQL_PORT": "port",
        "ADB_MYSQL_USER": "database_user",
        "ADB_MYSQL_PASSWORD": "database_password",
        "ADB_MYSQL_DATABASE": "database"
      }
    }
  }
}

2. Develop your own AnalyticDB for MySQL MCP server

If you want to develop your own AnalyticDB for MySQL MCP Server, you can install the python dependency packages using the following command:

  1. Download the source code from GitHub.
  2. Install uv package manager.
  3. Install Node.js which provides a node package tool whose name is npx
  4. Install the python dependencies in the root diretory of the project using the following command:
uv pip install -r pyproject.toml
  1. If you want to debug the mcp server locally, you could start up an MCP Inspector using the following command:
npx @modelcontextprotocol/inspector  \
-e ADB_MYSQL_HOST=your_host \
-e ADB_MYSQL_PORT=your_port \
-e ADB_MYSQL_USER=your_username \
-e ADB_MYSQL_PASSWORD=your_password \
-e ADB_MYSQL_DATABASE=your_database \
uv --directory /path/to/alibabacloud-adb-mysql-mcp-server run adb-mysql-mcp-server

3. Introduction to the components of AnalyticDB for MySQL MCP Server

  • Tools

    • execute_sql: Execute a SQL query in the AnalyticDB for MySQL Cluster

    • get_query_plan: Get the query plan for a SQL query

    • get_execution_plan: Get the actual execution plan with runtime statistics for a SQL query

  • Resources

    • Built-in Resources

      • adbmysql:///databases: Get all the databases in the analytic for mysql cluster

    • Resource Templates

      • adbmysql:///{database}/tables: Get all the tables in a specific database

      • adbmysql:///{database}/{table}/ddl: Get the DDL script of a table in a specific database

      • adbmysql:///config/{key}/value: Get the value for a config key in the cluster

  • Prompts

Not provided at the present moment.