Repository navigation
Expand file tree
/
Copy pathmcp-install-paths.js
More file actions
342 lines (332 loc) · 11.1 KB
/
Copy pathmcp-install-paths.js
File metadata and controls
342 lines (332 loc) · 11.1 KB
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
/**
* Per-client MCP install paths and post-install sign-in steps.
*
* Each entry describes the step the client actually performs in its own UI or
* CLI. Data-only and browser-safe: no IO, no imports, and every field
* serializable.
*/
/**
* How a client receives the server.
*
* - `deeplink`: the client has a URL scheme that installs the server on click
* (Cursor, VS Code). One step; the client handles the rest.
* - `plugin`: the client has a plugin or marketplace bundle that carries skills
* and (sometimes) the server (Claude Code, Codex, Cursor, Devin, Antigravity,
* Hermes, OpenClaw, ChatGPT).
* - `command`: a CLI or config write registers the server (Codex, Gemini CLI,
* Warp, OpenClaw, Hermes, Cline, JetBrains).
* - `url`: paste the endpoint into a settings UI; the host runs its own
* sign-in (Claude web/Desktop connectors, Zed, n8n).
*/
export const MCP_INSTALL_CLASSES = ['deeplink', 'plugin', 'command', 'url'];
/**
* Who completes authentication after the server is registered.
*
* - `host`: the client opens its own browser sign-in. This is the default
* and the only interactive path. Never describe the trigger as a button
* unless `connectLabel` is set.
* - `manual`: no browser sign-in; the user must supply an access key header.
* Used for servers, CI, containers, and scheduled jobs, or clients that
* document no OAuth (Cline, JetBrains).
* - `none`: nothing to authenticate (discovery/metadata only).
*/
export const MCP_AUTH_OWNERS = ['host', 'manual', 'none'];
/**
* One record per client.
*
* @typedef {object} McpInstallPath
* @property {string} id Stable id; also the `--client` value where one exists.
* @property {string} label Product name the user sees.
* @property {'ide'|'cli'|'web'|'desktop'|'terminal'|'automation'} kind
* @property {number} tier 1 = first-class on /install; 2 = long tail.
* @property {string} installClass One of MCP_INSTALL_CLASSES.
* @property {'cursor'|'vscode'|null} deeplinkKind Which builder produces the install href.
* @property {string} afterInstall What the user does next. Never names a control
* unless the client really renders it.
* @property {string} authOwner One of MCP_AUTH_OWNERS.
* @property {string|null} connectLabel The literal button text, ONLY where the
* client renders such a button (Claude, Devin).
* @property {boolean} pluginSupport Whether the client accepts a plugin bundle.
* @property {string} markKey Key into the official brand-mark registry.
* @property {string} docsUrl Vendor documentation for the add-server step.
* @property {string} [addUrl] The client's own page where the server is added, when it has one.
*/
/** @type {ReadonlyArray<McpInstallPath>} */
export const MCP_INSTALL_PATHS = [
{
id: 'cursor',
label: 'Cursor',
kind: 'ide',
tier: 1,
installClass: 'deeplink',
deeplinkKind: 'cursor',
// Cursor has no Connect button. The deeplink registers the server; the user
// enables it in Customize and Cursor runs OAuth itself.
afterInstall: 'Turn Proofable on in Customize. Cursor opens the sign-in.',
authOwner: 'host',
connectLabel: null,
pluginSupport: true,
markKey: 'cursor',
docsUrl: 'https://cursor.com/docs/context/mcp/install-links'
},
{
id: 'vscode',
label: 'VS Code',
kind: 'ide',
tier: 1,
installClass: 'deeplink',
deeplinkKind: 'vscode',
// No Connect button. The server appears in the MCP list and must be started.
afterInstall: 'Start it from “MCP: List Servers”. VS Code opens the sign-in.',
authOwner: 'host',
connectLabel: null,
pluginSupport: true,
markKey: 'vscode',
docsUrl: 'https://code.visualstudio.com/docs/copilot/customization/mcp-servers'
},
{
id: 'claude-code',
label: 'Claude Code',
kind: 'cli',
tier: 1,
installClass: 'plugin',
deeplinkKind: null,
// The plugin carries the server and the skills; adding the server again
// creates a duplicate connection. Sign-in runs from the `/mcp` slash command.
afterInstall: 'Installs the server and skills. Run /mcp, select Proofable and sign in.',
authOwner: 'host',
connectLabel: null,
pluginSupport: true,
markKey: 'claude-code',
docsUrl: 'https://code.claude.com/docs/en/mcp'
},
{
id: 'claude-connectors',
label: 'Claude (connectors)',
kind: 'web',
tier: 1,
installClass: 'url',
deeplinkKind: null,
// The one client where "Connect" is the real button label. Owners add the
// connector once for the whole organization; members then authenticate.
afterInstall: 'Add the connector, then click Connect to sign in.',
authOwner: 'host',
connectLabel: 'Connect',
pluginSupport: true,
markKey: 'anthropic',
docsUrl: 'https://support.claude.com/en/articles/11175166-getting-started-with-custom-connectors'
},
{
id: 'devin',
label: 'Devin',
kind: 'desktop',
tier: 1,
installClass: 'plugin',
deeplinkKind: null,
// Devin renders a real Connect button after the custom MCP is added.
afterInstall: 'Add the MCP, then click Connect to sign in.',
authOwner: 'host',
connectLabel: 'Connect',
pluginSupport: true,
markKey: 'devin',
docsUrl: 'https://docs.devin.ai/work-with-devin/mcp'
},
{
id: 'codex',
label: 'Codex',
kind: 'cli',
tier: 2,
installClass: 'command',
deeplinkKind: null,
// No Connect button: the client's own login subcommand owns the sign-in.
afterInstall: 'Then run codex mcp login proofable.',
authOwner: 'host',
connectLabel: null,
pluginSupport: true,
markKey: 'codex',
docsUrl: 'https://developers.openai.com/codex/mcp'
},
{
id: 'chatgpt',
label: 'ChatGPT',
kind: 'web',
tier: 2,
installClass: 'plugin',
deeplinkKind: null,
// Listed in the ChatGPT plugin directory (addUrl). The listing renders
// "Install plugin", then ChatGPT runs the sign-in.
afterInstall: 'Select Install plugin, then sign in when ChatGPT asks.',
addUrl: 'https://chatgpt.com/plugins/plugin_asdk_app_6ae65c2bac0881918812c63246c7e6c9',
authOwner: 'host',
connectLabel: null,
pluginSupport: true,
markKey: 'openai',
docsUrl: 'https://developers.openai.com/plugins/deploy/connect-chatgpt'
},
{
id: 'gemini-cli',
label: 'Gemini CLI',
kind: 'cli',
tier: 2,
installClass: 'command',
deeplinkKind: null,
afterInstall: 'Then run /mcp auth proofable.',
authOwner: 'host',
connectLabel: null,
pluginSupport: false,
markKey: 'gemini',
docsUrl: 'https://github.com/google-gemini/gemini-cli/blob/main/docs/tools/mcp-server.md'
},
{
id: 'antigravity',
label: 'Antigravity',
kind: 'desktop',
tier: 2,
installClass: 'plugin',
deeplinkKind: null,
afterInstall: 'Then sign in when Antigravity asks.',
authOwner: 'host',
connectLabel: null,
pluginSupport: true,
markKey: 'antigravity',
docsUrl: 'https://antigravity.google/docs/mcp'
},
{
id: 'warp',
label: 'Warp',
kind: 'terminal',
tier: 2,
installClass: 'command',
deeplinkKind: null,
afterInstall: 'Start it and Warp opens the sign-in.',
authOwner: 'host',
connectLabel: null,
pluginSupport: true,
markKey: 'warp',
docsUrl: 'https://docs.warp.dev/knowledge-and-collaboration/mcp'
},
{
id: 'zed',
label: 'Zed',
kind: 'ide',
tier: 2,
installClass: 'url',
deeplinkKind: null,
afterInstall: 'Add it as a remote server, then sign in when Zed prompts you.',
authOwner: 'host',
connectLabel: null,
pluginSupport: false,
markKey: 'zed',
docsUrl: 'https://zed.dev/docs/assistant/model-context-protocol'
},
{
id: 'openclaw',
label: 'OpenClaw',
kind: 'cli',
tier: 2,
installClass: 'command',
deeplinkKind: null,
afterInstall: 'Then run openclaw mcp login proofable.',
authOwner: 'host',
connectLabel: null,
pluginSupport: true,
markKey: 'openclaw',
docsUrl: 'https://docs.openclaw.ai/tools/mcp'
},
{
id: 'hermes',
label: 'Hermes',
kind: 'cli',
tier: 2,
installClass: 'command',
deeplinkKind: null,
afterInstall: 'Then run hermes mcp login proofable.',
authOwner: 'host',
connectLabel: null,
pluginSupport: true,
markKey: 'hermes',
docsUrl: 'https://hermes-agent.nousresearch.com/docs/user-guide/features/mcp'
},
{
id: 'n8n',
label: 'n8n',
kind: 'automation',
tier: 2,
installClass: 'url',
deeplinkKind: null,
afterInstall: 'Use the MCP Client node with OAuth2 and dynamic client registration on.',
authOwner: 'host',
connectLabel: null,
pluginSupport: false,
markKey: 'n8n',
docsUrl: 'https://docs.n8n.io/integrations/builtin/credentials/mcp/'
},
{
id: 'cline',
label: 'Cline',
kind: 'ide',
tier: 2,
installClass: 'command',
deeplinkKind: null,
// Cline documents no browser sign-in: an access-key header is the honest path.
afterInstall: 'Cline needs an access key header; it has no browser sign-in.',
authOwner: 'manual',
connectLabel: null,
pluginSupport: false,
markKey: 'cline',
docsUrl: 'https://docs.cline.bot/mcp/connecting-to-a-remote-server'
},
{
id: 'jetbrains',
label: 'JetBrains IDEs',
kind: 'ide',
tier: 2,
installClass: 'command',
deeplinkKind: null,
// No documented MCP OAuth in JetBrains docs: do not promise a sign-in.
afterInstall: 'No documented sign-in yet; use an access key header.',
authOwner: 'manual',
connectLabel: null,
pluginSupport: false,
markKey: 'jetbrains',
docsUrl: 'https://www.jetbrains.com/help/ai-assistant/mcp.html'
}
];
/** Clients shown as first-class on the install surface. */
export const MCP_PRIMARY_CLIENT_IDS = MCP_INSTALL_PATHS
.filter((entry) => entry.tier === 1)
.map((entry) => entry.id);
/** Everything else, for the long-tail list. */
export const MCP_SECONDARY_CLIENT_IDS = MCP_INSTALL_PATHS
.filter((entry) => entry.tier === 2)
.map((entry) => entry.id);
/** Look up one client's install path. */
export function mcpInstallPath(id) {
const key = String(id || '').trim();
return MCP_INSTALL_PATHS.find((entry) => entry.id === key) || null;
}
/**
* True when the client really renders a "Connect" control.
* Callers that want to name a control must ask this first, so the old
* "Click Connect" copy cannot come back by habit.
*/
export function mcpClientHasConnectButton(id) {
return Boolean(mcpInstallPath(id)?.connectLabel);
}
/**
* True when a browser sign-in is the honest interactive path.
* False means an access key is the only documented route.
*/
export function mcpClientSignsInInBrowser(id) {
return mcpInstallPath(id)?.authOwner === 'host';
}
/**
* The honest next-step sentence for a client, safe to render verbatim.
* Falls back to the generic any-client instruction for an unknown id rather
* than inventing a host-specific step.
*/
export function mcpAfterInstallCopy(id) {
const entry = mcpInstallPath(id);
if (entry) return entry.afterInstall;
return 'Then complete the sign-in your client opens.';
}