@alpic-ai/api 0.0.0-dev.gf7fc4b5 → 0.0.0-dev.gf80bbbb
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 +1292 -77
- package/dist/index.mjs +1380 -318
- package/package.json +17 -10
package/dist/index.mjs
CHANGED
|
@@ -1,11 +1,189 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
|
+
import * as z$1 from "zod/v4";
|
|
2
3
|
import { oc } from "@orpc/contract";
|
|
3
4
|
import ms from "ms";
|
|
4
|
-
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
|
+
/**
|
|
7
|
+
* Reusable URL validation that disallows javascript: scheme
|
|
8
|
+
*/
|
|
9
|
+
const SafeUrlSchema = z$1.url().superRefine((val, ctx) => {
|
|
10
|
+
if (!URL.canParse(val)) {
|
|
11
|
+
ctx.addIssue({
|
|
12
|
+
code: z$1.ZodIssueCode.custom,
|
|
13
|
+
message: "URL must be parseable",
|
|
14
|
+
fatal: true
|
|
15
|
+
});
|
|
16
|
+
return z$1.NEVER;
|
|
17
|
+
}
|
|
18
|
+
}).refine((url) => {
|
|
19
|
+
const u = new URL(url);
|
|
20
|
+
return u.protocol !== "javascript:" && u.protocol !== "data:" && u.protocol !== "vbscript:";
|
|
21
|
+
}, { message: "URL cannot use javascript:, data:, or vbscript: scheme" });
|
|
22
|
+
/**
|
|
23
|
+
* RFC 9728 OAuth Protected Resource Metadata
|
|
24
|
+
*/
|
|
25
|
+
const OAuthProtectedResourceMetadataSchema = z$1.looseObject({
|
|
26
|
+
resource: z$1.string().url(),
|
|
27
|
+
authorization_servers: z$1.array(SafeUrlSchema).optional(),
|
|
28
|
+
jwks_uri: z$1.string().url().optional(),
|
|
29
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
30
|
+
bearer_methods_supported: z$1.array(z$1.string()).optional(),
|
|
31
|
+
resource_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
32
|
+
resource_name: z$1.string().optional(),
|
|
33
|
+
resource_documentation: z$1.string().optional(),
|
|
34
|
+
resource_policy_uri: z$1.string().url().optional(),
|
|
35
|
+
resource_tos_uri: z$1.string().url().optional(),
|
|
36
|
+
tls_client_certificate_bound_access_tokens: z$1.boolean().optional(),
|
|
37
|
+
authorization_details_types_supported: z$1.array(z$1.string()).optional(),
|
|
38
|
+
dpop_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
39
|
+
dpop_bound_access_tokens_required: z$1.boolean().optional()
|
|
40
|
+
});
|
|
41
|
+
/**
|
|
42
|
+
* RFC 8414 OAuth 2.0 Authorization Server Metadata
|
|
43
|
+
*/
|
|
44
|
+
const OAuthMetadataSchema = z$1.looseObject({
|
|
45
|
+
issuer: z$1.string(),
|
|
46
|
+
authorization_endpoint: SafeUrlSchema,
|
|
47
|
+
token_endpoint: SafeUrlSchema,
|
|
48
|
+
registration_endpoint: SafeUrlSchema.optional(),
|
|
49
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
50
|
+
response_types_supported: z$1.array(z$1.string()),
|
|
51
|
+
response_modes_supported: z$1.array(z$1.string()).optional(),
|
|
52
|
+
grant_types_supported: z$1.array(z$1.string()).optional(),
|
|
53
|
+
token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
54
|
+
token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
55
|
+
service_documentation: SafeUrlSchema.optional(),
|
|
56
|
+
revocation_endpoint: SafeUrlSchema.optional(),
|
|
57
|
+
revocation_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
58
|
+
revocation_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
59
|
+
introspection_endpoint: z$1.string().optional(),
|
|
60
|
+
introspection_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
61
|
+
introspection_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
62
|
+
code_challenge_methods_supported: z$1.array(z$1.string()).optional(),
|
|
63
|
+
client_id_metadata_document_supported: z$1.boolean().optional()
|
|
64
|
+
});
|
|
65
|
+
/**
|
|
66
|
+
* OpenID Connect Discovery 1.0 Provider Metadata
|
|
67
|
+
* see: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
|
|
68
|
+
*/
|
|
69
|
+
const OpenIdProviderMetadataSchema = z$1.looseObject({
|
|
70
|
+
issuer: z$1.string(),
|
|
71
|
+
authorization_endpoint: SafeUrlSchema,
|
|
72
|
+
token_endpoint: SafeUrlSchema,
|
|
73
|
+
userinfo_endpoint: SafeUrlSchema.optional(),
|
|
74
|
+
jwks_uri: SafeUrlSchema,
|
|
75
|
+
registration_endpoint: SafeUrlSchema.optional(),
|
|
76
|
+
scopes_supported: z$1.array(z$1.string()).optional(),
|
|
77
|
+
response_types_supported: z$1.array(z$1.string()),
|
|
78
|
+
response_modes_supported: z$1.array(z$1.string()).optional(),
|
|
79
|
+
grant_types_supported: z$1.array(z$1.string()).optional(),
|
|
80
|
+
acr_values_supported: z$1.array(z$1.string()).optional(),
|
|
81
|
+
subject_types_supported: z$1.array(z$1.string()),
|
|
82
|
+
id_token_signing_alg_values_supported: z$1.array(z$1.string()),
|
|
83
|
+
id_token_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
84
|
+
id_token_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
85
|
+
userinfo_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
86
|
+
userinfo_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
87
|
+
userinfo_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
88
|
+
request_object_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
89
|
+
request_object_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
90
|
+
request_object_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
|
|
91
|
+
token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
|
|
92
|
+
token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
|
|
93
|
+
display_values_supported: z$1.array(z$1.string()).optional(),
|
|
94
|
+
claim_types_supported: z$1.array(z$1.string()).optional(),
|
|
95
|
+
claims_supported: z$1.array(z$1.string()).optional(),
|
|
96
|
+
service_documentation: z$1.string().optional(),
|
|
97
|
+
claims_locales_supported: z$1.array(z$1.string()).optional(),
|
|
98
|
+
ui_locales_supported: z$1.array(z$1.string()).optional(),
|
|
99
|
+
claims_parameter_supported: z$1.boolean().optional(),
|
|
100
|
+
request_parameter_supported: z$1.boolean().optional(),
|
|
101
|
+
request_uri_parameter_supported: z$1.boolean().optional(),
|
|
102
|
+
require_request_uri_registration: z$1.boolean().optional(),
|
|
103
|
+
op_policy_uri: SafeUrlSchema.optional(),
|
|
104
|
+
op_tos_uri: SafeUrlSchema.optional(),
|
|
105
|
+
client_id_metadata_document_supported: z$1.boolean().optional()
|
|
106
|
+
});
|
|
107
|
+
/**
|
|
108
|
+
* OpenID Connect Discovery metadata that may include OAuth 2.0 fields
|
|
109
|
+
* This schema represents the real-world scenario where OIDC providers
|
|
110
|
+
* return a mix of OpenID Connect and OAuth 2.0 metadata fields
|
|
111
|
+
*/
|
|
112
|
+
const OpenIdProviderDiscoveryMetadataSchema = z$1.object({
|
|
113
|
+
...OpenIdProviderMetadataSchema.shape,
|
|
114
|
+
...OAuthMetadataSchema.pick({ code_challenge_methods_supported: true }).shape
|
|
115
|
+
});
|
|
116
|
+
z$1.object({
|
|
117
|
+
access_token: z$1.string(),
|
|
118
|
+
id_token: z$1.string().optional(),
|
|
119
|
+
token_type: z$1.string(),
|
|
120
|
+
expires_in: z$1.coerce.number().optional(),
|
|
121
|
+
scope: z$1.string().optional(),
|
|
122
|
+
refresh_token: z$1.string().optional()
|
|
123
|
+
}).strip();
|
|
124
|
+
z$1.object({
|
|
125
|
+
error: z$1.string(),
|
|
126
|
+
error_description: z$1.string().optional(),
|
|
127
|
+
error_uri: z$1.string().optional()
|
|
128
|
+
});
|
|
129
|
+
/**
|
|
130
|
+
* Optional version of SafeUrlSchema that allows empty string for retrocompatibility on tos_uri and logo_uri
|
|
131
|
+
*/
|
|
132
|
+
const OptionalSafeUrlSchema = SafeUrlSchema.optional().or(z$1.literal("").transform(() => void 0));
|
|
133
|
+
/**
|
|
134
|
+
* RFC 7591 OAuth 2.0 Dynamic Client Registration metadata
|
|
135
|
+
*/
|
|
136
|
+
const OAuthClientMetadataSchema = z$1.object({
|
|
137
|
+
redirect_uris: z$1.array(SafeUrlSchema),
|
|
138
|
+
token_endpoint_auth_method: z$1.string().optional(),
|
|
139
|
+
grant_types: z$1.array(z$1.string()).optional(),
|
|
140
|
+
response_types: z$1.array(z$1.string()).optional(),
|
|
141
|
+
client_name: z$1.string().optional(),
|
|
142
|
+
client_uri: SafeUrlSchema.optional(),
|
|
143
|
+
logo_uri: OptionalSafeUrlSchema,
|
|
144
|
+
scope: z$1.string().optional(),
|
|
145
|
+
contacts: z$1.array(z$1.string()).optional(),
|
|
146
|
+
tos_uri: OptionalSafeUrlSchema,
|
|
147
|
+
policy_uri: z$1.string().optional(),
|
|
148
|
+
jwks_uri: SafeUrlSchema.optional(),
|
|
149
|
+
jwks: z$1.any().optional(),
|
|
150
|
+
software_id: z$1.string().optional(),
|
|
151
|
+
software_version: z$1.string().optional(),
|
|
152
|
+
software_statement: z$1.string().optional()
|
|
153
|
+
}).strip();
|
|
154
|
+
/**
|
|
155
|
+
* RFC 7591 OAuth 2.0 Dynamic Client Registration client information
|
|
156
|
+
*/
|
|
157
|
+
const OAuthClientInformationSchema = z$1.object({
|
|
158
|
+
client_id: z$1.string(),
|
|
159
|
+
client_secret: z$1.string().optional(),
|
|
160
|
+
client_id_issued_at: z$1.number().optional(),
|
|
161
|
+
client_secret_expires_at: z$1.number().optional()
|
|
162
|
+
}).strip();
|
|
163
|
+
OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
|
|
164
|
+
z$1.object({
|
|
165
|
+
error: z$1.string(),
|
|
166
|
+
error_description: z$1.string().optional()
|
|
167
|
+
}).strip();
|
|
168
|
+
z$1.object({
|
|
169
|
+
token: z$1.string(),
|
|
170
|
+
token_type_hint: z$1.string().optional()
|
|
171
|
+
}).strip();
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
5
176
|
const PLATFORM_LABELS = {
|
|
6
177
|
chatgpt: "ChatGPT",
|
|
7
178
|
claudeai: "Claude.ai"
|
|
8
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cloudflare",
|
|
183
|
+
"fastly"
|
|
184
|
+
];
|
|
185
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
186
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
9
187
|
const auditStatusSchema = z.enum([
|
|
10
188
|
"pending",
|
|
11
189
|
"partial",
|
|
@@ -71,7 +249,14 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
|
|
|
71
249
|
chatgpt: widgetScreenshotSchema.optional(),
|
|
72
250
|
claudeai: widgetScreenshotSchema.optional()
|
|
73
251
|
}) });
|
|
74
|
-
z.
|
|
252
|
+
z.object({
|
|
253
|
+
id: z.string(),
|
|
254
|
+
environmentId: z.string(),
|
|
255
|
+
clientId: z.string(),
|
|
256
|
+
clientSecret: z.string(),
|
|
257
|
+
clientScopes: z.array(z.string())
|
|
258
|
+
});
|
|
259
|
+
const deploymentStatusSchema$1 = z.enum([
|
|
75
260
|
"ongoing",
|
|
76
261
|
"deployed",
|
|
77
262
|
"failed",
|
|
@@ -81,17 +266,235 @@ z.object({
|
|
|
81
266
|
timestamp: z.coerce.date().optional(),
|
|
82
267
|
content: z.string().optional()
|
|
83
268
|
});
|
|
269
|
+
const deploymentSummarySchema = z.object({
|
|
270
|
+
id: z.string(),
|
|
271
|
+
status: deploymentStatusSchema$1,
|
|
272
|
+
sourceBucket: z.string().nullable(),
|
|
273
|
+
sourceObjectKey: z.string().nullable(),
|
|
274
|
+
sourceRef: z.string().nullable(),
|
|
275
|
+
sourceCommitId: z.string().nullable(),
|
|
276
|
+
sourceCommitMessage: z.string().nullable(),
|
|
277
|
+
environmentId: z.string(),
|
|
278
|
+
authorUsername: z.string().nullable(),
|
|
279
|
+
authorAvatarUrl: z.string().nullable(),
|
|
280
|
+
startedAt: z.coerce.date().nullable(),
|
|
281
|
+
completedAt: z.coerce.date().nullable(),
|
|
282
|
+
isCurrent: z.boolean().optional(),
|
|
283
|
+
createdAt: z.coerce.date(),
|
|
284
|
+
updatedAt: z.coerce.date()
|
|
285
|
+
});
|
|
286
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
287
|
+
const publicEnvironmentSchema = z.object({
|
|
288
|
+
allowsAnonymous: z.literal(true),
|
|
289
|
+
oAuthMetadata: z.strictObject({})
|
|
290
|
+
});
|
|
291
|
+
/** 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. */
|
|
292
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
293
|
+
allowsAnonymous: z.boolean(),
|
|
294
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
295
|
+
scope: z.string().optional()
|
|
296
|
+
});
|
|
297
|
+
/** 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. */
|
|
298
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
299
|
+
allowsAnonymous: z.boolean(),
|
|
300
|
+
oAuthMetadata: z.object({
|
|
301
|
+
externalAuthorizationServerUrl: z.url(),
|
|
302
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
303
|
+
}),
|
|
304
|
+
scope: z.string().optional()
|
|
305
|
+
});
|
|
306
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
307
|
+
const standaloneEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.boolean(),
|
|
309
|
+
oAuthMetadata: z.object({
|
|
310
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
311
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
312
|
+
}),
|
|
313
|
+
scope: z.string().optional()
|
|
314
|
+
});
|
|
315
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
316
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
317
|
+
allowsAnonymous: z.literal(false),
|
|
318
|
+
oAuthMetadata: z.strictObject({}),
|
|
319
|
+
scope: z.string().optional()
|
|
320
|
+
});
|
|
321
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
322
|
+
isPublic: z.literal(true),
|
|
323
|
+
oAuthMetadata: z.undefined().optional()
|
|
324
|
+
});
|
|
325
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
326
|
+
isPublic: z.literal(false),
|
|
327
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
328
|
+
scope: z.string().optional()
|
|
329
|
+
});
|
|
330
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
331
|
+
isPublic: z.literal(false),
|
|
332
|
+
oAuthMetadata: z.object({
|
|
333
|
+
externalAuthorizationServerUrl: z.url(),
|
|
334
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
335
|
+
}),
|
|
336
|
+
scope: z.string().optional()
|
|
337
|
+
});
|
|
338
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
339
|
+
isPublic: z.literal(false),
|
|
340
|
+
oAuthMetadata: z.object({
|
|
341
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
342
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
343
|
+
}),
|
|
344
|
+
scope: z.string().optional()
|
|
345
|
+
});
|
|
346
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
347
|
+
isPublic: z.literal(false),
|
|
348
|
+
oAuthMetadata: z.strictObject({}),
|
|
349
|
+
scope: z.string().optional()
|
|
350
|
+
});
|
|
351
|
+
z.union([
|
|
352
|
+
publicEnvironmentSchema,
|
|
353
|
+
externalResourceMetadataEnvironmentSchema,
|
|
354
|
+
externalAuthorizationServerEnvironmentSchema,
|
|
355
|
+
standaloneEnvironmentSchema,
|
|
356
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
357
|
+
legacyPublicEnvironmentSchema,
|
|
358
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
359
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
360
|
+
legacyStandaloneEnvironmentSchema,
|
|
361
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
362
|
+
]);
|
|
363
|
+
const playgroundModelSchema = z.enum([
|
|
364
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
365
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
366
|
+
"openai.gpt-5.4",
|
|
367
|
+
"openai.gpt-5.5"
|
|
368
|
+
]);
|
|
369
|
+
const environmentDomainSchema = z.object({
|
|
370
|
+
name: z.string(),
|
|
371
|
+
status: z.enum([
|
|
372
|
+
"ongoing",
|
|
373
|
+
"deployed",
|
|
374
|
+
"failed"
|
|
375
|
+
]),
|
|
376
|
+
createdAt: z.coerce.date(),
|
|
377
|
+
updatedAt: z.coerce.date()
|
|
378
|
+
});
|
|
379
|
+
const environmentSchema$1 = z.object({
|
|
380
|
+
id: z.string(),
|
|
381
|
+
name: z.string(),
|
|
382
|
+
sourceBranch: z.string().nullable(),
|
|
383
|
+
mcpServerUrl: z.string(),
|
|
384
|
+
activeDeployment: deploymentSummarySchema.optional(),
|
|
385
|
+
latestDeployment: deploymentSummarySchema.optional(),
|
|
386
|
+
openaiAppsChallenge: z.string().nullable().optional(),
|
|
387
|
+
isPlaygroundEnabled: z.boolean(),
|
|
388
|
+
playgroundModel: playgroundModelSchema,
|
|
389
|
+
isIpWhitelistEnabled: z.boolean(),
|
|
390
|
+
ipAllowlist: z.array(z.string()).nullable(),
|
|
391
|
+
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
392
|
+
projectId: z.string(),
|
|
393
|
+
createdAt: z.coerce.date(),
|
|
394
|
+
updatedAt: z.coerce.date()
|
|
395
|
+
});
|
|
396
|
+
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
84
397
|
z.object({
|
|
398
|
+
sessionReplayEnabled: z.boolean(),
|
|
399
|
+
collectRequestPayload: z.boolean(),
|
|
400
|
+
collectResponsePayload: z.boolean(),
|
|
401
|
+
collectErrorMessage: z.boolean(),
|
|
402
|
+
collectUserData: z.boolean(),
|
|
403
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
404
|
+
});
|
|
405
|
+
const feedbackSchema = z.object({
|
|
85
406
|
id: z.string(),
|
|
86
407
|
createdAt: z.coerce.date(),
|
|
87
408
|
environmentId: z.string(),
|
|
88
409
|
content: z.string(),
|
|
89
|
-
source: z.enum(["model", "user"])
|
|
410
|
+
source: z.enum(["model", "user"]),
|
|
411
|
+
clientName: z.string().nullable()
|
|
90
412
|
});
|
|
91
413
|
z.object({
|
|
92
414
|
content: z.string(),
|
|
93
415
|
source: z.enum(["model", "user"])
|
|
94
416
|
});
|
|
417
|
+
const intentCategoryColorSchema = z.enum([
|
|
418
|
+
"red",
|
|
419
|
+
"orange",
|
|
420
|
+
"yellow",
|
|
421
|
+
"green",
|
|
422
|
+
"blue",
|
|
423
|
+
"purple",
|
|
424
|
+
"pink",
|
|
425
|
+
"gray"
|
|
426
|
+
]);
|
|
427
|
+
intentCategoryColorSchema.options;
|
|
428
|
+
const intentCategorySchema = z.object({
|
|
429
|
+
id: z.string(),
|
|
430
|
+
createdAt: z.coerce.date(),
|
|
431
|
+
environmentId: z.string(),
|
|
432
|
+
name: z.string(),
|
|
433
|
+
color: intentCategoryColorSchema
|
|
434
|
+
});
|
|
435
|
+
z.object({
|
|
436
|
+
id: z.string(),
|
|
437
|
+
name: z.string(),
|
|
438
|
+
color: intentCategoryColorSchema,
|
|
439
|
+
intentCount: z.number().int().nonnegative()
|
|
440
|
+
});
|
|
441
|
+
z.object({
|
|
442
|
+
id: z.string(),
|
|
443
|
+
createdAt: z.coerce.date(),
|
|
444
|
+
environmentId: z.string(),
|
|
445
|
+
toolName: z.string(),
|
|
446
|
+
message: z.string(),
|
|
447
|
+
clientName: z.string().nullable(),
|
|
448
|
+
categories: z.array(intentCategorySchema)
|
|
449
|
+
});
|
|
450
|
+
const signalCategorySchema = z.object({
|
|
451
|
+
id: z.string(),
|
|
452
|
+
name: z.string(),
|
|
453
|
+
color: intentCategoryColorSchema
|
|
454
|
+
});
|
|
455
|
+
z.discriminatedUnion("kind", [
|
|
456
|
+
z.object({
|
|
457
|
+
kind: z.literal("new"),
|
|
458
|
+
category: signalCategorySchema,
|
|
459
|
+
currentCount: z.number().int().nonnegative(),
|
|
460
|
+
currentShare: z.number()
|
|
461
|
+
}),
|
|
462
|
+
z.object({
|
|
463
|
+
kind: z.literal("resurging"),
|
|
464
|
+
category: signalCategorySchema,
|
|
465
|
+
currentCount: z.number().int().nonnegative(),
|
|
466
|
+
daysQuiet: z.number(),
|
|
467
|
+
currentShare: z.number()
|
|
468
|
+
}),
|
|
469
|
+
z.object({
|
|
470
|
+
kind: z.literal("spike"),
|
|
471
|
+
category: signalCategorySchema,
|
|
472
|
+
currentCount: z.number().int().nonnegative(),
|
|
473
|
+
previousCount: z.number().int().nonnegative(),
|
|
474
|
+
currentShare: z.number(),
|
|
475
|
+
previousShare: z.number(),
|
|
476
|
+
changeRatio: z.number()
|
|
477
|
+
}),
|
|
478
|
+
z.object({
|
|
479
|
+
kind: z.literal("declining"),
|
|
480
|
+
category: signalCategorySchema,
|
|
481
|
+
currentCount: z.number().int().nonnegative(),
|
|
482
|
+
previousCount: z.number().int().nonnegative(),
|
|
483
|
+
currentShare: z.number(),
|
|
484
|
+
previousShare: z.number(),
|
|
485
|
+
changeRatio: z.number()
|
|
486
|
+
})
|
|
487
|
+
]);
|
|
488
|
+
z.discriminatedUnion("kind", [z.object({
|
|
489
|
+
kind: z.literal("existing"),
|
|
490
|
+
categoryId: z.string(),
|
|
491
|
+
categoryName: z.string(),
|
|
492
|
+
intentIds: z.array(z.string())
|
|
493
|
+
}), z.object({
|
|
494
|
+
kind: z.literal("new"),
|
|
495
|
+
categoryName: z.string(),
|
|
496
|
+
intentIds: z.array(z.string())
|
|
497
|
+
})]);
|
|
95
498
|
z.object({
|
|
96
499
|
id: z.string(),
|
|
97
500
|
teamId: z.string(),
|
|
@@ -100,6 +503,252 @@ z.object({
|
|
|
100
503
|
createdAt: z.coerce.date(),
|
|
101
504
|
updatedAt: z.coerce.date()
|
|
102
505
|
});
|
|
506
|
+
z.enum([
|
|
507
|
+
"INFO",
|
|
508
|
+
"WARNING",
|
|
509
|
+
"DEBUG",
|
|
510
|
+
"ERROR"
|
|
511
|
+
]);
|
|
512
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
513
|
+
const MCP_CLIENT_GROUPS = [
|
|
514
|
+
{
|
|
515
|
+
id: "claude_code",
|
|
516
|
+
label: "Claude Code",
|
|
517
|
+
vendor: "anthropic",
|
|
518
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
519
|
+
},
|
|
520
|
+
{
|
|
521
|
+
id: "claude",
|
|
522
|
+
label: "Claude",
|
|
523
|
+
vendor: "anthropic",
|
|
524
|
+
rawNames: [
|
|
525
|
+
"Anthropic/ClaudeAI",
|
|
526
|
+
"claude-ai",
|
|
527
|
+
"claude",
|
|
528
|
+
"Claude",
|
|
529
|
+
"claude-desktop",
|
|
530
|
+
"claude-desktop-3p"
|
|
531
|
+
]
|
|
532
|
+
},
|
|
533
|
+
{
|
|
534
|
+
id: "claude_mobile",
|
|
535
|
+
label: "Claude mobile",
|
|
536
|
+
vendor: "anthropic",
|
|
537
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
538
|
+
},
|
|
539
|
+
{
|
|
540
|
+
id: "claude_cowork",
|
|
541
|
+
label: "Claude Cowork",
|
|
542
|
+
vendor: "anthropic",
|
|
543
|
+
rawNames: ["Anthropic/Cowork"]
|
|
544
|
+
},
|
|
545
|
+
{
|
|
546
|
+
id: "claude_toolbox",
|
|
547
|
+
label: "Claude Toolbox",
|
|
548
|
+
vendor: "anthropic",
|
|
549
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
id: "anthropic_api",
|
|
553
|
+
label: "Anthropic API",
|
|
554
|
+
vendor: "anthropic",
|
|
555
|
+
rawNames: ["Anthropic/API"]
|
|
556
|
+
},
|
|
557
|
+
{
|
|
558
|
+
id: "anthropic_connector_refresh",
|
|
559
|
+
label: "Anthropic (connector refresh)",
|
|
560
|
+
vendor: "anthropic",
|
|
561
|
+
rawNames: ["Anthropic"]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "codex",
|
|
565
|
+
label: "Codex",
|
|
566
|
+
vendor: "openai",
|
|
567
|
+
rawNames: [
|
|
568
|
+
"codex-mcp-client",
|
|
569
|
+
"codex",
|
|
570
|
+
"Codex",
|
|
571
|
+
"codex-cli",
|
|
572
|
+
"openai-mcp (Codex)"
|
|
573
|
+
]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "chatgpt",
|
|
577
|
+
label: "ChatGPT",
|
|
578
|
+
vendor: "openai",
|
|
579
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "openai_responses_api",
|
|
583
|
+
label: "OpenAI Responses API",
|
|
584
|
+
vendor: "openai",
|
|
585
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "openai_agent_builder",
|
|
589
|
+
label: "OpenAI Agent Builder",
|
|
590
|
+
vendor: "openai",
|
|
591
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "openai_other",
|
|
595
|
+
label: "OpenAI Other",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: ["openai-mcp"]
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
id: "cursor",
|
|
601
|
+
label: "Cursor",
|
|
602
|
+
vendor: "cursor",
|
|
603
|
+
rawNames: [
|
|
604
|
+
"cursor-vscode",
|
|
605
|
+
"Cursor",
|
|
606
|
+
"cursor"
|
|
607
|
+
]
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
id: "cline",
|
|
611
|
+
label: "Cline",
|
|
612
|
+
vendor: "cline",
|
|
613
|
+
rawNames: [
|
|
614
|
+
"Cline",
|
|
615
|
+
"cline",
|
|
616
|
+
"@cline/core"
|
|
617
|
+
]
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
id: "github_copilot",
|
|
621
|
+
label: "GitHub Copilot",
|
|
622
|
+
vendor: "githubCopilot",
|
|
623
|
+
rawNames: [
|
|
624
|
+
"Copilot",
|
|
625
|
+
"github-copilot-developer",
|
|
626
|
+
"Copilot MCP Gateway",
|
|
627
|
+
"Xcode/copilot-xcode"
|
|
628
|
+
]
|
|
629
|
+
},
|
|
630
|
+
{
|
|
631
|
+
id: "gemini_cli",
|
|
632
|
+
label: "Gemini CLI",
|
|
633
|
+
vendor: "google",
|
|
634
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
635
|
+
},
|
|
636
|
+
{
|
|
637
|
+
id: "antigravity",
|
|
638
|
+
label: "Antigravity",
|
|
639
|
+
vendor: "google",
|
|
640
|
+
rawNames: ["antigravity-client"]
|
|
641
|
+
},
|
|
642
|
+
{
|
|
643
|
+
id: "gemini",
|
|
644
|
+
label: "Gemini",
|
|
645
|
+
vendor: "google",
|
|
646
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
id: "windsurf",
|
|
650
|
+
label: "Windsurf",
|
|
651
|
+
vendor: "windsurf",
|
|
652
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
653
|
+
},
|
|
654
|
+
{
|
|
655
|
+
id: "mistral",
|
|
656
|
+
label: "Mistral / Le Chat",
|
|
657
|
+
vendor: "mistral",
|
|
658
|
+
rawNames: ["Mistral"],
|
|
659
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
id: "n8n",
|
|
663
|
+
label: "n8n",
|
|
664
|
+
vendor: "n8n",
|
|
665
|
+
rawNames: [
|
|
666
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
667
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
668
|
+
"n8n"
|
|
669
|
+
]
|
|
670
|
+
},
|
|
671
|
+
{
|
|
672
|
+
id: "alpic_playground",
|
|
673
|
+
label: "Alpic Playground",
|
|
674
|
+
vendor: "alpic",
|
|
675
|
+
rawNames: ["alpic-playground", "playground"]
|
|
676
|
+
},
|
|
677
|
+
{
|
|
678
|
+
id: "opencode",
|
|
679
|
+
label: "opencode",
|
|
680
|
+
vendor: "opencode",
|
|
681
|
+
rawNames: ["opencode"]
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
id: "zed",
|
|
685
|
+
label: "Zed",
|
|
686
|
+
vendor: "zed",
|
|
687
|
+
rawNames: ["Zed", "zed"]
|
|
688
|
+
},
|
|
689
|
+
{
|
|
690
|
+
id: "zapier",
|
|
691
|
+
label: "Zapier",
|
|
692
|
+
vendor: "zapier",
|
|
693
|
+
rawNames: ["Zapier", "zapier"]
|
|
694
|
+
},
|
|
695
|
+
{
|
|
696
|
+
id: "make",
|
|
697
|
+
label: "Make",
|
|
698
|
+
vendor: "make",
|
|
699
|
+
rawNames: ["Make", "make"]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "librechat",
|
|
703
|
+
label: "LibreChat",
|
|
704
|
+
vendor: "mcp",
|
|
705
|
+
rawNames: ["LibreChat", "librechat"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "jan",
|
|
709
|
+
label: "Jan",
|
|
710
|
+
vendor: "mcp",
|
|
711
|
+
rawNames: ["Jan", "jan"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "goose",
|
|
715
|
+
label: "goose",
|
|
716
|
+
vendor: "mcp",
|
|
717
|
+
rawNames: ["goose", "Goose"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "mcphost",
|
|
721
|
+
label: "mcphost",
|
|
722
|
+
vendor: "mcp",
|
|
723
|
+
rawNames: ["mcphost"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "mcporter",
|
|
727
|
+
label: "mcporter",
|
|
728
|
+
vendor: "mcp",
|
|
729
|
+
rawNames: ["mcporter"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "rmcp",
|
|
733
|
+
label: "rmcp",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["rmcp"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "unnamed_client",
|
|
739
|
+
label: "Unnamed client",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: [
|
|
742
|
+
"mcp",
|
|
743
|
+
"unknown",
|
|
744
|
+
""
|
|
745
|
+
]
|
|
746
|
+
}
|
|
747
|
+
];
|
|
748
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
749
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
750
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
751
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
103
752
|
const runtimeSchema = z.enum([
|
|
104
753
|
"python3.13",
|
|
105
754
|
"python3.14",
|
|
@@ -111,6 +760,80 @@ const transportSchema = z.enum([
|
|
|
111
760
|
"sse",
|
|
112
761
|
"streamablehttp"
|
|
113
762
|
]);
|
|
763
|
+
z.object({
|
|
764
|
+
id: z.string(),
|
|
765
|
+
name: z.string(),
|
|
766
|
+
teamId: z.string(),
|
|
767
|
+
sourceRepository: z.string().nullable(),
|
|
768
|
+
createdAt: z.coerce.date().optional(),
|
|
769
|
+
runtime: runtimeSchema,
|
|
770
|
+
transport: transportSchema.nullable(),
|
|
771
|
+
rootDirectory: z.string().nullable(),
|
|
772
|
+
installCommand: z.string().nullable(),
|
|
773
|
+
buildCommand: z.string().nullable(),
|
|
774
|
+
buildOutputDir: z.string().nullable(),
|
|
775
|
+
startCommand: z.string().nullable(),
|
|
776
|
+
fixedOutboundIp: z.boolean(),
|
|
777
|
+
environments: z.array(environmentWithDomainsSchema),
|
|
778
|
+
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
779
|
+
});
|
|
780
|
+
const domainFailureReasonSchema = z.enum([
|
|
781
|
+
"caa",
|
|
782
|
+
"dns",
|
|
783
|
+
"invalid_domain",
|
|
784
|
+
"other"
|
|
785
|
+
]);
|
|
786
|
+
const projectDomainMappingSchema = z.object({
|
|
787
|
+
pathPrefix: z.string(),
|
|
788
|
+
environment: environmentSchema$1
|
|
789
|
+
});
|
|
790
|
+
z.object({
|
|
791
|
+
name: z.string(),
|
|
792
|
+
createdAt: z.coerce.date(),
|
|
793
|
+
status: z.enum([
|
|
794
|
+
"ongoing",
|
|
795
|
+
"deployed",
|
|
796
|
+
"failed"
|
|
797
|
+
]),
|
|
798
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
799
|
+
environment: environmentSchema$1,
|
|
800
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
801
|
+
});
|
|
802
|
+
const serverFieldsSchema$1 = z.object({
|
|
803
|
+
$schema: z.string(),
|
|
804
|
+
name: z.string(),
|
|
805
|
+
description: z.string(),
|
|
806
|
+
version: z.string().optional(),
|
|
807
|
+
title: z.string().optional(),
|
|
808
|
+
websiteUrl: z.string().optional(),
|
|
809
|
+
icons: z.array(z.object({
|
|
810
|
+
src: z.string(),
|
|
811
|
+
mimeType: z.string().optional(),
|
|
812
|
+
sizes: z.array(z.string()).optional()
|
|
813
|
+
})).optional(),
|
|
814
|
+
remotes: z.array(z.object({
|
|
815
|
+
type: z.string(),
|
|
816
|
+
url: z.string().optional(),
|
|
817
|
+
headers: z.array(z.object({
|
|
818
|
+
name: z.string(),
|
|
819
|
+
description: z.string(),
|
|
820
|
+
isRequired: z.boolean().optional(),
|
|
821
|
+
isSecret: z.boolean().optional()
|
|
822
|
+
})).optional()
|
|
823
|
+
})).optional()
|
|
824
|
+
}).catchall(z.unknown());
|
|
825
|
+
z.object({
|
|
826
|
+
serverFields: serverFieldsSchema$1,
|
|
827
|
+
source: z.enum(["registry", "defaults"])
|
|
828
|
+
});
|
|
829
|
+
/** 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. */
|
|
830
|
+
const clampStringField = (field) => {
|
|
831
|
+
const max = field.maxLength;
|
|
832
|
+
if (max === null) return field;
|
|
833
|
+
const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
|
|
834
|
+
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
835
|
+
return field.description ? withMin.describe(field.description) : withMin;
|
|
836
|
+
};
|
|
114
837
|
const toolDefinitionSchema = z.object({
|
|
115
838
|
name: z.string(),
|
|
116
839
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -123,13 +846,20 @@ const toolDefinitionSchema = z.object({
|
|
|
123
846
|
}).optional()
|
|
124
847
|
});
|
|
125
848
|
const positiveTestCaseSchema = z.object({
|
|
126
|
-
scenario: z.string(),
|
|
127
|
-
userPrompt: z.string(),
|
|
128
|
-
toolTriggered: z.string().optional(),
|
|
129
|
-
expectedOutput: z.string().optional()
|
|
849
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
850
|
+
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."),
|
|
851
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
852
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
130
853
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
854
|
+
const screenshotEntrySchema = z.object({
|
|
855
|
+
prompt: z.string(),
|
|
856
|
+
url: z.url()
|
|
857
|
+
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
858
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
131
859
|
/** Accepts either a valid email or URL. */
|
|
132
860
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
861
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
862
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
133
863
|
const chatgptCategorySchema = z.enum([
|
|
134
864
|
"BUSINESS",
|
|
135
865
|
"COLLABORATION",
|
|
@@ -146,51 +876,348 @@ const chatgptCategorySchema = z.enum([
|
|
|
146
876
|
"TRAVEL"
|
|
147
877
|
]);
|
|
148
878
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
149
|
-
const
|
|
879
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
880
|
+
"AD",
|
|
881
|
+
"AE",
|
|
882
|
+
"AF",
|
|
883
|
+
"AG",
|
|
884
|
+
"AL",
|
|
885
|
+
"AM",
|
|
886
|
+
"AO",
|
|
887
|
+
"AR",
|
|
888
|
+
"AT",
|
|
889
|
+
"AU",
|
|
890
|
+
"AW",
|
|
891
|
+
"AX",
|
|
892
|
+
"AZ",
|
|
893
|
+
"BA",
|
|
894
|
+
"BB",
|
|
895
|
+
"BD",
|
|
896
|
+
"BE",
|
|
897
|
+
"BF",
|
|
898
|
+
"BG",
|
|
899
|
+
"BH",
|
|
900
|
+
"BI",
|
|
901
|
+
"BJ",
|
|
902
|
+
"BL",
|
|
903
|
+
"BM",
|
|
904
|
+
"BN",
|
|
905
|
+
"BO",
|
|
906
|
+
"BR",
|
|
907
|
+
"BS",
|
|
908
|
+
"BT",
|
|
909
|
+
"BW",
|
|
910
|
+
"BZ",
|
|
911
|
+
"CA",
|
|
912
|
+
"CD",
|
|
913
|
+
"CF",
|
|
914
|
+
"CG",
|
|
915
|
+
"CH",
|
|
916
|
+
"CI",
|
|
917
|
+
"CL",
|
|
918
|
+
"CM",
|
|
919
|
+
"CO",
|
|
920
|
+
"CR",
|
|
921
|
+
"CV",
|
|
922
|
+
"CY",
|
|
923
|
+
"CZ",
|
|
924
|
+
"DE",
|
|
925
|
+
"DJ",
|
|
926
|
+
"DK",
|
|
927
|
+
"DM",
|
|
928
|
+
"DO",
|
|
929
|
+
"DZ",
|
|
930
|
+
"EC",
|
|
931
|
+
"EE",
|
|
932
|
+
"EG",
|
|
933
|
+
"ER",
|
|
934
|
+
"ES",
|
|
935
|
+
"ET",
|
|
936
|
+
"FI",
|
|
937
|
+
"FJ",
|
|
938
|
+
"FM",
|
|
939
|
+
"FO",
|
|
940
|
+
"FR",
|
|
941
|
+
"GA",
|
|
942
|
+
"GB",
|
|
943
|
+
"GD",
|
|
944
|
+
"GE",
|
|
945
|
+
"GF",
|
|
946
|
+
"GH",
|
|
947
|
+
"GL",
|
|
948
|
+
"GM",
|
|
949
|
+
"GN",
|
|
950
|
+
"GP",
|
|
951
|
+
"GQ",
|
|
952
|
+
"GR",
|
|
953
|
+
"GT",
|
|
954
|
+
"GW",
|
|
955
|
+
"GY",
|
|
956
|
+
"HN",
|
|
957
|
+
"HR",
|
|
958
|
+
"HT",
|
|
959
|
+
"HU",
|
|
960
|
+
"ID",
|
|
961
|
+
"IE",
|
|
962
|
+
"IL",
|
|
963
|
+
"IN",
|
|
964
|
+
"IQ",
|
|
965
|
+
"IS",
|
|
966
|
+
"IT",
|
|
967
|
+
"JM",
|
|
968
|
+
"JO",
|
|
969
|
+
"JP",
|
|
970
|
+
"KE",
|
|
971
|
+
"KG",
|
|
972
|
+
"KH",
|
|
973
|
+
"KI",
|
|
974
|
+
"KM",
|
|
975
|
+
"KN",
|
|
976
|
+
"KR",
|
|
977
|
+
"KW",
|
|
978
|
+
"KY",
|
|
979
|
+
"KZ",
|
|
980
|
+
"LA",
|
|
981
|
+
"LB",
|
|
982
|
+
"LC",
|
|
983
|
+
"LI",
|
|
984
|
+
"LK",
|
|
985
|
+
"LR",
|
|
986
|
+
"LS",
|
|
987
|
+
"LT",
|
|
988
|
+
"LU",
|
|
989
|
+
"LV",
|
|
990
|
+
"LY",
|
|
991
|
+
"MA",
|
|
992
|
+
"MC",
|
|
993
|
+
"MD",
|
|
994
|
+
"ME",
|
|
995
|
+
"MF",
|
|
996
|
+
"MG",
|
|
997
|
+
"MH",
|
|
998
|
+
"MK",
|
|
999
|
+
"ML",
|
|
1000
|
+
"MM",
|
|
1001
|
+
"MN",
|
|
1002
|
+
"MQ",
|
|
1003
|
+
"MR",
|
|
1004
|
+
"MT",
|
|
1005
|
+
"MU",
|
|
1006
|
+
"MV",
|
|
1007
|
+
"MW",
|
|
1008
|
+
"MX",
|
|
1009
|
+
"MY",
|
|
1010
|
+
"MZ",
|
|
1011
|
+
"NA",
|
|
1012
|
+
"NC",
|
|
1013
|
+
"NE",
|
|
1014
|
+
"NG",
|
|
1015
|
+
"NI",
|
|
1016
|
+
"NL",
|
|
1017
|
+
"NO",
|
|
1018
|
+
"NP",
|
|
1019
|
+
"NR",
|
|
1020
|
+
"NZ",
|
|
1021
|
+
"OM",
|
|
1022
|
+
"PA",
|
|
1023
|
+
"PE",
|
|
1024
|
+
"PF",
|
|
1025
|
+
"PG",
|
|
1026
|
+
"PH",
|
|
1027
|
+
"PK",
|
|
1028
|
+
"PL",
|
|
1029
|
+
"PM",
|
|
1030
|
+
"PS",
|
|
1031
|
+
"PT",
|
|
1032
|
+
"PW",
|
|
1033
|
+
"PY",
|
|
1034
|
+
"QA",
|
|
1035
|
+
"RE",
|
|
1036
|
+
"RO",
|
|
1037
|
+
"RS",
|
|
1038
|
+
"RW",
|
|
1039
|
+
"SA",
|
|
1040
|
+
"SB",
|
|
1041
|
+
"SC",
|
|
1042
|
+
"SD",
|
|
1043
|
+
"SE",
|
|
1044
|
+
"SG",
|
|
1045
|
+
"SH",
|
|
1046
|
+
"SI",
|
|
1047
|
+
"SJ",
|
|
1048
|
+
"SK",
|
|
1049
|
+
"SL",
|
|
1050
|
+
"SM",
|
|
1051
|
+
"SN",
|
|
1052
|
+
"SO",
|
|
1053
|
+
"SR",
|
|
1054
|
+
"SS",
|
|
1055
|
+
"ST",
|
|
1056
|
+
"SV",
|
|
1057
|
+
"SZ",
|
|
1058
|
+
"TD",
|
|
1059
|
+
"TF",
|
|
1060
|
+
"TG",
|
|
1061
|
+
"TH",
|
|
1062
|
+
"TJ",
|
|
1063
|
+
"TL",
|
|
1064
|
+
"TM",
|
|
1065
|
+
"TN",
|
|
1066
|
+
"TO",
|
|
1067
|
+
"TR",
|
|
1068
|
+
"TT",
|
|
1069
|
+
"TV",
|
|
1070
|
+
"TW",
|
|
1071
|
+
"TZ",
|
|
1072
|
+
"UA",
|
|
1073
|
+
"UG",
|
|
1074
|
+
"US",
|
|
1075
|
+
"UY",
|
|
1076
|
+
"UZ",
|
|
1077
|
+
"VA",
|
|
1078
|
+
"VC",
|
|
1079
|
+
"VN",
|
|
1080
|
+
"VU",
|
|
1081
|
+
"WF",
|
|
1082
|
+
"WS",
|
|
1083
|
+
"YE",
|
|
1084
|
+
"YT",
|
|
1085
|
+
"ZA",
|
|
1086
|
+
"ZM",
|
|
1087
|
+
"ZW"
|
|
1088
|
+
]);
|
|
1089
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
1090
|
+
z.object({ mode: z.literal("all") }),
|
|
1091
|
+
z.object({
|
|
1092
|
+
mode: z.literal("allow"),
|
|
1093
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1094
|
+
}),
|
|
1095
|
+
z.object({
|
|
1096
|
+
mode: z.literal("block"),
|
|
1097
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
1098
|
+
})
|
|
1099
|
+
]);
|
|
1100
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
1101
|
+
"am",
|
|
1102
|
+
"ar",
|
|
1103
|
+
"bg-BG",
|
|
1104
|
+
"bn-BD",
|
|
1105
|
+
"bs-BA",
|
|
1106
|
+
"ca-ES",
|
|
1107
|
+
"cs-CZ",
|
|
1108
|
+
"da-DK",
|
|
1109
|
+
"de-DE",
|
|
1110
|
+
"el-GR",
|
|
1111
|
+
"es-419",
|
|
1112
|
+
"es-ES",
|
|
1113
|
+
"et-EE",
|
|
1114
|
+
"fi-FI",
|
|
1115
|
+
"fr-CA",
|
|
1116
|
+
"fr-FR",
|
|
1117
|
+
"gu-IN",
|
|
1118
|
+
"hi-IN",
|
|
1119
|
+
"hr-HR",
|
|
1120
|
+
"hu-HU",
|
|
1121
|
+
"hy-AM",
|
|
1122
|
+
"id-ID",
|
|
1123
|
+
"is-IS",
|
|
1124
|
+
"it-IT",
|
|
1125
|
+
"ja-JP",
|
|
1126
|
+
"ka-GE",
|
|
1127
|
+
"kk",
|
|
1128
|
+
"kn-IN",
|
|
1129
|
+
"ko-KR",
|
|
1130
|
+
"lt",
|
|
1131
|
+
"lv-LV",
|
|
1132
|
+
"mk-MK",
|
|
1133
|
+
"ml",
|
|
1134
|
+
"mn",
|
|
1135
|
+
"mr-IN",
|
|
1136
|
+
"ms-MY",
|
|
1137
|
+
"my-MM",
|
|
1138
|
+
"nb-NO",
|
|
1139
|
+
"nl-NL",
|
|
1140
|
+
"pa",
|
|
1141
|
+
"pl-PL",
|
|
1142
|
+
"pt-BR",
|
|
1143
|
+
"pt-PT",
|
|
1144
|
+
"ro-RO",
|
|
1145
|
+
"ru-RU",
|
|
1146
|
+
"sk-SK",
|
|
1147
|
+
"sl-SI",
|
|
1148
|
+
"so-SO",
|
|
1149
|
+
"sq-AL",
|
|
1150
|
+
"sr-RS",
|
|
1151
|
+
"sv-SE",
|
|
1152
|
+
"sw-TZ",
|
|
1153
|
+
"ta-IN",
|
|
1154
|
+
"te-IN",
|
|
1155
|
+
"th-TH",
|
|
1156
|
+
"tl",
|
|
1157
|
+
"tr-TR",
|
|
1158
|
+
"uk-UA",
|
|
1159
|
+
"ur",
|
|
1160
|
+
"vi-VN",
|
|
1161
|
+
"zh-CN",
|
|
1162
|
+
"zh-HK",
|
|
1163
|
+
"zh-TW"
|
|
1164
|
+
]);
|
|
150
1165
|
const negativeTestCaseSchema = z.object({
|
|
151
1166
|
scenario: z.string(),
|
|
152
1167
|
userPrompt: z.string()
|
|
153
1168
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
154
1169
|
const chatgptToolJustificationSchema = z.object({
|
|
155
1170
|
toolName: z.string(),
|
|
156
|
-
readOnlyJustification: z.string(),
|
|
157
|
-
openWorldJustification: z.string(),
|
|
158
|
-
destructiveJustification: z.string()
|
|
159
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
1171
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
1172
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
1173
|
+
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.\"")
|
|
1174
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
1175
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
1176
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
1177
|
+
const chatgptDescriptionSchema = z.string();
|
|
160
1178
|
const chatgptTranslationSchema = z.object({
|
|
161
|
-
locale:
|
|
162
|
-
tagline:
|
|
163
|
-
description:
|
|
1179
|
+
locale: chatgptTranslationLocaleSchema,
|
|
1180
|
+
tagline: chatgptTaglineSchema,
|
|
1181
|
+
description: chatgptDescriptionSchema
|
|
164
1182
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
168
|
-
*/
|
|
1183
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
1184
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
169
1185
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
170
1186
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
171
|
-
logoDark: z.string().describe("
|
|
1187
|
+
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."),
|
|
172
1188
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
173
|
-
tagline:
|
|
174
|
-
description:
|
|
1189
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1190
|
+
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)."),
|
|
175
1191
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
176
1192
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
177
|
-
companyUrl:
|
|
1193
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
178
1194
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
179
|
-
privacyPolicyUrl:
|
|
180
|
-
termsOfServiceUrl:
|
|
181
|
-
demoRecordingUrl:
|
|
1195
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1196
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1197
|
+
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."),
|
|
182
1198
|
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."),
|
|
183
|
-
serverUrl:
|
|
1199
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
184
1200
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
185
1201
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
186
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
187
|
-
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output.
|
|
188
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases
|
|
189
|
-
screenshots: z.array(z.
|
|
1202
|
+
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."),
|
|
1203
|
+
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."),
|
|
1204
|
+
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."),
|
|
1205
|
+
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."),
|
|
190
1206
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
191
|
-
allowedCountries: chatgptAllowedCountriesSchema.describe("
|
|
1207
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
192
1208
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
193
1209
|
});
|
|
1210
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1211
|
+
tagline: z.string().optional(),
|
|
1212
|
+
companyUrl: z.string().optional(),
|
|
1213
|
+
supportChannel: z.string().optional(),
|
|
1214
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1215
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1216
|
+
demoRecordingUrl: z.string().optional(),
|
|
1217
|
+
serverUrl: z.string().optional(),
|
|
1218
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1219
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1220
|
+
});
|
|
194
1221
|
chatgptSubmissionFormDataSchema.pick({
|
|
195
1222
|
appName: true,
|
|
196
1223
|
developerName: true,
|
|
@@ -205,9 +1232,9 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
205
1232
|
testCases: true,
|
|
206
1233
|
negativeTestCases: true,
|
|
207
1234
|
toolJustifications: true
|
|
208
|
-
});
|
|
1235
|
+
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
209
1236
|
const claudeCategorySchema = z.enum([
|
|
210
|
-
"
|
|
1237
|
+
"Productivity",
|
|
211
1238
|
"Communication",
|
|
212
1239
|
"Data & Analytics",
|
|
213
1240
|
"Development tools",
|
|
@@ -215,212 +1242,202 @@ const claudeCategorySchema = z.enum([
|
|
|
215
1242
|
"Consumer Health",
|
|
216
1243
|
"Health & Life Sciences",
|
|
217
1244
|
"Media & Entertainment",
|
|
218
|
-
"Commerce & Shopping"
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
"
|
|
222
|
-
"
|
|
223
|
-
"
|
|
1245
|
+
"Commerce & Shopping",
|
|
1246
|
+
"Legal",
|
|
1247
|
+
"Sales and marketing",
|
|
1248
|
+
"Creative",
|
|
1249
|
+
"Nonprofit",
|
|
1250
|
+
"Education",
|
|
1251
|
+
"Other"
|
|
224
1252
|
]);
|
|
225
|
-
const
|
|
226
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1253
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
227
1254
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
228
|
-
"
|
|
229
|
-
"
|
|
230
|
-
"
|
|
1255
|
+
"read_only",
|
|
1256
|
+
"write_only",
|
|
1257
|
+
"read_write"
|
|
231
1258
|
]);
|
|
232
|
-
const
|
|
233
|
-
|
|
234
|
-
"
|
|
235
|
-
"
|
|
236
|
-
"
|
|
237
|
-
"
|
|
238
|
-
"N/A"
|
|
1259
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1260
|
+
"oauth_dcr",
|
|
1261
|
+
"oauth_cimd",
|
|
1262
|
+
"oauth_anthropic_creds",
|
|
1263
|
+
"custom_connection",
|
|
1264
|
+
"none"
|
|
239
1265
|
]);
|
|
240
|
-
const
|
|
241
|
-
"
|
|
242
|
-
"
|
|
243
|
-
"
|
|
244
|
-
"GDPR compliant (if applicable)"
|
|
1266
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1267
|
+
"first_party",
|
|
1268
|
+
"proxied",
|
|
1269
|
+
"third_party"
|
|
245
1270
|
]);
|
|
246
|
-
const
|
|
247
|
-
|
|
248
|
-
"
|
|
249
|
-
"
|
|
1271
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1272
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1273
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1274
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1275
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1276
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1277
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1278
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1279
|
+
"Public documentation for this connector will be live by the publish date."
|
|
250
1280
|
]);
|
|
251
|
-
/**
|
|
252
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
253
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
254
|
-
*/
|
|
1281
|
+
/** 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. */
|
|
255
1282
|
const claudeSubmissionFormDataSchema = z.object({
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
(
|
|
266
|
-
|
|
267
|
-
(
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
•
|
|
285
|
-
•
|
|
286
|
-
•
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
• '
|
|
302
|
-
• '
|
|
303
|
-
• '
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
331
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
332
|
-
• 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
|
|
333
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
334
|
-
serverDocumentationLink: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. This is displayed in the Directory listing and must be publicly accessible without login. Minimum requirements for the docs page:
|
|
335
|
-
• What the connector does and its key capabilities
|
|
336
|
-
• How to connect/set it up (step by step)
|
|
337
|
-
• What each tool does (or at least the main ones)
|
|
338
|
-
• How to troubleshoot common issues
|
|
339
|
-
• A support contact or channel
|
|
340
|
-
Acceptable formats: a dedicated docs page, a help center article, a README on GitHub, or a blog post — as long as it's comprehensive. Note: Anthropic requires public documentation to be live by your publish date.`),
|
|
341
|
-
privacyPolicyUrl: z.url().describe(`URL to your privacy policy. This is mandatory and displayed in the directory listing. Missing or incomplete privacy policies result in immediate rejection. Your privacy policy must cover:
|
|
342
|
-
• What data you collect (and how)
|
|
343
|
-
• How you use the collected data
|
|
344
|
-
• Where and how long you store it
|
|
345
|
-
• Whether you share data with third parties (and who)
|
|
346
|
-
• How users can contact you about data concerns
|
|
347
|
-
The policy must be publicly accessible. If you don't have one yet, create one before submitting — there are free generators online, but make sure it accurately reflects your actual practices. If you're GDPR-compliant, your policy should reflect that.`),
|
|
348
|
-
supportChannel: supportChannelSchema.describe(`A URL or email address where users can get help with your connector. This is displayed in the Directory listing. Acceptable options:
|
|
349
|
-
• Email address (e.g. support@myapp.com)
|
|
350
|
-
• Link to a GitHub Issues page
|
|
351
|
-
• Link to a help center or support article
|
|
352
|
-
• Link to a Discord/Slack community
|
|
353
|
-
• Link to your documentation's troubleshooting section
|
|
354
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
355
|
-
testingCredentials: z.string().describe(`Provide login credentials for a test account that Anthropic reviewers can use to verify your server works end-to-end. Critical requirements:
|
|
356
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
357
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
358
|
-
• If your service uses Google OAuth or another OAuth that requires email verification, use mcp-review@anthropic.com as the account email — Anthropic has access to this inbox.
|
|
359
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
360
|
-
• If your service requires API keys instead of a password, provide those.
|
|
361
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
362
|
-
tools: z.array(toolDefinitionSchema).describe(`A comma-separated list of all tools your MCP server exposes. Use the format: tool_name (Human-Readable Name). The tool_name is the internal identifier (snake_case, max 64 characters). The Human-Readable Name is what users see.
|
|
363
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
364
|
-
Reviewers test every single tool you list here — don't list tools that don't work. Also: do not have a single catch-all tool like api_request(method, endpoint) — Anthropic rejects these. Each action should be its own purpose-built tool.`),
|
|
365
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
366
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
367
|
-
• 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
|
|
368
|
-
This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
|
|
369
|
-
logoLight: z.string().describe(`Your connector's logo as displayed in the directory. Requirements:
|
|
370
|
-
• Format: SVG only
|
|
371
|
-
• Aspect ratio: square (1:1)
|
|
372
|
-
• Should work on both light and dark backgrounds (or you can provide separate light/dark versions)
|
|
373
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
374
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
375
|
-
screenshots: z.array(z.url()).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
|
|
376
|
-
• 3–5 images is ideal
|
|
377
|
-
• Minimum 1000px width, PNG format preferred
|
|
378
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
379
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
380
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
381
|
-
• Videos are also welcome
|
|
382
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1283
|
+
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
|
|
1284
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1285
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1286
|
+
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
|
|
1287
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1288
|
+
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.
|
|
1289
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1290
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1291
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1292
|
+
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
|
|
1293
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1294
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1295
|
+
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
|
|
1296
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1297
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1298
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1299
|
+
by your publish date.`),
|
|
1300
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1301
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1302
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1303
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1304
|
+
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
|
|
1305
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1306
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1307
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1308
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1309
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1310
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1311
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1312
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1313
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1314
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1315
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1316
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1317
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1318
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1319
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1320
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1321
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1322
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1323
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1324
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1325
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1326
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1327
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1328
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1329
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1330
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1331
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1332
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1333
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1334
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1335
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1336
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1337
|
+
fully populated account.`),
|
|
1338
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1339
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1340
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1341
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1342
|
+
});
|
|
1343
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1344
|
+
serverUrl: z.string().optional(),
|
|
1345
|
+
name: z.string().optional(),
|
|
1346
|
+
slug: z.string().optional(),
|
|
1347
|
+
oneLiner: z.string().optional(),
|
|
1348
|
+
description: z.string().optional(),
|
|
1349
|
+
iconUrl: z.string().optional(),
|
|
1350
|
+
documentation: z.string().optional(),
|
|
1351
|
+
support: z.string().optional(),
|
|
1352
|
+
privacyPolicy: z.string().optional(),
|
|
1353
|
+
companyWebsite: z.string().optional(),
|
|
1354
|
+
primaryContactEmail: z.string().optional(),
|
|
1355
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1356
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
383
1357
|
});
|
|
384
1358
|
claudeSubmissionFormDataSchema.pick({
|
|
385
|
-
companyName: true,
|
|
386
|
-
appName: true,
|
|
387
|
-
mcpUrlType: true,
|
|
388
1359
|
serverUrl: true,
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
transportSupport: true,
|
|
1360
|
+
name: true,
|
|
1361
|
+
slug: true,
|
|
1362
|
+
companyName: true,
|
|
393
1363
|
primaryContactEmail: true,
|
|
394
|
-
primaryContactName: true
|
|
1364
|
+
primaryContactName: true,
|
|
1365
|
+
readWriteCapabilities: true,
|
|
1366
|
+
authentication: true,
|
|
1367
|
+
apiOwnership: true,
|
|
1368
|
+
personalHealthData: true
|
|
1369
|
+
}).extend({
|
|
1370
|
+
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1371
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
395
1372
|
});
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
1373
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1374
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1375
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1376
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1377
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1378
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1379
|
+
});
|
|
1380
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1381
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1382
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
401
1383
|
});
|
|
402
1384
|
const submissionMetaFieldsSchema = z.object({
|
|
403
1385
|
id: z.string(),
|
|
404
1386
|
environmentId: z.string(),
|
|
1387
|
+
auditId: z.string().nullable(),
|
|
405
1388
|
createdAt: z.coerce.date(),
|
|
406
1389
|
updatedAt: z.coerce.date()
|
|
407
1390
|
});
|
|
408
1391
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
409
1392
|
platform: z.literal("claudeai"),
|
|
410
|
-
formData:
|
|
1393
|
+
formData: claudeSubmissionDraftSchema
|
|
411
1394
|
});
|
|
412
1395
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
413
1396
|
platform: z.literal("chatgpt"),
|
|
414
|
-
formData:
|
|
1397
|
+
formData: chatgptSubmissionDraftSchema
|
|
415
1398
|
});
|
|
416
1399
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
417
|
-
z.union([
|
|
1400
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1401
|
+
({
|
|
1402
|
+
free: 1e4,
|
|
1403
|
+
pro: 2e5,
|
|
1404
|
+
business: 2e6,
|
|
1405
|
+
enterprise: null
|
|
1406
|
+
}).free;
|
|
1407
|
+
z.literal([
|
|
1408
|
+
100,
|
|
1409
|
+
75,
|
|
1410
|
+
50
|
|
1411
|
+
]);
|
|
418
1412
|
const subscriptionPlanSchema = z.enum([
|
|
419
1413
|
"pro",
|
|
420
1414
|
"business",
|
|
421
1415
|
"enterprise"
|
|
422
1416
|
]);
|
|
423
1417
|
z.object({ plan: subscriptionPlanSchema.nullable() });
|
|
1418
|
+
const customerCreditsSchema = z.object({
|
|
1419
|
+
balanceInCents: z.number(),
|
|
1420
|
+
expiresAt: z.number().nullable(),
|
|
1421
|
+
currency: z.string()
|
|
1422
|
+
});
|
|
1423
|
+
const customerUsageSchema = z.object({
|
|
1424
|
+
amountInCents: z.number(),
|
|
1425
|
+
currency: z.string(),
|
|
1426
|
+
periodEnd: z.number()
|
|
1427
|
+
});
|
|
1428
|
+
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1429
|
+
z.object({ balanceInNanoUSD: z.number() });
|
|
1430
|
+
z.object({
|
|
1431
|
+
customerCredits: customerCreditsSchema.nullable(),
|
|
1432
|
+
customerUsage: customerUsageSchema.nullable(),
|
|
1433
|
+
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1434
|
+
});
|
|
1435
|
+
//#endregion
|
|
1436
|
+
//#region src/auth-scope.ts
|
|
1437
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1438
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1439
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1440
|
+
const AUTH_SCOPE_USER = "user";
|
|
424
1441
|
//#endregion
|
|
425
1442
|
//#region src/schemas.ts
|
|
426
1443
|
const RESERVED_KEYS = [
|
|
@@ -457,7 +1474,10 @@ const RESERVED_KEYS = [
|
|
|
457
1474
|
"BUILD_ARG_START_COMMAND",
|
|
458
1475
|
"ALPIC_HOST",
|
|
459
1476
|
"ALPIC_CUSTOM_DOMAINS",
|
|
460
|
-
"ALPIC_INTENT_META_KEY"
|
|
1477
|
+
"ALPIC_INTENT_META_KEY",
|
|
1478
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1479
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1480
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
461
1481
|
];
|
|
462
1482
|
const environmentVariableSchema = z.object({
|
|
463
1483
|
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"),
|
|
@@ -538,21 +1558,20 @@ const deploymentSchema = z.object({
|
|
|
538
1558
|
isCurrent: z.boolean(),
|
|
539
1559
|
deploymentPageUrl: z.url().nullable()
|
|
540
1560
|
});
|
|
541
|
-
const
|
|
1561
|
+
const isValidTimeInput = (value) => {
|
|
542
1562
|
if (ms(value) !== void 0) return true;
|
|
543
1563
|
return !Number.isNaN(new Date(value).getTime());
|
|
544
1564
|
};
|
|
545
|
-
const
|
|
1565
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1566
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1567
|
+
const createEnvironmentContractV1 = base.route({
|
|
546
1568
|
path: "/v1/environments",
|
|
547
1569
|
method: "POST",
|
|
548
1570
|
summary: "Create an environment",
|
|
549
1571
|
description: "Create an environment for a project",
|
|
550
1572
|
tags: ["environments"],
|
|
551
1573
|
successDescription: "The environment has been created successfully"
|
|
552
|
-
}).errors({
|
|
553
|
-
NOT_FOUND: {},
|
|
554
|
-
BAD_REQUEST: {}
|
|
555
|
-
}).input(z.object({
|
|
1574
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
556
1575
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
557
1576
|
name: z.string().min(1).describe("The name of the environment"),
|
|
558
1577
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -561,11 +1580,11 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
561
1580
|
id: z.string(),
|
|
562
1581
|
name: z.string(),
|
|
563
1582
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
564
|
-
urls: z.array(z.
|
|
1583
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
565
1584
|
createdAt: z.coerce.date(),
|
|
566
1585
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
567
1586
|
}));
|
|
568
|
-
const getEnvironmentContractV1 =
|
|
1587
|
+
const getEnvironmentContractV1 = base.route({
|
|
569
1588
|
path: "/v1/environments/{environmentId}",
|
|
570
1589
|
method: "GET",
|
|
571
1590
|
summary: "Get an environment",
|
|
@@ -577,7 +1596,7 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
577
1596
|
name: z.string(),
|
|
578
1597
|
sourceBranch: z.string().nullable(),
|
|
579
1598
|
mcpServerUrl: z.string(),
|
|
580
|
-
domains: z.array(z.
|
|
1599
|
+
domains: z.array(z.hostname()),
|
|
581
1600
|
createdAt: z.coerce.date(),
|
|
582
1601
|
projectId: z.string()
|
|
583
1602
|
}));
|
|
@@ -622,7 +1641,7 @@ const projectOutputSchema = z.object({
|
|
|
622
1641
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
623
1642
|
environments: z.array(environmentSchema)
|
|
624
1643
|
});
|
|
625
|
-
const getProjectContractV1 =
|
|
1644
|
+
const getProjectContractV1 = base.route({
|
|
626
1645
|
path: "/v1/projects/{projectId}",
|
|
627
1646
|
method: "GET",
|
|
628
1647
|
summary: "Get a project",
|
|
@@ -630,15 +1649,15 @@ const getProjectContractV1 = oc.route({
|
|
|
630
1649
|
tags: ["projects"],
|
|
631
1650
|
successDescription: "The project details"
|
|
632
1651
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
633
|
-
const listProjectsContractV1 =
|
|
1652
|
+
const listProjectsContractV1 = base.route({
|
|
634
1653
|
path: "/v1/projects",
|
|
635
1654
|
method: "GET",
|
|
636
1655
|
summary: "List projects",
|
|
637
1656
|
description: "List all projects for a team",
|
|
638
1657
|
tags: ["projects"],
|
|
639
1658
|
successDescription: "The list of projects"
|
|
640
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
641
|
-
const createProjectContractV1 =
|
|
1659
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1660
|
+
const createProjectContractV1 = base.route({
|
|
642
1661
|
path: "/v1/projects",
|
|
643
1662
|
method: "POST",
|
|
644
1663
|
summary: "Create a project",
|
|
@@ -647,7 +1666,7 @@ const createProjectContractV1 = oc.route({
|
|
|
647
1666
|
successDescription: "The project has been created successfully"
|
|
648
1667
|
}).errors({
|
|
649
1668
|
NOT_FOUND: {},
|
|
650
|
-
|
|
1669
|
+
FORBIDDEN: {}
|
|
651
1670
|
}).input(z.object({
|
|
652
1671
|
teamId: z.string().optional(),
|
|
653
1672
|
name: z.string().trim().min(1).max(100),
|
|
@@ -687,7 +1706,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
687
1706
|
isSecret: z.boolean(),
|
|
688
1707
|
createdAt: z.coerce.date()
|
|
689
1708
|
});
|
|
690
|
-
const listEnvironmentVariablesContractV1 =
|
|
1709
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
691
1710
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
692
1711
|
method: "GET",
|
|
693
1712
|
summary: "List environment variables",
|
|
@@ -695,37 +1714,31 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
695
1714
|
tags: ["environments"],
|
|
696
1715
|
successDescription: "The list of environment variables"
|
|
697
1716
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
698
|
-
const createEnvironmentVariablesContractV1 =
|
|
1717
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
699
1718
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
700
1719
|
method: "POST",
|
|
701
1720
|
summary: "Add environment variables",
|
|
702
1721
|
description: "Add one or more environment variables to an environment",
|
|
703
1722
|
tags: ["environments"],
|
|
704
1723
|
successDescription: "The environment variables have been added successfully"
|
|
705
|
-
}).errors({
|
|
706
|
-
NOT_FOUND: {},
|
|
707
|
-
BAD_REQUEST: {}
|
|
708
|
-
}).input(z.object({
|
|
1724
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
709
1725
|
environmentId: z.string().describe("The ID of the environment"),
|
|
710
1726
|
environmentVariables: environmentVariablesSchema
|
|
711
1727
|
})).output(z.object({ success: z.literal(true) }));
|
|
712
|
-
const updateEnvironmentVariableContractV1 =
|
|
1728
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
713
1729
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
714
1730
|
method: "PATCH",
|
|
715
1731
|
summary: "Update an environment variable",
|
|
716
1732
|
description: "Update an environment variable by ID",
|
|
717
1733
|
tags: ["environments"],
|
|
718
1734
|
successDescription: "The environment variable has been updated successfully"
|
|
719
|
-
}).errors({
|
|
720
|
-
NOT_FOUND: {},
|
|
721
|
-
BAD_REQUEST: {}
|
|
722
|
-
}).input(z.object({
|
|
1735
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
723
1736
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
724
1737
|
key: environmentVariableSchema.shape.key,
|
|
725
1738
|
value: environmentVariableSchema.shape.value.optional(),
|
|
726
1739
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
727
1740
|
})).output(z.object({ success: z.literal(true) }));
|
|
728
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1741
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
729
1742
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
730
1743
|
method: "DELETE",
|
|
731
1744
|
summary: "Delete an environment variable",
|
|
@@ -733,7 +1746,7 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
733
1746
|
tags: ["environments"],
|
|
734
1747
|
successDescription: "The environment variable has been deleted successfully"
|
|
735
1748
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
736
|
-
const deleteProjectContractV1 =
|
|
1749
|
+
const deleteProjectContractV1 = base.route({
|
|
737
1750
|
path: "/v1/projects/{projectId}",
|
|
738
1751
|
method: "DELETE",
|
|
739
1752
|
summary: "Delete a project",
|
|
@@ -741,7 +1754,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
741
1754
|
tags: ["projects"],
|
|
742
1755
|
successDescription: "The project has been deleted successfully"
|
|
743
1756
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
744
|
-
const updateProjectContractV1 =
|
|
1757
|
+
const updateProjectContractV1 = base.route({
|
|
745
1758
|
path: "/v1/projects/{projectId}",
|
|
746
1759
|
method: "PATCH",
|
|
747
1760
|
summary: "Update a project",
|
|
@@ -750,13 +1763,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
750
1763
|
successDescription: "The project has been updated successfully"
|
|
751
1764
|
}).errors({
|
|
752
1765
|
NOT_FOUND: {},
|
|
753
|
-
|
|
1766
|
+
FORBIDDEN: {}
|
|
754
1767
|
}).input(z.object({
|
|
755
1768
|
projectId: z.string().describe("The ID of the project"),
|
|
756
1769
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
757
1770
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
758
1771
|
})).output(projectOutputSchema);
|
|
759
|
-
const deployEnvironmentContractV1 =
|
|
1772
|
+
const deployEnvironmentContractV1 = base.route({
|
|
760
1773
|
path: "/v1/environments/{environmentId}/deploy",
|
|
761
1774
|
method: "POST",
|
|
762
1775
|
summary: "Deploy an environment",
|
|
@@ -765,24 +1778,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
765
1778
|
successDescription: "The environment has been deployed successfully"
|
|
766
1779
|
}).errors({
|
|
767
1780
|
NOT_FOUND: {},
|
|
768
|
-
|
|
1781
|
+
CONFLICT: {}
|
|
769
1782
|
}).input(z.object({
|
|
770
1783
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
771
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1784
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1785
|
+
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.")
|
|
772
1786
|
})).output(deploymentSchema);
|
|
773
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1787
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
774
1788
|
path: "/v1/deployments/upload",
|
|
775
1789
|
method: "POST",
|
|
776
1790
|
summary: "Upload deployment artifacts",
|
|
777
1791
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
778
1792
|
tags: ["deployments"],
|
|
779
1793
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
780
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1794
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
781
1795
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
782
1796
|
token: z.string().describe("Token to identify the source archive"),
|
|
783
1797
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
784
1798
|
}));
|
|
785
|
-
const listDeploymentsContractV1 =
|
|
1799
|
+
const listDeploymentsContractV1 = base.route({
|
|
786
1800
|
path: "/v1/projects/{projectId}/deployments",
|
|
787
1801
|
method: "GET",
|
|
788
1802
|
summary: "List project deployments",
|
|
@@ -794,7 +1808,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
794
1808
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
795
1809
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
796
1810
|
})).output(z.array(deploymentSchema));
|
|
797
|
-
const getDeploymentContractV1 =
|
|
1811
|
+
const getDeploymentContractV1 = base.route({
|
|
798
1812
|
path: "/v1/deployments/{deploymentId}",
|
|
799
1813
|
method: "GET",
|
|
800
1814
|
summary: "Get a deployment",
|
|
@@ -802,20 +1816,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
802
1816
|
tags: ["deployments"],
|
|
803
1817
|
successDescription: "The deployment details"
|
|
804
1818
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
805
|
-
const
|
|
1819
|
+
const logEntrySchema = z.object({
|
|
1820
|
+
timestamp: z.coerce.date(),
|
|
1821
|
+
type: z.enum([
|
|
1822
|
+
"START",
|
|
1823
|
+
"END",
|
|
1824
|
+
"INFO",
|
|
1825
|
+
"ERROR",
|
|
1826
|
+
"WARNING",
|
|
1827
|
+
"DEBUG"
|
|
1828
|
+
]),
|
|
1829
|
+
requestId: z.string(),
|
|
1830
|
+
content: z.string().optional(),
|
|
1831
|
+
method: z.string().optional(),
|
|
1832
|
+
durationInMs: z.number().optional()
|
|
1833
|
+
});
|
|
1834
|
+
const getLogsContractV1 = base.route({
|
|
806
1835
|
path: "/v1/environments/{environmentId}/logs",
|
|
807
1836
|
method: "GET",
|
|
808
1837
|
summary: "Get logs",
|
|
809
1838
|
description: "Get logs for an environment",
|
|
810
1839
|
tags: ["environments"],
|
|
811
1840
|
successDescription: "The logs"
|
|
812
|
-
}).errors({
|
|
813
|
-
NOT_FOUND: {},
|
|
814
|
-
BAD_REQUEST: {}
|
|
815
|
-
}).input(z.object({
|
|
1841
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
816
1842
|
environmentId: z.string().describe("The ID of the environment"),
|
|
817
|
-
since:
|
|
818
|
-
until:
|
|
1843
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1844
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
819
1845
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
820
1846
|
level: z.array(z.enum([
|
|
821
1847
|
"INFO",
|
|
@@ -826,34 +1852,17 @@ const getLogsContractV1 = oc.route({
|
|
|
826
1852
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
827
1853
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
828
1854
|
})).output(z.object({
|
|
829
|
-
logs: z.array(
|
|
830
|
-
timestamp: z.coerce.date(),
|
|
831
|
-
type: z.enum([
|
|
832
|
-
"START",
|
|
833
|
-
"END",
|
|
834
|
-
"INFO",
|
|
835
|
-
"ERROR",
|
|
836
|
-
"WARNING",
|
|
837
|
-
"DEBUG"
|
|
838
|
-
]),
|
|
839
|
-
requestId: z.string(),
|
|
840
|
-
content: z.string().optional(),
|
|
841
|
-
method: z.string().optional(),
|
|
842
|
-
durationInMs: z.number().optional()
|
|
843
|
-
})),
|
|
1855
|
+
logs: z.array(logEntrySchema),
|
|
844
1856
|
nextToken: z.string().nullable()
|
|
845
1857
|
}));
|
|
846
|
-
const getLatestLogsContractV1 =
|
|
1858
|
+
const getLatestLogsContractV1 = base.route({
|
|
847
1859
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
848
1860
|
method: "GET",
|
|
849
1861
|
summary: "Get latest logs",
|
|
850
1862
|
description: "Get the N most recent logs for an environment",
|
|
851
1863
|
tags: ["environments"],
|
|
852
1864
|
successDescription: "The latest logs"
|
|
853
|
-
}).errors({
|
|
854
|
-
NOT_FOUND: {},
|
|
855
|
-
BAD_REQUEST: {}
|
|
856
|
-
}).input(z.object({
|
|
1865
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
857
1866
|
environmentId: z.string().describe("The ID of the environment"),
|
|
858
1867
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
859
1868
|
level: z.array(z.enum([
|
|
@@ -863,22 +1872,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
863
1872
|
"DEBUG"
|
|
864
1873
|
])).optional().describe("Filter by log level"),
|
|
865
1874
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
866
|
-
})).output(z.object({ logs: z.array(
|
|
867
|
-
|
|
868
|
-
type: z.enum([
|
|
869
|
-
"START",
|
|
870
|
-
"END",
|
|
871
|
-
"INFO",
|
|
872
|
-
"ERROR",
|
|
873
|
-
"WARNING",
|
|
874
|
-
"DEBUG"
|
|
875
|
-
]),
|
|
876
|
-
requestId: z.string(),
|
|
877
|
-
content: z.string().optional(),
|
|
878
|
-
method: z.string().optional(),
|
|
879
|
-
durationInMs: z.number().optional()
|
|
880
|
-
})) }));
|
|
881
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1875
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1876
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
882
1877
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
883
1878
|
method: "GET",
|
|
884
1879
|
summary: "Get deployment logs",
|
|
@@ -905,17 +1900,14 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
905
1900
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
906
1901
|
task_count: z.array(analyticsDataPointSchema)
|
|
907
1902
|
});
|
|
908
|
-
const getProjectAnalyticsContractV1 =
|
|
1903
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
909
1904
|
path: "/v1/analytics/{projectId}",
|
|
910
1905
|
method: "GET",
|
|
911
1906
|
summary: "Get project analytics",
|
|
912
1907
|
description: "Get analytics data for a project over a time range",
|
|
913
1908
|
tags: ["analytics"],
|
|
914
1909
|
successDescription: "The project analytics data"
|
|
915
|
-
}).errors({
|
|
916
|
-
NOT_FOUND: {},
|
|
917
|
-
BAD_REQUEST: {}
|
|
918
|
-
}).input(z.object({
|
|
1910
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
919
1911
|
projectId: z.string().describe("The ID of the project"),
|
|
920
1912
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
921
1913
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
@@ -930,7 +1922,61 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
930
1922
|
}),
|
|
931
1923
|
timeSeries: analyticsTimeSeriesSchema
|
|
932
1924
|
}));
|
|
933
|
-
const
|
|
1925
|
+
const paginatedInsightsInputShape = {
|
|
1926
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1927
|
+
since: timeInputSchema.default("7d").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"),
|
|
1929
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1930
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1931
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1932
|
+
};
|
|
1933
|
+
const listIntentsContractV1 = base.route({
|
|
1934
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1935
|
+
method: "GET",
|
|
1936
|
+
summary: "List intents",
|
|
1937
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1938
|
+
tags: ["insights"],
|
|
1939
|
+
successDescription: "The grouped user intents"
|
|
1940
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1941
|
+
...paginatedInsightsInputShape,
|
|
1942
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1943
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
1944
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1945
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
1946
|
+
})).output(z.object({
|
|
1947
|
+
intents: z.array(z.object({
|
|
1948
|
+
id: z.string(),
|
|
1949
|
+
intentIds: z.array(z.string()).min(1),
|
|
1950
|
+
environmentId: z.string(),
|
|
1951
|
+
message: z.string(),
|
|
1952
|
+
toolName: z.string(),
|
|
1953
|
+
createdAt: z.coerce.date(),
|
|
1954
|
+
occurrenceCount: z.number().int().positive(),
|
|
1955
|
+
clientName: z.string().nullable(),
|
|
1956
|
+
clientId: z.string().nullable(),
|
|
1957
|
+
categories: z.array(z.object({
|
|
1958
|
+
id: z.string(),
|
|
1959
|
+
name: z.string(),
|
|
1960
|
+
color: intentCategoryColorSchema
|
|
1961
|
+
}))
|
|
1962
|
+
})),
|
|
1963
|
+
totalCount: z.number().int().nonnegative()
|
|
1964
|
+
}));
|
|
1965
|
+
const listFeedbacksContractV1 = base.route({
|
|
1966
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
1967
|
+
method: "GET",
|
|
1968
|
+
summary: "List feedbacks",
|
|
1969
|
+
description: "List user feedback for an environment over a time range",
|
|
1970
|
+
tags: ["insights"],
|
|
1971
|
+
successDescription: "The user feedback"
|
|
1972
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1973
|
+
...paginatedInsightsInputShape,
|
|
1974
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
1975
|
+
})).output(z.object({
|
|
1976
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
1977
|
+
totalCount: z.number().int().nonnegative()
|
|
1978
|
+
}));
|
|
1979
|
+
const listTeamsContractV1 = base.route({
|
|
934
1980
|
path: "/v1/teams",
|
|
935
1981
|
method: "GET",
|
|
936
1982
|
summary: "List teams",
|
|
@@ -943,28 +1989,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
943
1989
|
createdAt: z.coerce.date(),
|
|
944
1990
|
hasStripeAccount: z.boolean()
|
|
945
1991
|
})));
|
|
946
|
-
const
|
|
1992
|
+
const getTeamUsageContractV1 = base.route({
|
|
1993
|
+
path: "/v1/teams/{teamId}/usage",
|
|
1994
|
+
method: "GET",
|
|
1995
|
+
summary: "Get team usage",
|
|
1996
|
+
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.",
|
|
1997
|
+
tags: ["teams"],
|
|
1998
|
+
successDescription: "The current billing window usage"
|
|
1999
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2000
|
+
teamId: z.string(),
|
|
2001
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2002
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2003
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2004
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2005
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2006
|
+
}));
|
|
2007
|
+
const getTunnelTicketContractV1 = base.route({
|
|
947
2008
|
path: "/v1/tunnels/ticket",
|
|
948
2009
|
method: "GET",
|
|
949
2010
|
summary: "Get a tunnel ticket",
|
|
950
2011
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
951
2012
|
tags: ["tunnels"],
|
|
952
2013
|
successDescription: "The tunnel ticket"
|
|
953
|
-
}).output(z.object({
|
|
2014
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
954
2015
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
955
2016
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
956
2017
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
957
2018
|
}));
|
|
958
|
-
const publishServerContractV1 =
|
|
2019
|
+
const publishServerContractV1 = base.route({
|
|
959
2020
|
path: "/v1/distribution/publish",
|
|
960
2021
|
method: "POST",
|
|
961
2022
|
summary: "Publish a server to the MCP registry",
|
|
962
2023
|
tags: ["distribution"],
|
|
963
2024
|
successDescription: "The server has been published successfully"
|
|
964
|
-
}).errors({
|
|
965
|
-
NOT_FOUND: {},
|
|
966
|
-
BAD_REQUEST: {}
|
|
967
|
-
}).input(z.object({
|
|
2025
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
968
2026
|
projectId: z.string(),
|
|
969
2027
|
domain: z.string(),
|
|
970
2028
|
title: z.string().min(1).max(100),
|
|
@@ -973,17 +2031,14 @@ const publishServerContractV1 = oc.route({
|
|
|
973
2031
|
iconSrc: z.url().max(255).optional(),
|
|
974
2032
|
dryRun: z.boolean().optional()
|
|
975
2033
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
976
|
-
const getServerInfoContractV1 =
|
|
2034
|
+
const getServerInfoContractV1 = base.route({
|
|
977
2035
|
path: "/v1/distribution/get",
|
|
978
2036
|
method: "GET",
|
|
979
2037
|
summary: "Get server info",
|
|
980
2038
|
description: "Get info about a server",
|
|
981
2039
|
tags: ["distribution"],
|
|
982
2040
|
successDescription: "The server info"
|
|
983
|
-
}).errors({
|
|
984
|
-
NOT_FOUND: {},
|
|
985
|
-
BAD_REQUEST: {}
|
|
986
|
-
}).input(z.object({
|
|
2041
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
987
2042
|
projectId: z.string(),
|
|
988
2043
|
domain: z.string()
|
|
989
2044
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1002,7 +2057,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1002
2057
|
isPlaygroundEnabled: z.boolean(),
|
|
1003
2058
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1004
2059
|
});
|
|
1005
|
-
const getPlaygroundContractV1 =
|
|
2060
|
+
const getPlaygroundContractV1 = base.route({
|
|
1006
2061
|
path: "/v1/environments/{environmentId}/playground",
|
|
1007
2062
|
method: "GET",
|
|
1008
2063
|
summary: "Get playground configuration",
|
|
@@ -1010,25 +2065,22 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1010
2065
|
tags: ["environments"],
|
|
1011
2066
|
successDescription: "The playground configuration"
|
|
1012
2067
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1013
|
-
const upsertPlaygroundContractV1 =
|
|
2068
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1014
2069
|
path: "/v1/environments/{environmentId}/playground",
|
|
1015
2070
|
method: "PUT",
|
|
1016
2071
|
summary: "Update playground configuration",
|
|
1017
2072
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1018
2073
|
tags: ["environments"],
|
|
1019
2074
|
successDescription: "The updated playground configuration"
|
|
1020
|
-
}).errors({
|
|
1021
|
-
NOT_FOUND: {},
|
|
1022
|
-
BAD_REQUEST: {}
|
|
1023
|
-
}).input(z.object({
|
|
2075
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1024
2076
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1025
2077
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1026
2078
|
name: z.string().min(1).max(100).optional(),
|
|
1027
2079
|
description: z.string().min(1).max(500).optional(),
|
|
1028
2080
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1029
|
-
examplePrompts: z.array(playgroundExamplePromptSchema).max(
|
|
2081
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1030
2082
|
})).output(playgroundOutputSchema);
|
|
1031
|
-
const createBeaconContractV1 =
|
|
2083
|
+
const createBeaconContractV1 = base.route({
|
|
1032
2084
|
path: "/v1/beacon/audits",
|
|
1033
2085
|
method: "POST",
|
|
1034
2086
|
summary: "Create a beacon audit",
|
|
@@ -1037,14 +2089,14 @@ const createBeaconContractV1 = oc.route({
|
|
|
1037
2089
|
successDescription: "The audit has been created"
|
|
1038
2090
|
}).errors({
|
|
1039
2091
|
NOT_FOUND: {},
|
|
1040
|
-
|
|
2092
|
+
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1041
2093
|
}).input(z.object({
|
|
1042
2094
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
1043
2095
|
teamId: z.string().optional().describe("The team ID to associate the audit with"),
|
|
1044
2096
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1045
2097
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1046
2098
|
})).output(z.object({ id: z.string() }));
|
|
1047
|
-
const getBeaconContractV1 =
|
|
2099
|
+
const getBeaconContractV1 = base.route({
|
|
1048
2100
|
path: "/v1/beacon/audits/{auditId}",
|
|
1049
2101
|
method: "GET",
|
|
1050
2102
|
summary: "Get a beacon audit",
|
|
@@ -1060,8 +2112,13 @@ const getBeaconContractV1 = oc.route({
|
|
|
1060
2112
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1061
2113
|
}));
|
|
1062
2114
|
const contract = {
|
|
1063
|
-
teams: {
|
|
2115
|
+
teams: {
|
|
2116
|
+
list: { v1: listTeamsContractV1 },
|
|
2117
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2118
|
+
},
|
|
1064
2119
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2120
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2121
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1065
2122
|
deployments: {
|
|
1066
2123
|
list: { v1: listDeploymentsContractV1 },
|
|
1067
2124
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1102,5 +2159,10 @@ const contract = {
|
|
|
1102
2159
|
get: { v1: getBeaconContractV1 }
|
|
1103
2160
|
}
|
|
1104
2161
|
};
|
|
2162
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2163
|
+
const contractForDocs = {
|
|
2164
|
+
...contract,
|
|
2165
|
+
deployments: deploymentsForDocs
|
|
2166
|
+
};
|
|
1105
2167
|
//#endregion
|
|
1106
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2168
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|