@alpic-ai/api 0.0.0-dev.gff0a01e → 0.0.0-dev.gff523d9
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 +6334 -112
- package/dist/index.mjs +1725 -327
- package/package.json +19 -12
package/dist/index.mjs
CHANGED
|
@@ -1,11 +1,190 @@
|
|
|
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.1_supports-color@7.2.0_zod@4.5.4/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
|
+
"cato",
|
|
183
|
+
"cloudflare",
|
|
184
|
+
"fastly"
|
|
185
|
+
];
|
|
186
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
187
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
9
188
|
const auditStatusSchema = z.enum([
|
|
10
189
|
"pending",
|
|
11
190
|
"partial",
|
|
@@ -71,7 +250,33 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
|
|
|
71
250
|
chatgpt: widgetScreenshotSchema.optional(),
|
|
72
251
|
claudeai: widgetScreenshotSchema.optional()
|
|
73
252
|
}) });
|
|
74
|
-
z.
|
|
253
|
+
z.object({
|
|
254
|
+
id: z.string(),
|
|
255
|
+
environmentId: z.string(),
|
|
256
|
+
clientId: z.string(),
|
|
257
|
+
clientSecret: z.string(),
|
|
258
|
+
clientScopes: z.array(z.string())
|
|
259
|
+
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
279
|
+
const deploymentStatusSchema$1 = z.enum([
|
|
75
280
|
"ongoing",
|
|
76
281
|
"deployed",
|
|
77
282
|
"failed",
|
|
@@ -81,17 +286,236 @@ z.object({
|
|
|
81
286
|
timestamp: z.coerce.date().optional(),
|
|
82
287
|
content: z.string().optional()
|
|
83
288
|
});
|
|
289
|
+
const deploymentSummarySchema = z.object({
|
|
290
|
+
id: z.string(),
|
|
291
|
+
status: deploymentStatusSchema$1,
|
|
292
|
+
sourceBucket: z.string().nullable(),
|
|
293
|
+
sourceObjectKey: z.string().nullable(),
|
|
294
|
+
sourceRef: z.string().nullable(),
|
|
295
|
+
sourceCommitId: z.string().nullable(),
|
|
296
|
+
sourceCommitMessage: z.string().nullable(),
|
|
297
|
+
environmentId: z.string(),
|
|
298
|
+
authorUsername: z.string().nullable(),
|
|
299
|
+
authorAvatarUrl: z.string().nullable(),
|
|
300
|
+
startedAt: z.coerce.date().nullable(),
|
|
301
|
+
completedAt: z.coerce.date().nullable(),
|
|
302
|
+
isCurrent: z.boolean().optional(),
|
|
303
|
+
createdAt: z.coerce.date(),
|
|
304
|
+
updatedAt: z.coerce.date()
|
|
305
|
+
});
|
|
306
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
307
|
+
const publicEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.literal(true),
|
|
309
|
+
oAuthMetadata: z.strictObject({})
|
|
310
|
+
});
|
|
311
|
+
/** 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. */
|
|
312
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
313
|
+
allowsAnonymous: z.boolean(),
|
|
314
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
315
|
+
scope: z.string().optional()
|
|
316
|
+
});
|
|
317
|
+
/** 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. */
|
|
318
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
319
|
+
allowsAnonymous: z.boolean(),
|
|
320
|
+
oAuthMetadata: z.object({
|
|
321
|
+
externalAuthorizationServerUrl: z.url(),
|
|
322
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
323
|
+
}),
|
|
324
|
+
scope: z.string().optional()
|
|
325
|
+
});
|
|
326
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
|
+
const standaloneEnvironmentSchema = z.object({
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
329
|
+
oAuthMetadata: z.object({
|
|
330
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
331
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
332
|
+
}),
|
|
333
|
+
scope: z.string().optional()
|
|
334
|
+
});
|
|
335
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
336
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
337
|
+
allowsAnonymous: z.literal(false),
|
|
338
|
+
oAuthMetadata: z.strictObject({}),
|
|
339
|
+
scope: z.string().optional()
|
|
340
|
+
});
|
|
341
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
342
|
+
isPublic: z.literal(true),
|
|
343
|
+
oAuthMetadata: z.undefined().optional()
|
|
344
|
+
});
|
|
345
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
346
|
+
isPublic: z.literal(false),
|
|
347
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
348
|
+
scope: z.string().optional()
|
|
349
|
+
});
|
|
350
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
351
|
+
isPublic: z.literal(false),
|
|
352
|
+
oAuthMetadata: z.object({
|
|
353
|
+
externalAuthorizationServerUrl: z.url(),
|
|
354
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
355
|
+
}),
|
|
356
|
+
scope: z.string().optional()
|
|
357
|
+
});
|
|
358
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
359
|
+
isPublic: z.literal(false),
|
|
360
|
+
oAuthMetadata: z.object({
|
|
361
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
362
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
363
|
+
}),
|
|
364
|
+
scope: z.string().optional()
|
|
365
|
+
});
|
|
366
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
367
|
+
isPublic: z.literal(false),
|
|
368
|
+
oAuthMetadata: z.strictObject({}),
|
|
369
|
+
scope: z.string().optional()
|
|
370
|
+
});
|
|
371
|
+
z.union([
|
|
372
|
+
publicEnvironmentSchema,
|
|
373
|
+
externalResourceMetadataEnvironmentSchema,
|
|
374
|
+
externalAuthorizationServerEnvironmentSchema,
|
|
375
|
+
standaloneEnvironmentSchema,
|
|
376
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
377
|
+
legacyPublicEnvironmentSchema,
|
|
378
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
379
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
380
|
+
legacyStandaloneEnvironmentSchema,
|
|
381
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
382
|
+
]);
|
|
383
|
+
const playgroundModelSchema = z.enum([
|
|
384
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
385
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
386
|
+
"openai.gpt-5.4",
|
|
387
|
+
"openai.gpt-5.5"
|
|
388
|
+
]);
|
|
389
|
+
const environmentDomainSchema = z.object({
|
|
390
|
+
name: z.string(),
|
|
391
|
+
status: z.enum([
|
|
392
|
+
"ongoing",
|
|
393
|
+
"deployed",
|
|
394
|
+
"failed"
|
|
395
|
+
]),
|
|
396
|
+
createdAt: z.coerce.date(),
|
|
397
|
+
updatedAt: z.coerce.date()
|
|
398
|
+
});
|
|
399
|
+
const environmentSchema$1 = z.object({
|
|
400
|
+
id: z.string(),
|
|
401
|
+
name: z.string(),
|
|
402
|
+
sourceBranch: z.string().nullable(),
|
|
403
|
+
mcpServerUrl: z.string(),
|
|
404
|
+
activeDeployment: deploymentSummarySchema.optional(),
|
|
405
|
+
latestDeployment: deploymentSummarySchema.optional(),
|
|
406
|
+
openaiAppsChallenge: z.string().nullable().optional(),
|
|
407
|
+
isPlaygroundEnabled: z.boolean(),
|
|
408
|
+
playgroundModel: playgroundModelSchema,
|
|
409
|
+
isIpWhitelistEnabled: z.boolean(),
|
|
410
|
+
ipAllowlist: z.array(z.string()).nullable(),
|
|
411
|
+
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
412
|
+
projectId: z.string(),
|
|
413
|
+
createdAt: z.coerce.date(),
|
|
414
|
+
updatedAt: z.coerce.date()
|
|
415
|
+
});
|
|
416
|
+
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
84
417
|
z.object({
|
|
418
|
+
sessionReplayEnabled: z.boolean(),
|
|
419
|
+
collectRequestPayload: z.boolean(),
|
|
420
|
+
collectResponsePayload: z.boolean(),
|
|
421
|
+
collectErrorMessage: z.boolean(),
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
424
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
425
|
+
});
|
|
426
|
+
const feedbackSchema = z.object({
|
|
85
427
|
id: z.string(),
|
|
86
428
|
createdAt: z.coerce.date(),
|
|
87
429
|
environmentId: z.string(),
|
|
88
430
|
content: z.string(),
|
|
89
|
-
source: z.enum(["model", "user"])
|
|
431
|
+
source: z.enum(["model", "user"]),
|
|
432
|
+
clientName: z.string().nullable()
|
|
90
433
|
});
|
|
91
434
|
z.object({
|
|
92
435
|
content: z.string(),
|
|
93
436
|
source: z.enum(["model", "user"])
|
|
94
437
|
});
|
|
438
|
+
const intentCategoryColorSchema = z.enum([
|
|
439
|
+
"red",
|
|
440
|
+
"orange",
|
|
441
|
+
"yellow",
|
|
442
|
+
"green",
|
|
443
|
+
"blue",
|
|
444
|
+
"purple",
|
|
445
|
+
"pink",
|
|
446
|
+
"gray"
|
|
447
|
+
]);
|
|
448
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
449
|
+
const intentCategorySchema = z.object({
|
|
450
|
+
id: z.string(),
|
|
451
|
+
createdAt: z.coerce.date(),
|
|
452
|
+
environmentId: z.string(),
|
|
453
|
+
name: z.string(),
|
|
454
|
+
color: intentCategoryColorSchema
|
|
455
|
+
});
|
|
456
|
+
const intentCategorySummarySchema = z.object({
|
|
457
|
+
id: z.string(),
|
|
458
|
+
name: z.string(),
|
|
459
|
+
color: intentCategoryColorSchema,
|
|
460
|
+
intentCount: z.number().int().nonnegative()
|
|
461
|
+
});
|
|
462
|
+
z.object({
|
|
463
|
+
id: z.string(),
|
|
464
|
+
createdAt: z.coerce.date(),
|
|
465
|
+
environmentId: z.string(),
|
|
466
|
+
toolName: z.string(),
|
|
467
|
+
message: z.string(),
|
|
468
|
+
clientName: z.string().nullable(),
|
|
469
|
+
categories: z.array(intentCategorySchema)
|
|
470
|
+
});
|
|
471
|
+
const signalCategorySchema = z.object({
|
|
472
|
+
id: z.string(),
|
|
473
|
+
name: z.string(),
|
|
474
|
+
color: intentCategoryColorSchema
|
|
475
|
+
});
|
|
476
|
+
z.discriminatedUnion("kind", [
|
|
477
|
+
z.object({
|
|
478
|
+
kind: z.literal("new"),
|
|
479
|
+
category: signalCategorySchema,
|
|
480
|
+
currentCount: z.number().int().nonnegative(),
|
|
481
|
+
currentShare: z.number()
|
|
482
|
+
}),
|
|
483
|
+
z.object({
|
|
484
|
+
kind: z.literal("resurging"),
|
|
485
|
+
category: signalCategorySchema,
|
|
486
|
+
currentCount: z.number().int().nonnegative(),
|
|
487
|
+
daysQuiet: z.number(),
|
|
488
|
+
currentShare: z.number()
|
|
489
|
+
}),
|
|
490
|
+
z.object({
|
|
491
|
+
kind: z.literal("spike"),
|
|
492
|
+
category: signalCategorySchema,
|
|
493
|
+
currentCount: z.number().int().nonnegative(),
|
|
494
|
+
previousCount: z.number().int().nonnegative(),
|
|
495
|
+
currentShare: z.number(),
|
|
496
|
+
previousShare: z.number(),
|
|
497
|
+
changeRatio: z.number()
|
|
498
|
+
}),
|
|
499
|
+
z.object({
|
|
500
|
+
kind: z.literal("declining"),
|
|
501
|
+
category: signalCategorySchema,
|
|
502
|
+
currentCount: z.number().int().nonnegative(),
|
|
503
|
+
previousCount: z.number().int().nonnegative(),
|
|
504
|
+
currentShare: z.number(),
|
|
505
|
+
previousShare: z.number(),
|
|
506
|
+
changeRatio: z.number()
|
|
507
|
+
})
|
|
508
|
+
]);
|
|
509
|
+
z.discriminatedUnion("kind", [z.object({
|
|
510
|
+
kind: z.literal("existing"),
|
|
511
|
+
categoryId: z.string(),
|
|
512
|
+
categoryName: z.string(),
|
|
513
|
+
intentIds: z.array(z.string())
|
|
514
|
+
}), z.object({
|
|
515
|
+
kind: z.literal("new"),
|
|
516
|
+
categoryName: z.string(),
|
|
517
|
+
intentIds: z.array(z.string())
|
|
518
|
+
})]);
|
|
95
519
|
z.object({
|
|
96
520
|
id: z.string(),
|
|
97
521
|
teamId: z.string(),
|
|
@@ -100,12 +524,262 @@ z.object({
|
|
|
100
524
|
createdAt: z.coerce.date(),
|
|
101
525
|
updatedAt: z.coerce.date()
|
|
102
526
|
});
|
|
527
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
528
|
+
type: z.literal("mcp_request"),
|
|
529
|
+
method: z.string()
|
|
530
|
+
});
|
|
531
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
532
|
+
type: z.literal("mcp_error"),
|
|
533
|
+
method: z.string(),
|
|
534
|
+
error: z.string()
|
|
535
|
+
});
|
|
536
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
103
537
|
z.enum([
|
|
104
538
|
"INFO",
|
|
105
539
|
"WARNING",
|
|
106
540
|
"DEBUG",
|
|
107
541
|
"ERROR"
|
|
108
542
|
]);
|
|
543
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
544
|
+
const MCP_CLIENT_GROUPS = [
|
|
545
|
+
{
|
|
546
|
+
id: "claude_code",
|
|
547
|
+
label: "Claude Code",
|
|
548
|
+
vendor: "anthropic",
|
|
549
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
id: "claude",
|
|
553
|
+
label: "Claude",
|
|
554
|
+
vendor: "anthropic",
|
|
555
|
+
rawNames: [
|
|
556
|
+
"Anthropic/ClaudeAI",
|
|
557
|
+
"claude-ai",
|
|
558
|
+
"claude",
|
|
559
|
+
"Claude",
|
|
560
|
+
"claude-desktop",
|
|
561
|
+
"claude-desktop-3p"
|
|
562
|
+
]
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
id: "claude_mobile",
|
|
566
|
+
label: "Claude mobile",
|
|
567
|
+
vendor: "anthropic",
|
|
568
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
569
|
+
},
|
|
570
|
+
{
|
|
571
|
+
id: "claude_cowork",
|
|
572
|
+
label: "Claude Cowork",
|
|
573
|
+
vendor: "anthropic",
|
|
574
|
+
rawNames: ["Anthropic/Cowork"]
|
|
575
|
+
},
|
|
576
|
+
{
|
|
577
|
+
id: "claude_toolbox",
|
|
578
|
+
label: "Claude Toolbox",
|
|
579
|
+
vendor: "anthropic",
|
|
580
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
581
|
+
},
|
|
582
|
+
{
|
|
583
|
+
id: "anthropic_api",
|
|
584
|
+
label: "Anthropic API",
|
|
585
|
+
vendor: "anthropic",
|
|
586
|
+
rawNames: ["Anthropic/API"]
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
id: "anthropic_connector_refresh",
|
|
590
|
+
label: "Anthropic (connector refresh)",
|
|
591
|
+
vendor: "anthropic",
|
|
592
|
+
rawNames: ["Anthropic"]
|
|
593
|
+
},
|
|
594
|
+
{
|
|
595
|
+
id: "codex",
|
|
596
|
+
label: "Codex",
|
|
597
|
+
vendor: "openai",
|
|
598
|
+
rawNames: [
|
|
599
|
+
"codex-mcp-client",
|
|
600
|
+
"codex",
|
|
601
|
+
"Codex",
|
|
602
|
+
"codex-cli",
|
|
603
|
+
"openai-mcp (Codex)"
|
|
604
|
+
]
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
id: "chatgpt",
|
|
608
|
+
label: "ChatGPT",
|
|
609
|
+
vendor: "openai",
|
|
610
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
id: "openai_responses_api",
|
|
614
|
+
label: "OpenAI Responses API",
|
|
615
|
+
vendor: "openai",
|
|
616
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
617
|
+
},
|
|
618
|
+
{
|
|
619
|
+
id: "openai_agent_builder",
|
|
620
|
+
label: "OpenAI Agent Builder",
|
|
621
|
+
vendor: "openai",
|
|
622
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
623
|
+
},
|
|
624
|
+
{
|
|
625
|
+
id: "openai_other",
|
|
626
|
+
label: "OpenAI Other",
|
|
627
|
+
vendor: "openai",
|
|
628
|
+
rawNames: ["openai-mcp"]
|
|
629
|
+
},
|
|
630
|
+
{
|
|
631
|
+
id: "cursor",
|
|
632
|
+
label: "Cursor",
|
|
633
|
+
vendor: "cursor",
|
|
634
|
+
rawNames: [
|
|
635
|
+
"cursor-vscode",
|
|
636
|
+
"Cursor",
|
|
637
|
+
"cursor"
|
|
638
|
+
]
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
id: "cline",
|
|
642
|
+
label: "Cline",
|
|
643
|
+
vendor: "cline",
|
|
644
|
+
rawNames: [
|
|
645
|
+
"Cline",
|
|
646
|
+
"cline",
|
|
647
|
+
"@cline/core"
|
|
648
|
+
]
|
|
649
|
+
},
|
|
650
|
+
{
|
|
651
|
+
id: "github_copilot",
|
|
652
|
+
label: "GitHub Copilot",
|
|
653
|
+
vendor: "githubCopilot",
|
|
654
|
+
rawNames: [
|
|
655
|
+
"Copilot",
|
|
656
|
+
"github-copilot-developer",
|
|
657
|
+
"Copilot MCP Gateway",
|
|
658
|
+
"Xcode/copilot-xcode"
|
|
659
|
+
]
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
id: "gemini_cli",
|
|
663
|
+
label: "Gemini CLI",
|
|
664
|
+
vendor: "google",
|
|
665
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
666
|
+
},
|
|
667
|
+
{
|
|
668
|
+
id: "antigravity",
|
|
669
|
+
label: "Antigravity",
|
|
670
|
+
vendor: "google",
|
|
671
|
+
rawNames: ["antigravity-client"]
|
|
672
|
+
},
|
|
673
|
+
{
|
|
674
|
+
id: "gemini",
|
|
675
|
+
label: "Gemini",
|
|
676
|
+
vendor: "google",
|
|
677
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
678
|
+
},
|
|
679
|
+
{
|
|
680
|
+
id: "windsurf",
|
|
681
|
+
label: "Windsurf",
|
|
682
|
+
vendor: "windsurf",
|
|
683
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
684
|
+
},
|
|
685
|
+
{
|
|
686
|
+
id: "mistral",
|
|
687
|
+
label: "Mistral / Le Chat",
|
|
688
|
+
vendor: "mistral",
|
|
689
|
+
rawNames: ["Mistral"],
|
|
690
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
691
|
+
},
|
|
692
|
+
{
|
|
693
|
+
id: "n8n",
|
|
694
|
+
label: "n8n",
|
|
695
|
+
vendor: "n8n",
|
|
696
|
+
rawNames: [
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
698
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
699
|
+
"n8n"
|
|
700
|
+
]
|
|
701
|
+
},
|
|
702
|
+
{
|
|
703
|
+
id: "alpic_playground",
|
|
704
|
+
label: "Alpic Playground",
|
|
705
|
+
vendor: "alpic",
|
|
706
|
+
rawNames: ["alpic-playground", "playground"]
|
|
707
|
+
},
|
|
708
|
+
{
|
|
709
|
+
id: "opencode",
|
|
710
|
+
label: "opencode",
|
|
711
|
+
vendor: "opencode",
|
|
712
|
+
rawNames: ["opencode"]
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
id: "zed",
|
|
716
|
+
label: "Zed",
|
|
717
|
+
vendor: "zed",
|
|
718
|
+
rawNames: ["Zed", "zed"]
|
|
719
|
+
},
|
|
720
|
+
{
|
|
721
|
+
id: "zapier",
|
|
722
|
+
label: "Zapier",
|
|
723
|
+
vendor: "zapier",
|
|
724
|
+
rawNames: ["Zapier", "zapier"]
|
|
725
|
+
},
|
|
726
|
+
{
|
|
727
|
+
id: "make",
|
|
728
|
+
label: "Make",
|
|
729
|
+
vendor: "make",
|
|
730
|
+
rawNames: ["Make", "make"]
|
|
731
|
+
},
|
|
732
|
+
{
|
|
733
|
+
id: "librechat",
|
|
734
|
+
label: "LibreChat",
|
|
735
|
+
vendor: "mcp",
|
|
736
|
+
rawNames: ["LibreChat", "librechat"]
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
id: "jan",
|
|
740
|
+
label: "Jan",
|
|
741
|
+
vendor: "mcp",
|
|
742
|
+
rawNames: ["Jan", "jan"]
|
|
743
|
+
},
|
|
744
|
+
{
|
|
745
|
+
id: "goose",
|
|
746
|
+
label: "goose",
|
|
747
|
+
vendor: "mcp",
|
|
748
|
+
rawNames: ["goose", "Goose"]
|
|
749
|
+
},
|
|
750
|
+
{
|
|
751
|
+
id: "mcphost",
|
|
752
|
+
label: "mcphost",
|
|
753
|
+
vendor: "mcp",
|
|
754
|
+
rawNames: ["mcphost"]
|
|
755
|
+
},
|
|
756
|
+
{
|
|
757
|
+
id: "mcporter",
|
|
758
|
+
label: "mcporter",
|
|
759
|
+
vendor: "mcp",
|
|
760
|
+
rawNames: ["mcporter"]
|
|
761
|
+
},
|
|
762
|
+
{
|
|
763
|
+
id: "rmcp",
|
|
764
|
+
label: "rmcp",
|
|
765
|
+
vendor: "mcp",
|
|
766
|
+
rawNames: ["rmcp"]
|
|
767
|
+
},
|
|
768
|
+
{
|
|
769
|
+
id: "unnamed_client",
|
|
770
|
+
label: "Unnamed client",
|
|
771
|
+
vendor: "mcp",
|
|
772
|
+
rawNames: [
|
|
773
|
+
"mcp",
|
|
774
|
+
"unknown",
|
|
775
|
+
""
|
|
776
|
+
]
|
|
777
|
+
}
|
|
778
|
+
];
|
|
779
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
780
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
781
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
782
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
109
783
|
const runtimeSchema = z.enum([
|
|
110
784
|
"python3.13",
|
|
111
785
|
"python3.14",
|
|
@@ -117,6 +791,84 @@ const transportSchema = z.enum([
|
|
|
117
791
|
"sse",
|
|
118
792
|
"streamablehttp"
|
|
119
793
|
]);
|
|
794
|
+
z.object({
|
|
795
|
+
id: z.string(),
|
|
796
|
+
name: z.string(),
|
|
797
|
+
teamId: z.string(),
|
|
798
|
+
sourceRepository: z.string().nullable(),
|
|
799
|
+
createdAt: z.coerce.date().optional(),
|
|
800
|
+
runtime: runtimeSchema,
|
|
801
|
+
transport: transportSchema.nullable(),
|
|
802
|
+
rootDirectory: z.string().nullable(),
|
|
803
|
+
installCommand: z.string().nullable(),
|
|
804
|
+
buildCommand: z.string().nullable(),
|
|
805
|
+
buildOutputDir: z.string().nullable(),
|
|
806
|
+
startCommand: z.string().nullable(),
|
|
807
|
+
fixedOutboundIp: z.boolean(),
|
|
808
|
+
environments: z.array(environmentWithDomainsSchema),
|
|
809
|
+
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
810
|
+
});
|
|
811
|
+
const domainFailureReasonSchema = z.enum([
|
|
812
|
+
"caa",
|
|
813
|
+
"dns",
|
|
814
|
+
"invalid_domain",
|
|
815
|
+
"other"
|
|
816
|
+
]);
|
|
817
|
+
const projectDomainMappingSchema = z.object({
|
|
818
|
+
pathPrefix: z.string(),
|
|
819
|
+
environment: environmentSchema$1
|
|
820
|
+
});
|
|
821
|
+
z.object({
|
|
822
|
+
name: z.string(),
|
|
823
|
+
createdAt: z.coerce.date(),
|
|
824
|
+
status: z.enum([
|
|
825
|
+
"ongoing",
|
|
826
|
+
"deployed",
|
|
827
|
+
"failed"
|
|
828
|
+
]),
|
|
829
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
830
|
+
environment: environmentSchema$1,
|
|
831
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
832
|
+
});
|
|
833
|
+
const serverFieldsSchema$1 = z.object({
|
|
834
|
+
$schema: z.string(),
|
|
835
|
+
name: z.string(),
|
|
836
|
+
description: z.string(),
|
|
837
|
+
version: z.string().optional(),
|
|
838
|
+
title: z.string().optional(),
|
|
839
|
+
websiteUrl: z.string().optional(),
|
|
840
|
+
icons: z.array(z.object({
|
|
841
|
+
src: z.string(),
|
|
842
|
+
mimeType: z.string().optional(),
|
|
843
|
+
sizes: z.array(z.string()).optional()
|
|
844
|
+
})).optional(),
|
|
845
|
+
remotes: z.array(z.object({
|
|
846
|
+
type: z.string(),
|
|
847
|
+
url: z.string().optional(),
|
|
848
|
+
headers: z.array(z.object({
|
|
849
|
+
name: z.string(),
|
|
850
|
+
description: z.string(),
|
|
851
|
+
isRequired: z.boolean().optional(),
|
|
852
|
+
isSecret: z.boolean().optional()
|
|
853
|
+
})).optional()
|
|
854
|
+
})).optional()
|
|
855
|
+
}).catchall(z.unknown());
|
|
856
|
+
z.object({
|
|
857
|
+
serverFields: serverFieldsSchema$1,
|
|
858
|
+
source: z.enum(["registry", "defaults"])
|
|
859
|
+
});
|
|
860
|
+
/** 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. */
|
|
861
|
+
const clampStringField = (field) => {
|
|
862
|
+
const max = field.maxLength;
|
|
863
|
+
if (max === null) return field;
|
|
864
|
+
const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
|
|
865
|
+
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
866
|
+
return field.description ? withMin.describe(field.description) : withMin;
|
|
867
|
+
};
|
|
868
|
+
const unboundedArrayField = (field) => {
|
|
869
|
+
const unbounded = z.array(field.element);
|
|
870
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
871
|
+
};
|
|
120
872
|
const toolDefinitionSchema = z.object({
|
|
121
873
|
name: z.string(),
|
|
122
874
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -129,13 +881,31 @@ const toolDefinitionSchema = z.object({
|
|
|
129
881
|
}).optional()
|
|
130
882
|
});
|
|
131
883
|
const positiveTestCaseSchema = z.object({
|
|
132
|
-
scenario: z.string(),
|
|
133
|
-
userPrompt: z.string(),
|
|
134
|
-
toolTriggered: z.string().optional(),
|
|
135
|
-
expectedOutput: z.string().optional()
|
|
136
|
-
}).
|
|
884
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
885
|
+
userPrompt: z.string().min(1).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."),
|
|
886
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
887
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
888
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
889
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
890
|
+
scenario: z.string().optional(),
|
|
891
|
+
userPrompt: z.string().optional()
|
|
892
|
+
});
|
|
893
|
+
const blankPositiveTestCase = () => ({
|
|
894
|
+
scenario: "",
|
|
895
|
+
userPrompt: "",
|
|
896
|
+
toolTriggered: "",
|
|
897
|
+
expectedOutput: ""
|
|
898
|
+
});
|
|
899
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
900
|
+
const screenshotEntrySchema = z.object({
|
|
901
|
+
prompt: z.string(),
|
|
902
|
+
url: z.url()
|
|
903
|
+
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
904
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
137
905
|
/** Accepts either a valid email or URL. */
|
|
138
906
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
907
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
908
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
139
909
|
const chatgptCategorySchema = z.enum([
|
|
140
910
|
"BUSINESS",
|
|
141
911
|
"COLLABORATION",
|
|
@@ -152,68 +922,387 @@ const chatgptCategorySchema = z.enum([
|
|
|
152
922
|
"TRAVEL"
|
|
153
923
|
]);
|
|
154
924
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
155
|
-
const
|
|
925
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
926
|
+
"AD",
|
|
927
|
+
"AE",
|
|
928
|
+
"AF",
|
|
929
|
+
"AG",
|
|
930
|
+
"AL",
|
|
931
|
+
"AM",
|
|
932
|
+
"AO",
|
|
933
|
+
"AR",
|
|
934
|
+
"AT",
|
|
935
|
+
"AU",
|
|
936
|
+
"AW",
|
|
937
|
+
"AX",
|
|
938
|
+
"AZ",
|
|
939
|
+
"BA",
|
|
940
|
+
"BB",
|
|
941
|
+
"BD",
|
|
942
|
+
"BE",
|
|
943
|
+
"BF",
|
|
944
|
+
"BG",
|
|
945
|
+
"BH",
|
|
946
|
+
"BI",
|
|
947
|
+
"BJ",
|
|
948
|
+
"BL",
|
|
949
|
+
"BM",
|
|
950
|
+
"BN",
|
|
951
|
+
"BO",
|
|
952
|
+
"BR",
|
|
953
|
+
"BS",
|
|
954
|
+
"BT",
|
|
955
|
+
"BW",
|
|
956
|
+
"BZ",
|
|
957
|
+
"CA",
|
|
958
|
+
"CD",
|
|
959
|
+
"CF",
|
|
960
|
+
"CG",
|
|
961
|
+
"CH",
|
|
962
|
+
"CI",
|
|
963
|
+
"CL",
|
|
964
|
+
"CM",
|
|
965
|
+
"CO",
|
|
966
|
+
"CR",
|
|
967
|
+
"CV",
|
|
968
|
+
"CY",
|
|
969
|
+
"CZ",
|
|
970
|
+
"DE",
|
|
971
|
+
"DJ",
|
|
972
|
+
"DK",
|
|
973
|
+
"DM",
|
|
974
|
+
"DO",
|
|
975
|
+
"DZ",
|
|
976
|
+
"EC",
|
|
977
|
+
"EE",
|
|
978
|
+
"EG",
|
|
979
|
+
"ER",
|
|
980
|
+
"ES",
|
|
981
|
+
"ET",
|
|
982
|
+
"FI",
|
|
983
|
+
"FJ",
|
|
984
|
+
"FM",
|
|
985
|
+
"FO",
|
|
986
|
+
"FR",
|
|
987
|
+
"GA",
|
|
988
|
+
"GB",
|
|
989
|
+
"GD",
|
|
990
|
+
"GE",
|
|
991
|
+
"GF",
|
|
992
|
+
"GH",
|
|
993
|
+
"GL",
|
|
994
|
+
"GM",
|
|
995
|
+
"GN",
|
|
996
|
+
"GP",
|
|
997
|
+
"GQ",
|
|
998
|
+
"GR",
|
|
999
|
+
"GT",
|
|
1000
|
+
"GW",
|
|
1001
|
+
"GY",
|
|
1002
|
+
"HN",
|
|
1003
|
+
"HR",
|
|
1004
|
+
"HT",
|
|
1005
|
+
"HU",
|
|
1006
|
+
"ID",
|
|
1007
|
+
"IE",
|
|
1008
|
+
"IL",
|
|
1009
|
+
"IN",
|
|
1010
|
+
"IQ",
|
|
1011
|
+
"IS",
|
|
1012
|
+
"IT",
|
|
1013
|
+
"JM",
|
|
1014
|
+
"JO",
|
|
1015
|
+
"JP",
|
|
1016
|
+
"KE",
|
|
1017
|
+
"KG",
|
|
1018
|
+
"KH",
|
|
1019
|
+
"KI",
|
|
1020
|
+
"KM",
|
|
1021
|
+
"KN",
|
|
1022
|
+
"KR",
|
|
1023
|
+
"KW",
|
|
1024
|
+
"KY",
|
|
1025
|
+
"KZ",
|
|
1026
|
+
"LA",
|
|
1027
|
+
"LB",
|
|
1028
|
+
"LC",
|
|
1029
|
+
"LI",
|
|
1030
|
+
"LK",
|
|
1031
|
+
"LR",
|
|
1032
|
+
"LS",
|
|
1033
|
+
"LT",
|
|
1034
|
+
"LU",
|
|
1035
|
+
"LV",
|
|
1036
|
+
"LY",
|
|
1037
|
+
"MA",
|
|
1038
|
+
"MC",
|
|
1039
|
+
"MD",
|
|
1040
|
+
"ME",
|
|
1041
|
+
"MF",
|
|
1042
|
+
"MG",
|
|
1043
|
+
"MH",
|
|
1044
|
+
"MK",
|
|
1045
|
+
"ML",
|
|
1046
|
+
"MM",
|
|
1047
|
+
"MN",
|
|
1048
|
+
"MQ",
|
|
1049
|
+
"MR",
|
|
1050
|
+
"MT",
|
|
1051
|
+
"MU",
|
|
1052
|
+
"MV",
|
|
1053
|
+
"MW",
|
|
1054
|
+
"MX",
|
|
1055
|
+
"MY",
|
|
1056
|
+
"MZ",
|
|
1057
|
+
"NA",
|
|
1058
|
+
"NC",
|
|
1059
|
+
"NE",
|
|
1060
|
+
"NG",
|
|
1061
|
+
"NI",
|
|
1062
|
+
"NL",
|
|
1063
|
+
"NO",
|
|
1064
|
+
"NP",
|
|
1065
|
+
"NR",
|
|
1066
|
+
"NZ",
|
|
1067
|
+
"OM",
|
|
1068
|
+
"PA",
|
|
1069
|
+
"PE",
|
|
1070
|
+
"PF",
|
|
1071
|
+
"PG",
|
|
1072
|
+
"PH",
|
|
1073
|
+
"PK",
|
|
1074
|
+
"PL",
|
|
1075
|
+
"PM",
|
|
1076
|
+
"PS",
|
|
1077
|
+
"PT",
|
|
1078
|
+
"PW",
|
|
1079
|
+
"PY",
|
|
1080
|
+
"QA",
|
|
1081
|
+
"RE",
|
|
1082
|
+
"RO",
|
|
1083
|
+
"RS",
|
|
1084
|
+
"RW",
|
|
1085
|
+
"SA",
|
|
1086
|
+
"SB",
|
|
1087
|
+
"SC",
|
|
1088
|
+
"SD",
|
|
1089
|
+
"SE",
|
|
1090
|
+
"SG",
|
|
1091
|
+
"SH",
|
|
1092
|
+
"SI",
|
|
1093
|
+
"SJ",
|
|
1094
|
+
"SK",
|
|
1095
|
+
"SL",
|
|
1096
|
+
"SM",
|
|
1097
|
+
"SN",
|
|
1098
|
+
"SO",
|
|
1099
|
+
"SR",
|
|
1100
|
+
"SS",
|
|
1101
|
+
"ST",
|
|
1102
|
+
"SV",
|
|
1103
|
+
"SZ",
|
|
1104
|
+
"TD",
|
|
1105
|
+
"TF",
|
|
1106
|
+
"TG",
|
|
1107
|
+
"TH",
|
|
1108
|
+
"TJ",
|
|
1109
|
+
"TL",
|
|
1110
|
+
"TM",
|
|
1111
|
+
"TN",
|
|
1112
|
+
"TO",
|
|
1113
|
+
"TR",
|
|
1114
|
+
"TT",
|
|
1115
|
+
"TV",
|
|
1116
|
+
"TW",
|
|
1117
|
+
"TZ",
|
|
1118
|
+
"UA",
|
|
1119
|
+
"UG",
|
|
1120
|
+
"US",
|
|
1121
|
+
"UY",
|
|
1122
|
+
"UZ",
|
|
1123
|
+
"VA",
|
|
1124
|
+
"VC",
|
|
1125
|
+
"VN",
|
|
1126
|
+
"VU",
|
|
1127
|
+
"WF",
|
|
1128
|
+
"WS",
|
|
1129
|
+
"YE",
|
|
1130
|
+
"YT",
|
|
1131
|
+
"ZA",
|
|
1132
|
+
"ZM",
|
|
1133
|
+
"ZW"
|
|
1134
|
+
]);
|
|
1135
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
1136
|
+
z.object({ mode: z.literal("all") }),
|
|
1137
|
+
z.object({
|
|
1138
|
+
mode: z.literal("allow"),
|
|
1139
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1140
|
+
}),
|
|
1141
|
+
z.object({
|
|
1142
|
+
mode: z.literal("block"),
|
|
1143
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1144
|
+
})
|
|
1145
|
+
]);
|
|
1146
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
1147
|
+
"am",
|
|
1148
|
+
"ar",
|
|
1149
|
+
"bg-BG",
|
|
1150
|
+
"bn-BD",
|
|
1151
|
+
"bs-BA",
|
|
1152
|
+
"ca-ES",
|
|
1153
|
+
"cs-CZ",
|
|
1154
|
+
"da-DK",
|
|
1155
|
+
"de-DE",
|
|
1156
|
+
"el-GR",
|
|
1157
|
+
"es-419",
|
|
1158
|
+
"es-ES",
|
|
1159
|
+
"et-EE",
|
|
1160
|
+
"fi-FI",
|
|
1161
|
+
"fr-CA",
|
|
1162
|
+
"fr-FR",
|
|
1163
|
+
"gu-IN",
|
|
1164
|
+
"hi-IN",
|
|
1165
|
+
"hr-HR",
|
|
1166
|
+
"hu-HU",
|
|
1167
|
+
"hy-AM",
|
|
1168
|
+
"id-ID",
|
|
1169
|
+
"is-IS",
|
|
1170
|
+
"it-IT",
|
|
1171
|
+
"ja-JP",
|
|
1172
|
+
"ka-GE",
|
|
1173
|
+
"kk",
|
|
1174
|
+
"kn-IN",
|
|
1175
|
+
"ko-KR",
|
|
1176
|
+
"lt",
|
|
1177
|
+
"lv-LV",
|
|
1178
|
+
"mk-MK",
|
|
1179
|
+
"ml",
|
|
1180
|
+
"mn",
|
|
1181
|
+
"mr-IN",
|
|
1182
|
+
"ms-MY",
|
|
1183
|
+
"my-MM",
|
|
1184
|
+
"nb-NO",
|
|
1185
|
+
"nl-NL",
|
|
1186
|
+
"pa",
|
|
1187
|
+
"pl-PL",
|
|
1188
|
+
"pt-BR",
|
|
1189
|
+
"pt-PT",
|
|
1190
|
+
"ro-RO",
|
|
1191
|
+
"ru-RU",
|
|
1192
|
+
"sk-SK",
|
|
1193
|
+
"sl-SI",
|
|
1194
|
+
"so-SO",
|
|
1195
|
+
"sq-AL",
|
|
1196
|
+
"sr-RS",
|
|
1197
|
+
"sv-SE",
|
|
1198
|
+
"sw-TZ",
|
|
1199
|
+
"ta-IN",
|
|
1200
|
+
"te-IN",
|
|
1201
|
+
"th-TH",
|
|
1202
|
+
"tl",
|
|
1203
|
+
"tr-TR",
|
|
1204
|
+
"uk-UA",
|
|
1205
|
+
"ur",
|
|
1206
|
+
"vi-VN",
|
|
1207
|
+
"zh-CN",
|
|
1208
|
+
"zh-HK",
|
|
1209
|
+
"zh-TW"
|
|
1210
|
+
]);
|
|
156
1211
|
const negativeTestCaseSchema = z.object({
|
|
157
|
-
scenario: z.string(),
|
|
158
|
-
userPrompt: z.string()
|
|
159
|
-
}).
|
|
1212
|
+
scenario: z.string().min(1),
|
|
1213
|
+
userPrompt: z.string().min(1)
|
|
1214
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1215
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1216
|
+
scenario: z.string().optional(),
|
|
1217
|
+
userPrompt: z.string().optional()
|
|
1218
|
+
});
|
|
1219
|
+
const blankNegativeTestCase = () => ({
|
|
1220
|
+
scenario: "",
|
|
1221
|
+
userPrompt: ""
|
|
1222
|
+
});
|
|
1223
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
160
1224
|
const chatgptToolJustificationSchema = z.object({
|
|
161
1225
|
toolName: z.string(),
|
|
162
|
-
readOnlyJustification: z.string(),
|
|
163
|
-
openWorldJustification: z.string(),
|
|
164
|
-
destructiveJustification: z.string()
|
|
165
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
1226
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
1227
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
1228
|
+
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.\"")
|
|
1229
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
1230
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
1231
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
1232
|
+
const chatgptDescriptionSchema = z.string();
|
|
166
1233
|
const chatgptTranslationSchema = z.object({
|
|
167
|
-
locale:
|
|
168
|
-
tagline:
|
|
169
|
-
description:
|
|
1234
|
+
locale: chatgptTranslationLocaleSchema,
|
|
1235
|
+
tagline: chatgptTaglineSchema,
|
|
1236
|
+
description: chatgptDescriptionSchema
|
|
170
1237
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
174
|
-
*/
|
|
1238
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
1239
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
175
1240
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
176
1241
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
177
|
-
logoDark: z.string().describe("
|
|
1242
|
+
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."),
|
|
178
1243
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
179
|
-
tagline:
|
|
180
|
-
description:
|
|
1244
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1245
|
+
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)."),
|
|
181
1246
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
182
1247
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
183
|
-
companyUrl:
|
|
1248
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
184
1249
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
185
|
-
privacyPolicyUrl:
|
|
186
|
-
termsOfServiceUrl:
|
|
187
|
-
demoRecordingUrl:
|
|
1250
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1251
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1252
|
+
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."),
|
|
188
1253
|
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."),
|
|
189
|
-
serverUrl:
|
|
1254
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
190
1255
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
191
1256
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
192
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
1257
|
+
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."),
|
|
1258
|
+
skills: z.array(chatgptSkillSchema).optional().describe("Skills the server exposes over MCP (auto-populated from the production server's manifest). Left unset when the server does not advertise the skills extension, which is a different state from advertising it and exposing none."),
|
|
1259
|
+
testCases: z.array(positiveTestCaseSchema).length(5).describe("Exactly 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."),
|
|
1260
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 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."),
|
|
1261
|
+
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."),
|
|
196
1262
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
197
|
-
allowedCountries: chatgptAllowedCountriesSchema.describe("
|
|
1263
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
198
1264
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
199
1265
|
});
|
|
200
|
-
chatgptSubmissionFormDataSchema.
|
|
1266
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1267
|
+
tagline: z.string().optional(),
|
|
1268
|
+
companyUrl: z.string().optional(),
|
|
1269
|
+
supportChannel: z.string().optional(),
|
|
1270
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1271
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1272
|
+
demoRecordingUrl: z.string().optional(),
|
|
1273
|
+
serverUrl: z.string().optional(),
|
|
1274
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1275
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1276
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1277
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1278
|
+
});
|
|
1279
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1280
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
201
1281
|
appName: true,
|
|
202
1282
|
developerName: true,
|
|
203
1283
|
serverUrl: true,
|
|
204
1284
|
tools: true,
|
|
1285
|
+
skills: true,
|
|
205
1286
|
authentication: true
|
|
206
1287
|
});
|
|
207
|
-
|
|
1288
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1289
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
208
1290
|
tagline: true,
|
|
209
1291
|
description: true,
|
|
210
1292
|
category: true,
|
|
211
1293
|
testCases: true,
|
|
212
1294
|
negativeTestCases: true,
|
|
213
1295
|
toolJustifications: true
|
|
1296
|
+
}).extend({
|
|
1297
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1298
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1299
|
+
}).extend({
|
|
1300
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1301
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1302
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
214
1303
|
});
|
|
215
1304
|
const claudeCategorySchema = z.enum([
|
|
216
|
-
"
|
|
1305
|
+
"Productivity",
|
|
217
1306
|
"Communication",
|
|
218
1307
|
"Data & Analytics",
|
|
219
1308
|
"Development tools",
|
|
@@ -221,212 +1310,303 @@ const claudeCategorySchema = z.enum([
|
|
|
221
1310
|
"Consumer Health",
|
|
222
1311
|
"Health & Life Sciences",
|
|
223
1312
|
"Media & Entertainment",
|
|
224
|
-
"Commerce & Shopping"
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
"
|
|
228
|
-
"
|
|
229
|
-
"
|
|
1313
|
+
"Commerce & Shopping",
|
|
1314
|
+
"Legal",
|
|
1315
|
+
"Sales and marketing",
|
|
1316
|
+
"Creative",
|
|
1317
|
+
"Nonprofit",
|
|
1318
|
+
"Education",
|
|
1319
|
+
"Other"
|
|
230
1320
|
]);
|
|
231
|
-
const
|
|
232
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1321
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
233
1322
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
234
|
-
"
|
|
235
|
-
"
|
|
236
|
-
"
|
|
1323
|
+
"read_only",
|
|
1324
|
+
"write_only",
|
|
1325
|
+
"read_write"
|
|
237
1326
|
]);
|
|
238
|
-
const
|
|
239
|
-
|
|
240
|
-
"
|
|
241
|
-
"
|
|
242
|
-
"
|
|
243
|
-
"
|
|
244
|
-
"N/A"
|
|
1327
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1328
|
+
"oauth_dcr",
|
|
1329
|
+
"oauth_cimd",
|
|
1330
|
+
"oauth_anthropic_creds",
|
|
1331
|
+
"custom_connection",
|
|
1332
|
+
"none"
|
|
245
1333
|
]);
|
|
246
|
-
const
|
|
247
|
-
"
|
|
248
|
-
"
|
|
249
|
-
"
|
|
250
|
-
"GDPR compliant (if applicable)"
|
|
1334
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1335
|
+
"first_party",
|
|
1336
|
+
"proxied",
|
|
1337
|
+
"third_party"
|
|
251
1338
|
]);
|
|
252
|
-
const
|
|
253
|
-
|
|
254
|
-
"
|
|
255
|
-
"
|
|
1339
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1340
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1341
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1342
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1343
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1344
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1345
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1346
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1347
|
+
"Public documentation for this connector will be live by the publish date."
|
|
256
1348
|
]);
|
|
257
|
-
/**
|
|
258
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
259
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
260
|
-
*/
|
|
1349
|
+
/** 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. */
|
|
261
1350
|
const claudeSubmissionFormDataSchema = z.object({
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
(
|
|
272
|
-
|
|
273
|
-
(
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
•
|
|
291
|
-
•
|
|
292
|
-
•
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
• '
|
|
308
|
-
• '
|
|
309
|
-
• '
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
340
|
-
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:
|
|
341
|
-
• What the connector does and its key capabilities
|
|
342
|
-
• How to connect/set it up (step by step)
|
|
343
|
-
• What each tool does (or at least the main ones)
|
|
344
|
-
• How to troubleshoot common issues
|
|
345
|
-
• A support contact or channel
|
|
346
|
-
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.`),
|
|
347
|
-
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:
|
|
348
|
-
• What data you collect (and how)
|
|
349
|
-
• How you use the collected data
|
|
350
|
-
• Where and how long you store it
|
|
351
|
-
• Whether you share data with third parties (and who)
|
|
352
|
-
• How users can contact you about data concerns
|
|
353
|
-
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.`),
|
|
354
|
-
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:
|
|
355
|
-
• Email address (e.g. support@myapp.com)
|
|
356
|
-
• Link to a GitHub Issues page
|
|
357
|
-
• Link to a help center or support article
|
|
358
|
-
• Link to a Discord/Slack community
|
|
359
|
-
• Link to your documentation's troubleshooting section
|
|
360
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
361
|
-
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:
|
|
362
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
363
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
364
|
-
• 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.
|
|
365
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
366
|
-
• If your service requires API keys instead of a password, provide those.
|
|
367
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
368
|
-
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.
|
|
369
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
370
|
-
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.`),
|
|
371
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
372
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
373
|
-
• '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).
|
|
374
|
-
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.`),
|
|
375
|
-
logoLight: z.string().describe(`Your connector's logo as displayed in the directory. Requirements:
|
|
376
|
-
• Format: SVG only
|
|
377
|
-
• Aspect ratio: square (1:1)
|
|
378
|
-
• Should work on both light and dark backgrounds (or you can provide separate light/dark versions)
|
|
379
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
380
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
381
|
-
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:
|
|
382
|
-
• 3–5 images is ideal
|
|
383
|
-
• Minimum 1000px width, PNG format preferred
|
|
384
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
385
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
386
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
387
|
-
• Videos are also welcome
|
|
388
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
389
|
-
});
|
|
390
|
-
claudeSubmissionFormDataSchema.pick({
|
|
391
|
-
companyName: true,
|
|
392
|
-
appName: true,
|
|
393
|
-
mcpUrlType: true,
|
|
1351
|
+
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
|
|
1352
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1353
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1354
|
+
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
|
|
1355
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1356
|
+
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.
|
|
1357
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1358
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1359
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1360
|
+
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
|
|
1361
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1362
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1363
|
+
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
|
|
1364
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1365
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1366
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1367
|
+
by your publish date.`),
|
|
1368
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1369
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1370
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1371
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1372
|
+
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
|
|
1373
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1374
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1375
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1376
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1377
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1378
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1379
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1380
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1381
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1382
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1383
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1384
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1385
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1386
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1387
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1388
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1389
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1390
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1391
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1392
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1393
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1394
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1395
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1396
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1397
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1398
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1399
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1400
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1401
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1402
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1403
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1404
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1405
|
+
fully populated account.`),
|
|
1406
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1407
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1408
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1409
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1410
|
+
});
|
|
1411
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1412
|
+
serverUrl: z.string().optional(),
|
|
1413
|
+
name: z.string().optional(),
|
|
1414
|
+
slug: z.string().optional(),
|
|
1415
|
+
oneLiner: z.string().optional(),
|
|
1416
|
+
description: z.string().optional(),
|
|
1417
|
+
iconUrl: z.string().optional(),
|
|
1418
|
+
documentation: z.string().optional(),
|
|
1419
|
+
support: z.string().optional(),
|
|
1420
|
+
privacyPolicy: z.string().optional(),
|
|
1421
|
+
companyWebsite: z.string().optional(),
|
|
1422
|
+
primaryContactEmail: z.string().optional(),
|
|
1423
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1424
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1425
|
+
});
|
|
1426
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1427
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
394
1428
|
serverUrl: true,
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
transportSupport: true,
|
|
1429
|
+
name: true,
|
|
1430
|
+
slug: true,
|
|
1431
|
+
companyName: true,
|
|
399
1432
|
primaryContactEmail: true,
|
|
400
|
-
primaryContactName: true
|
|
1433
|
+
primaryContactName: true,
|
|
1434
|
+
readWriteCapabilities: true,
|
|
1435
|
+
authentication: true,
|
|
1436
|
+
apiOwnership: true,
|
|
1437
|
+
personalHealthData: true
|
|
1438
|
+
}).extend({
|
|
1439
|
+
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1440
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
401
1441
|
});
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
1442
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1443
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1444
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1445
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1446
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1447
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1448
|
+
});
|
|
1449
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1450
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1451
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1452
|
+
});
|
|
1453
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1454
|
+
const byField = {};
|
|
1455
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1456
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1457
|
+
return byField;
|
|
1458
|
+
}
|
|
1459
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1460
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1461
|
+
"pass",
|
|
1462
|
+
"fail",
|
|
1463
|
+
"unverified"
|
|
1464
|
+
]);
|
|
1465
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1466
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1467
|
+
claudeai: ["privacyPolicy"]
|
|
1468
|
+
};
|
|
1469
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1470
|
+
const policyDisclosureSchema = z.enum([
|
|
1471
|
+
"dataCategories",
|
|
1472
|
+
"purposesOfUse",
|
|
1473
|
+
"recipients",
|
|
1474
|
+
"retention"
|
|
1475
|
+
]);
|
|
1476
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1477
|
+
field: verifiableUrlFieldSchema,
|
|
1478
|
+
url: z.string(),
|
|
1479
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1480
|
+
reason: z.string(),
|
|
1481
|
+
concerns: z.array(z.string()).optional(),
|
|
1482
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1483
|
+
});
|
|
1484
|
+
const urlVerificationSchema = z.object({
|
|
1485
|
+
verifiedAt: z.coerce.date(),
|
|
1486
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1487
|
+
});
|
|
1488
|
+
const pageKindSchema = z.enum([
|
|
1489
|
+
"expectedDocument",
|
|
1490
|
+
"errorPage",
|
|
1491
|
+
"loginWall",
|
|
1492
|
+
"parkedDomain",
|
|
1493
|
+
"comingSoon",
|
|
1494
|
+
"marketingPage",
|
|
1495
|
+
"unrelatedDocument"
|
|
1496
|
+
]);
|
|
1497
|
+
z.object({
|
|
1498
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1499
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1500
|
+
missingDisclosures: z.array(policyDisclosureSchema).describe("For a privacy policy only: which of the four required disclosures the text does not cover. Empty for every other page kind.")
|
|
407
1501
|
});
|
|
408
1502
|
const submissionMetaFieldsSchema = z.object({
|
|
409
1503
|
id: z.string(),
|
|
410
1504
|
environmentId: z.string(),
|
|
1505
|
+
auditId: z.string().nullable(),
|
|
1506
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
411
1507
|
createdAt: z.coerce.date(),
|
|
412
1508
|
updatedAt: z.coerce.date()
|
|
413
1509
|
});
|
|
414
1510
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
415
1511
|
platform: z.literal("claudeai"),
|
|
416
|
-
formData:
|
|
1512
|
+
formData: claudeSubmissionDraftSchema,
|
|
1513
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
417
1514
|
});
|
|
418
1515
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
419
1516
|
platform: z.literal("chatgpt"),
|
|
420
|
-
formData:
|
|
1517
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1518
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
421
1519
|
});
|
|
422
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
423
|
-
z.union([
|
|
1520
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1521
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1522
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1523
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1524
|
+
z.literal([
|
|
1525
|
+
100,
|
|
1526
|
+
75,
|
|
1527
|
+
50
|
|
1528
|
+
]);
|
|
424
1529
|
const subscriptionPlanSchema = z.enum([
|
|
425
1530
|
"pro",
|
|
426
1531
|
"business",
|
|
427
1532
|
"enterprise"
|
|
428
1533
|
]);
|
|
429
1534
|
z.object({ plan: subscriptionPlanSchema.nullable() });
|
|
1535
|
+
const customerCreditsSchema = z.object({
|
|
1536
|
+
balanceInCents: z.number(),
|
|
1537
|
+
expiresAt: z.number().nullable(),
|
|
1538
|
+
currency: z.string()
|
|
1539
|
+
});
|
|
1540
|
+
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1541
|
+
z.object({
|
|
1542
|
+
customerCredits: customerCreditsSchema.nullable(),
|
|
1543
|
+
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1544
|
+
});
|
|
1545
|
+
const metricsQueueEventSchema = z.object({
|
|
1546
|
+
ts: z.number().int(),
|
|
1547
|
+
method: z.string(),
|
|
1548
|
+
tool: z.string().nullable(),
|
|
1549
|
+
client: z.string(),
|
|
1550
|
+
sessionId: z.string().nullable(),
|
|
1551
|
+
durationMs: z.number().int(),
|
|
1552
|
+
outputTokens: z.number().int().nullable(),
|
|
1553
|
+
errorType: z.enum([
|
|
1554
|
+
"mcp_error",
|
|
1555
|
+
"tool_error",
|
|
1556
|
+
"timeout"
|
|
1557
|
+
]).nullable(),
|
|
1558
|
+
errorCode: z.number().int().nullable()
|
|
1559
|
+
});
|
|
1560
|
+
z.object({
|
|
1561
|
+
v: z.literal(1),
|
|
1562
|
+
envId: z.string(),
|
|
1563
|
+
events: z.array(metricsQueueEventSchema)
|
|
1564
|
+
});
|
|
1565
|
+
z.object({ v: z.number() });
|
|
1566
|
+
const telemetrySignalSchema = z.enum([
|
|
1567
|
+
"logs",
|
|
1568
|
+
"metrics",
|
|
1569
|
+
"traces"
|
|
1570
|
+
]);
|
|
1571
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1572
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1573
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1574
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1575
|
+
const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
|
|
1576
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1577
|
+
id: z.string(),
|
|
1578
|
+
name: otlpHeaderNameSchema,
|
|
1579
|
+
value: otlpHeaderValueSchema,
|
|
1580
|
+
isSecret: z.boolean()
|
|
1581
|
+
});
|
|
1582
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1583
|
+
"credentials",
|
|
1584
|
+
"wrong-path",
|
|
1585
|
+
"wrong-protocol",
|
|
1586
|
+
"invalid-payload",
|
|
1587
|
+
"partial-rejection",
|
|
1588
|
+
"blocked-target",
|
|
1589
|
+
"timeout",
|
|
1590
|
+
"unreachable",
|
|
1591
|
+
"receiver-error",
|
|
1592
|
+
"unexpected-status"
|
|
1593
|
+
]);
|
|
1594
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1595
|
+
z.object({
|
|
1596
|
+
id: z.string(),
|
|
1597
|
+
signal: telemetrySignalSchema,
|
|
1598
|
+
endpoint: otlpEndpointSchema,
|
|
1599
|
+
protocol: otlpProtocolSchema,
|
|
1600
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1601
|
+
status: telemetryDestinationStatusSchema,
|
|
1602
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1603
|
+
});
|
|
1604
|
+
//#endregion
|
|
1605
|
+
//#region src/auth-scope.ts
|
|
1606
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1607
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1608
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1609
|
+
const AUTH_SCOPE_USER = "user";
|
|
430
1610
|
//#endregion
|
|
431
1611
|
//#region src/schemas.ts
|
|
432
1612
|
const RESERVED_KEYS = [
|
|
@@ -463,7 +1643,10 @@ const RESERVED_KEYS = [
|
|
|
463
1643
|
"BUILD_ARG_START_COMMAND",
|
|
464
1644
|
"ALPIC_HOST",
|
|
465
1645
|
"ALPIC_CUSTOM_DOMAINS",
|
|
466
|
-
"ALPIC_INTENT_META_KEY"
|
|
1646
|
+
"ALPIC_INTENT_META_KEY",
|
|
1647
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1648
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1649
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
467
1650
|
];
|
|
468
1651
|
const environmentVariableSchema = z.object({
|
|
469
1652
|
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"),
|
|
@@ -516,6 +1699,14 @@ const serverFieldsSchema = z.object({
|
|
|
516
1699
|
});
|
|
517
1700
|
//#endregion
|
|
518
1701
|
//#region src/api.contract.ts
|
|
1702
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1703
|
+
try {
|
|
1704
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1705
|
+
return true;
|
|
1706
|
+
} catch {
|
|
1707
|
+
return false;
|
|
1708
|
+
}
|
|
1709
|
+
};
|
|
519
1710
|
const deploymentStatusSchema = z.enum([
|
|
520
1711
|
"ongoing",
|
|
521
1712
|
"deployed",
|
|
@@ -544,21 +1735,20 @@ const deploymentSchema = z.object({
|
|
|
544
1735
|
isCurrent: z.boolean(),
|
|
545
1736
|
deploymentPageUrl: z.url().nullable()
|
|
546
1737
|
});
|
|
547
|
-
const
|
|
1738
|
+
const isValidTimeInput = (value) => {
|
|
548
1739
|
if (ms(value) !== void 0) return true;
|
|
549
1740
|
return !Number.isNaN(new Date(value).getTime());
|
|
550
1741
|
};
|
|
551
|
-
const
|
|
1742
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1743
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1744
|
+
const createEnvironmentContractV1 = base.route({
|
|
552
1745
|
path: "/v1/environments",
|
|
553
1746
|
method: "POST",
|
|
554
1747
|
summary: "Create an environment",
|
|
555
1748
|
description: "Create an environment for a project",
|
|
556
1749
|
tags: ["environments"],
|
|
557
1750
|
successDescription: "The environment has been created successfully"
|
|
558
|
-
}).errors({
|
|
559
|
-
NOT_FOUND: {},
|
|
560
|
-
BAD_REQUEST: {}
|
|
561
|
-
}).input(z.object({
|
|
1751
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
562
1752
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
563
1753
|
name: z.string().min(1).describe("The name of the environment"),
|
|
564
1754
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -567,11 +1757,11 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
567
1757
|
id: z.string(),
|
|
568
1758
|
name: z.string(),
|
|
569
1759
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
570
|
-
urls: z.array(z.
|
|
1760
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
571
1761
|
createdAt: z.coerce.date(),
|
|
572
1762
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
573
1763
|
}));
|
|
574
|
-
const getEnvironmentContractV1 =
|
|
1764
|
+
const getEnvironmentContractV1 = base.route({
|
|
575
1765
|
path: "/v1/environments/{environmentId}",
|
|
576
1766
|
method: "GET",
|
|
577
1767
|
summary: "Get an environment",
|
|
@@ -583,10 +1773,18 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
583
1773
|
name: z.string(),
|
|
584
1774
|
sourceBranch: z.string().nullable(),
|
|
585
1775
|
mcpServerUrl: z.string(),
|
|
586
|
-
domains: z.array(z.
|
|
1776
|
+
domains: z.array(z.hostname()),
|
|
587
1777
|
createdAt: z.coerce.date(),
|
|
588
1778
|
projectId: z.string()
|
|
589
1779
|
}));
|
|
1780
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1781
|
+
path: "/v1/environments/{environmentId}",
|
|
1782
|
+
method: "DELETE",
|
|
1783
|
+
summary: "Delete an environment",
|
|
1784
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1785
|
+
tags: ["environments"],
|
|
1786
|
+
successDescription: "The environment has been deleted successfully"
|
|
1787
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
590
1788
|
const domainSchema = z.object({
|
|
591
1789
|
domain: z.string(),
|
|
592
1790
|
status: z.enum([
|
|
@@ -628,7 +1826,7 @@ const projectOutputSchema = z.object({
|
|
|
628
1826
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
629
1827
|
environments: z.array(environmentSchema)
|
|
630
1828
|
});
|
|
631
|
-
const getProjectContractV1 =
|
|
1829
|
+
const getProjectContractV1 = base.route({
|
|
632
1830
|
path: "/v1/projects/{projectId}",
|
|
633
1831
|
method: "GET",
|
|
634
1832
|
summary: "Get a project",
|
|
@@ -636,15 +1834,15 @@ const getProjectContractV1 = oc.route({
|
|
|
636
1834
|
tags: ["projects"],
|
|
637
1835
|
successDescription: "The project details"
|
|
638
1836
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
639
|
-
const listProjectsContractV1 =
|
|
1837
|
+
const listProjectsContractV1 = base.route({
|
|
640
1838
|
path: "/v1/projects",
|
|
641
1839
|
method: "GET",
|
|
642
1840
|
summary: "List projects",
|
|
643
1841
|
description: "List all projects for a team",
|
|
644
1842
|
tags: ["projects"],
|
|
645
1843
|
successDescription: "The list of projects"
|
|
646
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
647
|
-
const createProjectContractV1 =
|
|
1844
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1845
|
+
const createProjectContractV1 = base.route({
|
|
648
1846
|
path: "/v1/projects",
|
|
649
1847
|
method: "POST",
|
|
650
1848
|
summary: "Create a project",
|
|
@@ -653,7 +1851,7 @@ const createProjectContractV1 = oc.route({
|
|
|
653
1851
|
successDescription: "The project has been created successfully"
|
|
654
1852
|
}).errors({
|
|
655
1853
|
NOT_FOUND: {},
|
|
656
|
-
|
|
1854
|
+
FORBIDDEN: {}
|
|
657
1855
|
}).input(z.object({
|
|
658
1856
|
teamId: z.string().optional(),
|
|
659
1857
|
name: z.string().trim().min(1).max(100),
|
|
@@ -693,7 +1891,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
693
1891
|
isSecret: z.boolean(),
|
|
694
1892
|
createdAt: z.coerce.date()
|
|
695
1893
|
});
|
|
696
|
-
const listEnvironmentVariablesContractV1 =
|
|
1894
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
697
1895
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
698
1896
|
method: "GET",
|
|
699
1897
|
summary: "List environment variables",
|
|
@@ -701,37 +1899,31 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
701
1899
|
tags: ["environments"],
|
|
702
1900
|
successDescription: "The list of environment variables"
|
|
703
1901
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
704
|
-
const createEnvironmentVariablesContractV1 =
|
|
1902
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
705
1903
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
706
1904
|
method: "POST",
|
|
707
1905
|
summary: "Add environment variables",
|
|
708
1906
|
description: "Add one or more environment variables to an environment",
|
|
709
1907
|
tags: ["environments"],
|
|
710
1908
|
successDescription: "The environment variables have been added successfully"
|
|
711
|
-
}).errors({
|
|
712
|
-
NOT_FOUND: {},
|
|
713
|
-
BAD_REQUEST: {}
|
|
714
|
-
}).input(z.object({
|
|
1909
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
715
1910
|
environmentId: z.string().describe("The ID of the environment"),
|
|
716
1911
|
environmentVariables: environmentVariablesSchema
|
|
717
1912
|
})).output(z.object({ success: z.literal(true) }));
|
|
718
|
-
const updateEnvironmentVariableContractV1 =
|
|
1913
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
719
1914
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
720
1915
|
method: "PATCH",
|
|
721
1916
|
summary: "Update an environment variable",
|
|
722
1917
|
description: "Update an environment variable by ID",
|
|
723
1918
|
tags: ["environments"],
|
|
724
1919
|
successDescription: "The environment variable has been updated successfully"
|
|
725
|
-
}).errors({
|
|
726
|
-
NOT_FOUND: {},
|
|
727
|
-
BAD_REQUEST: {}
|
|
728
|
-
}).input(z.object({
|
|
1920
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
729
1921
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
730
1922
|
key: environmentVariableSchema.shape.key,
|
|
731
1923
|
value: environmentVariableSchema.shape.value.optional(),
|
|
732
1924
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
733
1925
|
})).output(z.object({ success: z.literal(true) }));
|
|
734
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1926
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
735
1927
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
736
1928
|
method: "DELETE",
|
|
737
1929
|
summary: "Delete an environment variable",
|
|
@@ -739,7 +1931,7 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
739
1931
|
tags: ["environments"],
|
|
740
1932
|
successDescription: "The environment variable has been deleted successfully"
|
|
741
1933
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
742
|
-
const deleteProjectContractV1 =
|
|
1934
|
+
const deleteProjectContractV1 = base.route({
|
|
743
1935
|
path: "/v1/projects/{projectId}",
|
|
744
1936
|
method: "DELETE",
|
|
745
1937
|
summary: "Delete a project",
|
|
@@ -747,7 +1939,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
747
1939
|
tags: ["projects"],
|
|
748
1940
|
successDescription: "The project has been deleted successfully"
|
|
749
1941
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
750
|
-
const updateProjectContractV1 =
|
|
1942
|
+
const updateProjectContractV1 = base.route({
|
|
751
1943
|
path: "/v1/projects/{projectId}",
|
|
752
1944
|
method: "PATCH",
|
|
753
1945
|
summary: "Update a project",
|
|
@@ -756,13 +1948,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
756
1948
|
successDescription: "The project has been updated successfully"
|
|
757
1949
|
}).errors({
|
|
758
1950
|
NOT_FOUND: {},
|
|
759
|
-
|
|
1951
|
+
FORBIDDEN: {}
|
|
760
1952
|
}).input(z.object({
|
|
761
1953
|
projectId: z.string().describe("The ID of the project"),
|
|
762
1954
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
763
1955
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
764
1956
|
})).output(projectOutputSchema);
|
|
765
|
-
const deployEnvironmentContractV1 =
|
|
1957
|
+
const deployEnvironmentContractV1 = base.route({
|
|
766
1958
|
path: "/v1/environments/{environmentId}/deploy",
|
|
767
1959
|
method: "POST",
|
|
768
1960
|
summary: "Deploy an environment",
|
|
@@ -771,24 +1963,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
771
1963
|
successDescription: "The environment has been deployed successfully"
|
|
772
1964
|
}).errors({
|
|
773
1965
|
NOT_FOUND: {},
|
|
774
|
-
|
|
1966
|
+
CONFLICT: {}
|
|
775
1967
|
}).input(z.object({
|
|
776
1968
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
777
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1969
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1970
|
+
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.")
|
|
778
1971
|
})).output(deploymentSchema);
|
|
779
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1972
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
780
1973
|
path: "/v1/deployments/upload",
|
|
781
1974
|
method: "POST",
|
|
782
1975
|
summary: "Upload deployment artifacts",
|
|
783
1976
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
784
1977
|
tags: ["deployments"],
|
|
785
1978
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
786
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1979
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
787
1980
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
788
1981
|
token: z.string().describe("Token to identify the source archive"),
|
|
789
1982
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
790
1983
|
}));
|
|
791
|
-
const listDeploymentsContractV1 =
|
|
1984
|
+
const listDeploymentsContractV1 = base.route({
|
|
792
1985
|
path: "/v1/projects/{projectId}/deployments",
|
|
793
1986
|
method: "GET",
|
|
794
1987
|
summary: "List project deployments",
|
|
@@ -800,7 +1993,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
800
1993
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
801
1994
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
802
1995
|
})).output(z.array(deploymentSchema));
|
|
803
|
-
const getDeploymentContractV1 =
|
|
1996
|
+
const getDeploymentContractV1 = base.route({
|
|
804
1997
|
path: "/v1/deployments/{deploymentId}",
|
|
805
1998
|
method: "GET",
|
|
806
1999
|
summary: "Get a deployment",
|
|
@@ -808,20 +2001,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
808
2001
|
tags: ["deployments"],
|
|
809
2002
|
successDescription: "The deployment details"
|
|
810
2003
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
811
|
-
const
|
|
2004
|
+
const logEntrySchema = z.object({
|
|
2005
|
+
timestamp: z.coerce.date(),
|
|
2006
|
+
type: z.enum([
|
|
2007
|
+
"START",
|
|
2008
|
+
"END",
|
|
2009
|
+
"INFO",
|
|
2010
|
+
"ERROR",
|
|
2011
|
+
"WARNING",
|
|
2012
|
+
"DEBUG"
|
|
2013
|
+
]),
|
|
2014
|
+
requestId: z.string(),
|
|
2015
|
+
content: z.string().optional(),
|
|
2016
|
+
method: z.string().optional(),
|
|
2017
|
+
durationInMs: z.number().optional()
|
|
2018
|
+
});
|
|
2019
|
+
const getLogsContractV1 = base.route({
|
|
812
2020
|
path: "/v1/environments/{environmentId}/logs",
|
|
813
2021
|
method: "GET",
|
|
814
2022
|
summary: "Get logs",
|
|
815
2023
|
description: "Get logs for an environment",
|
|
816
2024
|
tags: ["environments"],
|
|
817
2025
|
successDescription: "The logs"
|
|
818
|
-
}).errors({
|
|
819
|
-
NOT_FOUND: {},
|
|
820
|
-
BAD_REQUEST: {}
|
|
821
|
-
}).input(z.object({
|
|
2026
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
822
2027
|
environmentId: z.string().describe("The ID of the environment"),
|
|
823
|
-
since:
|
|
824
|
-
until:
|
|
2028
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2029
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
825
2030
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
826
2031
|
level: z.array(z.enum([
|
|
827
2032
|
"INFO",
|
|
@@ -832,34 +2037,17 @@ const getLogsContractV1 = oc.route({
|
|
|
832
2037
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
833
2038
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
834
2039
|
})).output(z.object({
|
|
835
|
-
logs: z.array(
|
|
836
|
-
timestamp: z.coerce.date(),
|
|
837
|
-
type: z.enum([
|
|
838
|
-
"START",
|
|
839
|
-
"END",
|
|
840
|
-
"INFO",
|
|
841
|
-
"ERROR",
|
|
842
|
-
"WARNING",
|
|
843
|
-
"DEBUG"
|
|
844
|
-
]),
|
|
845
|
-
requestId: z.string(),
|
|
846
|
-
content: z.string().optional(),
|
|
847
|
-
method: z.string().optional(),
|
|
848
|
-
durationInMs: z.number().optional()
|
|
849
|
-
})),
|
|
2040
|
+
logs: z.array(logEntrySchema),
|
|
850
2041
|
nextToken: z.string().nullable()
|
|
851
2042
|
}));
|
|
852
|
-
const getLatestLogsContractV1 =
|
|
2043
|
+
const getLatestLogsContractV1 = base.route({
|
|
853
2044
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
854
2045
|
method: "GET",
|
|
855
2046
|
summary: "Get latest logs",
|
|
856
2047
|
description: "Get the N most recent logs for an environment",
|
|
857
2048
|
tags: ["environments"],
|
|
858
2049
|
successDescription: "The latest logs"
|
|
859
|
-
}).errors({
|
|
860
|
-
NOT_FOUND: {},
|
|
861
|
-
BAD_REQUEST: {}
|
|
862
|
-
}).input(z.object({
|
|
2050
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
863
2051
|
environmentId: z.string().describe("The ID of the environment"),
|
|
864
2052
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
865
2053
|
level: z.array(z.enum([
|
|
@@ -869,22 +2057,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
869
2057
|
"DEBUG"
|
|
870
2058
|
])).optional().describe("Filter by log level"),
|
|
871
2059
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
872
|
-
})).output(z.object({ logs: z.array(
|
|
873
|
-
|
|
874
|
-
type: z.enum([
|
|
875
|
-
"START",
|
|
876
|
-
"END",
|
|
877
|
-
"INFO",
|
|
878
|
-
"ERROR",
|
|
879
|
-
"WARNING",
|
|
880
|
-
"DEBUG"
|
|
881
|
-
]),
|
|
882
|
-
requestId: z.string(),
|
|
883
|
-
content: z.string().optional(),
|
|
884
|
-
method: z.string().optional(),
|
|
885
|
-
durationInMs: z.number().optional()
|
|
886
|
-
})) }));
|
|
887
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
2060
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
2061
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
888
2062
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
889
2063
|
method: "GET",
|
|
890
2064
|
summary: "Get deployment logs",
|
|
@@ -911,22 +2085,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
911
2085
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
912
2086
|
task_count: z.array(analyticsDataPointSchema)
|
|
913
2087
|
});
|
|
914
|
-
const getProjectAnalyticsContractV1 =
|
|
2088
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
915
2089
|
path: "/v1/analytics/{projectId}",
|
|
916
2090
|
method: "GET",
|
|
917
2091
|
summary: "Get project analytics",
|
|
918
2092
|
description: "Get analytics data for a project over a time range",
|
|
919
2093
|
tags: ["analytics"],
|
|
920
2094
|
successDescription: "The project analytics data"
|
|
921
|
-
}).errors({
|
|
922
|
-
NOT_FOUND: {},
|
|
923
|
-
BAD_REQUEST: {}
|
|
924
|
-
}).input(z.object({
|
|
2095
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
925
2096
|
projectId: z.string().describe("The ID of the project"),
|
|
926
2097
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
927
2098
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
928
2099
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
929
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2100
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => isValidIanaTimeZone(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
930
2101
|
metadata: z.object({
|
|
931
2102
|
startTimestamp: z.number(),
|
|
932
2103
|
endTimestamp: z.number(),
|
|
@@ -936,7 +2107,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
936
2107
|
}),
|
|
937
2108
|
timeSeries: analyticsTimeSeriesSchema
|
|
938
2109
|
}));
|
|
939
|
-
const
|
|
2110
|
+
const paginatedInsightsInputShape = {
|
|
2111
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2112
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2113
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2114
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2115
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2116
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2117
|
+
};
|
|
2118
|
+
const listIntentsContractV1 = base.route({
|
|
2119
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2120
|
+
method: "GET",
|
|
2121
|
+
summary: "List intents",
|
|
2122
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2123
|
+
tags: ["insights"],
|
|
2124
|
+
successDescription: "The grouped user intents"
|
|
2125
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2126
|
+
...paginatedInsightsInputShape,
|
|
2127
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2128
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2129
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2130
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2131
|
+
})).output(z.object({
|
|
2132
|
+
intents: z.array(z.object({
|
|
2133
|
+
id: z.string(),
|
|
2134
|
+
intentIds: z.array(z.string()).min(1),
|
|
2135
|
+
environmentId: z.string(),
|
|
2136
|
+
message: z.string(),
|
|
2137
|
+
toolName: z.string(),
|
|
2138
|
+
createdAt: z.coerce.date(),
|
|
2139
|
+
occurrenceCount: z.number().int().positive(),
|
|
2140
|
+
clientName: z.string().nullable(),
|
|
2141
|
+
clientId: z.string().nullable(),
|
|
2142
|
+
categories: z.array(z.object({
|
|
2143
|
+
id: z.string(),
|
|
2144
|
+
name: z.string(),
|
|
2145
|
+
color: intentCategoryColorSchema
|
|
2146
|
+
}))
|
|
2147
|
+
})),
|
|
2148
|
+
totalCount: z.number().int().nonnegative()
|
|
2149
|
+
}));
|
|
2150
|
+
const listFeedbacksContractV1 = base.route({
|
|
2151
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2152
|
+
method: "GET",
|
|
2153
|
+
summary: "List feedbacks",
|
|
2154
|
+
description: "List user feedback for an environment over a time range",
|
|
2155
|
+
tags: ["insights"],
|
|
2156
|
+
successDescription: "The user feedback"
|
|
2157
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2158
|
+
...paginatedInsightsInputShape,
|
|
2159
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2160
|
+
})).output(z.object({
|
|
2161
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2162
|
+
totalCount: z.number().int().nonnegative()
|
|
2163
|
+
}));
|
|
2164
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2165
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2166
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2167
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2168
|
+
method: "GET",
|
|
2169
|
+
summary: "List intent categories",
|
|
2170
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2171
|
+
tags: ["insights"],
|
|
2172
|
+
successDescription: "The intent categories"
|
|
2173
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2174
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2175
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2176
|
+
method: "POST",
|
|
2177
|
+
summary: "Create an intent category",
|
|
2178
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2179
|
+
tags: ["insights"],
|
|
2180
|
+
successDescription: "The created intent category"
|
|
2181
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2182
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2183
|
+
name: intentCategoryNameSchema,
|
|
2184
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2185
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2186
|
+
})).output(intentCategorySchema);
|
|
2187
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2188
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2189
|
+
method: "PATCH",
|
|
2190
|
+
summary: "Update an intent category",
|
|
2191
|
+
description: "Rename or recolor an intent category",
|
|
2192
|
+
tags: ["insights"],
|
|
2193
|
+
successDescription: "The updated intent category"
|
|
2194
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2195
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2196
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2197
|
+
name: intentCategoryNameSchema.optional(),
|
|
2198
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2199
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2200
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2201
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2202
|
+
method: "DELETE",
|
|
2203
|
+
summary: "Delete an intent category",
|
|
2204
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2205
|
+
tags: ["insights"],
|
|
2206
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2207
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2208
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2209
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2210
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2211
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2212
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2213
|
+
method: "POST",
|
|
2214
|
+
summary: "Link an intent category",
|
|
2215
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2216
|
+
tags: ["insights"],
|
|
2217
|
+
successDescription: "The intents have been linked successfully"
|
|
2218
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2219
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2220
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2221
|
+
intentIds: categorizableIntentIdsSchema
|
|
2222
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2223
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2224
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2225
|
+
method: "POST",
|
|
2226
|
+
summary: "Unlink an intent category",
|
|
2227
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2228
|
+
tags: ["insights"],
|
|
2229
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2230
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2231
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2232
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2233
|
+
intentIds: categorizableIntentIdsSchema
|
|
2234
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2235
|
+
const listTeamsContractV1 = base.route({
|
|
940
2236
|
path: "/v1/teams",
|
|
941
2237
|
method: "GET",
|
|
942
2238
|
summary: "List teams",
|
|
@@ -949,28 +2245,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
949
2245
|
createdAt: z.coerce.date(),
|
|
950
2246
|
hasStripeAccount: z.boolean()
|
|
951
2247
|
})));
|
|
952
|
-
const
|
|
2248
|
+
const getTeamUsageContractV1 = base.route({
|
|
2249
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2250
|
+
method: "GET",
|
|
2251
|
+
summary: "Get team usage",
|
|
2252
|
+
description: "Get the MCP request usage of a team for its current billing window. A team that has made no request in the window reports zero.",
|
|
2253
|
+
tags: ["teams"],
|
|
2254
|
+
successDescription: "The current billing window usage"
|
|
2255
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2256
|
+
teamId: z.string(),
|
|
2257
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2258
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2259
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2260
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2261
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2262
|
+
}));
|
|
2263
|
+
const getTunnelTicketContractV1 = base.route({
|
|
953
2264
|
path: "/v1/tunnels/ticket",
|
|
954
2265
|
method: "GET",
|
|
955
2266
|
summary: "Get a tunnel ticket",
|
|
956
2267
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
957
2268
|
tags: ["tunnels"],
|
|
958
2269
|
successDescription: "The tunnel ticket"
|
|
959
|
-
}).output(z.object({
|
|
2270
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
960
2271
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
961
2272
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
962
2273
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
963
2274
|
}));
|
|
964
|
-
const publishServerContractV1 =
|
|
2275
|
+
const publishServerContractV1 = base.route({
|
|
965
2276
|
path: "/v1/distribution/publish",
|
|
966
2277
|
method: "POST",
|
|
967
2278
|
summary: "Publish a server to the MCP registry",
|
|
968
2279
|
tags: ["distribution"],
|
|
969
2280
|
successDescription: "The server has been published successfully"
|
|
970
|
-
}).errors({
|
|
971
|
-
NOT_FOUND: {},
|
|
972
|
-
BAD_REQUEST: {}
|
|
973
|
-
}).input(z.object({
|
|
2281
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
974
2282
|
projectId: z.string(),
|
|
975
2283
|
domain: z.string(),
|
|
976
2284
|
title: z.string().min(1).max(100),
|
|
@@ -979,17 +2287,14 @@ const publishServerContractV1 = oc.route({
|
|
|
979
2287
|
iconSrc: z.url().max(255).optional(),
|
|
980
2288
|
dryRun: z.boolean().optional()
|
|
981
2289
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
982
|
-
const getServerInfoContractV1 =
|
|
2290
|
+
const getServerInfoContractV1 = base.route({
|
|
983
2291
|
path: "/v1/distribution/get",
|
|
984
2292
|
method: "GET",
|
|
985
2293
|
summary: "Get server info",
|
|
986
2294
|
description: "Get info about a server",
|
|
987
2295
|
tags: ["distribution"],
|
|
988
2296
|
successDescription: "The server info"
|
|
989
|
-
}).errors({
|
|
990
|
-
NOT_FOUND: {},
|
|
991
|
-
BAD_REQUEST: {}
|
|
992
|
-
}).input(z.object({
|
|
2297
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
993
2298
|
projectId: z.string(),
|
|
994
2299
|
domain: z.string()
|
|
995
2300
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1008,7 +2313,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1008
2313
|
isPlaygroundEnabled: z.boolean(),
|
|
1009
2314
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1010
2315
|
});
|
|
1011
|
-
const getPlaygroundContractV1 =
|
|
2316
|
+
const getPlaygroundContractV1 = base.route({
|
|
1012
2317
|
path: "/v1/environments/{environmentId}/playground",
|
|
1013
2318
|
method: "GET",
|
|
1014
2319
|
summary: "Get playground configuration",
|
|
@@ -1016,25 +2321,22 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1016
2321
|
tags: ["environments"],
|
|
1017
2322
|
successDescription: "The playground configuration"
|
|
1018
2323
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1019
|
-
const upsertPlaygroundContractV1 =
|
|
2324
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1020
2325
|
path: "/v1/environments/{environmentId}/playground",
|
|
1021
2326
|
method: "PUT",
|
|
1022
2327
|
summary: "Update playground configuration",
|
|
1023
2328
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1024
2329
|
tags: ["environments"],
|
|
1025
2330
|
successDescription: "The updated playground configuration"
|
|
1026
|
-
}).errors({
|
|
1027
|
-
NOT_FOUND: {},
|
|
1028
|
-
BAD_REQUEST: {}
|
|
1029
|
-
}).input(z.object({
|
|
2331
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1030
2332
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1031
2333
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1032
2334
|
name: z.string().min(1).max(100).optional(),
|
|
1033
2335
|
description: z.string().min(1).max(500).optional(),
|
|
1034
2336
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1035
|
-
examplePrompts: z.array(playgroundExamplePromptSchema).max(
|
|
2337
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1036
2338
|
})).output(playgroundOutputSchema);
|
|
1037
|
-
const createBeaconContractV1 =
|
|
2339
|
+
const createBeaconContractV1 = base.route({
|
|
1038
2340
|
path: "/v1/beacon/audits",
|
|
1039
2341
|
method: "POST",
|
|
1040
2342
|
summary: "Create a beacon audit",
|
|
@@ -1043,7 +2345,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1043
2345
|
successDescription: "The audit has been created"
|
|
1044
2346
|
}).errors({
|
|
1045
2347
|
NOT_FOUND: {},
|
|
1046
|
-
BAD_REQUEST: {},
|
|
1047
2348
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1048
2349
|
}).input(z.object({
|
|
1049
2350
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1051,7 +2352,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1051
2352
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1052
2353
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1053
2354
|
})).output(z.object({ id: z.string() }));
|
|
1054
|
-
const getBeaconContractV1 =
|
|
2355
|
+
const getBeaconContractV1 = base.route({
|
|
1055
2356
|
path: "/v1/beacon/audits/{auditId}",
|
|
1056
2357
|
method: "GET",
|
|
1057
2358
|
summary: "Get a beacon audit",
|
|
@@ -1066,9 +2367,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1066
2367
|
createdAt: z.coerce.date(),
|
|
1067
2368
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1068
2369
|
}));
|
|
2370
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2371
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2372
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2373
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2374
|
+
const createSubmissionContractV1 = base.route({
|
|
2375
|
+
path: "/v1/submissions",
|
|
2376
|
+
method: "POST",
|
|
2377
|
+
summary: "Create a submission package",
|
|
2378
|
+
description: "Create a submission package for an environment. Alpic reads the environment's live MCP server and prefills every field it can infer, so the response already carries the populated package. The environment must have a successful deployment and must not require authentication.",
|
|
2379
|
+
tags: ["submissions"],
|
|
2380
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2381
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2382
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2383
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2384
|
+
})).output(submissionSchema);
|
|
2385
|
+
const listSubmissionsContractV1 = base.route({
|
|
2386
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2387
|
+
method: "GET",
|
|
2388
|
+
summary: "List submission packages",
|
|
2389
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2390
|
+
tags: ["submissions"],
|
|
2391
|
+
successDescription: "The list of submission packages"
|
|
2392
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2393
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2394
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2395
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2396
|
+
})).output(z.array(submissionSchema));
|
|
2397
|
+
const getSubmissionContractV1 = base.route({
|
|
2398
|
+
path: "/v1/submissions/{submissionId}",
|
|
2399
|
+
method: "GET",
|
|
2400
|
+
summary: "Get a submission package",
|
|
2401
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2402
|
+
tags: ["submissions"],
|
|
2403
|
+
successDescription: "The submission package"
|
|
2404
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2405
|
+
const updateSubmissionContractV1 = base.route({
|
|
2406
|
+
path: "/v1/submissions/{submissionId}",
|
|
2407
|
+
method: "PUT",
|
|
2408
|
+
summary: "Update a submission package",
|
|
2409
|
+
description: "Update the form data of a submission package. Only the fields you send are changed; the rest are left as they are. Unknown field names are rejected rather than ignored, so a typo fails the call. `platform` must match the package's own platform.",
|
|
2410
|
+
tags: ["submissions"],
|
|
2411
|
+
successDescription: "The updated submission package"
|
|
2412
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2413
|
+
submissionId: submissionIdSchema,
|
|
2414
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2415
|
+
formData: claudeSubmissionUpdateSchema
|
|
2416
|
+
}), z.object({
|
|
2417
|
+
submissionId: submissionIdSchema,
|
|
2418
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2419
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2420
|
+
})])).output(submissionSchema);
|
|
1069
2421
|
const contract = {
|
|
1070
|
-
teams: {
|
|
2422
|
+
teams: {
|
|
2423
|
+
list: { v1: listTeamsContractV1 },
|
|
2424
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2425
|
+
},
|
|
1071
2426
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2427
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2428
|
+
intentCategories: {
|
|
2429
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2430
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2431
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2432
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2433
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2434
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2435
|
+
},
|
|
2436
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1072
2437
|
deployments: {
|
|
1073
2438
|
list: { v1: listDeploymentsContractV1 },
|
|
1074
2439
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1078,6 +2443,7 @@ const contract = {
|
|
|
1078
2443
|
environments: {
|
|
1079
2444
|
create: { v1: createEnvironmentContractV1 },
|
|
1080
2445
|
get: { v1: getEnvironmentContractV1 },
|
|
2446
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1081
2447
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1082
2448
|
getLogs: { v1: getLogsContractV1 },
|
|
1083
2449
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1107,7 +2473,39 @@ const contract = {
|
|
|
1107
2473
|
beacon: {
|
|
1108
2474
|
create: { v1: createBeaconContractV1 },
|
|
1109
2475
|
get: { v1: getBeaconContractV1 }
|
|
2476
|
+
},
|
|
2477
|
+
submissions: {
|
|
2478
|
+
create: { v1: createSubmissionContractV1 },
|
|
2479
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2480
|
+
get: { v1: getSubmissionContractV1 },
|
|
2481
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2482
|
+
}
|
|
2483
|
+
};
|
|
2484
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2485
|
+
const contractForDocs = {
|
|
2486
|
+
...contract,
|
|
2487
|
+
deployments: deploymentsForDocs
|
|
2488
|
+
};
|
|
2489
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2490
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2491
|
+
info: {
|
|
2492
|
+
title: "Alpic API",
|
|
2493
|
+
version: "1.0.0"
|
|
2494
|
+
},
|
|
2495
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2496
|
+
security: [{ bearerAuth: [] }],
|
|
2497
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2498
|
+
type: "http",
|
|
2499
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2500
|
+
scheme: "bearer"
|
|
2501
|
+
} } },
|
|
2502
|
+
commonSchemas: {
|
|
2503
|
+
Submission: { schema: submissionSchema },
|
|
2504
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2505
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2506
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2507
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
1110
2508
|
}
|
|
1111
2509
|
};
|
|
1112
2510
|
//#endregion
|
|
1113
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2511
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, PLATFORM_LABELS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|