@alpic-ai/api 0.0.0-staging.ffd67d5 → 0.0.0-staging.g019b064
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 +1733 -251
- package/dist/index.mjs +1833 -164
- package/package.json +27 -8
package/dist/index.mjs
CHANGED
|
@@ -1,72 +1,196 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import * as z$1 from "zod/v4";
|
|
1
3
|
import { oc } from "@orpc/contract";
|
|
2
4
|
import ms from "ms";
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
"
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
"ALPIC_CUSTOM_DOMAINS"
|
|
39
|
-
];
|
|
40
|
-
const environmentVariableSchema = z.object({
|
|
41
|
-
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"),
|
|
42
|
-
value: z.string().min(1, "Value is required"),
|
|
43
|
-
isSecret: z.boolean().default(false)
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.5.4/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()
|
|
44
40
|
});
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
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()
|
|
51
64
|
});
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
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);
|
|
176
|
+
const PLATFORM_LABELS = {
|
|
177
|
+
chatgpt: "ChatGPT",
|
|
178
|
+
claudeai: "Claude.ai"
|
|
179
|
+
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cato",
|
|
183
|
+
"cloudflare",
|
|
184
|
+
"fastly"
|
|
185
|
+
];
|
|
186
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
187
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
188
|
+
const auditStatusSchema = z.enum([
|
|
64
189
|
"pending",
|
|
65
190
|
"partial",
|
|
66
191
|
"completed",
|
|
67
192
|
"failed"
|
|
68
193
|
]);
|
|
69
|
-
const platformSchema = z.enum(["chatgpt", "claudeai"]);
|
|
70
194
|
const checkSeveritySchema = z.enum([
|
|
71
195
|
"error",
|
|
72
196
|
"warning",
|
|
@@ -86,6 +210,8 @@ const checkDetailSchema = z.object({
|
|
|
86
210
|
});
|
|
87
211
|
const checkResultSchema = z.object({
|
|
88
212
|
checkId: z.string(),
|
|
213
|
+
checkName: z.string(),
|
|
214
|
+
description: z.string(),
|
|
89
215
|
status: z.enum([
|
|
90
216
|
"pass",
|
|
91
217
|
"fail",
|
|
@@ -117,12 +243,1344 @@ const auditReportSchema = z.object({
|
|
|
117
243
|
widgetScreenshotKeys: z.object({
|
|
118
244
|
chatgpt: z.string().optional(),
|
|
119
245
|
claudeai: z.string().optional()
|
|
120
|
-
})
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
246
|
+
})
|
|
247
|
+
});
|
|
248
|
+
const widgetScreenshotSchema = z.object({ url: z.string() });
|
|
249
|
+
const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreenshots: z.object({
|
|
250
|
+
chatgpt: widgetScreenshotSchema.optional(),
|
|
251
|
+
claudeai: widgetScreenshotSchema.optional()
|
|
252
|
+
}) });
|
|
253
|
+
z.object({
|
|
254
|
+
id: z.string(),
|
|
255
|
+
environmentId: z.string(),
|
|
256
|
+
clientId: z.string(),
|
|
257
|
+
clientSecret: z.string(),
|
|
258
|
+
clientScopes: z.array(z.string())
|
|
259
|
+
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
279
|
+
const deploymentStatusSchema$1 = z.enum([
|
|
280
|
+
"ongoing",
|
|
281
|
+
"deployed",
|
|
282
|
+
"failed",
|
|
283
|
+
"canceled"
|
|
284
|
+
]);
|
|
285
|
+
z.object({
|
|
286
|
+
timestamp: z.coerce.date().optional(),
|
|
287
|
+
content: z.string().optional()
|
|
288
|
+
});
|
|
289
|
+
const deploymentSummarySchema = z.object({
|
|
290
|
+
id: z.string(),
|
|
291
|
+
status: deploymentStatusSchema$1,
|
|
292
|
+
sourceBucket: z.string().nullable(),
|
|
293
|
+
sourceObjectKey: z.string().nullable(),
|
|
294
|
+
sourceRef: z.string().nullable(),
|
|
295
|
+
sourceCommitId: z.string().nullable(),
|
|
296
|
+
sourceCommitMessage: z.string().nullable(),
|
|
297
|
+
environmentId: z.string(),
|
|
298
|
+
authorUsername: z.string().nullable(),
|
|
299
|
+
authorAvatarUrl: z.string().nullable(),
|
|
300
|
+
startedAt: z.coerce.date().nullable(),
|
|
301
|
+
completedAt: z.coerce.date().nullable(),
|
|
302
|
+
isCurrent: z.boolean().optional(),
|
|
303
|
+
createdAt: z.coerce.date(),
|
|
304
|
+
updatedAt: z.coerce.date()
|
|
305
|
+
});
|
|
306
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
307
|
+
const publicEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.literal(true),
|
|
309
|
+
oAuthMetadata: z.strictObject({})
|
|
310
|
+
});
|
|
311
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
312
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
313
|
+
allowsAnonymous: z.boolean(),
|
|
314
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
315
|
+
scope: z.string().optional()
|
|
316
|
+
});
|
|
317
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
318
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
319
|
+
allowsAnonymous: z.boolean(),
|
|
320
|
+
oAuthMetadata: z.object({
|
|
321
|
+
externalAuthorizationServerUrl: z.url(),
|
|
322
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
323
|
+
}),
|
|
324
|
+
scope: z.string().optional()
|
|
325
|
+
});
|
|
326
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
|
+
const standaloneEnvironmentSchema = z.object({
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
329
|
+
oAuthMetadata: z.object({
|
|
330
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
331
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
332
|
+
}),
|
|
333
|
+
scope: z.string().optional()
|
|
334
|
+
});
|
|
335
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
336
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
337
|
+
allowsAnonymous: z.literal(false),
|
|
338
|
+
oAuthMetadata: z.strictObject({}),
|
|
339
|
+
scope: z.string().optional()
|
|
340
|
+
});
|
|
341
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
342
|
+
isPublic: z.literal(true),
|
|
343
|
+
oAuthMetadata: z.undefined().optional()
|
|
344
|
+
});
|
|
345
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
346
|
+
isPublic: z.literal(false),
|
|
347
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
348
|
+
scope: z.string().optional()
|
|
349
|
+
});
|
|
350
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
351
|
+
isPublic: z.literal(false),
|
|
352
|
+
oAuthMetadata: z.object({
|
|
353
|
+
externalAuthorizationServerUrl: z.url(),
|
|
354
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
355
|
+
}),
|
|
356
|
+
scope: z.string().optional()
|
|
357
|
+
});
|
|
358
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
359
|
+
isPublic: z.literal(false),
|
|
360
|
+
oAuthMetadata: z.object({
|
|
361
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
362
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
363
|
+
}),
|
|
364
|
+
scope: z.string().optional()
|
|
365
|
+
});
|
|
366
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
367
|
+
isPublic: z.literal(false),
|
|
368
|
+
oAuthMetadata: z.strictObject({}),
|
|
369
|
+
scope: z.string().optional()
|
|
370
|
+
});
|
|
371
|
+
z.union([
|
|
372
|
+
publicEnvironmentSchema,
|
|
373
|
+
externalResourceMetadataEnvironmentSchema,
|
|
374
|
+
externalAuthorizationServerEnvironmentSchema,
|
|
375
|
+
standaloneEnvironmentSchema,
|
|
376
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
377
|
+
legacyPublicEnvironmentSchema,
|
|
378
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
379
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
380
|
+
legacyStandaloneEnvironmentSchema,
|
|
381
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
382
|
+
]);
|
|
383
|
+
const playgroundModelSchema = z.enum([
|
|
384
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
385
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
386
|
+
"openai.gpt-5.4",
|
|
387
|
+
"openai.gpt-5.5"
|
|
388
|
+
]);
|
|
389
|
+
const environmentDomainSchema = z.object({
|
|
390
|
+
name: z.string(),
|
|
391
|
+
status: z.enum([
|
|
392
|
+
"ongoing",
|
|
393
|
+
"deployed",
|
|
394
|
+
"failed"
|
|
395
|
+
]),
|
|
396
|
+
createdAt: z.coerce.date(),
|
|
397
|
+
updatedAt: z.coerce.date()
|
|
398
|
+
});
|
|
399
|
+
const environmentSchema$1 = z.object({
|
|
400
|
+
id: z.string(),
|
|
401
|
+
name: z.string(),
|
|
402
|
+
sourceBranch: z.string().nullable(),
|
|
403
|
+
mcpServerUrl: z.string(),
|
|
404
|
+
activeDeployment: deploymentSummarySchema.optional(),
|
|
405
|
+
latestDeployment: deploymentSummarySchema.optional(),
|
|
406
|
+
openaiAppsChallenge: z.string().nullable().optional(),
|
|
407
|
+
isPlaygroundEnabled: z.boolean(),
|
|
408
|
+
playgroundModel: playgroundModelSchema,
|
|
409
|
+
isIpWhitelistEnabled: z.boolean(),
|
|
410
|
+
ipAllowlist: z.array(z.string()).nullable(),
|
|
411
|
+
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
412
|
+
projectId: z.string(),
|
|
413
|
+
createdAt: z.coerce.date(),
|
|
414
|
+
updatedAt: z.coerce.date()
|
|
415
|
+
});
|
|
416
|
+
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
417
|
+
z.object({
|
|
418
|
+
sessionReplayEnabled: z.boolean(),
|
|
419
|
+
collectRequestPayload: z.boolean(),
|
|
420
|
+
collectResponsePayload: z.boolean(),
|
|
421
|
+
collectErrorMessage: z.boolean(),
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
424
|
+
});
|
|
425
|
+
const feedbackSchema = z.object({
|
|
426
|
+
id: z.string(),
|
|
427
|
+
createdAt: z.coerce.date(),
|
|
428
|
+
environmentId: z.string(),
|
|
429
|
+
content: z.string(),
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
432
|
+
});
|
|
433
|
+
z.object({
|
|
434
|
+
content: z.string(),
|
|
435
|
+
source: z.enum(["model", "user"])
|
|
436
|
+
});
|
|
437
|
+
const intentCategoryColorSchema = z.enum([
|
|
438
|
+
"red",
|
|
439
|
+
"orange",
|
|
440
|
+
"yellow",
|
|
441
|
+
"green",
|
|
442
|
+
"blue",
|
|
443
|
+
"purple",
|
|
444
|
+
"pink",
|
|
445
|
+
"gray"
|
|
446
|
+
]);
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
448
|
+
const intentCategorySchema = z.object({
|
|
449
|
+
id: z.string(),
|
|
450
|
+
createdAt: z.coerce.date(),
|
|
451
|
+
environmentId: z.string(),
|
|
452
|
+
name: z.string(),
|
|
453
|
+
color: intentCategoryColorSchema
|
|
454
|
+
});
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
456
|
+
id: z.string(),
|
|
457
|
+
name: z.string(),
|
|
458
|
+
color: intentCategoryColorSchema,
|
|
459
|
+
intentCount: z.number().int().nonnegative()
|
|
460
|
+
});
|
|
461
|
+
z.object({
|
|
462
|
+
id: z.string(),
|
|
463
|
+
createdAt: z.coerce.date(),
|
|
464
|
+
environmentId: z.string(),
|
|
465
|
+
toolName: z.string(),
|
|
466
|
+
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
468
|
+
categories: z.array(intentCategorySchema)
|
|
469
|
+
});
|
|
470
|
+
const signalCategorySchema = z.object({
|
|
471
|
+
id: z.string(),
|
|
472
|
+
name: z.string(),
|
|
473
|
+
color: intentCategoryColorSchema
|
|
474
|
+
});
|
|
475
|
+
z.discriminatedUnion("kind", [
|
|
476
|
+
z.object({
|
|
477
|
+
kind: z.literal("new"),
|
|
478
|
+
category: signalCategorySchema,
|
|
479
|
+
currentCount: z.number().int().nonnegative(),
|
|
480
|
+
currentShare: z.number()
|
|
481
|
+
}),
|
|
482
|
+
z.object({
|
|
483
|
+
kind: z.literal("resurging"),
|
|
484
|
+
category: signalCategorySchema,
|
|
485
|
+
currentCount: z.number().int().nonnegative(),
|
|
486
|
+
daysQuiet: z.number(),
|
|
487
|
+
currentShare: z.number()
|
|
488
|
+
}),
|
|
489
|
+
z.object({
|
|
490
|
+
kind: z.literal("spike"),
|
|
491
|
+
category: signalCategorySchema,
|
|
492
|
+
currentCount: z.number().int().nonnegative(),
|
|
493
|
+
previousCount: z.number().int().nonnegative(),
|
|
494
|
+
currentShare: z.number(),
|
|
495
|
+
previousShare: z.number(),
|
|
496
|
+
changeRatio: z.number()
|
|
497
|
+
}),
|
|
498
|
+
z.object({
|
|
499
|
+
kind: z.literal("declining"),
|
|
500
|
+
category: signalCategorySchema,
|
|
501
|
+
currentCount: z.number().int().nonnegative(),
|
|
502
|
+
previousCount: z.number().int().nonnegative(),
|
|
503
|
+
currentShare: z.number(),
|
|
504
|
+
previousShare: z.number(),
|
|
505
|
+
changeRatio: z.number()
|
|
506
|
+
})
|
|
507
|
+
]);
|
|
508
|
+
z.discriminatedUnion("kind", [z.object({
|
|
509
|
+
kind: z.literal("existing"),
|
|
510
|
+
categoryId: z.string(),
|
|
511
|
+
categoryName: z.string(),
|
|
512
|
+
intentIds: z.array(z.string())
|
|
513
|
+
}), z.object({
|
|
514
|
+
kind: z.literal("new"),
|
|
515
|
+
categoryName: z.string(),
|
|
516
|
+
intentIds: z.array(z.string())
|
|
517
|
+
})]);
|
|
518
|
+
z.object({
|
|
519
|
+
id: z.string(),
|
|
520
|
+
teamId: z.string(),
|
|
521
|
+
email: z.string(),
|
|
522
|
+
expiresAt: z.coerce.date(),
|
|
523
|
+
createdAt: z.coerce.date(),
|
|
524
|
+
updatedAt: z.coerce.date()
|
|
525
|
+
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
536
|
+
z.enum([
|
|
537
|
+
"INFO",
|
|
538
|
+
"WARNING",
|
|
539
|
+
"DEBUG",
|
|
540
|
+
"ERROR"
|
|
541
|
+
]);
|
|
542
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
|
+
const MCP_CLIENT_GROUPS = [
|
|
544
|
+
{
|
|
545
|
+
id: "claude_code",
|
|
546
|
+
label: "Claude Code",
|
|
547
|
+
vendor: "anthropic",
|
|
548
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
id: "claude",
|
|
552
|
+
label: "Claude",
|
|
553
|
+
vendor: "anthropic",
|
|
554
|
+
rawNames: [
|
|
555
|
+
"Anthropic/ClaudeAI",
|
|
556
|
+
"claude-ai",
|
|
557
|
+
"claude",
|
|
558
|
+
"Claude",
|
|
559
|
+
"claude-desktop",
|
|
560
|
+
"claude-desktop-3p"
|
|
561
|
+
]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "claude_mobile",
|
|
565
|
+
label: "Claude mobile",
|
|
566
|
+
vendor: "anthropic",
|
|
567
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
id: "claude_cowork",
|
|
571
|
+
label: "Claude Cowork",
|
|
572
|
+
vendor: "anthropic",
|
|
573
|
+
rawNames: ["Anthropic/Cowork"]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "claude_toolbox",
|
|
577
|
+
label: "Claude Toolbox",
|
|
578
|
+
vendor: "anthropic",
|
|
579
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "anthropic_api",
|
|
583
|
+
label: "Anthropic API",
|
|
584
|
+
vendor: "anthropic",
|
|
585
|
+
rawNames: ["Anthropic/API"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "anthropic_connector_refresh",
|
|
589
|
+
label: "Anthropic (connector refresh)",
|
|
590
|
+
vendor: "anthropic",
|
|
591
|
+
rawNames: ["Anthropic"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "codex",
|
|
595
|
+
label: "Codex",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: [
|
|
598
|
+
"codex-mcp-client",
|
|
599
|
+
"codex",
|
|
600
|
+
"Codex",
|
|
601
|
+
"codex-cli",
|
|
602
|
+
"openai-mcp (Codex)"
|
|
603
|
+
]
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
id: "chatgpt",
|
|
607
|
+
label: "ChatGPT",
|
|
608
|
+
vendor: "openai",
|
|
609
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
id: "openai_responses_api",
|
|
613
|
+
label: "OpenAI Responses API",
|
|
614
|
+
vendor: "openai",
|
|
615
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
id: "openai_agent_builder",
|
|
619
|
+
label: "OpenAI Agent Builder",
|
|
620
|
+
vendor: "openai",
|
|
621
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
id: "openai_other",
|
|
625
|
+
label: "OpenAI Other",
|
|
626
|
+
vendor: "openai",
|
|
627
|
+
rawNames: ["openai-mcp"]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cursor",
|
|
631
|
+
label: "Cursor",
|
|
632
|
+
vendor: "cursor",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"cursor-vscode",
|
|
635
|
+
"Cursor",
|
|
636
|
+
"cursor"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "cline",
|
|
641
|
+
label: "Cline",
|
|
642
|
+
vendor: "cline",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Cline",
|
|
645
|
+
"cline",
|
|
646
|
+
"@cline/core"
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
id: "github_copilot",
|
|
651
|
+
label: "GitHub Copilot",
|
|
652
|
+
vendor: "githubCopilot",
|
|
653
|
+
rawNames: [
|
|
654
|
+
"Copilot",
|
|
655
|
+
"github-copilot-developer",
|
|
656
|
+
"Copilot MCP Gateway",
|
|
657
|
+
"Xcode/copilot-xcode"
|
|
658
|
+
]
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
id: "gemini_cli",
|
|
662
|
+
label: "Gemini CLI",
|
|
663
|
+
vendor: "google",
|
|
664
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "antigravity",
|
|
668
|
+
label: "Antigravity",
|
|
669
|
+
vendor: "google",
|
|
670
|
+
rawNames: ["antigravity-client"]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "gemini",
|
|
674
|
+
label: "Gemini",
|
|
675
|
+
vendor: "google",
|
|
676
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
id: "windsurf",
|
|
680
|
+
label: "Windsurf",
|
|
681
|
+
vendor: "windsurf",
|
|
682
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
id: "mistral",
|
|
686
|
+
label: "Mistral / Le Chat",
|
|
687
|
+
vendor: "mistral",
|
|
688
|
+
rawNames: ["Mistral"],
|
|
689
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "n8n",
|
|
693
|
+
label: "n8n",
|
|
694
|
+
vendor: "n8n",
|
|
695
|
+
rawNames: [
|
|
696
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
698
|
+
"n8n"
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "alpic_playground",
|
|
703
|
+
label: "Alpic Playground",
|
|
704
|
+
vendor: "alpic",
|
|
705
|
+
rawNames: ["alpic-playground", "playground"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "opencode",
|
|
709
|
+
label: "opencode",
|
|
710
|
+
vendor: "opencode",
|
|
711
|
+
rawNames: ["opencode"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "zed",
|
|
715
|
+
label: "Zed",
|
|
716
|
+
vendor: "zed",
|
|
717
|
+
rawNames: ["Zed", "zed"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "zapier",
|
|
721
|
+
label: "Zapier",
|
|
722
|
+
vendor: "zapier",
|
|
723
|
+
rawNames: ["Zapier", "zapier"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "make",
|
|
727
|
+
label: "Make",
|
|
728
|
+
vendor: "make",
|
|
729
|
+
rawNames: ["Make", "make"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "librechat",
|
|
733
|
+
label: "LibreChat",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["LibreChat", "librechat"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "jan",
|
|
739
|
+
label: "Jan",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: ["Jan", "jan"]
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
id: "goose",
|
|
745
|
+
label: "goose",
|
|
746
|
+
vendor: "mcp",
|
|
747
|
+
rawNames: ["goose", "Goose"]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
id: "mcphost",
|
|
751
|
+
label: "mcphost",
|
|
752
|
+
vendor: "mcp",
|
|
753
|
+
rawNames: ["mcphost"]
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
id: "mcporter",
|
|
757
|
+
label: "mcporter",
|
|
758
|
+
vendor: "mcp",
|
|
759
|
+
rawNames: ["mcporter"]
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
id: "rmcp",
|
|
763
|
+
label: "rmcp",
|
|
764
|
+
vendor: "mcp",
|
|
765
|
+
rawNames: ["rmcp"]
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
id: "unnamed_client",
|
|
769
|
+
label: "Unnamed client",
|
|
770
|
+
vendor: "mcp",
|
|
771
|
+
rawNames: [
|
|
772
|
+
"mcp",
|
|
773
|
+
"unknown",
|
|
774
|
+
""
|
|
775
|
+
]
|
|
776
|
+
}
|
|
777
|
+
];
|
|
778
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
779
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
780
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
781
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
782
|
+
const runtimeSchema = z.enum([
|
|
783
|
+
"python3.13",
|
|
784
|
+
"python3.14",
|
|
785
|
+
"node22",
|
|
786
|
+
"node24"
|
|
787
|
+
]);
|
|
788
|
+
const transportSchema = z.enum([
|
|
789
|
+
"stdio",
|
|
790
|
+
"sse",
|
|
791
|
+
"streamablehttp"
|
|
792
|
+
]);
|
|
793
|
+
z.object({
|
|
794
|
+
id: z.string(),
|
|
795
|
+
name: z.string(),
|
|
796
|
+
teamId: z.string(),
|
|
797
|
+
sourceRepository: z.string().nullable(),
|
|
798
|
+
createdAt: z.coerce.date().optional(),
|
|
799
|
+
runtime: runtimeSchema,
|
|
800
|
+
transport: transportSchema.nullable(),
|
|
801
|
+
rootDirectory: z.string().nullable(),
|
|
802
|
+
installCommand: z.string().nullable(),
|
|
803
|
+
buildCommand: z.string().nullable(),
|
|
804
|
+
buildOutputDir: z.string().nullable(),
|
|
805
|
+
startCommand: z.string().nullable(),
|
|
806
|
+
fixedOutboundIp: z.boolean(),
|
|
807
|
+
environments: z.array(environmentWithDomainsSchema),
|
|
808
|
+
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
809
|
+
});
|
|
810
|
+
const domainFailureReasonSchema = z.enum([
|
|
811
|
+
"caa",
|
|
812
|
+
"dns",
|
|
813
|
+
"invalid_domain",
|
|
814
|
+
"other"
|
|
815
|
+
]);
|
|
816
|
+
const projectDomainMappingSchema = z.object({
|
|
817
|
+
pathPrefix: z.string(),
|
|
818
|
+
environment: environmentSchema$1
|
|
819
|
+
});
|
|
820
|
+
z.object({
|
|
821
|
+
name: z.string(),
|
|
822
|
+
createdAt: z.coerce.date(),
|
|
823
|
+
status: z.enum([
|
|
824
|
+
"ongoing",
|
|
825
|
+
"deployed",
|
|
826
|
+
"failed"
|
|
827
|
+
]),
|
|
828
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
829
|
+
environment: environmentSchema$1,
|
|
830
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
831
|
+
});
|
|
832
|
+
const serverFieldsSchema$1 = z.object({
|
|
833
|
+
$schema: z.string(),
|
|
834
|
+
name: z.string(),
|
|
835
|
+
description: z.string(),
|
|
836
|
+
version: z.string().optional(),
|
|
837
|
+
title: z.string().optional(),
|
|
838
|
+
websiteUrl: z.string().optional(),
|
|
839
|
+
icons: z.array(z.object({
|
|
840
|
+
src: z.string(),
|
|
841
|
+
mimeType: z.string().optional(),
|
|
842
|
+
sizes: z.array(z.string()).optional()
|
|
843
|
+
})).optional(),
|
|
844
|
+
remotes: z.array(z.object({
|
|
845
|
+
type: z.string(),
|
|
846
|
+
url: z.string().optional(),
|
|
847
|
+
headers: z.array(z.object({
|
|
848
|
+
name: z.string(),
|
|
849
|
+
description: z.string(),
|
|
850
|
+
isRequired: z.boolean().optional(),
|
|
851
|
+
isSecret: z.boolean().optional()
|
|
852
|
+
})).optional()
|
|
853
|
+
})).optional()
|
|
854
|
+
}).catchall(z.unknown());
|
|
855
|
+
z.object({
|
|
856
|
+
serverFields: serverFieldsSchema$1,
|
|
857
|
+
source: z.enum(["registry", "defaults"])
|
|
858
|
+
});
|
|
859
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
860
|
+
const clampStringField = (field) => {
|
|
861
|
+
const max = field.maxLength;
|
|
862
|
+
if (max === null) return field;
|
|
863
|
+
const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
|
|
864
|
+
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
865
|
+
return field.description ? withMin.describe(field.description) : withMin;
|
|
866
|
+
};
|
|
867
|
+
const toolDefinitionSchema = z.object({
|
|
868
|
+
name: z.string(),
|
|
869
|
+
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
870
|
+
description: z.string().optional(),
|
|
871
|
+
annotations: z.object({
|
|
872
|
+
readOnlyHint: z.boolean().optional(),
|
|
873
|
+
destructiveHint: z.boolean().optional(),
|
|
874
|
+
openWorldHint: z.boolean().optional(),
|
|
875
|
+
idempotentHint: z.boolean().optional()
|
|
124
876
|
}).optional()
|
|
125
877
|
});
|
|
878
|
+
const positiveTestCaseSchema = z.object({
|
|
879
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
880
|
+
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
881
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
882
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
883
|
+
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
884
|
+
const screenshotEntrySchema = z.object({
|
|
885
|
+
prompt: z.string(),
|
|
886
|
+
url: z.url()
|
|
887
|
+
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
888
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
889
|
+
/** Accepts either a valid email or URL. */
|
|
890
|
+
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
891
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
892
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
893
|
+
const chatgptCategorySchema = z.enum([
|
|
894
|
+
"BUSINESS",
|
|
895
|
+
"COLLABORATION",
|
|
896
|
+
"DESIGN",
|
|
897
|
+
"DEVELOPER_TOOLS",
|
|
898
|
+
"EDUCATION",
|
|
899
|
+
"ENTERTAINMENT",
|
|
900
|
+
"FINANCE",
|
|
901
|
+
"FOOD",
|
|
902
|
+
"LIFESTYLE",
|
|
903
|
+
"NEWS",
|
|
904
|
+
"PRODUCTIVITY",
|
|
905
|
+
"SHOPPING",
|
|
906
|
+
"TRAVEL"
|
|
907
|
+
]);
|
|
908
|
+
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
909
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
910
|
+
"AD",
|
|
911
|
+
"AE",
|
|
912
|
+
"AF",
|
|
913
|
+
"AG",
|
|
914
|
+
"AL",
|
|
915
|
+
"AM",
|
|
916
|
+
"AO",
|
|
917
|
+
"AR",
|
|
918
|
+
"AT",
|
|
919
|
+
"AU",
|
|
920
|
+
"AW",
|
|
921
|
+
"AX",
|
|
922
|
+
"AZ",
|
|
923
|
+
"BA",
|
|
924
|
+
"BB",
|
|
925
|
+
"BD",
|
|
926
|
+
"BE",
|
|
927
|
+
"BF",
|
|
928
|
+
"BG",
|
|
929
|
+
"BH",
|
|
930
|
+
"BI",
|
|
931
|
+
"BJ",
|
|
932
|
+
"BL",
|
|
933
|
+
"BM",
|
|
934
|
+
"BN",
|
|
935
|
+
"BO",
|
|
936
|
+
"BR",
|
|
937
|
+
"BS",
|
|
938
|
+
"BT",
|
|
939
|
+
"BW",
|
|
940
|
+
"BZ",
|
|
941
|
+
"CA",
|
|
942
|
+
"CD",
|
|
943
|
+
"CF",
|
|
944
|
+
"CG",
|
|
945
|
+
"CH",
|
|
946
|
+
"CI",
|
|
947
|
+
"CL",
|
|
948
|
+
"CM",
|
|
949
|
+
"CO",
|
|
950
|
+
"CR",
|
|
951
|
+
"CV",
|
|
952
|
+
"CY",
|
|
953
|
+
"CZ",
|
|
954
|
+
"DE",
|
|
955
|
+
"DJ",
|
|
956
|
+
"DK",
|
|
957
|
+
"DM",
|
|
958
|
+
"DO",
|
|
959
|
+
"DZ",
|
|
960
|
+
"EC",
|
|
961
|
+
"EE",
|
|
962
|
+
"EG",
|
|
963
|
+
"ER",
|
|
964
|
+
"ES",
|
|
965
|
+
"ET",
|
|
966
|
+
"FI",
|
|
967
|
+
"FJ",
|
|
968
|
+
"FM",
|
|
969
|
+
"FO",
|
|
970
|
+
"FR",
|
|
971
|
+
"GA",
|
|
972
|
+
"GB",
|
|
973
|
+
"GD",
|
|
974
|
+
"GE",
|
|
975
|
+
"GF",
|
|
976
|
+
"GH",
|
|
977
|
+
"GL",
|
|
978
|
+
"GM",
|
|
979
|
+
"GN",
|
|
980
|
+
"GP",
|
|
981
|
+
"GQ",
|
|
982
|
+
"GR",
|
|
983
|
+
"GT",
|
|
984
|
+
"GW",
|
|
985
|
+
"GY",
|
|
986
|
+
"HN",
|
|
987
|
+
"HR",
|
|
988
|
+
"HT",
|
|
989
|
+
"HU",
|
|
990
|
+
"ID",
|
|
991
|
+
"IE",
|
|
992
|
+
"IL",
|
|
993
|
+
"IN",
|
|
994
|
+
"IQ",
|
|
995
|
+
"IS",
|
|
996
|
+
"IT",
|
|
997
|
+
"JM",
|
|
998
|
+
"JO",
|
|
999
|
+
"JP",
|
|
1000
|
+
"KE",
|
|
1001
|
+
"KG",
|
|
1002
|
+
"KH",
|
|
1003
|
+
"KI",
|
|
1004
|
+
"KM",
|
|
1005
|
+
"KN",
|
|
1006
|
+
"KR",
|
|
1007
|
+
"KW",
|
|
1008
|
+
"KY",
|
|
1009
|
+
"KZ",
|
|
1010
|
+
"LA",
|
|
1011
|
+
"LB",
|
|
1012
|
+
"LC",
|
|
1013
|
+
"LI",
|
|
1014
|
+
"LK",
|
|
1015
|
+
"LR",
|
|
1016
|
+
"LS",
|
|
1017
|
+
"LT",
|
|
1018
|
+
"LU",
|
|
1019
|
+
"LV",
|
|
1020
|
+
"LY",
|
|
1021
|
+
"MA",
|
|
1022
|
+
"MC",
|
|
1023
|
+
"MD",
|
|
1024
|
+
"ME",
|
|
1025
|
+
"MF",
|
|
1026
|
+
"MG",
|
|
1027
|
+
"MH",
|
|
1028
|
+
"MK",
|
|
1029
|
+
"ML",
|
|
1030
|
+
"MM",
|
|
1031
|
+
"MN",
|
|
1032
|
+
"MQ",
|
|
1033
|
+
"MR",
|
|
1034
|
+
"MT",
|
|
1035
|
+
"MU",
|
|
1036
|
+
"MV",
|
|
1037
|
+
"MW",
|
|
1038
|
+
"MX",
|
|
1039
|
+
"MY",
|
|
1040
|
+
"MZ",
|
|
1041
|
+
"NA",
|
|
1042
|
+
"NC",
|
|
1043
|
+
"NE",
|
|
1044
|
+
"NG",
|
|
1045
|
+
"NI",
|
|
1046
|
+
"NL",
|
|
1047
|
+
"NO",
|
|
1048
|
+
"NP",
|
|
1049
|
+
"NR",
|
|
1050
|
+
"NZ",
|
|
1051
|
+
"OM",
|
|
1052
|
+
"PA",
|
|
1053
|
+
"PE",
|
|
1054
|
+
"PF",
|
|
1055
|
+
"PG",
|
|
1056
|
+
"PH",
|
|
1057
|
+
"PK",
|
|
1058
|
+
"PL",
|
|
1059
|
+
"PM",
|
|
1060
|
+
"PS",
|
|
1061
|
+
"PT",
|
|
1062
|
+
"PW",
|
|
1063
|
+
"PY",
|
|
1064
|
+
"QA",
|
|
1065
|
+
"RE",
|
|
1066
|
+
"RO",
|
|
1067
|
+
"RS",
|
|
1068
|
+
"RW",
|
|
1069
|
+
"SA",
|
|
1070
|
+
"SB",
|
|
1071
|
+
"SC",
|
|
1072
|
+
"SD",
|
|
1073
|
+
"SE",
|
|
1074
|
+
"SG",
|
|
1075
|
+
"SH",
|
|
1076
|
+
"SI",
|
|
1077
|
+
"SJ",
|
|
1078
|
+
"SK",
|
|
1079
|
+
"SL",
|
|
1080
|
+
"SM",
|
|
1081
|
+
"SN",
|
|
1082
|
+
"SO",
|
|
1083
|
+
"SR",
|
|
1084
|
+
"SS",
|
|
1085
|
+
"ST",
|
|
1086
|
+
"SV",
|
|
1087
|
+
"SZ",
|
|
1088
|
+
"TD",
|
|
1089
|
+
"TF",
|
|
1090
|
+
"TG",
|
|
1091
|
+
"TH",
|
|
1092
|
+
"TJ",
|
|
1093
|
+
"TL",
|
|
1094
|
+
"TM",
|
|
1095
|
+
"TN",
|
|
1096
|
+
"TO",
|
|
1097
|
+
"TR",
|
|
1098
|
+
"TT",
|
|
1099
|
+
"TV",
|
|
1100
|
+
"TW",
|
|
1101
|
+
"TZ",
|
|
1102
|
+
"UA",
|
|
1103
|
+
"UG",
|
|
1104
|
+
"US",
|
|
1105
|
+
"UY",
|
|
1106
|
+
"UZ",
|
|
1107
|
+
"VA",
|
|
1108
|
+
"VC",
|
|
1109
|
+
"VN",
|
|
1110
|
+
"VU",
|
|
1111
|
+
"WF",
|
|
1112
|
+
"WS",
|
|
1113
|
+
"YE",
|
|
1114
|
+
"YT",
|
|
1115
|
+
"ZA",
|
|
1116
|
+
"ZM",
|
|
1117
|
+
"ZW"
|
|
1118
|
+
]);
|
|
1119
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
1120
|
+
z.object({ mode: z.literal("all") }),
|
|
1121
|
+
z.object({
|
|
1122
|
+
mode: z.literal("allow"),
|
|
1123
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1124
|
+
}),
|
|
1125
|
+
z.object({
|
|
1126
|
+
mode: z.literal("block"),
|
|
1127
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1128
|
+
})
|
|
1129
|
+
]);
|
|
1130
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
1131
|
+
"am",
|
|
1132
|
+
"ar",
|
|
1133
|
+
"bg-BG",
|
|
1134
|
+
"bn-BD",
|
|
1135
|
+
"bs-BA",
|
|
1136
|
+
"ca-ES",
|
|
1137
|
+
"cs-CZ",
|
|
1138
|
+
"da-DK",
|
|
1139
|
+
"de-DE",
|
|
1140
|
+
"el-GR",
|
|
1141
|
+
"es-419",
|
|
1142
|
+
"es-ES",
|
|
1143
|
+
"et-EE",
|
|
1144
|
+
"fi-FI",
|
|
1145
|
+
"fr-CA",
|
|
1146
|
+
"fr-FR",
|
|
1147
|
+
"gu-IN",
|
|
1148
|
+
"hi-IN",
|
|
1149
|
+
"hr-HR",
|
|
1150
|
+
"hu-HU",
|
|
1151
|
+
"hy-AM",
|
|
1152
|
+
"id-ID",
|
|
1153
|
+
"is-IS",
|
|
1154
|
+
"it-IT",
|
|
1155
|
+
"ja-JP",
|
|
1156
|
+
"ka-GE",
|
|
1157
|
+
"kk",
|
|
1158
|
+
"kn-IN",
|
|
1159
|
+
"ko-KR",
|
|
1160
|
+
"lt",
|
|
1161
|
+
"lv-LV",
|
|
1162
|
+
"mk-MK",
|
|
1163
|
+
"ml",
|
|
1164
|
+
"mn",
|
|
1165
|
+
"mr-IN",
|
|
1166
|
+
"ms-MY",
|
|
1167
|
+
"my-MM",
|
|
1168
|
+
"nb-NO",
|
|
1169
|
+
"nl-NL",
|
|
1170
|
+
"pa",
|
|
1171
|
+
"pl-PL",
|
|
1172
|
+
"pt-BR",
|
|
1173
|
+
"pt-PT",
|
|
1174
|
+
"ro-RO",
|
|
1175
|
+
"ru-RU",
|
|
1176
|
+
"sk-SK",
|
|
1177
|
+
"sl-SI",
|
|
1178
|
+
"so-SO",
|
|
1179
|
+
"sq-AL",
|
|
1180
|
+
"sr-RS",
|
|
1181
|
+
"sv-SE",
|
|
1182
|
+
"sw-TZ",
|
|
1183
|
+
"ta-IN",
|
|
1184
|
+
"te-IN",
|
|
1185
|
+
"th-TH",
|
|
1186
|
+
"tl",
|
|
1187
|
+
"tr-TR",
|
|
1188
|
+
"uk-UA",
|
|
1189
|
+
"ur",
|
|
1190
|
+
"vi-VN",
|
|
1191
|
+
"zh-CN",
|
|
1192
|
+
"zh-HK",
|
|
1193
|
+
"zh-TW"
|
|
1194
|
+
]);
|
|
1195
|
+
const negativeTestCaseSchema = z.object({
|
|
1196
|
+
scenario: z.string(),
|
|
1197
|
+
userPrompt: z.string()
|
|
1198
|
+
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1199
|
+
const chatgptToolJustificationSchema = z.object({
|
|
1200
|
+
toolName: z.string(),
|
|
1201
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
1202
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
1203
|
+
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
1204
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
1205
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
1206
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
1207
|
+
const chatgptDescriptionSchema = z.string();
|
|
1208
|
+
const chatgptTranslationSchema = z.object({
|
|
1209
|
+
locale: chatgptTranslationLocaleSchema,
|
|
1210
|
+
tagline: chatgptTaglineSchema,
|
|
1211
|
+
description: chatgptDescriptionSchema
|
|
1212
|
+
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
1213
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
1214
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
1215
|
+
const chatgptSubmissionFormDataSchema = z.object({
|
|
1216
|
+
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
1217
|
+
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
1218
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
1219
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1220
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
1221
|
+
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
1222
|
+
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
1223
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
1224
|
+
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
1225
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1226
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1227
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
1228
|
+
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
|
|
1229
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
1230
|
+
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1231
|
+
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1232
|
+
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
1233
|
+
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
1234
|
+
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
1235
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1236
|
+
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1237
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
1238
|
+
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
1239
|
+
});
|
|
1240
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1241
|
+
tagline: z.string().optional(),
|
|
1242
|
+
companyUrl: z.string().optional(),
|
|
1243
|
+
supportChannel: z.string().optional(),
|
|
1244
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1245
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1246
|
+
demoRecordingUrl: z.string().optional(),
|
|
1247
|
+
serverUrl: z.string().optional(),
|
|
1248
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1249
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1250
|
+
});
|
|
1251
|
+
chatgptSubmissionFormDataSchema.pick({
|
|
1252
|
+
appName: true,
|
|
1253
|
+
developerName: true,
|
|
1254
|
+
serverUrl: true,
|
|
1255
|
+
tools: true,
|
|
1256
|
+
authentication: true
|
|
1257
|
+
});
|
|
1258
|
+
chatgptSubmissionFormDataSchema.pick({
|
|
1259
|
+
tagline: true,
|
|
1260
|
+
description: true,
|
|
1261
|
+
category: true,
|
|
1262
|
+
testCases: true,
|
|
1263
|
+
negativeTestCases: true,
|
|
1264
|
+
toolJustifications: true
|
|
1265
|
+
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
1266
|
+
const claudeCategorySchema = z.enum([
|
|
1267
|
+
"Productivity",
|
|
1268
|
+
"Communication",
|
|
1269
|
+
"Data & Analytics",
|
|
1270
|
+
"Development tools",
|
|
1271
|
+
"Financial Services",
|
|
1272
|
+
"Consumer Health",
|
|
1273
|
+
"Health & Life Sciences",
|
|
1274
|
+
"Media & Entertainment",
|
|
1275
|
+
"Commerce & Shopping",
|
|
1276
|
+
"Legal",
|
|
1277
|
+
"Sales and marketing",
|
|
1278
|
+
"Creative",
|
|
1279
|
+
"Nonprofit",
|
|
1280
|
+
"Education",
|
|
1281
|
+
"Other"
|
|
1282
|
+
]);
|
|
1283
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
1284
|
+
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
1285
|
+
"read_only",
|
|
1286
|
+
"write_only",
|
|
1287
|
+
"read_write"
|
|
1288
|
+
]);
|
|
1289
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1290
|
+
"oauth_dcr",
|
|
1291
|
+
"oauth_cimd",
|
|
1292
|
+
"oauth_anthropic_creds",
|
|
1293
|
+
"custom_connection",
|
|
1294
|
+
"none"
|
|
1295
|
+
]);
|
|
1296
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1297
|
+
"first_party",
|
|
1298
|
+
"proxied",
|
|
1299
|
+
"third_party"
|
|
1300
|
+
]);
|
|
1301
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1302
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1303
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1304
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1305
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1306
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1307
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1308
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1309
|
+
"Public documentation for this connector will be live by the publish date."
|
|
1310
|
+
]);
|
|
1311
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1312
|
+
const claudeSubmissionFormDataSchema = z.object({
|
|
1313
|
+
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1314
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1315
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1316
|
+
name: z.string().max(100).describe(`The public display name for your connector as it appears in the directory. Use your brand/product name. You must
|
|
1317
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1318
|
+
slug: z.string().max(50).regex(/^[a-z0-9-]+$/).describe(`URL-safe identifier for your connector's directory page. Lowercase letters, numbers, and hyphens only.
|
|
1319
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1320
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1321
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1322
|
+
description: z.string().max(2e3).describe(`A description of what your connector does and its key features, shown on the connector's detail page in
|
|
1323
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1324
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1325
|
+
iconUrl: z.url().optional().describe(`Optional custom icon for the directory listing — a square SVG. By default the favicon from your MCP URL is used
|
|
1326
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1327
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1328
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1329
|
+
by your publish date.`),
|
|
1330
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1331
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1332
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1333
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1334
|
+
screenshots: z.array(screenshotEntrySchema).optional().describe(`Carousel images shown on your connector's directory page (PNG). Each is paired with the user prompt that produced
|
|
1335
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1336
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1337
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1338
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1339
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1340
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1341
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1342
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1343
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1344
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1345
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1346
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1347
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1348
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1349
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1350
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1351
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1352
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1353
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1354
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1355
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1356
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1357
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1358
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1359
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1360
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1361
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1362
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1363
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1364
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1365
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1366
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1367
|
+
fully populated account.`),
|
|
1368
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1369
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1370
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1371
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1372
|
+
});
|
|
1373
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1374
|
+
serverUrl: z.string().optional(),
|
|
1375
|
+
name: z.string().optional(),
|
|
1376
|
+
slug: z.string().optional(),
|
|
1377
|
+
oneLiner: z.string().optional(),
|
|
1378
|
+
description: z.string().optional(),
|
|
1379
|
+
iconUrl: z.string().optional(),
|
|
1380
|
+
documentation: z.string().optional(),
|
|
1381
|
+
support: z.string().optional(),
|
|
1382
|
+
privacyPolicy: z.string().optional(),
|
|
1383
|
+
companyWebsite: z.string().optional(),
|
|
1384
|
+
primaryContactEmail: z.string().optional(),
|
|
1385
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1386
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1387
|
+
});
|
|
1388
|
+
claudeSubmissionFormDataSchema.pick({
|
|
1389
|
+
serverUrl: true,
|
|
1390
|
+
name: true,
|
|
1391
|
+
slug: true,
|
|
1392
|
+
companyName: true,
|
|
1393
|
+
primaryContactEmail: true,
|
|
1394
|
+
primaryContactName: true,
|
|
1395
|
+
readWriteCapabilities: true,
|
|
1396
|
+
authentication: true,
|
|
1397
|
+
apiOwnership: true,
|
|
1398
|
+
personalHealthData: true
|
|
1399
|
+
}).extend({
|
|
1400
|
+
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1401
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1402
|
+
});
|
|
1403
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1404
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1405
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1406
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1407
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1408
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1409
|
+
});
|
|
1410
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1411
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1412
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1413
|
+
});
|
|
1414
|
+
const submissionMetaFieldsSchema = z.object({
|
|
1415
|
+
id: z.string(),
|
|
1416
|
+
environmentId: z.string(),
|
|
1417
|
+
auditId: z.string().nullable(),
|
|
1418
|
+
createdAt: z.coerce.date(),
|
|
1419
|
+
updatedAt: z.coerce.date()
|
|
1420
|
+
});
|
|
1421
|
+
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1422
|
+
platform: z.literal("claudeai"),
|
|
1423
|
+
formData: claudeSubmissionDraftSchema
|
|
1424
|
+
});
|
|
1425
|
+
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1426
|
+
platform: z.literal("chatgpt"),
|
|
1427
|
+
formData: chatgptSubmissionDraftSchema
|
|
1428
|
+
});
|
|
1429
|
+
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1430
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1431
|
+
z.literal([
|
|
1432
|
+
100,
|
|
1433
|
+
75,
|
|
1434
|
+
50
|
|
1435
|
+
]);
|
|
1436
|
+
const subscriptionPlanSchema = z.enum([
|
|
1437
|
+
"pro",
|
|
1438
|
+
"business",
|
|
1439
|
+
"enterprise"
|
|
1440
|
+
]);
|
|
1441
|
+
z.object({ plan: subscriptionPlanSchema.nullable() });
|
|
1442
|
+
const customerCreditsSchema = z.object({
|
|
1443
|
+
balanceInCents: z.number(),
|
|
1444
|
+
expiresAt: z.number().nullable(),
|
|
1445
|
+
currency: z.string()
|
|
1446
|
+
});
|
|
1447
|
+
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1448
|
+
z.object({
|
|
1449
|
+
customerCredits: customerCreditsSchema.nullable(),
|
|
1450
|
+
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1451
|
+
});
|
|
1452
|
+
const metricsQueueEventSchema = z.object({
|
|
1453
|
+
ts: z.number().int(),
|
|
1454
|
+
method: z.string(),
|
|
1455
|
+
tool: z.string().nullable(),
|
|
1456
|
+
client: z.string(),
|
|
1457
|
+
sessionId: z.string().nullable(),
|
|
1458
|
+
durationMs: z.number().int(),
|
|
1459
|
+
outputTokens: z.number().int().nullable(),
|
|
1460
|
+
errorType: z.enum([
|
|
1461
|
+
"mcp_error",
|
|
1462
|
+
"tool_error",
|
|
1463
|
+
"timeout"
|
|
1464
|
+
]).nullable(),
|
|
1465
|
+
errorCode: z.number().int().nullable()
|
|
1466
|
+
});
|
|
1467
|
+
z.object({
|
|
1468
|
+
v: z.literal(1),
|
|
1469
|
+
envId: z.string(),
|
|
1470
|
+
events: z.array(metricsQueueEventSchema)
|
|
1471
|
+
});
|
|
1472
|
+
z.object({ v: z.number() });
|
|
1473
|
+
const telemetrySignalSchema = z.enum([
|
|
1474
|
+
"logs",
|
|
1475
|
+
"metrics",
|
|
1476
|
+
"traces"
|
|
1477
|
+
]);
|
|
1478
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1479
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1480
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1481
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1482
|
+
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");
|
|
1483
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1484
|
+
id: z.string(),
|
|
1485
|
+
name: otlpHeaderNameSchema,
|
|
1486
|
+
value: otlpHeaderValueSchema,
|
|
1487
|
+
isSecret: z.boolean()
|
|
1488
|
+
});
|
|
1489
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1490
|
+
"credentials",
|
|
1491
|
+
"wrong-path",
|
|
1492
|
+
"wrong-protocol",
|
|
1493
|
+
"invalid-payload",
|
|
1494
|
+
"partial-rejection",
|
|
1495
|
+
"blocked-target",
|
|
1496
|
+
"timeout",
|
|
1497
|
+
"unreachable",
|
|
1498
|
+
"receiver-error",
|
|
1499
|
+
"unexpected-status"
|
|
1500
|
+
]);
|
|
1501
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1502
|
+
z.object({
|
|
1503
|
+
id: z.string(),
|
|
1504
|
+
signal: telemetrySignalSchema,
|
|
1505
|
+
endpoint: otlpEndpointSchema,
|
|
1506
|
+
protocol: otlpProtocolSchema,
|
|
1507
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1508
|
+
status: telemetryDestinationStatusSchema,
|
|
1509
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1510
|
+
});
|
|
1511
|
+
//#endregion
|
|
1512
|
+
//#region src/auth-scope.ts
|
|
1513
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1514
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1515
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1516
|
+
const AUTH_SCOPE_USER = "user";
|
|
1517
|
+
//#endregion
|
|
1518
|
+
//#region src/schemas.ts
|
|
1519
|
+
const RESERVED_KEYS = [
|
|
1520
|
+
"_HANDLER",
|
|
1521
|
+
"_X_AMZN_TRACE_ID",
|
|
1522
|
+
"AWS_DEFAULT_REGION",
|
|
1523
|
+
"AWS_REGION",
|
|
1524
|
+
"AWS_EXECUTION_ENV",
|
|
1525
|
+
"AWS_LAMBDA_FUNCTION_NAME",
|
|
1526
|
+
"AWS_LAMBDA_FUNCTION_MEMORY_SIZE",
|
|
1527
|
+
"AWS_LAMBDA_FUNCTION_VERSION",
|
|
1528
|
+
"AWS_LAMBDA_INITIALIZATION_TYPE",
|
|
1529
|
+
"AWS_LAMBDA_LOG_GROUP_NAME",
|
|
1530
|
+
"AWS_LAMBDA_LOG_STREAM_NAME",
|
|
1531
|
+
"AWS_ACCESS_KEY",
|
|
1532
|
+
"AWS_ACCESS_KEY_ID",
|
|
1533
|
+
"AWS_SECRET_ACCESS_KEY",
|
|
1534
|
+
"AWS_SESSION_TOKEN",
|
|
1535
|
+
"AWS_LAMBDA_RUNTIME_API",
|
|
1536
|
+
"LAMBDA_TASK_ROOT",
|
|
1537
|
+
"LAMBDA_RUNTIME_DIR",
|
|
1538
|
+
"START_COMMAND",
|
|
1539
|
+
"ENVIRONMENT_ID",
|
|
1540
|
+
"PROJECT_BUILD_IMAGES_REPOSITORY_URI",
|
|
1541
|
+
"ENVIRONMENT_LAMBDA_FUNCTION_ARN",
|
|
1542
|
+
"SOURCE_REPOSITORY",
|
|
1543
|
+
"SOURCE_BRANCH",
|
|
1544
|
+
"SOURCE_REPOSITORY_CREDENTIALS",
|
|
1545
|
+
"RUNTIME",
|
|
1546
|
+
"ROOT_DIRECTORY",
|
|
1547
|
+
"BUILD_ARG_INSTALL_COMMAND",
|
|
1548
|
+
"BUILD_ARG_BUILD_COMMAND",
|
|
1549
|
+
"BUILD_ARG_BUILD_OUTPUT_DIR",
|
|
1550
|
+
"BUILD_ARG_START_COMMAND",
|
|
1551
|
+
"ALPIC_HOST",
|
|
1552
|
+
"ALPIC_CUSTOM_DOMAINS",
|
|
1553
|
+
"ALPIC_INTENT_META_KEY",
|
|
1554
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1555
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1556
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1557
|
+
];
|
|
1558
|
+
const environmentVariableSchema = z.object({
|
|
1559
|
+
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"),
|
|
1560
|
+
value: z.string().min(1, "Value is required"),
|
|
1561
|
+
isSecret: z.boolean().default(false)
|
|
1562
|
+
});
|
|
1563
|
+
const environmentVariablesSchema = z.array(environmentVariableSchema);
|
|
1564
|
+
const updateEnvironmentVariableSchema = environmentVariableSchema.partial({
|
|
1565
|
+
value: true,
|
|
1566
|
+
isSecret: true
|
|
1567
|
+
});
|
|
1568
|
+
const buildSettingsSchema = z.object({
|
|
1569
|
+
installCommand: z.string().optional(),
|
|
1570
|
+
buildCommand: z.string().optional(),
|
|
1571
|
+
buildOutputDir: z.string().optional(),
|
|
1572
|
+
startCommand: z.string().optional()
|
|
1573
|
+
});
|
|
1574
|
+
const playgroundHeaderSchema = z.object({
|
|
1575
|
+
name: z.string().min(1).max(100),
|
|
1576
|
+
description: z.string().max(200),
|
|
1577
|
+
isRequired: z.boolean().default(false),
|
|
1578
|
+
isSecret: z.boolean().default(false)
|
|
1579
|
+
});
|
|
1580
|
+
const playgroundExamplePromptSchema = z.object({
|
|
1581
|
+
title: z.string().min(1).max(100),
|
|
1582
|
+
prompt: z.string().min(1).max(500)
|
|
1583
|
+
});
|
|
126
1584
|
const serverFieldsSchema = z.object({
|
|
127
1585
|
$schema: z.string(),
|
|
128
1586
|
name: z.string(),
|
|
@@ -148,6 +1606,14 @@ const serverFieldsSchema = z.object({
|
|
|
148
1606
|
});
|
|
149
1607
|
//#endregion
|
|
150
1608
|
//#region src/api.contract.ts
|
|
1609
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1610
|
+
try {
|
|
1611
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1612
|
+
return true;
|
|
1613
|
+
} catch {
|
|
1614
|
+
return false;
|
|
1615
|
+
}
|
|
1616
|
+
};
|
|
151
1617
|
const deploymentStatusSchema = z.enum([
|
|
152
1618
|
"ongoing",
|
|
153
1619
|
"deployed",
|
|
@@ -176,21 +1642,20 @@ const deploymentSchema = z.object({
|
|
|
176
1642
|
isCurrent: z.boolean(),
|
|
177
1643
|
deploymentPageUrl: z.url().nullable()
|
|
178
1644
|
});
|
|
179
|
-
const
|
|
1645
|
+
const isValidTimeInput = (value) => {
|
|
180
1646
|
if (ms(value) !== void 0) return true;
|
|
181
1647
|
return !Number.isNaN(new Date(value).getTime());
|
|
182
1648
|
};
|
|
183
|
-
const
|
|
1649
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1650
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1651
|
+
const createEnvironmentContractV1 = base.route({
|
|
184
1652
|
path: "/v1/environments",
|
|
185
1653
|
method: "POST",
|
|
186
1654
|
summary: "Create an environment",
|
|
187
1655
|
description: "Create an environment for a project",
|
|
188
1656
|
tags: ["environments"],
|
|
189
1657
|
successDescription: "The environment has been created successfully"
|
|
190
|
-
}).errors({
|
|
191
|
-
NOT_FOUND: {},
|
|
192
|
-
BAD_REQUEST: {}
|
|
193
|
-
}).input(z.object({
|
|
1658
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
194
1659
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
195
1660
|
name: z.string().min(1).describe("The name of the environment"),
|
|
196
1661
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -199,11 +1664,11 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
199
1664
|
id: z.string(),
|
|
200
1665
|
name: z.string(),
|
|
201
1666
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
202
|
-
urls: z.array(z.
|
|
1667
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
203
1668
|
createdAt: z.coerce.date(),
|
|
204
1669
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
205
1670
|
}));
|
|
206
|
-
const getEnvironmentContractV1 =
|
|
1671
|
+
const getEnvironmentContractV1 = base.route({
|
|
207
1672
|
path: "/v1/environments/{environmentId}",
|
|
208
1673
|
method: "GET",
|
|
209
1674
|
summary: "Get an environment",
|
|
@@ -215,7 +1680,7 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
215
1680
|
name: z.string(),
|
|
216
1681
|
sourceBranch: z.string().nullable(),
|
|
217
1682
|
mcpServerUrl: z.string(),
|
|
218
|
-
domains: z.array(z.
|
|
1683
|
+
domains: z.array(z.hostname()),
|
|
219
1684
|
createdAt: z.coerce.date(),
|
|
220
1685
|
projectId: z.string()
|
|
221
1686
|
}));
|
|
@@ -260,7 +1725,7 @@ const projectOutputSchema = z.object({
|
|
|
260
1725
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
261
1726
|
environments: z.array(environmentSchema)
|
|
262
1727
|
});
|
|
263
|
-
const getProjectContractV1 =
|
|
1728
|
+
const getProjectContractV1 = base.route({
|
|
264
1729
|
path: "/v1/projects/{projectId}",
|
|
265
1730
|
method: "GET",
|
|
266
1731
|
summary: "Get a project",
|
|
@@ -268,15 +1733,15 @@ const getProjectContractV1 = oc.route({
|
|
|
268
1733
|
tags: ["projects"],
|
|
269
1734
|
successDescription: "The project details"
|
|
270
1735
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
271
|
-
const listProjectsContractV1 =
|
|
1736
|
+
const listProjectsContractV1 = base.route({
|
|
272
1737
|
path: "/v1/projects",
|
|
273
1738
|
method: "GET",
|
|
274
1739
|
summary: "List projects",
|
|
275
1740
|
description: "List all projects for a team",
|
|
276
1741
|
tags: ["projects"],
|
|
277
1742
|
successDescription: "The list of projects"
|
|
278
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
279
|
-
const createProjectContractV1 =
|
|
1743
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1744
|
+
const createProjectContractV1 = base.route({
|
|
280
1745
|
path: "/v1/projects",
|
|
281
1746
|
method: "POST",
|
|
282
1747
|
summary: "Create a project",
|
|
@@ -285,7 +1750,7 @@ const createProjectContractV1 = oc.route({
|
|
|
285
1750
|
successDescription: "The project has been created successfully"
|
|
286
1751
|
}).errors({
|
|
287
1752
|
NOT_FOUND: {},
|
|
288
|
-
|
|
1753
|
+
FORBIDDEN: {}
|
|
289
1754
|
}).input(z.object({
|
|
290
1755
|
teamId: z.string().optional(),
|
|
291
1756
|
name: z.string().trim().min(1).max(100),
|
|
@@ -325,7 +1790,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
325
1790
|
isSecret: z.boolean(),
|
|
326
1791
|
createdAt: z.coerce.date()
|
|
327
1792
|
});
|
|
328
|
-
const listEnvironmentVariablesContractV1 =
|
|
1793
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
329
1794
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
330
1795
|
method: "GET",
|
|
331
1796
|
summary: "List environment variables",
|
|
@@ -333,37 +1798,31 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
333
1798
|
tags: ["environments"],
|
|
334
1799
|
successDescription: "The list of environment variables"
|
|
335
1800
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
336
|
-
const createEnvironmentVariablesContractV1 =
|
|
1801
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
337
1802
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
338
1803
|
method: "POST",
|
|
339
1804
|
summary: "Add environment variables",
|
|
340
1805
|
description: "Add one or more environment variables to an environment",
|
|
341
1806
|
tags: ["environments"],
|
|
342
1807
|
successDescription: "The environment variables have been added successfully"
|
|
343
|
-
}).errors({
|
|
344
|
-
NOT_FOUND: {},
|
|
345
|
-
BAD_REQUEST: {}
|
|
346
|
-
}).input(z.object({
|
|
1808
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
347
1809
|
environmentId: z.string().describe("The ID of the environment"),
|
|
348
1810
|
environmentVariables: environmentVariablesSchema
|
|
349
1811
|
})).output(z.object({ success: z.literal(true) }));
|
|
350
|
-
const updateEnvironmentVariableContractV1 =
|
|
1812
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
351
1813
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
352
1814
|
method: "PATCH",
|
|
353
1815
|
summary: "Update an environment variable",
|
|
354
1816
|
description: "Update an environment variable by ID",
|
|
355
1817
|
tags: ["environments"],
|
|
356
1818
|
successDescription: "The environment variable has been updated successfully"
|
|
357
|
-
}).errors({
|
|
358
|
-
NOT_FOUND: {},
|
|
359
|
-
BAD_REQUEST: {}
|
|
360
|
-
}).input(z.object({
|
|
1819
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
361
1820
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
362
1821
|
key: environmentVariableSchema.shape.key,
|
|
363
1822
|
value: environmentVariableSchema.shape.value.optional(),
|
|
364
|
-
isSecret: environmentVariableSchema.shape.isSecret
|
|
1823
|
+
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
365
1824
|
})).output(z.object({ success: z.literal(true) }));
|
|
366
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1825
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
367
1826
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
368
1827
|
method: "DELETE",
|
|
369
1828
|
summary: "Delete an environment variable",
|
|
@@ -371,15 +1830,15 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
371
1830
|
tags: ["environments"],
|
|
372
1831
|
successDescription: "The environment variable has been deleted successfully"
|
|
373
1832
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
374
|
-
const deleteProjectContractV1 =
|
|
375
|
-
path: "/v1/projects
|
|
1833
|
+
const deleteProjectContractV1 = base.route({
|
|
1834
|
+
path: "/v1/projects/{projectId}",
|
|
376
1835
|
method: "DELETE",
|
|
377
1836
|
summary: "Delete a project",
|
|
378
1837
|
description: "Delete a project and all its environments",
|
|
379
1838
|
tags: ["projects"],
|
|
380
1839
|
successDescription: "The project has been deleted successfully"
|
|
381
1840
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
382
|
-
const updateProjectContractV1 =
|
|
1841
|
+
const updateProjectContractV1 = base.route({
|
|
383
1842
|
path: "/v1/projects/{projectId}",
|
|
384
1843
|
method: "PATCH",
|
|
385
1844
|
summary: "Update a project",
|
|
@@ -388,13 +1847,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
388
1847
|
successDescription: "The project has been updated successfully"
|
|
389
1848
|
}).errors({
|
|
390
1849
|
NOT_FOUND: {},
|
|
391
|
-
|
|
1850
|
+
FORBIDDEN: {}
|
|
392
1851
|
}).input(z.object({
|
|
393
1852
|
projectId: z.string().describe("The ID of the project"),
|
|
394
1853
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
395
1854
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
396
1855
|
})).output(projectOutputSchema);
|
|
397
|
-
const deployEnvironmentContractV1 =
|
|
1856
|
+
const deployEnvironmentContractV1 = base.route({
|
|
398
1857
|
path: "/v1/environments/{environmentId}/deploy",
|
|
399
1858
|
method: "POST",
|
|
400
1859
|
summary: "Deploy an environment",
|
|
@@ -403,24 +1862,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
403
1862
|
successDescription: "The environment has been deployed successfully"
|
|
404
1863
|
}).errors({
|
|
405
1864
|
NOT_FOUND: {},
|
|
406
|
-
|
|
1865
|
+
CONFLICT: {}
|
|
407
1866
|
}).input(z.object({
|
|
408
1867
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
409
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1868
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1869
|
+
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.")
|
|
410
1870
|
})).output(deploymentSchema);
|
|
411
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1871
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
412
1872
|
path: "/v1/deployments/upload",
|
|
413
1873
|
method: "POST",
|
|
414
1874
|
summary: "Upload deployment artifacts",
|
|
415
1875
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
416
1876
|
tags: ["deployments"],
|
|
417
1877
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
418
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1878
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
419
1879
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
420
1880
|
token: z.string().describe("Token to identify the source archive"),
|
|
421
1881
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
422
1882
|
}));
|
|
423
|
-
const listDeploymentsContractV1 =
|
|
1883
|
+
const listDeploymentsContractV1 = base.route({
|
|
424
1884
|
path: "/v1/projects/{projectId}/deployments",
|
|
425
1885
|
method: "GET",
|
|
426
1886
|
summary: "List project deployments",
|
|
@@ -432,7 +1892,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
432
1892
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
433
1893
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
434
1894
|
})).output(z.array(deploymentSchema));
|
|
435
|
-
const getDeploymentContractV1 =
|
|
1895
|
+
const getDeploymentContractV1 = base.route({
|
|
436
1896
|
path: "/v1/deployments/{deploymentId}",
|
|
437
1897
|
method: "GET",
|
|
438
1898
|
summary: "Get a deployment",
|
|
@@ -440,20 +1900,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
440
1900
|
tags: ["deployments"],
|
|
441
1901
|
successDescription: "The deployment details"
|
|
442
1902
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
443
|
-
const
|
|
1903
|
+
const logEntrySchema = z.object({
|
|
1904
|
+
timestamp: z.coerce.date(),
|
|
1905
|
+
type: z.enum([
|
|
1906
|
+
"START",
|
|
1907
|
+
"END",
|
|
1908
|
+
"INFO",
|
|
1909
|
+
"ERROR",
|
|
1910
|
+
"WARNING",
|
|
1911
|
+
"DEBUG"
|
|
1912
|
+
]),
|
|
1913
|
+
requestId: z.string(),
|
|
1914
|
+
content: z.string().optional(),
|
|
1915
|
+
method: z.string().optional(),
|
|
1916
|
+
durationInMs: z.number().optional()
|
|
1917
|
+
});
|
|
1918
|
+
const getLogsContractV1 = base.route({
|
|
444
1919
|
path: "/v1/environments/{environmentId}/logs",
|
|
445
1920
|
method: "GET",
|
|
446
1921
|
summary: "Get logs",
|
|
447
1922
|
description: "Get logs for an environment",
|
|
448
1923
|
tags: ["environments"],
|
|
449
1924
|
successDescription: "The logs"
|
|
450
|
-
}).errors({
|
|
451
|
-
NOT_FOUND: {},
|
|
452
|
-
BAD_REQUEST: {}
|
|
453
|
-
}).input(z.object({
|
|
1925
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
454
1926
|
environmentId: z.string().describe("The ID of the environment"),
|
|
455
|
-
since:
|
|
456
|
-
until:
|
|
1927
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1928
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
457
1929
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
458
1930
|
level: z.array(z.enum([
|
|
459
1931
|
"INFO",
|
|
@@ -464,24 +1936,28 @@ const getLogsContractV1 = oc.route({
|
|
|
464
1936
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
465
1937
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
466
1938
|
})).output(z.object({
|
|
467
|
-
logs: z.array(
|
|
468
|
-
timestamp: z.coerce.date(),
|
|
469
|
-
type: z.enum([
|
|
470
|
-
"START",
|
|
471
|
-
"END",
|
|
472
|
-
"INFO",
|
|
473
|
-
"ERROR",
|
|
474
|
-
"WARNING",
|
|
475
|
-
"DEBUG"
|
|
476
|
-
]),
|
|
477
|
-
requestId: z.string(),
|
|
478
|
-
content: z.string().optional(),
|
|
479
|
-
method: z.string().optional(),
|
|
480
|
-
durationInMs: z.number().optional()
|
|
481
|
-
})),
|
|
1939
|
+
logs: z.array(logEntrySchema),
|
|
482
1940
|
nextToken: z.string().nullable()
|
|
483
1941
|
}));
|
|
484
|
-
const
|
|
1942
|
+
const getLatestLogsContractV1 = base.route({
|
|
1943
|
+
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1944
|
+
method: "GET",
|
|
1945
|
+
summary: "Get latest logs",
|
|
1946
|
+
description: "Get the N most recent logs for an environment",
|
|
1947
|
+
tags: ["environments"],
|
|
1948
|
+
successDescription: "The latest logs"
|
|
1949
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1950
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1951
|
+
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1952
|
+
level: z.array(z.enum([
|
|
1953
|
+
"INFO",
|
|
1954
|
+
"ERROR",
|
|
1955
|
+
"WARNING",
|
|
1956
|
+
"DEBUG"
|
|
1957
|
+
])).optional().describe("Filter by log level"),
|
|
1958
|
+
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1959
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1960
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
485
1961
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
486
1962
|
method: "GET",
|
|
487
1963
|
summary: "Get deployment logs",
|
|
@@ -508,22 +1984,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
508
1984
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
509
1985
|
task_count: z.array(analyticsDataPointSchema)
|
|
510
1986
|
});
|
|
511
|
-
const getProjectAnalyticsContractV1 =
|
|
1987
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
512
1988
|
path: "/v1/analytics/{projectId}",
|
|
513
1989
|
method: "GET",
|
|
514
1990
|
summary: "Get project analytics",
|
|
515
1991
|
description: "Get analytics data for a project over a time range",
|
|
516
1992
|
tags: ["analytics"],
|
|
517
1993
|
successDescription: "The project analytics data"
|
|
518
|
-
}).errors({
|
|
519
|
-
NOT_FOUND: {},
|
|
520
|
-
BAD_REQUEST: {}
|
|
521
|
-
}).input(z.object({
|
|
1994
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
522
1995
|
projectId: z.string().describe("The ID of the project"),
|
|
523
1996
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
524
1997
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
525
1998
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
526
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
1999
|
+
}).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 }) => isValidIanaTimeZone(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
527
2000
|
metadata: z.object({
|
|
528
2001
|
startTimestamp: z.number(),
|
|
529
2002
|
endTimestamp: z.number(),
|
|
@@ -533,7 +2006,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
533
2006
|
}),
|
|
534
2007
|
timeSeries: analyticsTimeSeriesSchema
|
|
535
2008
|
}));
|
|
536
|
-
const
|
|
2009
|
+
const paginatedInsightsInputShape = {
|
|
2010
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2011
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2012
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2013
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2014
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2015
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2016
|
+
};
|
|
2017
|
+
const listIntentsContractV1 = base.route({
|
|
2018
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2019
|
+
method: "GET",
|
|
2020
|
+
summary: "List intents",
|
|
2021
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2022
|
+
tags: ["insights"],
|
|
2023
|
+
successDescription: "The grouped user intents"
|
|
2024
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2025
|
+
...paginatedInsightsInputShape,
|
|
2026
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2027
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2028
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2029
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2030
|
+
})).output(z.object({
|
|
2031
|
+
intents: z.array(z.object({
|
|
2032
|
+
id: z.string(),
|
|
2033
|
+
intentIds: z.array(z.string()).min(1),
|
|
2034
|
+
environmentId: z.string(),
|
|
2035
|
+
message: z.string(),
|
|
2036
|
+
toolName: z.string(),
|
|
2037
|
+
createdAt: z.coerce.date(),
|
|
2038
|
+
occurrenceCount: z.number().int().positive(),
|
|
2039
|
+
clientName: z.string().nullable(),
|
|
2040
|
+
clientId: z.string().nullable(),
|
|
2041
|
+
categories: z.array(z.object({
|
|
2042
|
+
id: z.string(),
|
|
2043
|
+
name: z.string(),
|
|
2044
|
+
color: intentCategoryColorSchema
|
|
2045
|
+
}))
|
|
2046
|
+
})),
|
|
2047
|
+
totalCount: z.number().int().nonnegative()
|
|
2048
|
+
}));
|
|
2049
|
+
const listFeedbacksContractV1 = base.route({
|
|
2050
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2051
|
+
method: "GET",
|
|
2052
|
+
summary: "List feedbacks",
|
|
2053
|
+
description: "List user feedback for an environment over a time range",
|
|
2054
|
+
tags: ["insights"],
|
|
2055
|
+
successDescription: "The user feedback"
|
|
2056
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2057
|
+
...paginatedInsightsInputShape,
|
|
2058
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2059
|
+
})).output(z.object({
|
|
2060
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2061
|
+
totalCount: z.number().int().nonnegative()
|
|
2062
|
+
}));
|
|
2063
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2064
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2065
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2066
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2067
|
+
method: "GET",
|
|
2068
|
+
summary: "List intent categories",
|
|
2069
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2070
|
+
tags: ["insights"],
|
|
2071
|
+
successDescription: "The intent categories"
|
|
2072
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2073
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2074
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2075
|
+
method: "POST",
|
|
2076
|
+
summary: "Create an intent category",
|
|
2077
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2078
|
+
tags: ["insights"],
|
|
2079
|
+
successDescription: "The created intent category"
|
|
2080
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2081
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2082
|
+
name: intentCategoryNameSchema,
|
|
2083
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2084
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2085
|
+
})).output(intentCategorySchema);
|
|
2086
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2087
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2088
|
+
method: "PATCH",
|
|
2089
|
+
summary: "Update an intent category",
|
|
2090
|
+
description: "Rename or recolor an intent category",
|
|
2091
|
+
tags: ["insights"],
|
|
2092
|
+
successDescription: "The updated intent category"
|
|
2093
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2094
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2095
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2096
|
+
name: intentCategoryNameSchema.optional(),
|
|
2097
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2098
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2099
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2100
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2101
|
+
method: "DELETE",
|
|
2102
|
+
summary: "Delete an intent category",
|
|
2103
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2104
|
+
tags: ["insights"],
|
|
2105
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2106
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2107
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2108
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2109
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2110
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2111
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2112
|
+
method: "POST",
|
|
2113
|
+
summary: "Link an intent category",
|
|
2114
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2115
|
+
tags: ["insights"],
|
|
2116
|
+
successDescription: "The intents have been linked successfully"
|
|
2117
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2118
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2119
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2120
|
+
intentIds: categorizableIntentIdsSchema
|
|
2121
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2122
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2123
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2124
|
+
method: "POST",
|
|
2125
|
+
summary: "Unlink an intent category",
|
|
2126
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2127
|
+
tags: ["insights"],
|
|
2128
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2129
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2130
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2131
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2132
|
+
intentIds: categorizableIntentIdsSchema
|
|
2133
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2134
|
+
const listTeamsContractV1 = base.route({
|
|
537
2135
|
path: "/v1/teams",
|
|
538
2136
|
method: "GET",
|
|
539
2137
|
summary: "List teams",
|
|
@@ -546,28 +2144,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
546
2144
|
createdAt: z.coerce.date(),
|
|
547
2145
|
hasStripeAccount: z.boolean()
|
|
548
2146
|
})));
|
|
549
|
-
const
|
|
2147
|
+
const getTeamUsageContractV1 = base.route({
|
|
2148
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2149
|
+
method: "GET",
|
|
2150
|
+
summary: "Get team usage",
|
|
2151
|
+
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.",
|
|
2152
|
+
tags: ["teams"],
|
|
2153
|
+
successDescription: "The current billing window usage"
|
|
2154
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2155
|
+
teamId: z.string(),
|
|
2156
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2157
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2158
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2159
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2160
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2161
|
+
}));
|
|
2162
|
+
const getTunnelTicketContractV1 = base.route({
|
|
550
2163
|
path: "/v1/tunnels/ticket",
|
|
551
2164
|
method: "GET",
|
|
552
2165
|
summary: "Get a tunnel ticket",
|
|
553
2166
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
554
2167
|
tags: ["tunnels"],
|
|
555
2168
|
successDescription: "The tunnel ticket"
|
|
556
|
-
}).output(z.object({
|
|
2169
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
557
2170
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
558
2171
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
559
2172
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
560
2173
|
}));
|
|
561
|
-
const publishServerContractV1 =
|
|
2174
|
+
const publishServerContractV1 = base.route({
|
|
562
2175
|
path: "/v1/distribution/publish",
|
|
563
2176
|
method: "POST",
|
|
564
2177
|
summary: "Publish a server to the MCP registry",
|
|
565
2178
|
tags: ["distribution"],
|
|
566
2179
|
successDescription: "The server has been published successfully"
|
|
567
|
-
}).errors({
|
|
568
|
-
NOT_FOUND: {},
|
|
569
|
-
BAD_REQUEST: {}
|
|
570
|
-
}).input(z.object({
|
|
2180
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
571
2181
|
projectId: z.string(),
|
|
572
2182
|
domain: z.string(),
|
|
573
2183
|
title: z.string().min(1).max(100),
|
|
@@ -576,53 +2186,102 @@ const publishServerContractV1 = oc.route({
|
|
|
576
2186
|
iconSrc: z.url().max(255).optional(),
|
|
577
2187
|
dryRun: z.boolean().optional()
|
|
578
2188
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
579
|
-
const getServerInfoContractV1 =
|
|
2189
|
+
const getServerInfoContractV1 = base.route({
|
|
580
2190
|
path: "/v1/distribution/get",
|
|
581
2191
|
method: "GET",
|
|
582
2192
|
summary: "Get server info",
|
|
583
2193
|
description: "Get info about a server",
|
|
584
2194
|
tags: ["distribution"],
|
|
585
2195
|
successDescription: "The server info"
|
|
586
|
-
}).errors({
|
|
587
|
-
NOT_FOUND: {},
|
|
588
|
-
BAD_REQUEST: {}
|
|
589
|
-
}).input(z.object({
|
|
2196
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
590
2197
|
projectId: z.string(),
|
|
591
2198
|
domain: z.string()
|
|
592
2199
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
593
|
-
const
|
|
594
|
-
|
|
2200
|
+
const playgroundServerMetadataOutputSchema = z.object({
|
|
2201
|
+
name: z.string(),
|
|
2202
|
+
description: z.string(),
|
|
2203
|
+
headers: z.array(z.object({
|
|
2204
|
+
name: z.string(),
|
|
2205
|
+
description: z.string(),
|
|
2206
|
+
isRequired: z.boolean(),
|
|
2207
|
+
isSecret: z.boolean()
|
|
2208
|
+
})),
|
|
2209
|
+
examplePrompts: z.array(playgroundExamplePromptSchema)
|
|
2210
|
+
});
|
|
2211
|
+
const playgroundOutputSchema = z.object({
|
|
2212
|
+
isPlaygroundEnabled: z.boolean(),
|
|
2213
|
+
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
2214
|
+
});
|
|
2215
|
+
const getPlaygroundContractV1 = base.route({
|
|
2216
|
+
path: "/v1/environments/{environmentId}/playground",
|
|
2217
|
+
method: "GET",
|
|
2218
|
+
summary: "Get playground configuration",
|
|
2219
|
+
description: "Get the playground configuration for an environment",
|
|
2220
|
+
tags: ["environments"],
|
|
2221
|
+
successDescription: "The playground configuration"
|
|
2222
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
2223
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
2224
|
+
path: "/v1/environments/{environmentId}/playground",
|
|
2225
|
+
method: "PUT",
|
|
2226
|
+
summary: "Update playground configuration",
|
|
2227
|
+
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
2228
|
+
tags: ["environments"],
|
|
2229
|
+
successDescription: "The updated playground configuration"
|
|
2230
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2231
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2232
|
+
isPlaygroundEnabled: z.boolean().optional(),
|
|
2233
|
+
name: z.string().min(1).max(100).optional(),
|
|
2234
|
+
description: z.string().min(1).max(500).optional(),
|
|
2235
|
+
headers: z.array(playgroundHeaderSchema).optional(),
|
|
2236
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
2237
|
+
})).output(playgroundOutputSchema);
|
|
2238
|
+
const createBeaconContractV1 = base.route({
|
|
2239
|
+
path: "/v1/beacon/audits",
|
|
595
2240
|
method: "POST",
|
|
596
|
-
summary: "Create a beacon
|
|
597
|
-
description: "
|
|
2241
|
+
summary: "Create a beacon audit",
|
|
2242
|
+
description: "Audit an MCP server for spec compliance and AI client compatibility",
|
|
598
2243
|
tags: ["beacon"],
|
|
599
|
-
successDescription: "The
|
|
2244
|
+
successDescription: "The audit has been created"
|
|
600
2245
|
}).errors({
|
|
601
2246
|
NOT_FOUND: {},
|
|
602
|
-
|
|
2247
|
+
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
603
2248
|
}).input(z.object({
|
|
604
|
-
targetUrl: z.
|
|
605
|
-
teamId: z.string().optional().describe("The team ID to associate the
|
|
606
|
-
projectId: z.string().optional().describe("The project ID to associate the
|
|
2249
|
+
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
2250
|
+
teamId: z.string().optional().describe("The team ID to associate the audit with"),
|
|
2251
|
+
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
2252
|
+
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
607
2253
|
})).output(z.object({ id: z.string() }));
|
|
608
|
-
const getBeaconContractV1 =
|
|
609
|
-
path: "/v1/beacon/
|
|
2254
|
+
const getBeaconContractV1 = base.route({
|
|
2255
|
+
path: "/v1/beacon/audits/{auditId}",
|
|
610
2256
|
method: "GET",
|
|
611
|
-
summary: "Get a beacon
|
|
612
|
-
description: "Get a beacon
|
|
2257
|
+
summary: "Get a beacon audit",
|
|
2258
|
+
description: "Get a beacon audit by ID, including the report if completed",
|
|
613
2259
|
tags: ["beacon"],
|
|
614
|
-
successDescription: "The
|
|
615
|
-
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2260
|
+
successDescription: "The audit details"
|
|
2261
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ auditId: z.string().describe("The ID of the audit") })).output(z.object({
|
|
616
2262
|
id: z.string(),
|
|
617
2263
|
targetUrl: z.string(),
|
|
618
|
-
status:
|
|
2264
|
+
status: auditStatusSchema,
|
|
619
2265
|
durationMs: z.number().nullable(),
|
|
620
2266
|
createdAt: z.coerce.date(),
|
|
621
|
-
report:
|
|
2267
|
+
report: auditReportWithScreenshotsSchema.nullable()
|
|
622
2268
|
}));
|
|
623
2269
|
const contract = {
|
|
624
|
-
teams: {
|
|
2270
|
+
teams: {
|
|
2271
|
+
list: { v1: listTeamsContractV1 },
|
|
2272
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2273
|
+
},
|
|
625
2274
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2275
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2276
|
+
intentCategories: {
|
|
2277
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2278
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2279
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2280
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2281
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2282
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2283
|
+
},
|
|
2284
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
626
2285
|
deployments: {
|
|
627
2286
|
list: { v1: listDeploymentsContractV1 },
|
|
628
2287
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -633,7 +2292,8 @@ const contract = {
|
|
|
633
2292
|
create: { v1: createEnvironmentContractV1 },
|
|
634
2293
|
get: { v1: getEnvironmentContractV1 },
|
|
635
2294
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
636
|
-
getLogs: { v1: getLogsContractV1 }
|
|
2295
|
+
getLogs: { v1: getLogsContractV1 },
|
|
2296
|
+
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
637
2297
|
},
|
|
638
2298
|
environmentVariables: {
|
|
639
2299
|
list: { v1: listEnvironmentVariablesContractV1 },
|
|
@@ -648,6 +2308,10 @@ const contract = {
|
|
|
648
2308
|
create: { v1: createProjectContractV1 },
|
|
649
2309
|
delete: { v1: deleteProjectContractV1 }
|
|
650
2310
|
},
|
|
2311
|
+
playground: {
|
|
2312
|
+
get: { v1: getPlaygroundContractV1 },
|
|
2313
|
+
upsert: { v1: upsertPlaygroundContractV1 }
|
|
2314
|
+
},
|
|
651
2315
|
tunnels: { getTicket: { v1: getTunnelTicketContractV1 } },
|
|
652
2316
|
distribution: {
|
|
653
2317
|
publish: { v1: publishServerContractV1 },
|
|
@@ -658,5 +2322,10 @@ const contract = {
|
|
|
658
2322
|
get: { v1: getBeaconContractV1 }
|
|
659
2323
|
}
|
|
660
2324
|
};
|
|
2325
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2326
|
+
const contractForDocs = {
|
|
2327
|
+
...contract,
|
|
2328
|
+
deployments: deploymentsForDocs
|
|
2329
|
+
};
|
|
661
2330
|
//#endregion
|
|
662
|
-
export {
|
|
2331
|
+
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 };
|