DataWorks:DataWorks Agent on third-party clients

Prerequisites

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

• (Optional, for RAM users) You have added the development RAM user to the workspace with the Development or Workspace Manager 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 you need to bind your personal development environment to a Virtual Private Cloud (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 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 instance under Personal Development Environment to enter the environment.

   • If the instance is in another state: 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, then click the instance to enter the environment.

   Note

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

Step 2: Install Cline

After entering 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 LLM API key

After installing the Cline extension, follow these steps to configure your API key. This example demonstrates how to connect to the Model Studio (Bailian) API 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, 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 you want to use. Select OpenAI Compatible. This indicates that you will use an OpenAI-compatible interface to connect to the Model Studio (Bailian) API.
   Base URL	The base URL for the API service, which specifies the root address for API requests. For example, the OpenAI-compatible API endpoint provided by Model Studio (Bailian) 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 (Bailian) console.
   Model ID	The model to use. Models vary in function 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 the Let's go! button at the bottom to complete the API key configuration.

Step 4: Configure the 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. In the upper-right corner of the Cline page, click the icon to go to the Marketplace tab in the MCP Servers panel.

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 the 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. This is the command provided by dataworks-mcp-server.
   args		alibabacloud-dataworks-mcp-server. This is the command argument for dataworks-mcp-server.
   env	REGION	cn-shanghai in the example. This indicates the region where the current DataWorks workspace is located.
   	ALIBABA_CLOUD_CREDENTIALS_URI	Specifies the URI for the Alibaba Cloud credential. Important This parameter is only effective in the DataWorks personal development environment and is used to obtain Alibaba Cloud user authentication.
   	TOOL_CATEGORIES	Configures an allowlist of Tool categories. Enter the OpenAPI categories here, separated by commas. Example: "TOOL_CATEGORIES":"Data Source,Workspace Management,Resource Group Management,Data Map,Data Integration,Data Development (New),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	Configures an allowlist of Tool names. Enter the OpenAPI names here, separated by commas. Example: "TOOL_NAMES":"ListProjects,CreateNode,UpdateNode". Note You can find TOOL_NAMES on the DataWorks - OpenAPI Overview page.

4. After you save the configuration, if the page loads and displays a list of available Tools, the alibabacloud-dataworks-mcp-server is installed and configured correctly. You can now use its features.

   Note

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

   

5. You can extend the capabilities of DataWorks Agent by editing the cline_mcp_settings.json file directly 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.