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

# Quickstart Upgrade Agent

> Get started in minutes with Upgrade Agent. Runs locally in Cursor and Claude Code. Free to use.

export const cursorDeeplink = "cursor://anysphere.cursor-deeplink/mcp/install?name=Chkk%20Upgrade%20Context%20MCP&config=eyJjb21tYW5kIjoiZG9ja2VyIHJ1biAtaSAtLXJtIC1lIENIS0tfQUNDRVNTX1RPS0VOIHB1YmxpYy5lY3IuYXdzL2Noa2svY2hray1tY3AtdXBncmFkZS1jb250ZXh0OmxhdGVzdCIsImVudiI6eyJDSEtLX0FDQ0VTU19UT0tFTiI6IjxBREQgVE9LRU4%252BIn19";

Chkk **Upgrade Agent** connects Chkk **Upgrade Plans** to your **MCP-compatible AI coding agent** (e.g., Cursor, Claude Code),
turning approved plans into environment-aware diffs and precise edits to your IaC (Helm/Kustomize/Jsonnet/Terraform).
The agent changes only what's required, preserves your customizations, and produces a focused PR you can review,
validate, and merge with confidence.

<Tabs>
  <Tab title="Cursor + Chkk">
    ## Prerequisites

    1. [Install Docker](https://docs.docker.com/get-docker/): Required to run the Chkk-Upgrade-Context-MCP Server.

    2. [Install Cursor](/resources/installation-guides/cursor): Required to begin generating environment-aware pull requests.

    <Info>
      Agent Responses on this page are illustrative. Exact phrasing from your AI
      model may vary depending on the model, settings, and repository context.
    </Info>

    <Note>
      For the best experience, it is recommended to use the **claude-4-sonnet** model with the Chkk-Upgrade-Context-MCP Server.
    </Note>

    <Steps>
      <Step title="Clone the Sample Chkk IaC repo">
        Run the following command to clone the sample Chkk IaC repo and open it in Cursor:

        ```bash theme={"dark"}
        git clone git@github.com:chkk-io/upgrade-playground.git && \
        cd upgrade-playground && \
        cursor .
        ```
      </Step>

      <Step title="Retrieve your Chkk Access Token">
        1. In the **Chkk Dashboard**, expand **Configure** on the left menu and click **Settings**.
        2. Select the **Tokens** tab. Here you'll see a list of all your active tokens (if any), along with options to create new ones or revoke existing ones.
        3. Click on the **clipboard** icon next to a token to copy it.

                   <img src="https://mintcdn.com/chkk/ErQAF5e5P7IkmW9z/images/features/chkk-access-token.gif?s=f0f979e1e97c8531d96868a9db175c25" alt="Tokens Tab" width="1920" height="1080" data-path="images/features/chkk-access-token.gif" />
      </Step>

      <Step title="Install in Cursor via deeplink">
        Click the card below to install the Chkk Upgrade Context MCP Server in Cursor.

        <Card title="Add Chkk to Cursor" icon="plus" href={cursorDeeplink} horizontal={true}>
          Click here to add Chkk to your Cursor
        </Card>
      </Step>

      <Step title="Configure your Chkk Access Token">
        Paste your Chkk Access Token in the `CHKK_ACCESS_TOKEN` environment variable
        in the **MCP Tool Settings** opened via the deeplink in the previous step.

        <img src="https://mintcdn.com/chkk/P3h5EG42IrWoBIeY/images/ai/cursor-install-uc-mcp.png?fit=max&auto=format&n=P3h5EG42IrWoBIeY&q=85&s=7d382f57e6de4cbf2975c55811abc15b" alt="Tokens Tab" width="1108" height="532" data-path="images/ai/cursor-install-uc-mcp.png" />
      </Step>

      <Step title="Verify Chkk Upgrade Context MCP Server is installed">
        Verify in **MCP Tool Settings** that Chkk Upgrade Context MCP Server is
        successfully installed and enabled. <img src="https://mintcdn.com/chkk/P3h5EG42IrWoBIeY/images/ai/cursor-uc-mcp-installed.png?fit=max&auto=format&n=P3h5EG42IrWoBIeY&q=85&s=c2e64240eb771281e943b0ac696f3554" alt="Tokens
        Tab" width="1116" height="316" data-path="images/ai/cursor-uc-mcp-installed.png" />
      </Step>

      <Steps title="Retrieve the Upgrade ID">
        1. In the **left-hand column** of the **Chkk Dashboard**, expand **Upgrade Copilot**.

        2. Under **Upgrade Plans** select **Add-on & App Services**.

                   <img src="https://mintcdn.com/chkk/ErQAF5e5P7IkmW9z/images/navigation/nav-project-upgrade-plans.png?fit=max&auto=format&n=ErQAF5e5P7IkmW9z&q=85&s=5f7a62b414f23a14f92997ef9c855916" alt="Navigate to Project Upgrade Plans" width="3516" height="2166" data-path="images/navigation/nav-project-upgrade-plans.png" />

        3. On the **Middle Right** corner of the page, enable the **Show Example Data** toggle, as shown in the image below.

        4. This will switch the view to only show example data and displays a confirmation banner.

                   <img src="https://mintcdn.com/chkk/ErQAF5e5P7IkmW9z/images/features/enable-show-example-data-toggle.png?fit=max&auto=format&n=ErQAF5e5P7IkmW9z&q=85&s=014dc909a160122f2b2c08ea0bdc140e" alt="Enable Example Data" width="3510" height="2160" data-path="images/features/enable-show-example-data-toggle.png" />

        5. In the table below, you will see a list of Projects **Example Upgrade Plans**.

        6. Select any Upgrade Plan from the table that has the **AI Context Generated** badge, as shown in the image below.

        <Info>
          The **AI Context Generated** badge indicates that these Upgrade Plans are supported by the **Chkk-Upgrade-Context-MCP Server**.
        </Info>

        <img src="https://mintcdn.com/chkk/ErQAF5e5P7IkmW9z/images/features/highlight-example-project-plan-with-ai-context-generated.png?fit=max&auto=format&n=ErQAF5e5P7IkmW9z&q=85&s=70657d45165b34cf2d4146ab9eebdf7c" alt="Example Project Upgrade Plan with AI Context Generated Badge" width="3516" height="2110" data-path="images/features/highlight-example-project-plan-with-ai-context-generated.png" />

        7. At the top of the page, under the name of the Upgrade Plan, you will see the **Upgrade ID**.
        8. Click the **clipboard** icon to copy the Upgrade ID to your clipboard.

                   <img src="https://mintcdn.com/chkk/ErQAF5e5P7IkmW9z/images/features/step-copy-project-upgrade-plan-id.png?fit=max&auto=format&n=ErQAF5e5P7IkmW9z&q=85&s=785f980f08904d1dd8cce4e4b6eb4bde" alt="Upgrade ID" width="3516" height="2160" data-path="images/features/step-copy-project-upgrade-plan-id.png" />
      </Steps>

      <Step title="Load the Chkk Upgrade Agent">
        Paste and send the following Prompt in the Cursor chat:

        <CodeBlock wrap language="text">
          You're in a K8s repo. Fetch "addon-upgrade-agent" from Chkk MCP and upgrade the package listed in the upgrade plan. Start by asking for the upgrade ID.
        </CodeBlock>

        <Info>
          Your opening prompt is flexible, but it **must** explicitly instruct the agent to **fetch "addon-upgrade-agent" from Chkk MCP**.
        </Info>

        **Agent Response:**

        <img src="https://mintcdn.com/chkk/P3h5EG42IrWoBIeY/images/ai/cursor-sample-req-upg-id.png?fit=max&auto=format&n=P3h5EG42IrWoBIeY&q=85&s=426bbfc825917bd6b52286098a0dab48" alt="Tokens Tab" width="950" height="150" data-path="images/ai/cursor-sample-req-upg-id.png" />
      </Step>

      <Step title="Provide the upgrade ID of the Example Upgrade Plan">
        Paste your **upgrade ID** (from your instantiated [Project Upgrade Plan](/resources/glossary#project-upgrade-plan)), for example:

        <CodeBlock copy={false}>
          upgr\_ea53db65-3d8d-4744-b8b7-92e3c7552932
        </CodeBlock>

        **Agent Response:**

        <img src="https://mintcdn.com/chkk/P3h5EG42IrWoBIeY/images/ai/cursor-sample-start-post-upg-id.png?fit=max&auto=format&n=P3h5EG42IrWoBIeY&q=85&s=75087f4c465577eca005d6f86c1b52a9" alt="Tokens Tab" width="950" height="136" data-path="images/ai/cursor-sample-start-post-upg-id.png" />
      </Step>

      <Step title="Let the agent apply changes to your IaC">
        Cursor will fetch Upgrade Context, stage artifacts in a local **Scratchpad** (`.chkk/scratchpad/upgrade-agent/` in the current working directory),
        apply targeted edits (`Chart.yaml`, `values.yaml`, minimal templates), and summarize the changes it has made.

        **Agent Response:**

        <img src="https://mintcdn.com/chkk/P3h5EG42IrWoBIeY/images/ai/cursor-sample-files-changed-concise.png?fit=max&auto=format&n=P3h5EG42IrWoBIeY&q=85&s=fac1029cf80c619ed08f8769ac77bcaa" alt="Tokens Tab" width="950" height="264" data-path="images/ai/cursor-sample-files-changed-concise.png" />

        <Info>
          To ensure your model is not overwhelmed by the task scope, any modifications are processed in batches of 5 files at a time.
        </Info>
      </Step>

      <Step title="Review the changes">
        You can now review the changes made within each file, which you would have
        otherwise would have had to do manually.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Claude Code + Chkk">
    ## Prerequisites

    1. [Install Docker](https://docs.docker.com/get-docker/): Required to run the Chkk-Upgrade-Context-MCP Server.

    2. [Install Claude Code](/resources/installation-guides/claude-code): Required to begin generating environment-aware pull requests.

    3. A [Claude.ai](https://claude.ai/) (recommended) or [Anthropic Console](https://console.anthropic.com/) account

    <Info>
      Agent Responses on this page are illustrative. Exact phrasing from your AI
      model may vary depending on the model, settings, and repository context.
    </Info>

    <Note>
      For the best experience, it is recommended to use the **claude-4-sonnet** model with the Chkk-Upgrade-Context-MCP Server.
    </Note>

    <Steps>
      <Step title="Clone the Sample Chkk IaC repo">
        Run the following command to clone the sample Chkk IaC repo:

        ```bash theme={"dark"}
        git clone git@github.com:chkk-io/upgrade-playground.git && \
        cd upgrade-playground
        ```
      </Step>

      <Step title="Retrieve your Chkk Access Token">
        1. In the **Chkk Dashboard**, expand **Configure** on the left menu and click **Settings**.
        2. Select the **Tokens** tab. Here you'll see a list of all your active tokens (if any), along with options to create new ones or revoke existing ones.
        3. Click on the **clipboard** icon next to a token to copy it.

                   <img src="https://mintcdn.com/chkk/ErQAF5e5P7IkmW9z/images/features/chkk-access-token.gif?s=f0f979e1e97c8531d96868a9db175c25" alt="Tokens Tab" width="1920" height="1080" data-path="images/features/chkk-access-token.gif" />
      </Step>

      <Step title="Install in Claude Code">
        Install the `Chkk-Upgrade-Context-MCP` using the Claude Code CLI:

        ```bash theme={"dark"}
        claude mcp add Chkk-Upgrade-Context-MCP --env CHKK_ACCESS_TOKEN="<CHKK_TOKEN>"  -- docker run -i --rm -e CHKK_ACCESS_TOKEN public.ecr.aws/chkk/chkk-mcp-upgrade-context:latest
        ```

        Replace `<CHKK_TOKEN>` with your Chkk Access Token.
      </Step>

      <Step title="Verify Chkk-Upgrade-Context-MCP Server is installed">
        Verify via CLI that the server is registered:

        ```bash theme={"dark"}
        claude mcp get Chkk-Upgrade-Context-MCP
        ```

        The command should return server details indicating it is installed and enabled.

        <img src="https://mintcdn.com/chkk/jVz5fXAMivd3Hr6E/images/ai/claude-code-mcp-setup.png?fit=max&auto=format&n=jVz5fXAMivd3Hr6E&q=85&s=8c9d625d12d42a5fdc2db59701a14677" alt="Claude Code Chkk MCP Server" width="3010" height="414" data-path="images/ai/claude-code-mcp-setup.png" />
      </Step>

      <Steps title="Retrieve the Upgrade ID">
        1. In the **left-hand column** of the **Chkk Dashboard**, expand **Upgrade Copilot**.

        2. Under **Upgrade Plans** select **Add-on & App Services**.

                   <img src="https://mintcdn.com/chkk/ErQAF5e5P7IkmW9z/images/navigation/nav-project-upgrade-plans.png?fit=max&auto=format&n=ErQAF5e5P7IkmW9z&q=85&s=5f7a62b414f23a14f92997ef9c855916" alt="Navigate to Project Upgrade Plans" width="3516" height="2166" data-path="images/navigation/nav-project-upgrade-plans.png" />

        3. On the **Middle Right** corner of the page, enable the **Show Example Data** toggle, as shown in the image below.

        4. This will switch the view to only show example data and displays a confirmation banner.

                   <img src="https://mintcdn.com/chkk/ErQAF5e5P7IkmW9z/images/features/enable-show-example-data-toggle.png?fit=max&auto=format&n=ErQAF5e5P7IkmW9z&q=85&s=014dc909a160122f2b2c08ea0bdc140e" alt="Enable Example Data" width="3510" height="2160" data-path="images/features/enable-show-example-data-toggle.png" />

        5. In the table below, you will see a list of Projects **Example Upgrade Plans**.

        6. Select any Upgrade Plan from the table that has the **AI Context Generated** badge, as shown in the image below.

        <Info>
          The **AI Context Generated** badge indicates that these Upgrade Plans are supported by the **Chkk-Upgrade-Context-MCP Server**.
        </Info>

        <img src="https://mintcdn.com/chkk/ErQAF5e5P7IkmW9z/images/features/highlight-example-project-plan-with-ai-context-generated.png?fit=max&auto=format&n=ErQAF5e5P7IkmW9z&q=85&s=70657d45165b34cf2d4146ab9eebdf7c" alt="Example Project Upgrade Plan with AI Context Generated Badge" width="3516" height="2110" data-path="images/features/highlight-example-project-plan-with-ai-context-generated.png" />

        7. At the top of the page, under the name of the Upgrade Plan, you will see the **Upgrade ID**.
        8. Click the **clipboard** icon to copy the Upgrade ID to your clipboard.

                   <img src="https://mintcdn.com/chkk/ErQAF5e5P7IkmW9z/images/features/step-copy-project-upgrade-plan-id.png?fit=max&auto=format&n=ErQAF5e5P7IkmW9z&q=85&s=785f980f08904d1dd8cce4e4b6eb4bde" alt="Upgrade ID" width="3516" height="2160" data-path="images/features/step-copy-project-upgrade-plan-id.png" />
      </Steps>

      <Step title="Open the project in Claude Code">
        From inside the `upgrade-playground` directory, start Claude Code.

        ```bash theme={"dark"}
        claude
        ```

        <img src="https://mintcdn.com/chkk/jVz5fXAMivd3Hr6E/images/ai/claude-code-open.png?fit=max&auto=format&n=jVz5fXAMivd3Hr6E&q=85&s=9952355b570985d680ddae6e88a0bc74" alt="Open Claude Code" width="3024" height="1286" data-path="images/ai/claude-code-open.png" />
      </Step>

      <Step title="Load the Chkk Upgrade Agent">
        Open a chat in Claude Code and send:

        <CodeBlock wrap language="text">
          You're in a K8s repo. Fetch "addon-upgrade-agent" from Chkk MCP and upgrade the package listed in the upgrade plan. Start by asking for the upgrade ID.
        </CodeBlock>

        <Info>
          Your opening prompt is flexible, but it **must** explicitly instruct the assistant to **fetch "addon-upgrade-agent" from Chkk MCP**.
        </Info>

        **Agent Response:**

        <img src="https://mintcdn.com/chkk/jVz5fXAMivd3Hr6E/images/ai/claude-code-init-prompt.png?fit=max&auto=format&n=jVz5fXAMivd3Hr6E&q=85&s=dbd03222df1be9e4ec36ab8917f8c04a" alt="Claude Code Chkk MCP Server start" width="3024" height="394" data-path="images/ai/claude-code-init-prompt.png" />
      </Step>

      <Step title="Provide the upgrade ID of the Example Upgrade Plan">
        Paste your **upgrade ID** (from your instantiated [Project Upgrade Plan](/resources/glossary#project-upgrade-plan)), for example:

        <CodeBlock copy={false}>
          upgr\_ea53db65-3d8d-4744-b8b7-92e3c7552932
        </CodeBlock>

        **Agent Response:**

        <img src="https://mintcdn.com/chkk/jVz5fXAMivd3Hr6E/images/ai/claude-code-upgrade-id.png?fit=max&auto=format&n=jVz5fXAMivd3Hr6E&q=85&s=65aa6381b36b760d934c2c5a53c93a12" alt="Claude Code Chkk MCP Server upgrade" width="2936" height="826" data-path="images/ai/claude-code-upgrade-id.png" />
      </Step>

      <Step title="Let the assistant apply changes to your IaC">
        The assistant will fetch Upgrade Context, stage artifacts in a local **Scratchpad** (`.chkk/scratchpad/upgrade-agent/` in the current working directory),
        apply targeted edits (`Chart.yaml`, `values.yaml`, minimal templates), and summarize the changes it has made.

        **Agent Response:**

        <img src="https://mintcdn.com/chkk/jVz5fXAMivd3Hr6E/images/ai/claude-code-apply-changes.png?fit=max&auto=format&n=jVz5fXAMivd3Hr6E&q=85&s=94f07cabd7577601fc5d685971b7d6d5" alt="Claude Code Apply Changes" width="2220" height="1538" data-path="images/ai/claude-code-apply-changes.png" />

        <Info>
          To ensure your model is not overwhelmed by the task scope, any modifications are processed in batches of 5 files at a time.
        </Info>
      </Step>

      <Step title="Review the changes">
        You can now review the changes made within each file, which you would have
        otherwise would have had to do manually.

        **Agent Response:**

        <img src="https://mintcdn.com/chkk/jVz5fXAMivd3Hr6E/images/ai/claude-code-review-changes.png?fit=max&auto=format&n=jVz5fXAMivd3Hr6E&q=85&s=b691454b2d07bcf64948d4607524e28d" alt="Claude Code Review Changes" width="3014" height="1286" data-path="images/ai/claude-code-review-changes.png" />
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Info>
  Learn more in the [Upgrade Agent guide](/ai/upgrade-agent).
</Info>

***

### Need Help?

Email us at **[support@chkk.io](mailto:support@chkk.io)** for assistance.
