Alibaba Cloud DataWorks + GitHub Copilot (VS Code): Complete MCP Integration
Alibaba Cloud DataWorks is a MCP server that A Model Context Protocol (MCP) server that provides tools for AI, allowing it to interact with the DataWorks Open API through a standardized interface. This implementation is based on the Alibaba Cloud Open API and enables AI agents to perform cloud resources operations seamlessly..
When integrated with GitHub Copilot (VS Code), you can:
- List all DataWorks projects in the account
- Create new data processing workflows
- Configure and manage data source connections
This guide provides step-by-step instructions to set up Alibaba Cloud DataWorks in GitHub Copilot (VS Code), including configuration, examples, and troubleshooting.
What You'll Achieve
After completing this setup:
- Alibaba Cloud DataWorks will be fully integrated and operational
- You can use Alibaba Cloud DataWorks tools directly in GitHub Copilot (VS Code)
- All Alibaba Cloud DataWorks capabilities will be available for your workflows
- Access to 6 different tools
Prerequisites
Before starting, ensure you have:
- Alibaba Cloud access key ID
- Alibaba Cloud access key secret
- Alibaba Cloud region
- GitHub Copilot (VS Code) installed and configured
- Compatible operating system (Windows, macOS, Linux)
Installation
Step 1: Install Alibaba Cloud DataWorks
Configuration
Step 2: Configure GitHub Copilot (VS Code)
-
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
- Windows:
-
Add server configuration:
{
"mcpServers": {
"alibaba-cloud-dataworks": {
"command": "alibaba cloud dataworks",
"args": [],
"env": {
"ALIBABA_CLOUD_ACCESS_KEY_ID": "LTAI4G8vQZ2XxxxxxxxxxX",
"ALIBABA_CLOUD_ACCESS_KEY_SECRET": "2vQZ2Xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"ALIBABA_CLOUD_REGION": "cn-hangzhou",
"DATAWORKS_PROJECT_ID": "12345"
}
}
}
}
- 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 DataWorks in GitHub Copilot (VS Code):
Enterprise Data Pipeline Management
undefined
Ask GitHub Copilot (VS Code): "Create and schedule end-to-end data pipeline from CRM to analytics warehouse"
Expected Result: undefined
Multi-Source Data Integration
undefined
Ask GitHub Copilot (VS Code): "Set up data integration from ERP, CRM, and marketing automation systems"
Expected Result: undefined
Data Quality Monitoring
undefined
Ask GitHub Copilot (VS Code): "Set up data quality rules and monitoring for all critical tables"
Expected Result: undefined
Testing Your Setup
- Start a new conversation in GitHub Copilot (VS Code)
- Ask GitHub Copilot (VS Code) to list available tools
- Try using Alibaba Cloud DataWorks functionality
Test prompts:
- "What MCP tools are available?"
- "Use Alibaba Cloud DataWorks to help with my code"
- "Show me what Alibaba Cloud DataWorks 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 DataWorks 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 DataWorks installation
- Restart GitHub Copilot (VS Code)
- Check logs for error messages
Next Steps
Now that Alibaba Cloud DataWorks is integrated with GitHub Copilot (VS Code):
- Explore all Alibaba Cloud DataWorks 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 DataWorks development
Need Help?
- Search for Alibaba Cloud DataWorks documentation
- Check the GitHub Copilot (VS Code) MCP guide
- Join the MCP community discussions