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