@vibescope/mcp-server 0.5.0 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (161) hide show
  1. package/CHANGELOG.md +84 -84
  2. package/README.md +194 -194
  3. package/dist/api-client/tasks.d.ts +1 -0
  4. package/dist/cli-init.js +21 -21
  5. package/dist/cli.js +26 -26
  6. package/dist/handlers/tasks.js +7 -1
  7. package/dist/handlers/tool-docs.js +1216 -1216
  8. package/dist/index.js +73 -73
  9. package/dist/templates/agent-guidelines.d.ts +1 -1
  10. package/dist/templates/agent-guidelines.js +205 -205
  11. package/dist/templates/help-content.js +1621 -1621
  12. package/dist/tools/bodies-of-work.js +6 -6
  13. package/dist/tools/cloud-agents.js +22 -22
  14. package/dist/tools/milestones.js +2 -2
  15. package/dist/tools/requests.js +1 -1
  16. package/dist/tools/session.js +11 -11
  17. package/dist/tools/sprints.js +9 -9
  18. package/dist/tools/tasks.js +43 -35
  19. package/dist/tools/worktrees.js +14 -14
  20. package/dist/utils.js +11 -11
  21. package/docs/TOOLS.md +2687 -2685
  22. package/package.json +53 -53
  23. package/scripts/generate-docs.ts +212 -212
  24. package/scripts/version-bump.ts +203 -203
  25. package/src/api-client/blockers.ts +86 -86
  26. package/src/api-client/bodies-of-work.ts +194 -194
  27. package/src/api-client/chat.ts +50 -50
  28. package/src/api-client/connectors.ts +152 -152
  29. package/src/api-client/cost.ts +185 -185
  30. package/src/api-client/decisions.ts +87 -87
  31. package/src/api-client/deployment.ts +313 -313
  32. package/src/api-client/discovery.ts +81 -81
  33. package/src/api-client/fallback.ts +52 -52
  34. package/src/api-client/file-checkouts.ts +115 -115
  35. package/src/api-client/findings.ts +100 -100
  36. package/src/api-client/git-issues.ts +88 -88
  37. package/src/api-client/ideas.ts +112 -112
  38. package/src/api-client/index.ts +592 -592
  39. package/src/api-client/milestones.ts +83 -83
  40. package/src/api-client/organizations.ts +185 -185
  41. package/src/api-client/progress.ts +94 -94
  42. package/src/api-client/project.ts +181 -181
  43. package/src/api-client/requests.ts +54 -54
  44. package/src/api-client/session.ts +220 -220
  45. package/src/api-client/sprints.ts +227 -227
  46. package/src/api-client/subtasks.ts +57 -57
  47. package/src/api-client/tasks.ts +451 -450
  48. package/src/api-client/types.ts +32 -32
  49. package/src/api-client/validation.ts +60 -60
  50. package/src/api-client/worktrees.ts +53 -53
  51. package/src/api-client.test.ts +847 -847
  52. package/src/api-client.ts +2728 -2728
  53. package/src/cli-init.ts +558 -558
  54. package/src/cli.test.ts +284 -284
  55. package/src/cli.ts +204 -204
  56. package/src/handlers/__test-setup__.ts +240 -240
  57. package/src/handlers/__test-utils__.ts +89 -89
  58. package/src/handlers/blockers.test.ts +468 -468
  59. package/src/handlers/blockers.ts +172 -172
  60. package/src/handlers/bodies-of-work.test.ts +704 -704
  61. package/src/handlers/bodies-of-work.ts +526 -526
  62. package/src/handlers/chat.test.ts +185 -185
  63. package/src/handlers/chat.ts +101 -101
  64. package/src/handlers/cloud-agents.test.ts +438 -438
  65. package/src/handlers/cloud-agents.ts +156 -156
  66. package/src/handlers/connectors.test.ts +834 -834
  67. package/src/handlers/connectors.ts +229 -229
  68. package/src/handlers/cost.test.ts +462 -462
  69. package/src/handlers/cost.ts +285 -285
  70. package/src/handlers/decisions.test.ts +382 -382
  71. package/src/handlers/decisions.ts +153 -153
  72. package/src/handlers/deployment.test.ts +551 -551
  73. package/src/handlers/deployment.ts +570 -570
  74. package/src/handlers/discovery.test.ts +206 -206
  75. package/src/handlers/discovery.ts +433 -433
  76. package/src/handlers/fallback.test.ts +537 -537
  77. package/src/handlers/fallback.ts +194 -194
  78. package/src/handlers/file-checkouts.test.ts +750 -750
  79. package/src/handlers/file-checkouts.ts +185 -185
  80. package/src/handlers/findings.test.ts +633 -633
  81. package/src/handlers/findings.ts +239 -239
  82. package/src/handlers/git-issues.test.ts +631 -631
  83. package/src/handlers/git-issues.ts +136 -136
  84. package/src/handlers/ideas.test.ts +644 -644
  85. package/src/handlers/ideas.ts +207 -207
  86. package/src/handlers/index.ts +93 -93
  87. package/src/handlers/milestones.test.ts +475 -475
  88. package/src/handlers/milestones.ts +180 -180
  89. package/src/handlers/organizations.test.ts +826 -826
  90. package/src/handlers/organizations.ts +315 -315
  91. package/src/handlers/progress.test.ts +269 -269
  92. package/src/handlers/progress.ts +77 -77
  93. package/src/handlers/project.test.ts +546 -546
  94. package/src/handlers/project.ts +245 -245
  95. package/src/handlers/requests.test.ts +303 -303
  96. package/src/handlers/requests.ts +99 -99
  97. package/src/handlers/roles.test.ts +305 -305
  98. package/src/handlers/roles.ts +219 -219
  99. package/src/handlers/session.test.ts +998 -998
  100. package/src/handlers/session.ts +1105 -1105
  101. package/src/handlers/sprints.test.ts +732 -732
  102. package/src/handlers/sprints.ts +537 -537
  103. package/src/handlers/tasks.test.ts +931 -931
  104. package/src/handlers/tasks.ts +1144 -1137
  105. package/src/handlers/tool-categories.test.ts +66 -66
  106. package/src/handlers/tool-docs.test.ts +511 -511
  107. package/src/handlers/tool-docs.ts +1595 -1595
  108. package/src/handlers/types.test.ts +259 -259
  109. package/src/handlers/types.ts +176 -176
  110. package/src/handlers/validation.test.ts +582 -582
  111. package/src/handlers/validation.ts +164 -164
  112. package/src/handlers/version.ts +63 -63
  113. package/src/index.test.ts +674 -674
  114. package/src/index.ts +884 -884
  115. package/src/setup.test.ts +243 -243
  116. package/src/setup.ts +410 -410
  117. package/src/templates/agent-guidelines.ts +233 -233
  118. package/src/templates/help-content.ts +1751 -1751
  119. package/src/token-tracking.test.ts +463 -463
  120. package/src/token-tracking.ts +167 -167
  121. package/src/tools/blockers.ts +122 -122
  122. package/src/tools/bodies-of-work.ts +283 -283
  123. package/src/tools/chat.ts +72 -72
  124. package/src/tools/cloud-agents.ts +101 -101
  125. package/src/tools/connectors.ts +191 -191
  126. package/src/tools/cost.ts +111 -111
  127. package/src/tools/decisions.ts +111 -111
  128. package/src/tools/deployment.ts +455 -455
  129. package/src/tools/discovery.ts +76 -76
  130. package/src/tools/fallback.ts +111 -111
  131. package/src/tools/features.ts +154 -154
  132. package/src/tools/file-checkouts.ts +145 -145
  133. package/src/tools/findings.ts +101 -101
  134. package/src/tools/git-issues.ts +130 -130
  135. package/src/tools/ideas.ts +162 -162
  136. package/src/tools/index.ts +145 -145
  137. package/src/tools/milestones.ts +118 -118
  138. package/src/tools/organizations.ts +224 -224
  139. package/src/tools/persona-templates.ts +25 -25
  140. package/src/tools/progress.ts +73 -73
  141. package/src/tools/project.ts +210 -210
  142. package/src/tools/requests.ts +68 -68
  143. package/src/tools/roles.ts +112 -112
  144. package/src/tools/session.ts +181 -181
  145. package/src/tools/sprints.ts +298 -298
  146. package/src/tools/tasks.ts +583 -575
  147. package/src/tools/tools.test.ts +222 -222
  148. package/src/tools/types.ts +9 -9
  149. package/src/tools/validation.ts +75 -75
  150. package/src/tools/version.ts +34 -34
  151. package/src/tools/worktrees.ts +66 -66
  152. package/src/tools.test.ts +416 -416
  153. package/src/utils.test.ts +1014 -1014
  154. package/src/utils.ts +586 -586
  155. package/src/validators.test.ts +223 -223
  156. package/src/validators.ts +249 -249
  157. package/src/version.ts +162 -162
  158. package/tsconfig.json +16 -16
  159. package/vitest.config.ts +14 -14
  160. package/dist/tools.d.ts +0 -2
  161. package/dist/tools.js +0 -3602
