@alpic-ai/api 0.0.0-dev.gdf09076 → 0.0.0-dev.gdfc1547
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 +66 -58
- package/dist/index.mjs +729 -46
- package/package.json +6 -6
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,7 +239,14 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
|
|
|
71
239
|
chatgpt: widgetScreenshotSchema.optional(),
|
|
72
240
|
claudeai: widgetScreenshotSchema.optional()
|
|
73
241
|
}) });
|
|
74
|
-
z.
|
|
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
|
+
});
|
|
249
|
+
const deploymentStatusSchema$1 = z.enum([
|
|
75
250
|
"ongoing",
|
|
76
251
|
"deployed",
|
|
77
252
|
"failed",
|
|
@@ -81,6 +256,125 @@ z.object({
|
|
|
81
256
|
timestamp: z.coerce.date().optional(),
|
|
82
257
|
content: z.string().optional()
|
|
83
258
|
});
|
|
259
|
+
const deploymentSummarySchema = z.object({
|
|
260
|
+
id: z.string(),
|
|
261
|
+
status: deploymentStatusSchema$1,
|
|
262
|
+
sourceBucket: z.string().nullable(),
|
|
263
|
+
sourceObjectKey: z.string().nullable(),
|
|
264
|
+
sourceRef: z.string().nullable(),
|
|
265
|
+
sourceCommitId: z.string().nullable(),
|
|
266
|
+
sourceCommitMessage: z.string().nullable(),
|
|
267
|
+
environmentId: z.string(),
|
|
268
|
+
authorUsername: z.string().nullable(),
|
|
269
|
+
authorAvatarUrl: z.string().nullable(),
|
|
270
|
+
startedAt: z.coerce.date().nullable(),
|
|
271
|
+
completedAt: z.coerce.date().nullable(),
|
|
272
|
+
isCurrent: z.boolean().optional(),
|
|
273
|
+
createdAt: z.coerce.date(),
|
|
274
|
+
updatedAt: z.coerce.date()
|
|
275
|
+
});
|
|
276
|
+
/**
|
|
277
|
+
* Public environment
|
|
278
|
+
*
|
|
279
|
+
* No OAuth metadata exposed.
|
|
280
|
+
*/
|
|
281
|
+
const publicEnvironmentSchema = z.object({
|
|
282
|
+
isPublic: z.literal(true),
|
|
283
|
+
oAuthMetadata: z.undefined().optional()
|
|
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
|
+
isPublic: z.literal(false),
|
|
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
|
+
isPublic: z.literal(false),
|
|
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
|
+
isPublic: z.literal(false),
|
|
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
|
+
isPublic: z.literal(false),
|
|
334
|
+
oAuthMetadata: z.strictObject({}),
|
|
335
|
+
scope: z.string().optional()
|
|
336
|
+
});
|
|
337
|
+
z.union([
|
|
338
|
+
publicEnvironmentSchema,
|
|
339
|
+
externalResourceMetadataEnvironmentSchema,
|
|
340
|
+
externalAuthorizationServerEnvironmentSchema,
|
|
341
|
+
standaloneEnvironmentSchema,
|
|
342
|
+
protectedWithoutDiscoveryEnvironmentSchema
|
|
343
|
+
]);
|
|
344
|
+
const allowedPlatformSchema = platformSchema;
|
|
345
|
+
const environmentDomainSchema = z.object({
|
|
346
|
+
domain: z.string(),
|
|
347
|
+
status: z.enum([
|
|
348
|
+
"ongoing",
|
|
349
|
+
"deployed",
|
|
350
|
+
"failed"
|
|
351
|
+
]),
|
|
352
|
+
createdAt: z.coerce.date(),
|
|
353
|
+
updatedAt: z.coerce.date()
|
|
354
|
+
});
|
|
355
|
+
const environmentSchema$1 = z.object({
|
|
356
|
+
id: z.string(),
|
|
357
|
+
name: z.string(),
|
|
358
|
+
sourceBranch: z.string().nullable(),
|
|
359
|
+
mcpServerUrl: z.string(),
|
|
360
|
+
activeDeployment: deploymentSummarySchema.optional(),
|
|
361
|
+
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
|
+
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
|
+
isPlaygroundEnabled: z.boolean(),
|
|
364
|
+
isIpWhitelistEnabled: z.boolean(),
|
|
365
|
+
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
|
+
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
367
|
+
projectId: z.string(),
|
|
368
|
+
createdAt: z.coerce.date(),
|
|
369
|
+
updatedAt: z.coerce.date()
|
|
370
|
+
});
|
|
371
|
+
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
372
|
+
z.object({
|
|
373
|
+
sessionReplayEnabled: z.boolean(),
|
|
374
|
+
collectRequestPayload: z.boolean(),
|
|
375
|
+
collectResponsePayload: z.boolean(),
|
|
376
|
+
collectErrorMessage: z.boolean()
|
|
377
|
+
});
|
|
84
378
|
z.object({
|
|
85
379
|
id: z.string(),
|
|
86
380
|
createdAt: z.coerce.date(),
|
|
@@ -197,6 +491,76 @@ const transportSchema = z.enum([
|
|
|
197
491
|
"sse",
|
|
198
492
|
"streamablehttp"
|
|
199
493
|
]);
|
|
494
|
+
z.object({
|
|
495
|
+
id: z.string(),
|
|
496
|
+
name: z.string(),
|
|
497
|
+
teamId: z.string(),
|
|
498
|
+
sourceRepository: z.string().nullable(),
|
|
499
|
+
createdAt: z.coerce.date().optional(),
|
|
500
|
+
runtime: runtimeSchema,
|
|
501
|
+
transport: transportSchema.nullable(),
|
|
502
|
+
rootDirectory: z.string().nullable(),
|
|
503
|
+
installCommand: z.string().nullable(),
|
|
504
|
+
buildCommand: z.string().nullable(),
|
|
505
|
+
buildOutputDir: z.string().nullable(),
|
|
506
|
+
startCommand: z.string().nullable(),
|
|
507
|
+
fixedOutboundIp: z.boolean(),
|
|
508
|
+
environments: z.array(environmentWithDomainsSchema),
|
|
509
|
+
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
510
|
+
});
|
|
511
|
+
z.object({
|
|
512
|
+
domain: z.string(),
|
|
513
|
+
createdAt: z.coerce.date(),
|
|
514
|
+
status: z.enum([
|
|
515
|
+
"ongoing",
|
|
516
|
+
"deployed",
|
|
517
|
+
"failed"
|
|
518
|
+
]),
|
|
519
|
+
environment: environmentSchema$1
|
|
520
|
+
});
|
|
521
|
+
const serverFieldsSchema$1 = z.object({
|
|
522
|
+
$schema: z.string(),
|
|
523
|
+
name: z.string(),
|
|
524
|
+
description: z.string(),
|
|
525
|
+
version: z.string().optional(),
|
|
526
|
+
title: z.string().optional(),
|
|
527
|
+
websiteUrl: z.string().optional(),
|
|
528
|
+
icons: z.array(z.object({
|
|
529
|
+
src: z.string(),
|
|
530
|
+
mimeType: z.string().optional(),
|
|
531
|
+
sizes: z.array(z.string()).optional()
|
|
532
|
+
})).optional(),
|
|
533
|
+
remotes: z.array(z.object({
|
|
534
|
+
type: z.string(),
|
|
535
|
+
url: z.string().optional(),
|
|
536
|
+
headers: z.array(z.object({
|
|
537
|
+
name: z.string(),
|
|
538
|
+
description: z.string(),
|
|
539
|
+
isRequired: z.boolean().optional(),
|
|
540
|
+
isSecret: z.boolean().optional()
|
|
541
|
+
})).optional()
|
|
542
|
+
})).optional()
|
|
543
|
+
}).catchall(z.unknown());
|
|
544
|
+
z.object({
|
|
545
|
+
serverFields: serverFieldsSchema$1,
|
|
546
|
+
source: z.enum(["registry", "defaults"])
|
|
547
|
+
});
|
|
548
|
+
/**
|
|
549
|
+
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
550
|
+
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
551
|
+
*
|
|
552
|
+
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
553
|
+
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
554
|
+
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
555
|
+
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
556
|
+
*/
|
|
557
|
+
const clampStringField = (field) => {
|
|
558
|
+
const max = field.maxLength;
|
|
559
|
+
if (max === null) return field;
|
|
560
|
+
const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
|
|
561
|
+
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
562
|
+
return field.description ? withMin.describe(field.description) : withMin;
|
|
563
|
+
};
|
|
200
564
|
const toolDefinitionSchema = z.object({
|
|
201
565
|
name: z.string(),
|
|
202
566
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -209,17 +573,19 @@ const toolDefinitionSchema = z.object({
|
|
|
209
573
|
}).optional()
|
|
210
574
|
});
|
|
211
575
|
const positiveTestCaseSchema = z.object({
|
|
212
|
-
scenario: z.string(),
|
|
213
|
-
userPrompt: z.string(),
|
|
214
|
-
toolTriggered: z.string().optional(),
|
|
215
|
-
expectedOutput: z.string().optional()
|
|
576
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
577
|
+
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."),
|
|
578
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
579
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
216
580
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
217
581
|
const screenshotEntrySchema = z.object({
|
|
218
582
|
prompt: z.string(),
|
|
219
|
-
url: z.url()
|
|
583
|
+
url: z.url().or(z.literal(""))
|
|
220
584
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
221
585
|
/** Accepts either a valid email or URL. */
|
|
222
586
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
587
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
588
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
223
589
|
const chatgptCategorySchema = z.enum([
|
|
224
590
|
"BUSINESS",
|
|
225
591
|
"COLLABORATION",
|
|
@@ -236,22 +602,315 @@ const chatgptCategorySchema = z.enum([
|
|
|
236
602
|
"TRAVEL"
|
|
237
603
|
]);
|
|
238
604
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
239
|
-
const
|
|
605
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
606
|
+
"AD",
|
|
607
|
+
"AE",
|
|
608
|
+
"AF",
|
|
609
|
+
"AG",
|
|
610
|
+
"AL",
|
|
611
|
+
"AM",
|
|
612
|
+
"AO",
|
|
613
|
+
"AR",
|
|
614
|
+
"AT",
|
|
615
|
+
"AU",
|
|
616
|
+
"AW",
|
|
617
|
+
"AX",
|
|
618
|
+
"AZ",
|
|
619
|
+
"BA",
|
|
620
|
+
"BB",
|
|
621
|
+
"BD",
|
|
622
|
+
"BE",
|
|
623
|
+
"BF",
|
|
624
|
+
"BG",
|
|
625
|
+
"BH",
|
|
626
|
+
"BI",
|
|
627
|
+
"BJ",
|
|
628
|
+
"BL",
|
|
629
|
+
"BM",
|
|
630
|
+
"BN",
|
|
631
|
+
"BO",
|
|
632
|
+
"BR",
|
|
633
|
+
"BS",
|
|
634
|
+
"BT",
|
|
635
|
+
"BW",
|
|
636
|
+
"BZ",
|
|
637
|
+
"CA",
|
|
638
|
+
"CD",
|
|
639
|
+
"CF",
|
|
640
|
+
"CG",
|
|
641
|
+
"CH",
|
|
642
|
+
"CI",
|
|
643
|
+
"CL",
|
|
644
|
+
"CM",
|
|
645
|
+
"CO",
|
|
646
|
+
"CR",
|
|
647
|
+
"CV",
|
|
648
|
+
"CY",
|
|
649
|
+
"CZ",
|
|
650
|
+
"DE",
|
|
651
|
+
"DJ",
|
|
652
|
+
"DK",
|
|
653
|
+
"DM",
|
|
654
|
+
"DO",
|
|
655
|
+
"DZ",
|
|
656
|
+
"EC",
|
|
657
|
+
"EE",
|
|
658
|
+
"EG",
|
|
659
|
+
"ER",
|
|
660
|
+
"ES",
|
|
661
|
+
"ET",
|
|
662
|
+
"FI",
|
|
663
|
+
"FJ",
|
|
664
|
+
"FM",
|
|
665
|
+
"FO",
|
|
666
|
+
"FR",
|
|
667
|
+
"GA",
|
|
668
|
+
"GB",
|
|
669
|
+
"GD",
|
|
670
|
+
"GE",
|
|
671
|
+
"GF",
|
|
672
|
+
"GH",
|
|
673
|
+
"GL",
|
|
674
|
+
"GM",
|
|
675
|
+
"GN",
|
|
676
|
+
"GP",
|
|
677
|
+
"GQ",
|
|
678
|
+
"GR",
|
|
679
|
+
"GT",
|
|
680
|
+
"GW",
|
|
681
|
+
"GY",
|
|
682
|
+
"HN",
|
|
683
|
+
"HR",
|
|
684
|
+
"HT",
|
|
685
|
+
"HU",
|
|
686
|
+
"ID",
|
|
687
|
+
"IE",
|
|
688
|
+
"IL",
|
|
689
|
+
"IN",
|
|
690
|
+
"IQ",
|
|
691
|
+
"IS",
|
|
692
|
+
"IT",
|
|
693
|
+
"JM",
|
|
694
|
+
"JO",
|
|
695
|
+
"JP",
|
|
696
|
+
"KE",
|
|
697
|
+
"KG",
|
|
698
|
+
"KH",
|
|
699
|
+
"KI",
|
|
700
|
+
"KM",
|
|
701
|
+
"KN",
|
|
702
|
+
"KR",
|
|
703
|
+
"KW",
|
|
704
|
+
"KY",
|
|
705
|
+
"KZ",
|
|
706
|
+
"LA",
|
|
707
|
+
"LB",
|
|
708
|
+
"LC",
|
|
709
|
+
"LI",
|
|
710
|
+
"LK",
|
|
711
|
+
"LR",
|
|
712
|
+
"LS",
|
|
713
|
+
"LT",
|
|
714
|
+
"LU",
|
|
715
|
+
"LV",
|
|
716
|
+
"LY",
|
|
717
|
+
"MA",
|
|
718
|
+
"MC",
|
|
719
|
+
"MD",
|
|
720
|
+
"ME",
|
|
721
|
+
"MF",
|
|
722
|
+
"MG",
|
|
723
|
+
"MH",
|
|
724
|
+
"MK",
|
|
725
|
+
"ML",
|
|
726
|
+
"MM",
|
|
727
|
+
"MN",
|
|
728
|
+
"MQ",
|
|
729
|
+
"MR",
|
|
730
|
+
"MT",
|
|
731
|
+
"MU",
|
|
732
|
+
"MV",
|
|
733
|
+
"MW",
|
|
734
|
+
"MX",
|
|
735
|
+
"MY",
|
|
736
|
+
"MZ",
|
|
737
|
+
"NA",
|
|
738
|
+
"NC",
|
|
739
|
+
"NE",
|
|
740
|
+
"NG",
|
|
741
|
+
"NI",
|
|
742
|
+
"NL",
|
|
743
|
+
"NO",
|
|
744
|
+
"NP",
|
|
745
|
+
"NR",
|
|
746
|
+
"NZ",
|
|
747
|
+
"OM",
|
|
748
|
+
"PA",
|
|
749
|
+
"PE",
|
|
750
|
+
"PF",
|
|
751
|
+
"PG",
|
|
752
|
+
"PH",
|
|
753
|
+
"PK",
|
|
754
|
+
"PL",
|
|
755
|
+
"PM",
|
|
756
|
+
"PS",
|
|
757
|
+
"PT",
|
|
758
|
+
"PW",
|
|
759
|
+
"PY",
|
|
760
|
+
"QA",
|
|
761
|
+
"RE",
|
|
762
|
+
"RO",
|
|
763
|
+
"RS",
|
|
764
|
+
"RW",
|
|
765
|
+
"SA",
|
|
766
|
+
"SB",
|
|
767
|
+
"SC",
|
|
768
|
+
"SD",
|
|
769
|
+
"SE",
|
|
770
|
+
"SG",
|
|
771
|
+
"SH",
|
|
772
|
+
"SI",
|
|
773
|
+
"SJ",
|
|
774
|
+
"SK",
|
|
775
|
+
"SL",
|
|
776
|
+
"SM",
|
|
777
|
+
"SN",
|
|
778
|
+
"SO",
|
|
779
|
+
"SR",
|
|
780
|
+
"SS",
|
|
781
|
+
"ST",
|
|
782
|
+
"SV",
|
|
783
|
+
"SZ",
|
|
784
|
+
"TD",
|
|
785
|
+
"TF",
|
|
786
|
+
"TG",
|
|
787
|
+
"TH",
|
|
788
|
+
"TJ",
|
|
789
|
+
"TL",
|
|
790
|
+
"TM",
|
|
791
|
+
"TN",
|
|
792
|
+
"TO",
|
|
793
|
+
"TR",
|
|
794
|
+
"TT",
|
|
795
|
+
"TV",
|
|
796
|
+
"TW",
|
|
797
|
+
"TZ",
|
|
798
|
+
"UA",
|
|
799
|
+
"UG",
|
|
800
|
+
"US",
|
|
801
|
+
"UY",
|
|
802
|
+
"UZ",
|
|
803
|
+
"VA",
|
|
804
|
+
"VC",
|
|
805
|
+
"VN",
|
|
806
|
+
"VU",
|
|
807
|
+
"WF",
|
|
808
|
+
"WS",
|
|
809
|
+
"YE",
|
|
810
|
+
"YT",
|
|
811
|
+
"ZA",
|
|
812
|
+
"ZM",
|
|
813
|
+
"ZW"
|
|
814
|
+
]);
|
|
815
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
816
|
+
z.object({ mode: z.literal("all") }),
|
|
817
|
+
z.object({
|
|
818
|
+
mode: z.literal("allow"),
|
|
819
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
820
|
+
}),
|
|
821
|
+
z.object({
|
|
822
|
+
mode: z.literal("block"),
|
|
823
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
824
|
+
})
|
|
825
|
+
]);
|
|
826
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
827
|
+
"am",
|
|
828
|
+
"ar",
|
|
829
|
+
"bg-BG",
|
|
830
|
+
"bn-BD",
|
|
831
|
+
"bs-BA",
|
|
832
|
+
"ca-ES",
|
|
833
|
+
"cs-CZ",
|
|
834
|
+
"da-DK",
|
|
835
|
+
"de-DE",
|
|
836
|
+
"el-GR",
|
|
837
|
+
"es-419",
|
|
838
|
+
"es-ES",
|
|
839
|
+
"et-EE",
|
|
840
|
+
"fi-FI",
|
|
841
|
+
"fr-CA",
|
|
842
|
+
"fr-FR",
|
|
843
|
+
"gu-IN",
|
|
844
|
+
"hi-IN",
|
|
845
|
+
"hr-HR",
|
|
846
|
+
"hu-HU",
|
|
847
|
+
"hy-AM",
|
|
848
|
+
"id-ID",
|
|
849
|
+
"is-IS",
|
|
850
|
+
"it-IT",
|
|
851
|
+
"ja-JP",
|
|
852
|
+
"ka-GE",
|
|
853
|
+
"kk",
|
|
854
|
+
"kn-IN",
|
|
855
|
+
"ko-KR",
|
|
856
|
+
"lt",
|
|
857
|
+
"lv-LV",
|
|
858
|
+
"mk-MK",
|
|
859
|
+
"ml",
|
|
860
|
+
"mn",
|
|
861
|
+
"mr-IN",
|
|
862
|
+
"ms-MY",
|
|
863
|
+
"my-MM",
|
|
864
|
+
"nb-NO",
|
|
865
|
+
"nl-NL",
|
|
866
|
+
"pa",
|
|
867
|
+
"pl-PL",
|
|
868
|
+
"pt-BR",
|
|
869
|
+
"pt-PT",
|
|
870
|
+
"ro-RO",
|
|
871
|
+
"ru-RU",
|
|
872
|
+
"sk-SK",
|
|
873
|
+
"sl-SI",
|
|
874
|
+
"so-SO",
|
|
875
|
+
"sq-AL",
|
|
876
|
+
"sr-RS",
|
|
877
|
+
"sv-SE",
|
|
878
|
+
"sw-TZ",
|
|
879
|
+
"ta-IN",
|
|
880
|
+
"te-IN",
|
|
881
|
+
"th-TH",
|
|
882
|
+
"tl",
|
|
883
|
+
"tr-TR",
|
|
884
|
+
"uk-UA",
|
|
885
|
+
"ur",
|
|
886
|
+
"vi-VN",
|
|
887
|
+
"zh-CN",
|
|
888
|
+
"zh-HK",
|
|
889
|
+
"zh-TW"
|
|
890
|
+
]);
|
|
240
891
|
const negativeTestCaseSchema = z.object({
|
|
241
892
|
scenario: z.string(),
|
|
242
893
|
userPrompt: z.string()
|
|
243
894
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
244
895
|
const chatgptToolJustificationSchema = z.object({
|
|
245
896
|
toolName: z.string(),
|
|
246
|
-
readOnlyJustification: z.string(),
|
|
247
|
-
openWorldJustification: z.string(),
|
|
248
|
-
destructiveJustification: z.string()
|
|
249
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
897
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
898
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
899
|
+
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.\"")
|
|
900
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
901
|
+
/**
|
|
902
|
+
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
903
|
+
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
904
|
+
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
905
|
+
*/
|
|
906
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
907
|
+
const chatgptDescriptionSchema = z.string();
|
|
250
908
|
const chatgptTranslationSchema = z.object({
|
|
251
|
-
locale:
|
|
252
|
-
tagline:
|
|
253
|
-
description:
|
|
909
|
+
locale: chatgptTranslationLocaleSchema,
|
|
910
|
+
tagline: chatgptTaglineSchema,
|
|
911
|
+
description: chatgptDescriptionSchema
|
|
254
912
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
913
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
255
914
|
/**
|
|
256
915
|
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
257
916
|
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
@@ -260,25 +919,25 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
260
919
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
261
920
|
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."),
|
|
262
921
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
263
|
-
tagline:
|
|
264
|
-
description:
|
|
922
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
923
|
+
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)."),
|
|
265
924
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
266
925
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
267
|
-
companyUrl:
|
|
926
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
268
927
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
269
|
-
privacyPolicyUrl:
|
|
270
|
-
termsOfServiceUrl:
|
|
271
|
-
demoRecordingUrl:
|
|
928
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
929
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
930
|
+
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."),
|
|
272
931
|
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."),
|
|
273
|
-
serverUrl:
|
|
932
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
274
933
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
275
934
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
276
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
277
|
-
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output.
|
|
278
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases
|
|
279
|
-
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
|
|
935
|
+
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."),
|
|
936
|
+
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."),
|
|
937
|
+
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."),
|
|
938
|
+
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."),
|
|
280
939
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
281
|
-
allowedCountries: chatgptAllowedCountriesSchema.describe("
|
|
940
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
282
941
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
283
942
|
});
|
|
284
943
|
chatgptSubmissionFormDataSchema.pick({
|
|
@@ -295,7 +954,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
295
954
|
testCases: true,
|
|
296
955
|
negativeTestCases: true,
|
|
297
956
|
toolJustifications: true
|
|
298
|
-
});
|
|
957
|
+
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
299
958
|
const claudeCategorySchema = z.enum([
|
|
300
959
|
"Business & Productivity",
|
|
301
960
|
"Communication",
|
|
@@ -307,7 +966,7 @@ const claudeCategorySchema = z.enum([
|
|
|
307
966
|
"Media & Entertainment",
|
|
308
967
|
"Commerce & Shopping"
|
|
309
968
|
]);
|
|
310
|
-
z.enum([
|
|
969
|
+
const claudeAuthenticationSchema = z.enum([
|
|
311
970
|
"No auth needed",
|
|
312
971
|
"OAuth 2.0",
|
|
313
972
|
"Custom URL"
|
|
@@ -315,28 +974,34 @@ z.enum([
|
|
|
315
974
|
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
316
975
|
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
317
976
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
318
|
-
"Read
|
|
319
|
-
"Write
|
|
320
|
-
"Read +
|
|
977
|
+
"Read Only",
|
|
978
|
+
"Write Only",
|
|
979
|
+
"Read + Write"
|
|
321
980
|
]);
|
|
322
981
|
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
982
|
+
const claudeTestedSurfaceSchema = z.enum([
|
|
983
|
+
"Claude.ai (web)",
|
|
984
|
+
"Claude Desktop",
|
|
985
|
+
"Claude Code",
|
|
986
|
+
"Cowork"
|
|
987
|
+
]);
|
|
323
988
|
const claudeThirdPartySchema = z.enum([
|
|
324
|
-
"Web access
|
|
325
|
-
"Third-party AI model integration",
|
|
326
|
-
"Third-party data retrieval (
|
|
327
|
-
"Third-party data modification (
|
|
989
|
+
"Web access: Fetches information from the open web (e.g., web scraping, search engines, or browsing arbitrary URLs, not just connecting to a specific API)",
|
|
990
|
+
"Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
|
|
991
|
+
"Third-party data retrieval: Connects to external services that themselves retrieve data from other sources (e.g., workflow automation platforms or other services that aggregate or relay data from multiple third-party sources)",
|
|
992
|
+
"Third-party data modification: Can connect to external services that themselves create, update, or delete data in other sources (e.g., workflow automation platforms or other services that write to multiple third-party sources)",
|
|
328
993
|
"N/A"
|
|
329
994
|
]);
|
|
330
995
|
const claudeDataHandlingSchema = z.enum([
|
|
331
996
|
"Server only accesses data explicitly requested by user",
|
|
332
997
|
"No data is stored beyond session requirements",
|
|
333
|
-
"Data transmission is encrypted (HTTPS
|
|
998
|
+
"Data transmission is encrypted (HTTPS/TLS)",
|
|
334
999
|
"GDPR compliant (if applicable)"
|
|
335
1000
|
]);
|
|
336
1001
|
const claudeSponsoredContentSchema = z.enum([
|
|
337
1002
|
"No, there is no sponsored content or advertisements",
|
|
338
1003
|
"Yes, there are banner ads or other paid visual elements",
|
|
339
|
-
"Yes, returned content or ranking is impacted by sponsorship or ad placement"
|
|
1004
|
+
"Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement"
|
|
340
1005
|
]);
|
|
341
1006
|
/**
|
|
342
1007
|
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
@@ -401,7 +1066,7 @@ If 'Yes', you will also be required to provide screenshots of your UI (see Promo
|
|
|
401
1066
|
Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
|
|
402
1067
|
personalDataHealthAccess: z.boolean().describe(`Select 'Yes' ONLY if your connector gives users access to their own personal health information — such as medical records, lab results, diagnoses, prescriptions, wearable health metrics (heart rate, sleep data, etc.), or mental health data.
|
|
403
1068
|
Select 'No' for the vast majority of business/productivity/dev tools. When in doubt, select 'No'. This field triggers additional compliance review if 'Yes'.`),
|
|
404
|
-
|
|
1069
|
+
category: claudeCategorySchema.describe(`Select the category that best describes your connector. This determines where it appears in the directory's browse experience. Choose the most specific fit:
|
|
405
1070
|
• Business & Productivity — project management, CRM, HR, office tools
|
|
406
1071
|
• Communication — email, chat, messaging, notifications
|
|
407
1072
|
• Data & Analytics — dashboards, reporting, databases, BI tools
|
|
@@ -411,12 +1076,13 @@ Select 'No' for the vast majority of business/productivity/dev tools. When in do
|
|
|
411
1076
|
• Health & Life Sciences — clinical, pharma, medical professional tools
|
|
412
1077
|
• Media & Entertainment — content, publishing, streaming
|
|
413
1078
|
• Commerce & Shopping — e-commerce, inventory, orders
|
|
414
|
-
|
|
1079
|
+
Anthropic's submission form only accepts a single category.`),
|
|
415
1080
|
sponsoredContentsOrAdvertisement: claudeSponsoredContentSchema.describe(`Be honest here — advertising is not permitted in the Connectors Directory per Anthropic's policy. Select the option that accurately describes your server:
|
|
416
1081
|
• 'No, there is no sponsored content or advertisements' — the results your server returns are not influenced by paid placement or sponsorship. This is what almost all connectors should select.
|
|
417
1082
|
• 'Yes, there are banner ads or other paid visual elements' — your UI includes visual ads. NOTE: this will likely lead to rejection, as Anthropic prohibits advertising in Claude.
|
|
418
1083
|
• 'Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement' — paid results affect what you return. NOTE: this also likely leads to rejection.
|
|
419
1084
|
If your server returns organic results from a platform that has ads in its own UI (but your API results are not affected by ads), select 'No'.`),
|
|
1085
|
+
authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
|
|
420
1086
|
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
421
1087
|
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
422
1088
|
• '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.
|
|
@@ -456,6 +1122,7 @@ Reviewers test every single tool you list here — don't list tools that don't w
|
|
|
456
1122
|
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
457
1123
|
• '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).
|
|
458
1124
|
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.`),
|
|
1125
|
+
testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
|
|
459
1126
|
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
460
1127
|
• Format: SVG only
|
|
461
1128
|
• Aspect ratio: square (1:1)
|
|
@@ -482,17 +1149,24 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
482
1149
|
isMcpApp: true,
|
|
483
1150
|
transportSupport: true,
|
|
484
1151
|
primaryContactEmail: true,
|
|
485
|
-
primaryContactName: true
|
|
1152
|
+
primaryContactName: true,
|
|
1153
|
+
authentication: true,
|
|
1154
|
+
personalDataHealthAccess: true,
|
|
1155
|
+
testedSurfaces: true
|
|
1156
|
+
}).extend({
|
|
1157
|
+
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1158
|
+
testingCredentials: claudeSubmissionFormDataSchema.shape.testingCredentials.optional()
|
|
486
1159
|
});
|
|
487
1160
|
claudeSubmissionFormDataSchema.pick({
|
|
488
1161
|
tagline: true,
|
|
489
1162
|
description: true,
|
|
490
|
-
|
|
1163
|
+
category: true,
|
|
491
1164
|
testCases: true
|
|
492
|
-
});
|
|
1165
|
+
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
493
1166
|
const submissionMetaFieldsSchema = z.object({
|
|
494
1167
|
id: z.string(),
|
|
495
1168
|
environmentId: z.string(),
|
|
1169
|
+
auditId: z.string().nullable(),
|
|
496
1170
|
createdAt: z.coerce.date(),
|
|
497
1171
|
updatedAt: z.coerce.date()
|
|
498
1172
|
});
|
|
@@ -668,7 +1342,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
668
1342
|
id: z.string(),
|
|
669
1343
|
name: z.string(),
|
|
670
1344
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
671
|
-
urls: z.array(z.
|
|
1345
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
672
1346
|
createdAt: z.coerce.date(),
|
|
673
1347
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
674
1348
|
}));
|
|
@@ -744,6 +1418,9 @@ const listProjectsContractV1 = oc.route({
|
|
|
744
1418
|
description: "List all projects for a team",
|
|
745
1419
|
tags: ["projects"],
|
|
746
1420
|
successDescription: "The list of projects"
|
|
1421
|
+
}).errors({
|
|
1422
|
+
NOT_FOUND: {},
|
|
1423
|
+
BAD_REQUEST: {}
|
|
747
1424
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
748
1425
|
const createProjectContractV1 = oc.route({
|
|
749
1426
|
path: "/v1/projects",
|
|
@@ -839,7 +1516,10 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
839
1516
|
description: "Delete an environment variable by ID",
|
|
840
1517
|
tags: ["environments"],
|
|
841
1518
|
successDescription: "The environment variable has been deleted successfully"
|
|
842
|
-
}).errors({
|
|
1519
|
+
}).errors({
|
|
1520
|
+
NOT_FOUND: {},
|
|
1521
|
+
BAD_REQUEST: {}
|
|
1522
|
+
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
843
1523
|
const deleteProjectContractV1 = oc.route({
|
|
844
1524
|
path: "/v1/projects/{projectId}",
|
|
845
1525
|
method: "DELETE",
|
|
@@ -884,6 +1564,9 @@ const uploadDeploymentArtifactContractV1 = oc.route({
|
|
|
884
1564
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
885
1565
|
tags: ["deployments"],
|
|
886
1566
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1567
|
+
}).errors({
|
|
1568
|
+
NOT_FOUND: {},
|
|
1569
|
+
BAD_REQUEST: {}
|
|
887
1570
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
888
1571
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
889
1572
|
token: z.string().describe("Token to identify the source archive"),
|
|
@@ -1057,7 +1740,7 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1057
1740
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1058
1741
|
tags: ["tunnels"],
|
|
1059
1742
|
successDescription: "The tunnel ticket"
|
|
1060
|
-
}).output(z.object({
|
|
1743
|
+
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1061
1744
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1062
1745
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1063
1746
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
@@ -1133,7 +1816,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1133
1816
|
name: z.string().min(1).max(100).optional(),
|
|
1134
1817
|
description: z.string().min(1).max(500).optional(),
|
|
1135
1818
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1136
|
-
examplePrompts: z.array(playgroundExamplePromptSchema).max(
|
|
1819
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1137
1820
|
})).output(playgroundOutputSchema);
|
|
1138
1821
|
const createBeaconContractV1 = oc.route({
|
|
1139
1822
|
path: "/v1/beacon/audits",
|