Alibaba Cloud AnalyticDB for MySQL + GitHub Copilot (VS Code): Complete MCP Integration

Alibaba Cloud AnalyticDB for MySQL is a MCP server that Connect to a AnalyticDB for MySQL cluster for getting database or table metadata, querying and analyzing data.It will be supported to add the openapi for cluster operation in the future..

When integrated with GitHub Copilot (VS Code), you can:

• Execute SQL queries on AnalyticDB for MySQL
• Retrieve query execution plan for optimization
• Get detailed execution plan with runtime statistics

This guide provides step-by-step instructions to set up Alibaba Cloud AnalyticDB for MySQL in GitHub Copilot (VS Code), including configuration, examples, and troubleshooting.

What You'll Achieve

After completing this setup:

• Alibaba Cloud AnalyticDB for MySQL will be fully integrated and operational
• You can use Alibaba Cloud AnalyticDB for MySQL tools directly in GitHub Copilot (VS Code)
• All Alibaba Cloud AnalyticDB for MySQL capabilities will be available for your workflows
• Access to 5 different tools

Prerequisites

Before starting, ensure you have:

• AnalyticDB for MySQL cluster endpoint
• Database username
• Database password
• GitHub Copilot (VS Code) installed and configured
• Compatible operating system (Windows, macOS, Linux)

Installation

Step 1: Install Alibaba Cloud AnalyticDB for MySQL

Configuration

Step 2: Configure GitHub Copilot (VS Code)

1. Locate your configuration file:

   • Windows: .vscode\\mcp.json in your project directory
   • macOS: .vscode/mcp.json in your project directory
   • Linux: .vscode/mcp.json in your project directory

2. Add server configuration:

{
  "mcpServers": {
    "alibaba-cloud-analyticdb-for-mysql": {
      "command": "alibaba cloud analyticdb for mysql",
      "args": [],
      "env": {
        "ADB_MYSQL_HOST": "adb-cluster-123.mysql.rds.aliyuncs.com",
        "ADB_MYSQL_PORT": "3306",
        "ADB_MYSQL_USER": "analytics_user",
        "ADB_MYSQL_PASSWORD": "secure_password123",
        "ADB_MYSQL_DATABASE": "analytics_db"
      }
    }
  }
}

3. Restart GitHub Copilot (VS Code)

Completely quit and restart GitHub Copilot (VS Code) to load the new configuration.

Examples

Once configured, you can use Alibaba Cloud AnalyticDB for MySQL in GitHub Copilot (VS Code):

Real-time Analytics Dashboard

undefined

Ask GitHub Copilot (VS Code): "Execute hourly sales aggregation and performance metrics"

Expected Result: undefined

Data Warehouse Optimization

undefined

Ask GitHub Copilot (VS Code): "Analyze execution plan for monthly revenue report"

Expected Result: undefined

Schema Management

undefined

Ask GitHub Copilot (VS Code): "Document all tables and their relationships in the analytics database"

Expected Result: undefined

Testing Your Setup

1. Start a new conversation in GitHub Copilot (VS Code)
2. Ask GitHub Copilot (VS Code) to list available tools
3. Try using Alibaba Cloud AnalyticDB for MySQL functionality

Test prompts:

• "What MCP tools are available?"
• "Use Alibaba Cloud AnalyticDB for MySQL to help with my code"
• "Show me what Alibaba Cloud AnalyticDB for MySQL can do"

Troubleshooting

Common Issues

MCP Configuration Not Loaded

Symptoms: MCP tools not appearing, Copilot does not recognize MCP server

Cause: Configuration file not in correct location or invalid JSON

Solution:

• Verify .vscode/mcp.json exists in project root directory
• Check JSON syntax is valid (no trailing commas, proper quotes)
• Reload VS Code window after making configuration changes
• Check VS Code Developer Tools (Help > Toggle Developer Tools) for errors

MCP Server Not Starting

Symptoms: Tools listed but not responding, Server connection errors

Cause: Server command path incorrect or dependencies missing

Solution:

• Test the MCP server command independently in terminal
• Verify all server prerequisites are installed
• Check that command path is correct (use absolute paths if needed)
• Ensure required environment variables are set in mcp.json
• Review VS Code Output panel for MCP server error messages

GitHub Copilot Subscription Required

Symptoms: Copilot features grayed out, Unable to access Copilot Chat

Cause: No active GitHub Copilot subscription

Solution:

• Sign up for GitHub Copilot subscription (Individual, Business, or Enterprise)
• Verify subscription is active in GitHub account settings
• Re-authenticate GitHub Copilot in VS Code
• Check that VS Code is using correct GitHub account

VS Code Version Too Old

Symptoms: MCP configuration ignored, No mcp.json recognition

Cause: VS Code version below 1.99 does not have native MCP support

Solution:

• Update VS Code to version 1.99 or later
• Check current version: Help > About
• Download latest version from code.visualstudio.com
• After updating, reload window and verify MCP support

{server_name} Tools Not Working

Symptoms: Server connected but tools fail, Error messages when invoking tools

Cause: Server-specific configuration or authentication issues

Solution:

• Verify all required environment variables for {server_name} are set
• Check {server_name} documentation for specific prerequisites
• Test {server_name} with another MCP client to isolate issue
• Review error messages in VS Code Output panel for specific failures

Alibaba Cloud AnalyticDB for MySQL not appearing in GitHub Copilot (VS Code)

Symptoms: Server not listed, Tools not available

Cause: Configuration or installation issue

Solution:

• Verify configuration syntax
• Check Alibaba Cloud AnalyticDB for MySQL installation
• Restart GitHub Copilot (VS Code)
• Check logs for error messages

Next Steps

Now that Alibaba Cloud AnalyticDB for MySQL is integrated with GitHub Copilot (VS Code):

• Explore all Alibaba Cloud AnalyticDB for MySQL capabilities through GitHub Copilot (VS Code)
• Check out other MCP servers that work with GitHub Copilot (VS Code)
• Join the MCP community for tips and support
• Consider contributing to Alibaba Cloud AnalyticDB for MySQL development

Need Help?

• Search for Alibaba Cloud AnalyticDB for MySQL documentation
• Check the GitHub Copilot (VS Code) MCP guide
• Join the MCP community discussions