@alpic-ai/api 0.0.0-dev.gf6f4f78 → 0.0.0-dev.gf73de62
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 +994 -60
- package/dist/index.mjs +820 -250
- package/package.json +23 -7
package/dist/index.mjs
CHANGED
|
@@ -1,11 +1,189 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
|
+
import * as z$1 from "zod/v4";
|
|
2
3
|
import { oc } from "@orpc/contract";
|
|
3
4
|
import ms from "ms";
|
|
4
|
-
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
|
+
/**
|
|
7
|
+
* Reusable URL validation that disallows javascript: scheme
|
|
8
|
+
*/
|
|
9
|
+
const SafeUrlSchema = z$1.url().superRefine((val, ctx) => {
|
|
10
|
+
if (!URL.canParse(val)) {
|
|
11
|
+
ctx.addIssue({
|
|
12
|
+
code: z$1.ZodIssueCode.custom,
|
|
13
|
+
message: "URL must be parseable",
|
|
14
|
+
fatal: true
|
|
15
|
+
});
|
|
16
|
+
return z$1.NEVER;
|
|
17
|
+
}
|
|
18
|
+
}).refine((url) => {
|
|
19
|
+
const u = new URL(url);
|
|
20
|
+
return u.protocol !== "javascript:" && u.protocol !== "data:" && u.protocol !== "vbscript:";
|
|
21
|
+
}, { message: "URL cannot use javascript:, data:, or vbscript: scheme" });
|
|
22
|
+
/**
|
|
23
|
+
* RFC 9728 OAuth Protected Resource Metadata
|
|
24
|
+
*/
|
|
25
|
+
const OAuthProtectedResourceMetadataSchema = z$1.looseObject({
|
|
26
|
+
resource: z$1.string().url(),
|
|
27
|
+
authorization_servers: z$1.array(SafeUrlSchema).optional(),
|
|
28
|
+
jwks_uri: z$1.string().url().optional(),
|
|
29
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
30
|
+
bearer_methods_supported: z$1.array(z$1.string()).optional(),
|
|
31
|
+
resource_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
32
|
+
resource_name: z$1.string().optional(),
|
|
33
|
+
resource_documentation: z$1.string().optional(),
|
|
34
|
+
resource_policy_uri: z$1.string().url().optional(),
|
|
35
|
+
resource_tos_uri: z$1.string().url().optional(),
|
|
36
|
+
tls_client_certificate_bound_access_tokens: z$1.boolean().optional(),
|
|
37
|
+
authorization_details_types_supported: z$1.array(z$1.string()).optional(),
|
|
38
|
+
dpop_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
39
|
+
dpop_bound_access_tokens_required: z$1.boolean().optional()
|
|
40
|
+
});
|
|
41
|
+
/**
|
|
42
|
+
* RFC 8414 OAuth 2.0 Authorization Server Metadata
|
|
43
|
+
*/
|
|
44
|
+
const OAuthMetadataSchema = z$1.looseObject({
|
|
45
|
+
issuer: z$1.string(),
|
|
46
|
+
authorization_endpoint: SafeUrlSchema,
|
|
47
|
+
token_endpoint: SafeUrlSchema,
|
|
48
|
+
registration_endpoint: SafeUrlSchema.optional(),
|
|
49
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
50
|
+
response_types_supported: z$1.array(z$1.string()),
|
|
51
|
+
response_modes_supported: z$1.array(z$1.string()).optional(),
|
|
52
|
+
grant_types_supported: z$1.array(z$1.string()).optional(),
|
|
53
|
+
token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
54
|
+
token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
55
|
+
service_documentation: SafeUrlSchema.optional(),
|
|
56
|
+
revocation_endpoint: SafeUrlSchema.optional(),
|
|
57
|
+
revocation_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
58
|
+
revocation_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
59
|
+
introspection_endpoint: z$1.string().optional(),
|
|
60
|
+
introspection_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
61
|
+
introspection_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
62
|
+
code_challenge_methods_supported: z$1.array(z$1.string()).optional(),
|
|
63
|
+
client_id_metadata_document_supported: z$1.boolean().optional()
|
|
64
|
+
});
|
|
65
|
+
/**
|
|
66
|
+
* OpenID Connect Discovery 1.0 Provider Metadata
|
|
67
|
+
* see: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
|
|
68
|
+
*/
|
|
69
|
+
const OpenIdProviderMetadataSchema = z$1.looseObject({
|
|
70
|
+
issuer: z$1.string(),
|
|
71
|
+
authorization_endpoint: SafeUrlSchema,
|
|
72
|
+
token_endpoint: SafeUrlSchema,
|
|
73
|
+
userinfo_endpoint: SafeUrlSchema.optional(),
|
|
74
|
+
jwks_uri: SafeUrlSchema,
|
|
75
|
+
registration_endpoint: SafeUrlSchema.optional(),
|
|
76
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
77
|
+
response_types_supported: z$1.array(z$1.string()),
|
|
78
|
+
response_modes_supported: z$1.array(z$1.string()).optional(),
|
|
79
|
+
grant_types_supported: z$1.array(z$1.string()).optional(),
|
|
80
|
+
acr_values_supported: z$1.array(z$1.string()).optional(),
|
|
81
|
+
subject_types_supported: z$1.array(z$1.string()),
|
|
82
|
+
id_token_signing_alg_values_supported: z$1.array(z$1.string()),
|
|
83
|
+
id_token_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
84
|
+
id_token_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
85
|
+
userinfo_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
86
|
+
userinfo_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
87
|
+
userinfo_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
88
|
+
request_object_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
89
|
+
request_object_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
90
|
+
request_object_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
91
|
+
token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
92
|
+
token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
93
|
+
display_values_supported: z$1.array(z$1.string()).optional(),
|
|
94
|
+
claim_types_supported: z$1.array(z$1.string()).optional(),
|
|
95
|
+
claims_supported: z$1.array(z$1.string()).optional(),
|
|
96
|
+
service_documentation: z$1.string().optional(),
|
|
97
|
+
claims_locales_supported: z$1.array(z$1.string()).optional(),
|
|
98
|
+
ui_locales_supported: z$1.array(z$1.string()).optional(),
|
|
99
|
+
claims_parameter_supported: z$1.boolean().optional(),
|
|
100
|
+
request_parameter_supported: z$1.boolean().optional(),
|
|
101
|
+
request_uri_parameter_supported: z$1.boolean().optional(),
|
|
102
|
+
require_request_uri_registration: z$1.boolean().optional(),
|
|
103
|
+
op_policy_uri: SafeUrlSchema.optional(),
|
|
104
|
+
op_tos_uri: SafeUrlSchema.optional(),
|
|
105
|
+
client_id_metadata_document_supported: z$1.boolean().optional()
|
|
106
|
+
});
|
|
107
|
+
/**
|
|
108
|
+
* OpenID Connect Discovery metadata that may include OAuth 2.0 fields
|
|
109
|
+
* This schema represents the real-world scenario where OIDC providers
|
|
110
|
+
* return a mix of OpenID Connect and OAuth 2.0 metadata fields
|
|
111
|
+
*/
|
|
112
|
+
const OpenIdProviderDiscoveryMetadataSchema = z$1.object({
|
|
113
|
+
...OpenIdProviderMetadataSchema.shape,
|
|
114
|
+
...OAuthMetadataSchema.pick({ code_challenge_methods_supported: true }).shape
|
|
115
|
+
});
|
|
116
|
+
z$1.object({
|
|
117
|
+
access_token: z$1.string(),
|
|
118
|
+
id_token: z$1.string().optional(),
|
|
119
|
+
token_type: z$1.string(),
|
|
120
|
+
expires_in: z$1.coerce.number().optional(),
|
|
121
|
+
scope: z$1.string().optional(),
|
|
122
|
+
refresh_token: z$1.string().optional()
|
|
123
|
+
}).strip();
|
|
124
|
+
z$1.object({
|
|
125
|
+
error: z$1.string(),
|
|
126
|
+
error_description: z$1.string().optional(),
|
|
127
|
+
error_uri: z$1.string().optional()
|
|
128
|
+
});
|
|
129
|
+
/**
|
|
130
|
+
* Optional version of SafeUrlSchema that allows empty string for retrocompatibility on tos_uri and logo_uri
|
|
131
|
+
*/
|
|
132
|
+
const OptionalSafeUrlSchema = SafeUrlSchema.optional().or(z$1.literal("").transform(() => void 0));
|
|
133
|
+
/**
|
|
134
|
+
* RFC 7591 OAuth 2.0 Dynamic Client Registration metadata
|
|
135
|
+
*/
|
|
136
|
+
const OAuthClientMetadataSchema = z$1.object({
|
|
137
|
+
redirect_uris: z$1.array(SafeUrlSchema),
|
|
138
|
+
token_endpoint_auth_method: z$1.string().optional(),
|
|
139
|
+
grant_types: z$1.array(z$1.string()).optional(),
|
|
140
|
+
response_types: z$1.array(z$1.string()).optional(),
|
|
141
|
+
client_name: z$1.string().optional(),
|
|
142
|
+
client_uri: SafeUrlSchema.optional(),
|
|
143
|
+
logo_uri: OptionalSafeUrlSchema,
|
|
144
|
+
scope: z$1.string().optional(),
|
|
145
|
+
contacts: z$1.array(z$1.string()).optional(),
|
|
146
|
+
tos_uri: OptionalSafeUrlSchema,
|
|
147
|
+
policy_uri: z$1.string().optional(),
|
|
148
|
+
jwks_uri: SafeUrlSchema.optional(),
|
|
149
|
+
jwks: z$1.any().optional(),
|
|
150
|
+
software_id: z$1.string().optional(),
|
|
151
|
+
software_version: z$1.string().optional(),
|
|
152
|
+
software_statement: z$1.string().optional()
|
|
153
|
+
}).strip();
|
|
154
|
+
/**
|
|
155
|
+
* RFC 7591 OAuth 2.0 Dynamic Client Registration client information
|
|
156
|
+
*/
|
|
157
|
+
const OAuthClientInformationSchema = z$1.object({
|
|
158
|
+
client_id: z$1.string(),
|
|
159
|
+
client_secret: z$1.string().optional(),
|
|
160
|
+
client_id_issued_at: z$1.number().optional(),
|
|
161
|
+
client_secret_expires_at: z$1.number().optional()
|
|
162
|
+
}).strip();
|
|
163
|
+
OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
|
|
164
|
+
z$1.object({
|
|
165
|
+
error: z$1.string(),
|
|
166
|
+
error_description: z$1.string().optional()
|
|
167
|
+
}).strip();
|
|
168
|
+
z$1.object({
|
|
169
|
+
token: z$1.string(),
|
|
170
|
+
token_type_hint: z$1.string().optional()
|
|
171
|
+
}).strip();
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
5
176
|
const PLATFORM_LABELS = {
|
|
6
177
|
chatgpt: "ChatGPT",
|
|
7
178
|
claudeai: "Claude.ai"
|
|
8
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cloudflare",
|
|
183
|
+
"fastly"
|
|
184
|
+
];
|
|
185
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
186
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
9
187
|
const auditStatusSchema = z.enum([
|
|
10
188
|
"pending",
|
|
11
189
|
"partial",
|
|
@@ -71,6 +249,13 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
|
|
|
71
249
|
chatgpt: widgetScreenshotSchema.optional(),
|
|
72
250
|
claudeai: widgetScreenshotSchema.optional()
|
|
73
251
|
}) });
|
|
252
|
+
z.object({
|
|
253
|
+
id: z.string(),
|
|
254
|
+
environmentId: z.string(),
|
|
255
|
+
clientId: z.string(),
|
|
256
|
+
clientSecret: z.string(),
|
|
257
|
+
clientScopes: z.array(z.string())
|
|
258
|
+
});
|
|
74
259
|
const deploymentStatusSchema$1 = z.enum([
|
|
75
260
|
"ongoing",
|
|
76
261
|
"deployed",
|
|
@@ -98,9 +283,91 @@ const deploymentSummarySchema = z.object({
|
|
|
98
283
|
createdAt: z.coerce.date(),
|
|
99
284
|
updatedAt: z.coerce.date()
|
|
100
285
|
});
|
|
101
|
-
|
|
286
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
287
|
+
const publicEnvironmentSchema = z.object({
|
|
288
|
+
allowsAnonymous: z.literal(true),
|
|
289
|
+
oAuthMetadata: z.strictObject({})
|
|
290
|
+
});
|
|
291
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
292
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
293
|
+
allowsAnonymous: z.boolean(),
|
|
294
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
295
|
+
scope: z.string().optional()
|
|
296
|
+
});
|
|
297
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
298
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
299
|
+
allowsAnonymous: z.boolean(),
|
|
300
|
+
oAuthMetadata: z.object({
|
|
301
|
+
externalAuthorizationServerUrl: z.url(),
|
|
302
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
303
|
+
}),
|
|
304
|
+
scope: z.string().optional()
|
|
305
|
+
});
|
|
306
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
307
|
+
const standaloneEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.boolean(),
|
|
309
|
+
oAuthMetadata: z.object({
|
|
310
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
311
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
312
|
+
}),
|
|
313
|
+
scope: z.string().optional()
|
|
314
|
+
});
|
|
315
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
316
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
317
|
+
allowsAnonymous: z.literal(false),
|
|
318
|
+
oAuthMetadata: z.strictObject({}),
|
|
319
|
+
scope: z.string().optional()
|
|
320
|
+
});
|
|
321
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
322
|
+
isPublic: z.literal(true),
|
|
323
|
+
oAuthMetadata: z.undefined().optional()
|
|
324
|
+
});
|
|
325
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
326
|
+
isPublic: z.literal(false),
|
|
327
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
328
|
+
scope: z.string().optional()
|
|
329
|
+
});
|
|
330
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
331
|
+
isPublic: z.literal(false),
|
|
332
|
+
oAuthMetadata: z.object({
|
|
333
|
+
externalAuthorizationServerUrl: z.url(),
|
|
334
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
335
|
+
}),
|
|
336
|
+
scope: z.string().optional()
|
|
337
|
+
});
|
|
338
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
339
|
+
isPublic: z.literal(false),
|
|
340
|
+
oAuthMetadata: z.object({
|
|
341
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
342
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
343
|
+
}),
|
|
344
|
+
scope: z.string().optional()
|
|
345
|
+
});
|
|
346
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
347
|
+
isPublic: z.literal(false),
|
|
348
|
+
oAuthMetadata: z.strictObject({}),
|
|
349
|
+
scope: z.string().optional()
|
|
350
|
+
});
|
|
351
|
+
z.union([
|
|
352
|
+
publicEnvironmentSchema,
|
|
353
|
+
externalResourceMetadataEnvironmentSchema,
|
|
354
|
+
externalAuthorizationServerEnvironmentSchema,
|
|
355
|
+
standaloneEnvironmentSchema,
|
|
356
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
357
|
+
legacyPublicEnvironmentSchema,
|
|
358
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
359
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
360
|
+
legacyStandaloneEnvironmentSchema,
|
|
361
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
362
|
+
]);
|
|
363
|
+
const playgroundModelSchema = z.enum([
|
|
364
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
365
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
366
|
+
"openai.gpt-5.4",
|
|
367
|
+
"openai.gpt-5.5"
|
|
368
|
+
]);
|
|
102
369
|
const environmentDomainSchema = z.object({
|
|
103
|
-
|
|
370
|
+
name: z.string(),
|
|
104
371
|
status: z.enum([
|
|
105
372
|
"ongoing",
|
|
106
373
|
"deployed",
|
|
@@ -118,6 +385,7 @@ const environmentSchema$1 = z.object({
|
|
|
118
385
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
119
386
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
120
387
|
isPlaygroundEnabled: z.boolean(),
|
|
388
|
+
playgroundModel: playgroundModelSchema,
|
|
121
389
|
isIpWhitelistEnabled: z.boolean(),
|
|
122
390
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
123
391
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -126,6 +394,14 @@ const environmentSchema$1 = z.object({
|
|
|
126
394
|
updatedAt: z.coerce.date()
|
|
127
395
|
});
|
|
128
396
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
397
|
+
z.object({
|
|
398
|
+
sessionReplayEnabled: z.boolean(),
|
|
399
|
+
collectRequestPayload: z.boolean(),
|
|
400
|
+
collectResponsePayload: z.boolean(),
|
|
401
|
+
collectErrorMessage: z.boolean(),
|
|
402
|
+
collectUserData: z.boolean(),
|
|
403
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
404
|
+
});
|
|
129
405
|
z.object({
|
|
130
406
|
id: z.string(),
|
|
131
407
|
createdAt: z.coerce.date(),
|
|
@@ -259,15 +535,27 @@ z.object({
|
|
|
259
535
|
environments: z.array(environmentWithDomainsSchema),
|
|
260
536
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
261
537
|
});
|
|
538
|
+
const domainFailureReasonSchema = z.enum([
|
|
539
|
+
"caa",
|
|
540
|
+
"dns",
|
|
541
|
+
"invalid_domain",
|
|
542
|
+
"other"
|
|
543
|
+
]);
|
|
544
|
+
const projectDomainMappingSchema = z.object({
|
|
545
|
+
pathPrefix: z.string(),
|
|
546
|
+
environment: environmentSchema$1
|
|
547
|
+
});
|
|
262
548
|
z.object({
|
|
263
|
-
|
|
549
|
+
name: z.string(),
|
|
264
550
|
createdAt: z.coerce.date(),
|
|
265
551
|
status: z.enum([
|
|
266
552
|
"ongoing",
|
|
267
553
|
"deployed",
|
|
268
554
|
"failed"
|
|
269
555
|
]),
|
|
270
|
-
|
|
556
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
557
|
+
environment: environmentSchema$1,
|
|
558
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
271
559
|
});
|
|
272
560
|
const serverFieldsSchema$1 = z.object({
|
|
273
561
|
$schema: z.string(),
|
|
@@ -296,6 +584,14 @@ z.object({
|
|
|
296
584
|
serverFields: serverFieldsSchema$1,
|
|
297
585
|
source: z.enum(["registry", "defaults"])
|
|
298
586
|
});
|
|
587
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
588
|
+
const clampStringField = (field) => {
|
|
589
|
+
const max = field.maxLength;
|
|
590
|
+
if (max === null) return field;
|
|
591
|
+
const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
|
|
592
|
+
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
593
|
+
return field.description ? withMin.describe(field.description) : withMin;
|
|
594
|
+
};
|
|
299
595
|
const toolDefinitionSchema = z.object({
|
|
300
596
|
name: z.string(),
|
|
301
597
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -308,13 +604,20 @@ const toolDefinitionSchema = z.object({
|
|
|
308
604
|
}).optional()
|
|
309
605
|
});
|
|
310
606
|
const positiveTestCaseSchema = z.object({
|
|
311
|
-
scenario: z.string(),
|
|
312
|
-
userPrompt: z.string(),
|
|
313
|
-
toolTriggered: z.string().optional(),
|
|
314
|
-
expectedOutput: z.string().optional()
|
|
607
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
608
|
+
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."),
|
|
609
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
610
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
315
611
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
612
|
+
const screenshotEntrySchema = z.object({
|
|
613
|
+
prompt: z.string(),
|
|
614
|
+
url: z.url()
|
|
615
|
+
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
616
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
316
617
|
/** Accepts either a valid email or URL. */
|
|
317
618
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
619
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
620
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
318
621
|
const chatgptCategorySchema = z.enum([
|
|
319
622
|
"BUSINESS",
|
|
320
623
|
"COLLABORATION",
|
|
@@ -331,51 +634,348 @@ const chatgptCategorySchema = z.enum([
|
|
|
331
634
|
"TRAVEL"
|
|
332
635
|
]);
|
|
333
636
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
334
|
-
const
|
|
637
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
638
|
+
"AD",
|
|
639
|
+
"AE",
|
|
640
|
+
"AF",
|
|
641
|
+
"AG",
|
|
642
|
+
"AL",
|
|
643
|
+
"AM",
|
|
644
|
+
"AO",
|
|
645
|
+
"AR",
|
|
646
|
+
"AT",
|
|
647
|
+
"AU",
|
|
648
|
+
"AW",
|
|
649
|
+
"AX",
|
|
650
|
+
"AZ",
|
|
651
|
+
"BA",
|
|
652
|
+
"BB",
|
|
653
|
+
"BD",
|
|
654
|
+
"BE",
|
|
655
|
+
"BF",
|
|
656
|
+
"BG",
|
|
657
|
+
"BH",
|
|
658
|
+
"BI",
|
|
659
|
+
"BJ",
|
|
660
|
+
"BL",
|
|
661
|
+
"BM",
|
|
662
|
+
"BN",
|
|
663
|
+
"BO",
|
|
664
|
+
"BR",
|
|
665
|
+
"BS",
|
|
666
|
+
"BT",
|
|
667
|
+
"BW",
|
|
668
|
+
"BZ",
|
|
669
|
+
"CA",
|
|
670
|
+
"CD",
|
|
671
|
+
"CF",
|
|
672
|
+
"CG",
|
|
673
|
+
"CH",
|
|
674
|
+
"CI",
|
|
675
|
+
"CL",
|
|
676
|
+
"CM",
|
|
677
|
+
"CO",
|
|
678
|
+
"CR",
|
|
679
|
+
"CV",
|
|
680
|
+
"CY",
|
|
681
|
+
"CZ",
|
|
682
|
+
"DE",
|
|
683
|
+
"DJ",
|
|
684
|
+
"DK",
|
|
685
|
+
"DM",
|
|
686
|
+
"DO",
|
|
687
|
+
"DZ",
|
|
688
|
+
"EC",
|
|
689
|
+
"EE",
|
|
690
|
+
"EG",
|
|
691
|
+
"ER",
|
|
692
|
+
"ES",
|
|
693
|
+
"ET",
|
|
694
|
+
"FI",
|
|
695
|
+
"FJ",
|
|
696
|
+
"FM",
|
|
697
|
+
"FO",
|
|
698
|
+
"FR",
|
|
699
|
+
"GA",
|
|
700
|
+
"GB",
|
|
701
|
+
"GD",
|
|
702
|
+
"GE",
|
|
703
|
+
"GF",
|
|
704
|
+
"GH",
|
|
705
|
+
"GL",
|
|
706
|
+
"GM",
|
|
707
|
+
"GN",
|
|
708
|
+
"GP",
|
|
709
|
+
"GQ",
|
|
710
|
+
"GR",
|
|
711
|
+
"GT",
|
|
712
|
+
"GW",
|
|
713
|
+
"GY",
|
|
714
|
+
"HN",
|
|
715
|
+
"HR",
|
|
716
|
+
"HT",
|
|
717
|
+
"HU",
|
|
718
|
+
"ID",
|
|
719
|
+
"IE",
|
|
720
|
+
"IL",
|
|
721
|
+
"IN",
|
|
722
|
+
"IQ",
|
|
723
|
+
"IS",
|
|
724
|
+
"IT",
|
|
725
|
+
"JM",
|
|
726
|
+
"JO",
|
|
727
|
+
"JP",
|
|
728
|
+
"KE",
|
|
729
|
+
"KG",
|
|
730
|
+
"KH",
|
|
731
|
+
"KI",
|
|
732
|
+
"KM",
|
|
733
|
+
"KN",
|
|
734
|
+
"KR",
|
|
735
|
+
"KW",
|
|
736
|
+
"KY",
|
|
737
|
+
"KZ",
|
|
738
|
+
"LA",
|
|
739
|
+
"LB",
|
|
740
|
+
"LC",
|
|
741
|
+
"LI",
|
|
742
|
+
"LK",
|
|
743
|
+
"LR",
|
|
744
|
+
"LS",
|
|
745
|
+
"LT",
|
|
746
|
+
"LU",
|
|
747
|
+
"LV",
|
|
748
|
+
"LY",
|
|
749
|
+
"MA",
|
|
750
|
+
"MC",
|
|
751
|
+
"MD",
|
|
752
|
+
"ME",
|
|
753
|
+
"MF",
|
|
754
|
+
"MG",
|
|
755
|
+
"MH",
|
|
756
|
+
"MK",
|
|
757
|
+
"ML",
|
|
758
|
+
"MM",
|
|
759
|
+
"MN",
|
|
760
|
+
"MQ",
|
|
761
|
+
"MR",
|
|
762
|
+
"MT",
|
|
763
|
+
"MU",
|
|
764
|
+
"MV",
|
|
765
|
+
"MW",
|
|
766
|
+
"MX",
|
|
767
|
+
"MY",
|
|
768
|
+
"MZ",
|
|
769
|
+
"NA",
|
|
770
|
+
"NC",
|
|
771
|
+
"NE",
|
|
772
|
+
"NG",
|
|
773
|
+
"NI",
|
|
774
|
+
"NL",
|
|
775
|
+
"NO",
|
|
776
|
+
"NP",
|
|
777
|
+
"NR",
|
|
778
|
+
"NZ",
|
|
779
|
+
"OM",
|
|
780
|
+
"PA",
|
|
781
|
+
"PE",
|
|
782
|
+
"PF",
|
|
783
|
+
"PG",
|
|
784
|
+
"PH",
|
|
785
|
+
"PK",
|
|
786
|
+
"PL",
|
|
787
|
+
"PM",
|
|
788
|
+
"PS",
|
|
789
|
+
"PT",
|
|
790
|
+
"PW",
|
|
791
|
+
"PY",
|
|
792
|
+
"QA",
|
|
793
|
+
"RE",
|
|
794
|
+
"RO",
|
|
795
|
+
"RS",
|
|
796
|
+
"RW",
|
|
797
|
+
"SA",
|
|
798
|
+
"SB",
|
|
799
|
+
"SC",
|
|
800
|
+
"SD",
|
|
801
|
+
"SE",
|
|
802
|
+
"SG",
|
|
803
|
+
"SH",
|
|
804
|
+
"SI",
|
|
805
|
+
"SJ",
|
|
806
|
+
"SK",
|
|
807
|
+
"SL",
|
|
808
|
+
"SM",
|
|
809
|
+
"SN",
|
|
810
|
+
"SO",
|
|
811
|
+
"SR",
|
|
812
|
+
"SS",
|
|
813
|
+
"ST",
|
|
814
|
+
"SV",
|
|
815
|
+
"SZ",
|
|
816
|
+
"TD",
|
|
817
|
+
"TF",
|
|
818
|
+
"TG",
|
|
819
|
+
"TH",
|
|
820
|
+
"TJ",
|
|
821
|
+
"TL",
|
|
822
|
+
"TM",
|
|
823
|
+
"TN",
|
|
824
|
+
"TO",
|
|
825
|
+
"TR",
|
|
826
|
+
"TT",
|
|
827
|
+
"TV",
|
|
828
|
+
"TW",
|
|
829
|
+
"TZ",
|
|
830
|
+
"UA",
|
|
831
|
+
"UG",
|
|
832
|
+
"US",
|
|
833
|
+
"UY",
|
|
834
|
+
"UZ",
|
|
835
|
+
"VA",
|
|
836
|
+
"VC",
|
|
837
|
+
"VN",
|
|
838
|
+
"VU",
|
|
839
|
+
"WF",
|
|
840
|
+
"WS",
|
|
841
|
+
"YE",
|
|
842
|
+
"YT",
|
|
843
|
+
"ZA",
|
|
844
|
+
"ZM",
|
|
845
|
+
"ZW"
|
|
846
|
+
]);
|
|
847
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
848
|
+
z.object({ mode: z.literal("all") }),
|
|
849
|
+
z.object({
|
|
850
|
+
mode: z.literal("allow"),
|
|
851
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
852
|
+
}),
|
|
853
|
+
z.object({
|
|
854
|
+
mode: z.literal("block"),
|
|
855
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
856
|
+
})
|
|
857
|
+
]);
|
|
858
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
859
|
+
"am",
|
|
860
|
+
"ar",
|
|
861
|
+
"bg-BG",
|
|
862
|
+
"bn-BD",
|
|
863
|
+
"bs-BA",
|
|
864
|
+
"ca-ES",
|
|
865
|
+
"cs-CZ",
|
|
866
|
+
"da-DK",
|
|
867
|
+
"de-DE",
|
|
868
|
+
"el-GR",
|
|
869
|
+
"es-419",
|
|
870
|
+
"es-ES",
|
|
871
|
+
"et-EE",
|
|
872
|
+
"fi-FI",
|
|
873
|
+
"fr-CA",
|
|
874
|
+
"fr-FR",
|
|
875
|
+
"gu-IN",
|
|
876
|
+
"hi-IN",
|
|
877
|
+
"hr-HR",
|
|
878
|
+
"hu-HU",
|
|
879
|
+
"hy-AM",
|
|
880
|
+
"id-ID",
|
|
881
|
+
"is-IS",
|
|
882
|
+
"it-IT",
|
|
883
|
+
"ja-JP",
|
|
884
|
+
"ka-GE",
|
|
885
|
+
"kk",
|
|
886
|
+
"kn-IN",
|
|
887
|
+
"ko-KR",
|
|
888
|
+
"lt",
|
|
889
|
+
"lv-LV",
|
|
890
|
+
"mk-MK",
|
|
891
|
+
"ml",
|
|
892
|
+
"mn",
|
|
893
|
+
"mr-IN",
|
|
894
|
+
"ms-MY",
|
|
895
|
+
"my-MM",
|
|
896
|
+
"nb-NO",
|
|
897
|
+
"nl-NL",
|
|
898
|
+
"pa",
|
|
899
|
+
"pl-PL",
|
|
900
|
+
"pt-BR",
|
|
901
|
+
"pt-PT",
|
|
902
|
+
"ro-RO",
|
|
903
|
+
"ru-RU",
|
|
904
|
+
"sk-SK",
|
|
905
|
+
"sl-SI",
|
|
906
|
+
"so-SO",
|
|
907
|
+
"sq-AL",
|
|
908
|
+
"sr-RS",
|
|
909
|
+
"sv-SE",
|
|
910
|
+
"sw-TZ",
|
|
911
|
+
"ta-IN",
|
|
912
|
+
"te-IN",
|
|
913
|
+
"th-TH",
|
|
914
|
+
"tl",
|
|
915
|
+
"tr-TR",
|
|
916
|
+
"uk-UA",
|
|
917
|
+
"ur",
|
|
918
|
+
"vi-VN",
|
|
919
|
+
"zh-CN",
|
|
920
|
+
"zh-HK",
|
|
921
|
+
"zh-TW"
|
|
922
|
+
]);
|
|
335
923
|
const negativeTestCaseSchema = z.object({
|
|
336
924
|
scenario: z.string(),
|
|
337
925
|
userPrompt: z.string()
|
|
338
926
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
339
927
|
const chatgptToolJustificationSchema = z.object({
|
|
340
928
|
toolName: z.string(),
|
|
341
|
-
readOnlyJustification: z.string(),
|
|
342
|
-
openWorldJustification: z.string(),
|
|
343
|
-
destructiveJustification: z.string()
|
|
344
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
929
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
930
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
931
|
+
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.\"")
|
|
932
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
933
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
934
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
935
|
+
const chatgptDescriptionSchema = z.string();
|
|
345
936
|
const chatgptTranslationSchema = z.object({
|
|
346
|
-
locale:
|
|
347
|
-
tagline:
|
|
348
|
-
description:
|
|
937
|
+
locale: chatgptTranslationLocaleSchema,
|
|
938
|
+
tagline: chatgptTaglineSchema,
|
|
939
|
+
description: chatgptDescriptionSchema
|
|
349
940
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
353
|
-
*/
|
|
941
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
942
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
354
943
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
355
944
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
356
|
-
logoDark: z.string().describe("
|
|
945
|
+
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."),
|
|
357
946
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
358
|
-
tagline:
|
|
359
|
-
description:
|
|
947
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
948
|
+
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)."),
|
|
360
949
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
361
950
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
362
|
-
companyUrl:
|
|
951
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
363
952
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
364
|
-
privacyPolicyUrl:
|
|
365
|
-
termsOfServiceUrl:
|
|
366
|
-
demoRecordingUrl:
|
|
953
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
954
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
955
|
+
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."),
|
|
367
956
|
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."),
|
|
368
|
-
serverUrl:
|
|
957
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
369
958
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
370
959
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
371
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
372
|
-
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output.
|
|
373
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases
|
|
374
|
-
screenshots: z.array(z.
|
|
960
|
+
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."),
|
|
961
|
+
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."),
|
|
962
|
+
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."),
|
|
963
|
+
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."),
|
|
375
964
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
376
|
-
allowedCountries: chatgptAllowedCountriesSchema.describe("
|
|
965
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
377
966
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
378
967
|
});
|
|
968
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
969
|
+
tagline: z.string().optional(),
|
|
970
|
+
companyUrl: z.string().optional(),
|
|
971
|
+
supportChannel: z.string().optional(),
|
|
972
|
+
privacyPolicyUrl: z.string().optional(),
|
|
973
|
+
termsOfServiceUrl: z.string().optional(),
|
|
974
|
+
demoRecordingUrl: z.string().optional(),
|
|
975
|
+
serverUrl: z.string().optional(),
|
|
976
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
977
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
978
|
+
});
|
|
379
979
|
chatgptSubmissionFormDataSchema.pick({
|
|
380
980
|
appName: true,
|
|
381
981
|
developerName: true,
|
|
@@ -390,9 +990,9 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
390
990
|
testCases: true,
|
|
391
991
|
negativeTestCases: true,
|
|
392
992
|
toolJustifications: true
|
|
393
|
-
});
|
|
993
|
+
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
394
994
|
const claudeCategorySchema = z.enum([
|
|
395
|
-
"
|
|
995
|
+
"Productivity",
|
|
396
996
|
"Communication",
|
|
397
997
|
"Data & Analytics",
|
|
398
998
|
"Development tools",
|
|
@@ -400,206 +1000,162 @@ const claudeCategorySchema = z.enum([
|
|
|
400
1000
|
"Consumer Health",
|
|
401
1001
|
"Health & Life Sciences",
|
|
402
1002
|
"Media & Entertainment",
|
|
403
|
-
"Commerce & Shopping"
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
"
|
|
407
|
-
"
|
|
408
|
-
"
|
|
1003
|
+
"Commerce & Shopping",
|
|
1004
|
+
"Legal",
|
|
1005
|
+
"Sales and marketing",
|
|
1006
|
+
"Creative",
|
|
1007
|
+
"Nonprofit",
|
|
1008
|
+
"Education",
|
|
1009
|
+
"Other"
|
|
409
1010
|
]);
|
|
410
|
-
const
|
|
411
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1011
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
412
1012
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
413
|
-
"
|
|
414
|
-
"
|
|
415
|
-
"
|
|
1013
|
+
"read_only",
|
|
1014
|
+
"write_only",
|
|
1015
|
+
"read_write"
|
|
416
1016
|
]);
|
|
417
|
-
const
|
|
418
|
-
|
|
419
|
-
"
|
|
420
|
-
"
|
|
421
|
-
"
|
|
422
|
-
"
|
|
423
|
-
"N/A"
|
|
1017
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1018
|
+
"oauth_dcr",
|
|
1019
|
+
"oauth_cimd",
|
|
1020
|
+
"oauth_anthropic_creds",
|
|
1021
|
+
"custom_connection",
|
|
1022
|
+
"none"
|
|
424
1023
|
]);
|
|
425
|
-
const
|
|
426
|
-
"
|
|
427
|
-
"
|
|
428
|
-
"
|
|
429
|
-
"GDPR compliant (if applicable)"
|
|
1024
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1025
|
+
"first_party",
|
|
1026
|
+
"proxied",
|
|
1027
|
+
"third_party"
|
|
430
1028
|
]);
|
|
431
|
-
const
|
|
432
|
-
|
|
433
|
-
"
|
|
434
|
-
"
|
|
1029
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1030
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1031
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1032
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1033
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1034
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1035
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1036
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1037
|
+
"Public documentation for this connector will be live by the publish date."
|
|
435
1038
|
]);
|
|
436
|
-
/**
|
|
437
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
438
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
439
|
-
*/
|
|
1039
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
440
1040
|
const claudeSubmissionFormDataSchema = z.object({
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
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
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
516
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
517
|
-
• '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.
|
|
518
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
519
|
-
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:
|
|
520
|
-
• What the connector does and its key capabilities
|
|
521
|
-
• How to connect/set it up (step by step)
|
|
522
|
-
• What each tool does (or at least the main ones)
|
|
523
|
-
• How to troubleshoot common issues
|
|
524
|
-
• A support contact or channel
|
|
525
|
-
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.`),
|
|
526
|
-
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:
|
|
527
|
-
• What data you collect (and how)
|
|
528
|
-
• How you use the collected data
|
|
529
|
-
• Where and how long you store it
|
|
530
|
-
• Whether you share data with third parties (and who)
|
|
531
|
-
• How users can contact you about data concerns
|
|
532
|
-
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.`),
|
|
533
|
-
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:
|
|
534
|
-
• Email address (e.g. support@myapp.com)
|
|
535
|
-
• Link to a GitHub Issues page
|
|
536
|
-
• Link to a help center or support article
|
|
537
|
-
• Link to a Discord/Slack community
|
|
538
|
-
• Link to your documentation's troubleshooting section
|
|
539
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
540
|
-
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:
|
|
541
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
542
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
543
|
-
• 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.
|
|
544
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
545
|
-
• If your service requires API keys instead of a password, provide those.
|
|
546
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
547
|
-
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.
|
|
548
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
549
|
-
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.`),
|
|
550
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
551
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
552
|
-
• '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).
|
|
553
|
-
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.`),
|
|
554
|
-
logoLight: z.string().describe(`Your connector's logo as displayed in the directory. Requirements:
|
|
555
|
-
• Format: SVG only
|
|
556
|
-
• Aspect ratio: square (1:1)
|
|
557
|
-
• Should work on both light and dark backgrounds (or you can provide separate light/dark versions)
|
|
558
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
559
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
560
|
-
screenshots: z.array(z.url()).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:
|
|
561
|
-
• 3–5 images is ideal
|
|
562
|
-
• Minimum 1000px width, PNG format preferred
|
|
563
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
564
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
565
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
566
|
-
• Videos are also welcome
|
|
567
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1041
|
+
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
|
|
1042
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1043
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1044
|
+
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
|
|
1045
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1046
|
+
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.
|
|
1047
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1048
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1049
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1050
|
+
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
|
|
1051
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1052
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1053
|
+
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
|
|
1054
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1055
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1056
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1057
|
+
by your publish date.`),
|
|
1058
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1059
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1060
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1061
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1062
|
+
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
|
|
1063
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1064
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1065
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1066
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1067
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1068
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1069
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1070
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1071
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1072
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1073
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1074
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1075
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1076
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1077
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1078
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1079
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1080
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1081
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1082
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1083
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1084
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1085
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1086
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1087
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1088
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1089
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1090
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1091
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1092
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1093
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1094
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1095
|
+
fully populated account.`),
|
|
1096
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1097
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1098
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1099
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1100
|
+
});
|
|
1101
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1102
|
+
serverUrl: z.string().optional(),
|
|
1103
|
+
name: z.string().optional(),
|
|
1104
|
+
slug: z.string().optional(),
|
|
1105
|
+
oneLiner: z.string().optional(),
|
|
1106
|
+
description: z.string().optional(),
|
|
1107
|
+
iconUrl: z.string().optional(),
|
|
1108
|
+
documentation: z.string().optional(),
|
|
1109
|
+
support: z.string().optional(),
|
|
1110
|
+
privacyPolicy: z.string().optional(),
|
|
1111
|
+
companyWebsite: z.string().optional(),
|
|
1112
|
+
primaryContactEmail: z.string().optional(),
|
|
1113
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1114
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
568
1115
|
});
|
|
569
1116
|
claudeSubmissionFormDataSchema.pick({
|
|
570
|
-
companyName: true,
|
|
571
|
-
appName: true,
|
|
572
|
-
mcpUrlType: true,
|
|
573
1117
|
serverUrl: true,
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
transportSupport: true,
|
|
1118
|
+
name: true,
|
|
1119
|
+
slug: true,
|
|
1120
|
+
companyName: true,
|
|
578
1121
|
primaryContactEmail: true,
|
|
579
|
-
primaryContactName: true
|
|
1122
|
+
primaryContactName: true,
|
|
1123
|
+
readWriteCapabilities: true,
|
|
1124
|
+
authentication: true,
|
|
1125
|
+
apiOwnership: true,
|
|
1126
|
+
personalHealthData: true
|
|
1127
|
+
}).extend({
|
|
1128
|
+
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1129
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
580
1130
|
});
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
1131
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1132
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1133
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1134
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1135
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1136
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1137
|
+
});
|
|
1138
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1139
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1140
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
586
1141
|
});
|
|
587
1142
|
const submissionMetaFieldsSchema = z.object({
|
|
588
1143
|
id: z.string(),
|
|
589
1144
|
environmentId: z.string(),
|
|
1145
|
+
auditId: z.string().nullable(),
|
|
590
1146
|
createdAt: z.coerce.date(),
|
|
591
1147
|
updatedAt: z.coerce.date()
|
|
592
1148
|
});
|
|
593
1149
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
594
1150
|
platform: z.literal("claudeai"),
|
|
595
|
-
formData:
|
|
1151
|
+
formData: claudeSubmissionDraftSchema
|
|
596
1152
|
});
|
|
597
1153
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
598
1154
|
platform: z.literal("chatgpt"),
|
|
599
|
-
formData:
|
|
1155
|
+
formData: chatgptSubmissionDraftSchema
|
|
600
1156
|
});
|
|
601
1157
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
602
|
-
z.union([
|
|
1158
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
603
1159
|
const subscriptionPlanSchema = z.enum([
|
|
604
1160
|
"pro",
|
|
605
1161
|
"business",
|
|
@@ -623,6 +1179,12 @@ z.object({
|
|
|
623
1179
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
624
1180
|
});
|
|
625
1181
|
//#endregion
|
|
1182
|
+
//#region src/auth-scope.ts
|
|
1183
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1184
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1185
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1186
|
+
const AUTH_SCOPE_USER = "user";
|
|
1187
|
+
//#endregion
|
|
626
1188
|
//#region src/schemas.ts
|
|
627
1189
|
const RESERVED_KEYS = [
|
|
628
1190
|
"_HANDLER",
|
|
@@ -658,7 +1220,10 @@ const RESERVED_KEYS = [
|
|
|
658
1220
|
"BUILD_ARG_START_COMMAND",
|
|
659
1221
|
"ALPIC_HOST",
|
|
660
1222
|
"ALPIC_CUSTOM_DOMAINS",
|
|
661
|
-
"ALPIC_INTENT_META_KEY"
|
|
1223
|
+
"ALPIC_INTENT_META_KEY",
|
|
1224
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1225
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1226
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
662
1227
|
];
|
|
663
1228
|
const environmentVariableSchema = z.object({
|
|
664
1229
|
key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
|
|
@@ -762,7 +1327,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
762
1327
|
id: z.string(),
|
|
763
1328
|
name: z.string(),
|
|
764
1329
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
765
|
-
urls: z.array(z.
|
|
1330
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
766
1331
|
createdAt: z.coerce.date(),
|
|
767
1332
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
768
1333
|
}));
|
|
@@ -838,6 +1403,9 @@ const listProjectsContractV1 = oc.route({
|
|
|
838
1403
|
description: "List all projects for a team",
|
|
839
1404
|
tags: ["projects"],
|
|
840
1405
|
successDescription: "The list of projects"
|
|
1406
|
+
}).errors({
|
|
1407
|
+
NOT_FOUND: {},
|
|
1408
|
+
BAD_REQUEST: {}
|
|
841
1409
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
842
1410
|
const createProjectContractV1 = oc.route({
|
|
843
1411
|
path: "/v1/projects",
|
|
@@ -848,7 +1416,8 @@ const createProjectContractV1 = oc.route({
|
|
|
848
1416
|
successDescription: "The project has been created successfully"
|
|
849
1417
|
}).errors({
|
|
850
1418
|
NOT_FOUND: {},
|
|
851
|
-
BAD_REQUEST: {}
|
|
1419
|
+
BAD_REQUEST: {},
|
|
1420
|
+
FORBIDDEN: {}
|
|
852
1421
|
}).input(z.object({
|
|
853
1422
|
teamId: z.string().optional(),
|
|
854
1423
|
name: z.string().trim().min(1).max(100),
|
|
@@ -933,7 +1502,10 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
933
1502
|
description: "Delete an environment variable by ID",
|
|
934
1503
|
tags: ["environments"],
|
|
935
1504
|
successDescription: "The environment variable has been deleted successfully"
|
|
936
|
-
}).errors({
|
|
1505
|
+
}).errors({
|
|
1506
|
+
NOT_FOUND: {},
|
|
1507
|
+
BAD_REQUEST: {}
|
|
1508
|
+
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
937
1509
|
const deleteProjectContractV1 = oc.route({
|
|
938
1510
|
path: "/v1/projects/{projectId}",
|
|
939
1511
|
method: "DELETE",
|
|
@@ -951,7 +1523,8 @@ const updateProjectContractV1 = oc.route({
|
|
|
951
1523
|
successDescription: "The project has been updated successfully"
|
|
952
1524
|
}).errors({
|
|
953
1525
|
NOT_FOUND: {},
|
|
954
|
-
BAD_REQUEST: {}
|
|
1526
|
+
BAD_REQUEST: {},
|
|
1527
|
+
FORBIDDEN: {}
|
|
955
1528
|
}).input(z.object({
|
|
956
1529
|
projectId: z.string().describe("The ID of the project"),
|
|
957
1530
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
@@ -966,10 +1539,12 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
966
1539
|
successDescription: "The environment has been deployed successfully"
|
|
967
1540
|
}).errors({
|
|
968
1541
|
NOT_FOUND: {},
|
|
969
|
-
BAD_REQUEST: {}
|
|
1542
|
+
BAD_REQUEST: {},
|
|
1543
|
+
CONFLICT: {}
|
|
970
1544
|
}).input(z.object({
|
|
971
1545
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
972
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1546
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1547
|
+
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.")
|
|
973
1548
|
})).output(deploymentSchema);
|
|
974
1549
|
const uploadDeploymentArtifactContractV1 = oc.route({
|
|
975
1550
|
path: "/v1/deployments/upload",
|
|
@@ -978,6 +1553,9 @@ const uploadDeploymentArtifactContractV1 = oc.route({
|
|
|
978
1553
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
979
1554
|
tags: ["deployments"],
|
|
980
1555
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1556
|
+
}).errors({
|
|
1557
|
+
NOT_FOUND: {},
|
|
1558
|
+
BAD_REQUEST: {}
|
|
981
1559
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
982
1560
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
983
1561
|
token: z.string().describe("Token to identify the source archive"),
|
|
@@ -1003,6 +1581,21 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1003
1581
|
tags: ["deployments"],
|
|
1004
1582
|
successDescription: "The deployment details"
|
|
1005
1583
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1584
|
+
const logEntrySchema = z.object({
|
|
1585
|
+
timestamp: z.coerce.date(),
|
|
1586
|
+
type: z.enum([
|
|
1587
|
+
"START",
|
|
1588
|
+
"END",
|
|
1589
|
+
"INFO",
|
|
1590
|
+
"ERROR",
|
|
1591
|
+
"WARNING",
|
|
1592
|
+
"DEBUG"
|
|
1593
|
+
]),
|
|
1594
|
+
requestId: z.string(),
|
|
1595
|
+
content: z.string().optional(),
|
|
1596
|
+
method: z.string().optional(),
|
|
1597
|
+
durationInMs: z.number().optional()
|
|
1598
|
+
});
|
|
1006
1599
|
const getLogsContractV1 = oc.route({
|
|
1007
1600
|
path: "/v1/environments/{environmentId}/logs",
|
|
1008
1601
|
method: "GET",
|
|
@@ -1027,21 +1620,7 @@ const getLogsContractV1 = oc.route({
|
|
|
1027
1620
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1028
1621
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1029
1622
|
})).output(z.object({
|
|
1030
|
-
logs: z.array(
|
|
1031
|
-
timestamp: z.coerce.date(),
|
|
1032
|
-
type: z.enum([
|
|
1033
|
-
"START",
|
|
1034
|
-
"END",
|
|
1035
|
-
"INFO",
|
|
1036
|
-
"ERROR",
|
|
1037
|
-
"WARNING",
|
|
1038
|
-
"DEBUG"
|
|
1039
|
-
]),
|
|
1040
|
-
requestId: z.string(),
|
|
1041
|
-
content: z.string().optional(),
|
|
1042
|
-
method: z.string().optional(),
|
|
1043
|
-
durationInMs: z.number().optional()
|
|
1044
|
-
})),
|
|
1623
|
+
logs: z.array(logEntrySchema),
|
|
1045
1624
|
nextToken: z.string().nullable()
|
|
1046
1625
|
}));
|
|
1047
1626
|
const getLatestLogsContractV1 = oc.route({
|
|
@@ -1064,21 +1643,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1064
1643
|
"DEBUG"
|
|
1065
1644
|
])).optional().describe("Filter by log level"),
|
|
1066
1645
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1067
|
-
})).output(z.object({ logs: z.array(
|
|
1068
|
-
timestamp: z.coerce.date(),
|
|
1069
|
-
type: z.enum([
|
|
1070
|
-
"START",
|
|
1071
|
-
"END",
|
|
1072
|
-
"INFO",
|
|
1073
|
-
"ERROR",
|
|
1074
|
-
"WARNING",
|
|
1075
|
-
"DEBUG"
|
|
1076
|
-
]),
|
|
1077
|
-
requestId: z.string(),
|
|
1078
|
-
content: z.string().optional(),
|
|
1079
|
-
method: z.string().optional(),
|
|
1080
|
-
durationInMs: z.number().optional()
|
|
1081
|
-
})) }));
|
|
1646
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1082
1647
|
const getDeploymentLogsContractV1 = oc.route({
|
|
1083
1648
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1084
1649
|
method: "GET",
|
|
@@ -1151,7 +1716,7 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1151
1716
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1152
1717
|
tags: ["tunnels"],
|
|
1153
1718
|
successDescription: "The tunnel ticket"
|
|
1154
|
-
}).output(z.object({
|
|
1719
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1155
1720
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1156
1721
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1157
1722
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
@@ -1227,7 +1792,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1227
1792
|
name: z.string().min(1).max(100).optional(),
|
|
1228
1793
|
description: z.string().min(1).max(500).optional(),
|
|
1229
1794
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1230
|
-
examplePrompts: z.array(playgroundExamplePromptSchema).max(
|
|
1795
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1231
1796
|
})).output(playgroundOutputSchema);
|
|
1232
1797
|
const createBeaconContractV1 = oc.route({
|
|
1233
1798
|
path: "/v1/beacon/audits",
|
|
@@ -1304,5 +1869,10 @@ const contract = {
|
|
|
1304
1869
|
get: { v1: getBeaconContractV1 }
|
|
1305
1870
|
}
|
|
1306
1871
|
};
|
|
1872
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
1873
|
+
const contractForDocs = {
|
|
1874
|
+
...contract,
|
|
1875
|
+
deployments: deploymentsForDocs
|
|
1876
|
+
};
|
|
1307
1877
|
//#endregion
|
|
1308
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1878
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|