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

# Cursor + Chkk in 5 minutes

> Use Chkk to provide precise, environment-aware context to plan safe software upgrades and create pull requests with updated configuration files and manifests.

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

## 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>

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

## Next steps

* Add your own upgrade plans in Chkk and repeat the flow
* Enable auto-confirm in trusted repos for zero-click edits