Alibaba Cloud AnalyticDB for MySQL

What is AnalyticDB for MySQL MCP Server?

AnalyticDB for MySQL MCP Server is a universal interface that enables AI Agents to seamlessly communicate with and control Alibaba Cloud's AnalyticDB for MySQL databases. It empowers AI Agents to retrieve database metadata and execute SQL operations.

How to use it?

You can integrate the server using two methods:

1. Local File Mode: Clone the repository and configure your MCP client to run the server from the local path. You'll need to provide your database connection details (host, port, user, password, database) as environment variables.
2. PIP Mode: Install the server via pip (pip install adb-mysql-mcp-server) and configure your MCP client to run the installed command, passing the same database credentials as environment variables.

Key Features

• AI Agent Integration: Connects AI agents directly to AnalyticDB for MySQL.
• Metadata Retrieval: Allows agents to fetch schema information about databases and tables.
• SQL Execution: Enables agents to run SQL queries and perform data operations.
• Secure Configuration: Uses environment variables to handle sensitive database credentials.

Use Cases

• AI-Powered Data Analysis: Allow an AI agent to query and analyze data directly from your AnalyticDB for MySQL.
• Automated Database Tasks: Enable an AI agent to perform administrative or maintenance SQL tasks.
• Data-Grounded Workflows: Integrate your database into larger AI-driven workflows that require access to your data.

FAQ

• Q: What is the main purpose of this MCP server?

  A: It acts as a bridge, allowing AI Agents to interact with Alibaba Cloud's AnalyticDB for MySQL for tasks like data querying and metadata retrieval.

• Q: How do I configure the database connection?

  A: Connection is configured by setting the ADB_MYSQL_HOST, ADB_MYSQL_PORT, ADB_MYSQL_USER, ADB_MYSQL_PASSWORD, and ADB_MYSQL_DATABASE environment variables in your MCP client setup.

• Q: What are the prerequisites?

  A: You need an active AnalyticDB for MySQL instance on Alibaba Cloud and an MCP client to run the server.

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 

5. 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:///{schema}/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.