@alpic-ai/api 0.0.0-dev.gd514aa3 → 0.0.0-dev.gd5572c3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +1572 -76
- package/dist/index.mjs +1308 -343
- 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,15 +856,7 @@ z.object({
|
|
|
296
856
|
serverFields: serverFieldsSchema$1,
|
|
297
857
|
source: z.enum(["registry", "defaults"])
|
|
298
858
|
});
|
|
299
|
-
/**
|
|
300
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
301
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
302
|
-
*
|
|
303
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
304
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
305
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
306
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
307
|
-
*/
|
|
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. */
|
|
308
860
|
const clampStringField = (field) => {
|
|
309
861
|
const max = field.maxLength;
|
|
310
862
|
if (max === null) return field;
|
|
@@ -324,17 +876,20 @@ const toolDefinitionSchema = z.object({
|
|
|
324
876
|
}).optional()
|
|
325
877
|
});
|
|
326
878
|
const positiveTestCaseSchema = z.object({
|
|
327
|
-
scenario: z.string(),
|
|
328
|
-
userPrompt: z.string(),
|
|
329
|
-
toolTriggered: z.string().optional(),
|
|
330
|
-
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.")
|
|
331
883
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
332
884
|
const screenshotEntrySchema = z.object({
|
|
333
885
|
prompt: z.string(),
|
|
334
|
-
url: z.url()
|
|
886
|
+
url: z.url()
|
|
335
887
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
888
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
336
889
|
/** Accepts either a valid email or URL. */
|
|
337
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)" });
|
|
338
893
|
const chatgptCategorySchema = z.enum([
|
|
339
894
|
"BUSINESS",
|
|
340
895
|
"COLLABORATION",
|
|
@@ -351,51 +906,348 @@ const chatgptCategorySchema = z.enum([
|
|
|
351
906
|
"TRAVEL"
|
|
352
907
|
]);
|
|
353
908
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
354
|
-
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
|
+
]);
|
|
355
1195
|
const negativeTestCaseSchema = z.object({
|
|
356
1196
|
scenario: z.string(),
|
|
357
1197
|
userPrompt: z.string()
|
|
358
1198
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
359
1199
|
const chatgptToolJustificationSchema = z.object({
|
|
360
1200
|
toolName: z.string(),
|
|
361
|
-
readOnlyJustification: z.string(),
|
|
362
|
-
openWorldJustification: z.string(),
|
|
363
|
-
destructiveJustification: z.string()
|
|
364
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
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();
|
|
365
1208
|
const chatgptTranslationSchema = z.object({
|
|
366
|
-
locale:
|
|
367
|
-
tagline:
|
|
368
|
-
description:
|
|
1209
|
+
locale: chatgptTranslationLocaleSchema,
|
|
1210
|
+
tagline: chatgptTaglineSchema,
|
|
1211
|
+
description: chatgptDescriptionSchema
|
|
369
1212
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
373
|
-
*/
|
|
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. */
|
|
374
1215
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
375
1216
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
376
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."),
|
|
377
1218
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
378
|
-
tagline:
|
|
379
|
-
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)."),
|
|
380
1221
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
381
1222
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
382
|
-
companyUrl:
|
|
1223
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
383
1224
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
384
|
-
privacyPolicyUrl:
|
|
385
|
-
termsOfServiceUrl:
|
|
386
|
-
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."),
|
|
387
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."),
|
|
388
|
-
serverUrl:
|
|
1229
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
389
1230
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
390
1231
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
391
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
392
|
-
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output.
|
|
393
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases
|
|
394
|
-
screenshots: z.array(screenshotEntrySchema).describe("In-app screenshots paired with the user prompt that produced them. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max
|
|
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."),
|
|
395
1236
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
396
|
-
allowedCountries: chatgptAllowedCountriesSchema.describe("
|
|
1237
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
397
1238
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
398
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
|
+
});
|
|
399
1251
|
chatgptSubmissionFormDataSchema.pick({
|
|
400
1252
|
appName: true,
|
|
401
1253
|
developerName: true,
|
|
@@ -412,7 +1264,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
412
1264
|
toolJustifications: true
|
|
413
1265
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
414
1266
|
const claudeCategorySchema = z.enum([
|
|
415
|
-
"
|
|
1267
|
+
"Productivity",
|
|
416
1268
|
"Communication",
|
|
417
1269
|
"Data & Analytics",
|
|
418
1270
|
"Development tools",
|
|
@@ -420,221 +1272,167 @@ const claudeCategorySchema = z.enum([
|
|
|
420
1272
|
"Consumer Health",
|
|
421
1273
|
"Health & Life Sciences",
|
|
422
1274
|
"Media & Entertainment",
|
|
423
|
-
"Commerce & Shopping"
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
"
|
|
427
|
-
"
|
|
428
|
-
"
|
|
1275
|
+
"Commerce & Shopping",
|
|
1276
|
+
"Legal",
|
|
1277
|
+
"Sales and marketing",
|
|
1278
|
+
"Creative",
|
|
1279
|
+
"Nonprofit",
|
|
1280
|
+
"Education",
|
|
1281
|
+
"Other"
|
|
429
1282
|
]);
|
|
430
|
-
const
|
|
431
|
-
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.`;
|
|
432
1284
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
433
|
-
"
|
|
434
|
-
"
|
|
435
|
-
"
|
|
436
|
-
]);
|
|
437
|
-
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
438
|
-
const claudeTestedSurfaceSchema = z.enum([
|
|
439
|
-
"Claude.ai (web)",
|
|
440
|
-
"Claude Desktop",
|
|
441
|
-
"Claude Code",
|
|
442
|
-
"Cowork"
|
|
1285
|
+
"read_only",
|
|
1286
|
+
"write_only",
|
|
1287
|
+
"read_write"
|
|
443
1288
|
]);
|
|
444
|
-
const
|
|
445
|
-
"
|
|
446
|
-
"
|
|
447
|
-
"
|
|
448
|
-
"
|
|
449
|
-
"
|
|
1289
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1290
|
+
"oauth_dcr",
|
|
1291
|
+
"oauth_cimd",
|
|
1292
|
+
"oauth_anthropic_creds",
|
|
1293
|
+
"custom_connection",
|
|
1294
|
+
"none"
|
|
450
1295
|
]);
|
|
451
|
-
const
|
|
452
|
-
"
|
|
453
|
-
"
|
|
454
|
-
"
|
|
455
|
-
"GDPR compliant (if applicable)"
|
|
1296
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1297
|
+
"first_party",
|
|
1298
|
+
"proxied",
|
|
1299
|
+
"third_party"
|
|
456
1300
|
]);
|
|
457
|
-
const
|
|
458
|
-
|
|
459
|
-
"
|
|
460
|
-
"
|
|
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."
|
|
461
1310
|
]);
|
|
462
|
-
/**
|
|
463
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
464
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
465
|
-
*/
|
|
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. */
|
|
466
1312
|
const claudeSubmissionFormDataSchema = z.object({
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
(
|
|
477
|
-
|
|
478
|
-
(
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
•
|
|
496
|
-
•
|
|
497
|
-
•
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
• '
|
|
513
|
-
• '
|
|
514
|
-
• '
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
|
|
542
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
543
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
544
|
-
• 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
|
|
545
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
546
|
-
serverDocumentationLink: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. This is displayed in the Directory listing and must be publicly accessible without login. Minimum requirements for the docs page:
|
|
547
|
-
• What the connector does and its key capabilities
|
|
548
|
-
• How to connect/set it up (step by step)
|
|
549
|
-
• What each tool does (or at least the main ones)
|
|
550
|
-
• How to troubleshoot common issues
|
|
551
|
-
• A support contact or channel
|
|
552
|
-
Acceptable formats: a dedicated docs page, a help center article, a README on GitHub, or a blog post — as long as it's comprehensive. Note: Anthropic requires public documentation to be live by your publish date.`),
|
|
553
|
-
privacyPolicyUrl: z.url().describe(`URL to your privacy policy. This is mandatory and displayed in the directory listing. Missing or incomplete privacy policies result in immediate rejection. Your privacy policy must cover:
|
|
554
|
-
• What data you collect (and how)
|
|
555
|
-
• How you use the collected data
|
|
556
|
-
• Where and how long you store it
|
|
557
|
-
• Whether you share data with third parties (and who)
|
|
558
|
-
• How users can contact you about data concerns
|
|
559
|
-
The policy must be publicly accessible. If you don't have one yet, create one before submitting — there are free generators online, but make sure it accurately reflects your actual practices. If you're GDPR-compliant, your policy should reflect that.`),
|
|
560
|
-
supportChannel: supportChannelSchema.describe(`A URL or email address where users can get help with your connector. This is displayed in the Directory listing. Acceptable options:
|
|
561
|
-
• Email address (e.g. support@myapp.com)
|
|
562
|
-
• Link to a GitHub Issues page
|
|
563
|
-
• Link to a help center or support article
|
|
564
|
-
• Link to a Discord/Slack community
|
|
565
|
-
• Link to your documentation's troubleshooting section
|
|
566
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
567
|
-
testingCredentials: z.string().describe(`Provide login credentials for a test account that Anthropic reviewers can use to verify your server works end-to-end. Critical requirements:
|
|
568
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
569
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
570
|
-
• If your service uses Google OAuth or another OAuth that requires email verification, use mcp-review@anthropic.com as the account email — Anthropic has access to this inbox.
|
|
571
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
572
|
-
• If your service requires API keys instead of a password, provide those.
|
|
573
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
574
|
-
tools: z.array(toolDefinitionSchema).describe(`A comma-separated list of all tools your MCP server exposes. Use the format: tool_name (Human-Readable Name). The tool_name is the internal identifier (snake_case, max 64 characters). The Human-Readable Name is what users see.
|
|
575
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
576
|
-
Reviewers test every single tool you list here — don't list tools that don't work. Also: do not have a single catch-all tool like api_request(method, endpoint) — Anthropic rejects these. Each action should be its own purpose-built tool.`),
|
|
577
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
578
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
579
|
-
• 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
|
|
580
|
-
This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
|
|
581
|
-
testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
|
|
582
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
583
|
-
• Format: SVG only
|
|
584
|
-
• Aspect ratio: square (1:1)
|
|
585
|
-
• Should work on a light background
|
|
586
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
587
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
588
|
-
logoDark: z.string().optional().describe(`Optional dark-mode variant of the connector logo. Same specs as the light variant (SVG, square 1:1) but designed to read on a dark background. Leave empty if the light logo already works on dark.`),
|
|
589
|
-
screenshots: z.array(screenshotEntrySchema).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
|
|
590
|
-
• 3–5 images is ideal
|
|
591
|
-
• Minimum 1000px width, PNG format preferred
|
|
592
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
593
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
594
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
595
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
596
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
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()
|
|
597
1387
|
});
|
|
598
1388
|
claudeSubmissionFormDataSchema.pick({
|
|
599
|
-
companyName: true,
|
|
600
|
-
appName: true,
|
|
601
|
-
mcpUrlType: true,
|
|
602
1389
|
serverUrl: true,
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
transportSupport: true,
|
|
1390
|
+
name: true,
|
|
1391
|
+
slug: true,
|
|
1392
|
+
companyName: true,
|
|
607
1393
|
primaryContactEmail: true,
|
|
608
1394
|
primaryContactName: true,
|
|
1395
|
+
readWriteCapabilities: true,
|
|
609
1396
|
authentication: true,
|
|
610
|
-
|
|
611
|
-
|
|
1397
|
+
apiOwnership: true,
|
|
1398
|
+
personalHealthData: true
|
|
612
1399
|
}).extend({
|
|
613
1400
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
614
|
-
|
|
1401
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1402
|
+
});
|
|
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))
|
|
615
1413
|
});
|
|
616
|
-
claudeSubmissionFormDataSchema.pick({
|
|
617
|
-
tagline: true,
|
|
618
|
-
description: true,
|
|
619
|
-
category: true,
|
|
620
|
-
testCases: true
|
|
621
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
622
1414
|
const submissionMetaFieldsSchema = z.object({
|
|
623
1415
|
id: z.string(),
|
|
624
1416
|
environmentId: z.string(),
|
|
1417
|
+
auditId: z.string().nullable(),
|
|
625
1418
|
createdAt: z.coerce.date(),
|
|
626
1419
|
updatedAt: z.coerce.date()
|
|
627
1420
|
});
|
|
628
1421
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
629
1422
|
platform: z.literal("claudeai"),
|
|
630
|
-
formData:
|
|
1423
|
+
formData: claudeSubmissionDraftSchema
|
|
631
1424
|
});
|
|
632
1425
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
633
1426
|
platform: z.literal("chatgpt"),
|
|
634
|
-
formData:
|
|
1427
|
+
formData: chatgptSubmissionDraftSchema
|
|
635
1428
|
});
|
|
636
1429
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
637
|
-
z.union([
|
|
1430
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1431
|
+
z.literal([
|
|
1432
|
+
100,
|
|
1433
|
+
75,
|
|
1434
|
+
50
|
|
1435
|
+
]);
|
|
638
1436
|
const subscriptionPlanSchema = z.enum([
|
|
639
1437
|
"pro",
|
|
640
1438
|
"business",
|
|
@@ -657,6 +1455,50 @@ z.object({
|
|
|
657
1455
|
customerUsage: customerUsageSchema.nullable(),
|
|
658
1456
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
659
1457
|
});
|
|
1458
|
+
const telemetrySignalSchema = z.enum([
|
|
1459
|
+
"logs",
|
|
1460
|
+
"metrics",
|
|
1461
|
+
"traces"
|
|
1462
|
+
]);
|
|
1463
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1464
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1465
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1466
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1467
|
+
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");
|
|
1468
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1469
|
+
id: z.string(),
|
|
1470
|
+
name: otlpHeaderNameSchema,
|
|
1471
|
+
value: otlpHeaderValueSchema,
|
|
1472
|
+
isSecret: z.boolean()
|
|
1473
|
+
});
|
|
1474
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1475
|
+
"credentials",
|
|
1476
|
+
"wrong-path",
|
|
1477
|
+
"wrong-protocol",
|
|
1478
|
+
"invalid-payload",
|
|
1479
|
+
"partial-rejection",
|
|
1480
|
+
"blocked-target",
|
|
1481
|
+
"timeout",
|
|
1482
|
+
"unreachable",
|
|
1483
|
+
"receiver-error",
|
|
1484
|
+
"unexpected-status"
|
|
1485
|
+
]);
|
|
1486
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1487
|
+
z.object({
|
|
1488
|
+
id: z.string(),
|
|
1489
|
+
signal: telemetrySignalSchema,
|
|
1490
|
+
endpoint: otlpEndpointSchema,
|
|
1491
|
+
protocol: otlpProtocolSchema,
|
|
1492
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1493
|
+
status: telemetryDestinationStatusSchema,
|
|
1494
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1495
|
+
});
|
|
1496
|
+
//#endregion
|
|
1497
|
+
//#region src/auth-scope.ts
|
|
1498
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1499
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1500
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1501
|
+
const AUTH_SCOPE_USER = "user";
|
|
660
1502
|
//#endregion
|
|
661
1503
|
//#region src/schemas.ts
|
|
662
1504
|
const RESERVED_KEYS = [
|
|
@@ -693,7 +1535,10 @@ const RESERVED_KEYS = [
|
|
|
693
1535
|
"BUILD_ARG_START_COMMAND",
|
|
694
1536
|
"ALPIC_HOST",
|
|
695
1537
|
"ALPIC_CUSTOM_DOMAINS",
|
|
696
|
-
"ALPIC_INTENT_META_KEY"
|
|
1538
|
+
"ALPIC_INTENT_META_KEY",
|
|
1539
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1540
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1541
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
697
1542
|
];
|
|
698
1543
|
const environmentVariableSchema = z.object({
|
|
699
1544
|
key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
|
|
@@ -774,21 +1619,20 @@ const deploymentSchema = z.object({
|
|
|
774
1619
|
isCurrent: z.boolean(),
|
|
775
1620
|
deploymentPageUrl: z.url().nullable()
|
|
776
1621
|
});
|
|
777
|
-
const
|
|
1622
|
+
const isValidTimeInput = (value) => {
|
|
778
1623
|
if (ms(value) !== void 0) return true;
|
|
779
1624
|
return !Number.isNaN(new Date(value).getTime());
|
|
780
1625
|
};
|
|
781
|
-
const
|
|
1626
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1627
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1628
|
+
const createEnvironmentContractV1 = base.route({
|
|
782
1629
|
path: "/v1/environments",
|
|
783
1630
|
method: "POST",
|
|
784
1631
|
summary: "Create an environment",
|
|
785
1632
|
description: "Create an environment for a project",
|
|
786
1633
|
tags: ["environments"],
|
|
787
1634
|
successDescription: "The environment has been created successfully"
|
|
788
|
-
}).errors({
|
|
789
|
-
NOT_FOUND: {},
|
|
790
|
-
BAD_REQUEST: {}
|
|
791
|
-
}).input(z.object({
|
|
1635
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
792
1636
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
793
1637
|
name: z.string().min(1).describe("The name of the environment"),
|
|
794
1638
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -797,11 +1641,11 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
797
1641
|
id: z.string(),
|
|
798
1642
|
name: z.string(),
|
|
799
1643
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
800
|
-
urls: z.array(z.
|
|
1644
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
801
1645
|
createdAt: z.coerce.date(),
|
|
802
1646
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
803
1647
|
}));
|
|
804
|
-
const getEnvironmentContractV1 =
|
|
1648
|
+
const getEnvironmentContractV1 = base.route({
|
|
805
1649
|
path: "/v1/environments/{environmentId}",
|
|
806
1650
|
method: "GET",
|
|
807
1651
|
summary: "Get an environment",
|
|
@@ -858,7 +1702,7 @@ const projectOutputSchema = z.object({
|
|
|
858
1702
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
859
1703
|
environments: z.array(environmentSchema)
|
|
860
1704
|
});
|
|
861
|
-
const getProjectContractV1 =
|
|
1705
|
+
const getProjectContractV1 = base.route({
|
|
862
1706
|
path: "/v1/projects/{projectId}",
|
|
863
1707
|
method: "GET",
|
|
864
1708
|
summary: "Get a project",
|
|
@@ -866,15 +1710,15 @@ const getProjectContractV1 = oc.route({
|
|
|
866
1710
|
tags: ["projects"],
|
|
867
1711
|
successDescription: "The project details"
|
|
868
1712
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
869
|
-
const listProjectsContractV1 =
|
|
1713
|
+
const listProjectsContractV1 = base.route({
|
|
870
1714
|
path: "/v1/projects",
|
|
871
1715
|
method: "GET",
|
|
872
1716
|
summary: "List projects",
|
|
873
1717
|
description: "List all projects for a team",
|
|
874
1718
|
tags: ["projects"],
|
|
875
1719
|
successDescription: "The list of projects"
|
|
876
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
877
|
-
const createProjectContractV1 =
|
|
1720
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1721
|
+
const createProjectContractV1 = base.route({
|
|
878
1722
|
path: "/v1/projects",
|
|
879
1723
|
method: "POST",
|
|
880
1724
|
summary: "Create a project",
|
|
@@ -883,7 +1727,7 @@ const createProjectContractV1 = oc.route({
|
|
|
883
1727
|
successDescription: "The project has been created successfully"
|
|
884
1728
|
}).errors({
|
|
885
1729
|
NOT_FOUND: {},
|
|
886
|
-
|
|
1730
|
+
FORBIDDEN: {}
|
|
887
1731
|
}).input(z.object({
|
|
888
1732
|
teamId: z.string().optional(),
|
|
889
1733
|
name: z.string().trim().min(1).max(100),
|
|
@@ -923,7 +1767,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
923
1767
|
isSecret: z.boolean(),
|
|
924
1768
|
createdAt: z.coerce.date()
|
|
925
1769
|
});
|
|
926
|
-
const listEnvironmentVariablesContractV1 =
|
|
1770
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
927
1771
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
928
1772
|
method: "GET",
|
|
929
1773
|
summary: "List environment variables",
|
|
@@ -931,37 +1775,31 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
931
1775
|
tags: ["environments"],
|
|
932
1776
|
successDescription: "The list of environment variables"
|
|
933
1777
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
934
|
-
const createEnvironmentVariablesContractV1 =
|
|
1778
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
935
1779
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
936
1780
|
method: "POST",
|
|
937
1781
|
summary: "Add environment variables",
|
|
938
1782
|
description: "Add one or more environment variables to an environment",
|
|
939
1783
|
tags: ["environments"],
|
|
940
1784
|
successDescription: "The environment variables have been added successfully"
|
|
941
|
-
}).errors({
|
|
942
|
-
NOT_FOUND: {},
|
|
943
|
-
BAD_REQUEST: {}
|
|
944
|
-
}).input(z.object({
|
|
1785
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
945
1786
|
environmentId: z.string().describe("The ID of the environment"),
|
|
946
1787
|
environmentVariables: environmentVariablesSchema
|
|
947
1788
|
})).output(z.object({ success: z.literal(true) }));
|
|
948
|
-
const updateEnvironmentVariableContractV1 =
|
|
1789
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
949
1790
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
950
1791
|
method: "PATCH",
|
|
951
1792
|
summary: "Update an environment variable",
|
|
952
1793
|
description: "Update an environment variable by ID",
|
|
953
1794
|
tags: ["environments"],
|
|
954
1795
|
successDescription: "The environment variable has been updated successfully"
|
|
955
|
-
}).errors({
|
|
956
|
-
NOT_FOUND: {},
|
|
957
|
-
BAD_REQUEST: {}
|
|
958
|
-
}).input(z.object({
|
|
1796
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
959
1797
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
960
1798
|
key: environmentVariableSchema.shape.key,
|
|
961
1799
|
value: environmentVariableSchema.shape.value.optional(),
|
|
962
1800
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
963
1801
|
})).output(z.object({ success: z.literal(true) }));
|
|
964
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1802
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
965
1803
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
966
1804
|
method: "DELETE",
|
|
967
1805
|
summary: "Delete an environment variable",
|
|
@@ -969,7 +1807,7 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
969
1807
|
tags: ["environments"],
|
|
970
1808
|
successDescription: "The environment variable has been deleted successfully"
|
|
971
1809
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
972
|
-
const deleteProjectContractV1 =
|
|
1810
|
+
const deleteProjectContractV1 = base.route({
|
|
973
1811
|
path: "/v1/projects/{projectId}",
|
|
974
1812
|
method: "DELETE",
|
|
975
1813
|
summary: "Delete a project",
|
|
@@ -977,7 +1815,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
977
1815
|
tags: ["projects"],
|
|
978
1816
|
successDescription: "The project has been deleted successfully"
|
|
979
1817
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
980
|
-
const updateProjectContractV1 =
|
|
1818
|
+
const updateProjectContractV1 = base.route({
|
|
981
1819
|
path: "/v1/projects/{projectId}",
|
|
982
1820
|
method: "PATCH",
|
|
983
1821
|
summary: "Update a project",
|
|
@@ -986,13 +1824,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
986
1824
|
successDescription: "The project has been updated successfully"
|
|
987
1825
|
}).errors({
|
|
988
1826
|
NOT_FOUND: {},
|
|
989
|
-
|
|
1827
|
+
FORBIDDEN: {}
|
|
990
1828
|
}).input(z.object({
|
|
991
1829
|
projectId: z.string().describe("The ID of the project"),
|
|
992
1830
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
993
1831
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
994
1832
|
})).output(projectOutputSchema);
|
|
995
|
-
const deployEnvironmentContractV1 =
|
|
1833
|
+
const deployEnvironmentContractV1 = base.route({
|
|
996
1834
|
path: "/v1/environments/{environmentId}/deploy",
|
|
997
1835
|
method: "POST",
|
|
998
1836
|
summary: "Deploy an environment",
|
|
@@ -1001,24 +1839,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1001
1839
|
successDescription: "The environment has been deployed successfully"
|
|
1002
1840
|
}).errors({
|
|
1003
1841
|
NOT_FOUND: {},
|
|
1004
|
-
|
|
1842
|
+
CONFLICT: {}
|
|
1005
1843
|
}).input(z.object({
|
|
1006
1844
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1007
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1845
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1846
|
+
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1008
1847
|
})).output(deploymentSchema);
|
|
1009
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1848
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1010
1849
|
path: "/v1/deployments/upload",
|
|
1011
1850
|
method: "POST",
|
|
1012
1851
|
summary: "Upload deployment artifacts",
|
|
1013
1852
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1014
1853
|
tags: ["deployments"],
|
|
1015
1854
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1016
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1855
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1017
1856
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1018
1857
|
token: z.string().describe("Token to identify the source archive"),
|
|
1019
1858
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1020
1859
|
}));
|
|
1021
|
-
const listDeploymentsContractV1 =
|
|
1860
|
+
const listDeploymentsContractV1 = base.route({
|
|
1022
1861
|
path: "/v1/projects/{projectId}/deployments",
|
|
1023
1862
|
method: "GET",
|
|
1024
1863
|
summary: "List project deployments",
|
|
@@ -1030,7 +1869,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1030
1869
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1031
1870
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1032
1871
|
})).output(z.array(deploymentSchema));
|
|
1033
|
-
const getDeploymentContractV1 =
|
|
1872
|
+
const getDeploymentContractV1 = base.route({
|
|
1034
1873
|
path: "/v1/deployments/{deploymentId}",
|
|
1035
1874
|
method: "GET",
|
|
1036
1875
|
summary: "Get a deployment",
|
|
@@ -1038,20 +1877,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1038
1877
|
tags: ["deployments"],
|
|
1039
1878
|
successDescription: "The deployment details"
|
|
1040
1879
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1041
|
-
const
|
|
1880
|
+
const logEntrySchema = z.object({
|
|
1881
|
+
timestamp: z.coerce.date(),
|
|
1882
|
+
type: z.enum([
|
|
1883
|
+
"START",
|
|
1884
|
+
"END",
|
|
1885
|
+
"INFO",
|
|
1886
|
+
"ERROR",
|
|
1887
|
+
"WARNING",
|
|
1888
|
+
"DEBUG"
|
|
1889
|
+
]),
|
|
1890
|
+
requestId: z.string(),
|
|
1891
|
+
content: z.string().optional(),
|
|
1892
|
+
method: z.string().optional(),
|
|
1893
|
+
durationInMs: z.number().optional()
|
|
1894
|
+
});
|
|
1895
|
+
const getLogsContractV1 = base.route({
|
|
1042
1896
|
path: "/v1/environments/{environmentId}/logs",
|
|
1043
1897
|
method: "GET",
|
|
1044
1898
|
summary: "Get logs",
|
|
1045
1899
|
description: "Get logs for an environment",
|
|
1046
1900
|
tags: ["environments"],
|
|
1047
1901
|
successDescription: "The logs"
|
|
1048
|
-
}).errors({
|
|
1049
|
-
NOT_FOUND: {},
|
|
1050
|
-
BAD_REQUEST: {}
|
|
1051
|
-
}).input(z.object({
|
|
1902
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1052
1903
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1053
|
-
since:
|
|
1054
|
-
until:
|
|
1904
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1905
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1055
1906
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1056
1907
|
level: z.array(z.enum([
|
|
1057
1908
|
"INFO",
|
|
@@ -1062,34 +1913,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1062
1913
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1063
1914
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1064
1915
|
})).output(z.object({
|
|
1065
|
-
logs: z.array(
|
|
1066
|
-
timestamp: z.coerce.date(),
|
|
1067
|
-
type: z.enum([
|
|
1068
|
-
"START",
|
|
1069
|
-
"END",
|
|
1070
|
-
"INFO",
|
|
1071
|
-
"ERROR",
|
|
1072
|
-
"WARNING",
|
|
1073
|
-
"DEBUG"
|
|
1074
|
-
]),
|
|
1075
|
-
requestId: z.string(),
|
|
1076
|
-
content: z.string().optional(),
|
|
1077
|
-
method: z.string().optional(),
|
|
1078
|
-
durationInMs: z.number().optional()
|
|
1079
|
-
})),
|
|
1916
|
+
logs: z.array(logEntrySchema),
|
|
1080
1917
|
nextToken: z.string().nullable()
|
|
1081
1918
|
}));
|
|
1082
|
-
const getLatestLogsContractV1 =
|
|
1919
|
+
const getLatestLogsContractV1 = base.route({
|
|
1083
1920
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1084
1921
|
method: "GET",
|
|
1085
1922
|
summary: "Get latest logs",
|
|
1086
1923
|
description: "Get the N most recent logs for an environment",
|
|
1087
1924
|
tags: ["environments"],
|
|
1088
1925
|
successDescription: "The latest logs"
|
|
1089
|
-
}).errors({
|
|
1090
|
-
NOT_FOUND: {},
|
|
1091
|
-
BAD_REQUEST: {}
|
|
1092
|
-
}).input(z.object({
|
|
1926
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1093
1927
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1094
1928
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1095
1929
|
level: z.array(z.enum([
|
|
@@ -1099,22 +1933,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1099
1933
|
"DEBUG"
|
|
1100
1934
|
])).optional().describe("Filter by log level"),
|
|
1101
1935
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1102
|
-
})).output(z.object({ logs: z.array(
|
|
1103
|
-
|
|
1104
|
-
type: z.enum([
|
|
1105
|
-
"START",
|
|
1106
|
-
"END",
|
|
1107
|
-
"INFO",
|
|
1108
|
-
"ERROR",
|
|
1109
|
-
"WARNING",
|
|
1110
|
-
"DEBUG"
|
|
1111
|
-
]),
|
|
1112
|
-
requestId: z.string(),
|
|
1113
|
-
content: z.string().optional(),
|
|
1114
|
-
method: z.string().optional(),
|
|
1115
|
-
durationInMs: z.number().optional()
|
|
1116
|
-
})) }));
|
|
1117
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1936
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1937
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1118
1938
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1119
1939
|
method: "GET",
|
|
1120
1940
|
summary: "Get deployment logs",
|
|
@@ -1141,22 +1961,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1141
1961
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1142
1962
|
task_count: z.array(analyticsDataPointSchema)
|
|
1143
1963
|
});
|
|
1144
|
-
const getProjectAnalyticsContractV1 =
|
|
1964
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1145
1965
|
path: "/v1/analytics/{projectId}",
|
|
1146
1966
|
method: "GET",
|
|
1147
1967
|
summary: "Get project analytics",
|
|
1148
1968
|
description: "Get analytics data for a project over a time range",
|
|
1149
1969
|
tags: ["analytics"],
|
|
1150
1970
|
successDescription: "The project analytics data"
|
|
1151
|
-
}).errors({
|
|
1152
|
-
NOT_FOUND: {},
|
|
1153
|
-
BAD_REQUEST: {}
|
|
1154
|
-
}).input(z.object({
|
|
1971
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1155
1972
|
projectId: z.string().describe("The ID of the project"),
|
|
1156
1973
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1157
1974
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1158
1975
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1159
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
1976
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => Intl.supportedValuesOf("timeZone").includes(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1160
1977
|
metadata: z.object({
|
|
1161
1978
|
startTimestamp: z.number(),
|
|
1162
1979
|
endTimestamp: z.number(),
|
|
@@ -1166,7 +1983,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1166
1983
|
}),
|
|
1167
1984
|
timeSeries: analyticsTimeSeriesSchema
|
|
1168
1985
|
}));
|
|
1169
|
-
const
|
|
1986
|
+
const paginatedInsightsInputShape = {
|
|
1987
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1988
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1989
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1990
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1991
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1992
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1993
|
+
};
|
|
1994
|
+
const listIntentsContractV1 = base.route({
|
|
1995
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1996
|
+
method: "GET",
|
|
1997
|
+
summary: "List intents",
|
|
1998
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1999
|
+
tags: ["insights"],
|
|
2000
|
+
successDescription: "The grouped user intents"
|
|
2001
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2002
|
+
...paginatedInsightsInputShape,
|
|
2003
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2004
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2005
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2006
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2007
|
+
})).output(z.object({
|
|
2008
|
+
intents: z.array(z.object({
|
|
2009
|
+
id: z.string(),
|
|
2010
|
+
intentIds: z.array(z.string()).min(1),
|
|
2011
|
+
environmentId: z.string(),
|
|
2012
|
+
message: z.string(),
|
|
2013
|
+
toolName: z.string(),
|
|
2014
|
+
createdAt: z.coerce.date(),
|
|
2015
|
+
occurrenceCount: z.number().int().positive(),
|
|
2016
|
+
clientName: z.string().nullable(),
|
|
2017
|
+
clientId: z.string().nullable(),
|
|
2018
|
+
categories: z.array(z.object({
|
|
2019
|
+
id: z.string(),
|
|
2020
|
+
name: z.string(),
|
|
2021
|
+
color: intentCategoryColorSchema
|
|
2022
|
+
}))
|
|
2023
|
+
})),
|
|
2024
|
+
totalCount: z.number().int().nonnegative()
|
|
2025
|
+
}));
|
|
2026
|
+
const listFeedbacksContractV1 = base.route({
|
|
2027
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2028
|
+
method: "GET",
|
|
2029
|
+
summary: "List feedbacks",
|
|
2030
|
+
description: "List user feedback for an environment over a time range",
|
|
2031
|
+
tags: ["insights"],
|
|
2032
|
+
successDescription: "The user feedback"
|
|
2033
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2034
|
+
...paginatedInsightsInputShape,
|
|
2035
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2036
|
+
})).output(z.object({
|
|
2037
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2038
|
+
totalCount: z.number().int().nonnegative()
|
|
2039
|
+
}));
|
|
2040
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2041
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2042
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2043
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2044
|
+
method: "GET",
|
|
2045
|
+
summary: "List intent categories",
|
|
2046
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2047
|
+
tags: ["insights"],
|
|
2048
|
+
successDescription: "The intent categories"
|
|
2049
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2050
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2051
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2052
|
+
method: "POST",
|
|
2053
|
+
summary: "Create an intent category",
|
|
2054
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2055
|
+
tags: ["insights"],
|
|
2056
|
+
successDescription: "The created intent category"
|
|
2057
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2058
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2059
|
+
name: intentCategoryNameSchema,
|
|
2060
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2061
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2062
|
+
})).output(intentCategorySchema);
|
|
2063
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2064
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2065
|
+
method: "PATCH",
|
|
2066
|
+
summary: "Update an intent category",
|
|
2067
|
+
description: "Rename or recolor an intent category",
|
|
2068
|
+
tags: ["insights"],
|
|
2069
|
+
successDescription: "The updated intent category"
|
|
2070
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2071
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2072
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2073
|
+
name: intentCategoryNameSchema.optional(),
|
|
2074
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2075
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2076
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2077
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2078
|
+
method: "DELETE",
|
|
2079
|
+
summary: "Delete an intent category",
|
|
2080
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2081
|
+
tags: ["insights"],
|
|
2082
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2083
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2084
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2085
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2086
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2087
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2088
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2089
|
+
method: "POST",
|
|
2090
|
+
summary: "Link an intent category",
|
|
2091
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2092
|
+
tags: ["insights"],
|
|
2093
|
+
successDescription: "The intents have been linked successfully"
|
|
2094
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2095
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2096
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2097
|
+
intentIds: categorizableIntentIdsSchema
|
|
2098
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2099
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2100
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2101
|
+
method: "POST",
|
|
2102
|
+
summary: "Unlink an intent category",
|
|
2103
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2104
|
+
tags: ["insights"],
|
|
2105
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2106
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2107
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2108
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2109
|
+
intentIds: categorizableIntentIdsSchema
|
|
2110
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2111
|
+
const listTeamsContractV1 = base.route({
|
|
1170
2112
|
path: "/v1/teams",
|
|
1171
2113
|
method: "GET",
|
|
1172
2114
|
summary: "List teams",
|
|
@@ -1179,28 +2121,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
1179
2121
|
createdAt: z.coerce.date(),
|
|
1180
2122
|
hasStripeAccount: z.boolean()
|
|
1181
2123
|
})));
|
|
1182
|
-
const
|
|
2124
|
+
const getTeamUsageContractV1 = base.route({
|
|
2125
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2126
|
+
method: "GET",
|
|
2127
|
+
summary: "Get team usage",
|
|
2128
|
+
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.",
|
|
2129
|
+
tags: ["teams"],
|
|
2130
|
+
successDescription: "The current billing window usage"
|
|
2131
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2132
|
+
teamId: z.string(),
|
|
2133
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2134
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2135
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2136
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2137
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2138
|
+
}));
|
|
2139
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1183
2140
|
path: "/v1/tunnels/ticket",
|
|
1184
2141
|
method: "GET",
|
|
1185
2142
|
summary: "Get a tunnel ticket",
|
|
1186
2143
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1187
2144
|
tags: ["tunnels"],
|
|
1188
2145
|
successDescription: "The tunnel ticket"
|
|
1189
|
-
}).output(z.object({
|
|
2146
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1190
2147
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1191
2148
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1192
2149
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1193
2150
|
}));
|
|
1194
|
-
const publishServerContractV1 =
|
|
2151
|
+
const publishServerContractV1 = base.route({
|
|
1195
2152
|
path: "/v1/distribution/publish",
|
|
1196
2153
|
method: "POST",
|
|
1197
2154
|
summary: "Publish a server to the MCP registry",
|
|
1198
2155
|
tags: ["distribution"],
|
|
1199
2156
|
successDescription: "The server has been published successfully"
|
|
1200
|
-
}).errors({
|
|
1201
|
-
NOT_FOUND: {},
|
|
1202
|
-
BAD_REQUEST: {}
|
|
1203
|
-
}).input(z.object({
|
|
2157
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1204
2158
|
projectId: z.string(),
|
|
1205
2159
|
domain: z.string(),
|
|
1206
2160
|
title: z.string().min(1).max(100),
|
|
@@ -1209,17 +2163,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1209
2163
|
iconSrc: z.url().max(255).optional(),
|
|
1210
2164
|
dryRun: z.boolean().optional()
|
|
1211
2165
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1212
|
-
const getServerInfoContractV1 =
|
|
2166
|
+
const getServerInfoContractV1 = base.route({
|
|
1213
2167
|
path: "/v1/distribution/get",
|
|
1214
2168
|
method: "GET",
|
|
1215
2169
|
summary: "Get server info",
|
|
1216
2170
|
description: "Get info about a server",
|
|
1217
2171
|
tags: ["distribution"],
|
|
1218
2172
|
successDescription: "The server info"
|
|
1219
|
-
}).errors({
|
|
1220
|
-
NOT_FOUND: {},
|
|
1221
|
-
BAD_REQUEST: {}
|
|
1222
|
-
}).input(z.object({
|
|
2173
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1223
2174
|
projectId: z.string(),
|
|
1224
2175
|
domain: z.string()
|
|
1225
2176
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1238,7 +2189,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1238
2189
|
isPlaygroundEnabled: z.boolean(),
|
|
1239
2190
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1240
2191
|
});
|
|
1241
|
-
const getPlaygroundContractV1 =
|
|
2192
|
+
const getPlaygroundContractV1 = base.route({
|
|
1242
2193
|
path: "/v1/environments/{environmentId}/playground",
|
|
1243
2194
|
method: "GET",
|
|
1244
2195
|
summary: "Get playground configuration",
|
|
@@ -1246,25 +2197,22 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1246
2197
|
tags: ["environments"],
|
|
1247
2198
|
successDescription: "The playground configuration"
|
|
1248
2199
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1249
|
-
const upsertPlaygroundContractV1 =
|
|
2200
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1250
2201
|
path: "/v1/environments/{environmentId}/playground",
|
|
1251
2202
|
method: "PUT",
|
|
1252
2203
|
summary: "Update playground configuration",
|
|
1253
2204
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1254
2205
|
tags: ["environments"],
|
|
1255
2206
|
successDescription: "The updated playground configuration"
|
|
1256
|
-
}).errors({
|
|
1257
|
-
NOT_FOUND: {},
|
|
1258
|
-
BAD_REQUEST: {}
|
|
1259
|
-
}).input(z.object({
|
|
2207
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1260
2208
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1261
2209
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1262
2210
|
name: z.string().min(1).max(100).optional(),
|
|
1263
2211
|
description: z.string().min(1).max(500).optional(),
|
|
1264
2212
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1265
|
-
examplePrompts: z.array(playgroundExamplePromptSchema).max(
|
|
2213
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1266
2214
|
})).output(playgroundOutputSchema);
|
|
1267
|
-
const createBeaconContractV1 =
|
|
2215
|
+
const createBeaconContractV1 = base.route({
|
|
1268
2216
|
path: "/v1/beacon/audits",
|
|
1269
2217
|
method: "POST",
|
|
1270
2218
|
summary: "Create a beacon audit",
|
|
@@ -1273,7 +2221,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1273
2221
|
successDescription: "The audit has been created"
|
|
1274
2222
|
}).errors({
|
|
1275
2223
|
NOT_FOUND: {},
|
|
1276
|
-
BAD_REQUEST: {},
|
|
1277
2224
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1278
2225
|
}).input(z.object({
|
|
1279
2226
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1281,7 +2228,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1281
2228
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1282
2229
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1283
2230
|
})).output(z.object({ id: z.string() }));
|
|
1284
|
-
const getBeaconContractV1 =
|
|
2231
|
+
const getBeaconContractV1 = base.route({
|
|
1285
2232
|
path: "/v1/beacon/audits/{auditId}",
|
|
1286
2233
|
method: "GET",
|
|
1287
2234
|
summary: "Get a beacon audit",
|
|
@@ -1297,8 +2244,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1297
2244
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1298
2245
|
}));
|
|
1299
2246
|
const contract = {
|
|
1300
|
-
teams: {
|
|
2247
|
+
teams: {
|
|
2248
|
+
list: { v1: listTeamsContractV1 },
|
|
2249
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2250
|
+
},
|
|
1301
2251
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2252
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2253
|
+
intentCategories: {
|
|
2254
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2255
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2256
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2257
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2258
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2259
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2260
|
+
},
|
|
2261
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1302
2262
|
deployments: {
|
|
1303
2263
|
list: { v1: listDeploymentsContractV1 },
|
|
1304
2264
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1339,5 +2299,10 @@ const contract = {
|
|
|
1339
2299
|
get: { v1: getBeaconContractV1 }
|
|
1340
2300
|
}
|
|
1341
2301
|
};
|
|
2302
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2303
|
+
const contractForDocs = {
|
|
2304
|
+
...contract,
|
|
2305
|
+
deployments: deploymentsForDocs
|
|
2306
|
+
};
|
|
1342
2307
|
//#endregion
|
|
1343
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2308
|
+
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 };
|