Alibaba Cloud DataWorks

Overview

This MCP server:

• Interact with DataWorks Open API
• Manage DataWorks resources

Prerequisites

• Node.js (v16 or higher)
• pnpm (recommended), npm, or yarn
• DataWorks Open API with access key and secret key

Installation# Option 1: Install from npm (recommend for clients like Cursor/Cline)

npm install -g alibabacloud-dataworks-mcp-server\n\n# Or install locally in your project
npm install alibabacloud-dataworks-mcp-server
```\n\n### Option 2: Build from Source (for developers)
1. Clone this repository:
```bash
git clone https://github.com/aliyun/alibabacloud-dataworks-mcp-server
cd alibabacloud-dataworks-mcp-server

2. Install dependencies (pnpm is recommended, npm is supported):

pnpm install

3. Build the project:

pnpm run build

4. Development the project (by @modelcontextprotocol/inspector):

pnpm run dev

open http://localhost:5173

Configuration# MCP Server Configuration

If you installed via npm (Option 1):

{
  "mcpServers": {
    "alibabacloud-dataworks-mcp-server": {
      "command": "npx",
      "args": ["alibabacloud-dataworks-mcp-server"],
      "env": {
        "REGION": "your_dataworks_open_api_region_id_here",
        "ALIBABA_CLOUD_ACCESS_KEY_ID": "your_alibaba_cloud_access_key_id",
        "ALIBABA_CLOUD_ACCESS_KEY_SECRET": "your_alibaba_cloud_access_key_secret",
        "TOOL_CATEGORIES": "optional_your_tool_categories_here_ex_UTILS",
        "TOOL_NAMES": "optional_your_tool_names_here_ex_ListProjects"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

If you built from source (Option 2):

{
  "mcpServers": {
    "alibabacloud-dataworks-mcp-server": {
      "command": "node",
      "args": ["/path/to/alibabacloud-dataworks-mcp-server/build/index.js"],
      "env": {
        "REGION": "your_dataworks_open_api_region_id_here",
        "ALIBABA_CLOUD_ACCESS_KEY_ID": "your_alibaba_cloud_access_key_id",
        "ALIBABA_CLOUD_ACCESS_KEY_SECRET": "your_alibaba_cloud_access_key_secret",
        "TOOL_CATEGORIES": "optional_your_tool_categories_here_ex_SERVER_IDE_DEFAULT",
        "TOOL_NAMES": "optional_your_tool_names_here_ex_ListProjects"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}
```\n\n### Environment Setup
init variables in your environment:
```env\n\n# DataWorks Configuration
REGION=your_dataworks_open_api_region_id_here
ALIBABA_CLOUD_ACCESS_KEY_ID=your_alibaba_cloud_access_key_id
ALIBABA_CLOUD_ACCESS_KEY_SECRET=your_alibaba_cloud_access_key_secret
TOOL_CATEGORIES=optional_your_tool_categories_here_ex_SERVER_IDE_DEFAULT
TOOL_NAMES=optional_your_tool_names_here_ex_ListProjects
```\n\n### Configuration Description - Use Guide Description [Link](https://www.alibabacloud.com/help/dataworks/user-guide/dataworks-mcp-server-function-usage#1ecf2a04b5ilh)

## Project Structure
```plaintext
alibabacloud-dataworks-mcp-server/
├── src/
│   ├── index.ts # Main entry point
├── package.json
└── tsconfig.json

Available Tools

The MCP server provides the following DataWorks tools: See this link

Security Considerations

• Keep your private key secure and never share it
• Use environment variables for sensitive information
• Regularly monitor and audit AI agent activities

Troubleshooting

If you encounter issues:

1. Verify your Aliyun Open API access key and secret key are correct
2. Check your region id is correct
3. Ensure you're on the intended network (mainnet, testnet, or devnet)
4. Verify the build was successful

Dependencies

Key dependencies include:

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

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

License

This project is licensed under the Apache 2.0 License.