Skip to content

Updates MCP documentation for clarity #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+148 −65
Open

Updates MCP documentation for clarity #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 36 additions & 15 deletions MCP/MCP-example-workflows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,55 @@
---
title: Example Workflows
description: A collection of example workflows that demonstrate how to use the GitKraken MCP (Model Context Protocol) Server to automate common tasks.
description: A collection of example workflows that demonstrate how to use the GitKraken MCP (Model Context Protocol) Server to automate common development tasks.
taxonomy:
category: MCP
---

Here are a couple of example workflows that demonstrate how to use the GitKraken MCP (Model Context Protocol) Server to automate common tasks. This is not an exhaustive list, but rather a starting point for you to craft your own workflows.
<kbd>Last updated: October 2025</kbd>

## Query Jira and/or GitHub for Issues Assigned to You
Explore these example workflows to learn how the GitKraken MCP (Model Context Protocol) Server can automate everyday development tasks. Use them as inspiration to craft your own time-saving workflows.

Going out to Jira/GitHub/etc just to find issues assigned to you can be a tedious task. To make it easier, simply type into a prompt, `What issues are assigned to me?`.
### Query Jira and GitHub for Assigned Issues

This will use the `issues_assigned_to_me` tool to query Jira and/or GitHub for issues assigned to you and list them out in the response.
Manually checking Jira or GitHub for your assigned issues can be tedious. Instead, ask your agent:

## Start Work on a Specific Jira Issue
```
What issues are assigned to me?
```

You can start work on a new task with the prompt `Start work on Jira issue <issue-id>`. Make sure to replace `<issue-id>` the actual issue ID that you are assigned.
This prompt uses the `issues_assigned_to_me` tool to query Jira and/or GitHub and list all issues assigned to your account.

This will call the `issues_get_detail` tool and pull the issue details, check your workspace, and create a new branch for that specific issue.
### Start Work on a Jira Issue

Depending on the Agent and model, your IDE may then start modifying your files and then it will call tools like `git_status` and `git_add_or_commit`.
To start work on a specific task, use the following prompt:

## Debug and Understand History
```
Start work on Jira issue <issue-id>
```

GitLens is a fantastic tool to see details about who changed what, when, and why. But, it relies on devs providing good commit messages and context.
Replace `<issue-id>` with the actual issue ID.
The MCP Server will call the `issues_get_detail` tool, fetch issue details, check your workspace, and create a new branch for that issue.

Instead, you can use the MCP server to do the research for you. find a function and ask `Who last changed the <function-name> function and why?`.
Depending on your agent and model, your IDE may then modify related files or call tools such as `git_status` and `git_add_or_commit`.

This will call the `git_blame` tool as well as some native git commands to get the details for you.
### Debug and Understand History

## Next Steps
While [GitLens](https://www.gitkraken.com/gitlens) helps visualize commit history, it depends on meaningful commit messages. You can use the MCP Server to investigate change history automatically.

Ask:

```
Who last changed the <function-name> function and why?
```

The MCP Server will call the `git_blame` tool and relevant Git commands to gather and summarize context for you.

### Next Steps

Now that you understand how to use the GitKraken MCP Server, explore more workflows:

- Check out the [Tools Reference](/mcp/MCP-tools-reference) for a list of available tools and usage examples.
- Visit the [Prompt Reference](/mcp/MCP-prompts-reference) for predefined prompts you can reuse or adapt.

By combining these tools and prompts, you can build your own automated GitKraken MCP workflows to simplify repetitive development tasks.

Now that you have a better understanding of how to use the MCP server, you can start crafting your own workflows. We recommend checking out the [Tools Reference](/mcp/MCP-tools-reference.) to see what tools are available and how to use them. You can also check the [Prompt Reference](/mcp/MCP-prompts-reference) for a list of all the prompts available. Prompts are self-contained workflows that will save you the effort of typing it all out yourself.
162 changes: 112 additions & 50 deletions MCP/MCP-getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,82 +1,137 @@
---
title: Getting Started
description: Detailed instructions on how to install the GitKraken MCP Server in various IDEs and editors.
title: Getting Started with the GitKraken MCP Server
description: Learn how to install the GitKraken MCP Server in GitLens, VS Code, and other supported editors.
taxonomy:
category: MCP
---

Getting started is easy in a variety of ways.
<kbd>Last updated: October 2025</kbd>

- [GitLens](#gitlens)
You can install the GitKraken MCP Server through GitLens or the GitKraken CLI. This guide walks you through installation in supported IDEs.

- [Install via GitLens](#install-via-gitlens)
- [GitKraken CLI](#gitkraken-cli)

### GitLens
### Install via GitLens

The GitKraken MCP server is bundled with [GitLens](https://www.gitkraken.com/gitlens) on VSCode versions `1.101.0` and greater. No action is needed to get started.
The GitKraken MCP Server is bundled with [GitLens](https://www.gitkraken.com/gitlens) for VS Code version `1.101.0` and later. **No manual setup is required.**

For VSCode versions older than `1.101.0` you can install the MCP Server easily from the command palette in VS Code, Cursor, and other IDEs based on VS Code.
If you’re using an older version of VS Code (prior to `1.101.0`), install the MCP Server from the command palette in VS Code, Cursor, Windsurf, or other VS Code–based IDEs.

<img src="/wp-content/uploads/install-gitlens.png" class="help-center-img img-bordered">
<figure>
<img src="/wp-content/uploads/install-gitlens.png" class="help-center-img img-bordered" alt="Install the MCP Server from the command palette in GitLens." />
<figcaption style="text-align: center; color: #888">Open the command palette to install the GitKraken MCP Server.</figcaption>
</figure>

You can also install the MCP server using one of these convenient deeplinks:
You can also install the MCP Server directly using the following deeplinks:

- [VS Code](https://gitkraken.dev/deeplink?product=gitlens&path=/link/command/install-mcp&ide=vscode)
- [VS Code Insiders](https://gitkraken.dev/deeplink?product=gitlens&path=/link/command/install-mcp&ide=vscode-insiders)
- [Cursor](https://gitkraken.dev/deeplink?product=gitlens&path=/link/command/install-mcp&ide=cursor)
- [Windsurf](https://gitkraken.dev/deeplink?product=gitlens&path=/link/command/install-mcp&ide=windsurf)
- [Trae](https://gitkraken.dev/deeplink?product=gitlens&path=/link/command/install-mcp&ide=trae)

The command and links will handle all of the configuration for you. You can then inspect the list of available MCP servers by making sure you are in Agent mode and clicking the gear icon in the bottom right corner of the copilot side panel.
Each link handles all required configuration automatically.

#### Verify installation

1. Ensure you are in **Agent Mode**.
2. Click the **gear icon** in the lower-right corner of the Copilot side panel.

<figure>
<img src="/wp-content/uploads/copilot-prompt.png" class="help-center-img img-bordered" alt="Copilot gear icon in VS Code for MCP configuration." />
<figcaption style="text-align: center; color: #888">Access MCP settings from the Copilot panel gear icon.</figcaption>
</figure>

3. Scroll through the list of available MCP servers.
4. Locate **MCP Server: GitKraken (bundled with GitLens)**.

<figure>
<img src="/wp-content/uploads/gitlens-bundled-tool.png" class="help-center-img img-bordered" alt="MCP Server: GitKraken listed in bundled GitLens tools." />
<figcaption style="text-align: center; color: #888">The GitKraken MCP Server appears in the bundled tools list.</figcaption>
</figure>

<img src="/wp-content/uploads/copilot-prompt.png" class="help-center-img img-bordered">

Then, scroll through the list and you will see "MCP Server: GitKraken (bundled with GitLens)".
### GitKraken CLI

<img src="/wp-content/uploads/gitlens-bundled-tool.png" class="help-center-img img-bordered">
You can also install the GitKraken MCP Server using the [GitKraken CLI](https://www.gitkraken.com/cli). Follow these steps to set up the MCP Server across different IDEs.

### GitKraken CLI
After installation, run the following command in your terminal to authenticate with your GitKraken account:

Download the latest release from [https://www.gitkraken.com/cli](https://www.gitkraken.com/cli)
```bash
gk auth login
```

After installation, run `gk auth login` in your terminal to authenticate with your GitKraken account.
Once authenticated, add the MCP server to your preferred agent.

After authentication, you will need to add the MCP server to your preferred agent.
---

#### VS Code

To install the MCP server into VS Code, you can run "MCP: Add server..." from the command palette.
To install the MCP server in **VS Code**, use the command palette:

1. Open the command palette and select **MCP: Add server...**

<img src="/wp-content/uploads/vscode-add-server.png" class="help-center-img img-bordered">
<figure>
<img src="/wp-content/uploads/vscode-add-server.png" class="help-center-img img-bordered" alt="Command palette showing MCP: Add server option in VS Code." />
<figcaption style="text-align: center; color: #888">Use the VS Code command palette to add a new MCP server.</figcaption>
</figure>

In the following prompts, select "stdio" as the type of server.
2. When prompted, select **stdio** as the server type.

<img src="/wp-content/uploads/vscode-stdio.png" class="help-center-img img-bordered">
<figure>
<img src="/wp-content/uploads/vscode-stdio.png" class="help-center-img img-bordered" alt="VS Code dialog for selecting MCP server type as stdio." />
<figcaption style="text-align: center; color: #888">Select <strong>stdio</strong> as the server type.</figcaption>
</figure>

In the next prompt, enter the command `gk mcp`.
3. In the next prompt, enter the following command:

<img src="/wp-content/uploads/vscode-stdio-command.png" class="help-center-img img-bordered">
```bash
gk mcp
```

<figure>
<img src="/wp-content/uploads/vscode-stdio-command.png" class="help-center-img img-bordered" alt="VS Code prompt showing gk mcp command entry." />
<figcaption style="text-align: center; color: #888">Enter <code>gk mcp</code> as the server command.</figcaption>
</figure>

Finally, give the server a name and press enter.
4. Provide a name for the server and press **Enter**.

<img src="/wp-content/uploads/vscode-stdio-name.png" class="help-center-img img-bordered">
<figure>
<img src="/wp-content/uploads/vscode-stdio-name.png" class="help-center-img img-bordered" alt="VS Code dialog for naming the MCP server." />
<figcaption style="text-align: center; color: #888">Assign a name to the GitKraken MCP Server.</figcaption>
</figure>

You can then inspect the list of available MCP servers and tools by making sure you are in Agent mode and clicking the gear icon in the bottom right corner of the copilot side panel.
5. To verify, make sure you are in **Agent Mode**, then click the **gear icon** in the lower-right corner of the Copilot side panel.

<img src="/wp-content/uploads/copilot-prompt.png" class="help-center-img img-bordered">
<figure>
<img src="/wp-content/uploads/copilot-prompt.png" class="help-center-img img-bordered" alt="Copilot side panel gear icon for MCP settings in VS Code." />
<figcaption style="text-align: center; color: #888">Access the list of installed MCP servers from the Copilot panel.</figcaption>
</figure>

**Please Note:** [MCP Tools must be enabled](https://code.visualstudio.com/docs/copilot/customization/mcp-servers#_enable-mcp-support-in-vs-code) in VSCode settings to function.
> **Note:** [MCP Tools must be enabled](https://code.visualstudio.com/docs/copilot/customization/mcp-servers#_enable-mcp-support-in-vs-code) in VS Code settings for the server to function.

---

#### Cursor

Installing an MCP server into Cursor is easy. Using the command palette, select "View: Open MCP Settings".
To install the MCP server in **Cursor**:

1. Open the command palette and select **View: Open MCP Settings**.

<img src="/wp-content/uploads/cursor-mcp-settings.png" class="help-center-img img-bordered">
<figure>
<img src="/wp-content/uploads/cursor-mcp-settings.png" class="help-center-img img-bordered" alt="Cursor IDE command palette showing View: Open MCP Settings." />
<figcaption style="text-align: center; color: #888">Access MCP settings from the command palette in Cursor.</figcaption>
</figure>

If you have no servers installed yet, you will see this screen. Simply click the "Add Custom MCP" button to get started.
2. If no servers are installed, click **Add Custom MCP** to begin setup.

<img src="/wp-content/uploads/cursor-mcp-add.png" class="help-center-img img-bordered">
<figure>
<img src="/wp-content/uploads/cursor-mcp-add.png" class="help-center-img img-bordered" alt="Cursor MCP settings screen showing Add Custom MCP button." />
<figcaption style="text-align: center; color: #888">Add a new custom MCP server in Cursor.</figcaption>
</figure>

Then, you will need to add the GitKraken MCP server to the JSON file. You can do this by copying the following JSON and pasting it.
3. Add the GitKraken MCP server configuration to the JSON file:

```json
{
Expand All @@ -89,19 +144,23 @@ Then, you will need to add the GitKraken MCP server to the JSON file. You can do
}
```

**Please Note:** [Windows users should have the latest Microsoft Visual C++ Redistributable installed.](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170)
> **Note:** [Windows users must have the latest Microsoft Visual C++ Redistributable installed.](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170)

#### Claude Desktop
---

Claude's MCP server process is a bit different than the IDEs, but is still fairly simple.
#### Claude Desktop

First, open the settings from the App toolbar and then click into the "Developer" tab.
To configure the MCP server in **Claude Desktop**:

<img src="/wp-content/uploads/claude-settings.png" class="help-center-img img-bordered">
1. From the app toolbar, open **Settings**, then navigate to the **Developer** tab.

Once you are in the developer tab, click the "Edit Config" button. This will open a directory containing `claude_desktop_config.json`.
<figure>
<img src="/wp-content/uploads/claude-settings.png" class="help-center-img img-bordered" alt="Claude Desktop settings window showing Developer tab." />
<figcaption style="text-align: center; color: #888">Open the Developer tab in Claude Desktop settings.</figcaption>
</figure>

Edit that file using your favorite text editor and paste in the following JSON.
2. Click **Edit Config** to open the `claude_desktop_config.json` directory.
3. Edit the file and paste in the following JSON:

```json
{
Expand All @@ -114,19 +173,20 @@ Edit that file using your favorite text editor and paste in the following JSON.
}
```

Save the file and restart Claude.
4. Save the file and restart Claude Desktop.

#### JetBrains IntelliJ

[JetBrains AI Assistant is required.](https://www.jetbrains.com/ai-assistant/)
---

Navigate to Go to Settings > Tools > AI Assistant > Model Context Protocol (MCP)
#### JetBrains IntelliJ

Click Add to add a new MCP server configuration.
To add the GitKraken MCP Server to **JetBrains IntelliJ**:

In the New MCP Server dialog, using the dropdown, select **As JSON**.
> [JetBrains AI Assistant is required.](https://www.jetbrains.com/ai-assistant/)

Paste the following JSON
1. Navigate to **Settings > Tools > AI Assistant > Model Context Protocol (MCP)**.
2. Click **Add** to create a new MCP server configuration.
3. In the dialog, select **As JSON** from the dropdown.
4. Paste the following configuration:

```json
{
Expand All @@ -139,6 +199,8 @@ Paste the following JSON
}
```

## Next Steps
---

### Next Steps

Once you are done setting up the MCP server, head over to our [Example Workflows](/mcp/MCP-example-workflows) for inspiration on how to use the MCP server to make your day-to-day tasks easier and less tedious.
After completing installation, visit our [Example Workflows](/mcp/MCP-example-workflows) to explore how the GitKraken MCP Server can simplify your daily development tasks.