@alpic-ai/api 0.0.0-dev.ge3cead0 → 0.0.0-dev.ge3eb38c
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.
- package/dist/index.d.mts +1087 -77
- package/dist/index.mjs +1003 -338
- package/package.json +23 -7
package/dist/index.mjs
CHANGED
|
@@ -1,11 +1,189 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
|
+
import * as z$1 from "zod/v4";
|
|
2
3
|
import { oc } from "@orpc/contract";
|
|
3
4
|
import ms from "ms";
|
|
4
|
-
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
|
+
/**
|
|
7
|
+
* Reusable URL validation that disallows javascript: scheme
|
|
8
|
+
*/
|
|
9
|
+
const SafeUrlSchema = z$1.url().superRefine((val, ctx) => {
|
|
10
|
+
if (!URL.canParse(val)) {
|
|
11
|
+
ctx.addIssue({
|
|
12
|
+
code: z$1.ZodIssueCode.custom,
|
|
13
|
+
message: "URL must be parseable",
|
|
14
|
+
fatal: true
|
|
15
|
+
});
|
|
16
|
+
return z$1.NEVER;
|
|
17
|
+
}
|
|
18
|
+
}).refine((url) => {
|
|
19
|
+
const u = new URL(url);
|
|
20
|
+
return u.protocol !== "javascript:" && u.protocol !== "data:" && u.protocol !== "vbscript:";
|
|
21
|
+
}, { message: "URL cannot use javascript:, data:, or vbscript: scheme" });
|
|
22
|
+
/**
|
|
23
|
+
* RFC 9728 OAuth Protected Resource Metadata
|
|
24
|
+
*/
|
|
25
|
+
const OAuthProtectedResourceMetadataSchema = z$1.looseObject({
|
|
26
|
+
resource: z$1.string().url(),
|
|
27
|
+
authorization_servers: z$1.array(SafeUrlSchema).optional(),
|
|
28
|
+
jwks_uri: z$1.string().url().optional(),
|
|
29
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
30
|
+
bearer_methods_supported: z$1.array(z$1.string()).optional(),
|
|
31
|
+
resource_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
32
|
+
resource_name: z$1.string().optional(),
|
|
33
|
+
resource_documentation: z$1.string().optional(),
|
|
34
|
+
resource_policy_uri: z$1.string().url().optional(),
|
|
35
|
+
resource_tos_uri: z$1.string().url().optional(),
|
|
36
|
+
tls_client_certificate_bound_access_tokens: z$1.boolean().optional(),
|
|
37
|
+
authorization_details_types_supported: z$1.array(z$1.string()).optional(),
|
|
38
|
+
dpop_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
39
|
+
dpop_bound_access_tokens_required: z$1.boolean().optional()
|
|
40
|
+
});
|
|
41
|
+
/**
|
|
42
|
+
* RFC 8414 OAuth 2.0 Authorization Server Metadata
|
|
43
|
+
*/
|
|
44
|
+
const OAuthMetadataSchema = z$1.looseObject({
|
|
45
|
+
issuer: z$1.string(),
|
|
46
|
+
authorization_endpoint: SafeUrlSchema,
|
|
47
|
+
token_endpoint: SafeUrlSchema,
|
|
48
|
+
registration_endpoint: SafeUrlSchema.optional(),
|
|
49
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
50
|
+
response_types_supported: z$1.array(z$1.string()),
|
|
51
|
+
response_modes_supported: z$1.array(z$1.string()).optional(),
|
|
52
|
+
grant_types_supported: z$1.array(z$1.string()).optional(),
|
|
53
|
+
token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
54
|
+
token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
55
|
+
service_documentation: SafeUrlSchema.optional(),
|
|
56
|
+
revocation_endpoint: SafeUrlSchema.optional(),
|
|
57
|
+
revocation_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
58
|
+
revocation_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
59
|
+
introspection_endpoint: z$1.string().optional(),
|
|
60
|
+
introspection_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
61
|
+
introspection_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
62
|
+
code_challenge_methods_supported: z$1.array(z$1.string()).optional(),
|
|
63
|
+
client_id_metadata_document_supported: z$1.boolean().optional()
|
|
64
|
+
});
|
|
65
|
+
/**
|
|
66
|
+
* OpenID Connect Discovery 1.0 Provider Metadata
|
|
67
|
+
* see: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
|
|
68
|
+
*/
|
|
69
|
+
const OpenIdProviderMetadataSchema = z$1.looseObject({
|
|
70
|
+
issuer: z$1.string(),
|
|
71
|
+
authorization_endpoint: SafeUrlSchema,
|
|
72
|
+
token_endpoint: SafeUrlSchema,
|
|
73
|
+
userinfo_endpoint: SafeUrlSchema.optional(),
|
|
74
|
+
jwks_uri: SafeUrlSchema,
|
|
75
|
+
registration_endpoint: SafeUrlSchema.optional(),
|
|
76
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
77
|
+
response_types_supported: z$1.array(z$1.string()),
|
|
78
|
+
response_modes_supported: z$1.array(z$1.string()).optional(),
|
|
79
|
+
grant_types_supported: z$1.array(z$1.string()).optional(),
|
|
80
|
+
acr_values_supported: z$1.array(z$1.string()).optional(),
|
|
81
|
+
subject_types_supported: z$1.array(z$1.string()),
|
|
82
|
+
id_token_signing_alg_values_supported: z$1.array(z$1.string()),
|
|
83
|
+
id_token_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
84
|
+
id_token_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
85
|
+
userinfo_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
86
|
+
userinfo_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
87
|
+
userinfo_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
88
|
+
request_object_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
89
|
+
request_object_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
90
|
+
request_object_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
91
|
+
token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
92
|
+
token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
93
|
+
display_values_supported: z$1.array(z$1.string()).optional(),
|
|
94
|
+
claim_types_supported: z$1.array(z$1.string()).optional(),
|
|
95
|
+
claims_supported: z$1.array(z$1.string()).optional(),
|
|
96
|
+
service_documentation: z$1.string().optional(),
|
|
97
|
+
claims_locales_supported: z$1.array(z$1.string()).optional(),
|
|
98
|
+
ui_locales_supported: z$1.array(z$1.string()).optional(),
|
|
99
|
+
claims_parameter_supported: z$1.boolean().optional(),
|
|
100
|
+
request_parameter_supported: z$1.boolean().optional(),
|
|
101
|
+
request_uri_parameter_supported: z$1.boolean().optional(),
|
|
102
|
+
require_request_uri_registration: z$1.boolean().optional(),
|
|
103
|
+
op_policy_uri: SafeUrlSchema.optional(),
|
|
104
|
+
op_tos_uri: SafeUrlSchema.optional(),
|
|
105
|
+
client_id_metadata_document_supported: z$1.boolean().optional()
|
|
106
|
+
});
|
|
107
|
+
/**
|
|
108
|
+
* OpenID Connect Discovery metadata that may include OAuth 2.0 fields
|
|
109
|
+
* This schema represents the real-world scenario where OIDC providers
|
|
110
|
+
* return a mix of OpenID Connect and OAuth 2.0 metadata fields
|
|
111
|
+
*/
|
|
112
|
+
const OpenIdProviderDiscoveryMetadataSchema = z$1.object({
|
|
113
|
+
...OpenIdProviderMetadataSchema.shape,
|
|
114
|
+
...OAuthMetadataSchema.pick({ code_challenge_methods_supported: true }).shape
|
|
115
|
+
});
|
|
116
|
+
z$1.object({
|
|
117
|
+
access_token: z$1.string(),
|
|
118
|
+
id_token: z$1.string().optional(),
|
|
119
|
+
token_type: z$1.string(),
|
|
120
|
+
expires_in: z$1.coerce.number().optional(),
|
|
121
|
+
scope: z$1.string().optional(),
|
|
122
|
+
refresh_token: z$1.string().optional()
|
|
123
|
+
}).strip();
|
|
124
|
+
z$1.object({
|
|
125
|
+
error: z$1.string(),
|
|
126
|
+
error_description: z$1.string().optional(),
|
|
127
|
+
error_uri: z$1.string().optional()
|
|
128
|
+
});
|
|
129
|
+
/**
|
|
130
|
+
* Optional version of SafeUrlSchema that allows empty string for retrocompatibility on tos_uri and logo_uri
|
|
131
|
+
*/
|
|
132
|
+
const OptionalSafeUrlSchema = SafeUrlSchema.optional().or(z$1.literal("").transform(() => void 0));
|
|
133
|
+
/**
|
|
134
|
+
* RFC 7591 OAuth 2.0 Dynamic Client Registration metadata
|
|
135
|
+
*/
|
|
136
|
+
const OAuthClientMetadataSchema = z$1.object({
|
|
137
|
+
redirect_uris: z$1.array(SafeUrlSchema),
|
|
138
|
+
token_endpoint_auth_method: z$1.string().optional(),
|
|
139
|
+
grant_types: z$1.array(z$1.string()).optional(),
|
|
140
|
+
response_types: z$1.array(z$1.string()).optional(),
|
|
141
|
+
client_name: z$1.string().optional(),
|
|
142
|
+
client_uri: SafeUrlSchema.optional(),
|
|
143
|
+
logo_uri: OptionalSafeUrlSchema,
|
|
144
|
+
scope: z$1.string().optional(),
|
|
145
|
+
contacts: z$1.array(z$1.string()).optional(),
|
|
146
|
+
tos_uri: OptionalSafeUrlSchema,
|
|
147
|
+
policy_uri: z$1.string().optional(),
|
|
148
|
+
jwks_uri: SafeUrlSchema.optional(),
|
|
149
|
+
jwks: z$1.any().optional(),
|
|
150
|
+
software_id: z$1.string().optional(),
|
|
151
|
+
software_version: z$1.string().optional(),
|
|
152
|
+
software_statement: z$1.string().optional()
|
|
153
|
+
}).strip();
|
|
154
|
+
/**
|
|
155
|
+
* RFC 7591 OAuth 2.0 Dynamic Client Registration client information
|
|
156
|
+
*/
|
|
157
|
+
const OAuthClientInformationSchema = z$1.object({
|
|
158
|
+
client_id: z$1.string(),
|
|
159
|
+
client_secret: z$1.string().optional(),
|
|
160
|
+
client_id_issued_at: z$1.number().optional(),
|
|
161
|
+
client_secret_expires_at: z$1.number().optional()
|
|
162
|
+
}).strip();
|
|
163
|
+
OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
|
|
164
|
+
z$1.object({
|
|
165
|
+
error: z$1.string(),
|
|
166
|
+
error_description: z$1.string().optional()
|
|
167
|
+
}).strip();
|
|
168
|
+
z$1.object({
|
|
169
|
+
token: z$1.string(),
|
|
170
|
+
token_type_hint: z$1.string().optional()
|
|
171
|
+
}).strip();
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
5
176
|
const PLATFORM_LABELS = {
|
|
6
177
|
chatgpt: "ChatGPT",
|
|
7
178
|
claudeai: "Claude.ai"
|
|
8
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cloudflare",
|
|
183
|
+
"fastly"
|
|
184
|
+
];
|
|
185
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
186
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
9
187
|
const auditStatusSchema = z.enum([
|
|
10
188
|
"pending",
|
|
11
189
|
"partial",
|
|
@@ -71,6 +249,13 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
|
|
|
71
249
|
chatgpt: widgetScreenshotSchema.optional(),
|
|
72
250
|
claudeai: widgetScreenshotSchema.optional()
|
|
73
251
|
}) });
|
|
252
|
+
z.object({
|
|
253
|
+
id: z.string(),
|
|
254
|
+
environmentId: z.string(),
|
|
255
|
+
clientId: z.string(),
|
|
256
|
+
clientSecret: z.string(),
|
|
257
|
+
clientScopes: z.array(z.string())
|
|
258
|
+
});
|
|
74
259
|
const deploymentStatusSchema$1 = z.enum([
|
|
75
260
|
"ongoing",
|
|
76
261
|
"deployed",
|
|
@@ -98,9 +283,91 @@ const deploymentSummarySchema = z.object({
|
|
|
98
283
|
createdAt: z.coerce.date(),
|
|
99
284
|
updatedAt: z.coerce.date()
|
|
100
285
|
});
|
|
101
|
-
|
|
286
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
287
|
+
const publicEnvironmentSchema = z.object({
|
|
288
|
+
allowsAnonymous: z.literal(true),
|
|
289
|
+
oAuthMetadata: z.strictObject({})
|
|
290
|
+
});
|
|
291
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
292
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
293
|
+
allowsAnonymous: z.boolean(),
|
|
294
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
295
|
+
scope: z.string().optional()
|
|
296
|
+
});
|
|
297
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
298
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
299
|
+
allowsAnonymous: z.boolean(),
|
|
300
|
+
oAuthMetadata: z.object({
|
|
301
|
+
externalAuthorizationServerUrl: z.url(),
|
|
302
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
303
|
+
}),
|
|
304
|
+
scope: z.string().optional()
|
|
305
|
+
});
|
|
306
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
307
|
+
const standaloneEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.boolean(),
|
|
309
|
+
oAuthMetadata: z.object({
|
|
310
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
311
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
312
|
+
}),
|
|
313
|
+
scope: z.string().optional()
|
|
314
|
+
});
|
|
315
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
316
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
317
|
+
allowsAnonymous: z.literal(false),
|
|
318
|
+
oAuthMetadata: z.strictObject({}),
|
|
319
|
+
scope: z.string().optional()
|
|
320
|
+
});
|
|
321
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
322
|
+
isPublic: z.literal(true),
|
|
323
|
+
oAuthMetadata: z.undefined().optional()
|
|
324
|
+
});
|
|
325
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
326
|
+
isPublic: z.literal(false),
|
|
327
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
328
|
+
scope: z.string().optional()
|
|
329
|
+
});
|
|
330
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
331
|
+
isPublic: z.literal(false),
|
|
332
|
+
oAuthMetadata: z.object({
|
|
333
|
+
externalAuthorizationServerUrl: z.url(),
|
|
334
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
335
|
+
}),
|
|
336
|
+
scope: z.string().optional()
|
|
337
|
+
});
|
|
338
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
339
|
+
isPublic: z.literal(false),
|
|
340
|
+
oAuthMetadata: z.object({
|
|
341
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
342
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
343
|
+
}),
|
|
344
|
+
scope: z.string().optional()
|
|
345
|
+
});
|
|
346
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
347
|
+
isPublic: z.literal(false),
|
|
348
|
+
oAuthMetadata: z.strictObject({}),
|
|
349
|
+
scope: z.string().optional()
|
|
350
|
+
});
|
|
351
|
+
z.union([
|
|
352
|
+
publicEnvironmentSchema,
|
|
353
|
+
externalResourceMetadataEnvironmentSchema,
|
|
354
|
+
externalAuthorizationServerEnvironmentSchema,
|
|
355
|
+
standaloneEnvironmentSchema,
|
|
356
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
357
|
+
legacyPublicEnvironmentSchema,
|
|
358
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
359
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
360
|
+
legacyStandaloneEnvironmentSchema,
|
|
361
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
362
|
+
]);
|
|
363
|
+
const playgroundModelSchema = z.enum([
|
|
364
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
365
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
366
|
+
"openai.gpt-5.4",
|
|
367
|
+
"openai.gpt-5.5"
|
|
368
|
+
]);
|
|
102
369
|
const environmentDomainSchema = z.object({
|
|
103
|
-
|
|
370
|
+
name: z.string(),
|
|
104
371
|
status: z.enum([
|
|
105
372
|
"ongoing",
|
|
106
373
|
"deployed",
|
|
@@ -118,6 +385,7 @@ const environmentSchema$1 = z.object({
|
|
|
118
385
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
119
386
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
120
387
|
isPlaygroundEnabled: z.boolean(),
|
|
388
|
+
playgroundModel: playgroundModelSchema,
|
|
121
389
|
isIpWhitelistEnabled: z.boolean(),
|
|
122
390
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
123
391
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -126,12 +394,21 @@ const environmentSchema$1 = z.object({
|
|
|
126
394
|
updatedAt: z.coerce.date()
|
|
127
395
|
});
|
|
128
396
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
397
|
+
z.object({
|
|
398
|
+
sessionReplayEnabled: z.boolean(),
|
|
399
|
+
collectRequestPayload: z.boolean(),
|
|
400
|
+
collectResponsePayload: z.boolean(),
|
|
401
|
+
collectErrorMessage: z.boolean(),
|
|
402
|
+
collectUserData: z.boolean(),
|
|
403
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
404
|
+
});
|
|
129
405
|
z.object({
|
|
130
406
|
id: z.string(),
|
|
131
407
|
createdAt: z.coerce.date(),
|
|
132
408
|
environmentId: z.string(),
|
|
133
409
|
content: z.string(),
|
|
134
|
-
source: z.enum(["model", "user"])
|
|
410
|
+
source: z.enum(["model", "user"]),
|
|
411
|
+
clientName: z.string().nullable()
|
|
135
412
|
});
|
|
136
413
|
z.object({
|
|
137
414
|
content: z.string(),
|
|
@@ -167,6 +444,7 @@ z.object({
|
|
|
167
444
|
environmentId: z.string(),
|
|
168
445
|
toolName: z.string(),
|
|
169
446
|
message: z.string(),
|
|
447
|
+
clientName: z.string().nullable(),
|
|
170
448
|
categories: z.array(intentCategorySchema)
|
|
171
449
|
});
|
|
172
450
|
const signalCategorySchema = z.object({
|
|
@@ -231,6 +509,246 @@ z.enum([
|
|
|
231
509
|
"DEBUG",
|
|
232
510
|
"ERROR"
|
|
233
511
|
]);
|
|
512
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
513
|
+
const MCP_CLIENT_GROUPS = [
|
|
514
|
+
{
|
|
515
|
+
id: "claude_code",
|
|
516
|
+
label: "Claude Code",
|
|
517
|
+
vendor: "anthropic",
|
|
518
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
519
|
+
},
|
|
520
|
+
{
|
|
521
|
+
id: "claude",
|
|
522
|
+
label: "Claude",
|
|
523
|
+
vendor: "anthropic",
|
|
524
|
+
rawNames: [
|
|
525
|
+
"Anthropic/ClaudeAI",
|
|
526
|
+
"claude-ai",
|
|
527
|
+
"claude",
|
|
528
|
+
"Claude",
|
|
529
|
+
"claude-desktop",
|
|
530
|
+
"claude-desktop-3p"
|
|
531
|
+
]
|
|
532
|
+
},
|
|
533
|
+
{
|
|
534
|
+
id: "claude_mobile",
|
|
535
|
+
label: "Claude mobile",
|
|
536
|
+
vendor: "anthropic",
|
|
537
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
538
|
+
},
|
|
539
|
+
{
|
|
540
|
+
id: "claude_cowork",
|
|
541
|
+
label: "Claude Cowork",
|
|
542
|
+
vendor: "anthropic",
|
|
543
|
+
rawNames: ["Anthropic/Cowork"]
|
|
544
|
+
},
|
|
545
|
+
{
|
|
546
|
+
id: "claude_toolbox",
|
|
547
|
+
label: "Claude Toolbox",
|
|
548
|
+
vendor: "anthropic",
|
|
549
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
id: "anthropic_api",
|
|
553
|
+
label: "Anthropic API",
|
|
554
|
+
vendor: "anthropic",
|
|
555
|
+
rawNames: ["Anthropic/API"]
|
|
556
|
+
},
|
|
557
|
+
{
|
|
558
|
+
id: "anthropic_connector_refresh",
|
|
559
|
+
label: "Anthropic (connector refresh)",
|
|
560
|
+
vendor: "anthropic",
|
|
561
|
+
rawNames: ["Anthropic"]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "codex",
|
|
565
|
+
label: "Codex",
|
|
566
|
+
vendor: "openai",
|
|
567
|
+
rawNames: [
|
|
568
|
+
"codex-mcp-client",
|
|
569
|
+
"codex",
|
|
570
|
+
"Codex",
|
|
571
|
+
"codex-cli",
|
|
572
|
+
"openai-mcp (Codex)"
|
|
573
|
+
]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "chatgpt",
|
|
577
|
+
label: "ChatGPT",
|
|
578
|
+
vendor: "openai",
|
|
579
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "openai_responses_api",
|
|
583
|
+
label: "OpenAI Responses API",
|
|
584
|
+
vendor: "openai",
|
|
585
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "openai_agent_builder",
|
|
589
|
+
label: "OpenAI Agent Builder",
|
|
590
|
+
vendor: "openai",
|
|
591
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "openai_other",
|
|
595
|
+
label: "OpenAI Other",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: ["openai-mcp"]
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
id: "cursor",
|
|
601
|
+
label: "Cursor",
|
|
602
|
+
vendor: "cursor",
|
|
603
|
+
rawNames: [
|
|
604
|
+
"cursor-vscode",
|
|
605
|
+
"Cursor",
|
|
606
|
+
"cursor"
|
|
607
|
+
]
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
id: "cline",
|
|
611
|
+
label: "Cline",
|
|
612
|
+
vendor: "cline",
|
|
613
|
+
rawNames: [
|
|
614
|
+
"Cline",
|
|
615
|
+
"cline",
|
|
616
|
+
"@cline/core"
|
|
617
|
+
]
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
id: "github_copilot",
|
|
621
|
+
label: "GitHub Copilot",
|
|
622
|
+
vendor: "githubCopilot",
|
|
623
|
+
rawNames: [
|
|
624
|
+
"Copilot",
|
|
625
|
+
"github-copilot-developer",
|
|
626
|
+
"Copilot MCP Gateway",
|
|
627
|
+
"Xcode/copilot-xcode"
|
|
628
|
+
]
|
|
629
|
+
},
|
|
630
|
+
{
|
|
631
|
+
id: "gemini_cli",
|
|
632
|
+
label: "Gemini CLI",
|
|
633
|
+
vendor: "google",
|
|
634
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
635
|
+
},
|
|
636
|
+
{
|
|
637
|
+
id: "antigravity",
|
|
638
|
+
label: "Antigravity",
|
|
639
|
+
vendor: "google",
|
|
640
|
+
rawNames: ["antigravity-client"]
|
|
641
|
+
},
|
|
642
|
+
{
|
|
643
|
+
id: "gemini",
|
|
644
|
+
label: "Gemini",
|
|
645
|
+
vendor: "google",
|
|
646
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
id: "windsurf",
|
|
650
|
+
label: "Windsurf",
|
|
651
|
+
vendor: "windsurf",
|
|
652
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
653
|
+
},
|
|
654
|
+
{
|
|
655
|
+
id: "mistral",
|
|
656
|
+
label: "Mistral / Le Chat",
|
|
657
|
+
vendor: "mistral",
|
|
658
|
+
rawNames: ["Mistral"],
|
|
659
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
id: "n8n",
|
|
663
|
+
label: "n8n",
|
|
664
|
+
vendor: "n8n",
|
|
665
|
+
rawNames: [
|
|
666
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
667
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
668
|
+
"n8n"
|
|
669
|
+
]
|
|
670
|
+
},
|
|
671
|
+
{
|
|
672
|
+
id: "alpic_playground",
|
|
673
|
+
label: "Alpic Playground",
|
|
674
|
+
vendor: "alpic",
|
|
675
|
+
rawNames: ["alpic-playground", "playground"]
|
|
676
|
+
},
|
|
677
|
+
{
|
|
678
|
+
id: "opencode",
|
|
679
|
+
label: "opencode",
|
|
680
|
+
vendor: "opencode",
|
|
681
|
+
rawNames: ["opencode"]
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
id: "zed",
|
|
685
|
+
label: "Zed",
|
|
686
|
+
vendor: "zed",
|
|
687
|
+
rawNames: ["Zed", "zed"]
|
|
688
|
+
},
|
|
689
|
+
{
|
|
690
|
+
id: "zapier",
|
|
691
|
+
label: "Zapier",
|
|
692
|
+
vendor: "zapier",
|
|
693
|
+
rawNames: ["Zapier", "zapier"]
|
|
694
|
+
},
|
|
695
|
+
{
|
|
696
|
+
id: "make",
|
|
697
|
+
label: "Make",
|
|
698
|
+
vendor: "make",
|
|
699
|
+
rawNames: ["Make", "make"]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "librechat",
|
|
703
|
+
label: "LibreChat",
|
|
704
|
+
vendor: "mcp",
|
|
705
|
+
rawNames: ["LibreChat", "librechat"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "jan",
|
|
709
|
+
label: "Jan",
|
|
710
|
+
vendor: "mcp",
|
|
711
|
+
rawNames: ["Jan", "jan"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "goose",
|
|
715
|
+
label: "goose",
|
|
716
|
+
vendor: "mcp",
|
|
717
|
+
rawNames: ["goose", "Goose"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "mcphost",
|
|
721
|
+
label: "mcphost",
|
|
722
|
+
vendor: "mcp",
|
|
723
|
+
rawNames: ["mcphost"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "mcporter",
|
|
727
|
+
label: "mcporter",
|
|
728
|
+
vendor: "mcp",
|
|
729
|
+
rawNames: ["mcporter"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "rmcp",
|
|
733
|
+
label: "rmcp",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["rmcp"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "unnamed_client",
|
|
739
|
+
label: "Unnamed client",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: [
|
|
742
|
+
"mcp",
|
|
743
|
+
"unknown",
|
|
744
|
+
""
|
|
745
|
+
]
|
|
746
|
+
}
|
|
747
|
+
];
|
|
748
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
749
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
750
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
751
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
234
752
|
const runtimeSchema = z.enum([
|
|
235
753
|
"python3.13",
|
|
236
754
|
"python3.14",
|
|
@@ -259,15 +777,27 @@ z.object({
|
|
|
259
777
|
environments: z.array(environmentWithDomainsSchema),
|
|
260
778
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
261
779
|
});
|
|
780
|
+
const domainFailureReasonSchema = z.enum([
|
|
781
|
+
"caa",
|
|
782
|
+
"dns",
|
|
783
|
+
"invalid_domain",
|
|
784
|
+
"other"
|
|
785
|
+
]);
|
|
786
|
+
const projectDomainMappingSchema = z.object({
|
|
787
|
+
pathPrefix: z.string(),
|
|
788
|
+
environment: environmentSchema$1
|
|
789
|
+
});
|
|
262
790
|
z.object({
|
|
263
|
-
|
|
791
|
+
name: z.string(),
|
|
264
792
|
createdAt: z.coerce.date(),
|
|
265
793
|
status: z.enum([
|
|
266
794
|
"ongoing",
|
|
267
795
|
"deployed",
|
|
268
796
|
"failed"
|
|
269
797
|
]),
|
|
270
|
-
|
|
798
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
799
|
+
environment: environmentSchema$1,
|
|
800
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
271
801
|
});
|
|
272
802
|
const serverFieldsSchema$1 = z.object({
|
|
273
803
|
$schema: z.string(),
|
|
@@ -296,15 +826,7 @@ z.object({
|
|
|
296
826
|
serverFields: serverFieldsSchema$1,
|
|
297
827
|
source: z.enum(["registry", "defaults"])
|
|
298
828
|
});
|
|
299
|
-
/**
|
|
300
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
301
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
302
|
-
*
|
|
303
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
304
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
305
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
306
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
307
|
-
*/
|
|
829
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
308
830
|
const clampStringField = (field) => {
|
|
309
831
|
const max = field.maxLength;
|
|
310
832
|
if (max === null) return field;
|
|
@@ -324,17 +846,20 @@ const toolDefinitionSchema = z.object({
|
|
|
324
846
|
}).optional()
|
|
325
847
|
});
|
|
326
848
|
const positiveTestCaseSchema = z.object({
|
|
327
|
-
scenario: z.string(),
|
|
328
|
-
userPrompt: z.string(),
|
|
329
|
-
toolTriggered: z.string().optional(),
|
|
330
|
-
expectedOutput: z.string().optional()
|
|
849
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
850
|
+
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
851
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
852
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
331
853
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
332
854
|
const screenshotEntrySchema = z.object({
|
|
333
855
|
prompt: z.string(),
|
|
334
|
-
url: z.url()
|
|
856
|
+
url: z.url()
|
|
335
857
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
858
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
336
859
|
/** Accepts either a valid email or URL. */
|
|
337
860
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
861
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
862
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
338
863
|
const chatgptCategorySchema = z.enum([
|
|
339
864
|
"BUSINESS",
|
|
340
865
|
"COLLABORATION",
|
|
@@ -351,7 +876,227 @@ const chatgptCategorySchema = z.enum([
|
|
|
351
876
|
"TRAVEL"
|
|
352
877
|
]);
|
|
353
878
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
354
|
-
const
|
|
879
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
880
|
+
"AD",
|
|
881
|
+
"AE",
|
|
882
|
+
"AF",
|
|
883
|
+
"AG",
|
|
884
|
+
"AL",
|
|
885
|
+
"AM",
|
|
886
|
+
"AO",
|
|
887
|
+
"AR",
|
|
888
|
+
"AT",
|
|
889
|
+
"AU",
|
|
890
|
+
"AW",
|
|
891
|
+
"AX",
|
|
892
|
+
"AZ",
|
|
893
|
+
"BA",
|
|
894
|
+
"BB",
|
|
895
|
+
"BD",
|
|
896
|
+
"BE",
|
|
897
|
+
"BF",
|
|
898
|
+
"BG",
|
|
899
|
+
"BH",
|
|
900
|
+
"BI",
|
|
901
|
+
"BJ",
|
|
902
|
+
"BL",
|
|
903
|
+
"BM",
|
|
904
|
+
"BN",
|
|
905
|
+
"BO",
|
|
906
|
+
"BR",
|
|
907
|
+
"BS",
|
|
908
|
+
"BT",
|
|
909
|
+
"BW",
|
|
910
|
+
"BZ",
|
|
911
|
+
"CA",
|
|
912
|
+
"CD",
|
|
913
|
+
"CF",
|
|
914
|
+
"CG",
|
|
915
|
+
"CH",
|
|
916
|
+
"CI",
|
|
917
|
+
"CL",
|
|
918
|
+
"CM",
|
|
919
|
+
"CO",
|
|
920
|
+
"CR",
|
|
921
|
+
"CV",
|
|
922
|
+
"CY",
|
|
923
|
+
"CZ",
|
|
924
|
+
"DE",
|
|
925
|
+
"DJ",
|
|
926
|
+
"DK",
|
|
927
|
+
"DM",
|
|
928
|
+
"DO",
|
|
929
|
+
"DZ",
|
|
930
|
+
"EC",
|
|
931
|
+
"EE",
|
|
932
|
+
"EG",
|
|
933
|
+
"ER",
|
|
934
|
+
"ES",
|
|
935
|
+
"ET",
|
|
936
|
+
"FI",
|
|
937
|
+
"FJ",
|
|
938
|
+
"FM",
|
|
939
|
+
"FO",
|
|
940
|
+
"FR",
|
|
941
|
+
"GA",
|
|
942
|
+
"GB",
|
|
943
|
+
"GD",
|
|
944
|
+
"GE",
|
|
945
|
+
"GF",
|
|
946
|
+
"GH",
|
|
947
|
+
"GL",
|
|
948
|
+
"GM",
|
|
949
|
+
"GN",
|
|
950
|
+
"GP",
|
|
951
|
+
"GQ",
|
|
952
|
+
"GR",
|
|
953
|
+
"GT",
|
|
954
|
+
"GW",
|
|
955
|
+
"GY",
|
|
956
|
+
"HN",
|
|
957
|
+
"HR",
|
|
958
|
+
"HT",
|
|
959
|
+
"HU",
|
|
960
|
+
"ID",
|
|
961
|
+
"IE",
|
|
962
|
+
"IL",
|
|
963
|
+
"IN",
|
|
964
|
+
"IQ",
|
|
965
|
+
"IS",
|
|
966
|
+
"IT",
|
|
967
|
+
"JM",
|
|
968
|
+
"JO",
|
|
969
|
+
"JP",
|
|
970
|
+
"KE",
|
|
971
|
+
"KG",
|
|
972
|
+
"KH",
|
|
973
|
+
"KI",
|
|
974
|
+
"KM",
|
|
975
|
+
"KN",
|
|
976
|
+
"KR",
|
|
977
|
+
"KW",
|
|
978
|
+
"KY",
|
|
979
|
+
"KZ",
|
|
980
|
+
"LA",
|
|
981
|
+
"LB",
|
|
982
|
+
"LC",
|
|
983
|
+
"LI",
|
|
984
|
+
"LK",
|
|
985
|
+
"LR",
|
|
986
|
+
"LS",
|
|
987
|
+
"LT",
|
|
988
|
+
"LU",
|
|
989
|
+
"LV",
|
|
990
|
+
"LY",
|
|
991
|
+
"MA",
|
|
992
|
+
"MC",
|
|
993
|
+
"MD",
|
|
994
|
+
"ME",
|
|
995
|
+
"MF",
|
|
996
|
+
"MG",
|
|
997
|
+
"MH",
|
|
998
|
+
"MK",
|
|
999
|
+
"ML",
|
|
1000
|
+
"MM",
|
|
1001
|
+
"MN",
|
|
1002
|
+
"MQ",
|
|
1003
|
+
"MR",
|
|
1004
|
+
"MT",
|
|
1005
|
+
"MU",
|
|
1006
|
+
"MV",
|
|
1007
|
+
"MW",
|
|
1008
|
+
"MX",
|
|
1009
|
+
"MY",
|
|
1010
|
+
"MZ",
|
|
1011
|
+
"NA",
|
|
1012
|
+
"NC",
|
|
1013
|
+
"NE",
|
|
1014
|
+
"NG",
|
|
1015
|
+
"NI",
|
|
1016
|
+
"NL",
|
|
1017
|
+
"NO",
|
|
1018
|
+
"NP",
|
|
1019
|
+
"NR",
|
|
1020
|
+
"NZ",
|
|
1021
|
+
"OM",
|
|
1022
|
+
"PA",
|
|
1023
|
+
"PE",
|
|
1024
|
+
"PF",
|
|
1025
|
+
"PG",
|
|
1026
|
+
"PH",
|
|
1027
|
+
"PK",
|
|
1028
|
+
"PL",
|
|
1029
|
+
"PM",
|
|
1030
|
+
"PS",
|
|
1031
|
+
"PT",
|
|
1032
|
+
"PW",
|
|
1033
|
+
"PY",
|
|
1034
|
+
"QA",
|
|
1035
|
+
"RE",
|
|
1036
|
+
"RO",
|
|
1037
|
+
"RS",
|
|
1038
|
+
"RW",
|
|
1039
|
+
"SA",
|
|
1040
|
+
"SB",
|
|
1041
|
+
"SC",
|
|
1042
|
+
"SD",
|
|
1043
|
+
"SE",
|
|
1044
|
+
"SG",
|
|
1045
|
+
"SH",
|
|
1046
|
+
"SI",
|
|
1047
|
+
"SJ",
|
|
1048
|
+
"SK",
|
|
1049
|
+
"SL",
|
|
1050
|
+
"SM",
|
|
1051
|
+
"SN",
|
|
1052
|
+
"SO",
|
|
1053
|
+
"SR",
|
|
1054
|
+
"SS",
|
|
1055
|
+
"ST",
|
|
1056
|
+
"SV",
|
|
1057
|
+
"SZ",
|
|
1058
|
+
"TD",
|
|
1059
|
+
"TF",
|
|
1060
|
+
"TG",
|
|
1061
|
+
"TH",
|
|
1062
|
+
"TJ",
|
|
1063
|
+
"TL",
|
|
1064
|
+
"TM",
|
|
1065
|
+
"TN",
|
|
1066
|
+
"TO",
|
|
1067
|
+
"TR",
|
|
1068
|
+
"TT",
|
|
1069
|
+
"TV",
|
|
1070
|
+
"TW",
|
|
1071
|
+
"TZ",
|
|
1072
|
+
"UA",
|
|
1073
|
+
"UG",
|
|
1074
|
+
"US",
|
|
1075
|
+
"UY",
|
|
1076
|
+
"UZ",
|
|
1077
|
+
"VA",
|
|
1078
|
+
"VC",
|
|
1079
|
+
"VN",
|
|
1080
|
+
"VU",
|
|
1081
|
+
"WF",
|
|
1082
|
+
"WS",
|
|
1083
|
+
"YE",
|
|
1084
|
+
"YT",
|
|
1085
|
+
"ZA",
|
|
1086
|
+
"ZM",
|
|
1087
|
+
"ZW"
|
|
1088
|
+
]);
|
|
1089
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
1090
|
+
z.object({ mode: z.literal("all") }),
|
|
1091
|
+
z.object({
|
|
1092
|
+
mode: z.literal("allow"),
|
|
1093
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1094
|
+
}),
|
|
1095
|
+
z.object({
|
|
1096
|
+
mode: z.literal("block"),
|
|
1097
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1098
|
+
})
|
|
1099
|
+
]);
|
|
355
1100
|
const chatgptTranslationLocaleSchema = z.enum([
|
|
356
1101
|
"am",
|
|
357
1102
|
"ar",
|
|
@@ -423,15 +1168,11 @@ const negativeTestCaseSchema = z.object({
|
|
|
423
1168
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
424
1169
|
const chatgptToolJustificationSchema = z.object({
|
|
425
1170
|
toolName: z.string(),
|
|
426
|
-
readOnlyJustification: z.string(),
|
|
427
|
-
openWorldJustification: z.string(),
|
|
428
|
-
destructiveJustification: z.string()
|
|
429
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
430
|
-
/**
|
|
431
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
432
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
433
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
434
|
-
*/
|
|
1171
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
1172
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
1173
|
+
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
1174
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
1175
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
435
1176
|
const chatgptTaglineSchema = z.string().max(30);
|
|
436
1177
|
const chatgptDescriptionSchema = z.string();
|
|
437
1178
|
const chatgptTranslationSchema = z.object({
|
|
@@ -440,35 +1181,43 @@ const chatgptTranslationSchema = z.object({
|
|
|
440
1181
|
description: chatgptDescriptionSchema
|
|
441
1182
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
442
1183
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
443
|
-
/**
|
|
444
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
445
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
446
|
-
*/
|
|
1184
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
447
1185
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
448
1186
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
449
1187
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
450
1188
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
451
|
-
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value
|
|
452
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
|
|
1189
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1190
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
453
1191
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
454
1192
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
455
|
-
companyUrl:
|
|
1193
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
456
1194
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
457
|
-
privacyPolicyUrl:
|
|
458
|
-
termsOfServiceUrl:
|
|
459
|
-
demoRecordingUrl:
|
|
1195
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1196
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1197
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
460
1198
|
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
|
|
461
|
-
serverUrl:
|
|
1199
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
462
1200
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
463
1201
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
464
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
465
|
-
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output.
|
|
466
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases
|
|
467
|
-
screenshots: z.array(screenshotEntrySchema).describe("In-app screenshots paired with the user prompt that produced them. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max
|
|
1202
|
+
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
1203
|
+
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
1204
|
+
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
1205
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
468
1206
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
469
|
-
allowedCountries: chatgptAllowedCountriesSchema.describe("
|
|
1207
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
470
1208
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
471
1209
|
});
|
|
1210
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1211
|
+
tagline: z.string().optional(),
|
|
1212
|
+
companyUrl: z.string().optional(),
|
|
1213
|
+
supportChannel: z.string().optional(),
|
|
1214
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1215
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1216
|
+
demoRecordingUrl: z.string().optional(),
|
|
1217
|
+
serverUrl: z.string().optional(),
|
|
1218
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1219
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1220
|
+
});
|
|
472
1221
|
chatgptSubmissionFormDataSchema.pick({
|
|
473
1222
|
appName: true,
|
|
474
1223
|
developerName: true,
|
|
@@ -485,7 +1234,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
485
1234
|
toolJustifications: true
|
|
486
1235
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
487
1236
|
const claudeCategorySchema = z.enum([
|
|
488
|
-
"
|
|
1237
|
+
"Productivity",
|
|
489
1238
|
"Communication",
|
|
490
1239
|
"Data & Analytics",
|
|
491
1240
|
"Development tools",
|
|
@@ -493,221 +1242,162 @@ const claudeCategorySchema = z.enum([
|
|
|
493
1242
|
"Consumer Health",
|
|
494
1243
|
"Health & Life Sciences",
|
|
495
1244
|
"Media & Entertainment",
|
|
496
|
-
"Commerce & Shopping"
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
"
|
|
500
|
-
"
|
|
501
|
-
"
|
|
1245
|
+
"Commerce & Shopping",
|
|
1246
|
+
"Legal",
|
|
1247
|
+
"Sales and marketing",
|
|
1248
|
+
"Creative",
|
|
1249
|
+
"Nonprofit",
|
|
1250
|
+
"Education",
|
|
1251
|
+
"Other"
|
|
502
1252
|
]);
|
|
503
|
-
const
|
|
504
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1253
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
505
1254
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
506
|
-
"
|
|
507
|
-
"
|
|
508
|
-
"
|
|
509
|
-
]);
|
|
510
|
-
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
511
|
-
const claudeTestedSurfaceSchema = z.enum([
|
|
512
|
-
"Claude.ai (web)",
|
|
513
|
-
"Claude Desktop",
|
|
514
|
-
"Claude Code",
|
|
515
|
-
"Cowork"
|
|
1255
|
+
"read_only",
|
|
1256
|
+
"write_only",
|
|
1257
|
+
"read_write"
|
|
516
1258
|
]);
|
|
517
|
-
const
|
|
518
|
-
"
|
|
519
|
-
"
|
|
520
|
-
"
|
|
521
|
-
"
|
|
522
|
-
"
|
|
1259
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1260
|
+
"oauth_dcr",
|
|
1261
|
+
"oauth_cimd",
|
|
1262
|
+
"oauth_anthropic_creds",
|
|
1263
|
+
"custom_connection",
|
|
1264
|
+
"none"
|
|
523
1265
|
]);
|
|
524
|
-
const
|
|
525
|
-
"
|
|
526
|
-
"
|
|
527
|
-
"
|
|
528
|
-
"GDPR compliant (if applicable)"
|
|
1266
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1267
|
+
"first_party",
|
|
1268
|
+
"proxied",
|
|
1269
|
+
"third_party"
|
|
529
1270
|
]);
|
|
530
|
-
const
|
|
531
|
-
|
|
532
|
-
"
|
|
533
|
-
"
|
|
1271
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1272
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1273
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1274
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1275
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1276
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1277
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1278
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1279
|
+
"Public documentation for this connector will be live by the publish date."
|
|
534
1280
|
]);
|
|
535
|
-
/**
|
|
536
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
537
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
538
|
-
*/
|
|
1281
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
539
1282
|
const claudeSubmissionFormDataSchema = z.object({
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
(
|
|
550
|
-
|
|
551
|
-
(
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
•
|
|
569
|
-
•
|
|
570
|
-
•
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
• '
|
|
586
|
-
• '
|
|
587
|
-
• '
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
|
|
615
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
616
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
617
|
-
• 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
|
|
618
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
619
|
-
serverDocumentationLink: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. This is displayed in the Directory listing and must be publicly accessible without login. Minimum requirements for the docs page:
|
|
620
|
-
• What the connector does and its key capabilities
|
|
621
|
-
• How to connect/set it up (step by step)
|
|
622
|
-
• What each tool does (or at least the main ones)
|
|
623
|
-
• How to troubleshoot common issues
|
|
624
|
-
• A support contact or channel
|
|
625
|
-
Acceptable formats: a dedicated docs page, a help center article, a README on GitHub, or a blog post — as long as it's comprehensive. Note: Anthropic requires public documentation to be live by your publish date.`),
|
|
626
|
-
privacyPolicyUrl: z.url().describe(`URL to your privacy policy. This is mandatory and displayed in the directory listing. Missing or incomplete privacy policies result in immediate rejection. Your privacy policy must cover:
|
|
627
|
-
• What data you collect (and how)
|
|
628
|
-
• How you use the collected data
|
|
629
|
-
• Where and how long you store it
|
|
630
|
-
• Whether you share data with third parties (and who)
|
|
631
|
-
• How users can contact you about data concerns
|
|
632
|
-
The policy must be publicly accessible. If you don't have one yet, create one before submitting — there are free generators online, but make sure it accurately reflects your actual practices. If you're GDPR-compliant, your policy should reflect that.`),
|
|
633
|
-
supportChannel: supportChannelSchema.describe(`A URL or email address where users can get help with your connector. This is displayed in the Directory listing. Acceptable options:
|
|
634
|
-
• Email address (e.g. support@myapp.com)
|
|
635
|
-
• Link to a GitHub Issues page
|
|
636
|
-
• Link to a help center or support article
|
|
637
|
-
• Link to a Discord/Slack community
|
|
638
|
-
• Link to your documentation's troubleshooting section
|
|
639
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
640
|
-
testingCredentials: z.string().describe(`Provide login credentials for a test account that Anthropic reviewers can use to verify your server works end-to-end. Critical requirements:
|
|
641
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
642
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
643
|
-
• If your service uses Google OAuth or another OAuth that requires email verification, use mcp-review@anthropic.com as the account email — Anthropic has access to this inbox.
|
|
644
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
645
|
-
• If your service requires API keys instead of a password, provide those.
|
|
646
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
647
|
-
tools: z.array(toolDefinitionSchema).describe(`A comma-separated list of all tools your MCP server exposes. Use the format: tool_name (Human-Readable Name). The tool_name is the internal identifier (snake_case, max 64 characters). The Human-Readable Name is what users see.
|
|
648
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
649
|
-
Reviewers test every single tool you list here — don't list tools that don't work. Also: do not have a single catch-all tool like api_request(method, endpoint) — Anthropic rejects these. Each action should be its own purpose-built tool.`),
|
|
650
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
651
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
652
|
-
• 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
|
|
653
|
-
This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
|
|
654
|
-
testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
|
|
655
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
656
|
-
• Format: SVG only
|
|
657
|
-
• Aspect ratio: square (1:1)
|
|
658
|
-
• Should work on a light background
|
|
659
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
660
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
661
|
-
logoDark: z.string().optional().describe(`Optional dark-mode variant of the connector logo. Same specs as the light variant (SVG, square 1:1) but designed to read on a dark background. Leave empty if the light logo already works on dark.`),
|
|
662
|
-
screenshots: z.array(screenshotEntrySchema).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
|
|
663
|
-
• 3–5 images is ideal
|
|
664
|
-
• Minimum 1000px width, PNG format preferred
|
|
665
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
666
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
667
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
668
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
669
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1283
|
+
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1284
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1285
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1286
|
+
name: z.string().max(100).describe(`The public display name for your connector as it appears in the directory. Use your brand/product name. You must
|
|
1287
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1288
|
+
slug: z.string().max(50).regex(/^[a-z0-9-]+$/).describe(`URL-safe identifier for your connector's directory page. Lowercase letters, numbers, and hyphens only.
|
|
1289
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1290
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1291
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1292
|
+
description: z.string().max(2e3).describe(`A description of what your connector does and its key features, shown on the connector's detail page in
|
|
1293
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1294
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1295
|
+
iconUrl: z.url().optional().describe(`Optional custom icon for the directory listing — a square SVG. By default the favicon from your MCP URL is used
|
|
1296
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1297
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1298
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1299
|
+
by your publish date.`),
|
|
1300
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1301
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1302
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1303
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1304
|
+
screenshots: z.array(screenshotEntrySchema).optional().describe(`Carousel images shown on your connector's directory page (PNG). Each is paired with the user prompt that produced
|
|
1305
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1306
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1307
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1308
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1309
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1310
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1311
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1312
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1313
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1314
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1315
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1316
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1317
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1318
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1319
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1320
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1321
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1322
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1323
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1324
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1325
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1326
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1327
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1328
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1329
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1330
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1331
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1332
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1333
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1334
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1335
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1336
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1337
|
+
fully populated account.`),
|
|
1338
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1339
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1340
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1341
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1342
|
+
});
|
|
1343
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1344
|
+
serverUrl: z.string().optional(),
|
|
1345
|
+
name: z.string().optional(),
|
|
1346
|
+
slug: z.string().optional(),
|
|
1347
|
+
oneLiner: z.string().optional(),
|
|
1348
|
+
description: z.string().optional(),
|
|
1349
|
+
iconUrl: z.string().optional(),
|
|
1350
|
+
documentation: z.string().optional(),
|
|
1351
|
+
support: z.string().optional(),
|
|
1352
|
+
privacyPolicy: z.string().optional(),
|
|
1353
|
+
companyWebsite: z.string().optional(),
|
|
1354
|
+
primaryContactEmail: z.string().optional(),
|
|
1355
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1356
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
670
1357
|
});
|
|
671
1358
|
claudeSubmissionFormDataSchema.pick({
|
|
672
|
-
companyName: true,
|
|
673
|
-
appName: true,
|
|
674
|
-
mcpUrlType: true,
|
|
675
1359
|
serverUrl: true,
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
transportSupport: true,
|
|
1360
|
+
name: true,
|
|
1361
|
+
slug: true,
|
|
1362
|
+
companyName: true,
|
|
680
1363
|
primaryContactEmail: true,
|
|
681
1364
|
primaryContactName: true,
|
|
1365
|
+
readWriteCapabilities: true,
|
|
682
1366
|
authentication: true,
|
|
683
|
-
|
|
684
|
-
|
|
1367
|
+
apiOwnership: true,
|
|
1368
|
+
personalHealthData: true
|
|
685
1369
|
}).extend({
|
|
686
1370
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
687
|
-
|
|
1371
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1372
|
+
});
|
|
1373
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1374
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1375
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1376
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1377
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1378
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1379
|
+
});
|
|
1380
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1381
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1382
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
688
1383
|
});
|
|
689
|
-
claudeSubmissionFormDataSchema.pick({
|
|
690
|
-
tagline: true,
|
|
691
|
-
description: true,
|
|
692
|
-
category: true,
|
|
693
|
-
testCases: true
|
|
694
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
695
1384
|
const submissionMetaFieldsSchema = z.object({
|
|
696
1385
|
id: z.string(),
|
|
697
1386
|
environmentId: z.string(),
|
|
1387
|
+
auditId: z.string().nullable(),
|
|
698
1388
|
createdAt: z.coerce.date(),
|
|
699
1389
|
updatedAt: z.coerce.date()
|
|
700
1390
|
});
|
|
701
1391
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
702
1392
|
platform: z.literal("claudeai"),
|
|
703
|
-
formData:
|
|
1393
|
+
formData: claudeSubmissionDraftSchema
|
|
704
1394
|
});
|
|
705
1395
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
706
1396
|
platform: z.literal("chatgpt"),
|
|
707
|
-
formData:
|
|
1397
|
+
formData: chatgptSubmissionDraftSchema
|
|
708
1398
|
});
|
|
709
1399
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
710
|
-
z.union([
|
|
1400
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
711
1401
|
const subscriptionPlanSchema = z.enum([
|
|
712
1402
|
"pro",
|
|
713
1403
|
"business",
|
|
@@ -731,6 +1421,12 @@ z.object({
|
|
|
731
1421
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
732
1422
|
});
|
|
733
1423
|
//#endregion
|
|
1424
|
+
//#region src/auth-scope.ts
|
|
1425
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1426
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1427
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1428
|
+
const AUTH_SCOPE_USER = "user";
|
|
1429
|
+
//#endregion
|
|
734
1430
|
//#region src/schemas.ts
|
|
735
1431
|
const RESERVED_KEYS = [
|
|
736
1432
|
"_HANDLER",
|
|
@@ -766,7 +1462,10 @@ const RESERVED_KEYS = [
|
|
|
766
1462
|
"BUILD_ARG_START_COMMAND",
|
|
767
1463
|
"ALPIC_HOST",
|
|
768
1464
|
"ALPIC_CUSTOM_DOMAINS",
|
|
769
|
-
"ALPIC_INTENT_META_KEY"
|
|
1465
|
+
"ALPIC_INTENT_META_KEY",
|
|
1466
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1467
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1468
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
770
1469
|
];
|
|
771
1470
|
const environmentVariableSchema = z.object({
|
|
772
1471
|
key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
|
|
@@ -851,17 +1550,15 @@ const isValidLogTimeInput = (value) => {
|
|
|
851
1550
|
if (ms(value) !== void 0) return true;
|
|
852
1551
|
return !Number.isNaN(new Date(value).getTime());
|
|
853
1552
|
};
|
|
854
|
-
const
|
|
1553
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1554
|
+
const createEnvironmentContractV1 = base.route({
|
|
855
1555
|
path: "/v1/environments",
|
|
856
1556
|
method: "POST",
|
|
857
1557
|
summary: "Create an environment",
|
|
858
1558
|
description: "Create an environment for a project",
|
|
859
1559
|
tags: ["environments"],
|
|
860
1560
|
successDescription: "The environment has been created successfully"
|
|
861
|
-
}).errors({
|
|
862
|
-
NOT_FOUND: {},
|
|
863
|
-
BAD_REQUEST: {}
|
|
864
|
-
}).input(z.object({
|
|
1561
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
865
1562
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
866
1563
|
name: z.string().min(1).describe("The name of the environment"),
|
|
867
1564
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -870,11 +1567,11 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
870
1567
|
id: z.string(),
|
|
871
1568
|
name: z.string(),
|
|
872
1569
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
873
|
-
urls: z.array(z.
|
|
1570
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
874
1571
|
createdAt: z.coerce.date(),
|
|
875
1572
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
876
1573
|
}));
|
|
877
|
-
const getEnvironmentContractV1 =
|
|
1574
|
+
const getEnvironmentContractV1 = base.route({
|
|
878
1575
|
path: "/v1/environments/{environmentId}",
|
|
879
1576
|
method: "GET",
|
|
880
1577
|
summary: "Get an environment",
|
|
@@ -931,7 +1628,7 @@ const projectOutputSchema = z.object({
|
|
|
931
1628
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
932
1629
|
environments: z.array(environmentSchema)
|
|
933
1630
|
});
|
|
934
|
-
const getProjectContractV1 =
|
|
1631
|
+
const getProjectContractV1 = base.route({
|
|
935
1632
|
path: "/v1/projects/{projectId}",
|
|
936
1633
|
method: "GET",
|
|
937
1634
|
summary: "Get a project",
|
|
@@ -939,15 +1636,15 @@ const getProjectContractV1 = oc.route({
|
|
|
939
1636
|
tags: ["projects"],
|
|
940
1637
|
successDescription: "The project details"
|
|
941
1638
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
942
|
-
const listProjectsContractV1 =
|
|
1639
|
+
const listProjectsContractV1 = base.route({
|
|
943
1640
|
path: "/v1/projects",
|
|
944
1641
|
method: "GET",
|
|
945
1642
|
summary: "List projects",
|
|
946
1643
|
description: "List all projects for a team",
|
|
947
1644
|
tags: ["projects"],
|
|
948
1645
|
successDescription: "The list of projects"
|
|
949
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
950
|
-
const createProjectContractV1 =
|
|
1646
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1647
|
+
const createProjectContractV1 = base.route({
|
|
951
1648
|
path: "/v1/projects",
|
|
952
1649
|
method: "POST",
|
|
953
1650
|
summary: "Create a project",
|
|
@@ -956,7 +1653,7 @@ const createProjectContractV1 = oc.route({
|
|
|
956
1653
|
successDescription: "The project has been created successfully"
|
|
957
1654
|
}).errors({
|
|
958
1655
|
NOT_FOUND: {},
|
|
959
|
-
|
|
1656
|
+
FORBIDDEN: {}
|
|
960
1657
|
}).input(z.object({
|
|
961
1658
|
teamId: z.string().optional(),
|
|
962
1659
|
name: z.string().trim().min(1).max(100),
|
|
@@ -996,7 +1693,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
996
1693
|
isSecret: z.boolean(),
|
|
997
1694
|
createdAt: z.coerce.date()
|
|
998
1695
|
});
|
|
999
|
-
const listEnvironmentVariablesContractV1 =
|
|
1696
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1000
1697
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1001
1698
|
method: "GET",
|
|
1002
1699
|
summary: "List environment variables",
|
|
@@ -1004,37 +1701,31 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1004
1701
|
tags: ["environments"],
|
|
1005
1702
|
successDescription: "The list of environment variables"
|
|
1006
1703
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1007
|
-
const createEnvironmentVariablesContractV1 =
|
|
1704
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1008
1705
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1009
1706
|
method: "POST",
|
|
1010
1707
|
summary: "Add environment variables",
|
|
1011
1708
|
description: "Add one or more environment variables to an environment",
|
|
1012
1709
|
tags: ["environments"],
|
|
1013
1710
|
successDescription: "The environment variables have been added successfully"
|
|
1014
|
-
}).errors({
|
|
1015
|
-
NOT_FOUND: {},
|
|
1016
|
-
BAD_REQUEST: {}
|
|
1017
|
-
}).input(z.object({
|
|
1711
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1018
1712
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1019
1713
|
environmentVariables: environmentVariablesSchema
|
|
1020
1714
|
})).output(z.object({ success: z.literal(true) }));
|
|
1021
|
-
const updateEnvironmentVariableContractV1 =
|
|
1715
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1022
1716
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1023
1717
|
method: "PATCH",
|
|
1024
1718
|
summary: "Update an environment variable",
|
|
1025
1719
|
description: "Update an environment variable by ID",
|
|
1026
1720
|
tags: ["environments"],
|
|
1027
1721
|
successDescription: "The environment variable has been updated successfully"
|
|
1028
|
-
}).errors({
|
|
1029
|
-
NOT_FOUND: {},
|
|
1030
|
-
BAD_REQUEST: {}
|
|
1031
|
-
}).input(z.object({
|
|
1722
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1032
1723
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1033
1724
|
key: environmentVariableSchema.shape.key,
|
|
1034
1725
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1035
1726
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1036
1727
|
})).output(z.object({ success: z.literal(true) }));
|
|
1037
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1728
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1038
1729
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1039
1730
|
method: "DELETE",
|
|
1040
1731
|
summary: "Delete an environment variable",
|
|
@@ -1042,7 +1733,7 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
1042
1733
|
tags: ["environments"],
|
|
1043
1734
|
successDescription: "The environment variable has been deleted successfully"
|
|
1044
1735
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1045
|
-
const deleteProjectContractV1 =
|
|
1736
|
+
const deleteProjectContractV1 = base.route({
|
|
1046
1737
|
path: "/v1/projects/{projectId}",
|
|
1047
1738
|
method: "DELETE",
|
|
1048
1739
|
summary: "Delete a project",
|
|
@@ -1050,7 +1741,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1050
1741
|
tags: ["projects"],
|
|
1051
1742
|
successDescription: "The project has been deleted successfully"
|
|
1052
1743
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1053
|
-
const updateProjectContractV1 =
|
|
1744
|
+
const updateProjectContractV1 = base.route({
|
|
1054
1745
|
path: "/v1/projects/{projectId}",
|
|
1055
1746
|
method: "PATCH",
|
|
1056
1747
|
summary: "Update a project",
|
|
@@ -1059,13 +1750,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1059
1750
|
successDescription: "The project has been updated successfully"
|
|
1060
1751
|
}).errors({
|
|
1061
1752
|
NOT_FOUND: {},
|
|
1062
|
-
|
|
1753
|
+
FORBIDDEN: {}
|
|
1063
1754
|
}).input(z.object({
|
|
1064
1755
|
projectId: z.string().describe("The ID of the project"),
|
|
1065
1756
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1066
1757
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1067
1758
|
})).output(projectOutputSchema);
|
|
1068
|
-
const deployEnvironmentContractV1 =
|
|
1759
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1069
1760
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1070
1761
|
method: "POST",
|
|
1071
1762
|
summary: "Deploy an environment",
|
|
@@ -1074,24 +1765,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1074
1765
|
successDescription: "The environment has been deployed successfully"
|
|
1075
1766
|
}).errors({
|
|
1076
1767
|
NOT_FOUND: {},
|
|
1077
|
-
|
|
1768
|
+
CONFLICT: {}
|
|
1078
1769
|
}).input(z.object({
|
|
1079
1770
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1080
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1771
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1772
|
+
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1081
1773
|
})).output(deploymentSchema);
|
|
1082
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1774
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1083
1775
|
path: "/v1/deployments/upload",
|
|
1084
1776
|
method: "POST",
|
|
1085
1777
|
summary: "Upload deployment artifacts",
|
|
1086
1778
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1087
1779
|
tags: ["deployments"],
|
|
1088
1780
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1089
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1781
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1090
1782
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1091
1783
|
token: z.string().describe("Token to identify the source archive"),
|
|
1092
1784
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1093
1785
|
}));
|
|
1094
|
-
const listDeploymentsContractV1 =
|
|
1786
|
+
const listDeploymentsContractV1 = base.route({
|
|
1095
1787
|
path: "/v1/projects/{projectId}/deployments",
|
|
1096
1788
|
method: "GET",
|
|
1097
1789
|
summary: "List project deployments",
|
|
@@ -1103,7 +1795,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1103
1795
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1104
1796
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1105
1797
|
})).output(z.array(deploymentSchema));
|
|
1106
|
-
const getDeploymentContractV1 =
|
|
1798
|
+
const getDeploymentContractV1 = base.route({
|
|
1107
1799
|
path: "/v1/deployments/{deploymentId}",
|
|
1108
1800
|
method: "GET",
|
|
1109
1801
|
summary: "Get a deployment",
|
|
@@ -1111,17 +1803,29 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1111
1803
|
tags: ["deployments"],
|
|
1112
1804
|
successDescription: "The deployment details"
|
|
1113
1805
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1114
|
-
const
|
|
1806
|
+
const logEntrySchema = z.object({
|
|
1807
|
+
timestamp: z.coerce.date(),
|
|
1808
|
+
type: z.enum([
|
|
1809
|
+
"START",
|
|
1810
|
+
"END",
|
|
1811
|
+
"INFO",
|
|
1812
|
+
"ERROR",
|
|
1813
|
+
"WARNING",
|
|
1814
|
+
"DEBUG"
|
|
1815
|
+
]),
|
|
1816
|
+
requestId: z.string(),
|
|
1817
|
+
content: z.string().optional(),
|
|
1818
|
+
method: z.string().optional(),
|
|
1819
|
+
durationInMs: z.number().optional()
|
|
1820
|
+
});
|
|
1821
|
+
const getLogsContractV1 = base.route({
|
|
1115
1822
|
path: "/v1/environments/{environmentId}/logs",
|
|
1116
1823
|
method: "GET",
|
|
1117
1824
|
summary: "Get logs",
|
|
1118
1825
|
description: "Get logs for an environment",
|
|
1119
1826
|
tags: ["environments"],
|
|
1120
1827
|
successDescription: "The logs"
|
|
1121
|
-
}).errors({
|
|
1122
|
-
NOT_FOUND: {},
|
|
1123
|
-
BAD_REQUEST: {}
|
|
1124
|
-
}).input(z.object({
|
|
1828
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1125
1829
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1126
1830
|
since: z.string().refine(isValidLogTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." }).optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1127
1831
|
until: z.string().refine(isValidLogTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." }).optional().describe("End time — ISO 8601 or relative"),
|
|
@@ -1135,34 +1839,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1135
1839
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1136
1840
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1137
1841
|
})).output(z.object({
|
|
1138
|
-
logs: z.array(
|
|
1139
|
-
timestamp: z.coerce.date(),
|
|
1140
|
-
type: z.enum([
|
|
1141
|
-
"START",
|
|
1142
|
-
"END",
|
|
1143
|
-
"INFO",
|
|
1144
|
-
"ERROR",
|
|
1145
|
-
"WARNING",
|
|
1146
|
-
"DEBUG"
|
|
1147
|
-
]),
|
|
1148
|
-
requestId: z.string(),
|
|
1149
|
-
content: z.string().optional(),
|
|
1150
|
-
method: z.string().optional(),
|
|
1151
|
-
durationInMs: z.number().optional()
|
|
1152
|
-
})),
|
|
1842
|
+
logs: z.array(logEntrySchema),
|
|
1153
1843
|
nextToken: z.string().nullable()
|
|
1154
1844
|
}));
|
|
1155
|
-
const getLatestLogsContractV1 =
|
|
1845
|
+
const getLatestLogsContractV1 = base.route({
|
|
1156
1846
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1157
1847
|
method: "GET",
|
|
1158
1848
|
summary: "Get latest logs",
|
|
1159
1849
|
description: "Get the N most recent logs for an environment",
|
|
1160
1850
|
tags: ["environments"],
|
|
1161
1851
|
successDescription: "The latest logs"
|
|
1162
|
-
}).errors({
|
|
1163
|
-
NOT_FOUND: {},
|
|
1164
|
-
BAD_REQUEST: {}
|
|
1165
|
-
}).input(z.object({
|
|
1852
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1166
1853
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1167
1854
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1168
1855
|
level: z.array(z.enum([
|
|
@@ -1172,22 +1859,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1172
1859
|
"DEBUG"
|
|
1173
1860
|
])).optional().describe("Filter by log level"),
|
|
1174
1861
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1175
|
-
})).output(z.object({ logs: z.array(
|
|
1176
|
-
|
|
1177
|
-
type: z.enum([
|
|
1178
|
-
"START",
|
|
1179
|
-
"END",
|
|
1180
|
-
"INFO",
|
|
1181
|
-
"ERROR",
|
|
1182
|
-
"WARNING",
|
|
1183
|
-
"DEBUG"
|
|
1184
|
-
]),
|
|
1185
|
-
requestId: z.string(),
|
|
1186
|
-
content: z.string().optional(),
|
|
1187
|
-
method: z.string().optional(),
|
|
1188
|
-
durationInMs: z.number().optional()
|
|
1189
|
-
})) }));
|
|
1190
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1862
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1863
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1191
1864
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1192
1865
|
method: "GET",
|
|
1193
1866
|
summary: "Get deployment logs",
|
|
@@ -1214,17 +1887,14 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1214
1887
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1215
1888
|
task_count: z.array(analyticsDataPointSchema)
|
|
1216
1889
|
});
|
|
1217
|
-
const getProjectAnalyticsContractV1 =
|
|
1890
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1218
1891
|
path: "/v1/analytics/{projectId}",
|
|
1219
1892
|
method: "GET",
|
|
1220
1893
|
summary: "Get project analytics",
|
|
1221
1894
|
description: "Get analytics data for a project over a time range",
|
|
1222
1895
|
tags: ["analytics"],
|
|
1223
1896
|
successDescription: "The project analytics data"
|
|
1224
|
-
}).errors({
|
|
1225
|
-
NOT_FOUND: {},
|
|
1226
|
-
BAD_REQUEST: {}
|
|
1227
|
-
}).input(z.object({
|
|
1897
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1228
1898
|
projectId: z.string().describe("The ID of the project"),
|
|
1229
1899
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1230
1900
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
@@ -1239,7 +1909,7 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1239
1909
|
}),
|
|
1240
1910
|
timeSeries: analyticsTimeSeriesSchema
|
|
1241
1911
|
}));
|
|
1242
|
-
const listTeamsContractV1 =
|
|
1912
|
+
const listTeamsContractV1 = base.route({
|
|
1243
1913
|
path: "/v1/teams",
|
|
1244
1914
|
method: "GET",
|
|
1245
1915
|
summary: "List teams",
|
|
@@ -1252,28 +1922,25 @@ const listTeamsContractV1 = oc.route({
|
|
|
1252
1922
|
createdAt: z.coerce.date(),
|
|
1253
1923
|
hasStripeAccount: z.boolean()
|
|
1254
1924
|
})));
|
|
1255
|
-
const getTunnelTicketContractV1 =
|
|
1925
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1256
1926
|
path: "/v1/tunnels/ticket",
|
|
1257
1927
|
method: "GET",
|
|
1258
1928
|
summary: "Get a tunnel ticket",
|
|
1259
1929
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1260
1930
|
tags: ["tunnels"],
|
|
1261
1931
|
successDescription: "The tunnel ticket"
|
|
1262
|
-
}).output(z.object({
|
|
1932
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1263
1933
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1264
1934
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1265
1935
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1266
1936
|
}));
|
|
1267
|
-
const publishServerContractV1 =
|
|
1937
|
+
const publishServerContractV1 = base.route({
|
|
1268
1938
|
path: "/v1/distribution/publish",
|
|
1269
1939
|
method: "POST",
|
|
1270
1940
|
summary: "Publish a server to the MCP registry",
|
|
1271
1941
|
tags: ["distribution"],
|
|
1272
1942
|
successDescription: "The server has been published successfully"
|
|
1273
|
-
}).errors({
|
|
1274
|
-
NOT_FOUND: {},
|
|
1275
|
-
BAD_REQUEST: {}
|
|
1276
|
-
}).input(z.object({
|
|
1943
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1277
1944
|
projectId: z.string(),
|
|
1278
1945
|
domain: z.string(),
|
|
1279
1946
|
title: z.string().min(1).max(100),
|
|
@@ -1282,17 +1949,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1282
1949
|
iconSrc: z.url().max(255).optional(),
|
|
1283
1950
|
dryRun: z.boolean().optional()
|
|
1284
1951
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1285
|
-
const getServerInfoContractV1 =
|
|
1952
|
+
const getServerInfoContractV1 = base.route({
|
|
1286
1953
|
path: "/v1/distribution/get",
|
|
1287
1954
|
method: "GET",
|
|
1288
1955
|
summary: "Get server info",
|
|
1289
1956
|
description: "Get info about a server",
|
|
1290
1957
|
tags: ["distribution"],
|
|
1291
1958
|
successDescription: "The server info"
|
|
1292
|
-
}).errors({
|
|
1293
|
-
NOT_FOUND: {},
|
|
1294
|
-
BAD_REQUEST: {}
|
|
1295
|
-
}).input(z.object({
|
|
1959
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1296
1960
|
projectId: z.string(),
|
|
1297
1961
|
domain: z.string()
|
|
1298
1962
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1311,7 +1975,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1311
1975
|
isPlaygroundEnabled: z.boolean(),
|
|
1312
1976
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1313
1977
|
});
|
|
1314
|
-
const getPlaygroundContractV1 =
|
|
1978
|
+
const getPlaygroundContractV1 = base.route({
|
|
1315
1979
|
path: "/v1/environments/{environmentId}/playground",
|
|
1316
1980
|
method: "GET",
|
|
1317
1981
|
summary: "Get playground configuration",
|
|
@@ -1319,25 +1983,22 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1319
1983
|
tags: ["environments"],
|
|
1320
1984
|
successDescription: "The playground configuration"
|
|
1321
1985
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1322
|
-
const upsertPlaygroundContractV1 =
|
|
1986
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1323
1987
|
path: "/v1/environments/{environmentId}/playground",
|
|
1324
1988
|
method: "PUT",
|
|
1325
1989
|
summary: "Update playground configuration",
|
|
1326
1990
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1327
1991
|
tags: ["environments"],
|
|
1328
1992
|
successDescription: "The updated playground configuration"
|
|
1329
|
-
}).errors({
|
|
1330
|
-
NOT_FOUND: {},
|
|
1331
|
-
BAD_REQUEST: {}
|
|
1332
|
-
}).input(z.object({
|
|
1993
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1333
1994
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1334
1995
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1335
1996
|
name: z.string().min(1).max(100).optional(),
|
|
1336
1997
|
description: z.string().min(1).max(500).optional(),
|
|
1337
1998
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1338
|
-
examplePrompts: z.array(playgroundExamplePromptSchema).max(
|
|
1999
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1339
2000
|
})).output(playgroundOutputSchema);
|
|
1340
|
-
const createBeaconContractV1 =
|
|
2001
|
+
const createBeaconContractV1 = base.route({
|
|
1341
2002
|
path: "/v1/beacon/audits",
|
|
1342
2003
|
method: "POST",
|
|
1343
2004
|
summary: "Create a beacon audit",
|
|
@@ -1346,7 +2007,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1346
2007
|
successDescription: "The audit has been created"
|
|
1347
2008
|
}).errors({
|
|
1348
2009
|
NOT_FOUND: {},
|
|
1349
|
-
BAD_REQUEST: {},
|
|
1350
2010
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1351
2011
|
}).input(z.object({
|
|
1352
2012
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1354,7 +2014,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1354
2014
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1355
2015
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1356
2016
|
})).output(z.object({ id: z.string() }));
|
|
1357
|
-
const getBeaconContractV1 =
|
|
2017
|
+
const getBeaconContractV1 = base.route({
|
|
1358
2018
|
path: "/v1/beacon/audits/{auditId}",
|
|
1359
2019
|
method: "GET",
|
|
1360
2020
|
summary: "Get a beacon audit",
|
|
@@ -1412,5 +2072,10 @@ const contract = {
|
|
|
1412
2072
|
get: { v1: getBeaconContractV1 }
|
|
1413
2073
|
}
|
|
1414
2074
|
};
|
|
2075
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2076
|
+
const contractForDocs = {
|
|
2077
|
+
...contract,
|
|
2078
|
+
deployments: deploymentsForDocs
|
|
2079
|
+
};
|
|
1415
2080
|
//#endregion
|
|
1416
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2081
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|