package/src/setup.ts CHANGED
@@ -1,410 +1,410 @@
1
- /**
2
- * Vibescope Setup Wizard
3
- * Guides users through setting up Vibescope MCP integration
4
- *
5
- * Usage: vibescope-cli setup
6
- */
7
-
8
- import { existsSync, readFileSync, writeFileSync, mkdirSync } from 'node:fs';
9
- import { createInterface } from 'node:readline';
10
- import { homedir, platform } from 'node:os';
11
- import { join, dirname } from 'node:path';
12
- import { exec } from 'node:child_process';
13
-
14
- const VIBESCOPE_SETTINGS_URL = 'https://vibescope.dev/dashboard/settings';
15
- const VIBESCOPE_API_URL = 'https://vibescope.dev';
16
-
17
- // ============================================================================
18
- // Types
19
- // ============================================================================
20
-
21
- export interface IdeConfig {
22
- name: string;
23
- displayName: string;
24
- configPath: string;
25
- detected: boolean;
26
- configFormat: 'mcp-json' | 'settings-json';
27
- }
28
-
29
- // ============================================================================
30
- // Config Path Helpers
31
- // ============================================================================
32
-
33
- function getClaudeDesktopConfigPath(): string {
34
- const plat = platform();
35
- const home = homedir();
36
-
37
- if (plat === 'darwin') {
38
- return join(home, 'Library', 'Application Support', 'Claude', 'claude_desktop_config.json');
39
- } else if (plat === 'win32') {
40
- return join(home, 'AppData', 'Roaming', 'Claude', 'claude_desktop_config.json');
41
- } else {
42
- return join(home, '.config', 'Claude', 'claude_desktop_config.json');
43
- }
44
- }
45
-
46
- function getCursorConfigPath(): string {
47
- const plat = platform();
48
- const home = homedir();
49
-
50
- if (plat === 'darwin') {
51
- return join(home, 'Library', 'Application Support', 'Cursor', 'User', 'globalStorage', 'saoudrizwan.claude-dev', 'settings', 'cline_mcp_settings.json');
52
- } else if (plat === 'win32') {
53
- return join(home, 'AppData', 'Roaming', 'Cursor', 'User', 'globalStorage', 'saoudrizwan.claude-dev', 'settings', 'cline_mcp_settings.json');
54
- } else {
55
- return join(home, '.config', 'Cursor', 'User', 'globalStorage', 'saoudrizwan.claude-dev', 'settings', 'cline_mcp_settings.json');
56
- }
57
- }
58
-
59
- function getGeminiConfigPath(): string {
60
- return join(homedir(), '.gemini', 'settings.json');
61
- }
62
-
63
- // ============================================================================
64
- // IDE Detection
65
- // ============================================================================
66
-
67
- export function detectIdes(): IdeConfig[] {
68
- const ides: IdeConfig[] = [
69
- {
70
- name: 'claude-code',
71
- displayName: 'Claude Code (CLI)',
72
- configPath: '.mcp.json',
73
- detected: true,
74
- configFormat: 'mcp-json',
75
- },
76
- {
77
- name: 'claude-desktop',
78
- displayName: 'Claude Desktop',
79
- configPath: getClaudeDesktopConfigPath(),
80
- detected: existsSync(dirname(getClaudeDesktopConfigPath())),
81
- configFormat: 'mcp-json',
82
- },
83
- {
84
- name: 'cursor',
85
- displayName: 'Cursor',
86
- configPath: getCursorConfigPath(),
87
- detected: existsSync(dirname(getCursorConfigPath())),
88
- configFormat: 'mcp-json',
89
- },
90
- {
91
- name: 'gemini',
92
- displayName: 'Gemini CLI',
93
- configPath: getGeminiConfigPath(),
94
- detected: true,
95
- configFormat: 'settings-json',
96
- },
97
- ];
98
-
99
- return ides;
100
- }
101
-
102
- // ============================================================================
103
- // User Prompts
104
- // ============================================================================
105
-
106
- async function prompt(question: string): Promise<string> {
107
- const rl = createInterface({
108
- input: process.stdin,
109
- output: process.stdout,
110
- });
111
-
112
- return new Promise((resolve) => {
113
- rl.question(question, (answer) => {
114
- rl.close();
115
- resolve(answer.trim());
116
- });
117
- });
118
- }
119
-
120
- async function promptSelect(question: string, options: { label: string; value: string }[]): Promise<string> {
121
- console.log('\n' + question + '\n');
122
- options.forEach((opt, i) => {
123
- console.log(' ' + (i + 1) + ') ' + opt.label);
124
- });
125
-
126
- const answer = await prompt('\nEnter number: ');
127
- const index = parseInt(answer, 10) - 1;
128
-
129
- if (index >= 0 && index < options.length) {
130
- return options[index].value;
131
- }
132
-
133
- console.log('Invalid selection, using first option.');
134
- return options[0].value;
135
- }
136
-
137
- // ============================================================================
138
- // Browser & Validation
139
- // ============================================================================
140
-
141
- function openBrowser(url: string): Promise<void> {
142
- return new Promise((resolve) => {
143
- const plat = platform();
144
- let cmd: string;
145
-
146
- if (plat === 'darwin') {
147
- cmd = 'open "' + url + '"';
148
- } else if (plat === 'win32') {
149
- cmd = 'start "" "' + url + '"';
150
- } else {
151
- cmd = 'xdg-open "' + url + '"';
152
- }
153
-
154
- exec(cmd, (error) => {
155
- if (error) {
156
- console.log('\nCould not open browser automatically.');
157
- console.log('Please visit: ' + url + '\n');
158
- }
159
- resolve();
160
- });
161
- });
162
- }
163
-
164
- export async function validateApiKey(apiKey: string): Promise<{ valid: boolean; message: string }> {
165
- try {
166
- const response = await fetch(VIBESCOPE_API_URL + '/api/mcp/auth/validate', {
167
- method: 'POST',
168
- headers: {
169
- 'Content-Type': 'application/json',
170
- 'X-API-Key': apiKey,
171
- },
172
- body: JSON.stringify({ api_key: apiKey }),
173
- });
174
-
175
- const data = await response.json();
176
-
177
- if (response.ok && data.valid) {
178
- return { valid: true, message: 'API key validated successfully!' };
179
- }
180
-
181
- // Extract actual error message from server response
182
- const errorMessage = data.error || 'API key appears to be invalid.';
183
- return { valid: false, message: errorMessage };
184
- } catch {
185
- return { valid: true, message: 'Could not validate API key (network issue), but proceeding.' };
186
- }
187
- }
188
-
189
- // ============================================================================
190
- // Config Management
191
- // ============================================================================
192
-
193
- export function readExistingConfig(configPath: string): Record<string, unknown> {
194
- if (existsSync(configPath)) {
195
- try {
196
- return JSON.parse(readFileSync(configPath, 'utf-8'));
197
- } catch {
198
- return {};
199
- }
200
- }
201
- return {};
202
- }
203
-
204
- export function writeConfig(configPath: string, config: Record<string, unknown>): void {
205
- const dir = dirname(configPath);
206
- if (!existsSync(dir)) {
207
- mkdirSync(dir, { recursive: true });
208
- }
209
- writeFileSync(configPath, JSON.stringify(config, null, 2) + '\n');
210
- }
211
-
212
- export function generateMcpConfig(apiKey: string, ide: IdeConfig): Record<string, unknown> {
213
- // Prefer globally installed binary (instant start) with npx fallback
214
- const isWindows = platform() === 'win32';
215
- const vibescopeServer = isWindows
216
- ? {
217
- command: 'cmd',
218
- args: ['/c', 'where vibescope-mcp >nul 2>&1 && vibescope-mcp || npx -y -p @vibescope/mcp-server@latest vibescope-mcp'],
219
- env: { VIBESCOPE_API_KEY: apiKey },
220
- }
221
- : {
222
- command: 'bash',
223
- args: ['-c', 'command -v vibescope-mcp >/dev/null 2>&1 && exec vibescope-mcp || exec npx -y -p @vibescope/mcp-server@latest vibescope-mcp'],
224
- env: { VIBESCOPE_API_KEY: apiKey },
225
- };
226
-
227
- // Gemini CLI uses a different config format with additional options
228
- if (ide.configFormat === 'settings-json') {
229
- return {
230
- mcpServers: {
231
- vibescope: {
232
- ...vibescopeServer,
233
- timeout: 30000,
234
- trust: true,
235
- },
236
- },
237
- };
238
- }
239
-
240
- // Standard MCP config for Claude Code, Claude Desktop, Cursor
241
- return {
242
- mcpServers: {
243
- vibescope: vibescopeServer,
244
- },
245
- };
246
- }
247
-
248
- // ============================================================================
249
- // Main Setup Flow
250
- // ============================================================================
251
-
252
- export async function runSetup(): Promise<void> {
253
- console.log('\n=================================');
254
- console.log(' Vibescope Setup Wizard');
255
- console.log('=================================\n');
256
-
257
- // Step 1: Detect IDEs
258
- const ides = detectIdes();
259
- const detectedIdes = ides.filter(ide => ide.detected);
260
-
261
- console.log('Available development environments:');
262
- detectedIdes.forEach(ide => {
263
- console.log(' - ' + ide.displayName);
264
- });
265
-
266
- // Step 2: Select IDE to configure
267
- let selectedIde: IdeConfig;
268
- if (detectedIdes.length === 1) {
269
- selectedIde = detectedIdes[0];
270
- console.log('\nConfiguring for ' + selectedIde.displayName + '...');
271
- } else {
272
- const ideChoice = await promptSelect(
273
- 'Which environment do you want to configure?',
274
- detectedIdes.map(ide => ({ label: ide.displayName, value: ide.name }))
275
- );
276
- selectedIde = ides.find(ide => ide.name === ideChoice) || detectedIdes[0];
277
- }
278
-
279
- // Step 3: Check if config already exists
280
- if (existsSync(selectedIde.configPath)) {
281
- const existingConfig = readExistingConfig(selectedIde.configPath);
282
- const hasMcpServers = 'mcpServers' in existingConfig;
283
- const hasVibescope = hasMcpServers &&
284
- typeof existingConfig.mcpServers === 'object' &&
285
- existingConfig.mcpServers !== null &&
286
- 'vibescope' in (existingConfig.mcpServers as Record<string, unknown>);
287
-
288
- if (hasVibescope) {
289
- const overwrite = await prompt('\nVibescope is already configured. Reconfigure? (y/N): ');
290
- if (overwrite.toLowerCase() !== 'y') {
291
- console.log('\nSetup cancelled. Your existing configuration is preserved.');
292
- return;
293
- }
294
- }
295
- }
296
-
297
- // Step 4: Get API key (with retry logic)
298
- console.log('\n--- Step 1: Get your API key ---\n');
299
- console.log('Opening Vibescope settings page in your browser...');
300
- console.log("Create an API key if you don't have one, then copy it.\n");
301
-
302
- await openBrowser(VIBESCOPE_SETTINGS_URL);
303
-
304
- const MAX_ATTEMPTS = 3;
305
- let apiKey = '';
306
- let attempts = 0;
307
-
308
- while (attempts < MAX_ATTEMPTS) {
309
- attempts++;
310
- const attemptsRemaining = MAX_ATTEMPTS - attempts;
311
-
312
- apiKey = await prompt('Paste your Vibescope API key: ');
313
-
314
- if (!apiKey) {
315
- if (attemptsRemaining > 0) {
316
- console.log('\nAPI key is required. Please try again. (' + attemptsRemaining + ' attempt' + (attemptsRemaining === 1 ? '' : 's') + ' remaining)\n');
317
- continue;
318
- } else {
319
- console.error('\nError: API key is required. Setup cancelled.');
320
- process.exit(1);
321
- }
322
- }
323
-
324
- // Validate API key
325
- console.log('\nValidating API key...');
326
- const validation = await validateApiKey(apiKey);
327
- console.log(validation.message);
328
-
329
- if (validation.valid) {
330
- break; // Success - exit the retry loop
331
- }
332
-
333
- // Invalid key
334
- if (attemptsRemaining > 0) {
335
- console.log('\nPlease check your API key and try again. (' + attemptsRemaining + ' attempt' + (attemptsRemaining === 1 ? '' : 's') + ' remaining)\n');
336
- } else {
337
- console.error('\nMaximum attempts reached. Please verify your API key at:');
338
- console.error(' ' + VIBESCOPE_SETTINGS_URL);
339
- console.error('\nSetup cancelled.');
340
- process.exit(1);
341
- }
342
- }
343
-
344
- // Step 5: Write configuration
345
- console.log('\n--- Step 2: Writing Configuration ---\n');
346
-
347
- const mcpConfig = generateMcpConfig(apiKey, selectedIde);
348
-
349
- // Merge with existing config if present
350
- const existingConfig = readExistingConfig(selectedIde.configPath);
351
- const existingMcpServers = typeof existingConfig.mcpServers === 'object' && existingConfig.mcpServers !== null
352
- ? existingConfig.mcpServers as Record<string, unknown>
353
- : {};
354
- const newMcpServers = mcpConfig.mcpServers as Record<string, unknown>;
355
-
356
- const mergedConfig = {
357
- ...existingConfig,
358
- mcpServers: {
359
- ...existingMcpServers,
360
- ...newMcpServers,
361
- },
362
- };
363
-
364
- writeConfig(selectedIde.configPath, mergedConfig);
365
-
366
- console.log('Configuration written to: ' + selectedIde.configPath);
367
-
368
- // Step 6: IDE-specific next steps
369
- console.log('\n=================================');
370
- console.log(' Setup Complete!');
371
- console.log('=================================\n');
372
-
373
- switch (selectedIde.name) {
374
- case 'claude-code':
375
- console.log('Next steps:');
376
- console.log(' 1. Restart Claude Code (or run: claude mcp reload)');
377
- console.log(' 2. Verify connection: claude mcp list');
378
- console.log(' 3. Start using Vibescope in your conversation');
379
- break;
380
- case 'claude-desktop':
381
- console.log('Next steps:');
382
- console.log(' 1. Restart Claude Desktop');
383
- console.log(' 2. Vibescope tools will be available in your conversations');
384
- break;
385
- case 'cursor':
386
- console.log('Next steps:');
387
- console.log(' 1. Restart Cursor');
388
- console.log(' 2. Open the MCP settings to verify Vibescope is connected');
389
- break;
390
- case 'gemini':
391
- console.log('Next steps:');
392
- console.log(' 1. Restart Gemini CLI');
393
- console.log(' 2. Verify connection: gemini mcp list');
394
- console.log(' 3. In your conversation, call the MCP tool: start_work_session(git_url: "...", agent_type: "gemini")');
395
- console.log('');
396
- console.log('IMPORTANT: Vibescope tools are MCP tool calls, NOT CLI commands.');
397
- console.log('Do NOT run "vibescope-cli start_work_session" - that command does not exist.');
398
- console.log('');
399
- console.log('NOTE: If you manually edit the config later, do NOT use $VAR_NAME syntax');
400
- console.log('for environment variables - Gemini CLI has a bug where this does not work.');
401
- console.log('Always hardcode API keys directly or use ~/.gemini/.env instead.');
402
- break;
403
- default:
404
- console.log('Next steps:');
405
- console.log(' 1. Restart your IDE/CLI');
406
- console.log(' 2. Verify Vibescope is connected');
407
- }
408
-
409
- console.log('\nHappy building!\n');
410
- }
1
+ /**
2
+ * Vibescope Setup Wizard
3
+ * Guides users through setting up Vibescope MCP integration
4
+ *
5
+ * Usage: vibescope-cli setup
6
+ */
7
+
8
+ import { existsSync, readFileSync, writeFileSync, mkdirSync } from 'node:fs';
9
+ import { createInterface } from 'node:readline';
10
+ import { homedir, platform } from 'node:os';
11
+ import { join, dirname } from 'node:path';
12
+ import { exec } from 'node:child_process';
13
+
14
+ const VIBESCOPE_SETTINGS_URL = 'https://vibescope.dev/dashboard/settings';
15
+ const VIBESCOPE_API_URL = 'https://vibescope.dev';
16
+
17
+ // ============================================================================
18
+ // Types
19
+ // ============================================================================
20
+
21
+ export interface IdeConfig {
22
+ name: string;
23
+ displayName: string;
24
+ configPath: string;
25
+ detected: boolean;
26
+ configFormat: 'mcp-json' | 'settings-json';
27
+ }
28
+
29
+ // ============================================================================
30
+ // Config Path Helpers
31
+ // ============================================================================
32
+
33
+ function getClaudeDesktopConfigPath(): string {
34
+ const plat = platform();
35
+ const home = homedir();
36
+
37
+ if (plat === 'darwin') {
38
+ return join(home, 'Library', 'Application Support', 'Claude', 'claude_desktop_config.json');
39
+ } else if (plat === 'win32') {
40
+ return join(home, 'AppData', 'Roaming', 'Claude', 'claude_desktop_config.json');
41
+ } else {
42
+ return join(home, '.config', 'Claude', 'claude_desktop_config.json');
43
+ }
44
+ }
45
+
46
+ function getCursorConfigPath(): string {
47
+ const plat = platform();
48
+ const home = homedir();
49
+
50
+ if (plat === 'darwin') {
51
+ return join(home, 'Library', 'Application Support', 'Cursor', 'User', 'globalStorage', 'saoudrizwan.claude-dev', 'settings', 'cline_mcp_settings.json');
52
+ } else if (plat === 'win32') {
53
+ return join(home, 'AppData', 'Roaming', 'Cursor', 'User', 'globalStorage', 'saoudrizwan.claude-dev', 'settings', 'cline_mcp_settings.json');
54
+ } else {
55
+ return join(home, '.config', 'Cursor', 'User', 'globalStorage', 'saoudrizwan.claude-dev', 'settings', 'cline_mcp_settings.json');
56
+ }
57
+ }
58
+
59
+ function getGeminiConfigPath(): string {
60
+ return join(homedir(), '.gemini', 'settings.json');
61
+ }
62
+
63
+ // ============================================================================
64
+ // IDE Detection
65
+ // ============================================================================
66
+
67
+ export function detectIdes(): IdeConfig[] {
68
+ const ides: IdeConfig[] = [
69
+ {
70
+ name: 'claude-code',
71
+ displayName: 'Claude Code (CLI)',
72
+ configPath: '.mcp.json',
73
+ detected: true,
74
+ configFormat: 'mcp-json',
75
+ },
76
+ {
77
+ name: 'claude-desktop',
78
+ displayName: 'Claude Desktop',
79
+ configPath: getClaudeDesktopConfigPath(),
80
+ detected: existsSync(dirname(getClaudeDesktopConfigPath())),
81
+ configFormat: 'mcp-json',
82
+ },
83
+ {
84
+ name: 'cursor',
85
+ displayName: 'Cursor',
86
+ configPath: getCursorConfigPath(),
87
+ detected: existsSync(dirname(getCursorConfigPath())),
88
+ configFormat: 'mcp-json',
89
+ },
90
+ {
91
+ name: 'gemini',
92
+ displayName: 'Gemini CLI',
93
+ configPath: getGeminiConfigPath(),
94
+ detected: true,
95
+ configFormat: 'settings-json',
96
+ },
97
+ ];
98
+
99
+ return ides;
100
+ }
101
+
102
+ // ============================================================================
103
+ // User Prompts
104
+ // ============================================================================
105
+
106
+ async function prompt(question: string): Promise<string> {
107
+ const rl = createInterface({
108
+ input: process.stdin,
109
+ output: process.stdout,
110
+ });
111
+
112
+ return new Promise((resolve) => {
113
+ rl.question(question, (answer) => {
114
+ rl.close();
115
+ resolve(answer.trim());
116
+ });
117
+ });
118
+ }
119
+
120
+ async function promptSelect(question: string, options: { label: string; value: string }[]): Promise<string> {
121
+ console.log('\n' + question + '\n');
122
+ options.forEach((opt, i) => {
123
+ console.log(' ' + (i + 1) + ') ' + opt.label);
124
+ });
125
+
126
+ const answer = await prompt('\nEnter number: ');
127
+ const index = parseInt(answer, 10) - 1;
128
+
129
+ if (index >= 0 && index < options.length) {
130
+ return options[index].value;
131
+ }
132
+
133
+ console.log('Invalid selection, using first option.');
134
+ return options[0].value;
135
+ }
136
+
137
+ // ============================================================================
138
+ // Browser & Validation
139
+ // ============================================================================
140
+
141
+ function openBrowser(url: string): Promise<void> {
142
+ return new Promise((resolve) => {
143
+ const plat = platform();
144
+ let cmd: string;
145
+
146
+ if (plat === 'darwin') {
147
+ cmd = 'open "' + url + '"';
148
+ } else if (plat === 'win32') {
149
+ cmd = 'start "" "' + url + '"';
150
+ } else {
151
+ cmd = 'xdg-open "' + url + '"';
152
+ }
153
+
154
+ exec(cmd, (error) => {
155
+ if (error) {
156
+ console.log('\nCould not open browser automatically.');
157
+ console.log('Please visit: ' + url + '\n');
158
+ }
159
+ resolve();
160
+ });
161
+ });
162
+ }
163
+
164
+ export async function validateApiKey(apiKey: string): Promise<{ valid: boolean; message: string }> {
165
+ try {
166
+ const response = await fetch(VIBESCOPE_API_URL + '/api/mcp/auth/validate', {
167
+ method: 'POST',
168
+ headers: {
169
+ 'Content-Type': 'application/json',
170
+ 'X-API-Key': apiKey,
171
+ },
172
+ body: JSON.stringify({ api_key: apiKey }),
173
+ });
174
+
175
+ const data = await response.json();
176
+
177
+ if (response.ok && data.valid) {
178
+ return { valid: true, message: 'API key validated successfully!' };
179
+ }
180
+
181
+ // Extract actual error message from server response
182
+ const errorMessage = data.error || 'API key appears to be invalid.';
183
+ return { valid: false, message: errorMessage };
184
+ } catch {
185
+ return { valid: true, message: 'Could not validate API key (network issue), but proceeding.' };
186
+ }
187
+ }
188
+
189
+ // ============================================================================
190
+ // Config Management
191
+ // ============================================================================
192
+
193
+ export function readExistingConfig(configPath: string): Record<string, unknown> {
194
+ if (existsSync(configPath)) {
195
+ try {
196
+ return JSON.parse(readFileSync(configPath, 'utf-8'));
197
+ } catch {
198
+ return {};
199
+ }
200
+ }
201
+ return {};
202
+ }
203
+
204
+ export function writeConfig(configPath: string, config: Record<string, unknown>): void {
205
+ const dir = dirname(configPath);
206
+ if (!existsSync(dir)) {
207
+ mkdirSync(dir, { recursive: true });
208
+ }
209
+ writeFileSync(configPath, JSON.stringify(config, null, 2) + '\n');
210
+ }
211
+
212
+ export function generateMcpConfig(apiKey: string, ide: IdeConfig): Record<string, unknown> {
213
+ // Prefer globally installed binary (instant start) with npx fallback
214
+ const isWindows = platform() === 'win32';
215
+ const vibescopeServer = isWindows
216
+ ? {
217
+ command: 'cmd',
218
+ args: ['/c', 'where vibescope-mcp >nul 2>&1 && vibescope-mcp || npx -y -p @vibescope/mcp-server@latest vibescope-mcp'],
219
+ env: { VIBESCOPE_API_KEY: apiKey },
220
+ }
221
+ : {
222
+ command: 'bash',
223
+ args: ['-c', 'command -v vibescope-mcp >/dev/null 2>&1 && exec vibescope-mcp || exec npx -y -p @vibescope/mcp-server@latest vibescope-mcp'],
224
+ env: { VIBESCOPE_API_KEY: apiKey },
225
+ };
226
+
227
+ // Gemini CLI uses a different config format with additional options
228
+ if (ide.configFormat === 'settings-json') {
229
+ return {
230
+ mcpServers: {
231
+ vibescope: {
232
+ ...vibescopeServer,
233
+ timeout: 30000,
234
+ trust: true,
235
+ },
236
+ },
237
+ };
238
+ }
239
+
240
+ // Standard MCP config for Claude Code, Claude Desktop, Cursor
241
+ return {
242
+ mcpServers: {
243
+ vibescope: vibescopeServer,
244
+ },
245
+ };
246
+ }
247
+
248
+ // ============================================================================
249
+ // Main Setup Flow
250
+ // ============================================================================
251
+
252
+ export async function runSetup(): Promise<void> {
253
+ console.log('\n=================================');
254
+ console.log(' Vibescope Setup Wizard');
255
+ console.log('=================================\n');
256
+
257
+ // Step 1: Detect IDEs
258
+ const ides = detectIdes();
259
+ const detectedIdes = ides.filter(ide => ide.detected);
260
+
261
+ console.log('Available development environments:');
262
+ detectedIdes.forEach(ide => {
263
+ console.log(' - ' + ide.displayName);
264
+ });
265
+
266
+ // Step 2: Select IDE to configure
267
+ let selectedIde: IdeConfig;
268
+ if (detectedIdes.length === 1) {
269
+ selectedIde = detectedIdes[0];
270
+ console.log('\nConfiguring for ' + selectedIde.displayName + '...');
271
+ } else {
272
+ const ideChoice = await promptSelect(
273
+ 'Which environment do you want to configure?',
274
+ detectedIdes.map(ide => ({ label: ide.displayName, value: ide.name }))
275
+ );
276
+ selectedIde = ides.find(ide => ide.name === ideChoice) || detectedIdes[0];
277
+ }
278
+
279
+ // Step 3: Check if config already exists
280
+ if (existsSync(selectedIde.configPath)) {
281
+ const existingConfig = readExistingConfig(selectedIde.configPath);
282
+ const hasMcpServers = 'mcpServers' in existingConfig;
283
+ const hasVibescope = hasMcpServers &&
284
+ typeof existingConfig.mcpServers === 'object' &&
285
+ existingConfig.mcpServers !== null &&
286
+ 'vibescope' in (existingConfig.mcpServers as Record<string, unknown>);
287
+
288
+ if (hasVibescope) {
289
+ const overwrite = await prompt('\nVibescope is already configured. Reconfigure? (y/N): ');
290
+ if (overwrite.toLowerCase() !== 'y') {
291
+ console.log('\nSetup cancelled. Your existing configuration is preserved.');
292
+ return;
293
+ }
294
+ }
295
+ }
296
+
297
+ // Step 4: Get API key (with retry logic)
298
+ console.log('\n--- Step 1: Get your API key ---\n');
299
+ console.log('Opening Vibescope settings page in your browser...');
300
+ console.log("Create an API key if you don't have one, then copy it.\n");
301
+
302
+ await openBrowser(VIBESCOPE_SETTINGS_URL);
303
+
304
+ const MAX_ATTEMPTS = 3;
305
+ let apiKey = '';
306
+ let attempts = 0;
307
+
308
+ while (attempts < MAX_ATTEMPTS) {
309
+ attempts++;
310
+ const attemptsRemaining = MAX_ATTEMPTS - attempts;
311
+
312
+ apiKey = await prompt('Paste your Vibescope API key: ');
313
+
314
+ if (!apiKey) {
315
+ if (attemptsRemaining > 0) {
316
+ console.log('\nAPI key is required. Please try again. (' + attemptsRemaining + ' attempt' + (attemptsRemaining === 1 ? '' : 's') + ' remaining)\n');
317
+ continue;
318
+ } else {
319
+ console.error('\nError: API key is required. Setup cancelled.');
320
+ process.exit(1);
321
+ }
322
+ }
323
+
324
+ // Validate API key
325
+ console.log('\nValidating API key...');
326
+ const validation = await validateApiKey(apiKey);
327
+ console.log(validation.message);
328
+
329
+ if (validation.valid) {
330
+ break; // Success - exit the retry loop
331
+ }
332
+
333
+ // Invalid key
334
+ if (attemptsRemaining > 0) {
335
+ console.log('\nPlease check your API key and try again. (' + attemptsRemaining + ' attempt' + (attemptsRemaining === 1 ? '' : 's') + ' remaining)\n');
336
+ } else {
337
+ console.error('\nMaximum attempts reached. Please verify your API key at:');
338
+ console.error(' ' + VIBESCOPE_SETTINGS_URL);
339
+ console.error('\nSetup cancelled.');
340
+ process.exit(1);
341
+ }
342
+ }
343
+
344
+ // Step 5: Write configuration
345
+ console.log('\n--- Step 2: Writing Configuration ---\n');
346
+
347
+ const mcpConfig = generateMcpConfig(apiKey, selectedIde);
348
+
349
+ // Merge with existing config if present
350
+ const existingConfig = readExistingConfig(selectedIde.configPath);
351
+ const existingMcpServers = typeof existingConfig.mcpServers === 'object' && existingConfig.mcpServers !== null
352
+ ? existingConfig.mcpServers as Record<string, unknown>
353
+ : {};
354
+ const newMcpServers = mcpConfig.mcpServers as Record<string, unknown>;
355
+
356
+ const mergedConfig = {
357
+ ...existingConfig,
358
+ mcpServers: {
359
+ ...existingMcpServers,
360
+ ...newMcpServers,
361
+ },
362
+ };
363
+
364
+ writeConfig(selectedIde.configPath, mergedConfig);
365
+
366
+ console.log('Configuration written to: ' + selectedIde.configPath);
367
+
368
+ // Step 6: IDE-specific next steps
369
+ console.log('\n=================================');
370
+ console.log(' Setup Complete!');
371
+ console.log('=================================\n');
372
+
373
+ switch (selectedIde.name) {
374
+ case 'claude-code':
375
+ console.log('Next steps:');
376
+ console.log(' 1. Restart Claude Code (or run: claude mcp reload)');
377
+ console.log(' 2. Verify connection: claude mcp list');
378
+ console.log(' 3. Start using Vibescope in your conversation');
379
+ break;
380
+ case 'claude-desktop':
381
+ console.log('Next steps:');
382
+ console.log(' 1. Restart Claude Desktop');
383
+ console.log(' 2. Vibescope tools will be available in your conversations');
384
+ break;
385
+ case 'cursor':
386
+ console.log('Next steps:');
387
+ console.log(' 1. Restart Cursor');
388
+ console.log(' 2. Open the MCP settings to verify Vibescope is connected');
389
+ break;
390
+ case 'gemini':
391
+ console.log('Next steps:');
392
+ console.log(' 1. Restart Gemini CLI');
393
+ console.log(' 2. Verify connection: gemini mcp list');
394
+ console.log(' 3. In your conversation, call the MCP tool: start_work_session(git_url: "...", agent_type: "gemini")');
395
+ console.log('');
396
+ console.log('IMPORTANT: Vibescope tools are MCP tool calls, NOT CLI commands.');
397
+ console.log('Do NOT run "vibescope-cli start_work_session" - that command does not exist.');
398
+ console.log('');
399
+ console.log('NOTE: If you manually edit the config later, do NOT use $VAR_NAME syntax');
400
+ console.log('for environment variables - Gemini CLI has a bug where this does not work.');
401
+ console.log('Always hardcode API keys directly or use ~/.gemini/.env instead.');
402
+ break;
403
+ default:
404
+ console.log('Next steps:');
405
+ console.log(' 1. Restart your IDE/CLI');
406
+ console.log(' 2. Verify Vibescope is connected');
407
+ }
408
+
409
+ console.log('\nHappy building!\n');
410
+ }