@alpic-ai/api 0.0.0-dev.gfe05e8c → 0.0.0-dev.gfe4c6ed
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 +92 -60
- package/dist/index.mjs +854 -244
- 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.29.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,117 @@ const deploymentSummarySchema = z.object({
|
|
|
98
283
|
createdAt: z.coerce.date(),
|
|
99
284
|
updatedAt: z.coerce.date()
|
|
100
285
|
});
|
|
101
|
-
|
|
286
|
+
/**
|
|
287
|
+
* Public environment
|
|
288
|
+
*
|
|
289
|
+
* Answers anonymously and exposes no OAuth metadata.
|
|
290
|
+
*/
|
|
291
|
+
const publicEnvironmentSchema = z.object({
|
|
292
|
+
allowsAnonymous: z.literal(true),
|
|
293
|
+
oAuthMetadata: z.strictObject({})
|
|
294
|
+
});
|
|
295
|
+
/**
|
|
296
|
+
* Protected environment with an external resource metadata URL
|
|
297
|
+
*
|
|
298
|
+
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
299
|
+
* Everything that follows is handled outside of the MCP server scope.
|
|
300
|
+
*/
|
|
301
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
302
|
+
allowsAnonymous: z.boolean(),
|
|
303
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
304
|
+
scope: z.string().optional()
|
|
305
|
+
});
|
|
306
|
+
/**
|
|
307
|
+
* Protected environment with an external authorization server URL
|
|
308
|
+
*
|
|
309
|
+
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
310
|
+
* An external authorization server URL is returned when requesting the endpoint.
|
|
311
|
+
* Everything that follows is handled outside of the MCP server scope.
|
|
312
|
+
*/
|
|
313
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
314
|
+
allowsAnonymous: z.boolean(),
|
|
315
|
+
oAuthMetadata: z.object({
|
|
316
|
+
externalAuthorizationServerUrl: z.url(),
|
|
317
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
318
|
+
}),
|
|
319
|
+
scope: z.string().optional()
|
|
320
|
+
});
|
|
321
|
+
/**
|
|
322
|
+
* Standalone protected environment
|
|
323
|
+
*
|
|
324
|
+
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
325
|
+
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
326
|
+
*/
|
|
327
|
+
const standaloneEnvironmentSchema = z.object({
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
329
|
+
oAuthMetadata: z.object({
|
|
330
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
331
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
332
|
+
}),
|
|
333
|
+
scope: z.string().optional()
|
|
334
|
+
});
|
|
335
|
+
/**
|
|
336
|
+
* Protected environment without OAuth discovery
|
|
337
|
+
*
|
|
338
|
+
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
339
|
+
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
340
|
+
* are advertised. Clients must obtain credentials out-of-band.
|
|
341
|
+
*/
|
|
342
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
343
|
+
allowsAnonymous: z.literal(false),
|
|
344
|
+
oAuthMetadata: z.strictObject({}),
|
|
345
|
+
scope: z.string().optional()
|
|
346
|
+
});
|
|
347
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
348
|
+
isPublic: z.literal(true),
|
|
349
|
+
oAuthMetadata: z.undefined().optional()
|
|
350
|
+
});
|
|
351
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
352
|
+
isPublic: z.literal(false),
|
|
353
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
354
|
+
scope: z.string().optional()
|
|
355
|
+
});
|
|
356
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
357
|
+
isPublic: z.literal(false),
|
|
358
|
+
oAuthMetadata: z.object({
|
|
359
|
+
externalAuthorizationServerUrl: z.url(),
|
|
360
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
361
|
+
}),
|
|
362
|
+
scope: z.string().optional()
|
|
363
|
+
});
|
|
364
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
365
|
+
isPublic: z.literal(false),
|
|
366
|
+
oAuthMetadata: z.object({
|
|
367
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
368
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
369
|
+
}),
|
|
370
|
+
scope: z.string().optional()
|
|
371
|
+
});
|
|
372
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
373
|
+
isPublic: z.literal(false),
|
|
374
|
+
oAuthMetadata: z.strictObject({}),
|
|
375
|
+
scope: z.string().optional()
|
|
376
|
+
});
|
|
377
|
+
z.union([
|
|
378
|
+
publicEnvironmentSchema,
|
|
379
|
+
externalResourceMetadataEnvironmentSchema,
|
|
380
|
+
externalAuthorizationServerEnvironmentSchema,
|
|
381
|
+
standaloneEnvironmentSchema,
|
|
382
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
383
|
+
legacyPublicEnvironmentSchema,
|
|
384
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
385
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
386
|
+
legacyStandaloneEnvironmentSchema,
|
|
387
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
388
|
+
]);
|
|
389
|
+
const playgroundModelSchema = z.enum([
|
|
390
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
391
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
392
|
+
"openai.gpt-5.4",
|
|
393
|
+
"openai.gpt-5.5"
|
|
394
|
+
]);
|
|
102
395
|
const environmentDomainSchema = z.object({
|
|
103
|
-
|
|
396
|
+
name: z.string(),
|
|
104
397
|
status: z.enum([
|
|
105
398
|
"ongoing",
|
|
106
399
|
"deployed",
|
|
@@ -118,6 +411,7 @@ const environmentSchema$1 = z.object({
|
|
|
118
411
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
119
412
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
120
413
|
isPlaygroundEnabled: z.boolean(),
|
|
414
|
+
playgroundModel: playgroundModelSchema,
|
|
121
415
|
isIpWhitelistEnabled: z.boolean(),
|
|
122
416
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
123
417
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -126,6 +420,14 @@ const environmentSchema$1 = z.object({
|
|
|
126
420
|
updatedAt: z.coerce.date()
|
|
127
421
|
});
|
|
128
422
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
423
|
+
z.object({
|
|
424
|
+
sessionReplayEnabled: z.boolean(),
|
|
425
|
+
collectRequestPayload: z.boolean(),
|
|
426
|
+
collectResponsePayload: z.boolean(),
|
|
427
|
+
collectErrorMessage: z.boolean(),
|
|
428
|
+
collectUserData: z.boolean(),
|
|
429
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
430
|
+
});
|
|
129
431
|
z.object({
|
|
130
432
|
id: z.string(),
|
|
131
433
|
createdAt: z.coerce.date(),
|
|
@@ -259,15 +561,27 @@ z.object({
|
|
|
259
561
|
environments: z.array(environmentWithDomainsSchema),
|
|
260
562
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
261
563
|
});
|
|
564
|
+
const domainFailureReasonSchema = z.enum([
|
|
565
|
+
"caa",
|
|
566
|
+
"dns",
|
|
567
|
+
"invalid_domain",
|
|
568
|
+
"other"
|
|
569
|
+
]);
|
|
570
|
+
const projectDomainMappingSchema = z.object({
|
|
571
|
+
pathPrefix: z.string(),
|
|
572
|
+
environment: environmentSchema$1
|
|
573
|
+
});
|
|
262
574
|
z.object({
|
|
263
|
-
|
|
575
|
+
name: z.string(),
|
|
264
576
|
createdAt: z.coerce.date(),
|
|
265
577
|
status: z.enum([
|
|
266
578
|
"ongoing",
|
|
267
579
|
"deployed",
|
|
268
580
|
"failed"
|
|
269
581
|
]),
|
|
270
|
-
|
|
582
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
583
|
+
environment: environmentSchema$1,
|
|
584
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
271
585
|
});
|
|
272
586
|
const serverFieldsSchema$1 = z.object({
|
|
273
587
|
$schema: z.string(),
|
|
@@ -296,6 +610,22 @@ z.object({
|
|
|
296
610
|
serverFields: serverFieldsSchema$1,
|
|
297
611
|
source: z.enum(["registry", "defaults"])
|
|
298
612
|
});
|
|
613
|
+
/**
|
|
614
|
+
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
615
|
+
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
616
|
+
*
|
|
617
|
+
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
618
|
+
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
619
|
+
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
620
|
+
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
621
|
+
*/
|
|
622
|
+
const clampStringField = (field) => {
|
|
623
|
+
const max = field.maxLength;
|
|
624
|
+
if (max === null) return field;
|
|
625
|
+
const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
|
|
626
|
+
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
627
|
+
return field.description ? withMin.describe(field.description) : withMin;
|
|
628
|
+
};
|
|
299
629
|
const toolDefinitionSchema = z.object({
|
|
300
630
|
name: z.string(),
|
|
301
631
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -308,17 +638,20 @@ const toolDefinitionSchema = z.object({
|
|
|
308
638
|
}).optional()
|
|
309
639
|
});
|
|
310
640
|
const positiveTestCaseSchema = z.object({
|
|
311
|
-
scenario: z.string(),
|
|
312
|
-
userPrompt: z.string(),
|
|
313
|
-
toolTriggered: z.string().optional(),
|
|
314
|
-
expectedOutput: z.string().optional()
|
|
641
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
642
|
+
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."),
|
|
643
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
644
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
315
645
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
316
646
|
const screenshotEntrySchema = z.object({
|
|
317
647
|
prompt: z.string(),
|
|
318
648
|
url: z.url()
|
|
319
649
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
650
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
320
651
|
/** Accepts either a valid email or URL. */
|
|
321
652
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
653
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
654
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
322
655
|
const chatgptCategorySchema = z.enum([
|
|
323
656
|
"BUSINESS",
|
|
324
657
|
"COLLABORATION",
|
|
@@ -335,22 +668,315 @@ const chatgptCategorySchema = z.enum([
|
|
|
335
668
|
"TRAVEL"
|
|
336
669
|
]);
|
|
337
670
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
338
|
-
const
|
|
671
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
672
|
+
"AD",
|
|
673
|
+
"AE",
|
|
674
|
+
"AF",
|
|
675
|
+
"AG",
|
|
676
|
+
"AL",
|
|
677
|
+
"AM",
|
|
678
|
+
"AO",
|
|
679
|
+
"AR",
|
|
680
|
+
"AT",
|
|
681
|
+
"AU",
|
|
682
|
+
"AW",
|
|
683
|
+
"AX",
|
|
684
|
+
"AZ",
|
|
685
|
+
"BA",
|
|
686
|
+
"BB",
|
|
687
|
+
"BD",
|
|
688
|
+
"BE",
|
|
689
|
+
"BF",
|
|
690
|
+
"BG",
|
|
691
|
+
"BH",
|
|
692
|
+
"BI",
|
|
693
|
+
"BJ",
|
|
694
|
+
"BL",
|
|
695
|
+
"BM",
|
|
696
|
+
"BN",
|
|
697
|
+
"BO",
|
|
698
|
+
"BR",
|
|
699
|
+
"BS",
|
|
700
|
+
"BT",
|
|
701
|
+
"BW",
|
|
702
|
+
"BZ",
|
|
703
|
+
"CA",
|
|
704
|
+
"CD",
|
|
705
|
+
"CF",
|
|
706
|
+
"CG",
|
|
707
|
+
"CH",
|
|
708
|
+
"CI",
|
|
709
|
+
"CL",
|
|
710
|
+
"CM",
|
|
711
|
+
"CO",
|
|
712
|
+
"CR",
|
|
713
|
+
"CV",
|
|
714
|
+
"CY",
|
|
715
|
+
"CZ",
|
|
716
|
+
"DE",
|
|
717
|
+
"DJ",
|
|
718
|
+
"DK",
|
|
719
|
+
"DM",
|
|
720
|
+
"DO",
|
|
721
|
+
"DZ",
|
|
722
|
+
"EC",
|
|
723
|
+
"EE",
|
|
724
|
+
"EG",
|
|
725
|
+
"ER",
|
|
726
|
+
"ES",
|
|
727
|
+
"ET",
|
|
728
|
+
"FI",
|
|
729
|
+
"FJ",
|
|
730
|
+
"FM",
|
|
731
|
+
"FO",
|
|
732
|
+
"FR",
|
|
733
|
+
"GA",
|
|
734
|
+
"GB",
|
|
735
|
+
"GD",
|
|
736
|
+
"GE",
|
|
737
|
+
"GF",
|
|
738
|
+
"GH",
|
|
739
|
+
"GL",
|
|
740
|
+
"GM",
|
|
741
|
+
"GN",
|
|
742
|
+
"GP",
|
|
743
|
+
"GQ",
|
|
744
|
+
"GR",
|
|
745
|
+
"GT",
|
|
746
|
+
"GW",
|
|
747
|
+
"GY",
|
|
748
|
+
"HN",
|
|
749
|
+
"HR",
|
|
750
|
+
"HT",
|
|
751
|
+
"HU",
|
|
752
|
+
"ID",
|
|
753
|
+
"IE",
|
|
754
|
+
"IL",
|
|
755
|
+
"IN",
|
|
756
|
+
"IQ",
|
|
757
|
+
"IS",
|
|
758
|
+
"IT",
|
|
759
|
+
"JM",
|
|
760
|
+
"JO",
|
|
761
|
+
"JP",
|
|
762
|
+
"KE",
|
|
763
|
+
"KG",
|
|
764
|
+
"KH",
|
|
765
|
+
"KI",
|
|
766
|
+
"KM",
|
|
767
|
+
"KN",
|
|
768
|
+
"KR",
|
|
769
|
+
"KW",
|
|
770
|
+
"KY",
|
|
771
|
+
"KZ",
|
|
772
|
+
"LA",
|
|
773
|
+
"LB",
|
|
774
|
+
"LC",
|
|
775
|
+
"LI",
|
|
776
|
+
"LK",
|
|
777
|
+
"LR",
|
|
778
|
+
"LS",
|
|
779
|
+
"LT",
|
|
780
|
+
"LU",
|
|
781
|
+
"LV",
|
|
782
|
+
"LY",
|
|
783
|
+
"MA",
|
|
784
|
+
"MC",
|
|
785
|
+
"MD",
|
|
786
|
+
"ME",
|
|
787
|
+
"MF",
|
|
788
|
+
"MG",
|
|
789
|
+
"MH",
|
|
790
|
+
"MK",
|
|
791
|
+
"ML",
|
|
792
|
+
"MM",
|
|
793
|
+
"MN",
|
|
794
|
+
"MQ",
|
|
795
|
+
"MR",
|
|
796
|
+
"MT",
|
|
797
|
+
"MU",
|
|
798
|
+
"MV",
|
|
799
|
+
"MW",
|
|
800
|
+
"MX",
|
|
801
|
+
"MY",
|
|
802
|
+
"MZ",
|
|
803
|
+
"NA",
|
|
804
|
+
"NC",
|
|
805
|
+
"NE",
|
|
806
|
+
"NG",
|
|
807
|
+
"NI",
|
|
808
|
+
"NL",
|
|
809
|
+
"NO",
|
|
810
|
+
"NP",
|
|
811
|
+
"NR",
|
|
812
|
+
"NZ",
|
|
813
|
+
"OM",
|
|
814
|
+
"PA",
|
|
815
|
+
"PE",
|
|
816
|
+
"PF",
|
|
817
|
+
"PG",
|
|
818
|
+
"PH",
|
|
819
|
+
"PK",
|
|
820
|
+
"PL",
|
|
821
|
+
"PM",
|
|
822
|
+
"PS",
|
|
823
|
+
"PT",
|
|
824
|
+
"PW",
|
|
825
|
+
"PY",
|
|
826
|
+
"QA",
|
|
827
|
+
"RE",
|
|
828
|
+
"RO",
|
|
829
|
+
"RS",
|
|
830
|
+
"RW",
|
|
831
|
+
"SA",
|
|
832
|
+
"SB",
|
|
833
|
+
"SC",
|
|
834
|
+
"SD",
|
|
835
|
+
"SE",
|
|
836
|
+
"SG",
|
|
837
|
+
"SH",
|
|
838
|
+
"SI",
|
|
839
|
+
"SJ",
|
|
840
|
+
"SK",
|
|
841
|
+
"SL",
|
|
842
|
+
"SM",
|
|
843
|
+
"SN",
|
|
844
|
+
"SO",
|
|
845
|
+
"SR",
|
|
846
|
+
"SS",
|
|
847
|
+
"ST",
|
|
848
|
+
"SV",
|
|
849
|
+
"SZ",
|
|
850
|
+
"TD",
|
|
851
|
+
"TF",
|
|
852
|
+
"TG",
|
|
853
|
+
"TH",
|
|
854
|
+
"TJ",
|
|
855
|
+
"TL",
|
|
856
|
+
"TM",
|
|
857
|
+
"TN",
|
|
858
|
+
"TO",
|
|
859
|
+
"TR",
|
|
860
|
+
"TT",
|
|
861
|
+
"TV",
|
|
862
|
+
"TW",
|
|
863
|
+
"TZ",
|
|
864
|
+
"UA",
|
|
865
|
+
"UG",
|
|
866
|
+
"US",
|
|
867
|
+
"UY",
|
|
868
|
+
"UZ",
|
|
869
|
+
"VA",
|
|
870
|
+
"VC",
|
|
871
|
+
"VN",
|
|
872
|
+
"VU",
|
|
873
|
+
"WF",
|
|
874
|
+
"WS",
|
|
875
|
+
"YE",
|
|
876
|
+
"YT",
|
|
877
|
+
"ZA",
|
|
878
|
+
"ZM",
|
|
879
|
+
"ZW"
|
|
880
|
+
]);
|
|
881
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
882
|
+
z.object({ mode: z.literal("all") }),
|
|
883
|
+
z.object({
|
|
884
|
+
mode: z.literal("allow"),
|
|
885
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
886
|
+
}),
|
|
887
|
+
z.object({
|
|
888
|
+
mode: z.literal("block"),
|
|
889
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
890
|
+
})
|
|
891
|
+
]);
|
|
892
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
893
|
+
"am",
|
|
894
|
+
"ar",
|
|
895
|
+
"bg-BG",
|
|
896
|
+
"bn-BD",
|
|
897
|
+
"bs-BA",
|
|
898
|
+
"ca-ES",
|
|
899
|
+
"cs-CZ",
|
|
900
|
+
"da-DK",
|
|
901
|
+
"de-DE",
|
|
902
|
+
"el-GR",
|
|
903
|
+
"es-419",
|
|
904
|
+
"es-ES",
|
|
905
|
+
"et-EE",
|
|
906
|
+
"fi-FI",
|
|
907
|
+
"fr-CA",
|
|
908
|
+
"fr-FR",
|
|
909
|
+
"gu-IN",
|
|
910
|
+
"hi-IN",
|
|
911
|
+
"hr-HR",
|
|
912
|
+
"hu-HU",
|
|
913
|
+
"hy-AM",
|
|
914
|
+
"id-ID",
|
|
915
|
+
"is-IS",
|
|
916
|
+
"it-IT",
|
|
917
|
+
"ja-JP",
|
|
918
|
+
"ka-GE",
|
|
919
|
+
"kk",
|
|
920
|
+
"kn-IN",
|
|
921
|
+
"ko-KR",
|
|
922
|
+
"lt",
|
|
923
|
+
"lv-LV",
|
|
924
|
+
"mk-MK",
|
|
925
|
+
"ml",
|
|
926
|
+
"mn",
|
|
927
|
+
"mr-IN",
|
|
928
|
+
"ms-MY",
|
|
929
|
+
"my-MM",
|
|
930
|
+
"nb-NO",
|
|
931
|
+
"nl-NL",
|
|
932
|
+
"pa",
|
|
933
|
+
"pl-PL",
|
|
934
|
+
"pt-BR",
|
|
935
|
+
"pt-PT",
|
|
936
|
+
"ro-RO",
|
|
937
|
+
"ru-RU",
|
|
938
|
+
"sk-SK",
|
|
939
|
+
"sl-SI",
|
|
940
|
+
"so-SO",
|
|
941
|
+
"sq-AL",
|
|
942
|
+
"sr-RS",
|
|
943
|
+
"sv-SE",
|
|
944
|
+
"sw-TZ",
|
|
945
|
+
"ta-IN",
|
|
946
|
+
"te-IN",
|
|
947
|
+
"th-TH",
|
|
948
|
+
"tl",
|
|
949
|
+
"tr-TR",
|
|
950
|
+
"uk-UA",
|
|
951
|
+
"ur",
|
|
952
|
+
"vi-VN",
|
|
953
|
+
"zh-CN",
|
|
954
|
+
"zh-HK",
|
|
955
|
+
"zh-TW"
|
|
956
|
+
]);
|
|
339
957
|
const negativeTestCaseSchema = z.object({
|
|
340
958
|
scenario: z.string(),
|
|
341
959
|
userPrompt: z.string()
|
|
342
960
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
343
961
|
const chatgptToolJustificationSchema = z.object({
|
|
344
962
|
toolName: z.string(),
|
|
345
|
-
readOnlyJustification: z.string(),
|
|
346
|
-
openWorldJustification: z.string(),
|
|
347
|
-
destructiveJustification: z.string()
|
|
348
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
963
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
964
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
965
|
+
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.\"")
|
|
966
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
967
|
+
/**
|
|
968
|
+
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
969
|
+
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
970
|
+
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
971
|
+
*/
|
|
972
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
973
|
+
const chatgptDescriptionSchema = z.string();
|
|
349
974
|
const chatgptTranslationSchema = z.object({
|
|
350
|
-
locale:
|
|
351
|
-
tagline:
|
|
352
|
-
description:
|
|
975
|
+
locale: chatgptTranslationLocaleSchema,
|
|
976
|
+
tagline: chatgptTaglineSchema,
|
|
977
|
+
description: chatgptDescriptionSchema
|
|
353
978
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
979
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
354
980
|
/**
|
|
355
981
|
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
356
982
|
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
@@ -359,27 +985,38 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
359
985
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
360
986
|
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."),
|
|
361
987
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
362
|
-
tagline:
|
|
363
|
-
description:
|
|
988
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
989
|
+
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)."),
|
|
364
990
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
365
991
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
366
|
-
companyUrl:
|
|
992
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
367
993
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
368
|
-
privacyPolicyUrl:
|
|
369
|
-
termsOfServiceUrl:
|
|
370
|
-
demoRecordingUrl:
|
|
994
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
995
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
996
|
+
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."),
|
|
371
997
|
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."),
|
|
372
|
-
serverUrl:
|
|
998
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
373
999
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
374
1000
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
375
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
376
|
-
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output.
|
|
377
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases
|
|
378
|
-
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
|
|
1001
|
+
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."),
|
|
1002
|
+
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."),
|
|
1003
|
+
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."),
|
|
1004
|
+
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."),
|
|
379
1005
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
380
|
-
allowedCountries: chatgptAllowedCountriesSchema.describe("
|
|
1006
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
381
1007
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
382
1008
|
});
|
|
1009
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1010
|
+
tagline: z.string().optional(),
|
|
1011
|
+
companyUrl: z.string().optional(),
|
|
1012
|
+
supportChannel: z.string().optional(),
|
|
1013
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1014
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1015
|
+
demoRecordingUrl: z.string().optional(),
|
|
1016
|
+
serverUrl: z.string().optional(),
|
|
1017
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1018
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1019
|
+
});
|
|
383
1020
|
chatgptSubmissionFormDataSchema.pick({
|
|
384
1021
|
appName: true,
|
|
385
1022
|
developerName: true,
|
|
@@ -394,9 +1031,9 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
394
1031
|
testCases: true,
|
|
395
1032
|
negativeTestCases: true,
|
|
396
1033
|
toolJustifications: true
|
|
397
|
-
});
|
|
1034
|
+
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
398
1035
|
const claudeCategorySchema = z.enum([
|
|
399
|
-
"
|
|
1036
|
+
"Productivity",
|
|
400
1037
|
"Communication",
|
|
401
1038
|
"Data & Analytics",
|
|
402
1039
|
"Development tools",
|
|
@@ -404,207 +1041,171 @@ const claudeCategorySchema = z.enum([
|
|
|
404
1041
|
"Consumer Health",
|
|
405
1042
|
"Health & Life Sciences",
|
|
406
1043
|
"Media & Entertainment",
|
|
407
|
-
"Commerce & Shopping"
|
|
1044
|
+
"Commerce & Shopping",
|
|
1045
|
+
"Legal",
|
|
1046
|
+
"Sales and marketing",
|
|
1047
|
+
"Creative",
|
|
1048
|
+
"Nonprofit",
|
|
1049
|
+
"Education",
|
|
1050
|
+
"Other"
|
|
408
1051
|
]);
|
|
409
|
-
|
|
410
|
-
"No auth needed",
|
|
411
|
-
"OAuth 2.0",
|
|
412
|
-
"Custom URL"
|
|
413
|
-
]);
|
|
414
|
-
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
415
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1052
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
416
1053
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
417
|
-
"
|
|
418
|
-
"
|
|
419
|
-
"
|
|
1054
|
+
"read_only",
|
|
1055
|
+
"write_only",
|
|
1056
|
+
"read_write"
|
|
420
1057
|
]);
|
|
421
|
-
const
|
|
422
|
-
|
|
423
|
-
"
|
|
424
|
-
"
|
|
425
|
-
"
|
|
426
|
-
"
|
|
427
|
-
"N/A"
|
|
1058
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1059
|
+
"oauth_dcr",
|
|
1060
|
+
"oauth_cimd",
|
|
1061
|
+
"oauth_anthropic_creds",
|
|
1062
|
+
"custom_connection",
|
|
1063
|
+
"none"
|
|
428
1064
|
]);
|
|
429
|
-
const
|
|
430
|
-
"
|
|
431
|
-
"
|
|
432
|
-
"
|
|
433
|
-
"GDPR compliant (if applicable)"
|
|
1065
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1066
|
+
"first_party",
|
|
1067
|
+
"proxied",
|
|
1068
|
+
"third_party"
|
|
434
1069
|
]);
|
|
435
|
-
const
|
|
436
|
-
|
|
437
|
-
"
|
|
438
|
-
"
|
|
1070
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1071
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1072
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1073
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1074
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1075
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1076
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1077
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1078
|
+
"Public documentation for this connector will be live by the publish date."
|
|
439
1079
|
]);
|
|
440
1080
|
/**
|
|
441
|
-
* Field order mirrors the
|
|
442
|
-
*
|
|
1081
|
+
* Field order mirrors the claude.ai directory submission wizard
|
|
1082
|
+
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1083
|
+
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
443
1084
|
*/
|
|
444
1085
|
const claudeSubmissionFormDataSchema = z.object({
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
(
|
|
455
|
-
|
|
456
|
-
(
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
•
|
|
474
|
-
•
|
|
475
|
-
•
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
• '
|
|
491
|
-
• '
|
|
492
|
-
• '
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
520
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
521
|
-
• '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.
|
|
522
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
523
|
-
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:
|
|
524
|
-
• What the connector does and its key capabilities
|
|
525
|
-
• How to connect/set it up (step by step)
|
|
526
|
-
• What each tool does (or at least the main ones)
|
|
527
|
-
• How to troubleshoot common issues
|
|
528
|
-
• A support contact or channel
|
|
529
|
-
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.`),
|
|
530
|
-
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:
|
|
531
|
-
• What data you collect (and how)
|
|
532
|
-
• How you use the collected data
|
|
533
|
-
• Where and how long you store it
|
|
534
|
-
• Whether you share data with third parties (and who)
|
|
535
|
-
• How users can contact you about data concerns
|
|
536
|
-
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.`),
|
|
537
|
-
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:
|
|
538
|
-
• Email address (e.g. support@myapp.com)
|
|
539
|
-
• Link to a GitHub Issues page
|
|
540
|
-
• Link to a help center or support article
|
|
541
|
-
• Link to a Discord/Slack community
|
|
542
|
-
• Link to your documentation's troubleshooting section
|
|
543
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
544
|
-
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:
|
|
545
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
546
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
547
|
-
• 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.
|
|
548
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
549
|
-
• If your service requires API keys instead of a password, provide those.
|
|
550
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
551
|
-
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.
|
|
552
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
553
|
-
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.`),
|
|
554
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
555
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
556
|
-
• '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).
|
|
557
|
-
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.`),
|
|
558
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
559
|
-
• Format: SVG only
|
|
560
|
-
• Aspect ratio: square (1:1)
|
|
561
|
-
• Should work on a light background
|
|
562
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
563
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
564
|
-
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.`),
|
|
565
|
-
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:
|
|
566
|
-
• 3–5 images is ideal
|
|
567
|
-
• Minimum 1000px width, PNG format preferred
|
|
568
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
569
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
570
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
571
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
572
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1086
|
+
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
|
|
1087
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1088
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1089
|
+
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
|
|
1090
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1091
|
+
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.
|
|
1092
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1093
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1094
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1095
|
+
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
|
|
1096
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1097
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1098
|
+
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
|
|
1099
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1100
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1101
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1102
|
+
by your publish date.`),
|
|
1103
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1104
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1105
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1106
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1107
|
+
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
|
|
1108
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1109
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1110
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1111
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1112
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1113
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1114
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1115
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1116
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1117
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1118
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1119
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1120
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1121
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1122
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1123
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1124
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1125
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1126
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1127
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1128
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1129
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1130
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1131
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1132
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1133
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1134
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1135
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1136
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1137
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1138
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1139
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1140
|
+
fully populated account.`),
|
|
1141
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1142
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1143
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1144
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1145
|
+
});
|
|
1146
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1147
|
+
serverUrl: z.string().optional(),
|
|
1148
|
+
name: z.string().optional(),
|
|
1149
|
+
slug: z.string().optional(),
|
|
1150
|
+
oneLiner: z.string().optional(),
|
|
1151
|
+
description: z.string().optional(),
|
|
1152
|
+
iconUrl: z.string().optional(),
|
|
1153
|
+
documentation: z.string().optional(),
|
|
1154
|
+
support: z.string().optional(),
|
|
1155
|
+
privacyPolicy: z.string().optional(),
|
|
1156
|
+
companyWebsite: z.string().optional(),
|
|
1157
|
+
primaryContactEmail: z.string().optional(),
|
|
1158
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1159
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
573
1160
|
});
|
|
574
1161
|
claudeSubmissionFormDataSchema.pick({
|
|
575
|
-
companyName: true,
|
|
576
|
-
appName: true,
|
|
577
|
-
mcpUrlType: true,
|
|
578
1162
|
serverUrl: true,
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
transportSupport: true,
|
|
1163
|
+
name: true,
|
|
1164
|
+
slug: true,
|
|
1165
|
+
companyName: true,
|
|
583
1166
|
primaryContactEmail: true,
|
|
584
|
-
primaryContactName: true
|
|
1167
|
+
primaryContactName: true,
|
|
1168
|
+
readWriteCapabilities: true,
|
|
1169
|
+
authentication: true,
|
|
1170
|
+
apiOwnership: true,
|
|
1171
|
+
personalHealthData: true
|
|
1172
|
+
}).extend({
|
|
1173
|
+
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1174
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
585
1175
|
});
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
1176
|
+
/**
|
|
1177
|
+
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1178
|
+
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1179
|
+
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1180
|
+
* colocated with the Claude contract.
|
|
1181
|
+
*/
|
|
1182
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1183
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1184
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1185
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1186
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1187
|
+
});
|
|
1188
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1189
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1190
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
591
1191
|
});
|
|
592
1192
|
const submissionMetaFieldsSchema = z.object({
|
|
593
1193
|
id: z.string(),
|
|
594
1194
|
environmentId: z.string(),
|
|
1195
|
+
auditId: z.string().nullable(),
|
|
595
1196
|
createdAt: z.coerce.date(),
|
|
596
1197
|
updatedAt: z.coerce.date()
|
|
597
1198
|
});
|
|
598
1199
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
599
1200
|
platform: z.literal("claudeai"),
|
|
600
|
-
formData:
|
|
1201
|
+
formData: claudeSubmissionDraftSchema
|
|
601
1202
|
});
|
|
602
1203
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
603
1204
|
platform: z.literal("chatgpt"),
|
|
604
|
-
formData:
|
|
1205
|
+
formData: chatgptSubmissionDraftSchema
|
|
605
1206
|
});
|
|
606
1207
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
607
|
-
z.union([
|
|
1208
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
608
1209
|
const subscriptionPlanSchema = z.enum([
|
|
609
1210
|
"pro",
|
|
610
1211
|
"business",
|
|
@@ -628,6 +1229,12 @@ z.object({
|
|
|
628
1229
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
629
1230
|
});
|
|
630
1231
|
//#endregion
|
|
1232
|
+
//#region src/auth-scope.ts
|
|
1233
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1234
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1235
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1236
|
+
const AUTH_SCOPE_USER = "user";
|
|
1237
|
+
//#endregion
|
|
631
1238
|
//#region src/schemas.ts
|
|
632
1239
|
const RESERVED_KEYS = [
|
|
633
1240
|
"_HANDLER",
|
|
@@ -663,7 +1270,10 @@ const RESERVED_KEYS = [
|
|
|
663
1270
|
"BUILD_ARG_START_COMMAND",
|
|
664
1271
|
"ALPIC_HOST",
|
|
665
1272
|
"ALPIC_CUSTOM_DOMAINS",
|
|
666
|
-
"ALPIC_INTENT_META_KEY"
|
|
1273
|
+
"ALPIC_INTENT_META_KEY",
|
|
1274
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1275
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1276
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
667
1277
|
];
|
|
668
1278
|
const environmentVariableSchema = z.object({
|
|
669
1279
|
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"),
|
|
@@ -767,7 +1377,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
767
1377
|
id: z.string(),
|
|
768
1378
|
name: z.string(),
|
|
769
1379
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
770
|
-
urls: z.array(z.
|
|
1380
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
771
1381
|
createdAt: z.coerce.date(),
|
|
772
1382
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
773
1383
|
}));
|
|
@@ -843,6 +1453,9 @@ const listProjectsContractV1 = oc.route({
|
|
|
843
1453
|
description: "List all projects for a team",
|
|
844
1454
|
tags: ["projects"],
|
|
845
1455
|
successDescription: "The list of projects"
|
|
1456
|
+
}).errors({
|
|
1457
|
+
NOT_FOUND: {},
|
|
1458
|
+
BAD_REQUEST: {}
|
|
846
1459
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
847
1460
|
const createProjectContractV1 = oc.route({
|
|
848
1461
|
path: "/v1/projects",
|
|
@@ -853,7 +1466,8 @@ const createProjectContractV1 = oc.route({
|
|
|
853
1466
|
successDescription: "The project has been created successfully"
|
|
854
1467
|
}).errors({
|
|
855
1468
|
NOT_FOUND: {},
|
|
856
|
-
BAD_REQUEST: {}
|
|
1469
|
+
BAD_REQUEST: {},
|
|
1470
|
+
FORBIDDEN: {}
|
|
857
1471
|
}).input(z.object({
|
|
858
1472
|
teamId: z.string().optional(),
|
|
859
1473
|
name: z.string().trim().min(1).max(100),
|
|
@@ -938,7 +1552,10 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
938
1552
|
description: "Delete an environment variable by ID",
|
|
939
1553
|
tags: ["environments"],
|
|
940
1554
|
successDescription: "The environment variable has been deleted successfully"
|
|
941
|
-
}).errors({
|
|
1555
|
+
}).errors({
|
|
1556
|
+
NOT_FOUND: {},
|
|
1557
|
+
BAD_REQUEST: {}
|
|
1558
|
+
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
942
1559
|
const deleteProjectContractV1 = oc.route({
|
|
943
1560
|
path: "/v1/projects/{projectId}",
|
|
944
1561
|
method: "DELETE",
|
|
@@ -956,7 +1573,8 @@ const updateProjectContractV1 = oc.route({
|
|
|
956
1573
|
successDescription: "The project has been updated successfully"
|
|
957
1574
|
}).errors({
|
|
958
1575
|
NOT_FOUND: {},
|
|
959
|
-
BAD_REQUEST: {}
|
|
1576
|
+
BAD_REQUEST: {},
|
|
1577
|
+
FORBIDDEN: {}
|
|
960
1578
|
}).input(z.object({
|
|
961
1579
|
projectId: z.string().describe("The ID of the project"),
|
|
962
1580
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
@@ -971,10 +1589,12 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
971
1589
|
successDescription: "The environment has been deployed successfully"
|
|
972
1590
|
}).errors({
|
|
973
1591
|
NOT_FOUND: {},
|
|
974
|
-
BAD_REQUEST: {}
|
|
1592
|
+
BAD_REQUEST: {},
|
|
1593
|
+
CONFLICT: {}
|
|
975
1594
|
}).input(z.object({
|
|
976
1595
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
977
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1596
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1597
|
+
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.")
|
|
978
1598
|
})).output(deploymentSchema);
|
|
979
1599
|
const uploadDeploymentArtifactContractV1 = oc.route({
|
|
980
1600
|
path: "/v1/deployments/upload",
|
|
@@ -983,6 +1603,9 @@ const uploadDeploymentArtifactContractV1 = oc.route({
|
|
|
983
1603
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
984
1604
|
tags: ["deployments"],
|
|
985
1605
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1606
|
+
}).errors({
|
|
1607
|
+
NOT_FOUND: {},
|
|
1608
|
+
BAD_REQUEST: {}
|
|
986
1609
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
987
1610
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
988
1611
|
token: z.string().describe("Token to identify the source archive"),
|
|
@@ -1008,6 +1631,21 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1008
1631
|
tags: ["deployments"],
|
|
1009
1632
|
successDescription: "The deployment details"
|
|
1010
1633
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1634
|
+
const logEntrySchema = z.object({
|
|
1635
|
+
timestamp: z.coerce.date(),
|
|
1636
|
+
type: z.enum([
|
|
1637
|
+
"START",
|
|
1638
|
+
"END",
|
|
1639
|
+
"INFO",
|
|
1640
|
+
"ERROR",
|
|
1641
|
+
"WARNING",
|
|
1642
|
+
"DEBUG"
|
|
1643
|
+
]),
|
|
1644
|
+
requestId: z.string(),
|
|
1645
|
+
content: z.string().optional(),
|
|
1646
|
+
method: z.string().optional(),
|
|
1647
|
+
durationInMs: z.number().optional()
|
|
1648
|
+
});
|
|
1011
1649
|
const getLogsContractV1 = oc.route({
|
|
1012
1650
|
path: "/v1/environments/{environmentId}/logs",
|
|
1013
1651
|
method: "GET",
|
|
@@ -1032,21 +1670,7 @@ const getLogsContractV1 = oc.route({
|
|
|
1032
1670
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1033
1671
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1034
1672
|
})).output(z.object({
|
|
1035
|
-
logs: z.array(
|
|
1036
|
-
timestamp: z.coerce.date(),
|
|
1037
|
-
type: z.enum([
|
|
1038
|
-
"START",
|
|
1039
|
-
"END",
|
|
1040
|
-
"INFO",
|
|
1041
|
-
"ERROR",
|
|
1042
|
-
"WARNING",
|
|
1043
|
-
"DEBUG"
|
|
1044
|
-
]),
|
|
1045
|
-
requestId: z.string(),
|
|
1046
|
-
content: z.string().optional(),
|
|
1047
|
-
method: z.string().optional(),
|
|
1048
|
-
durationInMs: z.number().optional()
|
|
1049
|
-
})),
|
|
1673
|
+
logs: z.array(logEntrySchema),
|
|
1050
1674
|
nextToken: z.string().nullable()
|
|
1051
1675
|
}));
|
|
1052
1676
|
const getLatestLogsContractV1 = oc.route({
|
|
@@ -1069,21 +1693,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1069
1693
|
"DEBUG"
|
|
1070
1694
|
])).optional().describe("Filter by log level"),
|
|
1071
1695
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1072
|
-
})).output(z.object({ logs: z.array(
|
|
1073
|
-
timestamp: z.coerce.date(),
|
|
1074
|
-
type: z.enum([
|
|
1075
|
-
"START",
|
|
1076
|
-
"END",
|
|
1077
|
-
"INFO",
|
|
1078
|
-
"ERROR",
|
|
1079
|
-
"WARNING",
|
|
1080
|
-
"DEBUG"
|
|
1081
|
-
]),
|
|
1082
|
-
requestId: z.string(),
|
|
1083
|
-
content: z.string().optional(),
|
|
1084
|
-
method: z.string().optional(),
|
|
1085
|
-
durationInMs: z.number().optional()
|
|
1086
|
-
})) }));
|
|
1696
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1087
1697
|
const getDeploymentLogsContractV1 = oc.route({
|
|
1088
1698
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1089
1699
|
method: "GET",
|
|
@@ -1156,7 +1766,7 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1156
1766
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1157
1767
|
tags: ["tunnels"],
|
|
1158
1768
|
successDescription: "The tunnel ticket"
|
|
1159
|
-
}).output(z.object({
|
|
1769
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1160
1770
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1161
1771
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1162
1772
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
@@ -1232,7 +1842,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1232
1842
|
name: z.string().min(1).max(100).optional(),
|
|
1233
1843
|
description: z.string().min(1).max(500).optional(),
|
|
1234
1844
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1235
|
-
examplePrompts: z.array(playgroundExamplePromptSchema).max(
|
|
1845
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1236
1846
|
})).output(playgroundOutputSchema);
|
|
1237
1847
|
const createBeaconContractV1 = oc.route({
|
|
1238
1848
|
path: "/v1/beacon/audits",
|
|
@@ -1310,4 +1920,4 @@ const contract = {
|
|
|
1310
1920
|
}
|
|
1311
1921
|
};
|
|
1312
1922
|
//#endregion
|
|
1313
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1923
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|