DataWorks Agent for third-party clients

Prerequisites

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

• (Optional, for RAM users) You have added the RAM user for task development to the workspace with the Development or Workspace Administrator role. The Workspace Manager role has extensive permissions, so assign it with caution. For details on adding members, see Add members to a workspace.

  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 needs to be bound to a VPC, you must configure public network access for the personal development environment.

Step 1: Enter the personal development environment

Follow these steps to start and access 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 access it.

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

   • If the instance has any other status: Click Management Environment in the pop-up window. On the Personal Development Environment Instances page, find your instance, and click Start in the Actions column. Wait for the Instance Status to change to Running, and then click the instance to enter the environment.

   Note

   An icon similar to in the Personal Development Environment area indicates that you have successfully entered the personal development environment.

Step 2: Install Cline

After you enter the personal development environment, follow these steps to configure DataWorks Agent. This guide 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 the LLM API key

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

1. On the Data Studio personal development environment page, click the icon in the upper-right corner of the top navigation bar to open Copilot Chat, and then click the icon 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	The API service provider that you want to use. 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. For example, the OpenAI-compatible API endpoint provided by Model Studio is https://dashscope.aliyuncs.com/compatible-mode/v1.
   API Key	The key that is used for authentication. You can obtain this API Key from the Alibaba Cloud Model Studio console.
   Model ID	The specific model that you want to use. Different models have different functions and performance. 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 Let's go! to save the configuration.

Step 4: Configure the MCP Server

After you configure 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. In the upper-right corner of the Cline page, click the icon to go to the MCP Servers Marketplace tab.

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, the command provided by dataworks-mcp-server.
   args		alibabacloud-dataworks-mcp-server, the command argument for dataworks-mcp-server.
   env	REGION	The region where your DataWorks workspace is located, for example, cn-shanghai.
   	ALIBABA_CLOUD_CREDENTIALS_URI	The URI for the Alibaba Cloud credential. Important This parameter is valid only in the DataWorks personal development environment and is used to obtain Alibaba Cloud user authentication.
   	TOOL_CATEGORIES	An allowlist of Tool categories. Enter the OpenAPI categories, separated by commas. Example: "TOOL_CATEGORIES":"Data Source,Workspace Management,Resource Group Management,Data Map,Data Integration,Data Studio (new version),Operation Center,DataService,Open Platform,Data Quality,Label 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, the default configuration sets TOOL_CATEGORIES to SERVER_IDE_DEFAULT. To enable all OpenAPI tools, you can remove this configuration item.
   	TOOL_NAMES	An allowlist of Tool names. Enter the OpenAPI names, separated by commas. Example: "TOOL_NAMES":"ListProjects,CreateNode,UpdateNode". Note You can find TOOL_NAMES on the DataWorks - OpenAPI Overview page.

4. If a list of available Tools loads on the page after you save the configuration, alibabacloud-dataworks-mcp-server is installed and configured correctly. You can now use the DataWorks MCP Server features.

   Note

   If this information fails to load, make sure that you have upgraded the engine.

5. You can extend the capabilities of 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 functions in DataWorks Agent, you can connect to the Hologres MCP Server.