DataWorks MCP Server

DataWorks MCP Server

site icon
2025.04.15 12
TypeScriptAI 交互云资源管理DataWorks 集成开发效率数据库
DataWorks MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,旨在为 AI 提供与 DataWorks Open API 交互的标准化接口。该服务基于阿里云 Open API 实现,允许 AI 代理无缝执行云资源操作。
View on GitHub

Overview

基本能力

产品定位

DataWorks MCP Server 是一个用于 AI 与 DataWorks Open API 交互的标准化接口服务,主要用于管理和操作 DataWorks 资源。

核心功能

  • 与 DataWorks Open API 交互
  • 管理 DataWorks 资源
  • 标准化云资源交互

适用场景

  • AI 代理执行云资源操作
  • 自动化管理 DataWorks 资源
  • 开发与 DataWorks 集成的 AI 应用

工具列表

  • 提供 DataWorks 工具列表,可通过 链接 查看。

常见问题解答

  1. 验证阿里云 Open API 访问密钥和密钥是否正确
  2. 检查区域 ID 是否正确
  3. 确保在正确的网络(主网、测试网或开发网)上
  4. 验证构建是否成功

使用教程

使用依赖

  • Node.js (v16 或更高版本)
  • pnpm (推荐), npm 或 yarn
  • DataWorks Open API 的访问密钥和密钥

安装教程

选项 1: 从 npm 安装(推荐用于客户端如 Cursor/Cline)

# 全局安装
npm install -g alibabacloud-dataworks-mcp-server

# 或在项目中本地安装
npm install alibabacloud-dataworks-mcp-server

选项 2: 从源代码构建(适用于开发者)

  1. 克隆仓库:
git clone https://github.com/aliyun/alibabacloud-dataworks-mcp-server
cd alibabacloud-dataworks-mcp-server
  1. 安装依赖(推荐使用 pnpm,也支持 npm):
pnpm install
  1. 构建项目:
pnpm run build
  1. 开发项目(通过 @modelcontextprotocol/inspector):
pnpm run dev

打开 http://localhost:5173

调试方式

  1. 确保环境变量配置正确
  2. 运行项目并检查日志
  3. 使用 VERBOSE=true 导出更多日志信息

配置

MCP Server 配置

通过 npm 安装的配置

{
  "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"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

从源代码构建的配置

{
  "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_UTILS",
        "NODE_ENV": "optional_development_or_product",
        "TOOL_FILE_URI":"if_NODE_ENV_is_development_then_the_tool_path_to_the_tool_file_uri",
        "OPEN_API_ENDPOINT": "open_api_endpoint_here",
        "VERBOSE": "export_more_logs_when_needed"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

许可证

该项目遵循 Apache 2.0 开源许可条款。