Alibabacloud Dataworks MCP Server

🚀 Alibaba Cloud DataWorks MCP Server

A server based on the Model Context Protocol (MCP) that provides tools to support AI operations, enabling interaction with DataWorks Open APIs through standard interfaces. This implementation is based on Alibaba Cloud Open APIs, allowing AI agents to seamlessly perform cloud resource operations.

🚀 Quick Start

This MCP server interacts with the DataWorks Open API and manages DataWorks resources. It implements the Model Context Protocol specification to standardize cloud resource interactions for AI agents.

✨ Features

• Interact with DataWorks Open API.
• Manage DataWorks resources.
• Standardize AI agents' cloud resource interactions through the implementation of the Model Context Protocol specification.

📦 Installation

Option 1: Install via npm (Recommended for clients like Cursor/Cline)

# Install globally
npm install -g alibabacloud-dataworks-mcp-server

# Or install locally in your project
npm install alibabacloud-dataworks-mcp-server

Option 2: Build from source code (For developers)

1. Clone this repository:

git clone https://github.com/aliyun/alibabacloud-dataworks-mcp-server
cd alibabacloud-dataworks-mcp-server

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

pnpm install

3. Build the project:

pnpm run build

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

pnpm run dev

Open http://localhost:5173

📚 Documentation

MCP Server Configuration

If installed via npm (Option 1):

{
  "mcpServers": {
    "alibabacloud-dataworks-mcp-server": {
      "command": "npx",
      "args": "alibabacloud-dataworks-mcp-server"
    }
  }
}

Example configuration file:

{
  "mcpServers": {
    "alibabacloud-dataworks-mcp-server": {
      "command": "node",
      "args": "./dist/server.js"
    }
  }
}

Environment Variables

Please refer to the README.md in the project or related documentation to set environment variables.

Project Structure

.
├── src/
│   ├── server.ts          # Server entry file
│   └── utils/           # Tools and helper functions
├── package.json         # Dependencies and scripts
└── README.md            # Project documentation

💻 Usage Examples

Basic Usage

Here are some available commands:

# Install the project
npm install

# Start the development server
npm run dev

# Build the project
npm run build

# Run tests
npm test

🔧 Technical Details

Prerequisites

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

Security Considerations

• Protect your private keys and access tokens.
• Use environment variables to store sensitive information and avoid plain text storage.
• Regularly update your credentials and limit their scope of use.

Troubleshooting

If you encounter problems, please check the following:

1. Ensure that the correct dependencies are installed.
2. Check if the network connection is normal.
3. View the console output for error information.

Dependencies

• @alicloud/dataworks-public-20240518 - Data Factory Public API
• @alicloud/openapi-client - Open API Client

🤝 Contribution

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

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add some amazing features').
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.