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.

    Caution

    There are other Checkmarx extensions available on marketplace ("Checkmarx Developer Assist" and "Checkmarx SAST 9.x"), make sure that you install the extension called Checkmarx.

  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 Checkmarx 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:

    CheckmarxSidePanel.png

  4. In the Checkmarx One Authentication sidebar, select the API Key login button.

    The API Key Log in window opens.

    ApiKeyLogin.png

  5. Enter your Checkmarx One API Key and click Log in.

  6. The Checkmarx One Authentication sidebar will now show that you are logged in.

    Image_159.png

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

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

    Image_790.png

  9. In the MCP servers list, select Checkmarx.

  10. Click on Start Server.

  11. 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 extension, then click Install for that extension.

    Image_918.png

    The Checkmarx 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 One Authentication sidebar opens:

    cursorsidebar.png

  5. In the Checkmarx One Authentication sidebar, select the API Key login button.

    The API Key Log in window opens.

    ApiKeyLogin.png

  6. Enter your Checkmarx One API Key and click Log in.

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

    Image_898.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 extension, then click Install for that extension.

    windsurf.png

    The Checkmarx extension is installed, and the Checkmarx icon appears on the left-side navigation panel.

    windsurficon.png

  3. Click on the Checkmarx extension icon.

    The Checkmarx One Authentication sidebar opens:

    windsurfsidebar.png

  4. In the Checkmarx One Authentication sidebar, select the API Key login button.

    The API Key Log in window opens.

    ApiKeyLogin.png

  5. Enter your Checkmarx One API Key and click Log in.

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

    windsurflogin.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 extension, then click Install for that extension.

    Notice

    Make sure to install version 2.44.0 or above, since older versions don't support Kiro.

    kiro1.png

    The Checkmarx extension is installed, and the Checkmarx icon appears on the left-side navigation panel.

    kiroicon.png

  3. Click on the Checkmarx extension icon.

    The Checkmarx One Authentication sidebar opens:

    kirosidebar.png

  4. In the Checkmarx One Authentication sidebar, select the API Key login button.

    The API Key Log in window opens.

    ApiKeyLogin.png

  5. Enter your Checkmarx One API Key and click Log in.

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

    kirologgedin.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 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.

  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.

In this section: