@vibescope/mcp-server 0.4.4 → 0.4.6

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 (204) hide show
  1. package/CHANGELOG.md +84 -84
  2. package/README.md +194 -194
  3. package/dist/api-client/bodies-of-work.d.ts +125 -0
  4. package/dist/api-client/bodies-of-work.js +78 -0
  5. package/dist/api-client/chat.d.ts +26 -0
  6. package/dist/api-client/chat.js +20 -0
  7. package/dist/api-client/connectors.d.ts +104 -0
  8. package/dist/api-client/connectors.js +46 -0
  9. package/dist/api-client/deployment.d.ts +190 -0
  10. package/dist/api-client/deployment.js +113 -0
  11. package/dist/api-client/file-checkouts.d.ts +71 -0
  12. package/dist/api-client/file-checkouts.js +43 -0
  13. package/dist/api-client/git-issues.d.ts +55 -0
  14. package/dist/api-client/git-issues.js +34 -0
  15. package/dist/api-client/index.d.ts +619 -1
  16. package/dist/api-client/index.js +148 -0
  17. package/dist/api-client/organizations.d.ts +101 -0
  18. package/dist/api-client/organizations.js +86 -0
  19. package/dist/api-client/progress.d.ts +61 -0
  20. package/dist/api-client/progress.js +34 -0
  21. package/dist/api-client/project.d.ts +1 -0
  22. package/dist/api-client/requests.d.ts +28 -0
  23. package/dist/api-client/requests.js +28 -0
  24. package/dist/api-client/sprints.d.ts +153 -0
  25. package/dist/api-client/sprints.js +82 -0
  26. package/dist/api-client/subtasks.d.ts +37 -0
  27. package/dist/api-client/subtasks.js +23 -0
  28. package/dist/api-client.d.ts +23 -0
  29. package/dist/api-client.js +15 -0
  30. package/dist/cli-init.js +21 -21
  31. package/dist/cli.js +26 -26
  32. package/dist/handlers/blockers.js +4 -0
  33. package/dist/handlers/chat.d.ts +23 -0
  34. package/dist/handlers/chat.js +84 -0
  35. package/dist/handlers/deployment.d.ts +3 -0
  36. package/dist/handlers/deployment.js +23 -0
  37. package/dist/handlers/discovery.js +13 -0
  38. package/dist/handlers/index.d.ts +1 -0
  39. package/dist/handlers/index.js +3 -0
  40. package/dist/handlers/project.js +4 -2
  41. package/dist/handlers/session.js +7 -0
  42. package/dist/handlers/tasks.js +7 -0
  43. package/dist/handlers/tool-docs.js +1204 -1131
  44. package/dist/index.js +73 -73
  45. package/dist/templates/agent-guidelines.d.ts +1 -1
  46. package/dist/templates/agent-guidelines.js +205 -187
  47. package/dist/templates/help-content.js +1621 -1621
  48. package/dist/tools/bodies-of-work.js +6 -6
  49. package/dist/tools/chat.d.ts +1 -0
  50. package/dist/tools/chat.js +24 -0
  51. package/dist/tools/cloud-agents.js +22 -22
  52. package/dist/tools/deployment.js +13 -0
  53. package/dist/tools/features.d.ts +13 -0
  54. package/dist/tools/features.js +151 -0
  55. package/dist/tools/index.d.ts +3 -1
  56. package/dist/tools/index.js +4 -1
  57. package/dist/tools/milestones.js +2 -2
  58. package/dist/tools/project.js +4 -0
  59. package/dist/tools/requests.js +1 -1
  60. package/dist/tools/session.js +11 -11
  61. package/dist/tools/sprints.js +9 -9
  62. package/dist/tools/tasks.js +35 -35
  63. package/dist/tools/worktrees.js +14 -14
  64. package/dist/tools.d.ts +2 -0
  65. package/dist/tools.js +3602 -0
  66. package/dist/utils.js +11 -11
  67. package/docs/TOOLS.md +2663 -2545
  68. package/package.json +53 -53
  69. package/scripts/generate-docs.ts +212 -212
  70. package/scripts/version-bump.ts +203 -203
  71. package/src/api-client/blockers.ts +86 -86
  72. package/src/api-client/bodies-of-work.ts +194 -0
  73. package/src/api-client/chat.ts +50 -0
  74. package/src/api-client/connectors.ts +152 -0
  75. package/src/api-client/cost.ts +185 -185
  76. package/src/api-client/decisions.ts +87 -87
  77. package/src/api-client/deployment.ts +313 -0
  78. package/src/api-client/discovery.ts +81 -81
  79. package/src/api-client/fallback.ts +52 -52
  80. package/src/api-client/file-checkouts.ts +115 -0
  81. package/src/api-client/findings.ts +100 -100
  82. package/src/api-client/git-issues.ts +88 -0
  83. package/src/api-client/ideas.ts +112 -112
  84. package/src/api-client/index.ts +592 -426
  85. package/src/api-client/milestones.ts +83 -83
  86. package/src/api-client/organizations.ts +185 -0
  87. package/src/api-client/progress.ts +94 -0
  88. package/src/api-client/project.ts +180 -179
  89. package/src/api-client/requests.ts +54 -0
  90. package/src/api-client/session.ts +220 -220
  91. package/src/api-client/sprints.ts +227 -0
  92. package/src/api-client/subtasks.ts +57 -0
  93. package/src/api-client/tasks.ts +450 -450
  94. package/src/api-client/types.ts +32 -32
  95. package/src/api-client/validation.ts +60 -60
  96. package/src/api-client/worktrees.ts +53 -53
  97. package/src/api-client.test.ts +847 -850
  98. package/src/api-client.ts +2707 -2672
  99. package/src/cli-init.ts +557 -557
  100. package/src/cli.test.ts +284 -284
  101. package/src/cli.ts +204 -204
  102. package/src/handlers/__test-setup__.ts +240 -236
  103. package/src/handlers/__test-utils__.ts +89 -89
  104. package/src/handlers/blockers.test.ts +468 -468
  105. package/src/handlers/blockers.ts +172 -163
  106. package/src/handlers/bodies-of-work.test.ts +704 -704
  107. package/src/handlers/bodies-of-work.ts +526 -526
  108. package/src/handlers/chat.test.ts +185 -0
  109. package/src/handlers/chat.ts +101 -0
  110. package/src/handlers/cloud-agents.test.ts +438 -438
  111. package/src/handlers/cloud-agents.ts +156 -156
  112. package/src/handlers/connectors.test.ts +834 -834
  113. package/src/handlers/connectors.ts +229 -229
  114. package/src/handlers/cost.test.ts +462 -462
  115. package/src/handlers/cost.ts +285 -285
  116. package/src/handlers/decisions.test.ts +382 -382
  117. package/src/handlers/decisions.ts +153 -153
  118. package/src/handlers/deployment.test.ts +551 -551
  119. package/src/handlers/deployment.ts +570 -541
  120. package/src/handlers/discovery.test.ts +206 -206
  121. package/src/handlers/discovery.ts +427 -414
  122. package/src/handlers/fallback.test.ts +537 -537
  123. package/src/handlers/fallback.ts +194 -194
  124. package/src/handlers/file-checkouts.test.ts +750 -750
  125. package/src/handlers/file-checkouts.ts +185 -185
  126. package/src/handlers/findings.test.ts +633 -633
  127. package/src/handlers/findings.ts +239 -239
  128. package/src/handlers/git-issues.test.ts +631 -631
  129. package/src/handlers/git-issues.ts +136 -136
  130. package/src/handlers/ideas.test.ts +644 -644
  131. package/src/handlers/ideas.ts +207 -207
  132. package/src/handlers/index.ts +93 -90
  133. package/src/handlers/milestones.test.ts +475 -475
  134. package/src/handlers/milestones.ts +180 -180
  135. package/src/handlers/organizations.test.ts +826 -826
  136. package/src/handlers/organizations.ts +315 -315
  137. package/src/handlers/progress.test.ts +269 -269
  138. package/src/handlers/progress.ts +77 -77
  139. package/src/handlers/project.test.ts +546 -546
  140. package/src/handlers/project.ts +242 -239
  141. package/src/handlers/requests.test.ts +303 -303
  142. package/src/handlers/requests.ts +99 -99
  143. package/src/handlers/roles.test.ts +305 -305
  144. package/src/handlers/roles.ts +219 -219
  145. package/src/handlers/session.test.ts +998 -998
  146. package/src/handlers/session.ts +1105 -1093
  147. package/src/handlers/sprints.test.ts +732 -732
  148. package/src/handlers/sprints.ts +537 -537
  149. package/src/handlers/tasks.test.ts +931 -931
  150. package/src/handlers/tasks.ts +1133 -1121
  151. package/src/handlers/tool-categories.test.ts +66 -66
  152. package/src/handlers/tool-docs.test.ts +511 -511
  153. package/src/handlers/tool-docs.ts +1571 -1491
  154. package/src/handlers/types.test.ts +259 -259
  155. package/src/handlers/types.ts +176 -176
  156. package/src/handlers/validation.test.ts +582 -582
  157. package/src/handlers/validation.ts +164 -164
  158. package/src/handlers/version.ts +63 -63
  159. package/src/index.test.ts +674 -674
  160. package/src/index.ts +807 -807
  161. package/src/setup.test.ts +233 -233
  162. package/src/setup.ts +404 -404
  163. package/src/templates/agent-guidelines.ts +233 -215
  164. package/src/templates/help-content.ts +1751 -1751
  165. package/src/token-tracking.test.ts +463 -463
  166. package/src/token-tracking.ts +167 -167
  167. package/src/tools/blockers.ts +122 -122
  168. package/src/tools/bodies-of-work.ts +283 -283
  169. package/src/tools/chat.ts +72 -46
  170. package/src/tools/cloud-agents.ts +101 -101
  171. package/src/tools/connectors.ts +191 -191
  172. package/src/tools/cost.ts +111 -111
  173. package/src/tools/decisions.ts +111 -111
  174. package/src/tools/deployment.ts +455 -442
  175. package/src/tools/discovery.ts +76 -76
  176. package/src/tools/fallback.ts +111 -111
  177. package/src/tools/features.ts +154 -0
  178. package/src/tools/file-checkouts.ts +145 -145
  179. package/src/tools/findings.ts +101 -101
  180. package/src/tools/git-issues.ts +130 -130
  181. package/src/tools/ideas.ts +162 -162
  182. package/src/tools/index.ts +141 -137
  183. package/src/tools/milestones.ts +118 -118
  184. package/src/tools/organizations.ts +224 -224
  185. package/src/tools/progress.ts +73 -73
  186. package/src/tools/project.ts +206 -202
  187. package/src/tools/requests.ts +68 -68
  188. package/src/tools/roles.ts +112 -112
  189. package/src/tools/session.ts +181 -181
  190. package/src/tools/sprints.ts +298 -298
  191. package/src/tools/tasks.ts +550 -550
  192. package/src/tools/tools.test.ts +222 -222
  193. package/src/tools/types.ts +9 -9
  194. package/src/tools/validation.ts +75 -75
  195. package/src/tools/version.ts +34 -34
  196. package/src/tools/worktrees.ts +66 -66
  197. package/src/tools.test.ts +416 -416
  198. package/src/utils.test.ts +1014 -1014
  199. package/src/utils.ts +586 -586
  200. package/src/validators.test.ts +223 -223
  201. package/src/validators.ts +249 -249
  202. package/src/version.ts +109 -109
  203. package/tsconfig.json +16 -16
  204. package/vitest.config.ts +14 -14
package/src/setup.ts CHANGED
@@ -1,404 +1,404 @@
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
- const vibescopeServer = {
214
- command: 'npx',
215
- args: ['-y', '-p', '@vibescope/mcp-server@latest', 'vibescope-mcp'],
216
- env: {
217
- VIBESCOPE_API_KEY: apiKey,
218
- },
219
- };
220
-
221
- // Gemini CLI uses a different config format with additional options
222
- if (ide.configFormat === 'settings-json') {
223
- return {
224
- mcpServers: {
225
- vibescope: {
226
- ...vibescopeServer,
227
- timeout: 30000,
228
- trust: true,
229
- },
230
- },
231
- };
232
- }
233
-
234
- // Standard MCP config for Claude Code, Claude Desktop, Cursor
235
- return {
236
- mcpServers: {
237
- vibescope: vibescopeServer,
238
- },
239
- };
240
- }
241
-
242
- // ============================================================================
243
- // Main Setup Flow
244
- // ============================================================================
245
-
246
- export async function runSetup(): Promise<void> {
247
- console.log('\n=================================');
248
- console.log(' Vibescope Setup Wizard');
249
- console.log('=================================\n');
250
-
251
- // Step 1: Detect IDEs
252
- const ides = detectIdes();
253
- const detectedIdes = ides.filter(ide => ide.detected);
254
-
255
- console.log('Available development environments:');
256
- detectedIdes.forEach(ide => {
257
- console.log(' - ' + ide.displayName);
258
- });
259
-
260
- // Step 2: Select IDE to configure
261
- let selectedIde: IdeConfig;
262
- if (detectedIdes.length === 1) {
263
- selectedIde = detectedIdes[0];
264
- console.log('\nConfiguring for ' + selectedIde.displayName + '...');
265
- } else {
266
- const ideChoice = await promptSelect(
267
- 'Which environment do you want to configure?',
268
- detectedIdes.map(ide => ({ label: ide.displayName, value: ide.name }))
269
- );
270
- selectedIde = ides.find(ide => ide.name === ideChoice) || detectedIdes[0];
271
- }
272
-
273
- // Step 3: Check if config already exists
274
- if (existsSync(selectedIde.configPath)) {
275
- const existingConfig = readExistingConfig(selectedIde.configPath);
276
- const hasMcpServers = 'mcpServers' in existingConfig;
277
- const hasVibescope = hasMcpServers &&
278
- typeof existingConfig.mcpServers === 'object' &&
279
- existingConfig.mcpServers !== null &&
280
- 'vibescope' in (existingConfig.mcpServers as Record<string, unknown>);
281
-
282
- if (hasVibescope) {
283
- const overwrite = await prompt('\nVibescope is already configured. Reconfigure? (y/N): ');
284
- if (overwrite.toLowerCase() !== 'y') {
285
- console.log('\nSetup cancelled. Your existing configuration is preserved.');
286
- return;
287
- }
288
- }
289
- }
290
-
291
- // Step 4: Get API key (with retry logic)
292
- console.log('\n--- Step 1: Get your API key ---\n');
293
- console.log('Opening Vibescope settings page in your browser...');
294
- console.log("Create an API key if you don't have one, then copy it.\n");
295
-
296
- await openBrowser(VIBESCOPE_SETTINGS_URL);
297
-
298
- const MAX_ATTEMPTS = 3;
299
- let apiKey = '';
300
- let attempts = 0;
301
-
302
- while (attempts < MAX_ATTEMPTS) {
303
- attempts++;
304
- const attemptsRemaining = MAX_ATTEMPTS - attempts;
305
-
306
- apiKey = await prompt('Paste your Vibescope API key: ');
307
-
308
- if (!apiKey) {
309
- if (attemptsRemaining > 0) {
310
- console.log('\nAPI key is required. Please try again. (' + attemptsRemaining + ' attempt' + (attemptsRemaining === 1 ? '' : 's') + ' remaining)\n');
311
- continue;
312
- } else {
313
- console.error('\nError: API key is required. Setup cancelled.');
314
- process.exit(1);
315
- }
316
- }
317
-
318
- // Validate API key
319
- console.log('\nValidating API key...');
320
- const validation = await validateApiKey(apiKey);
321
- console.log(validation.message);
322
-
323
- if (validation.valid) {
324
- break; // Success - exit the retry loop
325
- }
326
-
327
- // Invalid key
328
- if (attemptsRemaining > 0) {
329
- console.log('\nPlease check your API key and try again. (' + attemptsRemaining + ' attempt' + (attemptsRemaining === 1 ? '' : 's') + ' remaining)\n');
330
- } else {
331
- console.error('\nMaximum attempts reached. Please verify your API key at:');
332
- console.error(' ' + VIBESCOPE_SETTINGS_URL);
333
- console.error('\nSetup cancelled.');
334
- process.exit(1);
335
- }
336
- }
337
-
338
- // Step 5: Write configuration
339
- console.log('\n--- Step 2: Writing Configuration ---\n');
340
-
341
- const mcpConfig = generateMcpConfig(apiKey, selectedIde);
342
-
343
- // Merge with existing config if present
344
- const existingConfig = readExistingConfig(selectedIde.configPath);
345
- const existingMcpServers = typeof existingConfig.mcpServers === 'object' && existingConfig.mcpServers !== null
346
- ? existingConfig.mcpServers as Record<string, unknown>
347
- : {};
348
- const newMcpServers = mcpConfig.mcpServers as Record<string, unknown>;
349
-
350
- const mergedConfig = {
351
- ...existingConfig,
352
- mcpServers: {
353
- ...existingMcpServers,
354
- ...newMcpServers,
355
- },
356
- };
357
-
358
- writeConfig(selectedIde.configPath, mergedConfig);
359
-
360
- console.log('Configuration written to: ' + selectedIde.configPath);
361
-
362
- // Step 6: IDE-specific next steps
363
- console.log('\n=================================');
364
- console.log(' Setup Complete!');
365
- console.log('=================================\n');
366
-
367
- switch (selectedIde.name) {
368
- case 'claude-code':
369
- console.log('Next steps:');
370
- console.log(' 1. Restart Claude Code (or run: claude mcp reload)');
371
- console.log(' 2. Verify connection: claude mcp list');
372
- console.log(' 3. Start using Vibescope in your conversation');
373
- break;
374
- case 'claude-desktop':
375
- console.log('Next steps:');
376
- console.log(' 1. Restart Claude Desktop');
377
- console.log(' 2. Vibescope tools will be available in your conversations');
378
- break;
379
- case 'cursor':
380
- console.log('Next steps:');
381
- console.log(' 1. Restart Cursor');
382
- console.log(' 2. Open the MCP settings to verify Vibescope is connected');
383
- break;
384
- case 'gemini':
385
- console.log('Next steps:');
386
- console.log(' 1. Restart Gemini CLI');
387
- console.log(' 2. Verify connection: gemini mcp list');
388
- console.log(' 3. In your conversation, call the MCP tool: start_work_session(git_url: "...", agent_type: "gemini")');
389
- console.log('');
390
- console.log('IMPORTANT: Vibescope tools are MCP tool calls, NOT CLI commands.');
391
- console.log('Do NOT run "vibescope-cli start_work_session" - that command does not exist.');
392
- console.log('');
393
- console.log('NOTE: If you manually edit the config later, do NOT use $VAR_NAME syntax');
394
- console.log('for environment variables - Gemini CLI has a bug where this does not work.');
395
- console.log('Always hardcode API keys directly or use ~/.gemini/.env instead.');
396
- break;
397
- default:
398
- console.log('Next steps:');
399
- console.log(' 1. Restart your IDE/CLI');
400
- console.log(' 2. Verify Vibescope is connected');
401
- }
402
-
403
- console.log('\nHappy building!\n');
404
- }
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
+ const vibescopeServer = {
214
+ command: 'npx',
215
+ args: ['-y', '-p', '@vibescope/mcp-server@latest', 'vibescope-mcp'],
216
+ env: {
217
+ VIBESCOPE_API_KEY: apiKey,
218
+ },
219
+ };
220
+
221
+ // Gemini CLI uses a different config format with additional options
222
+ if (ide.configFormat === 'settings-json') {
223
+ return {
224
+ mcpServers: {
225
+ vibescope: {
226
+ ...vibescopeServer,
227
+ timeout: 30000,
228
+ trust: true,
229
+ },
230
+ },
231
+ };
232
+ }
233
+
234
+ // Standard MCP config for Claude Code, Claude Desktop, Cursor
235
+ return {
236
+ mcpServers: {
237
+ vibescope: vibescopeServer,
238
+ },
239
+ };
240
+ }
241
+
242
+ // ============================================================================
243
+ // Main Setup Flow
244
+ // ============================================================================
245
+
246
+ export async function runSetup(): Promise<void> {
247
+ console.log('\n=================================');
248
+ console.log(' Vibescope Setup Wizard');
249
+ console.log('=================================\n');
250
+
251
+ // Step 1: Detect IDEs
252
+ const ides = detectIdes();
253
+ const detectedIdes = ides.filter(ide => ide.detected);
254
+
255
+ console.log('Available development environments:');
256
+ detectedIdes.forEach(ide => {
257
+ console.log(' - ' + ide.displayName);
258
+ });
259
+
260
+ // Step 2: Select IDE to configure
261
+ let selectedIde: IdeConfig;
262
+ if (detectedIdes.length === 1) {
263
+ selectedIde = detectedIdes[0];
264
+ console.log('\nConfiguring for ' + selectedIde.displayName + '...');
265
+ } else {
266
+ const ideChoice = await promptSelect(
267
+ 'Which environment do you want to configure?',
268
+ detectedIdes.map(ide => ({ label: ide.displayName, value: ide.name }))
269
+ );
270
+ selectedIde = ides.find(ide => ide.name === ideChoice) || detectedIdes[0];
271
+ }
272
+
273
+ // Step 3: Check if config already exists
274
+ if (existsSync(selectedIde.configPath)) {
275
+ const existingConfig = readExistingConfig(selectedIde.configPath);
276
+ const hasMcpServers = 'mcpServers' in existingConfig;
277
+ const hasVibescope = hasMcpServers &&
278
+ typeof existingConfig.mcpServers === 'object' &&
279
+ existingConfig.mcpServers !== null &&
280
+ 'vibescope' in (existingConfig.mcpServers as Record<string, unknown>);
281
+
282
+ if (hasVibescope) {
283
+ const overwrite = await prompt('\nVibescope is already configured. Reconfigure? (y/N): ');
284
+ if (overwrite.toLowerCase() !== 'y') {
285
+ console.log('\nSetup cancelled. Your existing configuration is preserved.');
286
+ return;
287
+ }
288
+ }
289
+ }
290
+
291
+ // Step 4: Get API key (with retry logic)
292
+ console.log('\n--- Step 1: Get your API key ---\n');
293
+ console.log('Opening Vibescope settings page in your browser...');
294
+ console.log("Create an API key if you don't have one, then copy it.\n");
295
+
296
+ await openBrowser(VIBESCOPE_SETTINGS_URL);
297
+
298
+ const MAX_ATTEMPTS = 3;
299
+ let apiKey = '';
300
+ let attempts = 0;
301
+
302
+ while (attempts < MAX_ATTEMPTS) {
303
+ attempts++;
304
+ const attemptsRemaining = MAX_ATTEMPTS - attempts;
305
+
306
+ apiKey = await prompt('Paste your Vibescope API key: ');
307
+
308
+ if (!apiKey) {
309
+ if (attemptsRemaining > 0) {
310
+ console.log('\nAPI key is required. Please try again. (' + attemptsRemaining + ' attempt' + (attemptsRemaining === 1 ? '' : 's') + ' remaining)\n');
311
+ continue;
312
+ } else {
313
+ console.error('\nError: API key is required. Setup cancelled.');
314
+ process.exit(1);
315
+ }
316
+ }
317
+
318
+ // Validate API key
319
+ console.log('\nValidating API key...');
320
+ const validation = await validateApiKey(apiKey);
321
+ console.log(validation.message);
322
+
323
+ if (validation.valid) {
324
+ break; // Success - exit the retry loop
325
+ }
326
+
327
+ // Invalid key
328
+ if (attemptsRemaining > 0) {
329
+ console.log('\nPlease check your API key and try again. (' + attemptsRemaining + ' attempt' + (attemptsRemaining === 1 ? '' : 's') + ' remaining)\n');
330
+ } else {
331
+ console.error('\nMaximum attempts reached. Please verify your API key at:');
332
+ console.error(' ' + VIBESCOPE_SETTINGS_URL);
333
+ console.error('\nSetup cancelled.');
334
+ process.exit(1);
335
+ }
336
+ }
337
+
338
+ // Step 5: Write configuration
339
+ console.log('\n--- Step 2: Writing Configuration ---\n');
340
+
341
+ const mcpConfig = generateMcpConfig(apiKey, selectedIde);
342
+
343
+ // Merge with existing config if present
344
+ const existingConfig = readExistingConfig(selectedIde.configPath);
345
+ const existingMcpServers = typeof existingConfig.mcpServers === 'object' && existingConfig.mcpServers !== null
346
+ ? existingConfig.mcpServers as Record<string, unknown>
347
+ : {};
348
+ const newMcpServers = mcpConfig.mcpServers as Record<string, unknown>;
349
+
350
+ const mergedConfig = {
351
+ ...existingConfig,
352
+ mcpServers: {
353
+ ...existingMcpServers,
354
+ ...newMcpServers,
355
+ },
356
+ };
357
+
358
+ writeConfig(selectedIde.configPath, mergedConfig);
359
+
360
+ console.log('Configuration written to: ' + selectedIde.configPath);
361
+
362
+ // Step 6: IDE-specific next steps
363
+ console.log('\n=================================');
364
+ console.log(' Setup Complete!');
365
+ console.log('=================================\n');
366
+
367
+ switch (selectedIde.name) {
368
+ case 'claude-code':
369
+ console.log('Next steps:');
370
+ console.log(' 1. Restart Claude Code (or run: claude mcp reload)');
371
+ console.log(' 2. Verify connection: claude mcp list');
372
+ console.log(' 3. Start using Vibescope in your conversation');
373
+ break;
374
+ case 'claude-desktop':
375
+ console.log('Next steps:');
376
+ console.log(' 1. Restart Claude Desktop');
377
+ console.log(' 2. Vibescope tools will be available in your conversations');
378
+ break;
379
+ case 'cursor':
380
+ console.log('Next steps:');
381
+ console.log(' 1. Restart Cursor');
382
+ console.log(' 2. Open the MCP settings to verify Vibescope is connected');
383
+ break;
384
+ case 'gemini':
385
+ console.log('Next steps:');
386
+ console.log(' 1. Restart Gemini CLI');
387
+ console.log(' 2. Verify connection: gemini mcp list');
388
+ console.log(' 3. In your conversation, call the MCP tool: start_work_session(git_url: "...", agent_type: "gemini")');
389
+ console.log('');
390
+ console.log('IMPORTANT: Vibescope tools are MCP tool calls, NOT CLI commands.');
391
+ console.log('Do NOT run "vibescope-cli start_work_session" - that command does not exist.');
392
+ console.log('');
393
+ console.log('NOTE: If you manually edit the config later, do NOT use $VAR_NAME syntax');
394
+ console.log('for environment variables - Gemini CLI has a bug where this does not work.');
395
+ console.log('Always hardcode API keys directly or use ~/.gemini/.env instead.');
396
+ break;
397
+ default:
398
+ console.log('Next steps:');
399
+ console.log(' 1. Restart your IDE/CLI');
400
+ console.log(' 2. Verify Vibescope is connected');
401
+ }
402
+
403
+ console.log('\nHappy building!\n');
404
+ }