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