Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 | 3x 3x 3x 3x 3x 3x 25x 25x 24x 25x 29x 29x 16x 16x 14x 22x 22x 13x 21x 29x 29x 5x 24x 24x 24x 13x 13x 13x 24x 24x 24x 6x 18x 18x 18x 18x 13x 5x 3x 5x 3x 9x 9x 9x 1x 8x 8x 8x 16x 8x 3x 3x 2x 2x 1x 7x 6x 4x 2x 2x 1x 1x 1x 3x 6x 3x 6x 6x 6x 1x 5x 5x 5x 3x 3x 3x 5x 5x 5x 1x 4x 4x 4x 4x 3x 1x 3x 7x 3x 6x 3x 5x 3x 3x 44x 44x 3x 4x 3x 3x 3x 1x 2x | /**
* MCP client installers
* Implements installation logic for each supported MCP client
*/
import { existsSync, readFileSync, writeFileSync, mkdirSync } from 'fs';
import { dirname } from 'path';
import { spawnSync } from 'child_process';
import { InstallableClient, InstallResult, CLIENT_METADATA } from './types';
import { McpServerConfig } from '../init/types';
import { expandPath, getConfigPath } from './detector';
import { createBackup } from './backup';
/**
* Server entry for JSON config files
*/
interface McpServerEntry {
command: string;
args: string[];
env?: Record<string, string>;
}
/**
* JSON config structure for MCP clients
*/
interface McpJsonConfig {
mcpServers?: Record<string, McpServerEntry>;
servers?: Record<string, McpServerEntry>;
[key: string]: unknown;
}
/**
* Build server entry from config
*/
function buildServerEntry(serverConfig: McpServerConfig): McpServerEntry {
const entry: McpServerEntry = {
command: serverConfig.command,
args: serverConfig.args,
};
if (Object.keys(serverConfig.env).length > 0) {
entry.env = serverConfig.env;
}
return entry;
}
/**
* Read existing JSON config or return empty object
*/
function readJsonConfig(configPath: string): McpJsonConfig {
try {
if (existsSync(configPath)) {
const content = readFileSync(configPath, 'utf8');
return JSON.parse(content) as McpJsonConfig;
}
} catch {
// Return empty config on parse error
}
return {};
}
/**
* Write JSON config with proper formatting
*/
function writeJsonConfig(configPath: string, config: McpJsonConfig): void {
const dir = dirname(configPath);
if (!existsSync(dir)) {
mkdirSync(dir, { recursive: true });
}
writeFileSync(configPath, JSON.stringify(config, null, 2) + '\n', 'utf8');
}
/**
* Shared install logic for clients configured via a JSON file with an
* `mcpServers` map (Claude Desktop, Cursor, Windsurf, Cline, Roo Code). Each
* public installer delegates here with its client id and not-available message;
* the body is otherwise identical, so it lives in one place.
*/
function installJsonConfigClient(
client: InstallableClient,
serverConfig: McpServerConfig,
force: boolean,
unavailableError: string,
): InstallResult {
const configPath = getConfigPath(client);
if (!configPath) {
return {
client,
success: false,
error: unavailableError,
};
}
const expandedPath = expandPath(configPath);
try {
// Create backup if config exists
let backupPath: string | undefined;
if (existsSync(expandedPath)) {
const backupResult = createBackup({ configPath: expandedPath });
Eif (backupResult.created) {
backupPath = backupResult.backupPath;
}
}
// Read existing config
const config = readJsonConfig(expandedPath);
const wasAlreadyConfigured =
config.mcpServers?.gitlab !== undefined || config.mcpServers?.['gitlab-mcp'] !== undefined;
if (wasAlreadyConfigured && !force) {
return {
client,
success: false,
error: 'gitlab-mcp is already configured. Use --force to overwrite.',
wasAlreadyConfigured: true,
configPath: expandedPath,
};
}
// Add/update gitlab server
config.mcpServers ??= {};
config.mcpServers.gitlab = buildServerEntry(serverConfig);
// Remove old name if exists
delete config.mcpServers['gitlab-mcp'];
// Write config
writeJsonConfig(expandedPath, config);
return {
client,
success: true,
backupPath,
configPath: expandedPath,
wasAlreadyConfigured,
};
} catch (error) {
return {
client,
success: false,
error: error instanceof Error ? error.message : String(error),
};
}
}
/**
* Install to Claude Desktop (JSON config)
*/
export function installClaudeDesktop(
serverConfig: McpServerConfig,
force: boolean = false,
): InstallResult {
return installJsonConfigClient(
'claude-desktop',
serverConfig,
force,
'Claude Desktop config path not available for this platform',
);
}
/**
* Install to Claude Code (via claude mcp add command)
*/
export function installClaudeCode(
serverConfig: McpServerConfig,
force: boolean = false,
): InstallResult {
const client: InstallableClient = 'claude-code';
const metadata = CLIENT_METADATA[client];
if (!metadata.cliCommand) {
return {
client,
success: false,
error: 'Claude Code CLI command not configured',
};
}
try {
// Build command arguments
const args = ['mcp', 'add', 'gitlab', serverConfig.command, ...serverConfig.args];
// Add environment variables
for (const [key, value] of Object.entries(serverConfig.env)) {
args.push('--env', `${key}=${value}`);
}
// Add force flag if needed
if (force) {
// Check if gitlab is already configured by running claude mcp list
const listResult = spawnSync(metadata.cliCommand, ['mcp', 'list'], {
stdio: 'pipe',
encoding: 'utf8',
});
if (listResult.status === 0 && listResult.stdout.includes('gitlab')) {
// Remove existing config first
const removeResult = spawnSync(metadata.cliCommand, ['mcp', 'remove', 'gitlab'], {
stdio: 'pipe',
encoding: 'utf8',
});
if (removeResult.status !== 0) {
return {
client,
success: false,
error: `Failed to remove existing gitlab config: ${removeResult.stderr || removeResult.stdout || 'Unknown error'}`,
};
}
}
}
// Run claude mcp add
const result = spawnSync(metadata.cliCommand, args, {
stdio: 'pipe',
encoding: 'utf8',
});
if (result.status === 0) {
return {
client,
success: true,
};
} else {
const errorOutput = result.stderr || result.stdout || 'Unknown error';
// Check if already configured
if (errorOutput.includes('already exists') || errorOutput.includes('already configured')) {
return {
client,
success: false,
error: 'gitlab-mcp is already configured. Use --force to overwrite.',
wasAlreadyConfigured: true,
};
}
return {
client,
success: false,
error: errorOutput,
};
}
} catch (error) {
return {
client,
success: false,
error: error instanceof Error ? error.message : String(error),
};
}
}
/**
* Install to Cursor (JSON config)
*/
export function installCursor(
serverConfig: McpServerConfig,
force: boolean = false,
): InstallResult {
return installJsonConfigClient(
'cursor',
serverConfig,
force,
'Cursor config path not available for this platform',
);
}
/**
* Install to VS Code Copilot (JSON config in .vscode/)
*/
export function installVSCodeCopilot(
serverConfig: McpServerConfig,
force: boolean = false,
): InstallResult {
const client: InstallableClient = 'vscode-copilot';
const configPath = getConfigPath(client);
if (!configPath) {
return {
client,
success: false,
error: 'VS Code config path not available',
};
}
// VS Code config is relative to current directory
const expandedPath = configPath;
try {
// Create backup if config exists
let backupPath: string | undefined;
if (existsSync(expandedPath)) {
const backupResult = createBackup({ configPath: expandedPath });
Eif (backupResult.created) {
backupPath = backupResult.backupPath;
}
}
// Read existing config
const config = readJsonConfig(expandedPath);
const wasAlreadyConfigured =
config.servers?.gitlab !== undefined || config.servers?.['gitlab-mcp'] !== undefined;
if (wasAlreadyConfigured && !force) {
return {
client,
success: false,
error: 'gitlab-mcp is already configured. Use --force to overwrite.',
wasAlreadyConfigured: true,
configPath: expandedPath,
};
}
// VS Code uses "servers" instead of "mcpServers"
config.servers ??= {};
config.servers.gitlab = buildServerEntry(serverConfig);
// Remove old name if exists
delete config.servers['gitlab-mcp'];
// Write config
writeJsonConfig(expandedPath, config);
return {
client,
success: true,
backupPath,
configPath: expandedPath,
wasAlreadyConfigured,
};
} catch (error) {
return {
client,
success: false,
error: error instanceof Error ? error.message : String(error),
};
}
}
/**
* Install to Windsurf (JSON config)
*/
export function installWindsurf(
serverConfig: McpServerConfig,
force: boolean = false,
): InstallResult {
return installJsonConfigClient(
'windsurf',
serverConfig,
force,
'Windsurf config path not available for this platform',
);
}
/**
* Install to Cline (JSON config)
*/
export function installCline(serverConfig: McpServerConfig, force: boolean = false): InstallResult {
return installJsonConfigClient(
'cline',
serverConfig,
force,
'Cline config path not available for this platform',
);
}
/**
* Install to Roo Code (JSON config)
*/
export function installRooCode(
serverConfig: McpServerConfig,
force: boolean = false,
): InstallResult {
return installJsonConfigClient(
'roo-code',
serverConfig,
force,
'Roo Code config path not available for this platform',
);
}
/**
* Client installer registry
*/
const INSTALLERS: Record<
InstallableClient,
(serverConfig: McpServerConfig, force: boolean) => InstallResult
> = {
'claude-desktop': installClaudeDesktop,
'claude-code': installClaudeCode,
cursor: installCursor,
'vscode-copilot': installVSCodeCopilot,
windsurf: installWindsurf,
cline: installCline,
'roo-code': installRooCode,
};
/**
* Install to a specific client
*/
export function installToClient(
client: InstallableClient,
serverConfig: McpServerConfig,
force: boolean = false,
): InstallResult {
const installer = INSTALLERS[client];
return installer(serverConfig, force);
}
/**
* Install to multiple clients
*/
export function installToClients(
clients: InstallableClient[],
serverConfig: McpServerConfig,
force: boolean = false,
): InstallResult[] {
return clients.map((client) => installToClient(client, serverConfig, force));
}
/**
* Generate config JSON for preview (--show mode)
*/
export function generateConfigPreview(
client: InstallableClient,
serverConfig: McpServerConfig,
): string {
const entry = buildServerEntry(serverConfig);
// VS Code uses different key
if (client === 'vscode-copilot') {
return JSON.stringify({ servers: { gitlab: entry } }, null, 2);
}
return JSON.stringify({ mcpServers: { gitlab: entry } }, null, 2);
}
|