Skip to main content

Installation and Initial Setup

Initial Setup and Configuration

Prerequisites

  • You have a an API Key for authenticating with Developer Assist

  • For VS Code: supported for version 1.100.0 or above (supports both settings.json (v1.100–1.101) and mcp.json ( v1.102+))

  • For VS Code: you must have GitHub Copilot installed

  • For Kiro: supported for version 0.6+ (latest version recommended)

Installing and Configuring the Plugin

The instructions below cover the general setup for all supported IDEs. For detailed, IDE-specific steps, open the collapsible section corresponding to your IDE.

  1. Install the Checkmarx extension from the Marketplace.

  2. In the IDE, open the extension, click on Log in, and enter your API Key.

  3. Make sure that the Checkmarx Developer Assist MCP is running.

  4. Optionally, adjust Checkmarx Developer Assist settings.

VS Code

  1. In the VS Code IDE main navigation, click on the Extensions icon.

  2. Search for the Checkmarx extension, then click Install for that extension.

    The Developer Assist extension is installed and the Checkmarx icon appears in the left-side navigation panel.

  3. Click on the Checkmarx extension icon.

    The Checkmarx One Authentication sidebar opens:

    Image_906.png

  4. In the Checkmarx One Authentication sidebar, click Log in.

    The Log in window opens.

    Image_907.png

  5. Enter your activation key in the Checkmarx Developer Assist API Key field and click Log in.

    The Checkmarx Developer Assist Authentication sidebar will now show that you are logged in.

    Image_908.png

  6. A Checkmarx Developer Assist welcome page is displayed immediately after a successful login. Scroll down and click on Mark Done.

  7. Click View > Command Pallete and enter MCP:List Servers.

    Image_790.png

  8. In the MCP servers list, select Checkmarx Developer Assist.

  9. Click on Start Server.

  10. You can optionally adjust the Checkmarx Developer Assist Settings as follows:

    1. Add Additional Params to set up custom configuraitions, such as proxy servers or to run in debug mode.

    2. Enable/disable specific realtime scanners. By default, all scanners are enabled.

    3. For IaC realtime scanner you can change the container platform used, Docker (default) or Podman.

Cursor

  1. In the Cursor IDE, click on the Extensions icon.

  2. Search for the Checkmarx Developer Assist extension, then click Install for that extension.

    The Developer Assist extension is installed.

  3. Click the arrow next to the Extensions icon to open the drop-down menu. Then click the pin icon beside the Checkmarx extension to add it to the top navigation bar.

  4. Click on the Checkmarx extension icon.

    The Checkmarx Developer Assist Authentication sidebar opens:

    Image_912.png

  5. In the Checkmarx Developer Assist Authentication sidebar, click Log in.

    The Log in window opens.

    Image_914.png

  6. Enter your activation key in the Checkmarx Developer Assist API Key field and click Log in.

    The Checkmarx Developer Assist Authentication sidebar will now show that you are logged in.

    Image_915.png

  7. A Checkmarx Developer Assist welcome page is displayed immediately after a successful login. Scroll down and click on Mark Done.

  8. To verify that your MCP server is running:

    1. In Cursor Settings under Tools & MCP > Installed MCP Servers, confirm that the Checkmarx Developer Assist toggle is enabled.

      Image_794.png

  9. You can optionally adjust the Checkmarx Developer Assist Settings as follows:

    1. Add Additional Params to set up custom configuraitions, such as proxy servers or to run in debug mode.

    2. Enable/disable specific realtime scanners. By default, all scanners are enabled.

    3. For IaC realtime scanner you can change the container platform used, Docker (default) or Podman.

Windsurf

  1. In the Windsurf IDE main navigation, click on the Extensions icon.

  2. Search for the Checkmarx Developer Assist extension, then click Install for that extension.

    The Developer Assist extension is installed and the Checkmarx icon appears in the left-side navigation panel.

  3. Click on the Checkmarx extension icon.

    The Checkmarx Developer Assist Authentication sidebar opens:

    windsurf1.png

  4. In the Checkmarx Developer Assist Authentication sidebar, click Log in.

    The Log in window opens.

    windsurf2.png

  5. Enter your activation key in the Checkmarx Developer Assist API Key field and click Log in.

    The Checkmarx Developer Assist Authentication sidebar will now show that you are logged in.

    windsurf3.png

  6. A Checkmarx Developer Assist welcome page is displayed immediately after a successful login. Scroll down and click on Mark Done.

  7. To verify that your MCP server is running:

    Image_899.png

    1. Go to Settings > Windsurf Settings.

    2. Under Cascade, click Open MCP Marketplace, and make sure that the Checkmarx Developer Assist MCP is installed and enabled.

  8. You can optionally adjust the Checkmarx Developer Assist Settings as follows:

    1. Add Additional Params to set up custom configuraitions, such as proxy servers or to run in debug mode.

    2. Enable/disable specific realtime scanners. By default, all scanners are enabled.

    3. For IaC realtime scanner you can change the container platform used, Docker (default) or Podman.

