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