Aliyun Alibabacloud Adb Mysql MCP Server

🚀 AnalyticDB for MySQL MCP Server

The AnalyticDB for MySQL MCP Server serves as a universal interface that connects AI Agents with AnalyticDB for MySQL, enabling seamless communication between them. It assists AI Agents in retrieving metadata from the AnalyticDB for MySQL database and executing SQL operations.

🚀 Quick Start

📦 Installation

Mode 1: Using Local Files

• 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

• Installation Install the 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"
      }
    }
  }
}

💻 Development of Your Own AnalyticDB for MySQL MCP Server

If you want to develop your own AnalyticDB for MySQL MCP Server, you can follow these steps to install Python dependencies:

1. Download the source code from GitHub.
2. Install the uv package manager.
3. Install Node.js (which provides a node package tool called npx).
4. Install Python dependencies in the project root directory using the following command:

uv pip install -r pyproject.toml

5. If you want to debug the MCP server locally, you can start 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

🔧 Technical Details

Tools

• execute_sql: Execute SQL queries.
• get_query_plan: Retrieve the query plan.
• get_execution_plan: Retrieve the actual execution plan and its statistics.

Resources

• Table: Represents a table in the database.
• Column: Represents a column in a table.
• Index: Represents an index on a table.