DataWorks:DataWorks Agent for third-party clients

(Optional) Upgrade program engine

If you are using a previous personal development environment or have already installed the Cline extension in the environment, you need to upgrade the existing underlying engine to use the extension features. You can skip this step if you have already upgraded.

One-click upgrade: After entering the personal development environment, if you encounter a pop-up prompting for underlying engine upgrade adaptation, click One-click Upgrade to complete the adaptation upgrade.

Command upgrade: Click the icon on the left side of the bottom toolbar to enter the terminal command bar. Enter the following upgrade commands in the command bar and press Enter to upgrade.

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

After the upgrade is complete, click Reload to apply the latest changes.

Install Cline extension

To install the Cline extension:

1. Click the icon on the left navigation bar of the personal development environment Welcome Page to enter the Extensions page.

2. Enter Cline in the search box on the Extensions page.

3. Locate the Cline extension.

4. Click Install at the bottom right of the Cline extension and wait for the installation to complete.

5. After installing the Cline extension, you can right-click the icon on the left navigation bar to Configure Keybindings, or select Move to > Secondary Sidebar or Move to > Panel according to your preference.

Configure LLM API key

After installing the Cline extension, follow these steps to configure the API Key information. This example uses the OpenAI Compatible mode to connect to the Alibaba Cloud Model Studio (Bailian) API.

1. Click the icon on the left navigation bar of the personal development environment Welcome Page to enter the Cline page.

2. Click Use your own API key in the Cline page and configure it according to the parameter descriptions in the table below.

   Parameter	Description
   API Provider	Specify the API service provider you want to use. Select OpenAI Compatible. This connects to the Alibaba Cloud Model Studio API via an OpenAI-compatible interface.
   Base URL	The base URL of the API service, used to specify the root address of API requests. For example, the API endpoint address compatible with OpenAI provided by Alibaba Cloud Model Studio: https://dashscope-intl.aliyuncs.com/compatible-mode/v1.
   API Key	The key used for identity authentication to ensure your request is legitimate. Obtain the API Key from the Alibaba Cloud Model Studio console.
   Model ID	Specify the specific model you want to use. Different models may have different functions and performance. Select qwen-coder-plus or qwen-plus. These two options represent different pre-trained models: 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.

Access MCP Server

After configuring the API Key, you can follow these steps to complete the relevant configuration for the MCP Server.

1. Click the icon in the upper-right corner of the Cline page to enter the Marketplace tab of MCP Server.

2. Click to switch to the Installed tab.

3. Click Configure MCP Servers. Add the following JSON to the configuration file on the right.

   Note

   If you need to use Hologres capabilities in DataWorks Agent, please access Hologres MCP Server.

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

   Parameter		Description
   command		Enter npx here, indicating the command method provided by dataworks-mcp-server.
   args		Enter the npm package name alibabacloud-dataworks-mcp-server here, indicating the command argument for dataworks-mcp-server.
   env	REGION	Set this to your region ID.
   	ALIBABA_CLOUD_CREDENTIALS_URI	Specify the URI for Alibaba Cloud credentials. Important This parameter is only effective in the DataWorks personal development environment and is used to obtain Alibaba Cloud user identity authentication.
   	TOOL_CATEGORIES	Configure the whitelist for Tool categories. Please enter the OpenAPI categories here, separated by half-width commas. For 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 is the default Tools on the personal development environment. Other business categories can be viewed in the left directory tree of the DataWorks - OpenAPI Overview page.
   	TOOL_NAMES	Configure the whitelist for Tool names. Please enter the OpenAPI names here, separated by half-width commas. For example: "TOOL_NAMES":"ListProjects,CreateNode,UpdateNode". Note TOOL_NAMES can be viewed in the DataWorks - OpenAPI Overview.

4. After editing the configuration information, press Ctrl+S to save and load the MCP Server information you configured.

5. The loaded tools (shown below) confirm that alibabacloud-dataworks-mcp-server has been successfully installed, and you can start using the DataWorks MCP Server function.

   Note

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