Aliyun Alibabacloud Dataworks MCP Server

🚀 Data Workbench MCP Server

A Model Context Protocol (MCP) server implemented based on Alibaba Cloud's open API, which provides tools for AI to interact with the Data Workbench's open API through a unified interface. This implementation allows AI agents to seamlessly operate cloud resources.

🚀 Quick Start

The Data Workbench MCP Server is a powerful tool that enables AI agents to interact with the Data Workbench's open API. It simplifies the process of managing cloud resources by providing a unified interface.

✨ Features

• Interaction with Data Workbench API: The MCP server interacts with the Data Workbench's open API.
• Resource Management: It manages Data Workbench resources.
• Model Context Protocol Compliance: The server implements the Model Context Protocol specification to manage cloud data resources through a unified interface.

📦 Installation

Prerequisites

• Node.js Environment: Ensure that the latest stable version of Node.js is installed.
• npm Package Manager: Confirm that npm is correctly configured.
• Alibaba Cloud Access Key: You need a valid Alibaba Cloud access key ID and secret.
• Data Workbench Account: Have access to the Data Workbench.

Installation Methods

Method 1: Install via npm

npm install alibabacloud-dataworks-mcp-server

Method 2: Clone the Project Repository

git clone https://github.com/your-username/alibabacloud-dataworks-mcp-server.git
cd alibabacloud-dataworks-mcp-server
npm install

📚 Documentation

Configuration Guide

Environment Variable Configuration

Create a .env file and add the following content:

# Required
ALIBABA_CLOUD_REGION_ID=cn-hangzhou  # Replace with your region ID
ALIBABA_CLOUD_ACCESS_KEY_ID=your_key_id  # Replace with your access key ID
ALIBABA_CLOUD_SECRET_ACCESS_KEY=your_secret_key  # Replace with your access key

# Optional
TOOL_CATEGORIES="Data Development (New Version),UTILS"  # Whitelist of tool categories, separated by commas
TOOL_NAMES="CreateNode,UpdateNode"      # Whitelist of tool names, separated by commas
VERBOSE=true                            # Debug mode switch

Configuration File Structure

After the project starts, a configuration file config.json will be automatically generated with the following content:

{
  "regionId": "cn-hangzhou",
  "accessKeyId": "your_key_id",
  "secretAccessKey": "your_secret_key",
  "toolCategories": ["Data Development (New Version)", "UTILS"],
  "toolNames": ["CreateNode", "UpdateNode"],
  "verbose": true
}

Project Structure

alibabacloud-dataworks-mcp-server/
├── src/
│   ├── index.ts          # Program entry file
└── package.json         # Project dependency management file

Available Tools

The Data Workbench tools provided by the MCP server include:

• Data node creation and management
• Data development environment configuration
• Resource access control
• Log query function
• Security policy configuration

For a detailed list, please refer to the official documentation.

Security Precautions

⚠️ Important Note

• Keep your private key secure to prevent leakage.
• Store sensitive information using environment variables.
• Regularly audit the activity records of AI agents.

Troubleshooting

If you encounter problems, please follow these steps to troubleshoot:

1. Confirm that the Alibaba Cloud access key is configured correctly.
2. Check if the region ID is accurate.
3. Ensure that you are using the correct network environment (main network/test network).
4. Verify that the build process is completed successfully.

Dependencies

The project mainly depends on the following packages:

• @alicloud/dataworks-public20240518
• @alicloud/openapi-client

Contributing to the Project

💡 Usage Tip

Contributions are welcome! Please follow these steps to contribute:

1. Fork this repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add amazing feature').
4. Push to the remote branch (git push origin feature/amazing-feature).
5. Submit a Pull Request.

📄 License

This project is open-sourced under the Apache 2.0 license.