Help Center/ CodeArts Agent/ Best Practices/ Code Check and Intelligent Defect Fixing Using CodeArts Check MCP/ Configuring CodeArts Check MCP
Updated on 2026-08-03 GMT+08:00
View PDF
Share

Configuring CodeArts Check MCP

  1. In the upper left corner of IDE, choose File > Open Project, and open the repo-demo project.
  2. Click in the upper right corner of CodeArts Agent IDE to open the settings page.
  3. In the navigation pane on the left, choose MCP.
  4. Download CodeArts Check MCP from official download website to the local PC and decompress it.
  5. Click Configure MCP, copy the following configuration information, and paste it to the mcp_settings.json file. For details about the parameters and their example values, see Table 1.

    After the configuration is complete, press shortcut keys (Ctrl+S for Windows/Linux and Command (⌘)+S for macOS) to save the settings and wait until the tool is started. 
    {
  "mcpServers": {
    "CodeArts Check MCP": {
      "disabled": false,
      "timeout": 600000,
      "command": [
        "D:\\Program Files\\nodejs\\node.exe",
        "D:\\codeartscheck-ts-mcp-server-1.0.0\\package\\dist\\index.js"
      ],     
      "environment": {
        "region": "ap-southeast-3",
        "ak": "your_ak",
        "sk": "your_sk"
      },
      "type": "local"
    }
  }
}
    Table 1 Parameters

    Parameter

    Example Value

    Description

    mcpServers

    See the configuration information below.

    Top-level node, which contains all registered MCP servers.

    CodeArts Check MCP

    /

    (Mandatory) A unique name (maximum 64 characters) used to distinguish between different MCP servers.

    NOTE:

    If the server name exceeds 64 characters, the request may fail with one of the following errors. For details, refer to the definition of Tools under Core Server Features.

    • type: session.error info
    • length over limit, maximum is 64

    disabled

    false

    (Mandatory) Whether to disable the MCP server. The default value is false. Value:

    • false: enabled
    • true: disabled

    timeout

    600000

    Timeout interval (ms). After the timeout interval expires, the client reports an error.

    command

    		 
    "command": [
        "D:\\Program Files\\nodejs\\node.exe",
        "D:\\codeartscheck-ts-mcp-server-1.0.0\\package\\dist\\index.js"
      ],

    (Mandatory) It consists of two parts:

    • "D:\\Program Files\\nodejs\\node.exe": path of the executable file for running the MCP server.
    • "D:\\codeartscheck-ts-mcp-server-1.0.0\\package\\dist\\index.js": path for storing the index.js file after the package obtained in 4 is decompressed.

    environment

    		 
    {
        "region": "ap-southeast-3",
        "ak": "your_ak",
        "sk": "your_sk"
      }

    (Optional) Environment variables, including areas, AK, and SK, passed to the MCP server. These variables must be strings.

    The value of environment.region must be fixed to ap-southeast-3. The methods of obtaining environment.ak and environment.sk are as follows:

    1. Create access keys by referring to Access Keys.
    2. In the Create Access Key dialog box, select the agreement check box and click Next. Enter a description for the access key and click OK.

      After the access key is created, download and save it. Once the dialog box is closed, the key cannot be obtained.

    3. You can obtain the values of environment.ak and environment.sk from the credentials.csv file that you have downloaded and saved.

    type

    local

    Communication protocol of the MCP server. The value is local.

  6. Click in the upper right corner of CodeArts Agent IDE to open the settings page.
  7. In the navigation pane on the left, choose MCP.
  8. On the Installed tab, the MCP server CodeArts Check MCP has been configured and takes effect, as shown in the following figure.

Locally Configuring a Check Task ID

  1. As shown in the following figure, create a codeartscheck folder under .codeartsdoer and create a task.md file in the codeartscheck folder.

    Figure 1 Creating a task.md file

  2. Log in to CodeArts console, and select AP-Singapore.
  3. Click Go to Workspace in the upper right corner to go to the CodeArts project homepage.
  4. Click the req-demo card to go to the homepage of the project.
  5. In the navigation pane, choose Code > Check to go to the CodeArts Check homepage.
  6. On the Tasks tab, click repo-demo-check to go to the Overview page of the scan task repo-demo-check.
  7. Copy the ID of the scan task (that is, the character string between "task" and "detail" in the URL of the current browser).
  8. As shown in the following figure, enter the task ID in the task.md file and save the file.

    Figure 2 Filling in the task.md file

Parent Topic: Code Check and Intelligent Defect Fixing Using CodeArts Check MCP