DataWorks:DataWorks Agent with third-party clients

Before you begin

• You have created a workspace and selected Use Data Studio (New Version).

• (Optional. Required for RAM users.) The RAM user for task development must be added to the workspace and granted the Development or Workspace Manager role. The Workspace Manager role has extensive permissions, so grant it with caution. For details on adding members, see Add workspace members.

  If you are using an Alibaba Cloud account, you can skip this step.

• You have created a personal development environment instance.

  Note

  If your personal development environment is bound to a Virtual Private Cloud (VPC), you must configure internet access for the personal development environment.

Step 1: Enter personal development environment

Follow these steps to enable and enter your personal development environment.

1. Go to the Workspaces page in the DataWorks console. In the top navigation bar, select a desired region. Find the desired workspace and choose Shortcuts > Data Studio in the Actions column.

2. Click the icon next to Personal Development Environment in the top navigation bar to check the status of your personal development environment instance and enter it.

   • If the instance status is Running: Click the running personal development environment instance under Personal Development Environment to enter it.

   • If the instance is in any other state: Click Management Environment in the pop-up window. On the Personal Development Environment Instances page, find the instance you created, click Start in the Actions column, and wait for the Instance Status to change to Running. Then, click the instance to enter the personal development environment.

   Note

   When an icon similar to appears in the Personal Development Environment area, it means you have entered the personal development environment.

Step 2: Install Cline

After entering the personal development environment, follow these steps to configure the DataWorks Agent. This document uses Cline as an example.

wget https://nodejs.org/dist/v20.19.0/node-v20.19.0-linux-x64.tar.xz
tar xf node-v20.19.0-linux-x64.tar.xz
mv /etc/dsw/node /etc/dsw/node14
mv node-v20.19.0-linux-x64 /etc/dsw/node

bash <(curl -s https://dataworks-notebook-${REGION}.oss-${REGION}.aliyuncs.com/public-datasets/aone-release/dwcode-server/scripts/update.sh)  0.2.169

Step 3: Configure LLM API key

After installing the Cline extension, follow these steps to configure your API key. This example shows how to connect to the Model Studio API using the OpenAI Compatible mode.

1. On the Data Studio personal development environment page, click in the upper-right corner of the top navigation bar to open Copilot Chat, and then click to switch to Cline.

2. On the Cline page, click Use your own API key and configure the parameters as described in the following table.

   Parameter	Description
   API Provider	Specifies the API service provider. Select OpenAI Compatible. This indicates that you will use an OpenAI-compatible interface to connect to the Model Studio API.
   Base URL	The base URL of the API service, which specifies the root address for API requests. For example, the OpenAI-compatible API endpoint address provided by the Model Studio API is https://dashscope-intl.aliyuncs.com/compatible-mode/v1.
   API key	The key used for authentication. You can obtain this API key from the Model Studio console.
   Model ID	Specifies the model you want to use. Different models have different functions and performance characteristics. Select qwen-coder-plus or qwen-plus: qwen-coder-plus: Suitable for code generation and programming tasks. qwen-plus: Suitable for general text generation and processing tasks.

3. Click the Let's go! button below to complete the API key configuration.

Step 4: Configure MCP Server

After configuring the API key, follow these steps to connect to and configure the DataWorks MCP Server. For more information about the DataWorks MCP Server, see Appendix: DataWorks MCP Server.

1. On the Cline page, click the icon in the upper-right corner to go to the Marketplace tab of MCP Server.

2. Switch to the Installed tab to view installed MCP servers.

3. Click Configure MCP Servers to open the cline_mcp_settings.json configuration file. DataWorks provides a default configuration for alibabacloud-dataworks-mcp-server. The configuration is as follows:

   {
     "mcpServers": {
       "alibabacloud-dataworks-mcp-server": {
         "command": "npx",
         "args": [
           "alibabacloud-dataworks-mcp-server"
         ],
         "env": {
           "REGION": "cn-shanghai",
           "ALIBABA_CLOUD_CREDENTIALS_URI": "http://localhost:7002/api/v1/credentials/0",
           "TOOL_CATEGORIES": "SERVER_IDE_DEFAULT"
         },
         "disabled": false,
         "autoApprove": [],
         "timeout": 60
       }
     }
   }

   Parameter		Description
   command		npx, which indicates the command method provided by dataworks-mcp-server.
   args		alibabacloud-dataworks-mcp-server, which indicates the command argument for dataworks-mcp-server.
   env	REGION	The region where the current DataWorks workspace is located. The example uses cn-shanghai.
   	ALIBABA_CLOUD_CREDENTIALS_URI	Specifies the URI for Alibaba Cloud credentials. Important This parameter is effective only in the DataWorks personal development environment and is used to obtain Alibaba Cloud user authentication.
   	TOOL_CATEGORIES	Configures the allowlist of Tool categories. Enter the OpenAPI categories here, separated by commas. Example: "TOOL_CATEGORIES":"Data Sources,Workspace Management,Resource Group Management,Data Map,Data Integration,Data Studio (New Version),Task O&M,Data Service,Open Platform,Data Quality,Tag Management,Security Center,SERVER_IDE_DEFAULT". Note SERVER_IDE_DEFAULT refers to the default Tools in the personal development environment. The other service categories can be found in the left-side directory tree on the DataWorks - OpenAPI Overview page. To improve model loading performance and user experience, TOOL_CATEGORIES is set to SERVER_IDE_DEFAULT in the default configuration. To enable all OpenAPI tools, you can remove this configuration item.
   	TOOL_NAMES	Configures the allowlist of Tool names. Enter the OpenAPI names here, separated by commas. Example: "TOOL_NAMES":"ListProjects,CreateNode,UpdateNode". Note You can find the TOOL_NAMES on the DataWorks - OpenAPI Overview page.

4. After you save the configuration, when the list of available Tools loads, this confirms that alibabacloud-dataworks-mcp-server is installed and configured. You can now start using the DataWorks MCP Server features.

   Note

   If the information fails to load, confirm whether you have upgraded the program engine.

   

5. You can extend the capabilities of the DataWorks Agent by directly editing the cline_mcp_settings.json configuration file or by installing other MCP servers from the Marketplace. For example, to use Hologres-related features in the DataWorks Agent, you can connect to the Hologres MCP Server.