@alpic-ai/api 0.0.0-dev.ge8867f0 → 0.0.0-dev.ge8a2a7c
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 +1572 -76
- package/dist/index.mjs +1305 -343
- package/package.json +24 -8
package/dist/index.mjs
CHANGED
|
@@ -1,11 +1,189 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
|
+
import * as z$1 from "zod/v4";
|
|
2
3
|
import { oc } from "@orpc/contract";
|
|
3
4
|
import ms from "ms";
|
|
4
|
-
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
|
+
/**
|
|
7
|
+
* Reusable URL validation that disallows javascript: scheme
|
|
8
|
+
*/
|
|
9
|
+
const SafeUrlSchema = z$1.url().superRefine((val, ctx) => {
|
|
10
|
+
if (!URL.canParse(val)) {
|
|
11
|
+
ctx.addIssue({
|
|
12
|
+
code: z$1.ZodIssueCode.custom,
|
|
13
|
+
message: "URL must be parseable",
|
|
14
|
+
fatal: true
|
|
15
|
+
});
|
|
16
|
+
return z$1.NEVER;
|
|
17
|
+
}
|
|
18
|
+
}).refine((url) => {
|
|
19
|
+
const u = new URL(url);
|
|
20
|
+
return u.protocol !== "javascript:" && u.protocol !== "data:" && u.protocol !== "vbscript:";
|
|
21
|
+
}, { message: "URL cannot use javascript:, data:, or vbscript: scheme" });
|
|
22
|
+
/**
|
|
23
|
+
* RFC 9728 OAuth Protected Resource Metadata
|
|
24
|
+
*/
|
|
25
|
+
const OAuthProtectedResourceMetadataSchema = z$1.looseObject({
|
|
26
|
+
resource: z$1.string().url(),
|
|
27
|
+
authorization_servers: z$1.array(SafeUrlSchema).optional(),
|
|
28
|
+
jwks_uri: z$1.string().url().optional(),
|
|
29
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
30
|
+
bearer_methods_supported: z$1.array(z$1.string()).optional(),
|
|
31
|
+
resource_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
32
|
+
resource_name: z$1.string().optional(),
|
|
33
|
+
resource_documentation: z$1.string().optional(),
|
|
34
|
+
resource_policy_uri: z$1.string().url().optional(),
|
|
35
|
+
resource_tos_uri: z$1.string().url().optional(),
|
|
36
|
+
tls_client_certificate_bound_access_tokens: z$1.boolean().optional(),
|
|
37
|
+
authorization_details_types_supported: z$1.array(z$1.string()).optional(),
|
|
38
|
+
dpop_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
39
|
+
dpop_bound_access_tokens_required: z$1.boolean().optional()
|
|
40
|
+
});
|
|
41
|
+
/**
|
|
42
|
+
* RFC 8414 OAuth 2.0 Authorization Server Metadata
|
|
43
|
+
*/
|
|
44
|
+
const OAuthMetadataSchema = z$1.looseObject({
|
|
45
|
+
issuer: z$1.string(),
|
|
46
|
+
authorization_endpoint: SafeUrlSchema,
|
|
47
|
+
token_endpoint: SafeUrlSchema,
|
|
48
|
+
registration_endpoint: SafeUrlSchema.optional(),
|
|
49
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
50
|
+
response_types_supported: z$1.array(z$1.string()),
|
|
51
|
+
response_modes_supported: z$1.array(z$1.string()).optional(),
|
|
52
|
+
grant_types_supported: z$1.array(z$1.string()).optional(),
|
|
53
|
+
token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
54
|
+
token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
55
|
+
service_documentation: SafeUrlSchema.optional(),
|
|
56
|
+
revocation_endpoint: SafeUrlSchema.optional(),
|
|
57
|
+
revocation_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
58
|
+
revocation_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
59
|
+
introspection_endpoint: z$1.string().optional(),
|
|
60
|
+
introspection_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
61
|
+
introspection_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
62
|
+
code_challenge_methods_supported: z$1.array(z$1.string()).optional(),
|
|
63
|
+
client_id_metadata_document_supported: z$1.boolean().optional()
|
|
64
|
+
});
|
|
65
|
+
/**
|
|
66
|
+
* OpenID Connect Discovery 1.0 Provider Metadata
|
|
67
|
+
* see: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
|
|
68
|
+
*/
|
|
69
|
+
const OpenIdProviderMetadataSchema = z$1.looseObject({
|
|
70
|
+
issuer: z$1.string(),
|
|
71
|
+
authorization_endpoint: SafeUrlSchema,
|
|
72
|
+
token_endpoint: SafeUrlSchema,
|
|
73
|
+
userinfo_endpoint: SafeUrlSchema.optional(),
|
|
74
|
+
jwks_uri: SafeUrlSchema,
|
|
75
|
+
registration_endpoint: SafeUrlSchema.optional(),
|
|
76
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
77
|
+
response_types_supported: z$1.array(z$1.string()),
|
|
78
|
+
response_modes_supported: z$1.array(z$1.string()).optional(),
|
|
79
|
+
grant_types_supported: z$1.array(z$1.string()).optional(),
|
|
80
|
+
acr_values_supported: z$1.array(z$1.string()).optional(),
|
|
81
|
+
subject_types_supported: z$1.array(z$1.string()),
|
|
82
|
+
id_token_signing_alg_values_supported: z$1.array(z$1.string()),
|
|
83
|
+
id_token_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
84
|
+
id_token_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
85
|
+
userinfo_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
86
|
+
userinfo_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
87
|
+
userinfo_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
88
|
+
request_object_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
89
|
+
request_object_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
90
|
+
request_object_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
91
|
+
token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
92
|
+
token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
93
|
+
display_values_supported: z$1.array(z$1.string()).optional(),
|
|
94
|
+
claim_types_supported: z$1.array(z$1.string()).optional(),
|
|
95
|
+
claims_supported: z$1.array(z$1.string()).optional(),
|
|
96
|
+
service_documentation: z$1.string().optional(),
|
|
97
|
+
claims_locales_supported: z$1.array(z$1.string()).optional(),
|
|
98
|
+
ui_locales_supported: z$1.array(z$1.string()).optional(),
|
|
99
|
+
claims_parameter_supported: z$1.boolean().optional(),
|
|
100
|
+
request_parameter_supported: z$1.boolean().optional(),
|
|
101
|
+
request_uri_parameter_supported: z$1.boolean().optional(),
|
|
102
|
+
require_request_uri_registration: z$1.boolean().optional(),
|
|
103
|
+
op_policy_uri: SafeUrlSchema.optional(),
|
|
104
|
+
op_tos_uri: SafeUrlSchema.optional(),
|
|
105
|
+
client_id_metadata_document_supported: z$1.boolean().optional()
|
|
106
|
+
});
|
|
107
|
+
/**
|
|
108
|
+
* OpenID Connect Discovery metadata that may include OAuth 2.0 fields
|
|
109
|
+
* This schema represents the real-world scenario where OIDC providers
|
|
110
|
+
* return a mix of OpenID Connect and OAuth 2.0 metadata fields
|
|
111
|
+
*/
|
|
112
|
+
const OpenIdProviderDiscoveryMetadataSchema = z$1.object({
|
|
113
|
+
...OpenIdProviderMetadataSchema.shape,
|
|
114
|
+
...OAuthMetadataSchema.pick({ code_challenge_methods_supported: true }).shape
|
|
115
|
+
});
|
|
116
|
+
z$1.object({
|
|
117
|
+
access_token: z$1.string(),
|
|
118
|
+
id_token: z$1.string().optional(),
|
|
119
|
+
token_type: z$1.string(),
|
|
120
|
+
expires_in: z$1.coerce.number().optional(),
|
|
121
|
+
scope: z$1.string().optional(),
|
|
122
|
+
refresh_token: z$1.string().optional()
|
|
123
|
+
}).strip();
|
|
124
|
+
z$1.object({
|
|
125
|
+
error: z$1.string(),
|
|
126
|
+
error_description: z$1.string().optional(),
|
|
127
|
+
error_uri: z$1.string().optional()
|
|
128
|
+
});
|
|
129
|
+
/**
|
|
130
|
+
* Optional version of SafeUrlSchema that allows empty string for retrocompatibility on tos_uri and logo_uri
|
|
131
|
+
*/
|
|
132
|
+
const OptionalSafeUrlSchema = SafeUrlSchema.optional().or(z$1.literal("").transform(() => void 0));
|
|
133
|
+
/**
|
|
134
|
+
* RFC 7591 OAuth 2.0 Dynamic Client Registration metadata
|
|
135
|
+
*/
|
|
136
|
+
const OAuthClientMetadataSchema = z$1.object({
|
|
137
|
+
redirect_uris: z$1.array(SafeUrlSchema),
|
|
138
|
+
token_endpoint_auth_method: z$1.string().optional(),
|
|
139
|
+
grant_types: z$1.array(z$1.string()).optional(),
|
|
140
|
+
response_types: z$1.array(z$1.string()).optional(),
|
|
141
|
+
client_name: z$1.string().optional(),
|
|
142
|
+
client_uri: SafeUrlSchema.optional(),
|
|
143
|
+
logo_uri: OptionalSafeUrlSchema,
|
|
144
|
+
scope: z$1.string().optional(),
|
|
145
|
+
contacts: z$1.array(z$1.string()).optional(),
|
|
146
|
+
tos_uri: OptionalSafeUrlSchema,
|
|
147
|
+
policy_uri: z$1.string().optional(),
|
|
148
|
+
jwks_uri: SafeUrlSchema.optional(),
|
|
149
|
+
jwks: z$1.any().optional(),
|
|
150
|
+
software_id: z$1.string().optional(),
|
|
151
|
+
software_version: z$1.string().optional(),
|
|
152
|
+
software_statement: z$1.string().optional()
|
|
153
|
+
}).strip();
|
|
154
|
+
/**
|
|
155
|
+
* RFC 7591 OAuth 2.0 Dynamic Client Registration client information
|
|
156
|
+
*/
|
|
157
|
+
const OAuthClientInformationSchema = z$1.object({
|
|
158
|
+
client_id: z$1.string(),
|
|
159
|
+
client_secret: z$1.string().optional(),
|
|
160
|
+
client_id_issued_at: z$1.number().optional(),
|
|
161
|
+
client_secret_expires_at: z$1.number().optional()
|
|
162
|
+
}).strip();
|
|
163
|
+
OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
|
|
164
|
+
z$1.object({
|
|
165
|
+
error: z$1.string(),
|
|
166
|
+
error_description: z$1.string().optional()
|
|
167
|
+
}).strip();
|
|
168
|
+
z$1.object({
|
|
169
|
+
token: z$1.string(),
|
|
170
|
+
token_type_hint: z$1.string().optional()
|
|
171
|
+
}).strip();
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
5
176
|
const PLATFORM_LABELS = {
|
|
6
177
|
chatgpt: "ChatGPT",
|
|
7
178
|
claudeai: "Claude.ai"
|
|
8
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cloudflare",
|
|
183
|
+
"fastly"
|
|
184
|
+
];
|
|
185
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
186
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
9
187
|
const auditStatusSchema = z.enum([
|
|
10
188
|
"pending",
|
|
11
189
|
"partial",
|
|
@@ -71,6 +249,23 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
|
|
|
71
249
|
chatgpt: widgetScreenshotSchema.optional(),
|
|
72
250
|
claudeai: widgetScreenshotSchema.optional()
|
|
73
251
|
}) });
|
|
252
|
+
z.object({
|
|
253
|
+
id: z.string(),
|
|
254
|
+
environmentId: z.string(),
|
|
255
|
+
clientId: z.string(),
|
|
256
|
+
clientSecret: z.string(),
|
|
257
|
+
clientScopes: z.array(z.string())
|
|
258
|
+
});
|
|
259
|
+
z.enum([
|
|
260
|
+
"opening_balance",
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"refund",
|
|
266
|
+
"admin_adjustment"
|
|
267
|
+
]);
|
|
268
|
+
z.enum(["playground"]);
|
|
74
269
|
const deploymentStatusSchema$1 = z.enum([
|
|
75
270
|
"ongoing",
|
|
76
271
|
"deployed",
|
|
@@ -98,9 +293,91 @@ const deploymentSummarySchema = z.object({
|
|
|
98
293
|
createdAt: z.coerce.date(),
|
|
99
294
|
updatedAt: z.coerce.date()
|
|
100
295
|
});
|
|
101
|
-
|
|
296
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
297
|
+
const publicEnvironmentSchema = z.object({
|
|
298
|
+
allowsAnonymous: z.literal(true),
|
|
299
|
+
oAuthMetadata: z.strictObject({})
|
|
300
|
+
});
|
|
301
|
+
/** 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. */
|
|
302
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
303
|
+
allowsAnonymous: z.boolean(),
|
|
304
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
305
|
+
scope: z.string().optional()
|
|
306
|
+
});
|
|
307
|
+
/** 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. */
|
|
308
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
309
|
+
allowsAnonymous: z.boolean(),
|
|
310
|
+
oAuthMetadata: z.object({
|
|
311
|
+
externalAuthorizationServerUrl: z.url(),
|
|
312
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
313
|
+
}),
|
|
314
|
+
scope: z.string().optional()
|
|
315
|
+
});
|
|
316
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
317
|
+
const standaloneEnvironmentSchema = z.object({
|
|
318
|
+
allowsAnonymous: z.boolean(),
|
|
319
|
+
oAuthMetadata: z.object({
|
|
320
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
321
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
322
|
+
}),
|
|
323
|
+
scope: z.string().optional()
|
|
324
|
+
});
|
|
325
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
326
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
327
|
+
allowsAnonymous: z.literal(false),
|
|
328
|
+
oAuthMetadata: z.strictObject({}),
|
|
329
|
+
scope: z.string().optional()
|
|
330
|
+
});
|
|
331
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
332
|
+
isPublic: z.literal(true),
|
|
333
|
+
oAuthMetadata: z.undefined().optional()
|
|
334
|
+
});
|
|
335
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
336
|
+
isPublic: z.literal(false),
|
|
337
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
338
|
+
scope: z.string().optional()
|
|
339
|
+
});
|
|
340
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
341
|
+
isPublic: z.literal(false),
|
|
342
|
+
oAuthMetadata: z.object({
|
|
343
|
+
externalAuthorizationServerUrl: z.url(),
|
|
344
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
345
|
+
}),
|
|
346
|
+
scope: z.string().optional()
|
|
347
|
+
});
|
|
348
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
349
|
+
isPublic: z.literal(false),
|
|
350
|
+
oAuthMetadata: z.object({
|
|
351
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
352
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
353
|
+
}),
|
|
354
|
+
scope: z.string().optional()
|
|
355
|
+
});
|
|
356
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
357
|
+
isPublic: z.literal(false),
|
|
358
|
+
oAuthMetadata: z.strictObject({}),
|
|
359
|
+
scope: z.string().optional()
|
|
360
|
+
});
|
|
361
|
+
z.union([
|
|
362
|
+
publicEnvironmentSchema,
|
|
363
|
+
externalResourceMetadataEnvironmentSchema,
|
|
364
|
+
externalAuthorizationServerEnvironmentSchema,
|
|
365
|
+
standaloneEnvironmentSchema,
|
|
366
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
367
|
+
legacyPublicEnvironmentSchema,
|
|
368
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
369
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
370
|
+
legacyStandaloneEnvironmentSchema,
|
|
371
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
372
|
+
]);
|
|
373
|
+
const playgroundModelSchema = z.enum([
|
|
374
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
375
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
376
|
+
"openai.gpt-5.4",
|
|
377
|
+
"openai.gpt-5.5"
|
|
378
|
+
]);
|
|
102
379
|
const environmentDomainSchema = z.object({
|
|
103
|
-
|
|
380
|
+
name: z.string(),
|
|
104
381
|
status: z.enum([
|
|
105
382
|
"ongoing",
|
|
106
383
|
"deployed",
|
|
@@ -118,6 +395,7 @@ const environmentSchema$1 = z.object({
|
|
|
118
395
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
119
396
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
120
397
|
isPlaygroundEnabled: z.boolean(),
|
|
398
|
+
playgroundModel: playgroundModelSchema,
|
|
121
399
|
isIpWhitelistEnabled: z.boolean(),
|
|
122
400
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
123
401
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -127,11 +405,20 @@ const environmentSchema$1 = z.object({
|
|
|
127
405
|
});
|
|
128
406
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
129
407
|
z.object({
|
|
408
|
+
sessionReplayEnabled: z.boolean(),
|
|
409
|
+
collectRequestPayload: z.boolean(),
|
|
410
|
+
collectResponsePayload: z.boolean(),
|
|
411
|
+
collectErrorMessage: z.boolean(),
|
|
412
|
+
collectUserData: z.boolean(),
|
|
413
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
414
|
+
});
|
|
415
|
+
const feedbackSchema = z.object({
|
|
130
416
|
id: z.string(),
|
|
131
417
|
createdAt: z.coerce.date(),
|
|
132
418
|
environmentId: z.string(),
|
|
133
419
|
content: z.string(),
|
|
134
|
-
source: z.enum(["model", "user"])
|
|
420
|
+
source: z.enum(["model", "user"]),
|
|
421
|
+
clientName: z.string().nullable()
|
|
135
422
|
});
|
|
136
423
|
z.object({
|
|
137
424
|
content: z.string(),
|
|
@@ -147,7 +434,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
147
434
|
"pink",
|
|
148
435
|
"gray"
|
|
149
436
|
]);
|
|
150
|
-
intentCategoryColorSchema.options;
|
|
437
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
151
438
|
const intentCategorySchema = z.object({
|
|
152
439
|
id: z.string(),
|
|
153
440
|
createdAt: z.coerce.date(),
|
|
@@ -155,7 +442,7 @@ const intentCategorySchema = z.object({
|
|
|
155
442
|
name: z.string(),
|
|
156
443
|
color: intentCategoryColorSchema
|
|
157
444
|
});
|
|
158
|
-
z.object({
|
|
445
|
+
const intentCategorySummarySchema = z.object({
|
|
159
446
|
id: z.string(),
|
|
160
447
|
name: z.string(),
|
|
161
448
|
color: intentCategoryColorSchema,
|
|
@@ -167,6 +454,7 @@ z.object({
|
|
|
167
454
|
environmentId: z.string(),
|
|
168
455
|
toolName: z.string(),
|
|
169
456
|
message: z.string(),
|
|
457
|
+
clientName: z.string().nullable(),
|
|
170
458
|
categories: z.array(intentCategorySchema)
|
|
171
459
|
});
|
|
172
460
|
const signalCategorySchema = z.object({
|
|
@@ -225,12 +513,262 @@ z.object({
|
|
|
225
513
|
createdAt: z.coerce.date(),
|
|
226
514
|
updatedAt: z.coerce.date()
|
|
227
515
|
});
|
|
516
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
517
|
+
type: z.literal("mcp_request"),
|
|
518
|
+
method: z.string()
|
|
519
|
+
});
|
|
520
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
521
|
+
type: z.literal("mcp_error"),
|
|
522
|
+
method: z.string(),
|
|
523
|
+
error: z.string()
|
|
524
|
+
});
|
|
525
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
228
526
|
z.enum([
|
|
229
527
|
"INFO",
|
|
230
528
|
"WARNING",
|
|
231
529
|
"DEBUG",
|
|
232
530
|
"ERROR"
|
|
233
531
|
]);
|
|
532
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
533
|
+
const MCP_CLIENT_GROUPS = [
|
|
534
|
+
{
|
|
535
|
+
id: "claude_code",
|
|
536
|
+
label: "Claude Code",
|
|
537
|
+
vendor: "anthropic",
|
|
538
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
539
|
+
},
|
|
540
|
+
{
|
|
541
|
+
id: "claude",
|
|
542
|
+
label: "Claude",
|
|
543
|
+
vendor: "anthropic",
|
|
544
|
+
rawNames: [
|
|
545
|
+
"Anthropic/ClaudeAI",
|
|
546
|
+
"claude-ai",
|
|
547
|
+
"claude",
|
|
548
|
+
"Claude",
|
|
549
|
+
"claude-desktop",
|
|
550
|
+
"claude-desktop-3p"
|
|
551
|
+
]
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
id: "claude_mobile",
|
|
555
|
+
label: "Claude mobile",
|
|
556
|
+
vendor: "anthropic",
|
|
557
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
id: "claude_cowork",
|
|
561
|
+
label: "Claude Cowork",
|
|
562
|
+
vendor: "anthropic",
|
|
563
|
+
rawNames: ["Anthropic/Cowork"]
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
id: "claude_toolbox",
|
|
567
|
+
label: "Claude Toolbox",
|
|
568
|
+
vendor: "anthropic",
|
|
569
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
id: "anthropic_api",
|
|
573
|
+
label: "Anthropic API",
|
|
574
|
+
vendor: "anthropic",
|
|
575
|
+
rawNames: ["Anthropic/API"]
|
|
576
|
+
},
|
|
577
|
+
{
|
|
578
|
+
id: "anthropic_connector_refresh",
|
|
579
|
+
label: "Anthropic (connector refresh)",
|
|
580
|
+
vendor: "anthropic",
|
|
581
|
+
rawNames: ["Anthropic"]
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
id: "codex",
|
|
585
|
+
label: "Codex",
|
|
586
|
+
vendor: "openai",
|
|
587
|
+
rawNames: [
|
|
588
|
+
"codex-mcp-client",
|
|
589
|
+
"codex",
|
|
590
|
+
"Codex",
|
|
591
|
+
"codex-cli",
|
|
592
|
+
"openai-mcp (Codex)"
|
|
593
|
+
]
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
id: "chatgpt",
|
|
597
|
+
label: "ChatGPT",
|
|
598
|
+
vendor: "openai",
|
|
599
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
600
|
+
},
|
|
601
|
+
{
|
|
602
|
+
id: "openai_responses_api",
|
|
603
|
+
label: "OpenAI Responses API",
|
|
604
|
+
vendor: "openai",
|
|
605
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
id: "openai_agent_builder",
|
|
609
|
+
label: "OpenAI Agent Builder",
|
|
610
|
+
vendor: "openai",
|
|
611
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
612
|
+
},
|
|
613
|
+
{
|
|
614
|
+
id: "openai_other",
|
|
615
|
+
label: "OpenAI Other",
|
|
616
|
+
vendor: "openai",
|
|
617
|
+
rawNames: ["openai-mcp"]
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
id: "cursor",
|
|
621
|
+
label: "Cursor",
|
|
622
|
+
vendor: "cursor",
|
|
623
|
+
rawNames: [
|
|
624
|
+
"cursor-vscode",
|
|
625
|
+
"Cursor",
|
|
626
|
+
"cursor"
|
|
627
|
+
]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cline",
|
|
631
|
+
label: "Cline",
|
|
632
|
+
vendor: "cline",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"Cline",
|
|
635
|
+
"cline",
|
|
636
|
+
"@cline/core"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "github_copilot",
|
|
641
|
+
label: "GitHub Copilot",
|
|
642
|
+
vendor: "githubCopilot",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Copilot",
|
|
645
|
+
"github-copilot-developer",
|
|
646
|
+
"Copilot MCP Gateway",
|
|
647
|
+
"Xcode/copilot-xcode"
|
|
648
|
+
]
|
|
649
|
+
},
|
|
650
|
+
{
|
|
651
|
+
id: "gemini_cli",
|
|
652
|
+
label: "Gemini CLI",
|
|
653
|
+
vendor: "google",
|
|
654
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
655
|
+
},
|
|
656
|
+
{
|
|
657
|
+
id: "antigravity",
|
|
658
|
+
label: "Antigravity",
|
|
659
|
+
vendor: "google",
|
|
660
|
+
rawNames: ["antigravity-client"]
|
|
661
|
+
},
|
|
662
|
+
{
|
|
663
|
+
id: "gemini",
|
|
664
|
+
label: "Gemini",
|
|
665
|
+
vendor: "google",
|
|
666
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
id: "windsurf",
|
|
670
|
+
label: "Windsurf",
|
|
671
|
+
vendor: "windsurf",
|
|
672
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
673
|
+
},
|
|
674
|
+
{
|
|
675
|
+
id: "mistral",
|
|
676
|
+
label: "Mistral / Le Chat",
|
|
677
|
+
vendor: "mistral",
|
|
678
|
+
rawNames: ["Mistral"],
|
|
679
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
680
|
+
},
|
|
681
|
+
{
|
|
682
|
+
id: "n8n",
|
|
683
|
+
label: "n8n",
|
|
684
|
+
vendor: "n8n",
|
|
685
|
+
rawNames: [
|
|
686
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
687
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
688
|
+
"n8n"
|
|
689
|
+
]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "alpic_playground",
|
|
693
|
+
label: "Alpic Playground",
|
|
694
|
+
vendor: "alpic",
|
|
695
|
+
rawNames: ["alpic-playground", "playground"]
|
|
696
|
+
},
|
|
697
|
+
{
|
|
698
|
+
id: "opencode",
|
|
699
|
+
label: "opencode",
|
|
700
|
+
vendor: "opencode",
|
|
701
|
+
rawNames: ["opencode"]
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
id: "zed",
|
|
705
|
+
label: "Zed",
|
|
706
|
+
vendor: "zed",
|
|
707
|
+
rawNames: ["Zed", "zed"]
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
id: "zapier",
|
|
711
|
+
label: "Zapier",
|
|
712
|
+
vendor: "zapier",
|
|
713
|
+
rawNames: ["Zapier", "zapier"]
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
id: "make",
|
|
717
|
+
label: "Make",
|
|
718
|
+
vendor: "make",
|
|
719
|
+
rawNames: ["Make", "make"]
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
id: "librechat",
|
|
723
|
+
label: "LibreChat",
|
|
724
|
+
vendor: "mcp",
|
|
725
|
+
rawNames: ["LibreChat", "librechat"]
|
|
726
|
+
},
|
|
727
|
+
{
|
|
728
|
+
id: "jan",
|
|
729
|
+
label: "Jan",
|
|
730
|
+
vendor: "mcp",
|
|
731
|
+
rawNames: ["Jan", "jan"]
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
id: "goose",
|
|
735
|
+
label: "goose",
|
|
736
|
+
vendor: "mcp",
|
|
737
|
+
rawNames: ["goose", "Goose"]
|
|
738
|
+
},
|
|
739
|
+
{
|
|
740
|
+
id: "mcphost",
|
|
741
|
+
label: "mcphost",
|
|
742
|
+
vendor: "mcp",
|
|
743
|
+
rawNames: ["mcphost"]
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
id: "mcporter",
|
|
747
|
+
label: "mcporter",
|
|
748
|
+
vendor: "mcp",
|
|
749
|
+
rawNames: ["mcporter"]
|
|
750
|
+
},
|
|
751
|
+
{
|
|
752
|
+
id: "rmcp",
|
|
753
|
+
label: "rmcp",
|
|
754
|
+
vendor: "mcp",
|
|
755
|
+
rawNames: ["rmcp"]
|
|
756
|
+
},
|
|
757
|
+
{
|
|
758
|
+
id: "unnamed_client",
|
|
759
|
+
label: "Unnamed client",
|
|
760
|
+
vendor: "mcp",
|
|
761
|
+
rawNames: [
|
|
762
|
+
"mcp",
|
|
763
|
+
"unknown",
|
|
764
|
+
""
|
|
765
|
+
]
|
|
766
|
+
}
|
|
767
|
+
];
|
|
768
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
769
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
770
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
771
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
234
772
|
const runtimeSchema = z.enum([
|
|
235
773
|
"python3.13",
|
|
236
774
|
"python3.14",
|
|
@@ -259,15 +797,27 @@ z.object({
|
|
|
259
797
|
environments: z.array(environmentWithDomainsSchema),
|
|
260
798
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
261
799
|
});
|
|
800
|
+
const domainFailureReasonSchema = z.enum([
|
|
801
|
+
"caa",
|
|
802
|
+
"dns",
|
|
803
|
+
"invalid_domain",
|
|
804
|
+
"other"
|
|
805
|
+
]);
|
|
806
|
+
const projectDomainMappingSchema = z.object({
|
|
807
|
+
pathPrefix: z.string(),
|
|
808
|
+
environment: environmentSchema$1
|
|
809
|
+
});
|
|
262
810
|
z.object({
|
|
263
|
-
|
|
811
|
+
name: z.string(),
|
|
264
812
|
createdAt: z.coerce.date(),
|
|
265
813
|
status: z.enum([
|
|
266
814
|
"ongoing",
|
|
267
815
|
"deployed",
|
|
268
816
|
"failed"
|
|
269
817
|
]),
|
|
270
|
-
|
|
818
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
819
|
+
environment: environmentSchema$1,
|
|
820
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
271
821
|
});
|
|
272
822
|
const serverFieldsSchema$1 = z.object({
|
|
273
823
|
$schema: z.string(),
|
|
@@ -296,15 +846,7 @@ z.object({
|
|
|
296
846
|
serverFields: serverFieldsSchema$1,
|
|
297
847
|
source: z.enum(["registry", "defaults"])
|
|
298
848
|
});
|
|
299
|
-
/**
|
|
300
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
301
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
302
|
-
*
|
|
303
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
304
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
305
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
306
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
307
|
-
*/
|
|
849
|
+
/** 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. */
|
|
308
850
|
const clampStringField = (field) => {
|
|
309
851
|
const max = field.maxLength;
|
|
310
852
|
if (max === null) return field;
|
|
@@ -324,17 +866,20 @@ const toolDefinitionSchema = z.object({
|
|
|
324
866
|
}).optional()
|
|
325
867
|
});
|
|
326
868
|
const positiveTestCaseSchema = z.object({
|
|
327
|
-
scenario: z.string(),
|
|
328
|
-
userPrompt: z.string(),
|
|
329
|
-
toolTriggered: z.string().optional(),
|
|
330
|
-
expectedOutput: z.string().optional()
|
|
869
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
870
|
+
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
871
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
872
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
331
873
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
332
874
|
const screenshotEntrySchema = z.object({
|
|
333
875
|
prompt: z.string(),
|
|
334
|
-
url: z.url()
|
|
876
|
+
url: z.url()
|
|
335
877
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
878
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
336
879
|
/** Accepts either a valid email or URL. */
|
|
337
880
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
881
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
882
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
338
883
|
const chatgptCategorySchema = z.enum([
|
|
339
884
|
"BUSINESS",
|
|
340
885
|
"COLLABORATION",
|
|
@@ -351,51 +896,348 @@ const chatgptCategorySchema = z.enum([
|
|
|
351
896
|
"TRAVEL"
|
|
352
897
|
]);
|
|
353
898
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
354
|
-
const
|
|
899
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
900
|
+
"AD",
|
|
901
|
+
"AE",
|
|
902
|
+
"AF",
|
|
903
|
+
"AG",
|
|
904
|
+
"AL",
|
|
905
|
+
"AM",
|
|
906
|
+
"AO",
|
|
907
|
+
"AR",
|
|
908
|
+
"AT",
|
|
909
|
+
"AU",
|
|
910
|
+
"AW",
|
|
911
|
+
"AX",
|
|
912
|
+
"AZ",
|
|
913
|
+
"BA",
|
|
914
|
+
"BB",
|
|
915
|
+
"BD",
|
|
916
|
+
"BE",
|
|
917
|
+
"BF",
|
|
918
|
+
"BG",
|
|
919
|
+
"BH",
|
|
920
|
+
"BI",
|
|
921
|
+
"BJ",
|
|
922
|
+
"BL",
|
|
923
|
+
"BM",
|
|
924
|
+
"BN",
|
|
925
|
+
"BO",
|
|
926
|
+
"BR",
|
|
927
|
+
"BS",
|
|
928
|
+
"BT",
|
|
929
|
+
"BW",
|
|
930
|
+
"BZ",
|
|
931
|
+
"CA",
|
|
932
|
+
"CD",
|
|
933
|
+
"CF",
|
|
934
|
+
"CG",
|
|
935
|
+
"CH",
|
|
936
|
+
"CI",
|
|
937
|
+
"CL",
|
|
938
|
+
"CM",
|
|
939
|
+
"CO",
|
|
940
|
+
"CR",
|
|
941
|
+
"CV",
|
|
942
|
+
"CY",
|
|
943
|
+
"CZ",
|
|
944
|
+
"DE",
|
|
945
|
+
"DJ",
|
|
946
|
+
"DK",
|
|
947
|
+
"DM",
|
|
948
|
+
"DO",
|
|
949
|
+
"DZ",
|
|
950
|
+
"EC",
|
|
951
|
+
"EE",
|
|
952
|
+
"EG",
|
|
953
|
+
"ER",
|
|
954
|
+
"ES",
|
|
955
|
+
"ET",
|
|
956
|
+
"FI",
|
|
957
|
+
"FJ",
|
|
958
|
+
"FM",
|
|
959
|
+
"FO",
|
|
960
|
+
"FR",
|
|
961
|
+
"GA",
|
|
962
|
+
"GB",
|
|
963
|
+
"GD",
|
|
964
|
+
"GE",
|
|
965
|
+
"GF",
|
|
966
|
+
"GH",
|
|
967
|
+
"GL",
|
|
968
|
+
"GM",
|
|
969
|
+
"GN",
|
|
970
|
+
"GP",
|
|
971
|
+
"GQ",
|
|
972
|
+
"GR",
|
|
973
|
+
"GT",
|
|
974
|
+
"GW",
|
|
975
|
+
"GY",
|
|
976
|
+
"HN",
|
|
977
|
+
"HR",
|
|
978
|
+
"HT",
|
|
979
|
+
"HU",
|
|
980
|
+
"ID",
|
|
981
|
+
"IE",
|
|
982
|
+
"IL",
|
|
983
|
+
"IN",
|
|
984
|
+
"IQ",
|
|
985
|
+
"IS",
|
|
986
|
+
"IT",
|
|
987
|
+
"JM",
|
|
988
|
+
"JO",
|
|
989
|
+
"JP",
|
|
990
|
+
"KE",
|
|
991
|
+
"KG",
|
|
992
|
+
"KH",
|
|
993
|
+
"KI",
|
|
994
|
+
"KM",
|
|
995
|
+
"KN",
|
|
996
|
+
"KR",
|
|
997
|
+
"KW",
|
|
998
|
+
"KY",
|
|
999
|
+
"KZ",
|
|
1000
|
+
"LA",
|
|
1001
|
+
"LB",
|
|
1002
|
+
"LC",
|
|
1003
|
+
"LI",
|
|
1004
|
+
"LK",
|
|
1005
|
+
"LR",
|
|
1006
|
+
"LS",
|
|
1007
|
+
"LT",
|
|
1008
|
+
"LU",
|
|
1009
|
+
"LV",
|
|
1010
|
+
"LY",
|
|
1011
|
+
"MA",
|
|
1012
|
+
"MC",
|
|
1013
|
+
"MD",
|
|
1014
|
+
"ME",
|
|
1015
|
+
"MF",
|
|
1016
|
+
"MG",
|
|
1017
|
+
"MH",
|
|
1018
|
+
"MK",
|
|
1019
|
+
"ML",
|
|
1020
|
+
"MM",
|
|
1021
|
+
"MN",
|
|
1022
|
+
"MQ",
|
|
1023
|
+
"MR",
|
|
1024
|
+
"MT",
|
|
1025
|
+
"MU",
|
|
1026
|
+
"MV",
|
|
1027
|
+
"MW",
|
|
1028
|
+
"MX",
|
|
1029
|
+
"MY",
|
|
1030
|
+
"MZ",
|
|
1031
|
+
"NA",
|
|
1032
|
+
"NC",
|
|
1033
|
+
"NE",
|
|
1034
|
+
"NG",
|
|
1035
|
+
"NI",
|
|
1036
|
+
"NL",
|
|
1037
|
+
"NO",
|
|
1038
|
+
"NP",
|
|
1039
|
+
"NR",
|
|
1040
|
+
"NZ",
|
|
1041
|
+
"OM",
|
|
1042
|
+
"PA",
|
|
1043
|
+
"PE",
|
|
1044
|
+
"PF",
|
|
1045
|
+
"PG",
|
|
1046
|
+
"PH",
|
|
1047
|
+
"PK",
|
|
1048
|
+
"PL",
|
|
1049
|
+
"PM",
|
|
1050
|
+
"PS",
|
|
1051
|
+
"PT",
|
|
1052
|
+
"PW",
|
|
1053
|
+
"PY",
|
|
1054
|
+
"QA",
|
|
1055
|
+
"RE",
|
|
1056
|
+
"RO",
|
|
1057
|
+
"RS",
|
|
1058
|
+
"RW",
|
|
1059
|
+
"SA",
|
|
1060
|
+
"SB",
|
|
1061
|
+
"SC",
|
|
1062
|
+
"SD",
|
|
1063
|
+
"SE",
|
|
1064
|
+
"SG",
|
|
1065
|
+
"SH",
|
|
1066
|
+
"SI",
|
|
1067
|
+
"SJ",
|
|
1068
|
+
"SK",
|
|
1069
|
+
"SL",
|
|
1070
|
+
"SM",
|
|
1071
|
+
"SN",
|
|
1072
|
+
"SO",
|
|
1073
|
+
"SR",
|
|
1074
|
+
"SS",
|
|
1075
|
+
"ST",
|
|
1076
|
+
"SV",
|
|
1077
|
+
"SZ",
|
|
1078
|
+
"TD",
|
|
1079
|
+
"TF",
|
|
1080
|
+
"TG",
|
|
1081
|
+
"TH",
|
|
1082
|
+
"TJ",
|
|
1083
|
+
"TL",
|
|
1084
|
+
"TM",
|
|
1085
|
+
"TN",
|
|
1086
|
+
"TO",
|
|
1087
|
+
"TR",
|
|
1088
|
+
"TT",
|
|
1089
|
+
"TV",
|
|
1090
|
+
"TW",
|
|
1091
|
+
"TZ",
|
|
1092
|
+
"UA",
|
|
1093
|
+
"UG",
|
|
1094
|
+
"US",
|
|
1095
|
+
"UY",
|
|
1096
|
+
"UZ",
|
|
1097
|
+
"VA",
|
|
1098
|
+
"VC",
|
|
1099
|
+
"VN",
|
|
1100
|
+
"VU",
|
|
1101
|
+
"WF",
|
|
1102
|
+
"WS",
|
|
1103
|
+
"YE",
|
|
1104
|
+
"YT",
|
|
1105
|
+
"ZA",
|
|
1106
|
+
"ZM",
|
|
1107
|
+
"ZW"
|
|
1108
|
+
]);
|
|
1109
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
1110
|
+
z.object({ mode: z.literal("all") }),
|
|
1111
|
+
z.object({
|
|
1112
|
+
mode: z.literal("allow"),
|
|
1113
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1114
|
+
}),
|
|
1115
|
+
z.object({
|
|
1116
|
+
mode: z.literal("block"),
|
|
1117
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1118
|
+
})
|
|
1119
|
+
]);
|
|
1120
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
1121
|
+
"am",
|
|
1122
|
+
"ar",
|
|
1123
|
+
"bg-BG",
|
|
1124
|
+
"bn-BD",
|
|
1125
|
+
"bs-BA",
|
|
1126
|
+
"ca-ES",
|
|
1127
|
+
"cs-CZ",
|
|
1128
|
+
"da-DK",
|
|
1129
|
+
"de-DE",
|
|
1130
|
+
"el-GR",
|
|
1131
|
+
"es-419",
|
|
1132
|
+
"es-ES",
|
|
1133
|
+
"et-EE",
|
|
1134
|
+
"fi-FI",
|
|
1135
|
+
"fr-CA",
|
|
1136
|
+
"fr-FR",
|
|
1137
|
+
"gu-IN",
|
|
1138
|
+
"hi-IN",
|
|
1139
|
+
"hr-HR",
|
|
1140
|
+
"hu-HU",
|
|
1141
|
+
"hy-AM",
|
|
1142
|
+
"id-ID",
|
|
1143
|
+
"is-IS",
|
|
1144
|
+
"it-IT",
|
|
1145
|
+
"ja-JP",
|
|
1146
|
+
"ka-GE",
|
|
1147
|
+
"kk",
|
|
1148
|
+
"kn-IN",
|
|
1149
|
+
"ko-KR",
|
|
1150
|
+
"lt",
|
|
1151
|
+
"lv-LV",
|
|
1152
|
+
"mk-MK",
|
|
1153
|
+
"ml",
|
|
1154
|
+
"mn",
|
|
1155
|
+
"mr-IN",
|
|
1156
|
+
"ms-MY",
|
|
1157
|
+
"my-MM",
|
|
1158
|
+
"nb-NO",
|
|
1159
|
+
"nl-NL",
|
|
1160
|
+
"pa",
|
|
1161
|
+
"pl-PL",
|
|
1162
|
+
"pt-BR",
|
|
1163
|
+
"pt-PT",
|
|
1164
|
+
"ro-RO",
|
|
1165
|
+
"ru-RU",
|
|
1166
|
+
"sk-SK",
|
|
1167
|
+
"sl-SI",
|
|
1168
|
+
"so-SO",
|
|
1169
|
+
"sq-AL",
|
|
1170
|
+
"sr-RS",
|
|
1171
|
+
"sv-SE",
|
|
1172
|
+
"sw-TZ",
|
|
1173
|
+
"ta-IN",
|
|
1174
|
+
"te-IN",
|
|
1175
|
+
"th-TH",
|
|
1176
|
+
"tl",
|
|
1177
|
+
"tr-TR",
|
|
1178
|
+
"uk-UA",
|
|
1179
|
+
"ur",
|
|
1180
|
+
"vi-VN",
|
|
1181
|
+
"zh-CN",
|
|
1182
|
+
"zh-HK",
|
|
1183
|
+
"zh-TW"
|
|
1184
|
+
]);
|
|
355
1185
|
const negativeTestCaseSchema = z.object({
|
|
356
1186
|
scenario: z.string(),
|
|
357
1187
|
userPrompt: z.string()
|
|
358
1188
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
359
1189
|
const chatgptToolJustificationSchema = z.object({
|
|
360
1190
|
toolName: z.string(),
|
|
361
|
-
readOnlyJustification: z.string(),
|
|
362
|
-
openWorldJustification: z.string(),
|
|
363
|
-
destructiveJustification: z.string()
|
|
364
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
1191
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
1192
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
1193
|
+
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.\"")
|
|
1194
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
1195
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
1196
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
1197
|
+
const chatgptDescriptionSchema = z.string();
|
|
365
1198
|
const chatgptTranslationSchema = z.object({
|
|
366
|
-
locale:
|
|
367
|
-
tagline:
|
|
368
|
-
description:
|
|
1199
|
+
locale: chatgptTranslationLocaleSchema,
|
|
1200
|
+
tagline: chatgptTaglineSchema,
|
|
1201
|
+
description: chatgptDescriptionSchema
|
|
369
1202
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
373
|
-
*/
|
|
1203
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
1204
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
374
1205
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
375
1206
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
376
1207
|
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."),
|
|
377
1208
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
378
|
-
tagline:
|
|
379
|
-
description:
|
|
1209
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1210
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
380
1211
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
381
1212
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
382
|
-
companyUrl:
|
|
1213
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
383
1214
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
384
|
-
privacyPolicyUrl:
|
|
385
|
-
termsOfServiceUrl:
|
|
386
|
-
demoRecordingUrl:
|
|
1215
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1216
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1217
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
387
1218
|
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
|
|
388
|
-
serverUrl:
|
|
1219
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
389
1220
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
390
1221
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
391
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
392
|
-
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output.
|
|
393
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases
|
|
394
|
-
screenshots: z.array(screenshotEntrySchema).describe("In-app screenshots paired with the user prompt that produced them. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max
|
|
1222
|
+
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."),
|
|
1223
|
+
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
1224
|
+
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
1225
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
395
1226
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
396
|
-
allowedCountries: chatgptAllowedCountriesSchema.describe("
|
|
1227
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
397
1228
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
398
1229
|
});
|
|
1230
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1231
|
+
tagline: z.string().optional(),
|
|
1232
|
+
companyUrl: z.string().optional(),
|
|
1233
|
+
supportChannel: z.string().optional(),
|
|
1234
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1235
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1236
|
+
demoRecordingUrl: z.string().optional(),
|
|
1237
|
+
serverUrl: z.string().optional(),
|
|
1238
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1239
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1240
|
+
});
|
|
399
1241
|
chatgptSubmissionFormDataSchema.pick({
|
|
400
1242
|
appName: true,
|
|
401
1243
|
developerName: true,
|
|
@@ -412,7 +1254,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
412
1254
|
toolJustifications: true
|
|
413
1255
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
414
1256
|
const claudeCategorySchema = z.enum([
|
|
415
|
-
"
|
|
1257
|
+
"Productivity",
|
|
416
1258
|
"Communication",
|
|
417
1259
|
"Data & Analytics",
|
|
418
1260
|
"Development tools",
|
|
@@ -420,221 +1262,167 @@ const claudeCategorySchema = z.enum([
|
|
|
420
1262
|
"Consumer Health",
|
|
421
1263
|
"Health & Life Sciences",
|
|
422
1264
|
"Media & Entertainment",
|
|
423
|
-
"Commerce & Shopping"
|
|
1265
|
+
"Commerce & Shopping",
|
|
1266
|
+
"Legal",
|
|
1267
|
+
"Sales and marketing",
|
|
1268
|
+
"Creative",
|
|
1269
|
+
"Nonprofit",
|
|
1270
|
+
"Education",
|
|
1271
|
+
"Other"
|
|
424
1272
|
]);
|
|
425
|
-
const
|
|
426
|
-
"No auth needed",
|
|
427
|
-
"OAuth 2.0",
|
|
428
|
-
"Custom URL"
|
|
429
|
-
]);
|
|
430
|
-
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
431
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1273
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
432
1274
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
433
|
-
"
|
|
434
|
-
"
|
|
435
|
-
"
|
|
1275
|
+
"read_only",
|
|
1276
|
+
"write_only",
|
|
1277
|
+
"read_write"
|
|
436
1278
|
]);
|
|
437
|
-
const
|
|
438
|
-
|
|
439
|
-
"
|
|
440
|
-
"
|
|
441
|
-
"
|
|
442
|
-
"
|
|
443
|
-
]);
|
|
444
|
-
const claudeThirdPartySchema = z.enum([
|
|
445
|
-
"Web access: Fetches information from the open web (e.g., web scraping, search engines, or browsing arbitrary URLs, not just connecting to a specific API)",
|
|
446
|
-
"Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
|
|
447
|
-
"Third-party data retrieval: Connects to external services that themselves retrieve data from other sources (e.g., workflow automation platforms or other services that aggregate or relay data from multiple third-party sources)",
|
|
448
|
-
"Third-party data modification: Can connect to external services that themselves create, update, or delete data in other sources (e.g., workflow automation platforms or other services that write to multiple third-party sources)",
|
|
449
|
-
"N/A"
|
|
1279
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1280
|
+
"oauth_dcr",
|
|
1281
|
+
"oauth_cimd",
|
|
1282
|
+
"oauth_anthropic_creds",
|
|
1283
|
+
"custom_connection",
|
|
1284
|
+
"none"
|
|
450
1285
|
]);
|
|
451
|
-
const
|
|
452
|
-
"
|
|
453
|
-
"
|
|
454
|
-
"
|
|
455
|
-
"GDPR compliant (if applicable)"
|
|
1286
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1287
|
+
"first_party",
|
|
1288
|
+
"proxied",
|
|
1289
|
+
"third_party"
|
|
456
1290
|
]);
|
|
457
|
-
const
|
|
458
|
-
|
|
459
|
-
"
|
|
460
|
-
"
|
|
1291
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1292
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1293
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1294
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1295
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1296
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1297
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1298
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1299
|
+
"Public documentation for this connector will be live by the publish date."
|
|
461
1300
|
]);
|
|
462
|
-
/**
|
|
463
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
464
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
465
|
-
*/
|
|
1301
|
+
/** 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. */
|
|
466
1302
|
const claudeSubmissionFormDataSchema = z.object({
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
(
|
|
477
|
-
|
|
478
|
-
(
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
•
|
|
496
|
-
•
|
|
497
|
-
•
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
• '
|
|
513
|
-
• '
|
|
514
|
-
• '
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
|
|
542
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
543
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
544
|
-
• 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
|
|
545
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
546
|
-
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:
|
|
547
|
-
• What the connector does and its key capabilities
|
|
548
|
-
• How to connect/set it up (step by step)
|
|
549
|
-
• What each tool does (or at least the main ones)
|
|
550
|
-
• How to troubleshoot common issues
|
|
551
|
-
• A support contact or channel
|
|
552
|
-
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.`),
|
|
553
|
-
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:
|
|
554
|
-
• What data you collect (and how)
|
|
555
|
-
• How you use the collected data
|
|
556
|
-
• Where and how long you store it
|
|
557
|
-
• Whether you share data with third parties (and who)
|
|
558
|
-
• How users can contact you about data concerns
|
|
559
|
-
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.`),
|
|
560
|
-
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:
|
|
561
|
-
• Email address (e.g. support@myapp.com)
|
|
562
|
-
• Link to a GitHub Issues page
|
|
563
|
-
• Link to a help center or support article
|
|
564
|
-
• Link to a Discord/Slack community
|
|
565
|
-
• Link to your documentation's troubleshooting section
|
|
566
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
567
|
-
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:
|
|
568
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
569
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
570
|
-
• 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.
|
|
571
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
572
|
-
• If your service requires API keys instead of a password, provide those.
|
|
573
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
574
|
-
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.
|
|
575
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
576
|
-
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.`),
|
|
577
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
578
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
579
|
-
• '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).
|
|
580
|
-
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.`),
|
|
581
|
-
testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
|
|
582
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
583
|
-
• Format: SVG only
|
|
584
|
-
• Aspect ratio: square (1:1)
|
|
585
|
-
• Should work on a light background
|
|
586
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
587
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
588
|
-
logoDark: z.string().optional().describe(`Optional dark-mode variant of the connector logo. Same specs as the light variant (SVG, square 1:1) but designed to read on a dark background. Leave empty if the light logo already works on dark.`),
|
|
589
|
-
screenshots: z.array(screenshotEntrySchema).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:
|
|
590
|
-
• 3–5 images is ideal
|
|
591
|
-
• Minimum 1000px width, PNG format preferred
|
|
592
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
593
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
594
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
595
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
596
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1303
|
+
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
|
|
1304
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1305
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1306
|
+
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
|
|
1307
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1308
|
+
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.
|
|
1309
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1310
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1311
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1312
|
+
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
|
|
1313
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1314
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1315
|
+
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
|
|
1316
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1317
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1318
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1319
|
+
by your publish date.`),
|
|
1320
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1321
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1322
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1323
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1324
|
+
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
|
|
1325
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1326
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1327
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1328
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1329
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1330
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1331
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1332
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1333
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1334
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1335
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1336
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1337
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1338
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1339
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1340
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1341
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1342
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1343
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1344
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1345
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1346
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1347
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1348
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1349
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1350
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1351
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1352
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1353
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1354
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1355
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1356
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1357
|
+
fully populated account.`),
|
|
1358
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1359
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1360
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1361
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1362
|
+
});
|
|
1363
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1364
|
+
serverUrl: z.string().optional(),
|
|
1365
|
+
name: z.string().optional(),
|
|
1366
|
+
slug: z.string().optional(),
|
|
1367
|
+
oneLiner: z.string().optional(),
|
|
1368
|
+
description: z.string().optional(),
|
|
1369
|
+
iconUrl: z.string().optional(),
|
|
1370
|
+
documentation: z.string().optional(),
|
|
1371
|
+
support: z.string().optional(),
|
|
1372
|
+
privacyPolicy: z.string().optional(),
|
|
1373
|
+
companyWebsite: z.string().optional(),
|
|
1374
|
+
primaryContactEmail: z.string().optional(),
|
|
1375
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1376
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
597
1377
|
});
|
|
598
1378
|
claudeSubmissionFormDataSchema.pick({
|
|
599
|
-
companyName: true,
|
|
600
|
-
appName: true,
|
|
601
|
-
mcpUrlType: true,
|
|
602
1379
|
serverUrl: true,
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
transportSupport: true,
|
|
1380
|
+
name: true,
|
|
1381
|
+
slug: true,
|
|
1382
|
+
companyName: true,
|
|
607
1383
|
primaryContactEmail: true,
|
|
608
1384
|
primaryContactName: true,
|
|
1385
|
+
readWriteCapabilities: true,
|
|
609
1386
|
authentication: true,
|
|
610
|
-
|
|
611
|
-
|
|
1387
|
+
apiOwnership: true,
|
|
1388
|
+
personalHealthData: true
|
|
612
1389
|
}).extend({
|
|
613
1390
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
614
|
-
|
|
1391
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1392
|
+
});
|
|
1393
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1394
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1395
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1396
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1397
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1398
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1399
|
+
});
|
|
1400
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1401
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1402
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
615
1403
|
});
|
|
616
|
-
claudeSubmissionFormDataSchema.pick({
|
|
617
|
-
tagline: true,
|
|
618
|
-
description: true,
|
|
619
|
-
category: true,
|
|
620
|
-
testCases: true
|
|
621
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
622
1404
|
const submissionMetaFieldsSchema = z.object({
|
|
623
1405
|
id: z.string(),
|
|
624
1406
|
environmentId: z.string(),
|
|
1407
|
+
auditId: z.string().nullable(),
|
|
625
1408
|
createdAt: z.coerce.date(),
|
|
626
1409
|
updatedAt: z.coerce.date()
|
|
627
1410
|
});
|
|
628
1411
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
629
1412
|
platform: z.literal("claudeai"),
|
|
630
|
-
formData:
|
|
1413
|
+
formData: claudeSubmissionDraftSchema
|
|
631
1414
|
});
|
|
632
1415
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
633
1416
|
platform: z.literal("chatgpt"),
|
|
634
|
-
formData:
|
|
1417
|
+
formData: chatgptSubmissionDraftSchema
|
|
635
1418
|
});
|
|
636
1419
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
637
|
-
z.union([
|
|
1420
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1421
|
+
z.literal([
|
|
1422
|
+
100,
|
|
1423
|
+
75,
|
|
1424
|
+
50
|
|
1425
|
+
]);
|
|
638
1426
|
const subscriptionPlanSchema = z.enum([
|
|
639
1427
|
"pro",
|
|
640
1428
|
"business",
|
|
@@ -652,11 +1440,62 @@ const customerUsageSchema = z.object({
|
|
|
652
1440
|
periodEnd: z.number()
|
|
653
1441
|
});
|
|
654
1442
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1443
|
+
z.object({ balanceInNanoUSD: z.number() });
|
|
655
1444
|
z.object({
|
|
656
1445
|
customerCredits: customerCreditsSchema.nullable(),
|
|
657
1446
|
customerUsage: customerUsageSchema.nullable(),
|
|
658
1447
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
659
1448
|
});
|
|
1449
|
+
const telemetrySignalSchema = z.enum([
|
|
1450
|
+
"logs",
|
|
1451
|
+
"metrics",
|
|
1452
|
+
"traces"
|
|
1453
|
+
]);
|
|
1454
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1455
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1456
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1457
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1458
|
+
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");
|
|
1459
|
+
const logSeveritySchema = z.enum([
|
|
1460
|
+
"TRACE",
|
|
1461
|
+
"DEBUG",
|
|
1462
|
+
"INFO",
|
|
1463
|
+
"WARN",
|
|
1464
|
+
"ERROR",
|
|
1465
|
+
"FATAL"
|
|
1466
|
+
]);
|
|
1467
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1468
|
+
id: z.string(),
|
|
1469
|
+
name: otlpHeaderNameSchema,
|
|
1470
|
+
value: otlpHeaderValueSchema,
|
|
1471
|
+
isSecret: z.boolean()
|
|
1472
|
+
});
|
|
1473
|
+
z.object({
|
|
1474
|
+
id: z.string(),
|
|
1475
|
+
signal: telemetrySignalSchema,
|
|
1476
|
+
endpoint: otlpEndpointSchema,
|
|
1477
|
+
protocol: otlpProtocolSchema,
|
|
1478
|
+
minimumSeverity: logSeveritySchema,
|
|
1479
|
+
headers: z.array(telemetryDestinationHeaderSchema)
|
|
1480
|
+
});
|
|
1481
|
+
z.enum([
|
|
1482
|
+
"credentials",
|
|
1483
|
+
"wrong-path",
|
|
1484
|
+
"wrong-protocol",
|
|
1485
|
+
"invalid-payload",
|
|
1486
|
+
"partial-rejection",
|
|
1487
|
+
"blocked-target",
|
|
1488
|
+
"timeout",
|
|
1489
|
+
"unreachable",
|
|
1490
|
+
"receiver-error",
|
|
1491
|
+
"unexpected-status"
|
|
1492
|
+
]);
|
|
1493
|
+
//#endregion
|
|
1494
|
+
//#region src/auth-scope.ts
|
|
1495
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1496
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1497
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1498
|
+
const AUTH_SCOPE_USER = "user";
|
|
660
1499
|
//#endregion
|
|
661
1500
|
//#region src/schemas.ts
|
|
662
1501
|
const RESERVED_KEYS = [
|
|
@@ -693,7 +1532,10 @@ const RESERVED_KEYS = [
|
|
|
693
1532
|
"BUILD_ARG_START_COMMAND",
|
|
694
1533
|
"ALPIC_HOST",
|
|
695
1534
|
"ALPIC_CUSTOM_DOMAINS",
|
|
696
|
-
"ALPIC_INTENT_META_KEY"
|
|
1535
|
+
"ALPIC_INTENT_META_KEY",
|
|
1536
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1537
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1538
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
697
1539
|
];
|
|
698
1540
|
const environmentVariableSchema = z.object({
|
|
699
1541
|
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"),
|
|
@@ -774,21 +1616,20 @@ const deploymentSchema = z.object({
|
|
|
774
1616
|
isCurrent: z.boolean(),
|
|
775
1617
|
deploymentPageUrl: z.url().nullable()
|
|
776
1618
|
});
|
|
777
|
-
const
|
|
1619
|
+
const isValidTimeInput = (value) => {
|
|
778
1620
|
if (ms(value) !== void 0) return true;
|
|
779
1621
|
return !Number.isNaN(new Date(value).getTime());
|
|
780
1622
|
};
|
|
781
|
-
const
|
|
1623
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1624
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1625
|
+
const createEnvironmentContractV1 = base.route({
|
|
782
1626
|
path: "/v1/environments",
|
|
783
1627
|
method: "POST",
|
|
784
1628
|
summary: "Create an environment",
|
|
785
1629
|
description: "Create an environment for a project",
|
|
786
1630
|
tags: ["environments"],
|
|
787
1631
|
successDescription: "The environment has been created successfully"
|
|
788
|
-
}).errors({
|
|
789
|
-
NOT_FOUND: {},
|
|
790
|
-
BAD_REQUEST: {}
|
|
791
|
-
}).input(z.object({
|
|
1632
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
792
1633
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
793
1634
|
name: z.string().min(1).describe("The name of the environment"),
|
|
794
1635
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -797,11 +1638,11 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
797
1638
|
id: z.string(),
|
|
798
1639
|
name: z.string(),
|
|
799
1640
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
800
|
-
urls: z.array(z.
|
|
1641
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
801
1642
|
createdAt: z.coerce.date(),
|
|
802
1643
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
803
1644
|
}));
|
|
804
|
-
const getEnvironmentContractV1 =
|
|
1645
|
+
const getEnvironmentContractV1 = base.route({
|
|
805
1646
|
path: "/v1/environments/{environmentId}",
|
|
806
1647
|
method: "GET",
|
|
807
1648
|
summary: "Get an environment",
|
|
@@ -858,7 +1699,7 @@ const projectOutputSchema = z.object({
|
|
|
858
1699
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
859
1700
|
environments: z.array(environmentSchema)
|
|
860
1701
|
});
|
|
861
|
-
const getProjectContractV1 =
|
|
1702
|
+
const getProjectContractV1 = base.route({
|
|
862
1703
|
path: "/v1/projects/{projectId}",
|
|
863
1704
|
method: "GET",
|
|
864
1705
|
summary: "Get a project",
|
|
@@ -866,15 +1707,15 @@ const getProjectContractV1 = oc.route({
|
|
|
866
1707
|
tags: ["projects"],
|
|
867
1708
|
successDescription: "The project details"
|
|
868
1709
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
869
|
-
const listProjectsContractV1 =
|
|
1710
|
+
const listProjectsContractV1 = base.route({
|
|
870
1711
|
path: "/v1/projects",
|
|
871
1712
|
method: "GET",
|
|
872
1713
|
summary: "List projects",
|
|
873
1714
|
description: "List all projects for a team",
|
|
874
1715
|
tags: ["projects"],
|
|
875
1716
|
successDescription: "The list of projects"
|
|
876
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
877
|
-
const createProjectContractV1 =
|
|
1717
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1718
|
+
const createProjectContractV1 = base.route({
|
|
878
1719
|
path: "/v1/projects",
|
|
879
1720
|
method: "POST",
|
|
880
1721
|
summary: "Create a project",
|
|
@@ -883,7 +1724,7 @@ const createProjectContractV1 = oc.route({
|
|
|
883
1724
|
successDescription: "The project has been created successfully"
|
|
884
1725
|
}).errors({
|
|
885
1726
|
NOT_FOUND: {},
|
|
886
|
-
|
|
1727
|
+
FORBIDDEN: {}
|
|
887
1728
|
}).input(z.object({
|
|
888
1729
|
teamId: z.string().optional(),
|
|
889
1730
|
name: z.string().trim().min(1).max(100),
|
|
@@ -923,7 +1764,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
923
1764
|
isSecret: z.boolean(),
|
|
924
1765
|
createdAt: z.coerce.date()
|
|
925
1766
|
});
|
|
926
|
-
const listEnvironmentVariablesContractV1 =
|
|
1767
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
927
1768
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
928
1769
|
method: "GET",
|
|
929
1770
|
summary: "List environment variables",
|
|
@@ -931,37 +1772,31 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
931
1772
|
tags: ["environments"],
|
|
932
1773
|
successDescription: "The list of environment variables"
|
|
933
1774
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
934
|
-
const createEnvironmentVariablesContractV1 =
|
|
1775
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
935
1776
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
936
1777
|
method: "POST",
|
|
937
1778
|
summary: "Add environment variables",
|
|
938
1779
|
description: "Add one or more environment variables to an environment",
|
|
939
1780
|
tags: ["environments"],
|
|
940
1781
|
successDescription: "The environment variables have been added successfully"
|
|
941
|
-
}).errors({
|
|
942
|
-
NOT_FOUND: {},
|
|
943
|
-
BAD_REQUEST: {}
|
|
944
|
-
}).input(z.object({
|
|
1782
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
945
1783
|
environmentId: z.string().describe("The ID of the environment"),
|
|
946
1784
|
environmentVariables: environmentVariablesSchema
|
|
947
1785
|
})).output(z.object({ success: z.literal(true) }));
|
|
948
|
-
const updateEnvironmentVariableContractV1 =
|
|
1786
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
949
1787
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
950
1788
|
method: "PATCH",
|
|
951
1789
|
summary: "Update an environment variable",
|
|
952
1790
|
description: "Update an environment variable by ID",
|
|
953
1791
|
tags: ["environments"],
|
|
954
1792
|
successDescription: "The environment variable has been updated successfully"
|
|
955
|
-
}).errors({
|
|
956
|
-
NOT_FOUND: {},
|
|
957
|
-
BAD_REQUEST: {}
|
|
958
|
-
}).input(z.object({
|
|
1793
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
959
1794
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
960
1795
|
key: environmentVariableSchema.shape.key,
|
|
961
1796
|
value: environmentVariableSchema.shape.value.optional(),
|
|
962
1797
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
963
1798
|
})).output(z.object({ success: z.literal(true) }));
|
|
964
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1799
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
965
1800
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
966
1801
|
method: "DELETE",
|
|
967
1802
|
summary: "Delete an environment variable",
|
|
@@ -969,7 +1804,7 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
969
1804
|
tags: ["environments"],
|
|
970
1805
|
successDescription: "The environment variable has been deleted successfully"
|
|
971
1806
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
972
|
-
const deleteProjectContractV1 =
|
|
1807
|
+
const deleteProjectContractV1 = base.route({
|
|
973
1808
|
path: "/v1/projects/{projectId}",
|
|
974
1809
|
method: "DELETE",
|
|
975
1810
|
summary: "Delete a project",
|
|
@@ -977,7 +1812,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
977
1812
|
tags: ["projects"],
|
|
978
1813
|
successDescription: "The project has been deleted successfully"
|
|
979
1814
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
980
|
-
const updateProjectContractV1 =
|
|
1815
|
+
const updateProjectContractV1 = base.route({
|
|
981
1816
|
path: "/v1/projects/{projectId}",
|
|
982
1817
|
method: "PATCH",
|
|
983
1818
|
summary: "Update a project",
|
|
@@ -986,13 +1821,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
986
1821
|
successDescription: "The project has been updated successfully"
|
|
987
1822
|
}).errors({
|
|
988
1823
|
NOT_FOUND: {},
|
|
989
|
-
|
|
1824
|
+
FORBIDDEN: {}
|
|
990
1825
|
}).input(z.object({
|
|
991
1826
|
projectId: z.string().describe("The ID of the project"),
|
|
992
1827
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
993
1828
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
994
1829
|
})).output(projectOutputSchema);
|
|
995
|
-
const deployEnvironmentContractV1 =
|
|
1830
|
+
const deployEnvironmentContractV1 = base.route({
|
|
996
1831
|
path: "/v1/environments/{environmentId}/deploy",
|
|
997
1832
|
method: "POST",
|
|
998
1833
|
summary: "Deploy an environment",
|
|
@@ -1001,24 +1836,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1001
1836
|
successDescription: "The environment has been deployed successfully"
|
|
1002
1837
|
}).errors({
|
|
1003
1838
|
NOT_FOUND: {},
|
|
1004
|
-
|
|
1839
|
+
CONFLICT: {}
|
|
1005
1840
|
}).input(z.object({
|
|
1006
1841
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1007
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1842
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1843
|
+
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.")
|
|
1008
1844
|
})).output(deploymentSchema);
|
|
1009
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1845
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1010
1846
|
path: "/v1/deployments/upload",
|
|
1011
1847
|
method: "POST",
|
|
1012
1848
|
summary: "Upload deployment artifacts",
|
|
1013
1849
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1014
1850
|
tags: ["deployments"],
|
|
1015
1851
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1016
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1852
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1017
1853
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1018
1854
|
token: z.string().describe("Token to identify the source archive"),
|
|
1019
1855
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1020
1856
|
}));
|
|
1021
|
-
const listDeploymentsContractV1 =
|
|
1857
|
+
const listDeploymentsContractV1 = base.route({
|
|
1022
1858
|
path: "/v1/projects/{projectId}/deployments",
|
|
1023
1859
|
method: "GET",
|
|
1024
1860
|
summary: "List project deployments",
|
|
@@ -1030,7 +1866,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1030
1866
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1031
1867
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1032
1868
|
})).output(z.array(deploymentSchema));
|
|
1033
|
-
const getDeploymentContractV1 =
|
|
1869
|
+
const getDeploymentContractV1 = base.route({
|
|
1034
1870
|
path: "/v1/deployments/{deploymentId}",
|
|
1035
1871
|
method: "GET",
|
|
1036
1872
|
summary: "Get a deployment",
|
|
@@ -1038,20 +1874,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1038
1874
|
tags: ["deployments"],
|
|
1039
1875
|
successDescription: "The deployment details"
|
|
1040
1876
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1041
|
-
const
|
|
1877
|
+
const logEntrySchema = z.object({
|
|
1878
|
+
timestamp: z.coerce.date(),
|
|
1879
|
+
type: z.enum([
|
|
1880
|
+
"START",
|
|
1881
|
+
"END",
|
|
1882
|
+
"INFO",
|
|
1883
|
+
"ERROR",
|
|
1884
|
+
"WARNING",
|
|
1885
|
+
"DEBUG"
|
|
1886
|
+
]),
|
|
1887
|
+
requestId: z.string(),
|
|
1888
|
+
content: z.string().optional(),
|
|
1889
|
+
method: z.string().optional(),
|
|
1890
|
+
durationInMs: z.number().optional()
|
|
1891
|
+
});
|
|
1892
|
+
const getLogsContractV1 = base.route({
|
|
1042
1893
|
path: "/v1/environments/{environmentId}/logs",
|
|
1043
1894
|
method: "GET",
|
|
1044
1895
|
summary: "Get logs",
|
|
1045
1896
|
description: "Get logs for an environment",
|
|
1046
1897
|
tags: ["environments"],
|
|
1047
1898
|
successDescription: "The logs"
|
|
1048
|
-
}).errors({
|
|
1049
|
-
NOT_FOUND: {},
|
|
1050
|
-
BAD_REQUEST: {}
|
|
1051
|
-
}).input(z.object({
|
|
1899
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1052
1900
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1053
|
-
since:
|
|
1054
|
-
until:
|
|
1901
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1902
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1055
1903
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1056
1904
|
level: z.array(z.enum([
|
|
1057
1905
|
"INFO",
|
|
@@ -1062,34 +1910,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1062
1910
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1063
1911
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1064
1912
|
})).output(z.object({
|
|
1065
|
-
logs: z.array(
|
|
1066
|
-
timestamp: z.coerce.date(),
|
|
1067
|
-
type: z.enum([
|
|
1068
|
-
"START",
|
|
1069
|
-
"END",
|
|
1070
|
-
"INFO",
|
|
1071
|
-
"ERROR",
|
|
1072
|
-
"WARNING",
|
|
1073
|
-
"DEBUG"
|
|
1074
|
-
]),
|
|
1075
|
-
requestId: z.string(),
|
|
1076
|
-
content: z.string().optional(),
|
|
1077
|
-
method: z.string().optional(),
|
|
1078
|
-
durationInMs: z.number().optional()
|
|
1079
|
-
})),
|
|
1913
|
+
logs: z.array(logEntrySchema),
|
|
1080
1914
|
nextToken: z.string().nullable()
|
|
1081
1915
|
}));
|
|
1082
|
-
const getLatestLogsContractV1 =
|
|
1916
|
+
const getLatestLogsContractV1 = base.route({
|
|
1083
1917
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1084
1918
|
method: "GET",
|
|
1085
1919
|
summary: "Get latest logs",
|
|
1086
1920
|
description: "Get the N most recent logs for an environment",
|
|
1087
1921
|
tags: ["environments"],
|
|
1088
1922
|
successDescription: "The latest logs"
|
|
1089
|
-
}).errors({
|
|
1090
|
-
NOT_FOUND: {},
|
|
1091
|
-
BAD_REQUEST: {}
|
|
1092
|
-
}).input(z.object({
|
|
1923
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1093
1924
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1094
1925
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1095
1926
|
level: z.array(z.enum([
|
|
@@ -1099,22 +1930,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1099
1930
|
"DEBUG"
|
|
1100
1931
|
])).optional().describe("Filter by log level"),
|
|
1101
1932
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1102
|
-
})).output(z.object({ logs: z.array(
|
|
1103
|
-
|
|
1104
|
-
type: z.enum([
|
|
1105
|
-
"START",
|
|
1106
|
-
"END",
|
|
1107
|
-
"INFO",
|
|
1108
|
-
"ERROR",
|
|
1109
|
-
"WARNING",
|
|
1110
|
-
"DEBUG"
|
|
1111
|
-
]),
|
|
1112
|
-
requestId: z.string(),
|
|
1113
|
-
content: z.string().optional(),
|
|
1114
|
-
method: z.string().optional(),
|
|
1115
|
-
durationInMs: z.number().optional()
|
|
1116
|
-
})) }));
|
|
1117
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1933
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1934
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1118
1935
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1119
1936
|
method: "GET",
|
|
1120
1937
|
summary: "Get deployment logs",
|
|
@@ -1141,22 +1958,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1141
1958
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1142
1959
|
task_count: z.array(analyticsDataPointSchema)
|
|
1143
1960
|
});
|
|
1144
|
-
const getProjectAnalyticsContractV1 =
|
|
1961
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1145
1962
|
path: "/v1/analytics/{projectId}",
|
|
1146
1963
|
method: "GET",
|
|
1147
1964
|
summary: "Get project analytics",
|
|
1148
1965
|
description: "Get analytics data for a project over a time range",
|
|
1149
1966
|
tags: ["analytics"],
|
|
1150
1967
|
successDescription: "The project analytics data"
|
|
1151
|
-
}).errors({
|
|
1152
|
-
NOT_FOUND: {},
|
|
1153
|
-
BAD_REQUEST: {}
|
|
1154
|
-
}).input(z.object({
|
|
1968
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1155
1969
|
projectId: z.string().describe("The ID of the project"),
|
|
1156
1970
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1157
1971
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1158
1972
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1159
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
1973
|
+
}).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 }) => Intl.supportedValuesOf("timeZone").includes(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1160
1974
|
metadata: z.object({
|
|
1161
1975
|
startTimestamp: z.number(),
|
|
1162
1976
|
endTimestamp: z.number(),
|
|
@@ -1166,7 +1980,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1166
1980
|
}),
|
|
1167
1981
|
timeSeries: analyticsTimeSeriesSchema
|
|
1168
1982
|
}));
|
|
1169
|
-
const
|
|
1983
|
+
const paginatedInsightsInputShape = {
|
|
1984
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1985
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1986
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1987
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1988
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1989
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1990
|
+
};
|
|
1991
|
+
const listIntentsContractV1 = base.route({
|
|
1992
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1993
|
+
method: "GET",
|
|
1994
|
+
summary: "List intents",
|
|
1995
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1996
|
+
tags: ["insights"],
|
|
1997
|
+
successDescription: "The grouped user intents"
|
|
1998
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1999
|
+
...paginatedInsightsInputShape,
|
|
2000
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2001
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2002
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2003
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2004
|
+
})).output(z.object({
|
|
2005
|
+
intents: z.array(z.object({
|
|
2006
|
+
id: z.string(),
|
|
2007
|
+
intentIds: z.array(z.string()).min(1),
|
|
2008
|
+
environmentId: z.string(),
|
|
2009
|
+
message: z.string(),
|
|
2010
|
+
toolName: z.string(),
|
|
2011
|
+
createdAt: z.coerce.date(),
|
|
2012
|
+
occurrenceCount: z.number().int().positive(),
|
|
2013
|
+
clientName: z.string().nullable(),
|
|
2014
|
+
clientId: z.string().nullable(),
|
|
2015
|
+
categories: z.array(z.object({
|
|
2016
|
+
id: z.string(),
|
|
2017
|
+
name: z.string(),
|
|
2018
|
+
color: intentCategoryColorSchema
|
|
2019
|
+
}))
|
|
2020
|
+
})),
|
|
2021
|
+
totalCount: z.number().int().nonnegative()
|
|
2022
|
+
}));
|
|
2023
|
+
const listFeedbacksContractV1 = base.route({
|
|
2024
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2025
|
+
method: "GET",
|
|
2026
|
+
summary: "List feedbacks",
|
|
2027
|
+
description: "List user feedback for an environment over a time range",
|
|
2028
|
+
tags: ["insights"],
|
|
2029
|
+
successDescription: "The user feedback"
|
|
2030
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2031
|
+
...paginatedInsightsInputShape,
|
|
2032
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2033
|
+
})).output(z.object({
|
|
2034
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2035
|
+
totalCount: z.number().int().nonnegative()
|
|
2036
|
+
}));
|
|
2037
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2038
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2039
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2040
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2041
|
+
method: "GET",
|
|
2042
|
+
summary: "List intent categories",
|
|
2043
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2044
|
+
tags: ["insights"],
|
|
2045
|
+
successDescription: "The intent categories"
|
|
2046
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2047
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2048
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2049
|
+
method: "POST",
|
|
2050
|
+
summary: "Create an intent category",
|
|
2051
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2052
|
+
tags: ["insights"],
|
|
2053
|
+
successDescription: "The created intent category"
|
|
2054
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2055
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2056
|
+
name: intentCategoryNameSchema,
|
|
2057
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2058
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2059
|
+
})).output(intentCategorySchema);
|
|
2060
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2061
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2062
|
+
method: "PATCH",
|
|
2063
|
+
summary: "Update an intent category",
|
|
2064
|
+
description: "Rename or recolor an intent category",
|
|
2065
|
+
tags: ["insights"],
|
|
2066
|
+
successDescription: "The updated intent category"
|
|
2067
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2068
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2069
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2070
|
+
name: intentCategoryNameSchema.optional(),
|
|
2071
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2072
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2073
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2074
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2075
|
+
method: "DELETE",
|
|
2076
|
+
summary: "Delete an intent category",
|
|
2077
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2078
|
+
tags: ["insights"],
|
|
2079
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2080
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2081
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2082
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2083
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2084
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2085
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2086
|
+
method: "POST",
|
|
2087
|
+
summary: "Link an intent category",
|
|
2088
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2089
|
+
tags: ["insights"],
|
|
2090
|
+
successDescription: "The intents have been linked successfully"
|
|
2091
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2092
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2093
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2094
|
+
intentIds: categorizableIntentIdsSchema
|
|
2095
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2096
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2097
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2098
|
+
method: "POST",
|
|
2099
|
+
summary: "Unlink an intent category",
|
|
2100
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2101
|
+
tags: ["insights"],
|
|
2102
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2103
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2104
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2105
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2106
|
+
intentIds: categorizableIntentIdsSchema
|
|
2107
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2108
|
+
const listTeamsContractV1 = base.route({
|
|
1170
2109
|
path: "/v1/teams",
|
|
1171
2110
|
method: "GET",
|
|
1172
2111
|
summary: "List teams",
|
|
@@ -1179,28 +2118,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
1179
2118
|
createdAt: z.coerce.date(),
|
|
1180
2119
|
hasStripeAccount: z.boolean()
|
|
1181
2120
|
})));
|
|
1182
|
-
const
|
|
2121
|
+
const getTeamUsageContractV1 = base.route({
|
|
2122
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2123
|
+
method: "GET",
|
|
2124
|
+
summary: "Get team usage",
|
|
2125
|
+
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.",
|
|
2126
|
+
tags: ["teams"],
|
|
2127
|
+
successDescription: "The current billing window usage"
|
|
2128
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2129
|
+
teamId: z.string(),
|
|
2130
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2131
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2132
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2133
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2134
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2135
|
+
}));
|
|
2136
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1183
2137
|
path: "/v1/tunnels/ticket",
|
|
1184
2138
|
method: "GET",
|
|
1185
2139
|
summary: "Get a tunnel ticket",
|
|
1186
2140
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1187
2141
|
tags: ["tunnels"],
|
|
1188
2142
|
successDescription: "The tunnel ticket"
|
|
1189
|
-
}).output(z.object({
|
|
2143
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1190
2144
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1191
2145
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1192
2146
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1193
2147
|
}));
|
|
1194
|
-
const publishServerContractV1 =
|
|
2148
|
+
const publishServerContractV1 = base.route({
|
|
1195
2149
|
path: "/v1/distribution/publish",
|
|
1196
2150
|
method: "POST",
|
|
1197
2151
|
summary: "Publish a server to the MCP registry",
|
|
1198
2152
|
tags: ["distribution"],
|
|
1199
2153
|
successDescription: "The server has been published successfully"
|
|
1200
|
-
}).errors({
|
|
1201
|
-
NOT_FOUND: {},
|
|
1202
|
-
BAD_REQUEST: {}
|
|
1203
|
-
}).input(z.object({
|
|
2154
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1204
2155
|
projectId: z.string(),
|
|
1205
2156
|
domain: z.string(),
|
|
1206
2157
|
title: z.string().min(1).max(100),
|
|
@@ -1209,17 +2160,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1209
2160
|
iconSrc: z.url().max(255).optional(),
|
|
1210
2161
|
dryRun: z.boolean().optional()
|
|
1211
2162
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1212
|
-
const getServerInfoContractV1 =
|
|
2163
|
+
const getServerInfoContractV1 = base.route({
|
|
1213
2164
|
path: "/v1/distribution/get",
|
|
1214
2165
|
method: "GET",
|
|
1215
2166
|
summary: "Get server info",
|
|
1216
2167
|
description: "Get info about a server",
|
|
1217
2168
|
tags: ["distribution"],
|
|
1218
2169
|
successDescription: "The server info"
|
|
1219
|
-
}).errors({
|
|
1220
|
-
NOT_FOUND: {},
|
|
1221
|
-
BAD_REQUEST: {}
|
|
1222
|
-
}).input(z.object({
|
|
2170
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1223
2171
|
projectId: z.string(),
|
|
1224
2172
|
domain: z.string()
|
|
1225
2173
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1238,7 +2186,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1238
2186
|
isPlaygroundEnabled: z.boolean(),
|
|
1239
2187
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1240
2188
|
});
|
|
1241
|
-
const getPlaygroundContractV1 =
|
|
2189
|
+
const getPlaygroundContractV1 = base.route({
|
|
1242
2190
|
path: "/v1/environments/{environmentId}/playground",
|
|
1243
2191
|
method: "GET",
|
|
1244
2192
|
summary: "Get playground configuration",
|
|
@@ -1246,25 +2194,22 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1246
2194
|
tags: ["environments"],
|
|
1247
2195
|
successDescription: "The playground configuration"
|
|
1248
2196
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1249
|
-
const upsertPlaygroundContractV1 =
|
|
2197
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1250
2198
|
path: "/v1/environments/{environmentId}/playground",
|
|
1251
2199
|
method: "PUT",
|
|
1252
2200
|
summary: "Update playground configuration",
|
|
1253
2201
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1254
2202
|
tags: ["environments"],
|
|
1255
2203
|
successDescription: "The updated playground configuration"
|
|
1256
|
-
}).errors({
|
|
1257
|
-
NOT_FOUND: {},
|
|
1258
|
-
BAD_REQUEST: {}
|
|
1259
|
-
}).input(z.object({
|
|
2204
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1260
2205
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1261
2206
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1262
2207
|
name: z.string().min(1).max(100).optional(),
|
|
1263
2208
|
description: z.string().min(1).max(500).optional(),
|
|
1264
2209
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1265
|
-
examplePrompts: z.array(playgroundExamplePromptSchema).max(
|
|
2210
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1266
2211
|
})).output(playgroundOutputSchema);
|
|
1267
|
-
const createBeaconContractV1 =
|
|
2212
|
+
const createBeaconContractV1 = base.route({
|
|
1268
2213
|
path: "/v1/beacon/audits",
|
|
1269
2214
|
method: "POST",
|
|
1270
2215
|
summary: "Create a beacon audit",
|
|
@@ -1273,7 +2218,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1273
2218
|
successDescription: "The audit has been created"
|
|
1274
2219
|
}).errors({
|
|
1275
2220
|
NOT_FOUND: {},
|
|
1276
|
-
BAD_REQUEST: {},
|
|
1277
2221
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1278
2222
|
}).input(z.object({
|
|
1279
2223
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1281,7 +2225,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1281
2225
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1282
2226
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1283
2227
|
})).output(z.object({ id: z.string() }));
|
|
1284
|
-
const getBeaconContractV1 =
|
|
2228
|
+
const getBeaconContractV1 = base.route({
|
|
1285
2229
|
path: "/v1/beacon/audits/{auditId}",
|
|
1286
2230
|
method: "GET",
|
|
1287
2231
|
summary: "Get a beacon audit",
|
|
@@ -1297,8 +2241,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1297
2241
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1298
2242
|
}));
|
|
1299
2243
|
const contract = {
|
|
1300
|
-
teams: {
|
|
2244
|
+
teams: {
|
|
2245
|
+
list: { v1: listTeamsContractV1 },
|
|
2246
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2247
|
+
},
|
|
1301
2248
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2249
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2250
|
+
intentCategories: {
|
|
2251
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2252
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2253
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2254
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2255
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2256
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2257
|
+
},
|
|
2258
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1302
2259
|
deployments: {
|
|
1303
2260
|
list: { v1: listDeploymentsContractV1 },
|
|
1304
2261
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1339,5 +2296,10 @@ const contract = {
|
|
|
1339
2296
|
get: { v1: getBeaconContractV1 }
|
|
1340
2297
|
}
|
|
1341
2298
|
};
|
|
2299
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2300
|
+
const contractForDocs = {
|
|
2301
|
+
...contract,
|
|
2302
|
+
deployments: deploymentsForDocs
|
|
2303
|
+
};
|
|
1342
2304
|
//#endregion
|
|
1343
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2305
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|