Kiro

  1. In the Kiro IDE main navigation, click on the Extensions icon.

  2. Search for the Checkmarx Developer Assist extension, then click Install for that extension.

  3. In the pop-up window, click Trust Publisher and Install.

    The Developer Assist extension is installed and the Checkmarx icon appears in the left-side navigation panel.

  4. Click on the Checkmarx extension icon.

    The Checkmarx Developer Assist Authentication sidebar opens:

    Image_909.png

  5. In the Checkmarx Developer Assist Authentication sidebar, click Log in.

    The Log in window opens.

    Image_910.png

  6. Enter your activation key in the Checkmarx Developer Assist API Key field and click Log in.

    The Checkmarx Developer Assist Authentication sidebar will now show that you are logged in.

    Image_911.png

  7. A Checkmarx Developer Assist welcome page is displayed immediately after a successful login. Scroll down and click on Mark Done.

  8. To verify that your MCP server is connected:

    Image_900.png

    1. Select the Kiro icon in the left-side navigation panel.

    2. Under MCP servers, confirm that Checkmarx Developer Assist is connected.

  9. You can optionally adjust the Checkmarx Developer Assist Settings as follows:

    1. Add Additional Params to set up custom configuraitions, such as proxy servers or to run in debug mode.

    2. Enable/disable specific realtime scanners. By default, all scanners are enabled.

    3. For IaC realtime scanner you can change the container platform used, Docker (default) or Podman.

Troubleshooting - Manually Configuring the MCP Server

In case the automatic procedure fails. You can manually configure access to the Checkmarx MCP server using the appropriate procedure below, according to your IDE.

Installing MCP in VS Code

In case the automatic installation procedure fails. You can manually configure access to the Checkmarx MCP server using the following procedure.

  1. If it does not already exist, create an mcp.json file at the following location: ${homeDir}\AppData\Roaming\Code\User\mcp.json

  2. Add the "Checkmarx Developer Assist" mcp using the following snippet, replacing <Activation_Key> - with your Developer Assist Activation Key.

    • {
   "servers":{
      "Checkmarx Developer Assist":{
         "url":"https://mea.ast.checkmarx.net/api/security-mcp/mcp",
         "headers":{
            "cx-origin":"VsCode",
            "Authorization":"<Activation_Key>"
         }
      }
   }
}

  3. Start running the MCP server as follows:

    1. Click View > Command Pallete and enter MCP:List Servers.

      Image_790.png

    2. In the MCP servers list, select Checkmarx Developer Assist.

    3. Click on Start Server.

Installing MCP in Cursor

In case the automatic installation procedure fails. You can manually configure access to the Checkmarx MCP server using the following procedure.

  1. If it does not already exist, create an mcp.json file at the following location: ${homeDir}\.cursor\mcp.json

  2. Add the "Checkmarx Developer Assist" mcp using the following snippet, replacing <Activation_Key> - with your Developer Assist Activation Key.

    {
   "mcpServers":{
      "checkmarx Developer Assist":{
         "url":"https://mea.ast.checkmarx.net/api/security-mcp/mcp",
         "headers":{
            "cx-origin":"Cursor",
            "Authorization":"<Activation_Key>"
         }
      }
   }
}

  3. Verify that your MCP server is running by opening Cursor Settings and under Tools & MCP > Installed MCP Servers, confirm that the Checkmarx Developer Assist toggle is enabled.

    Image_794.png

Installing MCP in Windsurf

In case the automatic installation procedure fails. You can manually configure access to the Checkmarx MCP server using the following procedure.

Image_899.png

  1. If it does not already exist, create an mcp_config.json file at the following location: ${homeDir}\.codeium\windsurf\mcp_config.json

    Notice

    If you are using windsurf-next, then the file location should be ${homeDir}\.codeium\windsurf-next\mcp_config.json

  2. Add the "Checkmarx Developer Assist" mcp using the following snippet, replacing <Activation_Key> - with your Developer Assist Activation Key.

    {
   "mcpServers":{
      "checkmarx Developer Assist":{
         "url":"https://mea.ast.checkmarx.net/api/security-mcp/mcp",
         "headers":{
            "cx-origin":"Windsurf",
            "Authorization":"<Activation_Key>"
         }
      }
   }
}

  3. Go to Settings > Windsurf Settings., and under Cascade, click Open MCP Marketplace. Make sure that the Checkmarx Developer Assist MCP is installed and enabled.

Installing MCP in Kiro

In case the automatic installation procedure fails. You can manually configure access to the Checkmarx MCP server using the following procedure.

  1. If it does not already exist, create an mcp.json file at the following location: ${homeDir}\.kiro\settings\mcp.json

  2. Add the "Checkmarx Developer Assist" mcp using the following snippet, replacing <Activation_Key> - with your Developer Assist Activation Key.

    {
   "mcpServers":{
      "checkmarx Developer Assist":{
         "url":"https://mea.ast.checkmarx.net/api/security-mcp/mcp",
         "headers":{
            "cx-origin":"Kiro",
            "Authorization":"<Activation_Key>"
         }
      }
   }
}

  3. Click on theKiro icon in the left-side navigation, and under MCP servers, confirm that Checkmarx Developer Assist is connected.

    Image_900.png
In this section: