Adds support for mcp server installation #4428

axosoft-ramint · 2025-06-25T22:46:05Z

axosoft-ramint · 2025-06-25T22:47:10Z

Draft until issues with the installer itself are addressed by the team that maintains it.

eamodio

I feel like we are conflating the CLI install with MCP "setup" and they are different/distinct tasks that should be handled as such.

The auto-install is only of the CLI, not MCP, and we should attempt to "auto-install" the CLI until successful (or some number of successive failures)

src/env/node/gk/cli/integration.ts

src/constants.storage.ts

contributions.json

d13 · 2025-08-26T19:26:07Z

src/env/node/gk/cli/integration.ts

+			switch (env.appName) {
+				case 'Visual Studio Code':
+					break;
+				case 'Visual Studio Code - Insiders':
+					appName = 'vscode-insiders';
+					break;
+				case 'Cursor':
+					appName = 'cursor';
+					break;
+				case 'Windsurf':
+					appName = 'windsurf';
+					break;


We reference in "VS Code - Exploration" (MS-provided adhoc build) and "VSCodium" (currently at 1.103.2) as well in other areas. Should we add these as well?

case 'Visual Studio Code - Exploration': app = 'code-exploration'; break; case 'VSCodium': app = 'codium'; break;

Those aren't supported by the "mcp install" command for the time being and should hit the default case and fail for now.

If we want them supported we should ask the CLI team to add them.

I checked in a new getHostAppName helper on main that we should use here. And IMO we should send whatever it is to the CLI and let them say its not supported, so that way the CLI can update and we dont need to for additional support.

@eamodio I am now using that helper. I still need to transform the app name from that helper because, for example, we use code and the command is expecting vscode, etc.

I also always continue to the command if the app name exists, and if they show an error in the output I send failure telemetry and kick out early. Check the latest commit.

axosoft-ramint · 2025-08-26T19:36:42Z

I feel like we are conflating the CLI install with MCP "setup" and they are different/distinct tasks that should be handled as such.

The auto-install is only of the CLI, not MCP, and we should attempt to "auto-install" the CLI until successful (or some number of successive failures)

@eamodio This process is not installing a full-fledged GK CLI. It is installing something called "gk core", which is a lightweight version of the CLI designed to basically just support the MCP and a few other things. Should I still go ahead with calling all of this logic "install CLI"?

eamodio · 2025-08-26T22:12:24Z

docs/telemetry-events.md

+```typescript
+{
+  'attempts': number,
+  'autoInstall': boolean


Do we get a version number or anything after the install? Because that would be great to have.

eamodio · 2025-08-26T22:13:49Z

docs/telemetry-events.md

+### mcp/setup/completed
+
+> Sent when GitKraken MCP setup is completed
+
+```typescript
+{
+  'requiresUserCompletion': boolean
+}
+```
+
+### mcp/setup/failed
+
+> Sent when GitKraken MCP setup fails
+
+```typescript
+{
+  'error.message': string,
+  'reason': string
+}
+```
+
+### mcp/setup/started
+
+> Sent when GitKraken MCP setup is started
+
+```typescript
+void
+```
+


We should make sure we have "source" plumbed in here

Also the cli version would be great too

eamodio · 2025-08-26T22:16:01Z

contributions.json

+		"gitlens.ai.mcp.install": {
+			"label": "Install GitKraken MCP Server",
+			"commandPalette": "gitlens:enabled && !gitlens:untrusted && gitlens:gk:organization:ai:enabled"
+		},


Eventually we will want versions of this command to other usages (e.g. home, etc) so we can understand the usage and make sure source is correct

…asks

eamodio · 2025-08-26T22:40:57Z

src/env/node/gk/cli/integration.ts

+					await window.withProgress(
+						{
+							location: ProgressLocation.Notification,
+							title: 'Setting up MCP integration...',


Suggested change

title: 'Setting up MCP integration...',

title: 'Setting up the GitKraken MCP...',

eamodio · 2025-08-26T22:42:25Z

src/env/node/gk/cli/integration.ts

+							case CLIInstallErrorReason.WebEnvironmentUnsupported:
+								void window.showErrorMessage(
+									'MCP installation is not supported in the web environment.',
+								);
+								failureReason = 'web environment unsupported';


This is fine as a fallback, but we shouldn't allow the command on the Web and kick out at the start.

eamodio · 2025-08-26T22:43:35Z

contributions.json

@@ -311,6 +311,10 @@
 			"icon": "$(sparkle)",
 			"commandPalette": "gitlens:enabled && !gitlens:untrusted && gitlens:gk:organization:ai:enabled"
 		},
+		"gitlens.ai.mcp.install": {
+			"label": "Install GitKraken MCP Server",
+			"commandPalette": "gitlens:enabled && !gitlens:untrusted && gitlens:gk:organization:ai:enabled"


Should add isWeb (I think that is the context key) here to not show this on the web

It's not isWeb, or at least that's not working as intended because using && !isWeb in the "when" clause prevents the command from appearing even when I'm not on web.

eamodio · 2025-08-26T22:46:41Z

src/env/node/gk/cli/integration.ts

+			let cliInstall = this.container.storage.get('gk:cli:install');
+			let cliPath = this.container.storage.get('gk:cli:path');
+			let cliProxyFileExists = true;
+			if (cliPath != null) {
+				try {
+					await workspace.fs.stat(
+						Uri.joinPath(Uri.file(cliPath), getPlatform() === 'windows' ? 'gk.exe' : 'gk'),
+					);
+				} catch {
+					cliProxyFileExists = false;
+				}
+			}
+			if (cliInstall?.status !== 'completed' || cliPath == null || !cliProxyFileExists) {


I'd suggest delegating all of this to this.installCLI() as this will need to check these same things. And have that method return the path/install data this method needs.

eamodio · 2025-08-26T22:47:11Z

src/env/node/gk/cli/integration.ts

+			cliInstall = this.container.storage.get('gk:cli:install');
+			cliPath = this.container.storage.get('gk:cli:path');


SHould be returned by this.installCLI

eamodio · 2025-08-26T23:01:31Z

src/env/node/gk/cli/integration.ts

+						},
+					);
+				} catch (ex) {
+					let failureReason = 'unknown error';


Suggested change

let failureReason = 'unknown error';

'GitKraken MCP installation is not supported on the web.',

eamodio · 2025-08-26T23:06:13Z

src/env/node/gk/cli/integration.ts

+						CLIInstallErrorReason.ProxyFetch,
+						undefined,
+						`${response.status} ${response.statusText}`,
+					);


We don't want to throw if this already exists right?

eamodio · 2025-08-26T23:07:02Z

src/env/node/gk/cli/integration.ts

+					throw new CLIInstallError(
+						CLIInstallErrorReason.ProxyDownload,
+						undefined,
+						'Downloaded proxy archive data is empty',


What if the file already exists? We should overwrite it or nuke it first.

eamodio · 2025-08-26T23:08:42Z

src/env/node/gk/cli/integration.ts

+						CLIInstallErrorReason.CoreDirectory,
+						ex instanceof Error ? ex : undefined,
+						ex instanceof Error ? ex.message : undefined,
+					);
+				}
+
+				// Write the installer to the extension storage
+				try {
+					await workspace.fs.writeFile(cliProxyZipFilePath, new Uint8Array(cliProxyZipFileDownloadData));
+				} catch (ex) {
+					throw new CLIInstallError(
+						CLIInstallErrorReason.ProxyDownload,
+						ex instanceof Error ? ex : undefined,
+						'Failed to write proxy archive to global storage',
+					);


Feels fragile -- maybe we should use an unzip lib?

But we can deal with that later

Will need to test this on linux

eamodio · 2025-08-26T23:37:51Z

src/env/node/gk/cli/integration.ts

+			}
+		}
+
+		return cliVersion;


Why do we care about the status if the path exists?

I can't understand this comment based on the line it's attached to

axosoft-ramint · 2025-08-27T05:17:26Z

@eamodio I tried addressing as many of your comments as I could, but most of them don't make sense because the code they are attached to got shifted. Would you mind resubmitting any that I did not address, with the latest on the branch?

axosoft-ramint assigned eamodio Jun 25, 2025

axosoft-ramint requested a review from eamodio June 25, 2025 22:46

axosoft-ramint force-pushed the feature-mcp branch 2 times, most recently from 383578b to b4f75a9 Compare June 30, 2025 20:14

axosoft-ramint marked this pull request as ready for review June 30, 2025 20:15

axosoft-ramint force-pushed the feature-mcp branch 3 times, most recently from a72d602 to ae46eb1 Compare July 11, 2025 00:10

axosoft-ramint force-pushed the feature-mcp branch 2 times, most recently from a134d87 to 97a6526 Compare July 18, 2025 17:52

axosoft-ramint force-pushed the feature-mcp branch from 97a6526 to 28e01ee Compare July 24, 2025 23:08

axosoft-ramint force-pushed the feature-mcp branch 2 times, most recently from 1c0ba9b to 1b59716 Compare August 26, 2025 17:43

d13 self-requested a review August 26, 2025 18:26

eamodio requested changes Aug 26, 2025

View reviewed changes

src/env/node/gk/cli/integration.ts Outdated Show resolved Hide resolved

src/constants.storage.ts Outdated Show resolved Hide resolved

contributions.json Outdated Show resolved Hide resolved

d13 reviewed Aug 26, 2025

View reviewed changes

axosoft-ramint requested a review from eamodio August 26, 2025 22:10

eamodio reviewed Aug 26, 2025

View reviewed changes

axosoft-ramint requested a review from eamodio August 26, 2025 22:53

axosoft-ramint added 7 commits August 26, 2025 16:08

Adds support for mcp server installation

9caa661

Updates storage key and splits automatic and manual installation subt…

33cded7

…asks

Adds gates and deeplink command support

179740d

Updates to include new params

f08a1e5

Updates terminology and adds telemetry

a9e9312

Includes source and CLI version in telemetry

9c003e6

Uses built-in app name function and always passes to mcp install command

746e78b

axosoft-ramint force-pushed the feature-mcp branch from c1a0b30 to 746e78b Compare August 26, 2025 23:21

eamodio requested changes Aug 26, 2025

View reviewed changes

Improvements from feedback

fa33618

axosoft-ramint requested a review from eamodio August 27, 2025 05:17

	title: 'Setting up MCP integration...',
	title: 'Setting up the GitKraken MCP...',

		cliInstall = this.container.storage.get('gk:cli:install');
		cliPath = this.container.storage.get('gk:cli:path');

	let failureReason = 'unknown error';
	'GitKraken MCP installation is not supported on the web.',

Adds support for mcp server installation #4428

Are you sure you want to change the base?

Adds support for mcp server installation #4428

Conversation

axosoft-ramint commented Jun 25, 2025

Uh oh!

axosoft-ramint commented Jun 25, 2025

Uh oh!

eamodio left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

axosoft-ramint Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

axosoft-ramint commented Aug 26, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

axosoft-ramint commented Aug 27, 2025

Uh oh!

Uh oh!

axosoft-ramint Aug 26, 2025 •

edited

Loading