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