使用说明

项目简介

DataWorks MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器端实现，旨在为AI应用提供标准化的接口，使其能够安全、便捷地与阿里云DataWorks Open API进行交互。通过该MCP服务器，AI智能体可以调用DataWorks的各项功能，实现云端数据资源的访问和管理。

主要功能点

DataWorks Open API 交互: 提供工具，允许AI智能体调用DataWorks Open API，执行云资源操作。
DataWorks 资源管理: 支持对DataWorks项目、工作流、数据表等资源的管理和操作。
标准化 MCP 协议: 遵循 Model Context Protocol 规范，提供标准的工具 (Tools) 和 Prompt 模板 (Prompts) 接口。
易于安装和配置: 支持 npm 全局安装和源码构建两种方式，方便用户快速部署和使用。
环境配置: 通过环境变量配置阿里云账号的 AccessKey 和 Region 信息，保障安全访问。

安装步骤

安装 Node.js 和 npm: 确保您的环境中已安装 Node.js (v16 或更高版本) 和 npm (或 pnpm, yarn)。

全局安装 MCP 服务器: 打开终端，执行以下命令进行全局安装：

npm install -g alibabacloud-dataworks-mcp-server

服务器配置

MCP 客户端需要配置 MCP 服务器的启动信息，以便连接并使用 DataWorks MCP Server 提供的工具。以下是配置示例（JSON 格式），请根据您的实际情况进行配置。

{
  "mcpServers": {
    "alibabacloud-dataworks-mcp-server": {
      "command": "npx",
      "args": ["alibabacloud-dataworks-mcp-server"],
      "env": {
        "REGION": "your_dataworks_open_api_region_id_here",  // 阿里云 DataWorks Open API 的 Region ID，例如 cn-hangzhou
        "ALIBABA_CLOUD_ACCESS_KEY_ID": "your_alibaba_cloud_access_key_id", // 阿里云账号的 Access Key ID
        "ALIBABA_CLOUD_ACCESS_KEY_SECRET": "your_alibaba_cloud_access_key_secret" // 阿里云账号的 Access Key Secret
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

配置参数说明:

'server name': 服务器名称，例如 'alibabacloud-dataworks-mcp-server'，客户端用以识别和调用。
'command': 启动服务器的命令，这里使用 'npx' 来运行全局安装的 'alibabacloud-dataworks-mcp-server'。
'args': 命令参数，本例中没有额外的参数。
'env': 环境变量配置，用于 DataWorks Open API 的身份验证和区域设置。
- 'REGION': 必填，阿里云 DataWorks Open API 所在的区域 ID。请替换为您的实际 Region ID。
- 'ALIBABA_CLOUD_ACCESS_KEY_ID': 必填，阿里云账号的 Access Key ID，用于 API 访问鉴权。请替换为您的 Access Key ID。
- 'ALIBABA_CLOUD_ACCESS_KEY_SECRET': 必填，阿里云账号的 Access Key Secret，用于 API 访问鉴权。请替换为您的 Access Key Secret。
'disabled': 是否禁用该服务器，默认为 'false' (启用)。
'autoApprove': 自动批准的工具列表，默认为空数组 '[]'，表示需要手动批准工具调用。

注意: 请务必将 'your_dataworks_open_api_region_id_here', 'your_alibaba_cloud_access_key_id', 和 'your_alibaba_cloud_access_key_secret' 替换为您实际的阿里云账号信息。为了安全起见，建议使用 RAM 用户的 AccessKey，并授予其 DataWorks 的最小必要权限。

基本使用方法

启动 MCP 客户端: 使用支持 MCP 协议的客户端（例如 Cursor 或 Cline），并按照客户端的文档配置上述服务器信息。
连接 MCP 服务器: 客户端启动后，会自动连接到 DataWorks MCP Server。
使用 DataWorks 工具: 在客户端中，您可以使用 DataWorks MCP Server 提供的工具，例如 'LIST_PROJECTS' (获取 DataWorks 项目列表) 等，来操作和管理您的 DataWorks 资源。具体的工具列表和使用方法，请参考 https://dataworks.data.aliyun.com/dw-pop-mcptools。
查看 Prompt 示例: 您可以使用客户端提供的 Prompt 功能，查看工具的使用示例，以便更好地理解工具的输入参数和输出结果。

关键词