@alpic-ai/api 0.0.0-dev.geef385d → 0.0.0-dev.gef12e79
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 +1573 -77
- package/dist/index.mjs +1510 -318
- package/package.json +17 -10
package/dist/index.mjs
CHANGED
|
@@ -1,11 +1,189 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
|
+
import * as z$1 from "zod/v4";
|
|
2
3
|
import { oc } from "@orpc/contract";
|
|
3
4
|
import ms from "ms";
|
|
4
|
-
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
|
+
/**
|
|
7
|
+
* Reusable URL validation that disallows javascript: scheme
|
|
8
|
+
*/
|
|
9
|
+
const SafeUrlSchema = z$1.url().superRefine((val, ctx) => {
|
|
10
|
+
if (!URL.canParse(val)) {
|
|
11
|
+
ctx.addIssue({
|
|
12
|
+
code: z$1.ZodIssueCode.custom,
|
|
13
|
+
message: "URL must be parseable",
|
|
14
|
+
fatal: true
|
|
15
|
+
});
|
|
16
|
+
return z$1.NEVER;
|
|
17
|
+
}
|
|
18
|
+
}).refine((url) => {
|
|
19
|
+
const u = new URL(url);
|
|
20
|
+
return u.protocol !== "javascript:" && u.protocol !== "data:" && u.protocol !== "vbscript:";
|
|
21
|
+
}, { message: "URL cannot use javascript:, data:, or vbscript: scheme" });
|
|
22
|
+
/**
|
|
23
|
+
* RFC 9728 OAuth Protected Resource Metadata
|
|
24
|
+
*/
|
|
25
|
+
const OAuthProtectedResourceMetadataSchema = z$1.looseObject({
|
|
26
|
+
resource: z$1.string().url(),
|
|
27
|
+
authorization_servers: z$1.array(SafeUrlSchema).optional(),
|
|
28
|
+
jwks_uri: z$1.string().url().optional(),
|
|
29
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
30
|
+
bearer_methods_supported: z$1.array(z$1.string()).optional(),
|
|
31
|
+
resource_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
32
|
+
resource_name: z$1.string().optional(),
|
|
33
|
+
resource_documentation: z$1.string().optional(),
|
|
34
|
+
resource_policy_uri: z$1.string().url().optional(),
|
|
35
|
+
resource_tos_uri: z$1.string().url().optional(),
|
|
36
|
+
tls_client_certificate_bound_access_tokens: z$1.boolean().optional(),
|
|
37
|
+
authorization_details_types_supported: z$1.array(z$1.string()).optional(),
|
|
38
|
+
dpop_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
39
|
+
dpop_bound_access_tokens_required: z$1.boolean().optional()
|
|
40
|
+
});
|
|
41
|
+
/**
|
|
42
|
+
* RFC 8414 OAuth 2.0 Authorization Server Metadata
|
|
43
|
+
*/
|
|
44
|
+
const OAuthMetadataSchema = z$1.looseObject({
|
|
45
|
+
issuer: z$1.string(),
|
|
46
|
+
authorization_endpoint: SafeUrlSchema,
|
|
47
|
+
token_endpoint: SafeUrlSchema,
|
|
48
|
+
registration_endpoint: SafeUrlSchema.optional(),
|
|
49
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
50
|
+
response_types_supported: z$1.array(z$1.string()),
|
|
51
|
+
response_modes_supported: z$1.array(z$1.string()).optional(),
|
|
52
|
+
grant_types_supported: z$1.array(z$1.string()).optional(),
|
|
53
|
+
token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
54
|
+
token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
55
|
+
service_documentation: SafeUrlSchema.optional(),
|
|
56
|
+
revocation_endpoint: SafeUrlSchema.optional(),
|
|
57
|
+
revocation_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
58
|
+
revocation_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
59
|
+
introspection_endpoint: z$1.string().optional(),
|
|
60
|
+
introspection_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
61
|
+
introspection_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
62
|
+
code_challenge_methods_supported: z$1.array(z$1.string()).optional(),
|
|
63
|
+
client_id_metadata_document_supported: z$1.boolean().optional()
|
|
64
|
+
});
|
|
65
|
+
/**
|
|
66
|
+
* OpenID Connect Discovery 1.0 Provider Metadata
|
|
67
|
+
* see: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
|
|
68
|
+
*/
|
|
69
|
+
const OpenIdProviderMetadataSchema = z$1.looseObject({
|
|
70
|
+
issuer: z$1.string(),
|
|
71
|
+
authorization_endpoint: SafeUrlSchema,
|
|
72
|
+
token_endpoint: SafeUrlSchema,
|
|
73
|
+
userinfo_endpoint: SafeUrlSchema.optional(),
|
|
74
|
+
jwks_uri: SafeUrlSchema,
|
|
75
|
+
registration_endpoint: SafeUrlSchema.optional(),
|
|
76
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
77
|
+
response_types_supported: z$1.array(z$1.string()),
|
|
78
|
+
response_modes_supported: z$1.array(z$1.string()).optional(),
|
|
79
|
+
grant_types_supported: z$1.array(z$1.string()).optional(),
|
|
80
|
+
acr_values_supported: z$1.array(z$1.string()).optional(),
|
|
81
|
+
subject_types_supported: z$1.array(z$1.string()),
|
|
82
|
+
id_token_signing_alg_values_supported: z$1.array(z$1.string()),
|
|
83
|
+
id_token_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
84
|
+
id_token_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
85
|
+
userinfo_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
86
|
+
userinfo_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
87
|
+
userinfo_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
88
|
+
request_object_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
89
|
+
request_object_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
90
|
+
request_object_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
91
|
+
token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
92
|
+
token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
93
|
+
display_values_supported: z$1.array(z$1.string()).optional(),
|
|
94
|
+
claim_types_supported: z$1.array(z$1.string()).optional(),
|
|
95
|
+
claims_supported: z$1.array(z$1.string()).optional(),
|
|
96
|
+
service_documentation: z$1.string().optional(),
|
|
97
|
+
claims_locales_supported: z$1.array(z$1.string()).optional(),
|
|
98
|
+
ui_locales_supported: z$1.array(z$1.string()).optional(),
|
|
99
|
+
claims_parameter_supported: z$1.boolean().optional(),
|
|
100
|
+
request_parameter_supported: z$1.boolean().optional(),
|
|
101
|
+
request_uri_parameter_supported: z$1.boolean().optional(),
|
|
102
|
+
require_request_uri_registration: z$1.boolean().optional(),
|
|
103
|
+
op_policy_uri: SafeUrlSchema.optional(),
|
|
104
|
+
op_tos_uri: SafeUrlSchema.optional(),
|
|
105
|
+
client_id_metadata_document_supported: z$1.boolean().optional()
|
|
106
|
+
});
|
|
107
|
+
/**
|
|
108
|
+
* OpenID Connect Discovery metadata that may include OAuth 2.0 fields
|
|
109
|
+
* This schema represents the real-world scenario where OIDC providers
|
|
110
|
+
* return a mix of OpenID Connect and OAuth 2.0 metadata fields
|
|
111
|
+
*/
|
|
112
|
+
const OpenIdProviderDiscoveryMetadataSchema = z$1.object({
|
|
113
|
+
...OpenIdProviderMetadataSchema.shape,
|
|
114
|
+
...OAuthMetadataSchema.pick({ code_challenge_methods_supported: true }).shape
|
|
115
|
+
});
|
|
116
|
+
z$1.object({
|
|
117
|
+
access_token: z$1.string(),
|
|
118
|
+
id_token: z$1.string().optional(),
|
|
119
|
+
token_type: z$1.string(),
|
|
120
|
+
expires_in: z$1.coerce.number().optional(),
|
|
121
|
+
scope: z$1.string().optional(),
|
|
122
|
+
refresh_token: z$1.string().optional()
|
|
123
|
+
}).strip();
|
|
124
|
+
z$1.object({
|
|
125
|
+
error: z$1.string(),
|
|
126
|
+
error_description: z$1.string().optional(),
|
|
127
|
+
error_uri: z$1.string().optional()
|
|
128
|
+
});
|
|
129
|
+
/**
|
|
130
|
+
* Optional version of SafeUrlSchema that allows empty string for retrocompatibility on tos_uri and logo_uri
|
|
131
|
+
*/
|
|
132
|
+
const OptionalSafeUrlSchema = SafeUrlSchema.optional().or(z$1.literal("").transform(() => void 0));
|
|
133
|
+
/**
|
|
134
|
+
* RFC 7591 OAuth 2.0 Dynamic Client Registration metadata
|
|
135
|
+
*/
|
|
136
|
+
const OAuthClientMetadataSchema = z$1.object({
|
|
137
|
+
redirect_uris: z$1.array(SafeUrlSchema),
|
|
138
|
+
token_endpoint_auth_method: z$1.string().optional(),
|
|
139
|
+
grant_types: z$1.array(z$1.string()).optional(),
|
|
140
|
+
response_types: z$1.array(z$1.string()).optional(),
|
|
141
|
+
client_name: z$1.string().optional(),
|
|
142
|
+
client_uri: SafeUrlSchema.optional(),
|
|
143
|
+
logo_uri: OptionalSafeUrlSchema,
|
|
144
|
+
scope: z$1.string().optional(),
|
|
145
|
+
contacts: z$1.array(z$1.string()).optional(),
|
|
146
|
+
tos_uri: OptionalSafeUrlSchema,
|
|
147
|
+
policy_uri: z$1.string().optional(),
|
|
148
|
+
jwks_uri: SafeUrlSchema.optional(),
|
|
149
|
+
jwks: z$1.any().optional(),
|
|
150
|
+
software_id: z$1.string().optional(),
|
|
151
|
+
software_version: z$1.string().optional(),
|
|
152
|
+
software_statement: z$1.string().optional()
|
|
153
|
+
}).strip();
|
|
154
|
+
/**
|
|
155
|
+
* RFC 7591 OAuth 2.0 Dynamic Client Registration client information
|
|
156
|
+
*/
|
|
157
|
+
const OAuthClientInformationSchema = z$1.object({
|
|
158
|
+
client_id: z$1.string(),
|
|
159
|
+
client_secret: z$1.string().optional(),
|
|
160
|
+
client_id_issued_at: z$1.number().optional(),
|
|
161
|
+
client_secret_expires_at: z$1.number().optional()
|
|
162
|
+
}).strip();
|
|
163
|
+
OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
|
|
164
|
+
z$1.object({
|
|
165
|
+
error: z$1.string(),
|
|
166
|
+
error_description: z$1.string().optional()
|
|
167
|
+
}).strip();
|
|
168
|
+
z$1.object({
|
|
169
|
+
token: z$1.string(),
|
|
170
|
+
token_type_hint: z$1.string().optional()
|
|
171
|
+
}).strip();
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
5
176
|
const PLATFORM_LABELS = {
|
|
6
177
|
chatgpt: "ChatGPT",
|
|
7
178
|
claudeai: "Claude.ai"
|
|
8
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cloudflare",
|
|
183
|
+
"fastly"
|
|
184
|
+
];
|
|
185
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
186
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
9
187
|
const auditStatusSchema = z.enum([
|
|
10
188
|
"pending",
|
|
11
189
|
"partial",
|
|
@@ -71,7 +249,24 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
|
|
|
71
249
|
chatgpt: widgetScreenshotSchema.optional(),
|
|
72
250
|
claudeai: widgetScreenshotSchema.optional()
|
|
73
251
|
}) });
|
|
252
|
+
z.object({
|
|
253
|
+
id: z.string(),
|
|
254
|
+
environmentId: z.string(),
|
|
255
|
+
clientId: z.string(),
|
|
256
|
+
clientSecret: z.string(),
|
|
257
|
+
clientScopes: z.array(z.string())
|
|
258
|
+
});
|
|
74
259
|
z.enum([
|
|
260
|
+
"opening_balance",
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"refund",
|
|
266
|
+
"admin_adjustment"
|
|
267
|
+
]);
|
|
268
|
+
z.enum(["playground"]);
|
|
269
|
+
const deploymentStatusSchema$1 = z.enum([
|
|
75
270
|
"ongoing",
|
|
76
271
|
"deployed",
|
|
77
272
|
"failed",
|
|
@@ -81,17 +276,235 @@ z.object({
|
|
|
81
276
|
timestamp: z.coerce.date().optional(),
|
|
82
277
|
content: z.string().optional()
|
|
83
278
|
});
|
|
279
|
+
const deploymentSummarySchema = z.object({
|
|
280
|
+
id: z.string(),
|
|
281
|
+
status: deploymentStatusSchema$1,
|
|
282
|
+
sourceBucket: z.string().nullable(),
|
|
283
|
+
sourceObjectKey: z.string().nullable(),
|
|
284
|
+
sourceRef: z.string().nullable(),
|
|
285
|
+
sourceCommitId: z.string().nullable(),
|
|
286
|
+
sourceCommitMessage: z.string().nullable(),
|
|
287
|
+
environmentId: z.string(),
|
|
288
|
+
authorUsername: z.string().nullable(),
|
|
289
|
+
authorAvatarUrl: z.string().nullable(),
|
|
290
|
+
startedAt: z.coerce.date().nullable(),
|
|
291
|
+
completedAt: z.coerce.date().nullable(),
|
|
292
|
+
isCurrent: z.boolean().optional(),
|
|
293
|
+
createdAt: z.coerce.date(),
|
|
294
|
+
updatedAt: z.coerce.date()
|
|
295
|
+
});
|
|
296
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
297
|
+
const publicEnvironmentSchema = z.object({
|
|
298
|
+
allowsAnonymous: z.literal(true),
|
|
299
|
+
oAuthMetadata: z.strictObject({})
|
|
300
|
+
});
|
|
301
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
302
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
303
|
+
allowsAnonymous: z.boolean(),
|
|
304
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
305
|
+
scope: z.string().optional()
|
|
306
|
+
});
|
|
307
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
308
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
309
|
+
allowsAnonymous: z.boolean(),
|
|
310
|
+
oAuthMetadata: z.object({
|
|
311
|
+
externalAuthorizationServerUrl: z.url(),
|
|
312
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
313
|
+
}),
|
|
314
|
+
scope: z.string().optional()
|
|
315
|
+
});
|
|
316
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
317
|
+
const standaloneEnvironmentSchema = z.object({
|
|
318
|
+
allowsAnonymous: z.boolean(),
|
|
319
|
+
oAuthMetadata: z.object({
|
|
320
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
321
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
322
|
+
}),
|
|
323
|
+
scope: z.string().optional()
|
|
324
|
+
});
|
|
325
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
326
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
327
|
+
allowsAnonymous: z.literal(false),
|
|
328
|
+
oAuthMetadata: z.strictObject({}),
|
|
329
|
+
scope: z.string().optional()
|
|
330
|
+
});
|
|
331
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
332
|
+
isPublic: z.literal(true),
|
|
333
|
+
oAuthMetadata: z.undefined().optional()
|
|
334
|
+
});
|
|
335
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
336
|
+
isPublic: z.literal(false),
|
|
337
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
338
|
+
scope: z.string().optional()
|
|
339
|
+
});
|
|
340
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
341
|
+
isPublic: z.literal(false),
|
|
342
|
+
oAuthMetadata: z.object({
|
|
343
|
+
externalAuthorizationServerUrl: z.url(),
|
|
344
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
345
|
+
}),
|
|
346
|
+
scope: z.string().optional()
|
|
347
|
+
});
|
|
348
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
349
|
+
isPublic: z.literal(false),
|
|
350
|
+
oAuthMetadata: z.object({
|
|
351
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
352
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
353
|
+
}),
|
|
354
|
+
scope: z.string().optional()
|
|
355
|
+
});
|
|
356
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
357
|
+
isPublic: z.literal(false),
|
|
358
|
+
oAuthMetadata: z.strictObject({}),
|
|
359
|
+
scope: z.string().optional()
|
|
360
|
+
});
|
|
361
|
+
z.union([
|
|
362
|
+
publicEnvironmentSchema,
|
|
363
|
+
externalResourceMetadataEnvironmentSchema,
|
|
364
|
+
externalAuthorizationServerEnvironmentSchema,
|
|
365
|
+
standaloneEnvironmentSchema,
|
|
366
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
367
|
+
legacyPublicEnvironmentSchema,
|
|
368
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
369
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
370
|
+
legacyStandaloneEnvironmentSchema,
|
|
371
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
372
|
+
]);
|
|
373
|
+
const playgroundModelSchema = z.enum([
|
|
374
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
375
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
376
|
+
"openai.gpt-5.4",
|
|
377
|
+
"openai.gpt-5.5"
|
|
378
|
+
]);
|
|
379
|
+
const environmentDomainSchema = z.object({
|
|
380
|
+
name: z.string(),
|
|
381
|
+
status: z.enum([
|
|
382
|
+
"ongoing",
|
|
383
|
+
"deployed",
|
|
384
|
+
"failed"
|
|
385
|
+
]),
|
|
386
|
+
createdAt: z.coerce.date(),
|
|
387
|
+
updatedAt: z.coerce.date()
|
|
388
|
+
});
|
|
389
|
+
const environmentSchema$1 = z.object({
|
|
390
|
+
id: z.string(),
|
|
391
|
+
name: z.string(),
|
|
392
|
+
sourceBranch: z.string().nullable(),
|
|
393
|
+
mcpServerUrl: z.string(),
|
|
394
|
+
activeDeployment: deploymentSummarySchema.optional(),
|
|
395
|
+
latestDeployment: deploymentSummarySchema.optional(),
|
|
396
|
+
openaiAppsChallenge: z.string().nullable().optional(),
|
|
397
|
+
isPlaygroundEnabled: z.boolean(),
|
|
398
|
+
playgroundModel: playgroundModelSchema,
|
|
399
|
+
isIpWhitelistEnabled: z.boolean(),
|
|
400
|
+
ipAllowlist: z.array(z.string()).nullable(),
|
|
401
|
+
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
402
|
+
projectId: z.string(),
|
|
403
|
+
createdAt: z.coerce.date(),
|
|
404
|
+
updatedAt: z.coerce.date()
|
|
405
|
+
});
|
|
406
|
+
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
84
407
|
z.object({
|
|
408
|
+
sessionReplayEnabled: z.boolean(),
|
|
409
|
+
collectRequestPayload: z.boolean(),
|
|
410
|
+
collectResponsePayload: z.boolean(),
|
|
411
|
+
collectErrorMessage: z.boolean(),
|
|
412
|
+
collectUserData: z.boolean(),
|
|
413
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
414
|
+
});
|
|
415
|
+
const feedbackSchema = z.object({
|
|
85
416
|
id: z.string(),
|
|
86
417
|
createdAt: z.coerce.date(),
|
|
87
418
|
environmentId: z.string(),
|
|
88
419
|
content: z.string(),
|
|
89
|
-
source: z.enum(["model", "user"])
|
|
420
|
+
source: z.enum(["model", "user"]),
|
|
421
|
+
clientName: z.string().nullable()
|
|
90
422
|
});
|
|
91
423
|
z.object({
|
|
92
424
|
content: z.string(),
|
|
93
425
|
source: z.enum(["model", "user"])
|
|
94
426
|
});
|
|
427
|
+
const intentCategoryColorSchema = z.enum([
|
|
428
|
+
"red",
|
|
429
|
+
"orange",
|
|
430
|
+
"yellow",
|
|
431
|
+
"green",
|
|
432
|
+
"blue",
|
|
433
|
+
"purple",
|
|
434
|
+
"pink",
|
|
435
|
+
"gray"
|
|
436
|
+
]);
|
|
437
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
438
|
+
const intentCategorySchema = z.object({
|
|
439
|
+
id: z.string(),
|
|
440
|
+
createdAt: z.coerce.date(),
|
|
441
|
+
environmentId: z.string(),
|
|
442
|
+
name: z.string(),
|
|
443
|
+
color: intentCategoryColorSchema
|
|
444
|
+
});
|
|
445
|
+
const intentCategorySummarySchema = z.object({
|
|
446
|
+
id: z.string(),
|
|
447
|
+
name: z.string(),
|
|
448
|
+
color: intentCategoryColorSchema,
|
|
449
|
+
intentCount: z.number().int().nonnegative()
|
|
450
|
+
});
|
|
451
|
+
z.object({
|
|
452
|
+
id: z.string(),
|
|
453
|
+
createdAt: z.coerce.date(),
|
|
454
|
+
environmentId: z.string(),
|
|
455
|
+
toolName: z.string(),
|
|
456
|
+
message: z.string(),
|
|
457
|
+
clientName: z.string().nullable(),
|
|
458
|
+
categories: z.array(intentCategorySchema)
|
|
459
|
+
});
|
|
460
|
+
const signalCategorySchema = z.object({
|
|
461
|
+
id: z.string(),
|
|
462
|
+
name: z.string(),
|
|
463
|
+
color: intentCategoryColorSchema
|
|
464
|
+
});
|
|
465
|
+
z.discriminatedUnion("kind", [
|
|
466
|
+
z.object({
|
|
467
|
+
kind: z.literal("new"),
|
|
468
|
+
category: signalCategorySchema,
|
|
469
|
+
currentCount: z.number().int().nonnegative(),
|
|
470
|
+
currentShare: z.number()
|
|
471
|
+
}),
|
|
472
|
+
z.object({
|
|
473
|
+
kind: z.literal("resurging"),
|
|
474
|
+
category: signalCategorySchema,
|
|
475
|
+
currentCount: z.number().int().nonnegative(),
|
|
476
|
+
daysQuiet: z.number(),
|
|
477
|
+
currentShare: z.number()
|
|
478
|
+
}),
|
|
479
|
+
z.object({
|
|
480
|
+
kind: z.literal("spike"),
|
|
481
|
+
category: signalCategorySchema,
|
|
482
|
+
currentCount: z.number().int().nonnegative(),
|
|
483
|
+
previousCount: z.number().int().nonnegative(),
|
|
484
|
+
currentShare: z.number(),
|
|
485
|
+
previousShare: z.number(),
|
|
486
|
+
changeRatio: z.number()
|
|
487
|
+
}),
|
|
488
|
+
z.object({
|
|
489
|
+
kind: z.literal("declining"),
|
|
490
|
+
category: signalCategorySchema,
|
|
491
|
+
currentCount: z.number().int().nonnegative(),
|
|
492
|
+
previousCount: z.number().int().nonnegative(),
|
|
493
|
+
currentShare: z.number(),
|
|
494
|
+
previousShare: z.number(),
|
|
495
|
+
changeRatio: z.number()
|
|
496
|
+
})
|
|
497
|
+
]);
|
|
498
|
+
z.discriminatedUnion("kind", [z.object({
|
|
499
|
+
kind: z.literal("existing"),
|
|
500
|
+
categoryId: z.string(),
|
|
501
|
+
categoryName: z.string(),
|
|
502
|
+
intentIds: z.array(z.string())
|
|
503
|
+
}), z.object({
|
|
504
|
+
kind: z.literal("new"),
|
|
505
|
+
categoryName: z.string(),
|
|
506
|
+
intentIds: z.array(z.string())
|
|
507
|
+
})]);
|
|
95
508
|
z.object({
|
|
96
509
|
id: z.string(),
|
|
97
510
|
teamId: z.string(),
|
|
@@ -100,12 +513,262 @@ z.object({
|
|
|
100
513
|
createdAt: z.coerce.date(),
|
|
101
514
|
updatedAt: z.coerce.date()
|
|
102
515
|
});
|
|
516
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
517
|
+
type: z.literal("mcp_request"),
|
|
518
|
+
method: z.string()
|
|
519
|
+
});
|
|
520
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
521
|
+
type: z.literal("mcp_error"),
|
|
522
|
+
method: z.string(),
|
|
523
|
+
error: z.string()
|
|
524
|
+
});
|
|
525
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
103
526
|
z.enum([
|
|
104
527
|
"INFO",
|
|
105
528
|
"WARNING",
|
|
106
529
|
"DEBUG",
|
|
107
530
|
"ERROR"
|
|
108
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]));
|
|
109
772
|
const runtimeSchema = z.enum([
|
|
110
773
|
"python3.13",
|
|
111
774
|
"python3.14",
|
|
@@ -117,6 +780,80 @@ const transportSchema = z.enum([
|
|
|
117
780
|
"sse",
|
|
118
781
|
"streamablehttp"
|
|
119
782
|
]);
|
|
783
|
+
z.object({
|
|
784
|
+
id: z.string(),
|
|
785
|
+
name: z.string(),
|
|
786
|
+
teamId: z.string(),
|
|
787
|
+
sourceRepository: z.string().nullable(),
|
|
788
|
+
createdAt: z.coerce.date().optional(),
|
|
789
|
+
runtime: runtimeSchema,
|
|
790
|
+
transport: transportSchema.nullable(),
|
|
791
|
+
rootDirectory: z.string().nullable(),
|
|
792
|
+
installCommand: z.string().nullable(),
|
|
793
|
+
buildCommand: z.string().nullable(),
|
|
794
|
+
buildOutputDir: z.string().nullable(),
|
|
795
|
+
startCommand: z.string().nullable(),
|
|
796
|
+
fixedOutboundIp: z.boolean(),
|
|
797
|
+
environments: z.array(environmentWithDomainsSchema),
|
|
798
|
+
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
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
|
+
});
|
|
810
|
+
z.object({
|
|
811
|
+
name: z.string(),
|
|
812
|
+
createdAt: z.coerce.date(),
|
|
813
|
+
status: z.enum([
|
|
814
|
+
"ongoing",
|
|
815
|
+
"deployed",
|
|
816
|
+
"failed"
|
|
817
|
+
]),
|
|
818
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
819
|
+
environment: environmentSchema$1,
|
|
820
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
821
|
+
});
|
|
822
|
+
const serverFieldsSchema$1 = z.object({
|
|
823
|
+
$schema: z.string(),
|
|
824
|
+
name: z.string(),
|
|
825
|
+
description: z.string(),
|
|
826
|
+
version: z.string().optional(),
|
|
827
|
+
title: z.string().optional(),
|
|
828
|
+
websiteUrl: z.string().optional(),
|
|
829
|
+
icons: z.array(z.object({
|
|
830
|
+
src: z.string(),
|
|
831
|
+
mimeType: z.string().optional(),
|
|
832
|
+
sizes: z.array(z.string()).optional()
|
|
833
|
+
})).optional(),
|
|
834
|
+
remotes: z.array(z.object({
|
|
835
|
+
type: z.string(),
|
|
836
|
+
url: z.string().optional(),
|
|
837
|
+
headers: z.array(z.object({
|
|
838
|
+
name: z.string(),
|
|
839
|
+
description: z.string(),
|
|
840
|
+
isRequired: z.boolean().optional(),
|
|
841
|
+
isSecret: z.boolean().optional()
|
|
842
|
+
})).optional()
|
|
843
|
+
})).optional()
|
|
844
|
+
}).catchall(z.unknown());
|
|
845
|
+
z.object({
|
|
846
|
+
serverFields: serverFieldsSchema$1,
|
|
847
|
+
source: z.enum(["registry", "defaults"])
|
|
848
|
+
});
|
|
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. */
|
|
850
|
+
const clampStringField = (field) => {
|
|
851
|
+
const max = field.maxLength;
|
|
852
|
+
if (max === null) return field;
|
|
853
|
+
const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
|
|
854
|
+
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
855
|
+
return field.description ? withMin.describe(field.description) : withMin;
|
|
856
|
+
};
|
|
120
857
|
const toolDefinitionSchema = z.object({
|
|
121
858
|
name: z.string(),
|
|
122
859
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -129,13 +866,20 @@ const toolDefinitionSchema = z.object({
|
|
|
129
866
|
}).optional()
|
|
130
867
|
});
|
|
131
868
|
const positiveTestCaseSchema = z.object({
|
|
132
|
-
scenario: z.string(),
|
|
133
|
-
userPrompt: z.string(),
|
|
134
|
-
toolTriggered: z.string().optional(),
|
|
135
|
-
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.")
|
|
136
873
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
874
|
+
const screenshotEntrySchema = z.object({
|
|
875
|
+
prompt: z.string(),
|
|
876
|
+
url: z.url()
|
|
877
|
+
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
878
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
137
879
|
/** Accepts either a valid email or URL. */
|
|
138
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)" });
|
|
139
883
|
const chatgptCategorySchema = z.enum([
|
|
140
884
|
"BUSINESS",
|
|
141
885
|
"COLLABORATION",
|
|
@@ -152,51 +896,348 @@ const chatgptCategorySchema = z.enum([
|
|
|
152
896
|
"TRAVEL"
|
|
153
897
|
]);
|
|
154
898
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
155
|
-
const
|
|
899
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
900
|
+
"AD",
|
|
901
|
+
"AE",
|
|
902
|
+
"AF",
|
|
903
|
+
"AG",
|
|
904
|
+
"AL",
|
|
905
|
+
"AM",
|
|
906
|
+
"AO",
|
|
907
|
+
"AR",
|
|
908
|
+
"AT",
|
|
909
|
+
"AU",
|
|
910
|
+
"AW",
|
|
911
|
+
"AX",
|
|
912
|
+
"AZ",
|
|
913
|
+
"BA",
|
|
914
|
+
"BB",
|
|
915
|
+
"BD",
|
|
916
|
+
"BE",
|
|
917
|
+
"BF",
|
|
918
|
+
"BG",
|
|
919
|
+
"BH",
|
|
920
|
+
"BI",
|
|
921
|
+
"BJ",
|
|
922
|
+
"BL",
|
|
923
|
+
"BM",
|
|
924
|
+
"BN",
|
|
925
|
+
"BO",
|
|
926
|
+
"BR",
|
|
927
|
+
"BS",
|
|
928
|
+
"BT",
|
|
929
|
+
"BW",
|
|
930
|
+
"BZ",
|
|
931
|
+
"CA",
|
|
932
|
+
"CD",
|
|
933
|
+
"CF",
|
|
934
|
+
"CG",
|
|
935
|
+
"CH",
|
|
936
|
+
"CI",
|
|
937
|
+
"CL",
|
|
938
|
+
"CM",
|
|
939
|
+
"CO",
|
|
940
|
+
"CR",
|
|
941
|
+
"CV",
|
|
942
|
+
"CY",
|
|
943
|
+
"CZ",
|
|
944
|
+
"DE",
|
|
945
|
+
"DJ",
|
|
946
|
+
"DK",
|
|
947
|
+
"DM",
|
|
948
|
+
"DO",
|
|
949
|
+
"DZ",
|
|
950
|
+
"EC",
|
|
951
|
+
"EE",
|
|
952
|
+
"EG",
|
|
953
|
+
"ER",
|
|
954
|
+
"ES",
|
|
955
|
+
"ET",
|
|
956
|
+
"FI",
|
|
957
|
+
"FJ",
|
|
958
|
+
"FM",
|
|
959
|
+
"FO",
|
|
960
|
+
"FR",
|
|
961
|
+
"GA",
|
|
962
|
+
"GB",
|
|
963
|
+
"GD",
|
|
964
|
+
"GE",
|
|
965
|
+
"GF",
|
|
966
|
+
"GH",
|
|
967
|
+
"GL",
|
|
968
|
+
"GM",
|
|
969
|
+
"GN",
|
|
970
|
+
"GP",
|
|
971
|
+
"GQ",
|
|
972
|
+
"GR",
|
|
973
|
+
"GT",
|
|
974
|
+
"GW",
|
|
975
|
+
"GY",
|
|
976
|
+
"HN",
|
|
977
|
+
"HR",
|
|
978
|
+
"HT",
|
|
979
|
+
"HU",
|
|
980
|
+
"ID",
|
|
981
|
+
"IE",
|
|
982
|
+
"IL",
|
|
983
|
+
"IN",
|
|
984
|
+
"IQ",
|
|
985
|
+
"IS",
|
|
986
|
+
"IT",
|
|
987
|
+
"JM",
|
|
988
|
+
"JO",
|
|
989
|
+
"JP",
|
|
990
|
+
"KE",
|
|
991
|
+
"KG",
|
|
992
|
+
"KH",
|
|
993
|
+
"KI",
|
|
994
|
+
"KM",
|
|
995
|
+
"KN",
|
|
996
|
+
"KR",
|
|
997
|
+
"KW",
|
|
998
|
+
"KY",
|
|
999
|
+
"KZ",
|
|
1000
|
+
"LA",
|
|
1001
|
+
"LB",
|
|
1002
|
+
"LC",
|
|
1003
|
+
"LI",
|
|
1004
|
+
"LK",
|
|
1005
|
+
"LR",
|
|
1006
|
+
"LS",
|
|
1007
|
+
"LT",
|
|
1008
|
+
"LU",
|
|
1009
|
+
"LV",
|
|
1010
|
+
"LY",
|
|
1011
|
+
"MA",
|
|
1012
|
+
"MC",
|
|
1013
|
+
"MD",
|
|
1014
|
+
"ME",
|
|
1015
|
+
"MF",
|
|
1016
|
+
"MG",
|
|
1017
|
+
"MH",
|
|
1018
|
+
"MK",
|
|
1019
|
+
"ML",
|
|
1020
|
+
"MM",
|
|
1021
|
+
"MN",
|
|
1022
|
+
"MQ",
|
|
1023
|
+
"MR",
|
|
1024
|
+
"MT",
|
|
1025
|
+
"MU",
|
|
1026
|
+
"MV",
|
|
1027
|
+
"MW",
|
|
1028
|
+
"MX",
|
|
1029
|
+
"MY",
|
|
1030
|
+
"MZ",
|
|
1031
|
+
"NA",
|
|
1032
|
+
"NC",
|
|
1033
|
+
"NE",
|
|
1034
|
+
"NG",
|
|
1035
|
+
"NI",
|
|
1036
|
+
"NL",
|
|
1037
|
+
"NO",
|
|
1038
|
+
"NP",
|
|
1039
|
+
"NR",
|
|
1040
|
+
"NZ",
|
|
1041
|
+
"OM",
|
|
1042
|
+
"PA",
|
|
1043
|
+
"PE",
|
|
1044
|
+
"PF",
|
|
1045
|
+
"PG",
|
|
1046
|
+
"PH",
|
|
1047
|
+
"PK",
|
|
1048
|
+
"PL",
|
|
1049
|
+
"PM",
|
|
1050
|
+
"PS",
|
|
1051
|
+
"PT",
|
|
1052
|
+
"PW",
|
|
1053
|
+
"PY",
|
|
1054
|
+
"QA",
|
|
1055
|
+
"RE",
|
|
1056
|
+
"RO",
|
|
1057
|
+
"RS",
|
|
1058
|
+
"RW",
|
|
1059
|
+
"SA",
|
|
1060
|
+
"SB",
|
|
1061
|
+
"SC",
|
|
1062
|
+
"SD",
|
|
1063
|
+
"SE",
|
|
1064
|
+
"SG",
|
|
1065
|
+
"SH",
|
|
1066
|
+
"SI",
|
|
1067
|
+
"SJ",
|
|
1068
|
+
"SK",
|
|
1069
|
+
"SL",
|
|
1070
|
+
"SM",
|
|
1071
|
+
"SN",
|
|
1072
|
+
"SO",
|
|
1073
|
+
"SR",
|
|
1074
|
+
"SS",
|
|
1075
|
+
"ST",
|
|
1076
|
+
"SV",
|
|
1077
|
+
"SZ",
|
|
1078
|
+
"TD",
|
|
1079
|
+
"TF",
|
|
1080
|
+
"TG",
|
|
1081
|
+
"TH",
|
|
1082
|
+
"TJ",
|
|
1083
|
+
"TL",
|
|
1084
|
+
"TM",
|
|
1085
|
+
"TN",
|
|
1086
|
+
"TO",
|
|
1087
|
+
"TR",
|
|
1088
|
+
"TT",
|
|
1089
|
+
"TV",
|
|
1090
|
+
"TW",
|
|
1091
|
+
"TZ",
|
|
1092
|
+
"UA",
|
|
1093
|
+
"UG",
|
|
1094
|
+
"US",
|
|
1095
|
+
"UY",
|
|
1096
|
+
"UZ",
|
|
1097
|
+
"VA",
|
|
1098
|
+
"VC",
|
|
1099
|
+
"VN",
|
|
1100
|
+
"VU",
|
|
1101
|
+
"WF",
|
|
1102
|
+
"WS",
|
|
1103
|
+
"YE",
|
|
1104
|
+
"YT",
|
|
1105
|
+
"ZA",
|
|
1106
|
+
"ZM",
|
|
1107
|
+
"ZW"
|
|
1108
|
+
]);
|
|
1109
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
1110
|
+
z.object({ mode: z.literal("all") }),
|
|
1111
|
+
z.object({
|
|
1112
|
+
mode: z.literal("allow"),
|
|
1113
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1114
|
+
}),
|
|
1115
|
+
z.object({
|
|
1116
|
+
mode: z.literal("block"),
|
|
1117
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1118
|
+
})
|
|
1119
|
+
]);
|
|
1120
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
1121
|
+
"am",
|
|
1122
|
+
"ar",
|
|
1123
|
+
"bg-BG",
|
|
1124
|
+
"bn-BD",
|
|
1125
|
+
"bs-BA",
|
|
1126
|
+
"ca-ES",
|
|
1127
|
+
"cs-CZ",
|
|
1128
|
+
"da-DK",
|
|
1129
|
+
"de-DE",
|
|
1130
|
+
"el-GR",
|
|
1131
|
+
"es-419",
|
|
1132
|
+
"es-ES",
|
|
1133
|
+
"et-EE",
|
|
1134
|
+
"fi-FI",
|
|
1135
|
+
"fr-CA",
|
|
1136
|
+
"fr-FR",
|
|
1137
|
+
"gu-IN",
|
|
1138
|
+
"hi-IN",
|
|
1139
|
+
"hr-HR",
|
|
1140
|
+
"hu-HU",
|
|
1141
|
+
"hy-AM",
|
|
1142
|
+
"id-ID",
|
|
1143
|
+
"is-IS",
|
|
1144
|
+
"it-IT",
|
|
1145
|
+
"ja-JP",
|
|
1146
|
+
"ka-GE",
|
|
1147
|
+
"kk",
|
|
1148
|
+
"kn-IN",
|
|
1149
|
+
"ko-KR",
|
|
1150
|
+
"lt",
|
|
1151
|
+
"lv-LV",
|
|
1152
|
+
"mk-MK",
|
|
1153
|
+
"ml",
|
|
1154
|
+
"mn",
|
|
1155
|
+
"mr-IN",
|
|
1156
|
+
"ms-MY",
|
|
1157
|
+
"my-MM",
|
|
1158
|
+
"nb-NO",
|
|
1159
|
+
"nl-NL",
|
|
1160
|
+
"pa",
|
|
1161
|
+
"pl-PL",
|
|
1162
|
+
"pt-BR",
|
|
1163
|
+
"pt-PT",
|
|
1164
|
+
"ro-RO",
|
|
1165
|
+
"ru-RU",
|
|
1166
|
+
"sk-SK",
|
|
1167
|
+
"sl-SI",
|
|
1168
|
+
"so-SO",
|
|
1169
|
+
"sq-AL",
|
|
1170
|
+
"sr-RS",
|
|
1171
|
+
"sv-SE",
|
|
1172
|
+
"sw-TZ",
|
|
1173
|
+
"ta-IN",
|
|
1174
|
+
"te-IN",
|
|
1175
|
+
"th-TH",
|
|
1176
|
+
"tl",
|
|
1177
|
+
"tr-TR",
|
|
1178
|
+
"uk-UA",
|
|
1179
|
+
"ur",
|
|
1180
|
+
"vi-VN",
|
|
1181
|
+
"zh-CN",
|
|
1182
|
+
"zh-HK",
|
|
1183
|
+
"zh-TW"
|
|
1184
|
+
]);
|
|
156
1185
|
const negativeTestCaseSchema = z.object({
|
|
157
1186
|
scenario: z.string(),
|
|
158
1187
|
userPrompt: z.string()
|
|
159
1188
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
160
1189
|
const chatgptToolJustificationSchema = z.object({
|
|
161
1190
|
toolName: z.string(),
|
|
162
|
-
readOnlyJustification: z.string(),
|
|
163
|
-
openWorldJustification: z.string(),
|
|
164
|
-
destructiveJustification: z.string()
|
|
165
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
1191
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
1192
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
1193
|
+
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
1194
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
1195
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
1196
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
1197
|
+
const chatgptDescriptionSchema = z.string();
|
|
166
1198
|
const chatgptTranslationSchema = z.object({
|
|
167
|
-
locale:
|
|
168
|
-
tagline:
|
|
169
|
-
description:
|
|
1199
|
+
locale: chatgptTranslationLocaleSchema,
|
|
1200
|
+
tagline: chatgptTaglineSchema,
|
|
1201
|
+
description: chatgptDescriptionSchema
|
|
170
1202
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
174
|
-
*/
|
|
1203
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
1204
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
175
1205
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
176
1206
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
177
|
-
logoDark: z.string().describe("
|
|
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."),
|
|
178
1208
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
179
|
-
tagline:
|
|
180
|
-
description:
|
|
1209
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1210
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
181
1211
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
182
1212
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
183
|
-
companyUrl:
|
|
1213
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
184
1214
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
185
|
-
privacyPolicyUrl:
|
|
186
|
-
termsOfServiceUrl:
|
|
187
|
-
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."),
|
|
188
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."),
|
|
189
|
-
serverUrl:
|
|
1219
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
190
1220
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
191
1221
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
192
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
193
|
-
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output.
|
|
194
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases
|
|
195
|
-
screenshots: z.array(z.
|
|
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."),
|
|
196
1226
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
197
|
-
allowedCountries: chatgptAllowedCountriesSchema.describe("
|
|
1227
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
198
1228
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
199
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
|
+
});
|
|
200
1241
|
chatgptSubmissionFormDataSchema.pick({
|
|
201
1242
|
appName: true,
|
|
202
1243
|
developerName: true,
|
|
@@ -211,9 +1252,9 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
211
1252
|
testCases: true,
|
|
212
1253
|
negativeTestCases: true,
|
|
213
1254
|
toolJustifications: true
|
|
214
|
-
});
|
|
1255
|
+
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
215
1256
|
const claudeCategorySchema = z.enum([
|
|
216
|
-
"
|
|
1257
|
+
"Productivity",
|
|
217
1258
|
"Communication",
|
|
218
1259
|
"Data & Analytics",
|
|
219
1260
|
"Development tools",
|
|
@@ -221,212 +1262,240 @@ const claudeCategorySchema = z.enum([
|
|
|
221
1262
|
"Consumer Health",
|
|
222
1263
|
"Health & Life Sciences",
|
|
223
1264
|
"Media & Entertainment",
|
|
224
|
-
"Commerce & Shopping"
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
"
|
|
228
|
-
"
|
|
229
|
-
"
|
|
1265
|
+
"Commerce & Shopping",
|
|
1266
|
+
"Legal",
|
|
1267
|
+
"Sales and marketing",
|
|
1268
|
+
"Creative",
|
|
1269
|
+
"Nonprofit",
|
|
1270
|
+
"Education",
|
|
1271
|
+
"Other"
|
|
230
1272
|
]);
|
|
231
|
-
const
|
|
232
|
-
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.`;
|
|
233
1274
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
234
|
-
"
|
|
235
|
-
"
|
|
236
|
-
"
|
|
1275
|
+
"read_only",
|
|
1276
|
+
"write_only",
|
|
1277
|
+
"read_write"
|
|
237
1278
|
]);
|
|
238
|
-
const
|
|
239
|
-
|
|
240
|
-
"
|
|
241
|
-
"
|
|
242
|
-
"
|
|
243
|
-
"
|
|
244
|
-
"N/A"
|
|
1279
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1280
|
+
"oauth_dcr",
|
|
1281
|
+
"oauth_cimd",
|
|
1282
|
+
"oauth_anthropic_creds",
|
|
1283
|
+
"custom_connection",
|
|
1284
|
+
"none"
|
|
245
1285
|
]);
|
|
246
|
-
const
|
|
247
|
-
"
|
|
248
|
-
"
|
|
249
|
-
"
|
|
250
|
-
"GDPR compliant (if applicable)"
|
|
1286
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1287
|
+
"first_party",
|
|
1288
|
+
"proxied",
|
|
1289
|
+
"third_party"
|
|
251
1290
|
]);
|
|
252
|
-
const
|
|
253
|
-
|
|
254
|
-
"
|
|
255
|
-
"
|
|
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."
|
|
256
1300
|
]);
|
|
257
|
-
/**
|
|
258
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
259
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
260
|
-
*/
|
|
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. */
|
|
261
1302
|
const claudeSubmissionFormDataSchema = z.object({
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
(
|
|
272
|
-
|
|
273
|
-
(
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
•
|
|
291
|
-
•
|
|
292
|
-
•
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
• '
|
|
308
|
-
• '
|
|
309
|
-
• '
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
337
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
338
|
-
• '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.
|
|
339
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
340
|
-
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:
|
|
341
|
-
• What the connector does and its key capabilities
|
|
342
|
-
• How to connect/set it up (step by step)
|
|
343
|
-
• What each tool does (or at least the main ones)
|
|
344
|
-
• How to troubleshoot common issues
|
|
345
|
-
• A support contact or channel
|
|
346
|
-
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.`),
|
|
347
|
-
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:
|
|
348
|
-
• What data you collect (and how)
|
|
349
|
-
• How you use the collected data
|
|
350
|
-
• Where and how long you store it
|
|
351
|
-
• Whether you share data with third parties (and who)
|
|
352
|
-
• How users can contact you about data concerns
|
|
353
|
-
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.`),
|
|
354
|
-
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:
|
|
355
|
-
• Email address (e.g. support@myapp.com)
|
|
356
|
-
• Link to a GitHub Issues page
|
|
357
|
-
• Link to a help center or support article
|
|
358
|
-
• Link to a Discord/Slack community
|
|
359
|
-
• Link to your documentation's troubleshooting section
|
|
360
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
361
|
-
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:
|
|
362
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
363
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
364
|
-
• 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.
|
|
365
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
366
|
-
• If your service requires API keys instead of a password, provide those.
|
|
367
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
368
|
-
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.
|
|
369
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
370
|
-
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.`),
|
|
371
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
372
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
373
|
-
• '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).
|
|
374
|
-
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.`),
|
|
375
|
-
logoLight: z.string().describe(`Your connector's logo as displayed in the directory. Requirements:
|
|
376
|
-
• Format: SVG only
|
|
377
|
-
• Aspect ratio: square (1:1)
|
|
378
|
-
• Should work on both light and dark backgrounds (or you can provide separate light/dark versions)
|
|
379
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
380
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
381
|
-
screenshots: z.array(z.url()).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
|
|
382
|
-
• 3–5 images is ideal
|
|
383
|
-
• Minimum 1000px width, PNG format preferred
|
|
384
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
385
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
386
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
387
|
-
• Videos are also welcome
|
|
388
|
-
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()
|
|
389
1377
|
});
|
|
390
1378
|
claudeSubmissionFormDataSchema.pick({
|
|
391
|
-
companyName: true,
|
|
392
|
-
appName: true,
|
|
393
|
-
mcpUrlType: true,
|
|
394
1379
|
serverUrl: true,
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
transportSupport: true,
|
|
1380
|
+
name: true,
|
|
1381
|
+
slug: true,
|
|
1382
|
+
companyName: true,
|
|
399
1383
|
primaryContactEmail: true,
|
|
400
|
-
primaryContactName: true
|
|
1384
|
+
primaryContactName: true,
|
|
1385
|
+
readWriteCapabilities: true,
|
|
1386
|
+
authentication: true,
|
|
1387
|
+
apiOwnership: true,
|
|
1388
|
+
personalHealthData: true
|
|
1389
|
+
}).extend({
|
|
1390
|
+
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1391
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
401
1392
|
});
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
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))
|
|
407
1403
|
});
|
|
408
1404
|
const submissionMetaFieldsSchema = z.object({
|
|
409
1405
|
id: z.string(),
|
|
410
1406
|
environmentId: z.string(),
|
|
1407
|
+
auditId: z.string().nullable(),
|
|
411
1408
|
createdAt: z.coerce.date(),
|
|
412
1409
|
updatedAt: z.coerce.date()
|
|
413
1410
|
});
|
|
414
1411
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
415
1412
|
platform: z.literal("claudeai"),
|
|
416
|
-
formData:
|
|
1413
|
+
formData: claudeSubmissionDraftSchema
|
|
417
1414
|
});
|
|
418
1415
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
419
1416
|
platform: z.literal("chatgpt"),
|
|
420
|
-
formData:
|
|
1417
|
+
formData: chatgptSubmissionDraftSchema
|
|
421
1418
|
});
|
|
422
1419
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
423
|
-
z.union([
|
|
1420
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1421
|
+
z.literal([
|
|
1422
|
+
100,
|
|
1423
|
+
75,
|
|
1424
|
+
50
|
|
1425
|
+
]);
|
|
424
1426
|
const subscriptionPlanSchema = z.enum([
|
|
425
1427
|
"pro",
|
|
426
1428
|
"business",
|
|
427
1429
|
"enterprise"
|
|
428
1430
|
]);
|
|
429
1431
|
z.object({ plan: subscriptionPlanSchema.nullable() });
|
|
1432
|
+
const customerCreditsSchema = z.object({
|
|
1433
|
+
balanceInCents: z.number(),
|
|
1434
|
+
expiresAt: z.number().nullable(),
|
|
1435
|
+
currency: z.string()
|
|
1436
|
+
});
|
|
1437
|
+
const customerUsageSchema = z.object({
|
|
1438
|
+
amountInCents: z.number(),
|
|
1439
|
+
currency: z.string(),
|
|
1440
|
+
periodEnd: z.number()
|
|
1441
|
+
});
|
|
1442
|
+
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1443
|
+
z.object({ balanceInNanoUSD: z.number() });
|
|
1444
|
+
z.object({
|
|
1445
|
+
customerCredits: customerCreditsSchema.nullable(),
|
|
1446
|
+
customerUsage: customerUsageSchema.nullable(),
|
|
1447
|
+
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1448
|
+
});
|
|
1449
|
+
const telemetrySignalSchema = z.enum([
|
|
1450
|
+
"logs",
|
|
1451
|
+
"metrics",
|
|
1452
|
+
"traces"
|
|
1453
|
+
]);
|
|
1454
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1455
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1456
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1457
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1458
|
+
const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
|
|
1459
|
+
const logSeveritySchema = z.enum([
|
|
1460
|
+
"TRACE",
|
|
1461
|
+
"DEBUG",
|
|
1462
|
+
"INFO",
|
|
1463
|
+
"WARN",
|
|
1464
|
+
"ERROR",
|
|
1465
|
+
"FATAL"
|
|
1466
|
+
]);
|
|
1467
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1468
|
+
id: z.string(),
|
|
1469
|
+
name: otlpHeaderNameSchema,
|
|
1470
|
+
value: otlpHeaderValueSchema,
|
|
1471
|
+
isSecret: z.boolean()
|
|
1472
|
+
});
|
|
1473
|
+
z.object({
|
|
1474
|
+
id: z.string(),
|
|
1475
|
+
signal: telemetrySignalSchema,
|
|
1476
|
+
endpoint: otlpEndpointSchema,
|
|
1477
|
+
protocol: otlpProtocolSchema,
|
|
1478
|
+
minimumSeverity: logSeveritySchema,
|
|
1479
|
+
headers: z.array(telemetryDestinationHeaderSchema)
|
|
1480
|
+
});
|
|
1481
|
+
z.enum([
|
|
1482
|
+
"credentials",
|
|
1483
|
+
"wrong-path",
|
|
1484
|
+
"wrong-protocol",
|
|
1485
|
+
"invalid-payload",
|
|
1486
|
+
"partial-rejection",
|
|
1487
|
+
"blocked-target",
|
|
1488
|
+
"timeout",
|
|
1489
|
+
"unreachable",
|
|
1490
|
+
"receiver-error",
|
|
1491
|
+
"unexpected-status"
|
|
1492
|
+
]);
|
|
1493
|
+
//#endregion
|
|
1494
|
+
//#region src/auth-scope.ts
|
|
1495
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1496
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1497
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1498
|
+
const AUTH_SCOPE_USER = "user";
|
|
430
1499
|
//#endregion
|
|
431
1500
|
//#region src/schemas.ts
|
|
432
1501
|
const RESERVED_KEYS = [
|
|
@@ -463,7 +1532,10 @@ const RESERVED_KEYS = [
|
|
|
463
1532
|
"BUILD_ARG_START_COMMAND",
|
|
464
1533
|
"ALPIC_HOST",
|
|
465
1534
|
"ALPIC_CUSTOM_DOMAINS",
|
|
466
|
-
"ALPIC_INTENT_META_KEY"
|
|
1535
|
+
"ALPIC_INTENT_META_KEY",
|
|
1536
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1537
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1538
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
467
1539
|
];
|
|
468
1540
|
const environmentVariableSchema = z.object({
|
|
469
1541
|
key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
|
|
@@ -544,21 +1616,20 @@ const deploymentSchema = z.object({
|
|
|
544
1616
|
isCurrent: z.boolean(),
|
|
545
1617
|
deploymentPageUrl: z.url().nullable()
|
|
546
1618
|
});
|
|
547
|
-
const
|
|
1619
|
+
const isValidTimeInput = (value) => {
|
|
548
1620
|
if (ms(value) !== void 0) return true;
|
|
549
1621
|
return !Number.isNaN(new Date(value).getTime());
|
|
550
1622
|
};
|
|
551
|
-
const
|
|
1623
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1624
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1625
|
+
const createEnvironmentContractV1 = base.route({
|
|
552
1626
|
path: "/v1/environments",
|
|
553
1627
|
method: "POST",
|
|
554
1628
|
summary: "Create an environment",
|
|
555
1629
|
description: "Create an environment for a project",
|
|
556
1630
|
tags: ["environments"],
|
|
557
1631
|
successDescription: "The environment has been created successfully"
|
|
558
|
-
}).errors({
|
|
559
|
-
NOT_FOUND: {},
|
|
560
|
-
BAD_REQUEST: {}
|
|
561
|
-
}).input(z.object({
|
|
1632
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
562
1633
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
563
1634
|
name: z.string().min(1).describe("The name of the environment"),
|
|
564
1635
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -567,11 +1638,11 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
567
1638
|
id: z.string(),
|
|
568
1639
|
name: z.string(),
|
|
569
1640
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
570
|
-
urls: z.array(z.
|
|
1641
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
571
1642
|
createdAt: z.coerce.date(),
|
|
572
1643
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
573
1644
|
}));
|
|
574
|
-
const getEnvironmentContractV1 =
|
|
1645
|
+
const getEnvironmentContractV1 = base.route({
|
|
575
1646
|
path: "/v1/environments/{environmentId}",
|
|
576
1647
|
method: "GET",
|
|
577
1648
|
summary: "Get an environment",
|
|
@@ -583,7 +1654,7 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
583
1654
|
name: z.string(),
|
|
584
1655
|
sourceBranch: z.string().nullable(),
|
|
585
1656
|
mcpServerUrl: z.string(),
|
|
586
|
-
domains: z.array(z.
|
|
1657
|
+
domains: z.array(z.hostname()),
|
|
587
1658
|
createdAt: z.coerce.date(),
|
|
588
1659
|
projectId: z.string()
|
|
589
1660
|
}));
|
|
@@ -628,7 +1699,7 @@ const projectOutputSchema = z.object({
|
|
|
628
1699
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
629
1700
|
environments: z.array(environmentSchema)
|
|
630
1701
|
});
|
|
631
|
-
const getProjectContractV1 =
|
|
1702
|
+
const getProjectContractV1 = base.route({
|
|
632
1703
|
path: "/v1/projects/{projectId}",
|
|
633
1704
|
method: "GET",
|
|
634
1705
|
summary: "Get a project",
|
|
@@ -636,15 +1707,15 @@ const getProjectContractV1 = oc.route({
|
|
|
636
1707
|
tags: ["projects"],
|
|
637
1708
|
successDescription: "The project details"
|
|
638
1709
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
639
|
-
const listProjectsContractV1 =
|
|
1710
|
+
const listProjectsContractV1 = base.route({
|
|
640
1711
|
path: "/v1/projects",
|
|
641
1712
|
method: "GET",
|
|
642
1713
|
summary: "List projects",
|
|
643
1714
|
description: "List all projects for a team",
|
|
644
1715
|
tags: ["projects"],
|
|
645
1716
|
successDescription: "The list of projects"
|
|
646
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
647
|
-
const createProjectContractV1 =
|
|
1717
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1718
|
+
const createProjectContractV1 = base.route({
|
|
648
1719
|
path: "/v1/projects",
|
|
649
1720
|
method: "POST",
|
|
650
1721
|
summary: "Create a project",
|
|
@@ -653,7 +1724,7 @@ const createProjectContractV1 = oc.route({
|
|
|
653
1724
|
successDescription: "The project has been created successfully"
|
|
654
1725
|
}).errors({
|
|
655
1726
|
NOT_FOUND: {},
|
|
656
|
-
|
|
1727
|
+
FORBIDDEN: {}
|
|
657
1728
|
}).input(z.object({
|
|
658
1729
|
teamId: z.string().optional(),
|
|
659
1730
|
name: z.string().trim().min(1).max(100),
|
|
@@ -693,7 +1764,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
693
1764
|
isSecret: z.boolean(),
|
|
694
1765
|
createdAt: z.coerce.date()
|
|
695
1766
|
});
|
|
696
|
-
const listEnvironmentVariablesContractV1 =
|
|
1767
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
697
1768
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
698
1769
|
method: "GET",
|
|
699
1770
|
summary: "List environment variables",
|
|
@@ -701,37 +1772,31 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
701
1772
|
tags: ["environments"],
|
|
702
1773
|
successDescription: "The list of environment variables"
|
|
703
1774
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
704
|
-
const createEnvironmentVariablesContractV1 =
|
|
1775
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
705
1776
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
706
1777
|
method: "POST",
|
|
707
1778
|
summary: "Add environment variables",
|
|
708
1779
|
description: "Add one or more environment variables to an environment",
|
|
709
1780
|
tags: ["environments"],
|
|
710
1781
|
successDescription: "The environment variables have been added successfully"
|
|
711
|
-
}).errors({
|
|
712
|
-
NOT_FOUND: {},
|
|
713
|
-
BAD_REQUEST: {}
|
|
714
|
-
}).input(z.object({
|
|
1782
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
715
1783
|
environmentId: z.string().describe("The ID of the environment"),
|
|
716
1784
|
environmentVariables: environmentVariablesSchema
|
|
717
1785
|
})).output(z.object({ success: z.literal(true) }));
|
|
718
|
-
const updateEnvironmentVariableContractV1 =
|
|
1786
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
719
1787
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
720
1788
|
method: "PATCH",
|
|
721
1789
|
summary: "Update an environment variable",
|
|
722
1790
|
description: "Update an environment variable by ID",
|
|
723
1791
|
tags: ["environments"],
|
|
724
1792
|
successDescription: "The environment variable has been updated successfully"
|
|
725
|
-
}).errors({
|
|
726
|
-
NOT_FOUND: {},
|
|
727
|
-
BAD_REQUEST: {}
|
|
728
|
-
}).input(z.object({
|
|
1793
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
729
1794
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
730
1795
|
key: environmentVariableSchema.shape.key,
|
|
731
1796
|
value: environmentVariableSchema.shape.value.optional(),
|
|
732
1797
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
733
1798
|
})).output(z.object({ success: z.literal(true) }));
|
|
734
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1799
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
735
1800
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
736
1801
|
method: "DELETE",
|
|
737
1802
|
summary: "Delete an environment variable",
|
|
@@ -739,7 +1804,7 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
739
1804
|
tags: ["environments"],
|
|
740
1805
|
successDescription: "The environment variable has been deleted successfully"
|
|
741
1806
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
742
|
-
const deleteProjectContractV1 =
|
|
1807
|
+
const deleteProjectContractV1 = base.route({
|
|
743
1808
|
path: "/v1/projects/{projectId}",
|
|
744
1809
|
method: "DELETE",
|
|
745
1810
|
summary: "Delete a project",
|
|
@@ -747,7 +1812,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
747
1812
|
tags: ["projects"],
|
|
748
1813
|
successDescription: "The project has been deleted successfully"
|
|
749
1814
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
750
|
-
const updateProjectContractV1 =
|
|
1815
|
+
const updateProjectContractV1 = base.route({
|
|
751
1816
|
path: "/v1/projects/{projectId}",
|
|
752
1817
|
method: "PATCH",
|
|
753
1818
|
summary: "Update a project",
|
|
@@ -756,13 +1821,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
756
1821
|
successDescription: "The project has been updated successfully"
|
|
757
1822
|
}).errors({
|
|
758
1823
|
NOT_FOUND: {},
|
|
759
|
-
|
|
1824
|
+
FORBIDDEN: {}
|
|
760
1825
|
}).input(z.object({
|
|
761
1826
|
projectId: z.string().describe("The ID of the project"),
|
|
762
1827
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
763
1828
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
764
1829
|
})).output(projectOutputSchema);
|
|
765
|
-
const deployEnvironmentContractV1 =
|
|
1830
|
+
const deployEnvironmentContractV1 = base.route({
|
|
766
1831
|
path: "/v1/environments/{environmentId}/deploy",
|
|
767
1832
|
method: "POST",
|
|
768
1833
|
summary: "Deploy an environment",
|
|
@@ -771,24 +1836,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
771
1836
|
successDescription: "The environment has been deployed successfully"
|
|
772
1837
|
}).errors({
|
|
773
1838
|
NOT_FOUND: {},
|
|
774
|
-
|
|
1839
|
+
CONFLICT: {}
|
|
775
1840
|
}).input(z.object({
|
|
776
1841
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
777
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1842
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1843
|
+
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
778
1844
|
})).output(deploymentSchema);
|
|
779
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1845
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
780
1846
|
path: "/v1/deployments/upload",
|
|
781
1847
|
method: "POST",
|
|
782
1848
|
summary: "Upload deployment artifacts",
|
|
783
1849
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
784
1850
|
tags: ["deployments"],
|
|
785
1851
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
786
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1852
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
787
1853
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
788
1854
|
token: z.string().describe("Token to identify the source archive"),
|
|
789
1855
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
790
1856
|
}));
|
|
791
|
-
const listDeploymentsContractV1 =
|
|
1857
|
+
const listDeploymentsContractV1 = base.route({
|
|
792
1858
|
path: "/v1/projects/{projectId}/deployments",
|
|
793
1859
|
method: "GET",
|
|
794
1860
|
summary: "List project deployments",
|
|
@@ -800,7 +1866,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
800
1866
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
801
1867
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
802
1868
|
})).output(z.array(deploymentSchema));
|
|
803
|
-
const getDeploymentContractV1 =
|
|
1869
|
+
const getDeploymentContractV1 = base.route({
|
|
804
1870
|
path: "/v1/deployments/{deploymentId}",
|
|
805
1871
|
method: "GET",
|
|
806
1872
|
summary: "Get a deployment",
|
|
@@ -808,20 +1874,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
808
1874
|
tags: ["deployments"],
|
|
809
1875
|
successDescription: "The deployment details"
|
|
810
1876
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
811
|
-
const
|
|
1877
|
+
const logEntrySchema = z.object({
|
|
1878
|
+
timestamp: z.coerce.date(),
|
|
1879
|
+
type: z.enum([
|
|
1880
|
+
"START",
|
|
1881
|
+
"END",
|
|
1882
|
+
"INFO",
|
|
1883
|
+
"ERROR",
|
|
1884
|
+
"WARNING",
|
|
1885
|
+
"DEBUG"
|
|
1886
|
+
]),
|
|
1887
|
+
requestId: z.string(),
|
|
1888
|
+
content: z.string().optional(),
|
|
1889
|
+
method: z.string().optional(),
|
|
1890
|
+
durationInMs: z.number().optional()
|
|
1891
|
+
});
|
|
1892
|
+
const getLogsContractV1 = base.route({
|
|
812
1893
|
path: "/v1/environments/{environmentId}/logs",
|
|
813
1894
|
method: "GET",
|
|
814
1895
|
summary: "Get logs",
|
|
815
1896
|
description: "Get logs for an environment",
|
|
816
1897
|
tags: ["environments"],
|
|
817
1898
|
successDescription: "The logs"
|
|
818
|
-
}).errors({
|
|
819
|
-
NOT_FOUND: {},
|
|
820
|
-
BAD_REQUEST: {}
|
|
821
|
-
}).input(z.object({
|
|
1899
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
822
1900
|
environmentId: z.string().describe("The ID of the environment"),
|
|
823
|
-
since:
|
|
824
|
-
until:
|
|
1901
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1902
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
825
1903
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
826
1904
|
level: z.array(z.enum([
|
|
827
1905
|
"INFO",
|
|
@@ -832,34 +1910,17 @@ const getLogsContractV1 = oc.route({
|
|
|
832
1910
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
833
1911
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
834
1912
|
})).output(z.object({
|
|
835
|
-
logs: z.array(
|
|
836
|
-
timestamp: z.coerce.date(),
|
|
837
|
-
type: z.enum([
|
|
838
|
-
"START",
|
|
839
|
-
"END",
|
|
840
|
-
"INFO",
|
|
841
|
-
"ERROR",
|
|
842
|
-
"WARNING",
|
|
843
|
-
"DEBUG"
|
|
844
|
-
]),
|
|
845
|
-
requestId: z.string(),
|
|
846
|
-
content: z.string().optional(),
|
|
847
|
-
method: z.string().optional(),
|
|
848
|
-
durationInMs: z.number().optional()
|
|
849
|
-
})),
|
|
1913
|
+
logs: z.array(logEntrySchema),
|
|
850
1914
|
nextToken: z.string().nullable()
|
|
851
1915
|
}));
|
|
852
|
-
const getLatestLogsContractV1 =
|
|
1916
|
+
const getLatestLogsContractV1 = base.route({
|
|
853
1917
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
854
1918
|
method: "GET",
|
|
855
1919
|
summary: "Get latest logs",
|
|
856
1920
|
description: "Get the N most recent logs for an environment",
|
|
857
1921
|
tags: ["environments"],
|
|
858
1922
|
successDescription: "The latest logs"
|
|
859
|
-
}).errors({
|
|
860
|
-
NOT_FOUND: {},
|
|
861
|
-
BAD_REQUEST: {}
|
|
862
|
-
}).input(z.object({
|
|
1923
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
863
1924
|
environmentId: z.string().describe("The ID of the environment"),
|
|
864
1925
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
865
1926
|
level: z.array(z.enum([
|
|
@@ -869,22 +1930,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
869
1930
|
"DEBUG"
|
|
870
1931
|
])).optional().describe("Filter by log level"),
|
|
871
1932
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
872
|
-
})).output(z.object({ logs: z.array(
|
|
873
|
-
|
|
874
|
-
type: z.enum([
|
|
875
|
-
"START",
|
|
876
|
-
"END",
|
|
877
|
-
"INFO",
|
|
878
|
-
"ERROR",
|
|
879
|
-
"WARNING",
|
|
880
|
-
"DEBUG"
|
|
881
|
-
]),
|
|
882
|
-
requestId: z.string(),
|
|
883
|
-
content: z.string().optional(),
|
|
884
|
-
method: z.string().optional(),
|
|
885
|
-
durationInMs: z.number().optional()
|
|
886
|
-
})) }));
|
|
887
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1933
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1934
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
888
1935
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
889
1936
|
method: "GET",
|
|
890
1937
|
summary: "Get deployment logs",
|
|
@@ -911,22 +1958,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
911
1958
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
912
1959
|
task_count: z.array(analyticsDataPointSchema)
|
|
913
1960
|
});
|
|
914
|
-
const getProjectAnalyticsContractV1 =
|
|
1961
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
915
1962
|
path: "/v1/analytics/{projectId}",
|
|
916
1963
|
method: "GET",
|
|
917
1964
|
summary: "Get project analytics",
|
|
918
1965
|
description: "Get analytics data for a project over a time range",
|
|
919
1966
|
tags: ["analytics"],
|
|
920
1967
|
successDescription: "The project analytics data"
|
|
921
|
-
}).errors({
|
|
922
|
-
NOT_FOUND: {},
|
|
923
|
-
BAD_REQUEST: {}
|
|
924
|
-
}).input(z.object({
|
|
1968
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
925
1969
|
projectId: z.string().describe("The ID of the project"),
|
|
926
1970
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
927
1971
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
928
1972
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
929
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
1973
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => Intl.supportedValuesOf("timeZone").includes(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
930
1974
|
metadata: z.object({
|
|
931
1975
|
startTimestamp: z.number(),
|
|
932
1976
|
endTimestamp: z.number(),
|
|
@@ -936,7 +1980,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
936
1980
|
}),
|
|
937
1981
|
timeSeries: analyticsTimeSeriesSchema
|
|
938
1982
|
}));
|
|
939
|
-
const
|
|
1983
|
+
const paginatedInsightsInputShape = {
|
|
1984
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1985
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1986
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1987
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1988
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1989
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1990
|
+
};
|
|
1991
|
+
const listIntentsContractV1 = base.route({
|
|
1992
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1993
|
+
method: "GET",
|
|
1994
|
+
summary: "List intents",
|
|
1995
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1996
|
+
tags: ["insights"],
|
|
1997
|
+
successDescription: "The grouped user intents"
|
|
1998
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1999
|
+
...paginatedInsightsInputShape,
|
|
2000
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2001
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2002
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2003
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2004
|
+
})).output(z.object({
|
|
2005
|
+
intents: z.array(z.object({
|
|
2006
|
+
id: z.string(),
|
|
2007
|
+
intentIds: z.array(z.string()).min(1),
|
|
2008
|
+
environmentId: z.string(),
|
|
2009
|
+
message: z.string(),
|
|
2010
|
+
toolName: z.string(),
|
|
2011
|
+
createdAt: z.coerce.date(),
|
|
2012
|
+
occurrenceCount: z.number().int().positive(),
|
|
2013
|
+
clientName: z.string().nullable(),
|
|
2014
|
+
clientId: z.string().nullable(),
|
|
2015
|
+
categories: z.array(z.object({
|
|
2016
|
+
id: z.string(),
|
|
2017
|
+
name: z.string(),
|
|
2018
|
+
color: intentCategoryColorSchema
|
|
2019
|
+
}))
|
|
2020
|
+
})),
|
|
2021
|
+
totalCount: z.number().int().nonnegative()
|
|
2022
|
+
}));
|
|
2023
|
+
const listFeedbacksContractV1 = base.route({
|
|
2024
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2025
|
+
method: "GET",
|
|
2026
|
+
summary: "List feedbacks",
|
|
2027
|
+
description: "List user feedback for an environment over a time range",
|
|
2028
|
+
tags: ["insights"],
|
|
2029
|
+
successDescription: "The user feedback"
|
|
2030
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2031
|
+
...paginatedInsightsInputShape,
|
|
2032
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2033
|
+
})).output(z.object({
|
|
2034
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2035
|
+
totalCount: z.number().int().nonnegative()
|
|
2036
|
+
}));
|
|
2037
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2038
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2039
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2040
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2041
|
+
method: "GET",
|
|
2042
|
+
summary: "List intent categories",
|
|
2043
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2044
|
+
tags: ["insights"],
|
|
2045
|
+
successDescription: "The intent categories"
|
|
2046
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2047
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2048
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2049
|
+
method: "POST",
|
|
2050
|
+
summary: "Create an intent category",
|
|
2051
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2052
|
+
tags: ["insights"],
|
|
2053
|
+
successDescription: "The created intent category"
|
|
2054
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2055
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2056
|
+
name: intentCategoryNameSchema,
|
|
2057
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2058
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2059
|
+
})).output(intentCategorySchema);
|
|
2060
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2061
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2062
|
+
method: "PATCH",
|
|
2063
|
+
summary: "Update an intent category",
|
|
2064
|
+
description: "Rename or recolor an intent category",
|
|
2065
|
+
tags: ["insights"],
|
|
2066
|
+
successDescription: "The updated intent category"
|
|
2067
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2068
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2069
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2070
|
+
name: intentCategoryNameSchema.optional(),
|
|
2071
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2072
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2073
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2074
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2075
|
+
method: "DELETE",
|
|
2076
|
+
summary: "Delete an intent category",
|
|
2077
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2078
|
+
tags: ["insights"],
|
|
2079
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2080
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2081
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2082
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2083
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2084
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2085
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2086
|
+
method: "POST",
|
|
2087
|
+
summary: "Link an intent category",
|
|
2088
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2089
|
+
tags: ["insights"],
|
|
2090
|
+
successDescription: "The intents have been linked successfully"
|
|
2091
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2092
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2093
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2094
|
+
intentIds: categorizableIntentIdsSchema
|
|
2095
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2096
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2097
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2098
|
+
method: "POST",
|
|
2099
|
+
summary: "Unlink an intent category",
|
|
2100
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2101
|
+
tags: ["insights"],
|
|
2102
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2103
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2104
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2105
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2106
|
+
intentIds: categorizableIntentIdsSchema
|
|
2107
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2108
|
+
const listTeamsContractV1 = base.route({
|
|
940
2109
|
path: "/v1/teams",
|
|
941
2110
|
method: "GET",
|
|
942
2111
|
summary: "List teams",
|
|
@@ -949,28 +2118,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
949
2118
|
createdAt: z.coerce.date(),
|
|
950
2119
|
hasStripeAccount: z.boolean()
|
|
951
2120
|
})));
|
|
952
|
-
const
|
|
2121
|
+
const getTeamUsageContractV1 = base.route({
|
|
2122
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2123
|
+
method: "GET",
|
|
2124
|
+
summary: "Get team usage",
|
|
2125
|
+
description: "Get the MCP request usage of a team for its current billing window. A team that has made no request in the window reports zero.",
|
|
2126
|
+
tags: ["teams"],
|
|
2127
|
+
successDescription: "The current billing window usage"
|
|
2128
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2129
|
+
teamId: z.string(),
|
|
2130
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2131
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2132
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2133
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2134
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2135
|
+
}));
|
|
2136
|
+
const getTunnelTicketContractV1 = base.route({
|
|
953
2137
|
path: "/v1/tunnels/ticket",
|
|
954
2138
|
method: "GET",
|
|
955
2139
|
summary: "Get a tunnel ticket",
|
|
956
2140
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
957
2141
|
tags: ["tunnels"],
|
|
958
2142
|
successDescription: "The tunnel ticket"
|
|
959
|
-
}).output(z.object({
|
|
2143
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
960
2144
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
961
2145
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
962
2146
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
963
2147
|
}));
|
|
964
|
-
const publishServerContractV1 =
|
|
2148
|
+
const publishServerContractV1 = base.route({
|
|
965
2149
|
path: "/v1/distribution/publish",
|
|
966
2150
|
method: "POST",
|
|
967
2151
|
summary: "Publish a server to the MCP registry",
|
|
968
2152
|
tags: ["distribution"],
|
|
969
2153
|
successDescription: "The server has been published successfully"
|
|
970
|
-
}).errors({
|
|
971
|
-
NOT_FOUND: {},
|
|
972
|
-
BAD_REQUEST: {}
|
|
973
|
-
}).input(z.object({
|
|
2154
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
974
2155
|
projectId: z.string(),
|
|
975
2156
|
domain: z.string(),
|
|
976
2157
|
title: z.string().min(1).max(100),
|
|
@@ -979,17 +2160,14 @@ const publishServerContractV1 = oc.route({
|
|
|
979
2160
|
iconSrc: z.url().max(255).optional(),
|
|
980
2161
|
dryRun: z.boolean().optional()
|
|
981
2162
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
982
|
-
const getServerInfoContractV1 =
|
|
2163
|
+
const getServerInfoContractV1 = base.route({
|
|
983
2164
|
path: "/v1/distribution/get",
|
|
984
2165
|
method: "GET",
|
|
985
2166
|
summary: "Get server info",
|
|
986
2167
|
description: "Get info about a server",
|
|
987
2168
|
tags: ["distribution"],
|
|
988
2169
|
successDescription: "The server info"
|
|
989
|
-
}).errors({
|
|
990
|
-
NOT_FOUND: {},
|
|
991
|
-
BAD_REQUEST: {}
|
|
992
|
-
}).input(z.object({
|
|
2170
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
993
2171
|
projectId: z.string(),
|
|
994
2172
|
domain: z.string()
|
|
995
2173
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1008,7 +2186,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1008
2186
|
isPlaygroundEnabled: z.boolean(),
|
|
1009
2187
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1010
2188
|
});
|
|
1011
|
-
const getPlaygroundContractV1 =
|
|
2189
|
+
const getPlaygroundContractV1 = base.route({
|
|
1012
2190
|
path: "/v1/environments/{environmentId}/playground",
|
|
1013
2191
|
method: "GET",
|
|
1014
2192
|
summary: "Get playground configuration",
|
|
@@ -1016,25 +2194,22 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1016
2194
|
tags: ["environments"],
|
|
1017
2195
|
successDescription: "The playground configuration"
|
|
1018
2196
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1019
|
-
const upsertPlaygroundContractV1 =
|
|
2197
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1020
2198
|
path: "/v1/environments/{environmentId}/playground",
|
|
1021
2199
|
method: "PUT",
|
|
1022
2200
|
summary: "Update playground configuration",
|
|
1023
2201
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1024
2202
|
tags: ["environments"],
|
|
1025
2203
|
successDescription: "The updated playground configuration"
|
|
1026
|
-
}).errors({
|
|
1027
|
-
NOT_FOUND: {},
|
|
1028
|
-
BAD_REQUEST: {}
|
|
1029
|
-
}).input(z.object({
|
|
2204
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1030
2205
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1031
2206
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1032
2207
|
name: z.string().min(1).max(100).optional(),
|
|
1033
2208
|
description: z.string().min(1).max(500).optional(),
|
|
1034
2209
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1035
|
-
examplePrompts: z.array(playgroundExamplePromptSchema).max(
|
|
2210
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1036
2211
|
})).output(playgroundOutputSchema);
|
|
1037
|
-
const createBeaconContractV1 =
|
|
2212
|
+
const createBeaconContractV1 = base.route({
|
|
1038
2213
|
path: "/v1/beacon/audits",
|
|
1039
2214
|
method: "POST",
|
|
1040
2215
|
summary: "Create a beacon audit",
|
|
@@ -1043,7 +2218,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1043
2218
|
successDescription: "The audit has been created"
|
|
1044
2219
|
}).errors({
|
|
1045
2220
|
NOT_FOUND: {},
|
|
1046
|
-
BAD_REQUEST: {},
|
|
1047
2221
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1048
2222
|
}).input(z.object({
|
|
1049
2223
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1051,7 +2225,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1051
2225
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1052
2226
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1053
2227
|
})).output(z.object({ id: z.string() }));
|
|
1054
|
-
const getBeaconContractV1 =
|
|
2228
|
+
const getBeaconContractV1 = base.route({
|
|
1055
2229
|
path: "/v1/beacon/audits/{auditId}",
|
|
1056
2230
|
method: "GET",
|
|
1057
2231
|
summary: "Get a beacon audit",
|
|
@@ -1067,8 +2241,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1067
2241
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1068
2242
|
}));
|
|
1069
2243
|
const contract = {
|
|
1070
|
-
teams: {
|
|
2244
|
+
teams: {
|
|
2245
|
+
list: { v1: listTeamsContractV1 },
|
|
2246
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2247
|
+
},
|
|
1071
2248
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2249
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2250
|
+
intentCategories: {
|
|
2251
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2252
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2253
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2254
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2255
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2256
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2257
|
+
},
|
|
2258
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1072
2259
|
deployments: {
|
|
1073
2260
|
list: { v1: listDeploymentsContractV1 },
|
|
1074
2261
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1109,5 +2296,10 @@ const contract = {
|
|
|
1109
2296
|
get: { v1: getBeaconContractV1 }
|
|
1110
2297
|
}
|
|
1111
2298
|
};
|
|
2299
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2300
|
+
const contractForDocs = {
|
|
2301
|
+
...contract,
|
|
2302
|
+
deployments: deploymentsForDocs
|
|
2303
|
+
};
|
|
1112
2304
|
//#endregion
|
|
1113
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2305
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|