> ## Documentation Index
> Fetch the complete documentation index at: https://docs.semgrep.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Semgrep Guardian

> Set up Semgrep's AI coding agent security plugin to scan AI-generated code and identify security issues before they ship.

Semgrep Guardian integrates natively with AI coding agents like Claude Code and Cursor to catch security issues before they ship. It bundles the Semgrep MCP server, Hooks, and Skills into a single install, and scans every file an agent generates using Semgrep Code, Supply Chain, and Secrets. When findings are detected, the agent is prompted to regenerate code until Semgrep returns clean results or you choose to dismiss them.

The plugin uses each IDE's native hook or MCP system:

* **Claude Code**: [hooks](https://code.claude.com/docs/en/hooks) and [plugins](https://code.claude.com/docs/en/plugins)
* **Codex**: [MCP](https://developers.openai.com/codex/mcp)
* **Cursor**: [hooks](https://cursor.com/docs/hooks) and [MCP](https://cursor.com/docs/mcp)
* **GitHub Copilot** (Visual Studio, JetBrains, Xcode, Eclipse): [MCP](https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp)
* **Kiro**: [MCP](https://kiro.dev/docs/mcp/)
* **VS Code**: [MCP](https://code.visualstudio.com/docs/copilot/customization/mcp-servers)
* **Devin** (Windsurf): [Cascade hooks](https://docs.windsurf.com/windsurf/cascade/hooks)

This guide covers setup for each of the preceding products listed, but the plugin works with any MCP client.

## Prerequisites

* A Semgrep account

## Connect to your IDE

<Tabs>
  <Tab title="Claude Code">
    Claude Code uses Semgrep's hosted remote server by default, so you do not need to install the Semgrep CLI locally.

    <Steps>
      <Step>
        Start a Claude Code instance:

        ```bash theme={null}
        claude
        ```
      </Step>

      <Step>
        Open the plugin manager:

        ```bash theme={null}
        /plugin
        ```
      </Step>

      <Step>
        Go to **Discover**, search for **Semgrep**, and click **Install**.
      </Step>

      <Step>
        Tell Claude to load the plugin:

        ```bash theme={null}
        /reload-plugins
        ```
      </Step>

      <Step>
        Start a new session in Claude to begin the Semgrep login flow:

        ```bash theme={null}
        /clear
        ```
      </Step>
    </Steps>

    The plugin registers a post-tool hook so Claude Code scans every file it writes. Learn more about [Claude Code plugins](https://code.claude.com/docs/en/plugins) and [hooks](https://code.claude.com/docs/en/hooks).

    <Accordion title="Run Semgrep Guardian locally">
      The remote server is the recommended default. If you need to run Semgrep locally instead, you can install the local plugin from the [`semgrep/guardian-local`](https://github.com/semgrep/guardian-local) repo.

      <Steps>
        <Step>
          [Install the Semgrep CLI](#install-the-semgrep-cli).
        </Step>

        <Step>
          Start a Claude Code instance:

          ```bash theme={null}
          claude
          ```
        </Step>

        <Step>
          Open the plugin manager:

          ```bash theme={null}
          /plugin
          ```
        </Step>

        <Step>
          Go to **Discover**. Search for **Semgrep**, and then click **Install**.
        </Step>

        <Step>
          Load the plugin:

          ```bash theme={null}
          /reload-plugins
          ```
        </Step>
      </Steps>
    </Accordion>
  </Tab>

  <Tab title="Codex">
    <Steps>
      <Step>
        [Install the Semgrep CLI](#install-the-semgrep-cli).
      </Step>

      <Step>
        Update your `~/.codex/config.toml` file and paste the following:

        ```bash theme={null}
        [mcp_servers.semgrep]
        command = "semgrep"
        args = ["mcp"]
        ```
      </Step>
    </Steps>

    Codex does not expose a post-write hook, so Semgrep tools are surfaced through MCP and invoked when the agent calls them. Learn more about [Codex MCP configuration](https://developers.openai.com/codex/mcp).
  </Tab>

  <Tab title="Cursor">
    <Steps>
      <Step>
        [Install the Semgrep CLI](#install-the-semgrep-cli).
      </Step>

      <Step>
        Find Semgrep in the [Cursor Plugin Marketplace](https://cursor.com/marketplace/semgrep), or open **Cursor > ⌘⇧J > Plugins**. Search "Semgrep" and click **Add to Cursor**.
      </Step>

      <Step>
        Restart Cursor to apply configuration.
      </Step>

      <Step>
        In Cursor's chat, run the `/setup-semgrep-plugin` skill to finish wiring up the plugin.

        The plugin uses [Cursor hooks](https://cursor.com/docs/hooks) (`afterFileEdit` and `stop`) to scan code as the agent writes it, and exposes Semgrep tools through [Cursor MCP](https://cursor.com/docs/mcp).
      </Step>
    </Steps>
  </Tab>

  <Tab title="GitHub Copilot">
    Use this tab for GitHub Copilot in Visual Studio, JetBrains IDEs, Xcode, or Eclipse. (For Copilot in VS Code, use the **VS Code** tab.)

    <Steps>
      <Step>
        [Install the Semgrep CLI](#install-the-semgrep-cli).
      </Step>

      <Step>
        Register the Semgrep MCP server with your IDE's Copilot configuration. The JSON shape is the same across IDEs:

        ```json theme={null}
          {
            "servers": {
              "semgrep": {
                  "command": "semgrep",
                  "args": ["mcp"]
              }
            }
          }
        ```

        Follow your IDE's instructions for *where* to put this entry: [Extending Copilot Chat with MCP servers](https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp) covers Visual Studio, JetBrains, Xcode, and Eclipse.
      </Step>

      <Step>
        Restart your IDE and open Copilot Chat. Semgrep tools become available in **Agent** mode.
      </Step>
    </Steps>

    Copilot does not expose a post-write hook, so Semgrep tools are invoked when the agent calls them through MCP.
  </Tab>

  <Tab title="VS Code">
    <Steps>
      <Step>
        [Install the Semgrep CLI](#install-the-semgrep-cli).
      </Step>

      <Step>
        Add the Semgrep MCP server to VS Code. Create `.vscode/mcp.json` in your workspace (or run the **MCP: Open User Configuration** command from the Command Palette for a user-wide entry) and paste the following:

        ```json theme={null}
          {
            "servers": {
              "semgrep": {
                  "command": "semgrep",
                  "args": ["mcp"]
              }
            }
          }
        ```
      </Step>

      <Step>
        Reload VS Code. Semgrep tools become available in the Copilot Chat **Agent** mode.
      </Step>
    </Steps>

    VS Code does not expose a post-write hook today, so Semgrep tools are invoked when the agent calls them through MCP. Learn more about [adding and managing MCP servers in VS Code](https://code.visualstudio.com/docs/copilot/customization/mcp-servers).
  </Tab>

  <Tab title="Devin (Windsurf)">
    <Steps>
      <Step>
        [Install the Semgrep CLI](#install-the-semgrep-cli).
      </Step>

      <Step>
        Create a `hooks.json` file at `~/.codeium/windsurf/hooks.json` and paste the following configuration:

        ```json theme={null}
        {
          "hooks": {
            "post_write_code": [
              {
                "command": "semgrep mcp -k post-tool-cli-scan -a windsurf",
                "show_output": true
              }
            ]
          }
        }
        ```
      </Step>

      <Step>
        Restart Windsurf to apply hook configuration.
      </Step>
    </Steps>

    The `post_write_code` event fires after Cascade writes or modifies any file. Learn more about [Windsurf Cascade hooks](https://docs.windsurf.com/windsurf/cascade/hooks).
  </Tab>

  <Tab title="Kiro">
    Kiro uses your locally installed Semgrep CLI to run Semgrep on your machine, so [install the Semgrep CLI](#install-the-semgrep-cli) first. Clicking the box below opens Kiro directly so you can add the server; it will not open a new browser tab.

    [![Add to Kiro](https://kiro.dev/images/add-to-kiro.svg)](https://kiro.dev/launch/mcp/add?name=semgrep\&config=%7B%22command%22%3A%22semgrep%22%2C%22args%22%3A%5B%22mcp%22%5D%2C%22env%22%3A%7B%22SEMGREP_APP_TOKEN%22%3A%22%24%7BSEMGREP_TOKEN%7D%22%7D%7D)

    Alternatively, follow the [Kiro MCP docs](https://kiro.dev/docs/mcp/) and add this file to your `.kiro/settings/mcp.json`:

    ```json theme={null}
    {
      "mcpServers": {
        "semgrep": {
          "command": "semgrep",
          "args": ["mcp"],
          "env": {
            "SEMGREP_APP_TOKEN": "${SEMGREP_TOKEN}"
          }
        }
      }
    }
    ```

    See [Kiro docs](https://kiro.dev/docs/mcp/) for more info.
  </Tab>

  <Tab title="Other IDEs">
    [Install the Semgrep CLI](#install-the-semgrep-cli), then add the Semgrep MCP Server to your IDE. Semgrep provides [sample configuration information](https://github.com/semgrep/semgrep/tree/develop/cli/src/semgrep/mcp#integrations) that you can use as a starting point. Refer to your IDE's documentation for specific details on where to add the MCP server configuration.

    If your IDE supports a post-write or post-tool hook, point it at `semgrep mcp -k post-tool-cli-scan -a <ide-name>` to scan generated code automatically. The Windsurf tab above shows this pattern.
  </Tab>
</Tabs>

## What rules does Semgrep Guardian scan with?

Guardian uses different rules depending on the environment in which you use it:

* **Claude Code remote server (default):** scans with the default [Guardian ruleset](https://semgrep.dev/p/guardian-default). This is not currently configurable. If you require custom rules, see Semgrep's `#mcp` [Slack community](https://go.semgrep.dev/slack) for assistance.
* **Claude Code local and all other IDE integrations:** scans with the rules enabled for your Semgrep organization through your Policies.

## Install the Semgrep CLI

Every IDE except Claude Code runs Semgrep from a locally installed CLI. Claude Code uses Semgrep's hosted remote server by default and does not need a local CLI.

<Steps>
  <Step>
    Install the Semgrep CLI using pipx, uv, or Homebrew. This requires Python 3.10 or later -- the Semgrep CLI needs Python at runtime regardless of how you installed the CLI:

    ```bash theme={null}
    # preferred: install using pipx (https://pipx.pypa.io/stable/how-to/install-pipx/)
    pipx install semgrep

    # preferred: install using uv (https://docs.astral.sh/uv/)
    uv tool install semgrep

    # best-effort (macOS): install using Homebrew (maintained on a best-effort basis; often lags behind the latest release)
    brew install semgrep
    ```

    <Info>
      **NOTE**

      `pipx` and `uv` are the preferred installation methods. The Homebrew formula is maintained on a best-effort basis and often lags behind the latest release.

      **Homebrew users:** ensure that you've [added Homebrew to your PATH](https://docs.brew.sh/FAQ#my-mac-apps-dont-find-homebrew-utilities).
    </Info>
  </Step>

  <Step>
    Verify that you've installed the [latest version](https://github.com/semgrep/semgrep/releases) of Semgrep:

    ```bash theme={null}
    semgrep --version
    ```
  </Step>

  <Step>
    Sign in to your Semgrep account and install the Semgrep Pro engine:

    ```bash theme={null}
    semgrep login && semgrep install-semgrep-pro
    ```

    `semgrep login` launches a browser window. You can also use the activation link printed in the terminal.
  </Step>
</Steps>

## Additional resources

* Semgrep's `#mcp` [Slack community](https://go.semgrep.dev/slack)
* The [Semgrep MCP server repo on GitHub](https://github.com/semgrep/semgrep/tree/develop/cli/src/semgrep/mcp)