AnalyticDB for MySQL MCP Server

AnalyticDB for MySQL MCP Server

By aliyun GitHub

AnalyticDB for MySQL MCP Server

alibabacloud adb
Overview

What is AnalyticDB for MySQL MCP Server?

AnalyticDB for MySQL MCP Server serves as a universal interface between AI Agents and AnalyticDB for MySQL databases, enabling seamless communication and SQL operations.

How to use AnalyticDB for MySQL MCP Server?

You can use it by configuring the MCP client either through a local file or by using PIP mode to install the server and integrate it into your application.

Key features of AnalyticDB for MySQL MCP Server?

  • Execute SQL queries in AnalyticDB for MySQL Cluster.
  • Retrieve query plans and execution plans with runtime statistics.
  • Access built-in resources and templates for database management.

Use cases of AnalyticDB for MySQL MCP Server?

  1. Integrating AI Agents with AnalyticDB for MySQL for data retrieval.
  2. Executing complex SQL queries programmatically.
  3. Analyzing query performance and execution plans.

FAQ from AnalyticDB for MySQL MCP Server?

  • Can I use this server with any AI Agent?

Yes, it is designed to work with various AI Agents that require database interaction.

  • Is there a specific programming language required?

The server is built using Python, but it can be integrated with any language that can make HTTP requests.

  • How do I debug the MCP server locally?

You can use the MCP Inspector tool to debug the server with your configurations.

Content

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

No tools information available.
No content found.