@alpic-ai/api 0.0.0-dev.gfe05e8c → 0.0.0-dev.gfe84b31
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 +91 -60
- package/dist/index.mjs +836 -240
- package/package.json +23 -7
package/dist/index.mjs
CHANGED
|
@@ -1,6 +1,174 @@
|
|
|
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";
|
|
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();
|
|
4
172
|
const platformSchema = z.enum(["chatgpt", "claudeai"]);
|
|
5
173
|
const PLATFORM_LABELS = {
|
|
6
174
|
chatgpt: "ChatGPT",
|
|
@@ -71,6 +239,13 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
|
|
|
71
239
|
chatgpt: widgetScreenshotSchema.optional(),
|
|
72
240
|
claudeai: widgetScreenshotSchema.optional()
|
|
73
241
|
}) });
|
|
242
|
+
z.object({
|
|
243
|
+
id: z.string(),
|
|
244
|
+
environmentId: z.string(),
|
|
245
|
+
clientId: z.string(),
|
|
246
|
+
clientSecret: z.string(),
|
|
247
|
+
clientScopes: z.array(z.string())
|
|
248
|
+
});
|
|
74
249
|
const deploymentStatusSchema$1 = z.enum([
|
|
75
250
|
"ongoing",
|
|
76
251
|
"deployed",
|
|
@@ -98,9 +273,118 @@ const deploymentSummarySchema = z.object({
|
|
|
98
273
|
createdAt: z.coerce.date(),
|
|
99
274
|
updatedAt: z.coerce.date()
|
|
100
275
|
});
|
|
276
|
+
/**
|
|
277
|
+
* Public environment
|
|
278
|
+
*
|
|
279
|
+
* Answers anonymously and exposes no OAuth metadata.
|
|
280
|
+
*/
|
|
281
|
+
const publicEnvironmentSchema = z.object({
|
|
282
|
+
allowsAnonymous: z.literal(true),
|
|
283
|
+
oAuthMetadata: z.strictObject({})
|
|
284
|
+
});
|
|
285
|
+
/**
|
|
286
|
+
* Protected environment with an external resource metadata URL
|
|
287
|
+
*
|
|
288
|
+
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
289
|
+
* Everything that follows is handled outside of the MCP server scope.
|
|
290
|
+
*/
|
|
291
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
292
|
+
allowsAnonymous: z.boolean(),
|
|
293
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
|
+
scope: z.string().optional()
|
|
295
|
+
});
|
|
296
|
+
/**
|
|
297
|
+
* Protected environment with an external authorization server URL
|
|
298
|
+
*
|
|
299
|
+
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
300
|
+
* An external authorization server URL is returned when requesting the endpoint.
|
|
301
|
+
* Everything that follows is handled outside of the MCP server scope.
|
|
302
|
+
*/
|
|
303
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
|
+
allowsAnonymous: z.boolean(),
|
|
305
|
+
oAuthMetadata: z.object({
|
|
306
|
+
externalAuthorizationServerUrl: z.url(),
|
|
307
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
308
|
+
}),
|
|
309
|
+
scope: z.string().optional()
|
|
310
|
+
});
|
|
311
|
+
/**
|
|
312
|
+
* Standalone protected environment
|
|
313
|
+
*
|
|
314
|
+
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
315
|
+
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
316
|
+
*/
|
|
317
|
+
const standaloneEnvironmentSchema = z.object({
|
|
318
|
+
allowsAnonymous: z.boolean(),
|
|
319
|
+
oAuthMetadata: z.object({
|
|
320
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
321
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
322
|
+
}),
|
|
323
|
+
scope: z.string().optional()
|
|
324
|
+
});
|
|
325
|
+
/**
|
|
326
|
+
* Protected environment without OAuth discovery
|
|
327
|
+
*
|
|
328
|
+
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
329
|
+
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
330
|
+
* are advertised. Clients must obtain credentials out-of-band.
|
|
331
|
+
*/
|
|
332
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
|
+
allowsAnonymous: z.literal(false),
|
|
334
|
+
oAuthMetadata: z.strictObject({}),
|
|
335
|
+
scope: z.string().optional()
|
|
336
|
+
});
|
|
337
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
338
|
+
isPublic: z.literal(true),
|
|
339
|
+
oAuthMetadata: z.undefined().optional()
|
|
340
|
+
});
|
|
341
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
342
|
+
isPublic: z.literal(false),
|
|
343
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
344
|
+
scope: z.string().optional()
|
|
345
|
+
});
|
|
346
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
347
|
+
isPublic: z.literal(false),
|
|
348
|
+
oAuthMetadata: z.object({
|
|
349
|
+
externalAuthorizationServerUrl: z.url(),
|
|
350
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
351
|
+
}),
|
|
352
|
+
scope: z.string().optional()
|
|
353
|
+
});
|
|
354
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
355
|
+
isPublic: z.literal(false),
|
|
356
|
+
oAuthMetadata: z.object({
|
|
357
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
358
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
359
|
+
}),
|
|
360
|
+
scope: z.string().optional()
|
|
361
|
+
});
|
|
362
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
363
|
+
isPublic: z.literal(false),
|
|
364
|
+
oAuthMetadata: z.strictObject({}),
|
|
365
|
+
scope: z.string().optional()
|
|
366
|
+
});
|
|
367
|
+
z.union([
|
|
368
|
+
publicEnvironmentSchema,
|
|
369
|
+
externalResourceMetadataEnvironmentSchema,
|
|
370
|
+
externalAuthorizationServerEnvironmentSchema,
|
|
371
|
+
standaloneEnvironmentSchema,
|
|
372
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
373
|
+
legacyPublicEnvironmentSchema,
|
|
374
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
375
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
376
|
+
legacyStandaloneEnvironmentSchema,
|
|
377
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
378
|
+
]);
|
|
101
379
|
const allowedPlatformSchema = platformSchema;
|
|
380
|
+
const playgroundModelSchema = z.enum([
|
|
381
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
382
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
383
|
+
"openai.gpt-5.4",
|
|
384
|
+
"openai.gpt-5.5"
|
|
385
|
+
]);
|
|
102
386
|
const environmentDomainSchema = z.object({
|
|
103
|
-
|
|
387
|
+
name: z.string(),
|
|
104
388
|
status: z.enum([
|
|
105
389
|
"ongoing",
|
|
106
390
|
"deployed",
|
|
@@ -118,6 +402,7 @@ const environmentSchema$1 = z.object({
|
|
|
118
402
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
119
403
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
120
404
|
isPlaygroundEnabled: z.boolean(),
|
|
405
|
+
playgroundModel: playgroundModelSchema,
|
|
121
406
|
isIpWhitelistEnabled: z.boolean(),
|
|
122
407
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
123
408
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -126,6 +411,13 @@ const environmentSchema$1 = z.object({
|
|
|
126
411
|
updatedAt: z.coerce.date()
|
|
127
412
|
});
|
|
128
413
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
414
|
+
z.object({
|
|
415
|
+
sessionReplayEnabled: z.boolean(),
|
|
416
|
+
collectRequestPayload: z.boolean(),
|
|
417
|
+
collectResponsePayload: z.boolean(),
|
|
418
|
+
collectErrorMessage: z.boolean(),
|
|
419
|
+
collectUserData: z.boolean()
|
|
420
|
+
});
|
|
129
421
|
z.object({
|
|
130
422
|
id: z.string(),
|
|
131
423
|
createdAt: z.coerce.date(),
|
|
@@ -259,15 +551,27 @@ z.object({
|
|
|
259
551
|
environments: z.array(environmentWithDomainsSchema),
|
|
260
552
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
261
553
|
});
|
|
554
|
+
const domainFailureReasonSchema = z.enum([
|
|
555
|
+
"caa",
|
|
556
|
+
"dns",
|
|
557
|
+
"invalid_domain",
|
|
558
|
+
"other"
|
|
559
|
+
]);
|
|
560
|
+
const projectDomainMappingSchema = z.object({
|
|
561
|
+
pathPrefix: z.string(),
|
|
562
|
+
environment: environmentSchema$1
|
|
563
|
+
});
|
|
262
564
|
z.object({
|
|
263
|
-
|
|
565
|
+
name: z.string(),
|
|
264
566
|
createdAt: z.coerce.date(),
|
|
265
567
|
status: z.enum([
|
|
266
568
|
"ongoing",
|
|
267
569
|
"deployed",
|
|
268
570
|
"failed"
|
|
269
571
|
]),
|
|
270
|
-
|
|
572
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
573
|
+
environment: environmentSchema$1,
|
|
574
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
271
575
|
});
|
|
272
576
|
const serverFieldsSchema$1 = z.object({
|
|
273
577
|
$schema: z.string(),
|
|
@@ -296,6 +600,22 @@ z.object({
|
|
|
296
600
|
serverFields: serverFieldsSchema$1,
|
|
297
601
|
source: z.enum(["registry", "defaults"])
|
|
298
602
|
});
|
|
603
|
+
/**
|
|
604
|
+
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
605
|
+
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
606
|
+
*
|
|
607
|
+
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
608
|
+
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
609
|
+
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
610
|
+
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
611
|
+
*/
|
|
612
|
+
const clampStringField = (field) => {
|
|
613
|
+
const max = field.maxLength;
|
|
614
|
+
if (max === null) return field;
|
|
615
|
+
const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
|
|
616
|
+
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
617
|
+
return field.description ? withMin.describe(field.description) : withMin;
|
|
618
|
+
};
|
|
299
619
|
const toolDefinitionSchema = z.object({
|
|
300
620
|
name: z.string(),
|
|
301
621
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -308,17 +628,20 @@ const toolDefinitionSchema = z.object({
|
|
|
308
628
|
}).optional()
|
|
309
629
|
});
|
|
310
630
|
const positiveTestCaseSchema = z.object({
|
|
311
|
-
scenario: z.string(),
|
|
312
|
-
userPrompt: z.string(),
|
|
313
|
-
toolTriggered: z.string().optional(),
|
|
314
|
-
expectedOutput: z.string().optional()
|
|
631
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
632
|
+
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."),
|
|
633
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
634
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
315
635
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
316
636
|
const screenshotEntrySchema = z.object({
|
|
317
637
|
prompt: z.string(),
|
|
318
638
|
url: z.url()
|
|
319
639
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
640
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
320
641
|
/** Accepts either a valid email or URL. */
|
|
321
642
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
643
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
644
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
322
645
|
const chatgptCategorySchema = z.enum([
|
|
323
646
|
"BUSINESS",
|
|
324
647
|
"COLLABORATION",
|
|
@@ -335,22 +658,315 @@ const chatgptCategorySchema = z.enum([
|
|
|
335
658
|
"TRAVEL"
|
|
336
659
|
]);
|
|
337
660
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
338
|
-
const
|
|
661
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
662
|
+
"AD",
|
|
663
|
+
"AE",
|
|
664
|
+
"AF",
|
|
665
|
+
"AG",
|
|
666
|
+
"AL",
|
|
667
|
+
"AM",
|
|
668
|
+
"AO",
|
|
669
|
+
"AR",
|
|
670
|
+
"AT",
|
|
671
|
+
"AU",
|
|
672
|
+
"AW",
|
|
673
|
+
"AX",
|
|
674
|
+
"AZ",
|
|
675
|
+
"BA",
|
|
676
|
+
"BB",
|
|
677
|
+
"BD",
|
|
678
|
+
"BE",
|
|
679
|
+
"BF",
|
|
680
|
+
"BG",
|
|
681
|
+
"BH",
|
|
682
|
+
"BI",
|
|
683
|
+
"BJ",
|
|
684
|
+
"BL",
|
|
685
|
+
"BM",
|
|
686
|
+
"BN",
|
|
687
|
+
"BO",
|
|
688
|
+
"BR",
|
|
689
|
+
"BS",
|
|
690
|
+
"BT",
|
|
691
|
+
"BW",
|
|
692
|
+
"BZ",
|
|
693
|
+
"CA",
|
|
694
|
+
"CD",
|
|
695
|
+
"CF",
|
|
696
|
+
"CG",
|
|
697
|
+
"CH",
|
|
698
|
+
"CI",
|
|
699
|
+
"CL",
|
|
700
|
+
"CM",
|
|
701
|
+
"CO",
|
|
702
|
+
"CR",
|
|
703
|
+
"CV",
|
|
704
|
+
"CY",
|
|
705
|
+
"CZ",
|
|
706
|
+
"DE",
|
|
707
|
+
"DJ",
|
|
708
|
+
"DK",
|
|
709
|
+
"DM",
|
|
710
|
+
"DO",
|
|
711
|
+
"DZ",
|
|
712
|
+
"EC",
|
|
713
|
+
"EE",
|
|
714
|
+
"EG",
|
|
715
|
+
"ER",
|
|
716
|
+
"ES",
|
|
717
|
+
"ET",
|
|
718
|
+
"FI",
|
|
719
|
+
"FJ",
|
|
720
|
+
"FM",
|
|
721
|
+
"FO",
|
|
722
|
+
"FR",
|
|
723
|
+
"GA",
|
|
724
|
+
"GB",
|
|
725
|
+
"GD",
|
|
726
|
+
"GE",
|
|
727
|
+
"GF",
|
|
728
|
+
"GH",
|
|
729
|
+
"GL",
|
|
730
|
+
"GM",
|
|
731
|
+
"GN",
|
|
732
|
+
"GP",
|
|
733
|
+
"GQ",
|
|
734
|
+
"GR",
|
|
735
|
+
"GT",
|
|
736
|
+
"GW",
|
|
737
|
+
"GY",
|
|
738
|
+
"HN",
|
|
739
|
+
"HR",
|
|
740
|
+
"HT",
|
|
741
|
+
"HU",
|
|
742
|
+
"ID",
|
|
743
|
+
"IE",
|
|
744
|
+
"IL",
|
|
745
|
+
"IN",
|
|
746
|
+
"IQ",
|
|
747
|
+
"IS",
|
|
748
|
+
"IT",
|
|
749
|
+
"JM",
|
|
750
|
+
"JO",
|
|
751
|
+
"JP",
|
|
752
|
+
"KE",
|
|
753
|
+
"KG",
|
|
754
|
+
"KH",
|
|
755
|
+
"KI",
|
|
756
|
+
"KM",
|
|
757
|
+
"KN",
|
|
758
|
+
"KR",
|
|
759
|
+
"KW",
|
|
760
|
+
"KY",
|
|
761
|
+
"KZ",
|
|
762
|
+
"LA",
|
|
763
|
+
"LB",
|
|
764
|
+
"LC",
|
|
765
|
+
"LI",
|
|
766
|
+
"LK",
|
|
767
|
+
"LR",
|
|
768
|
+
"LS",
|
|
769
|
+
"LT",
|
|
770
|
+
"LU",
|
|
771
|
+
"LV",
|
|
772
|
+
"LY",
|
|
773
|
+
"MA",
|
|
774
|
+
"MC",
|
|
775
|
+
"MD",
|
|
776
|
+
"ME",
|
|
777
|
+
"MF",
|
|
778
|
+
"MG",
|
|
779
|
+
"MH",
|
|
780
|
+
"MK",
|
|
781
|
+
"ML",
|
|
782
|
+
"MM",
|
|
783
|
+
"MN",
|
|
784
|
+
"MQ",
|
|
785
|
+
"MR",
|
|
786
|
+
"MT",
|
|
787
|
+
"MU",
|
|
788
|
+
"MV",
|
|
789
|
+
"MW",
|
|
790
|
+
"MX",
|
|
791
|
+
"MY",
|
|
792
|
+
"MZ",
|
|
793
|
+
"NA",
|
|
794
|
+
"NC",
|
|
795
|
+
"NE",
|
|
796
|
+
"NG",
|
|
797
|
+
"NI",
|
|
798
|
+
"NL",
|
|
799
|
+
"NO",
|
|
800
|
+
"NP",
|
|
801
|
+
"NR",
|
|
802
|
+
"NZ",
|
|
803
|
+
"OM",
|
|
804
|
+
"PA",
|
|
805
|
+
"PE",
|
|
806
|
+
"PF",
|
|
807
|
+
"PG",
|
|
808
|
+
"PH",
|
|
809
|
+
"PK",
|
|
810
|
+
"PL",
|
|
811
|
+
"PM",
|
|
812
|
+
"PS",
|
|
813
|
+
"PT",
|
|
814
|
+
"PW",
|
|
815
|
+
"PY",
|
|
816
|
+
"QA",
|
|
817
|
+
"RE",
|
|
818
|
+
"RO",
|
|
819
|
+
"RS",
|
|
820
|
+
"RW",
|
|
821
|
+
"SA",
|
|
822
|
+
"SB",
|
|
823
|
+
"SC",
|
|
824
|
+
"SD",
|
|
825
|
+
"SE",
|
|
826
|
+
"SG",
|
|
827
|
+
"SH",
|
|
828
|
+
"SI",
|
|
829
|
+
"SJ",
|
|
830
|
+
"SK",
|
|
831
|
+
"SL",
|
|
832
|
+
"SM",
|
|
833
|
+
"SN",
|
|
834
|
+
"SO",
|
|
835
|
+
"SR",
|
|
836
|
+
"SS",
|
|
837
|
+
"ST",
|
|
838
|
+
"SV",
|
|
839
|
+
"SZ",
|
|
840
|
+
"TD",
|
|
841
|
+
"TF",
|
|
842
|
+
"TG",
|
|
843
|
+
"TH",
|
|
844
|
+
"TJ",
|
|
845
|
+
"TL",
|
|
846
|
+
"TM",
|
|
847
|
+
"TN",
|
|
848
|
+
"TO",
|
|
849
|
+
"TR",
|
|
850
|
+
"TT",
|
|
851
|
+
"TV",
|
|
852
|
+
"TW",
|
|
853
|
+
"TZ",
|
|
854
|
+
"UA",
|
|
855
|
+
"UG",
|
|
856
|
+
"US",
|
|
857
|
+
"UY",
|
|
858
|
+
"UZ",
|
|
859
|
+
"VA",
|
|
860
|
+
"VC",
|
|
861
|
+
"VN",
|
|
862
|
+
"VU",
|
|
863
|
+
"WF",
|
|
864
|
+
"WS",
|
|
865
|
+
"YE",
|
|
866
|
+
"YT",
|
|
867
|
+
"ZA",
|
|
868
|
+
"ZM",
|
|
869
|
+
"ZW"
|
|
870
|
+
]);
|
|
871
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
872
|
+
z.object({ mode: z.literal("all") }),
|
|
873
|
+
z.object({
|
|
874
|
+
mode: z.literal("allow"),
|
|
875
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
876
|
+
}),
|
|
877
|
+
z.object({
|
|
878
|
+
mode: z.literal("block"),
|
|
879
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
880
|
+
})
|
|
881
|
+
]);
|
|
882
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
883
|
+
"am",
|
|
884
|
+
"ar",
|
|
885
|
+
"bg-BG",
|
|
886
|
+
"bn-BD",
|
|
887
|
+
"bs-BA",
|
|
888
|
+
"ca-ES",
|
|
889
|
+
"cs-CZ",
|
|
890
|
+
"da-DK",
|
|
891
|
+
"de-DE",
|
|
892
|
+
"el-GR",
|
|
893
|
+
"es-419",
|
|
894
|
+
"es-ES",
|
|
895
|
+
"et-EE",
|
|
896
|
+
"fi-FI",
|
|
897
|
+
"fr-CA",
|
|
898
|
+
"fr-FR",
|
|
899
|
+
"gu-IN",
|
|
900
|
+
"hi-IN",
|
|
901
|
+
"hr-HR",
|
|
902
|
+
"hu-HU",
|
|
903
|
+
"hy-AM",
|
|
904
|
+
"id-ID",
|
|
905
|
+
"is-IS",
|
|
906
|
+
"it-IT",
|
|
907
|
+
"ja-JP",
|
|
908
|
+
"ka-GE",
|
|
909
|
+
"kk",
|
|
910
|
+
"kn-IN",
|
|
911
|
+
"ko-KR",
|
|
912
|
+
"lt",
|
|
913
|
+
"lv-LV",
|
|
914
|
+
"mk-MK",
|
|
915
|
+
"ml",
|
|
916
|
+
"mn",
|
|
917
|
+
"mr-IN",
|
|
918
|
+
"ms-MY",
|
|
919
|
+
"my-MM",
|
|
920
|
+
"nb-NO",
|
|
921
|
+
"nl-NL",
|
|
922
|
+
"pa",
|
|
923
|
+
"pl-PL",
|
|
924
|
+
"pt-BR",
|
|
925
|
+
"pt-PT",
|
|
926
|
+
"ro-RO",
|
|
927
|
+
"ru-RU",
|
|
928
|
+
"sk-SK",
|
|
929
|
+
"sl-SI",
|
|
930
|
+
"so-SO",
|
|
931
|
+
"sq-AL",
|
|
932
|
+
"sr-RS",
|
|
933
|
+
"sv-SE",
|
|
934
|
+
"sw-TZ",
|
|
935
|
+
"ta-IN",
|
|
936
|
+
"te-IN",
|
|
937
|
+
"th-TH",
|
|
938
|
+
"tl",
|
|
939
|
+
"tr-TR",
|
|
940
|
+
"uk-UA",
|
|
941
|
+
"ur",
|
|
942
|
+
"vi-VN",
|
|
943
|
+
"zh-CN",
|
|
944
|
+
"zh-HK",
|
|
945
|
+
"zh-TW"
|
|
946
|
+
]);
|
|
339
947
|
const negativeTestCaseSchema = z.object({
|
|
340
948
|
scenario: z.string(),
|
|
341
949
|
userPrompt: z.string()
|
|
342
950
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
343
951
|
const chatgptToolJustificationSchema = z.object({
|
|
344
952
|
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).");
|
|
953
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
954
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
955
|
+
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.\"")
|
|
956
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
957
|
+
/**
|
|
958
|
+
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
959
|
+
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
960
|
+
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
961
|
+
*/
|
|
962
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
963
|
+
const chatgptDescriptionSchema = z.string();
|
|
349
964
|
const chatgptTranslationSchema = z.object({
|
|
350
|
-
locale:
|
|
351
|
-
tagline:
|
|
352
|
-
description:
|
|
965
|
+
locale: chatgptTranslationLocaleSchema,
|
|
966
|
+
tagline: chatgptTaglineSchema,
|
|
967
|
+
description: chatgptDescriptionSchema
|
|
353
968
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
969
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
354
970
|
/**
|
|
355
971
|
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
356
972
|
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
@@ -359,27 +975,38 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
359
975
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
360
976
|
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
977
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
362
|
-
tagline:
|
|
363
|
-
description:
|
|
978
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
979
|
+
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
980
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
365
981
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
366
|
-
companyUrl:
|
|
982
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
367
983
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
368
|
-
privacyPolicyUrl:
|
|
369
|
-
termsOfServiceUrl:
|
|
370
|
-
demoRecordingUrl:
|
|
984
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
985
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
986
|
+
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
987
|
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:
|
|
988
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
373
989
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
374
990
|
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
|
|
991
|
+
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."),
|
|
992
|
+
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."),
|
|
993
|
+
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."),
|
|
994
|
+
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
995
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
380
|
-
allowedCountries: chatgptAllowedCountriesSchema.describe("
|
|
996
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
381
997
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
382
998
|
});
|
|
999
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1000
|
+
tagline: z.string().optional(),
|
|
1001
|
+
companyUrl: z.string().optional(),
|
|
1002
|
+
supportChannel: z.string().optional(),
|
|
1003
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1004
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1005
|
+
demoRecordingUrl: z.string().optional(),
|
|
1006
|
+
serverUrl: z.string().optional(),
|
|
1007
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1008
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1009
|
+
});
|
|
383
1010
|
chatgptSubmissionFormDataSchema.pick({
|
|
384
1011
|
appName: true,
|
|
385
1012
|
developerName: true,
|
|
@@ -394,9 +1021,9 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
394
1021
|
testCases: true,
|
|
395
1022
|
negativeTestCases: true,
|
|
396
1023
|
toolJustifications: true
|
|
397
|
-
});
|
|
1024
|
+
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
398
1025
|
const claudeCategorySchema = z.enum([
|
|
399
|
-
"
|
|
1026
|
+
"Productivity",
|
|
400
1027
|
"Communication",
|
|
401
1028
|
"Data & Analytics",
|
|
402
1029
|
"Development tools",
|
|
@@ -404,207 +1031,171 @@ const claudeCategorySchema = z.enum([
|
|
|
404
1031
|
"Consumer Health",
|
|
405
1032
|
"Health & Life Sciences",
|
|
406
1033
|
"Media & Entertainment",
|
|
407
|
-
"Commerce & Shopping"
|
|
1034
|
+
"Commerce & Shopping",
|
|
1035
|
+
"Legal",
|
|
1036
|
+
"Sales and marketing",
|
|
1037
|
+
"Creative",
|
|
1038
|
+
"Nonprofit",
|
|
1039
|
+
"Education",
|
|
1040
|
+
"Other"
|
|
408
1041
|
]);
|
|
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)"]);
|
|
1042
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
416
1043
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
417
|
-
"
|
|
418
|
-
"
|
|
419
|
-
"
|
|
1044
|
+
"read_only",
|
|
1045
|
+
"write_only",
|
|
1046
|
+
"read_write"
|
|
420
1047
|
]);
|
|
421
|
-
const
|
|
422
|
-
|
|
423
|
-
"
|
|
424
|
-
"
|
|
425
|
-
"
|
|
426
|
-
"
|
|
427
|
-
"N/A"
|
|
1048
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1049
|
+
"oauth_dcr",
|
|
1050
|
+
"oauth_cimd",
|
|
1051
|
+
"oauth_anthropic_creds",
|
|
1052
|
+
"custom_connection",
|
|
1053
|
+
"none"
|
|
428
1054
|
]);
|
|
429
|
-
const
|
|
430
|
-
"
|
|
431
|
-
"
|
|
432
|
-
"
|
|
433
|
-
"GDPR compliant (if applicable)"
|
|
1055
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1056
|
+
"first_party",
|
|
1057
|
+
"proxied",
|
|
1058
|
+
"third_party"
|
|
434
1059
|
]);
|
|
435
|
-
const
|
|
436
|
-
|
|
437
|
-
"
|
|
438
|
-
"
|
|
1060
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1061
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1062
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1063
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1064
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1065
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1066
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1067
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1068
|
+
"Public documentation for this connector will be live by the publish date."
|
|
439
1069
|
]);
|
|
440
1070
|
/**
|
|
441
|
-
* Field order mirrors the
|
|
442
|
-
*
|
|
1071
|
+
* Field order mirrors the claude.ai directory submission wizard
|
|
1072
|
+
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1073
|
+
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
443
1074
|
*/
|
|
444
1075
|
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.`)
|
|
1076
|
+
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
|
|
1077
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1078
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1079
|
+
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
|
|
1080
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1081
|
+
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.
|
|
1082
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1083
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1084
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1085
|
+
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
|
|
1086
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1087
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1088
|
+
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
|
|
1089
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1090
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1091
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1092
|
+
by your publish date.`),
|
|
1093
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1094
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1095
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1096
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1097
|
+
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
|
|
1098
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1099
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1100
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1101
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1102
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1103
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1104
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1105
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1106
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1107
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1108
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1109
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1110
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1111
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1112
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1113
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1114
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1115
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1116
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1117
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1118
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1119
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1120
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1121
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1122
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1123
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1124
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1125
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1126
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1127
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1128
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1129
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1130
|
+
fully populated account.`),
|
|
1131
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1132
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1133
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1134
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1135
|
+
});
|
|
1136
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1137
|
+
serverUrl: z.string().optional(),
|
|
1138
|
+
name: z.string().optional(),
|
|
1139
|
+
slug: z.string().optional(),
|
|
1140
|
+
oneLiner: z.string().optional(),
|
|
1141
|
+
description: z.string().optional(),
|
|
1142
|
+
iconUrl: z.string().optional(),
|
|
1143
|
+
documentation: z.string().optional(),
|
|
1144
|
+
support: z.string().optional(),
|
|
1145
|
+
privacyPolicy: z.string().optional(),
|
|
1146
|
+
companyWebsite: z.string().optional(),
|
|
1147
|
+
primaryContactEmail: z.string().optional(),
|
|
1148
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1149
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
573
1150
|
});
|
|
574
1151
|
claudeSubmissionFormDataSchema.pick({
|
|
575
|
-
companyName: true,
|
|
576
|
-
appName: true,
|
|
577
|
-
mcpUrlType: true,
|
|
578
1152
|
serverUrl: true,
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
transportSupport: true,
|
|
1153
|
+
name: true,
|
|
1154
|
+
slug: true,
|
|
1155
|
+
companyName: true,
|
|
583
1156
|
primaryContactEmail: true,
|
|
584
|
-
primaryContactName: true
|
|
1157
|
+
primaryContactName: true,
|
|
1158
|
+
readWriteCapabilities: true,
|
|
1159
|
+
authentication: true,
|
|
1160
|
+
apiOwnership: true,
|
|
1161
|
+
personalHealthData: true
|
|
1162
|
+
}).extend({
|
|
1163
|
+
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1164
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
585
1165
|
});
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
1166
|
+
/**
|
|
1167
|
+
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1168
|
+
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1169
|
+
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1170
|
+
* colocated with the Claude contract.
|
|
1171
|
+
*/
|
|
1172
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1173
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1174
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1175
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1176
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1177
|
+
});
|
|
1178
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1179
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1180
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
591
1181
|
});
|
|
592
1182
|
const submissionMetaFieldsSchema = z.object({
|
|
593
1183
|
id: z.string(),
|
|
594
1184
|
environmentId: z.string(),
|
|
1185
|
+
auditId: z.string().nullable(),
|
|
595
1186
|
createdAt: z.coerce.date(),
|
|
596
1187
|
updatedAt: z.coerce.date()
|
|
597
1188
|
});
|
|
598
1189
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
599
1190
|
platform: z.literal("claudeai"),
|
|
600
|
-
formData:
|
|
1191
|
+
formData: claudeSubmissionDraftSchema
|
|
601
1192
|
});
|
|
602
1193
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
603
1194
|
platform: z.literal("chatgpt"),
|
|
604
|
-
formData:
|
|
1195
|
+
formData: chatgptSubmissionDraftSchema
|
|
605
1196
|
});
|
|
606
1197
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
607
|
-
z.union([
|
|
1198
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
608
1199
|
const subscriptionPlanSchema = z.enum([
|
|
609
1200
|
"pro",
|
|
610
1201
|
"business",
|
|
@@ -628,6 +1219,12 @@ z.object({
|
|
|
628
1219
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
629
1220
|
});
|
|
630
1221
|
//#endregion
|
|
1222
|
+
//#region src/auth-scope.ts
|
|
1223
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1224
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1225
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1226
|
+
const AUTH_SCOPE_USER = "user";
|
|
1227
|
+
//#endregion
|
|
631
1228
|
//#region src/schemas.ts
|
|
632
1229
|
const RESERVED_KEYS = [
|
|
633
1230
|
"_HANDLER",
|
|
@@ -767,7 +1364,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
767
1364
|
id: z.string(),
|
|
768
1365
|
name: z.string(),
|
|
769
1366
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
770
|
-
urls: z.array(z.
|
|
1367
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
771
1368
|
createdAt: z.coerce.date(),
|
|
772
1369
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
773
1370
|
}));
|
|
@@ -843,6 +1440,9 @@ const listProjectsContractV1 = oc.route({
|
|
|
843
1440
|
description: "List all projects for a team",
|
|
844
1441
|
tags: ["projects"],
|
|
845
1442
|
successDescription: "The list of projects"
|
|
1443
|
+
}).errors({
|
|
1444
|
+
NOT_FOUND: {},
|
|
1445
|
+
BAD_REQUEST: {}
|
|
846
1446
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
847
1447
|
const createProjectContractV1 = oc.route({
|
|
848
1448
|
path: "/v1/projects",
|
|
@@ -853,7 +1453,8 @@ const createProjectContractV1 = oc.route({
|
|
|
853
1453
|
successDescription: "The project has been created successfully"
|
|
854
1454
|
}).errors({
|
|
855
1455
|
NOT_FOUND: {},
|
|
856
|
-
BAD_REQUEST: {}
|
|
1456
|
+
BAD_REQUEST: {},
|
|
1457
|
+
FORBIDDEN: {}
|
|
857
1458
|
}).input(z.object({
|
|
858
1459
|
teamId: z.string().optional(),
|
|
859
1460
|
name: z.string().trim().min(1).max(100),
|
|
@@ -938,7 +1539,10 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
938
1539
|
description: "Delete an environment variable by ID",
|
|
939
1540
|
tags: ["environments"],
|
|
940
1541
|
successDescription: "The environment variable has been deleted successfully"
|
|
941
|
-
}).errors({
|
|
1542
|
+
}).errors({
|
|
1543
|
+
NOT_FOUND: {},
|
|
1544
|
+
BAD_REQUEST: {}
|
|
1545
|
+
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
942
1546
|
const deleteProjectContractV1 = oc.route({
|
|
943
1547
|
path: "/v1/projects/{projectId}",
|
|
944
1548
|
method: "DELETE",
|
|
@@ -956,7 +1560,8 @@ const updateProjectContractV1 = oc.route({
|
|
|
956
1560
|
successDescription: "The project has been updated successfully"
|
|
957
1561
|
}).errors({
|
|
958
1562
|
NOT_FOUND: {},
|
|
959
|
-
BAD_REQUEST: {}
|
|
1563
|
+
BAD_REQUEST: {},
|
|
1564
|
+
FORBIDDEN: {}
|
|
960
1565
|
}).input(z.object({
|
|
961
1566
|
projectId: z.string().describe("The ID of the project"),
|
|
962
1567
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
@@ -974,7 +1579,8 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
974
1579
|
BAD_REQUEST: {}
|
|
975
1580
|
}).input(z.object({
|
|
976
1581
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
977
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1582
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1583
|
+
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
1584
|
})).output(deploymentSchema);
|
|
979
1585
|
const uploadDeploymentArtifactContractV1 = oc.route({
|
|
980
1586
|
path: "/v1/deployments/upload",
|
|
@@ -983,6 +1589,9 @@ const uploadDeploymentArtifactContractV1 = oc.route({
|
|
|
983
1589
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
984
1590
|
tags: ["deployments"],
|
|
985
1591
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1592
|
+
}).errors({
|
|
1593
|
+
NOT_FOUND: {},
|
|
1594
|
+
BAD_REQUEST: {}
|
|
986
1595
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
987
1596
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
988
1597
|
token: z.string().describe("Token to identify the source archive"),
|
|
@@ -1008,6 +1617,21 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1008
1617
|
tags: ["deployments"],
|
|
1009
1618
|
successDescription: "The deployment details"
|
|
1010
1619
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1620
|
+
const logEntrySchema = z.object({
|
|
1621
|
+
timestamp: z.coerce.date(),
|
|
1622
|
+
type: z.enum([
|
|
1623
|
+
"START",
|
|
1624
|
+
"END",
|
|
1625
|
+
"INFO",
|
|
1626
|
+
"ERROR",
|
|
1627
|
+
"WARNING",
|
|
1628
|
+
"DEBUG"
|
|
1629
|
+
]),
|
|
1630
|
+
requestId: z.string(),
|
|
1631
|
+
content: z.string().optional(),
|
|
1632
|
+
method: z.string().optional(),
|
|
1633
|
+
durationInMs: z.number().optional()
|
|
1634
|
+
});
|
|
1011
1635
|
const getLogsContractV1 = oc.route({
|
|
1012
1636
|
path: "/v1/environments/{environmentId}/logs",
|
|
1013
1637
|
method: "GET",
|
|
@@ -1032,21 +1656,7 @@ const getLogsContractV1 = oc.route({
|
|
|
1032
1656
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1033
1657
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1034
1658
|
})).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
|
-
})),
|
|
1659
|
+
logs: z.array(logEntrySchema),
|
|
1050
1660
|
nextToken: z.string().nullable()
|
|
1051
1661
|
}));
|
|
1052
1662
|
const getLatestLogsContractV1 = oc.route({
|
|
@@ -1069,21 +1679,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1069
1679
|
"DEBUG"
|
|
1070
1680
|
])).optional().describe("Filter by log level"),
|
|
1071
1681
|
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
|
-
})) }));
|
|
1682
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1087
1683
|
const getDeploymentLogsContractV1 = oc.route({
|
|
1088
1684
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1089
1685
|
method: "GET",
|
|
@@ -1156,7 +1752,7 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1156
1752
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1157
1753
|
tags: ["tunnels"],
|
|
1158
1754
|
successDescription: "The tunnel ticket"
|
|
1159
|
-
}).output(z.object({
|
|
1755
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1160
1756
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1161
1757
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1162
1758
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
@@ -1232,7 +1828,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1232
1828
|
name: z.string().min(1).max(100).optional(),
|
|
1233
1829
|
description: z.string().min(1).max(500).optional(),
|
|
1234
1830
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1235
|
-
examplePrompts: z.array(playgroundExamplePromptSchema).max(
|
|
1831
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1236
1832
|
})).output(playgroundOutputSchema);
|
|
1237
1833
|
const createBeaconContractV1 = oc.route({
|
|
1238
1834
|
path: "/v1/beacon/audits",
|
|
@@ -1310,4 +1906,4 @@ const contract = {
|
|
|
1310
1906
|
}
|
|
1311
1907
|
};
|
|
1312
1908
|
//#endregion
|
|
1313
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1909
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|