@alpic-ai/api 0.0.0-dev.ge3cead0 → 0.0.0-dev.ge3d809b
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 +1188 -344
- 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({
|
|
@@ -231,6 +529,246 @@ z.enum([
|
|
|
231
529
|
"DEBUG",
|
|
232
530
|
"ERROR"
|
|
233
531
|
]);
|
|
532
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
533
|
+
const MCP_CLIENT_GROUPS = [
|
|
534
|
+
{
|
|
535
|
+
id: "claude_code",
|
|
536
|
+
label: "Claude Code",
|
|
537
|
+
vendor: "anthropic",
|
|
538
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
539
|
+
},
|
|
540
|
+
{
|
|
541
|
+
id: "claude",
|
|
542
|
+
label: "Claude",
|
|
543
|
+
vendor: "anthropic",
|
|
544
|
+
rawNames: [
|
|
545
|
+
"Anthropic/ClaudeAI",
|
|
546
|
+
"claude-ai",
|
|
547
|
+
"claude",
|
|
548
|
+
"Claude",
|
|
549
|
+
"claude-desktop",
|
|
550
|
+
"claude-desktop-3p"
|
|
551
|
+
]
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
id: "claude_mobile",
|
|
555
|
+
label: "Claude mobile",
|
|
556
|
+
vendor: "anthropic",
|
|
557
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
id: "claude_cowork",
|
|
561
|
+
label: "Claude Cowork",
|
|
562
|
+
vendor: "anthropic",
|
|
563
|
+
rawNames: ["Anthropic/Cowork"]
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
id: "claude_toolbox",
|
|
567
|
+
label: "Claude Toolbox",
|
|
568
|
+
vendor: "anthropic",
|
|
569
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
id: "anthropic_api",
|
|
573
|
+
label: "Anthropic API",
|
|
574
|
+
vendor: "anthropic",
|
|
575
|
+
rawNames: ["Anthropic/API"]
|
|
576
|
+
},
|
|
577
|
+
{
|
|
578
|
+
id: "anthropic_connector_refresh",
|
|
579
|
+
label: "Anthropic (connector refresh)",
|
|
580
|
+
vendor: "anthropic",
|
|
581
|
+
rawNames: ["Anthropic"]
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
id: "codex",
|
|
585
|
+
label: "Codex",
|
|
586
|
+
vendor: "openai",
|
|
587
|
+
rawNames: [
|
|
588
|
+
"codex-mcp-client",
|
|
589
|
+
"codex",
|
|
590
|
+
"Codex",
|
|
591
|
+
"codex-cli",
|
|
592
|
+
"openai-mcp (Codex)"
|
|
593
|
+
]
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
id: "chatgpt",
|
|
597
|
+
label: "ChatGPT",
|
|
598
|
+
vendor: "openai",
|
|
599
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
600
|
+
},
|
|
601
|
+
{
|
|
602
|
+
id: "openai_responses_api",
|
|
603
|
+
label: "OpenAI Responses API",
|
|
604
|
+
vendor: "openai",
|
|
605
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
id: "openai_agent_builder",
|
|
609
|
+
label: "OpenAI Agent Builder",
|
|
610
|
+
vendor: "openai",
|
|
611
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
612
|
+
},
|
|
613
|
+
{
|
|
614
|
+
id: "openai_other",
|
|
615
|
+
label: "OpenAI Other",
|
|
616
|
+
vendor: "openai",
|
|
617
|
+
rawNames: ["openai-mcp"]
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
id: "cursor",
|
|
621
|
+
label: "Cursor",
|
|
622
|
+
vendor: "cursor",
|
|
623
|
+
rawNames: [
|
|
624
|
+
"cursor-vscode",
|
|
625
|
+
"Cursor",
|
|
626
|
+
"cursor"
|
|
627
|
+
]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cline",
|
|
631
|
+
label: "Cline",
|
|
632
|
+
vendor: "cline",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"Cline",
|
|
635
|
+
"cline",
|
|
636
|
+
"@cline/core"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "github_copilot",
|
|
641
|
+
label: "GitHub Copilot",
|
|
642
|
+
vendor: "githubCopilot",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Copilot",
|
|
645
|
+
"github-copilot-developer",
|
|
646
|
+
"Copilot MCP Gateway",
|
|
647
|
+
"Xcode/copilot-xcode"
|
|
648
|
+
]
|
|
649
|
+
},
|
|
650
|
+
{
|
|
651
|
+
id: "gemini_cli",
|
|
652
|
+
label: "Gemini CLI",
|
|
653
|
+
vendor: "google",
|
|
654
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
655
|
+
},
|
|
656
|
+
{
|
|
657
|
+
id: "antigravity",
|
|
658
|
+
label: "Antigravity",
|
|
659
|
+
vendor: "google",
|
|
660
|
+
rawNames: ["antigravity-client"]
|
|
661
|
+
},
|
|
662
|
+
{
|
|
663
|
+
id: "gemini",
|
|
664
|
+
label: "Gemini",
|
|
665
|
+
vendor: "google",
|
|
666
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
id: "windsurf",
|
|
670
|
+
label: "Windsurf",
|
|
671
|
+
vendor: "windsurf",
|
|
672
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
673
|
+
},
|
|
674
|
+
{
|
|
675
|
+
id: "mistral",
|
|
676
|
+
label: "Mistral / Le Chat",
|
|
677
|
+
vendor: "mistral",
|
|
678
|
+
rawNames: ["Mistral"],
|
|
679
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
680
|
+
},
|
|
681
|
+
{
|
|
682
|
+
id: "n8n",
|
|
683
|
+
label: "n8n",
|
|
684
|
+
vendor: "n8n",
|
|
685
|
+
rawNames: [
|
|
686
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
687
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
688
|
+
"n8n"
|
|
689
|
+
]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "alpic_playground",
|
|
693
|
+
label: "Alpic Playground",
|
|
694
|
+
vendor: "alpic",
|
|
695
|
+
rawNames: ["alpic-playground", "playground"]
|
|
696
|
+
},
|
|
697
|
+
{
|
|
698
|
+
id: "opencode",
|
|
699
|
+
label: "opencode",
|
|
700
|
+
vendor: "opencode",
|
|
701
|
+
rawNames: ["opencode"]
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
id: "zed",
|
|
705
|
+
label: "Zed",
|
|
706
|
+
vendor: "zed",
|
|
707
|
+
rawNames: ["Zed", "zed"]
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
id: "zapier",
|
|
711
|
+
label: "Zapier",
|
|
712
|
+
vendor: "zapier",
|
|
713
|
+
rawNames: ["Zapier", "zapier"]
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
id: "make",
|
|
717
|
+
label: "Make",
|
|
718
|
+
vendor: "make",
|
|
719
|
+
rawNames: ["Make", "make"]
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
id: "librechat",
|
|
723
|
+
label: "LibreChat",
|
|
724
|
+
vendor: "mcp",
|
|
725
|
+
rawNames: ["LibreChat", "librechat"]
|
|
726
|
+
},
|
|
727
|
+
{
|
|
728
|
+
id: "jan",
|
|
729
|
+
label: "Jan",
|
|
730
|
+
vendor: "mcp",
|
|
731
|
+
rawNames: ["Jan", "jan"]
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
id: "goose",
|
|
735
|
+
label: "goose",
|
|
736
|
+
vendor: "mcp",
|
|
737
|
+
rawNames: ["goose", "Goose"]
|
|
738
|
+
},
|
|
739
|
+
{
|
|
740
|
+
id: "mcphost",
|
|
741
|
+
label: "mcphost",
|
|
742
|
+
vendor: "mcp",
|
|
743
|
+
rawNames: ["mcphost"]
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
id: "mcporter",
|
|
747
|
+
label: "mcporter",
|
|
748
|
+
vendor: "mcp",
|
|
749
|
+
rawNames: ["mcporter"]
|
|
750
|
+
},
|
|
751
|
+
{
|
|
752
|
+
id: "rmcp",
|
|
753
|
+
label: "rmcp",
|
|
754
|
+
vendor: "mcp",
|
|
755
|
+
rawNames: ["rmcp"]
|
|
756
|
+
},
|
|
757
|
+
{
|
|
758
|
+
id: "unnamed_client",
|
|
759
|
+
label: "Unnamed client",
|
|
760
|
+
vendor: "mcp",
|
|
761
|
+
rawNames: [
|
|
762
|
+
"mcp",
|
|
763
|
+
"unknown",
|
|
764
|
+
""
|
|
765
|
+
]
|
|
766
|
+
}
|
|
767
|
+
];
|
|
768
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
769
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
770
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
771
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
234
772
|
const runtimeSchema = z.enum([
|
|
235
773
|
"python3.13",
|
|
236
774
|
"python3.14",
|
|
@@ -259,15 +797,27 @@ z.object({
|
|
|
259
797
|
environments: z.array(environmentWithDomainsSchema),
|
|
260
798
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
261
799
|
});
|
|
800
|
+
const domainFailureReasonSchema = z.enum([
|
|
801
|
+
"caa",
|
|
802
|
+
"dns",
|
|
803
|
+
"invalid_domain",
|
|
804
|
+
"other"
|
|
805
|
+
]);
|
|
806
|
+
const projectDomainMappingSchema = z.object({
|
|
807
|
+
pathPrefix: z.string(),
|
|
808
|
+
environment: environmentSchema$1
|
|
809
|
+
});
|
|
262
810
|
z.object({
|
|
263
|
-
|
|
811
|
+
name: z.string(),
|
|
264
812
|
createdAt: z.coerce.date(),
|
|
265
813
|
status: z.enum([
|
|
266
814
|
"ongoing",
|
|
267
815
|
"deployed",
|
|
268
816
|
"failed"
|
|
269
817
|
]),
|
|
270
|
-
|
|
818
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
819
|
+
environment: environmentSchema$1,
|
|
820
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
271
821
|
});
|
|
272
822
|
const serverFieldsSchema$1 = z.object({
|
|
273
823
|
$schema: z.string(),
|
|
@@ -296,15 +846,7 @@ z.object({
|
|
|
296
846
|
serverFields: serverFieldsSchema$1,
|
|
297
847
|
source: z.enum(["registry", "defaults"])
|
|
298
848
|
});
|
|
299
|
-
/**
|
|
300
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
301
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
302
|
-
*
|
|
303
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
304
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
305
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
306
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
307
|
-
*/
|
|
849
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
308
850
|
const clampStringField = (field) => {
|
|
309
851
|
const max = field.maxLength;
|
|
310
852
|
if (max === null) return field;
|
|
@@ -324,17 +866,20 @@ const toolDefinitionSchema = z.object({
|
|
|
324
866
|
}).optional()
|
|
325
867
|
});
|
|
326
868
|
const positiveTestCaseSchema = z.object({
|
|
327
|
-
scenario: z.string(),
|
|
328
|
-
userPrompt: z.string(),
|
|
329
|
-
toolTriggered: z.string().optional(),
|
|
330
|
-
expectedOutput: z.string().optional()
|
|
869
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
870
|
+
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
871
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
872
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
331
873
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
332
874
|
const screenshotEntrySchema = z.object({
|
|
333
875
|
prompt: z.string(),
|
|
334
|
-
url: z.url()
|
|
876
|
+
url: z.url()
|
|
335
877
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
878
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
336
879
|
/** Accepts either a valid email or URL. */
|
|
337
880
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
881
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
882
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
338
883
|
const chatgptCategorySchema = z.enum([
|
|
339
884
|
"BUSINESS",
|
|
340
885
|
"COLLABORATION",
|
|
@@ -351,7 +896,227 @@ const chatgptCategorySchema = z.enum([
|
|
|
351
896
|
"TRAVEL"
|
|
352
897
|
]);
|
|
353
898
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
354
|
-
const
|
|
899
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
900
|
+
"AD",
|
|
901
|
+
"AE",
|
|
902
|
+
"AF",
|
|
903
|
+
"AG",
|
|
904
|
+
"AL",
|
|
905
|
+
"AM",
|
|
906
|
+
"AO",
|
|
907
|
+
"AR",
|
|
908
|
+
"AT",
|
|
909
|
+
"AU",
|
|
910
|
+
"AW",
|
|
911
|
+
"AX",
|
|
912
|
+
"AZ",
|
|
913
|
+
"BA",
|
|
914
|
+
"BB",
|
|
915
|
+
"BD",
|
|
916
|
+
"BE",
|
|
917
|
+
"BF",
|
|
918
|
+
"BG",
|
|
919
|
+
"BH",
|
|
920
|
+
"BI",
|
|
921
|
+
"BJ",
|
|
922
|
+
"BL",
|
|
923
|
+
"BM",
|
|
924
|
+
"BN",
|
|
925
|
+
"BO",
|
|
926
|
+
"BR",
|
|
927
|
+
"BS",
|
|
928
|
+
"BT",
|
|
929
|
+
"BW",
|
|
930
|
+
"BZ",
|
|
931
|
+
"CA",
|
|
932
|
+
"CD",
|
|
933
|
+
"CF",
|
|
934
|
+
"CG",
|
|
935
|
+
"CH",
|
|
936
|
+
"CI",
|
|
937
|
+
"CL",
|
|
938
|
+
"CM",
|
|
939
|
+
"CO",
|
|
940
|
+
"CR",
|
|
941
|
+
"CV",
|
|
942
|
+
"CY",
|
|
943
|
+
"CZ",
|
|
944
|
+
"DE",
|
|
945
|
+
"DJ",
|
|
946
|
+
"DK",
|
|
947
|
+
"DM",
|
|
948
|
+
"DO",
|
|
949
|
+
"DZ",
|
|
950
|
+
"EC",
|
|
951
|
+
"EE",
|
|
952
|
+
"EG",
|
|
953
|
+
"ER",
|
|
954
|
+
"ES",
|
|
955
|
+
"ET",
|
|
956
|
+
"FI",
|
|
957
|
+
"FJ",
|
|
958
|
+
"FM",
|
|
959
|
+
"FO",
|
|
960
|
+
"FR",
|
|
961
|
+
"GA",
|
|
962
|
+
"GB",
|
|
963
|
+
"GD",
|
|
964
|
+
"GE",
|
|
965
|
+
"GF",
|
|
966
|
+
"GH",
|
|
967
|
+
"GL",
|
|
968
|
+
"GM",
|
|
969
|
+
"GN",
|
|
970
|
+
"GP",
|
|
971
|
+
"GQ",
|
|
972
|
+
"GR",
|
|
973
|
+
"GT",
|
|
974
|
+
"GW",
|
|
975
|
+
"GY",
|
|
976
|
+
"HN",
|
|
977
|
+
"HR",
|
|
978
|
+
"HT",
|
|
979
|
+
"HU",
|
|
980
|
+
"ID",
|
|
981
|
+
"IE",
|
|
982
|
+
"IL",
|
|
983
|
+
"IN",
|
|
984
|
+
"IQ",
|
|
985
|
+
"IS",
|
|
986
|
+
"IT",
|
|
987
|
+
"JM",
|
|
988
|
+
"JO",
|
|
989
|
+
"JP",
|
|
990
|
+
"KE",
|
|
991
|
+
"KG",
|
|
992
|
+
"KH",
|
|
993
|
+
"KI",
|
|
994
|
+
"KM",
|
|
995
|
+
"KN",
|
|
996
|
+
"KR",
|
|
997
|
+
"KW",
|
|
998
|
+
"KY",
|
|
999
|
+
"KZ",
|
|
1000
|
+
"LA",
|
|
1001
|
+
"LB",
|
|
1002
|
+
"LC",
|
|
1003
|
+
"LI",
|
|
1004
|
+
"LK",
|
|
1005
|
+
"LR",
|
|
1006
|
+
"LS",
|
|
1007
|
+
"LT",
|
|
1008
|
+
"LU",
|
|
1009
|
+
"LV",
|
|
1010
|
+
"LY",
|
|
1011
|
+
"MA",
|
|
1012
|
+
"MC",
|
|
1013
|
+
"MD",
|
|
1014
|
+
"ME",
|
|
1015
|
+
"MF",
|
|
1016
|
+
"MG",
|
|
1017
|
+
"MH",
|
|
1018
|
+
"MK",
|
|
1019
|
+
"ML",
|
|
1020
|
+
"MM",
|
|
1021
|
+
"MN",
|
|
1022
|
+
"MQ",
|
|
1023
|
+
"MR",
|
|
1024
|
+
"MT",
|
|
1025
|
+
"MU",
|
|
1026
|
+
"MV",
|
|
1027
|
+
"MW",
|
|
1028
|
+
"MX",
|
|
1029
|
+
"MY",
|
|
1030
|
+
"MZ",
|
|
1031
|
+
"NA",
|
|
1032
|
+
"NC",
|
|
1033
|
+
"NE",
|
|
1034
|
+
"NG",
|
|
1035
|
+
"NI",
|
|
1036
|
+
"NL",
|
|
1037
|
+
"NO",
|
|
1038
|
+
"NP",
|
|
1039
|
+
"NR",
|
|
1040
|
+
"NZ",
|
|
1041
|
+
"OM",
|
|
1042
|
+
"PA",
|
|
1043
|
+
"PE",
|
|
1044
|
+
"PF",
|
|
1045
|
+
"PG",
|
|
1046
|
+
"PH",
|
|
1047
|
+
"PK",
|
|
1048
|
+
"PL",
|
|
1049
|
+
"PM",
|
|
1050
|
+
"PS",
|
|
1051
|
+
"PT",
|
|
1052
|
+
"PW",
|
|
1053
|
+
"PY",
|
|
1054
|
+
"QA",
|
|
1055
|
+
"RE",
|
|
1056
|
+
"RO",
|
|
1057
|
+
"RS",
|
|
1058
|
+
"RW",
|
|
1059
|
+
"SA",
|
|
1060
|
+
"SB",
|
|
1061
|
+
"SC",
|
|
1062
|
+
"SD",
|
|
1063
|
+
"SE",
|
|
1064
|
+
"SG",
|
|
1065
|
+
"SH",
|
|
1066
|
+
"SI",
|
|
1067
|
+
"SJ",
|
|
1068
|
+
"SK",
|
|
1069
|
+
"SL",
|
|
1070
|
+
"SM",
|
|
1071
|
+
"SN",
|
|
1072
|
+
"SO",
|
|
1073
|
+
"SR",
|
|
1074
|
+
"SS",
|
|
1075
|
+
"ST",
|
|
1076
|
+
"SV",
|
|
1077
|
+
"SZ",
|
|
1078
|
+
"TD",
|
|
1079
|
+
"TF",
|
|
1080
|
+
"TG",
|
|
1081
|
+
"TH",
|
|
1082
|
+
"TJ",
|
|
1083
|
+
"TL",
|
|
1084
|
+
"TM",
|
|
1085
|
+
"TN",
|
|
1086
|
+
"TO",
|
|
1087
|
+
"TR",
|
|
1088
|
+
"TT",
|
|
1089
|
+
"TV",
|
|
1090
|
+
"TW",
|
|
1091
|
+
"TZ",
|
|
1092
|
+
"UA",
|
|
1093
|
+
"UG",
|
|
1094
|
+
"US",
|
|
1095
|
+
"UY",
|
|
1096
|
+
"UZ",
|
|
1097
|
+
"VA",
|
|
1098
|
+
"VC",
|
|
1099
|
+
"VN",
|
|
1100
|
+
"VU",
|
|
1101
|
+
"WF",
|
|
1102
|
+
"WS",
|
|
1103
|
+
"YE",
|
|
1104
|
+
"YT",
|
|
1105
|
+
"ZA",
|
|
1106
|
+
"ZM",
|
|
1107
|
+
"ZW"
|
|
1108
|
+
]);
|
|
1109
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
1110
|
+
z.object({ mode: z.literal("all") }),
|
|
1111
|
+
z.object({
|
|
1112
|
+
mode: z.literal("allow"),
|
|
1113
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1114
|
+
}),
|
|
1115
|
+
z.object({
|
|
1116
|
+
mode: z.literal("block"),
|
|
1117
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1118
|
+
})
|
|
1119
|
+
]);
|
|
355
1120
|
const chatgptTranslationLocaleSchema = z.enum([
|
|
356
1121
|
"am",
|
|
357
1122
|
"ar",
|
|
@@ -423,15 +1188,11 @@ const negativeTestCaseSchema = z.object({
|
|
|
423
1188
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
424
1189
|
const chatgptToolJustificationSchema = z.object({
|
|
425
1190
|
toolName: z.string(),
|
|
426
|
-
readOnlyJustification: z.string(),
|
|
427
|
-
openWorldJustification: z.string(),
|
|
428
|
-
destructiveJustification: z.string()
|
|
429
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
430
|
-
/**
|
|
431
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
432
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
433
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
434
|
-
*/
|
|
1191
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
1192
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
1193
|
+
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
1194
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
1195
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
435
1196
|
const chatgptTaglineSchema = z.string().max(30);
|
|
436
1197
|
const chatgptDescriptionSchema = z.string();
|
|
437
1198
|
const chatgptTranslationSchema = z.object({
|
|
@@ -440,35 +1201,43 @@ const chatgptTranslationSchema = z.object({
|
|
|
440
1201
|
description: chatgptDescriptionSchema
|
|
441
1202
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
442
1203
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
443
|
-
/**
|
|
444
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
445
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
446
|
-
*/
|
|
1204
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
447
1205
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
448
1206
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
449
1207
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
450
1208
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
451
|
-
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value
|
|
452
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
|
|
1209
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1210
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
453
1211
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
454
1212
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
455
|
-
companyUrl:
|
|
1213
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
456
1214
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
457
|
-
privacyPolicyUrl:
|
|
458
|
-
termsOfServiceUrl:
|
|
459
|
-
demoRecordingUrl:
|
|
1215
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1216
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1217
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
460
1218
|
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
|
|
461
|
-
serverUrl:
|
|
1219
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
462
1220
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
463
1221
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
464
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
465
|
-
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output.
|
|
466
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases
|
|
467
|
-
screenshots: z.array(screenshotEntrySchema).describe("In-app screenshots paired with the user prompt that produced them. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max
|
|
1222
|
+
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
1223
|
+
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
1224
|
+
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
1225
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
468
1226
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
469
|
-
allowedCountries: chatgptAllowedCountriesSchema.describe("
|
|
1227
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
470
1228
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
471
1229
|
});
|
|
1230
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1231
|
+
tagline: z.string().optional(),
|
|
1232
|
+
companyUrl: z.string().optional(),
|
|
1233
|
+
supportChannel: z.string().optional(),
|
|
1234
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1235
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1236
|
+
demoRecordingUrl: z.string().optional(),
|
|
1237
|
+
serverUrl: z.string().optional(),
|
|
1238
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1239
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1240
|
+
});
|
|
472
1241
|
chatgptSubmissionFormDataSchema.pick({
|
|
473
1242
|
appName: true,
|
|
474
1243
|
developerName: true,
|
|
@@ -485,7 +1254,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
485
1254
|
toolJustifications: true
|
|
486
1255
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
487
1256
|
const claudeCategorySchema = z.enum([
|
|
488
|
-
"
|
|
1257
|
+
"Productivity",
|
|
489
1258
|
"Communication",
|
|
490
1259
|
"Data & Analytics",
|
|
491
1260
|
"Development tools",
|
|
@@ -493,221 +1262,167 @@ const claudeCategorySchema = z.enum([
|
|
|
493
1262
|
"Consumer Health",
|
|
494
1263
|
"Health & Life Sciences",
|
|
495
1264
|
"Media & Entertainment",
|
|
496
|
-
"Commerce & Shopping"
|
|
1265
|
+
"Commerce & Shopping",
|
|
1266
|
+
"Legal",
|
|
1267
|
+
"Sales and marketing",
|
|
1268
|
+
"Creative",
|
|
1269
|
+
"Nonprofit",
|
|
1270
|
+
"Education",
|
|
1271
|
+
"Other"
|
|
497
1272
|
]);
|
|
498
|
-
const
|
|
499
|
-
"No auth needed",
|
|
500
|
-
"OAuth 2.0",
|
|
501
|
-
"Custom URL"
|
|
502
|
-
]);
|
|
503
|
-
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
504
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1273
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
505
1274
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
506
|
-
"
|
|
507
|
-
"
|
|
508
|
-
"
|
|
509
|
-
]);
|
|
510
|
-
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
511
|
-
const claudeTestedSurfaceSchema = z.enum([
|
|
512
|
-
"Claude.ai (web)",
|
|
513
|
-
"Claude Desktop",
|
|
514
|
-
"Claude Code",
|
|
515
|
-
"Cowork"
|
|
1275
|
+
"read_only",
|
|
1276
|
+
"write_only",
|
|
1277
|
+
"read_write"
|
|
516
1278
|
]);
|
|
517
|
-
const
|
|
518
|
-
"
|
|
519
|
-
"
|
|
520
|
-
"
|
|
521
|
-
"
|
|
522
|
-
"
|
|
1279
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1280
|
+
"oauth_dcr",
|
|
1281
|
+
"oauth_cimd",
|
|
1282
|
+
"oauth_anthropic_creds",
|
|
1283
|
+
"custom_connection",
|
|
1284
|
+
"none"
|
|
523
1285
|
]);
|
|
524
|
-
const
|
|
525
|
-
"
|
|
526
|
-
"
|
|
527
|
-
"
|
|
528
|
-
"GDPR compliant (if applicable)"
|
|
1286
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1287
|
+
"first_party",
|
|
1288
|
+
"proxied",
|
|
1289
|
+
"third_party"
|
|
529
1290
|
]);
|
|
530
|
-
const
|
|
531
|
-
|
|
532
|
-
"
|
|
533
|
-
"
|
|
1291
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1292
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1293
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1294
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1295
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1296
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1297
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1298
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1299
|
+
"Public documentation for this connector will be live by the publish date."
|
|
534
1300
|
]);
|
|
535
|
-
/**
|
|
536
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
537
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
538
|
-
*/
|
|
1301
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
539
1302
|
const claudeSubmissionFormDataSchema = z.object({
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
(
|
|
550
|
-
|
|
551
|
-
(
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
•
|
|
569
|
-
•
|
|
570
|
-
•
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
• '
|
|
586
|
-
• '
|
|
587
|
-
• '
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
|
|
615
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
616
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
617
|
-
• '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.
|
|
618
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
619
|
-
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:
|
|
620
|
-
• What the connector does and its key capabilities
|
|
621
|
-
• How to connect/set it up (step by step)
|
|
622
|
-
• What each tool does (or at least the main ones)
|
|
623
|
-
• How to troubleshoot common issues
|
|
624
|
-
• A support contact or channel
|
|
625
|
-
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.`),
|
|
626
|
-
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:
|
|
627
|
-
• What data you collect (and how)
|
|
628
|
-
• How you use the collected data
|
|
629
|
-
• Where and how long you store it
|
|
630
|
-
• Whether you share data with third parties (and who)
|
|
631
|
-
• How users can contact you about data concerns
|
|
632
|
-
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.`),
|
|
633
|
-
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:
|
|
634
|
-
• Email address (e.g. support@myapp.com)
|
|
635
|
-
• Link to a GitHub Issues page
|
|
636
|
-
• Link to a help center or support article
|
|
637
|
-
• Link to a Discord/Slack community
|
|
638
|
-
• Link to your documentation's troubleshooting section
|
|
639
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
640
|
-
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:
|
|
641
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
642
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
643
|
-
• 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.
|
|
644
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
645
|
-
• If your service requires API keys instead of a password, provide those.
|
|
646
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
647
|
-
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.
|
|
648
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
649
|
-
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.`),
|
|
650
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
651
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
652
|
-
• '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).
|
|
653
|
-
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.`),
|
|
654
|
-
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.`),
|
|
655
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
656
|
-
• Format: SVG only
|
|
657
|
-
• Aspect ratio: square (1:1)
|
|
658
|
-
• Should work on a light background
|
|
659
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
660
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
661
|
-
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.`),
|
|
662
|
-
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:
|
|
663
|
-
• 3–5 images is ideal
|
|
664
|
-
• Minimum 1000px width, PNG format preferred
|
|
665
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
666
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
667
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
668
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
669
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1303
|
+
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1304
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1305
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1306
|
+
name: z.string().max(100).describe(`The public display name for your connector as it appears in the directory. Use your brand/product name. You must
|
|
1307
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1308
|
+
slug: z.string().max(50).regex(/^[a-z0-9-]+$/).describe(`URL-safe identifier for your connector's directory page. Lowercase letters, numbers, and hyphens only.
|
|
1309
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1310
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1311
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1312
|
+
description: z.string().max(2e3).describe(`A description of what your connector does and its key features, shown on the connector's detail page in
|
|
1313
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1314
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1315
|
+
iconUrl: z.url().optional().describe(`Optional custom icon for the directory listing — a square SVG. By default the favicon from your MCP URL is used
|
|
1316
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1317
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1318
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1319
|
+
by your publish date.`),
|
|
1320
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1321
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1322
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1323
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1324
|
+
screenshots: z.array(screenshotEntrySchema).optional().describe(`Carousel images shown on your connector's directory page (PNG). Each is paired with the user prompt that produced
|
|
1325
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1326
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1327
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1328
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1329
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1330
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1331
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1332
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1333
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1334
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1335
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1336
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1337
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1338
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1339
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1340
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1341
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1342
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1343
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1344
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1345
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1346
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1347
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1348
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1349
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1350
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1351
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1352
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1353
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1354
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1355
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1356
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1357
|
+
fully populated account.`),
|
|
1358
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1359
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1360
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1361
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1362
|
+
});
|
|
1363
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1364
|
+
serverUrl: z.string().optional(),
|
|
1365
|
+
name: z.string().optional(),
|
|
1366
|
+
slug: z.string().optional(),
|
|
1367
|
+
oneLiner: z.string().optional(),
|
|
1368
|
+
description: z.string().optional(),
|
|
1369
|
+
iconUrl: z.string().optional(),
|
|
1370
|
+
documentation: z.string().optional(),
|
|
1371
|
+
support: z.string().optional(),
|
|
1372
|
+
privacyPolicy: z.string().optional(),
|
|
1373
|
+
companyWebsite: z.string().optional(),
|
|
1374
|
+
primaryContactEmail: z.string().optional(),
|
|
1375
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1376
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
670
1377
|
});
|
|
671
1378
|
claudeSubmissionFormDataSchema.pick({
|
|
672
|
-
companyName: true,
|
|
673
|
-
appName: true,
|
|
674
|
-
mcpUrlType: true,
|
|
675
1379
|
serverUrl: true,
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
transportSupport: true,
|
|
1380
|
+
name: true,
|
|
1381
|
+
slug: true,
|
|
1382
|
+
companyName: true,
|
|
680
1383
|
primaryContactEmail: true,
|
|
681
1384
|
primaryContactName: true,
|
|
1385
|
+
readWriteCapabilities: true,
|
|
682
1386
|
authentication: true,
|
|
683
|
-
|
|
684
|
-
|
|
1387
|
+
apiOwnership: true,
|
|
1388
|
+
personalHealthData: true
|
|
685
1389
|
}).extend({
|
|
686
1390
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
687
|
-
|
|
1391
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1392
|
+
});
|
|
1393
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1394
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1395
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1396
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1397
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1398
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1399
|
+
});
|
|
1400
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1401
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1402
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
688
1403
|
});
|
|
689
|
-
claudeSubmissionFormDataSchema.pick({
|
|
690
|
-
tagline: true,
|
|
691
|
-
description: true,
|
|
692
|
-
category: true,
|
|
693
|
-
testCases: true
|
|
694
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
695
1404
|
const submissionMetaFieldsSchema = z.object({
|
|
696
1405
|
id: z.string(),
|
|
697
1406
|
environmentId: z.string(),
|
|
1407
|
+
auditId: z.string().nullable(),
|
|
698
1408
|
createdAt: z.coerce.date(),
|
|
699
1409
|
updatedAt: z.coerce.date()
|
|
700
1410
|
});
|
|
701
1411
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
702
1412
|
platform: z.literal("claudeai"),
|
|
703
|
-
formData:
|
|
1413
|
+
formData: claudeSubmissionDraftSchema
|
|
704
1414
|
});
|
|
705
1415
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
706
1416
|
platform: z.literal("chatgpt"),
|
|
707
|
-
formData:
|
|
1417
|
+
formData: chatgptSubmissionDraftSchema
|
|
708
1418
|
});
|
|
709
1419
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
710
|
-
z.union([
|
|
1420
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1421
|
+
z.literal([
|
|
1422
|
+
100,
|
|
1423
|
+
75,
|
|
1424
|
+
50
|
|
1425
|
+
]);
|
|
711
1426
|
const subscriptionPlanSchema = z.enum([
|
|
712
1427
|
"pro",
|
|
713
1428
|
"business",
|
|
@@ -731,6 +1446,12 @@ z.object({
|
|
|
731
1446
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
732
1447
|
});
|
|
733
1448
|
//#endregion
|
|
1449
|
+
//#region src/auth-scope.ts
|
|
1450
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1451
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1452
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1453
|
+
const AUTH_SCOPE_USER = "user";
|
|
1454
|
+
//#endregion
|
|
734
1455
|
//#region src/schemas.ts
|
|
735
1456
|
const RESERVED_KEYS = [
|
|
736
1457
|
"_HANDLER",
|
|
@@ -766,7 +1487,10 @@ const RESERVED_KEYS = [
|
|
|
766
1487
|
"BUILD_ARG_START_COMMAND",
|
|
767
1488
|
"ALPIC_HOST",
|
|
768
1489
|
"ALPIC_CUSTOM_DOMAINS",
|
|
769
|
-
"ALPIC_INTENT_META_KEY"
|
|
1490
|
+
"ALPIC_INTENT_META_KEY",
|
|
1491
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1492
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1493
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
770
1494
|
];
|
|
771
1495
|
const environmentVariableSchema = z.object({
|
|
772
1496
|
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"),
|
|
@@ -847,21 +1571,20 @@ const deploymentSchema = z.object({
|
|
|
847
1571
|
isCurrent: z.boolean(),
|
|
848
1572
|
deploymentPageUrl: z.url().nullable()
|
|
849
1573
|
});
|
|
850
|
-
const
|
|
1574
|
+
const isValidTimeInput = (value) => {
|
|
851
1575
|
if (ms(value) !== void 0) return true;
|
|
852
1576
|
return !Number.isNaN(new Date(value).getTime());
|
|
853
1577
|
};
|
|
854
|
-
const
|
|
1578
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1579
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1580
|
+
const createEnvironmentContractV1 = base.route({
|
|
855
1581
|
path: "/v1/environments",
|
|
856
1582
|
method: "POST",
|
|
857
1583
|
summary: "Create an environment",
|
|
858
1584
|
description: "Create an environment for a project",
|
|
859
1585
|
tags: ["environments"],
|
|
860
1586
|
successDescription: "The environment has been created successfully"
|
|
861
|
-
}).errors({
|
|
862
|
-
NOT_FOUND: {},
|
|
863
|
-
BAD_REQUEST: {}
|
|
864
|
-
}).input(z.object({
|
|
1587
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
865
1588
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
866
1589
|
name: z.string().min(1).describe("The name of the environment"),
|
|
867
1590
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -870,11 +1593,11 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
870
1593
|
id: z.string(),
|
|
871
1594
|
name: z.string(),
|
|
872
1595
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
873
|
-
urls: z.array(z.
|
|
1596
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
874
1597
|
createdAt: z.coerce.date(),
|
|
875
1598
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
876
1599
|
}));
|
|
877
|
-
const getEnvironmentContractV1 =
|
|
1600
|
+
const getEnvironmentContractV1 = base.route({
|
|
878
1601
|
path: "/v1/environments/{environmentId}",
|
|
879
1602
|
method: "GET",
|
|
880
1603
|
summary: "Get an environment",
|
|
@@ -931,7 +1654,7 @@ const projectOutputSchema = z.object({
|
|
|
931
1654
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
932
1655
|
environments: z.array(environmentSchema)
|
|
933
1656
|
});
|
|
934
|
-
const getProjectContractV1 =
|
|
1657
|
+
const getProjectContractV1 = base.route({
|
|
935
1658
|
path: "/v1/projects/{projectId}",
|
|
936
1659
|
method: "GET",
|
|
937
1660
|
summary: "Get a project",
|
|
@@ -939,15 +1662,15 @@ const getProjectContractV1 = oc.route({
|
|
|
939
1662
|
tags: ["projects"],
|
|
940
1663
|
successDescription: "The project details"
|
|
941
1664
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
942
|
-
const listProjectsContractV1 =
|
|
1665
|
+
const listProjectsContractV1 = base.route({
|
|
943
1666
|
path: "/v1/projects",
|
|
944
1667
|
method: "GET",
|
|
945
1668
|
summary: "List projects",
|
|
946
1669
|
description: "List all projects for a team",
|
|
947
1670
|
tags: ["projects"],
|
|
948
1671
|
successDescription: "The list of projects"
|
|
949
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
950
|
-
const createProjectContractV1 =
|
|
1672
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1673
|
+
const createProjectContractV1 = base.route({
|
|
951
1674
|
path: "/v1/projects",
|
|
952
1675
|
method: "POST",
|
|
953
1676
|
summary: "Create a project",
|
|
@@ -956,7 +1679,7 @@ const createProjectContractV1 = oc.route({
|
|
|
956
1679
|
successDescription: "The project has been created successfully"
|
|
957
1680
|
}).errors({
|
|
958
1681
|
NOT_FOUND: {},
|
|
959
|
-
|
|
1682
|
+
FORBIDDEN: {}
|
|
960
1683
|
}).input(z.object({
|
|
961
1684
|
teamId: z.string().optional(),
|
|
962
1685
|
name: z.string().trim().min(1).max(100),
|
|
@@ -996,7 +1719,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
996
1719
|
isSecret: z.boolean(),
|
|
997
1720
|
createdAt: z.coerce.date()
|
|
998
1721
|
});
|
|
999
|
-
const listEnvironmentVariablesContractV1 =
|
|
1722
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1000
1723
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1001
1724
|
method: "GET",
|
|
1002
1725
|
summary: "List environment variables",
|
|
@@ -1004,37 +1727,31 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1004
1727
|
tags: ["environments"],
|
|
1005
1728
|
successDescription: "The list of environment variables"
|
|
1006
1729
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1007
|
-
const createEnvironmentVariablesContractV1 =
|
|
1730
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1008
1731
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1009
1732
|
method: "POST",
|
|
1010
1733
|
summary: "Add environment variables",
|
|
1011
1734
|
description: "Add one or more environment variables to an environment",
|
|
1012
1735
|
tags: ["environments"],
|
|
1013
1736
|
successDescription: "The environment variables have been added successfully"
|
|
1014
|
-
}).errors({
|
|
1015
|
-
NOT_FOUND: {},
|
|
1016
|
-
BAD_REQUEST: {}
|
|
1017
|
-
}).input(z.object({
|
|
1737
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1018
1738
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1019
1739
|
environmentVariables: environmentVariablesSchema
|
|
1020
1740
|
})).output(z.object({ success: z.literal(true) }));
|
|
1021
|
-
const updateEnvironmentVariableContractV1 =
|
|
1741
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1022
1742
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1023
1743
|
method: "PATCH",
|
|
1024
1744
|
summary: "Update an environment variable",
|
|
1025
1745
|
description: "Update an environment variable by ID",
|
|
1026
1746
|
tags: ["environments"],
|
|
1027
1747
|
successDescription: "The environment variable has been updated successfully"
|
|
1028
|
-
}).errors({
|
|
1029
|
-
NOT_FOUND: {},
|
|
1030
|
-
BAD_REQUEST: {}
|
|
1031
|
-
}).input(z.object({
|
|
1748
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1032
1749
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1033
1750
|
key: environmentVariableSchema.shape.key,
|
|
1034
1751
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1035
1752
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1036
1753
|
})).output(z.object({ success: z.literal(true) }));
|
|
1037
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1754
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1038
1755
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1039
1756
|
method: "DELETE",
|
|
1040
1757
|
summary: "Delete an environment variable",
|
|
@@ -1042,7 +1759,7 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
1042
1759
|
tags: ["environments"],
|
|
1043
1760
|
successDescription: "The environment variable has been deleted successfully"
|
|
1044
1761
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1045
|
-
const deleteProjectContractV1 =
|
|
1762
|
+
const deleteProjectContractV1 = base.route({
|
|
1046
1763
|
path: "/v1/projects/{projectId}",
|
|
1047
1764
|
method: "DELETE",
|
|
1048
1765
|
summary: "Delete a project",
|
|
@@ -1050,7 +1767,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1050
1767
|
tags: ["projects"],
|
|
1051
1768
|
successDescription: "The project has been deleted successfully"
|
|
1052
1769
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1053
|
-
const updateProjectContractV1 =
|
|
1770
|
+
const updateProjectContractV1 = base.route({
|
|
1054
1771
|
path: "/v1/projects/{projectId}",
|
|
1055
1772
|
method: "PATCH",
|
|
1056
1773
|
summary: "Update a project",
|
|
@@ -1059,13 +1776,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1059
1776
|
successDescription: "The project has been updated successfully"
|
|
1060
1777
|
}).errors({
|
|
1061
1778
|
NOT_FOUND: {},
|
|
1062
|
-
|
|
1779
|
+
FORBIDDEN: {}
|
|
1063
1780
|
}).input(z.object({
|
|
1064
1781
|
projectId: z.string().describe("The ID of the project"),
|
|
1065
1782
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1066
1783
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1067
1784
|
})).output(projectOutputSchema);
|
|
1068
|
-
const deployEnvironmentContractV1 =
|
|
1785
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1069
1786
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1070
1787
|
method: "POST",
|
|
1071
1788
|
summary: "Deploy an environment",
|
|
@@ -1074,24 +1791,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1074
1791
|
successDescription: "The environment has been deployed successfully"
|
|
1075
1792
|
}).errors({
|
|
1076
1793
|
NOT_FOUND: {},
|
|
1077
|
-
|
|
1794
|
+
CONFLICT: {}
|
|
1078
1795
|
}).input(z.object({
|
|
1079
1796
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1080
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1797
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1798
|
+
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.")
|
|
1081
1799
|
})).output(deploymentSchema);
|
|
1082
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1800
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1083
1801
|
path: "/v1/deployments/upload",
|
|
1084
1802
|
method: "POST",
|
|
1085
1803
|
summary: "Upload deployment artifacts",
|
|
1086
1804
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1087
1805
|
tags: ["deployments"],
|
|
1088
1806
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1089
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1807
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1090
1808
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1091
1809
|
token: z.string().describe("Token to identify the source archive"),
|
|
1092
1810
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1093
1811
|
}));
|
|
1094
|
-
const listDeploymentsContractV1 =
|
|
1812
|
+
const listDeploymentsContractV1 = base.route({
|
|
1095
1813
|
path: "/v1/projects/{projectId}/deployments",
|
|
1096
1814
|
method: "GET",
|
|
1097
1815
|
summary: "List project deployments",
|
|
@@ -1103,7 +1821,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1103
1821
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1104
1822
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1105
1823
|
})).output(z.array(deploymentSchema));
|
|
1106
|
-
const getDeploymentContractV1 =
|
|
1824
|
+
const getDeploymentContractV1 = base.route({
|
|
1107
1825
|
path: "/v1/deployments/{deploymentId}",
|
|
1108
1826
|
method: "GET",
|
|
1109
1827
|
summary: "Get a deployment",
|
|
@@ -1111,20 +1829,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1111
1829
|
tags: ["deployments"],
|
|
1112
1830
|
successDescription: "The deployment details"
|
|
1113
1831
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1114
|
-
const
|
|
1832
|
+
const logEntrySchema = z.object({
|
|
1833
|
+
timestamp: z.coerce.date(),
|
|
1834
|
+
type: z.enum([
|
|
1835
|
+
"START",
|
|
1836
|
+
"END",
|
|
1837
|
+
"INFO",
|
|
1838
|
+
"ERROR",
|
|
1839
|
+
"WARNING",
|
|
1840
|
+
"DEBUG"
|
|
1841
|
+
]),
|
|
1842
|
+
requestId: z.string(),
|
|
1843
|
+
content: z.string().optional(),
|
|
1844
|
+
method: z.string().optional(),
|
|
1845
|
+
durationInMs: z.number().optional()
|
|
1846
|
+
});
|
|
1847
|
+
const getLogsContractV1 = base.route({
|
|
1115
1848
|
path: "/v1/environments/{environmentId}/logs",
|
|
1116
1849
|
method: "GET",
|
|
1117
1850
|
summary: "Get logs",
|
|
1118
1851
|
description: "Get logs for an environment",
|
|
1119
1852
|
tags: ["environments"],
|
|
1120
1853
|
successDescription: "The logs"
|
|
1121
|
-
}).errors({
|
|
1122
|
-
NOT_FOUND: {},
|
|
1123
|
-
BAD_REQUEST: {}
|
|
1124
|
-
}).input(z.object({
|
|
1854
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1125
1855
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1126
|
-
since:
|
|
1127
|
-
until:
|
|
1856
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1857
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1128
1858
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1129
1859
|
level: z.array(z.enum([
|
|
1130
1860
|
"INFO",
|
|
@@ -1135,34 +1865,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1135
1865
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1136
1866
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1137
1867
|
})).output(z.object({
|
|
1138
|
-
logs: z.array(
|
|
1139
|
-
timestamp: z.coerce.date(),
|
|
1140
|
-
type: z.enum([
|
|
1141
|
-
"START",
|
|
1142
|
-
"END",
|
|
1143
|
-
"INFO",
|
|
1144
|
-
"ERROR",
|
|
1145
|
-
"WARNING",
|
|
1146
|
-
"DEBUG"
|
|
1147
|
-
]),
|
|
1148
|
-
requestId: z.string(),
|
|
1149
|
-
content: z.string().optional(),
|
|
1150
|
-
method: z.string().optional(),
|
|
1151
|
-
durationInMs: z.number().optional()
|
|
1152
|
-
})),
|
|
1868
|
+
logs: z.array(logEntrySchema),
|
|
1153
1869
|
nextToken: z.string().nullable()
|
|
1154
1870
|
}));
|
|
1155
|
-
const getLatestLogsContractV1 =
|
|
1871
|
+
const getLatestLogsContractV1 = base.route({
|
|
1156
1872
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1157
1873
|
method: "GET",
|
|
1158
1874
|
summary: "Get latest logs",
|
|
1159
1875
|
description: "Get the N most recent logs for an environment",
|
|
1160
1876
|
tags: ["environments"],
|
|
1161
1877
|
successDescription: "The latest logs"
|
|
1162
|
-
}).errors({
|
|
1163
|
-
NOT_FOUND: {},
|
|
1164
|
-
BAD_REQUEST: {}
|
|
1165
|
-
}).input(z.object({
|
|
1878
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1166
1879
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1167
1880
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1168
1881
|
level: z.array(z.enum([
|
|
@@ -1172,22 +1885,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1172
1885
|
"DEBUG"
|
|
1173
1886
|
])).optional().describe("Filter by log level"),
|
|
1174
1887
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1175
|
-
})).output(z.object({ logs: z.array(
|
|
1176
|
-
|
|
1177
|
-
type: z.enum([
|
|
1178
|
-
"START",
|
|
1179
|
-
"END",
|
|
1180
|
-
"INFO",
|
|
1181
|
-
"ERROR",
|
|
1182
|
-
"WARNING",
|
|
1183
|
-
"DEBUG"
|
|
1184
|
-
]),
|
|
1185
|
-
requestId: z.string(),
|
|
1186
|
-
content: z.string().optional(),
|
|
1187
|
-
method: z.string().optional(),
|
|
1188
|
-
durationInMs: z.number().optional()
|
|
1189
|
-
})) }));
|
|
1190
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1888
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1889
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1191
1890
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1192
1891
|
method: "GET",
|
|
1193
1892
|
summary: "Get deployment logs",
|
|
@@ -1214,17 +1913,14 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1214
1913
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1215
1914
|
task_count: z.array(analyticsDataPointSchema)
|
|
1216
1915
|
});
|
|
1217
|
-
const getProjectAnalyticsContractV1 =
|
|
1916
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1218
1917
|
path: "/v1/analytics/{projectId}",
|
|
1219
1918
|
method: "GET",
|
|
1220
1919
|
summary: "Get project analytics",
|
|
1221
1920
|
description: "Get analytics data for a project over a time range",
|
|
1222
1921
|
tags: ["analytics"],
|
|
1223
1922
|
successDescription: "The project analytics data"
|
|
1224
|
-
}).errors({
|
|
1225
|
-
NOT_FOUND: {},
|
|
1226
|
-
BAD_REQUEST: {}
|
|
1227
|
-
}).input(z.object({
|
|
1923
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1228
1924
|
projectId: z.string().describe("The ID of the project"),
|
|
1229
1925
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1230
1926
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
@@ -1239,7 +1935,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1239
1935
|
}),
|
|
1240
1936
|
timeSeries: analyticsTimeSeriesSchema
|
|
1241
1937
|
}));
|
|
1242
|
-
const
|
|
1938
|
+
const paginatedInsightsInputShape = {
|
|
1939
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1940
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1941
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1942
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1943
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1944
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1945
|
+
};
|
|
1946
|
+
const listIntentsContractV1 = base.route({
|
|
1947
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1948
|
+
method: "GET",
|
|
1949
|
+
summary: "List intents",
|
|
1950
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1951
|
+
tags: ["insights"],
|
|
1952
|
+
successDescription: "The grouped user intents"
|
|
1953
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1954
|
+
...paginatedInsightsInputShape,
|
|
1955
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1956
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
1957
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1958
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
1959
|
+
})).output(z.object({
|
|
1960
|
+
intents: z.array(z.object({
|
|
1961
|
+
id: z.string(),
|
|
1962
|
+
intentIds: z.array(z.string()).min(1),
|
|
1963
|
+
environmentId: z.string(),
|
|
1964
|
+
message: z.string(),
|
|
1965
|
+
toolName: z.string(),
|
|
1966
|
+
createdAt: z.coerce.date(),
|
|
1967
|
+
occurrenceCount: z.number().int().positive(),
|
|
1968
|
+
clientName: z.string().nullable(),
|
|
1969
|
+
clientId: z.string().nullable(),
|
|
1970
|
+
categories: z.array(z.object({
|
|
1971
|
+
id: z.string(),
|
|
1972
|
+
name: z.string(),
|
|
1973
|
+
color: intentCategoryColorSchema
|
|
1974
|
+
}))
|
|
1975
|
+
})),
|
|
1976
|
+
totalCount: z.number().int().nonnegative()
|
|
1977
|
+
}));
|
|
1978
|
+
const listFeedbacksContractV1 = base.route({
|
|
1979
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
1980
|
+
method: "GET",
|
|
1981
|
+
summary: "List feedbacks",
|
|
1982
|
+
description: "List user feedback for an environment over a time range",
|
|
1983
|
+
tags: ["insights"],
|
|
1984
|
+
successDescription: "The user feedback"
|
|
1985
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1986
|
+
...paginatedInsightsInputShape,
|
|
1987
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
1988
|
+
})).output(z.object({
|
|
1989
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
1990
|
+
totalCount: z.number().int().nonnegative()
|
|
1991
|
+
}));
|
|
1992
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
1993
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
1994
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
1995
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
1996
|
+
method: "GET",
|
|
1997
|
+
summary: "List intent categories",
|
|
1998
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
1999
|
+
tags: ["insights"],
|
|
2000
|
+
successDescription: "The intent categories"
|
|
2001
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2002
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2003
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2004
|
+
method: "POST",
|
|
2005
|
+
summary: "Create an intent category",
|
|
2006
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2007
|
+
tags: ["insights"],
|
|
2008
|
+
successDescription: "The created intent category"
|
|
2009
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2010
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2011
|
+
name: intentCategoryNameSchema,
|
|
2012
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2013
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2014
|
+
})).output(intentCategorySchema);
|
|
2015
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2016
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2017
|
+
method: "PATCH",
|
|
2018
|
+
summary: "Update an intent category",
|
|
2019
|
+
description: "Rename or recolor an intent category",
|
|
2020
|
+
tags: ["insights"],
|
|
2021
|
+
successDescription: "The updated intent category"
|
|
2022
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2023
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2024
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2025
|
+
name: intentCategoryNameSchema.optional(),
|
|
2026
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2027
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2028
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2029
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2030
|
+
method: "DELETE",
|
|
2031
|
+
summary: "Delete an intent category",
|
|
2032
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2033
|
+
tags: ["insights"],
|
|
2034
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2035
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2036
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2037
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2038
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2039
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2040
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2041
|
+
method: "POST",
|
|
2042
|
+
summary: "Link an intent category",
|
|
2043
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2044
|
+
tags: ["insights"],
|
|
2045
|
+
successDescription: "The intents have been linked successfully"
|
|
2046
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2047
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2048
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2049
|
+
intentIds: categorizableIntentIdsSchema
|
|
2050
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2051
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2052
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2053
|
+
method: "POST",
|
|
2054
|
+
summary: "Unlink an intent category",
|
|
2055
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2056
|
+
tags: ["insights"],
|
|
2057
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2058
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2059
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2060
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2061
|
+
intentIds: categorizableIntentIdsSchema
|
|
2062
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2063
|
+
const listTeamsContractV1 = base.route({
|
|
1243
2064
|
path: "/v1/teams",
|
|
1244
2065
|
method: "GET",
|
|
1245
2066
|
summary: "List teams",
|
|
@@ -1252,28 +2073,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
1252
2073
|
createdAt: z.coerce.date(),
|
|
1253
2074
|
hasStripeAccount: z.boolean()
|
|
1254
2075
|
})));
|
|
1255
|
-
const
|
|
2076
|
+
const getTeamUsageContractV1 = base.route({
|
|
2077
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2078
|
+
method: "GET",
|
|
2079
|
+
summary: "Get team usage",
|
|
2080
|
+
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.",
|
|
2081
|
+
tags: ["teams"],
|
|
2082
|
+
successDescription: "The current billing window usage"
|
|
2083
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2084
|
+
teamId: z.string(),
|
|
2085
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2086
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2087
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2088
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2089
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2090
|
+
}));
|
|
2091
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1256
2092
|
path: "/v1/tunnels/ticket",
|
|
1257
2093
|
method: "GET",
|
|
1258
2094
|
summary: "Get a tunnel ticket",
|
|
1259
2095
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1260
2096
|
tags: ["tunnels"],
|
|
1261
2097
|
successDescription: "The tunnel ticket"
|
|
1262
|
-
}).output(z.object({
|
|
2098
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1263
2099
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1264
2100
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1265
2101
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1266
2102
|
}));
|
|
1267
|
-
const publishServerContractV1 =
|
|
2103
|
+
const publishServerContractV1 = base.route({
|
|
1268
2104
|
path: "/v1/distribution/publish",
|
|
1269
2105
|
method: "POST",
|
|
1270
2106
|
summary: "Publish a server to the MCP registry",
|
|
1271
2107
|
tags: ["distribution"],
|
|
1272
2108
|
successDescription: "The server has been published successfully"
|
|
1273
|
-
}).errors({
|
|
1274
|
-
NOT_FOUND: {},
|
|
1275
|
-
BAD_REQUEST: {}
|
|
1276
|
-
}).input(z.object({
|
|
2109
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1277
2110
|
projectId: z.string(),
|
|
1278
2111
|
domain: z.string(),
|
|
1279
2112
|
title: z.string().min(1).max(100),
|
|
@@ -1282,17 +2115,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1282
2115
|
iconSrc: z.url().max(255).optional(),
|
|
1283
2116
|
dryRun: z.boolean().optional()
|
|
1284
2117
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1285
|
-
const getServerInfoContractV1 =
|
|
2118
|
+
const getServerInfoContractV1 = base.route({
|
|
1286
2119
|
path: "/v1/distribution/get",
|
|
1287
2120
|
method: "GET",
|
|
1288
2121
|
summary: "Get server info",
|
|
1289
2122
|
description: "Get info about a server",
|
|
1290
2123
|
tags: ["distribution"],
|
|
1291
2124
|
successDescription: "The server info"
|
|
1292
|
-
}).errors({
|
|
1293
|
-
NOT_FOUND: {},
|
|
1294
|
-
BAD_REQUEST: {}
|
|
1295
|
-
}).input(z.object({
|
|
2125
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1296
2126
|
projectId: z.string(),
|
|
1297
2127
|
domain: z.string()
|
|
1298
2128
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1311,7 +2141,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1311
2141
|
isPlaygroundEnabled: z.boolean(),
|
|
1312
2142
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1313
2143
|
});
|
|
1314
|
-
const getPlaygroundContractV1 =
|
|
2144
|
+
const getPlaygroundContractV1 = base.route({
|
|
1315
2145
|
path: "/v1/environments/{environmentId}/playground",
|
|
1316
2146
|
method: "GET",
|
|
1317
2147
|
summary: "Get playground configuration",
|
|
@@ -1319,25 +2149,22 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1319
2149
|
tags: ["environments"],
|
|
1320
2150
|
successDescription: "The playground configuration"
|
|
1321
2151
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1322
|
-
const upsertPlaygroundContractV1 =
|
|
2152
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1323
2153
|
path: "/v1/environments/{environmentId}/playground",
|
|
1324
2154
|
method: "PUT",
|
|
1325
2155
|
summary: "Update playground configuration",
|
|
1326
2156
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1327
2157
|
tags: ["environments"],
|
|
1328
2158
|
successDescription: "The updated playground configuration"
|
|
1329
|
-
}).errors({
|
|
1330
|
-
NOT_FOUND: {},
|
|
1331
|
-
BAD_REQUEST: {}
|
|
1332
|
-
}).input(z.object({
|
|
2159
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1333
2160
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1334
2161
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1335
2162
|
name: z.string().min(1).max(100).optional(),
|
|
1336
2163
|
description: z.string().min(1).max(500).optional(),
|
|
1337
2164
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1338
|
-
examplePrompts: z.array(playgroundExamplePromptSchema).max(
|
|
2165
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1339
2166
|
})).output(playgroundOutputSchema);
|
|
1340
|
-
const createBeaconContractV1 =
|
|
2167
|
+
const createBeaconContractV1 = base.route({
|
|
1341
2168
|
path: "/v1/beacon/audits",
|
|
1342
2169
|
method: "POST",
|
|
1343
2170
|
summary: "Create a beacon audit",
|
|
@@ -1346,7 +2173,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1346
2173
|
successDescription: "The audit has been created"
|
|
1347
2174
|
}).errors({
|
|
1348
2175
|
NOT_FOUND: {},
|
|
1349
|
-
BAD_REQUEST: {},
|
|
1350
2176
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1351
2177
|
}).input(z.object({
|
|
1352
2178
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1354,7 +2180,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1354
2180
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1355
2181
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1356
2182
|
})).output(z.object({ id: z.string() }));
|
|
1357
|
-
const getBeaconContractV1 =
|
|
2183
|
+
const getBeaconContractV1 = base.route({
|
|
1358
2184
|
path: "/v1/beacon/audits/{auditId}",
|
|
1359
2185
|
method: "GET",
|
|
1360
2186
|
summary: "Get a beacon audit",
|
|
@@ -1370,8 +2196,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1370
2196
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1371
2197
|
}));
|
|
1372
2198
|
const contract = {
|
|
1373
|
-
teams: {
|
|
2199
|
+
teams: {
|
|
2200
|
+
list: { v1: listTeamsContractV1 },
|
|
2201
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2202
|
+
},
|
|
1374
2203
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2204
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2205
|
+
intentCategories: {
|
|
2206
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2207
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2208
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2209
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2210
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2211
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2212
|
+
},
|
|
2213
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1375
2214
|
deployments: {
|
|
1376
2215
|
list: { v1: listDeploymentsContractV1 },
|
|
1377
2216
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1412,5 +2251,10 @@ const contract = {
|
|
|
1412
2251
|
get: { v1: getBeaconContractV1 }
|
|
1413
2252
|
}
|
|
1414
2253
|
};
|
|
2254
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2255
|
+
const contractForDocs = {
|
|
2256
|
+
...contract,
|
|
2257
|
+
deployments: deploymentsForDocs
|
|
2258
|
+
};
|
|
1415
2259
|
//#endregion
|
|
1416
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2260
|
+
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 };
|