@alpic-ai/api 0.0.0-dev.gd514aa3 → 0.0.0-dev.gd5c7a44
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 +91 -59
- package/dist/index.mjs +765 -221
- package/package.json +22 -6
package/dist/index.mjs
CHANGED
|
@@ -1,6 +1,174 @@
|
|
|
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";
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.29.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();
|
|
4
172
|
const platformSchema = z.enum(["chatgpt", "claudeai"]);
|
|
5
173
|
const PLATFORM_LABELS = {
|
|
6
174
|
chatgpt: "ChatGPT",
|
|
@@ -71,6 +239,13 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
|
|
|
71
239
|
chatgpt: widgetScreenshotSchema.optional(),
|
|
72
240
|
claudeai: widgetScreenshotSchema.optional()
|
|
73
241
|
}) });
|
|
242
|
+
z.object({
|
|
243
|
+
id: z.string(),
|
|
244
|
+
environmentId: z.string(),
|
|
245
|
+
clientId: z.string(),
|
|
246
|
+
clientSecret: z.string(),
|
|
247
|
+
clientScopes: z.array(z.string())
|
|
248
|
+
});
|
|
74
249
|
const deploymentStatusSchema$1 = z.enum([
|
|
75
250
|
"ongoing",
|
|
76
251
|
"deployed",
|
|
@@ -98,9 +273,83 @@ const deploymentSummarySchema = z.object({
|
|
|
98
273
|
createdAt: z.coerce.date(),
|
|
99
274
|
updatedAt: z.coerce.date()
|
|
100
275
|
});
|
|
276
|
+
/**
|
|
277
|
+
* Public environment
|
|
278
|
+
*
|
|
279
|
+
* No OAuth metadata exposed.
|
|
280
|
+
*/
|
|
281
|
+
const publicEnvironmentSchema = z.object({
|
|
282
|
+
isPublic: z.literal(true),
|
|
283
|
+
oAuthMetadata: z.undefined().optional()
|
|
284
|
+
});
|
|
285
|
+
/**
|
|
286
|
+
* Protected environment with an external resource metadata URL
|
|
287
|
+
*
|
|
288
|
+
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
289
|
+
* Everything that follows is handled outside of the MCP server scope.
|
|
290
|
+
*/
|
|
291
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
292
|
+
isPublic: z.literal(false),
|
|
293
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
|
+
scope: z.string().optional()
|
|
295
|
+
});
|
|
296
|
+
/**
|
|
297
|
+
* Protected environment with an external authorization server URL
|
|
298
|
+
*
|
|
299
|
+
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
300
|
+
* An external authorization server URL is returned when requesting the endpoint.
|
|
301
|
+
* Everything that follows is handled outside of the MCP server scope.
|
|
302
|
+
*/
|
|
303
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
|
+
isPublic: z.literal(false),
|
|
305
|
+
oAuthMetadata: z.object({
|
|
306
|
+
externalAuthorizationServerUrl: z.url(),
|
|
307
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
308
|
+
}),
|
|
309
|
+
scope: z.string().optional()
|
|
310
|
+
});
|
|
311
|
+
/**
|
|
312
|
+
* Standalone protected environment
|
|
313
|
+
*
|
|
314
|
+
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
315
|
+
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
316
|
+
*/
|
|
317
|
+
const standaloneEnvironmentSchema = z.object({
|
|
318
|
+
isPublic: z.literal(false),
|
|
319
|
+
oAuthMetadata: z.object({
|
|
320
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
321
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
322
|
+
}),
|
|
323
|
+
scope: z.string().optional()
|
|
324
|
+
});
|
|
325
|
+
/**
|
|
326
|
+
* Protected environment without OAuth discovery
|
|
327
|
+
*
|
|
328
|
+
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
329
|
+
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
330
|
+
* are advertised. Clients must obtain credentials out-of-band.
|
|
331
|
+
*/
|
|
332
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
|
+
isPublic: z.literal(false),
|
|
334
|
+
oAuthMetadata: z.strictObject({}),
|
|
335
|
+
scope: z.string().optional()
|
|
336
|
+
});
|
|
337
|
+
z.union([
|
|
338
|
+
publicEnvironmentSchema,
|
|
339
|
+
externalResourceMetadataEnvironmentSchema,
|
|
340
|
+
externalAuthorizationServerEnvironmentSchema,
|
|
341
|
+
standaloneEnvironmentSchema,
|
|
342
|
+
protectedWithoutDiscoveryEnvironmentSchema
|
|
343
|
+
]);
|
|
101
344
|
const allowedPlatformSchema = platformSchema;
|
|
345
|
+
const playgroundModelSchema = z.enum([
|
|
346
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
347
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
348
|
+
"openai.gpt-5.4",
|
|
349
|
+
"openai.gpt-5.5"
|
|
350
|
+
]);
|
|
102
351
|
const environmentDomainSchema = z.object({
|
|
103
|
-
|
|
352
|
+
name: z.string(),
|
|
104
353
|
status: z.enum([
|
|
105
354
|
"ongoing",
|
|
106
355
|
"deployed",
|
|
@@ -118,6 +367,7 @@ const environmentSchema$1 = z.object({
|
|
|
118
367
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
119
368
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
120
369
|
isPlaygroundEnabled: z.boolean(),
|
|
370
|
+
playgroundModel: playgroundModelSchema,
|
|
121
371
|
isIpWhitelistEnabled: z.boolean(),
|
|
122
372
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
123
373
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -126,6 +376,13 @@ const environmentSchema$1 = z.object({
|
|
|
126
376
|
updatedAt: z.coerce.date()
|
|
127
377
|
});
|
|
128
378
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
379
|
+
z.object({
|
|
380
|
+
sessionReplayEnabled: z.boolean(),
|
|
381
|
+
collectRequestPayload: z.boolean(),
|
|
382
|
+
collectResponsePayload: z.boolean(),
|
|
383
|
+
collectErrorMessage: z.boolean(),
|
|
384
|
+
collectUserData: z.boolean()
|
|
385
|
+
});
|
|
129
386
|
z.object({
|
|
130
387
|
id: z.string(),
|
|
131
388
|
createdAt: z.coerce.date(),
|
|
@@ -259,15 +516,27 @@ z.object({
|
|
|
259
516
|
environments: z.array(environmentWithDomainsSchema),
|
|
260
517
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
261
518
|
});
|
|
519
|
+
const domainFailureReasonSchema = z.enum([
|
|
520
|
+
"caa",
|
|
521
|
+
"dns",
|
|
522
|
+
"invalid_domain",
|
|
523
|
+
"other"
|
|
524
|
+
]);
|
|
525
|
+
const projectDomainMappingSchema = z.object({
|
|
526
|
+
pathPrefix: z.string(),
|
|
527
|
+
environment: environmentSchema$1
|
|
528
|
+
});
|
|
262
529
|
z.object({
|
|
263
|
-
|
|
530
|
+
name: z.string(),
|
|
264
531
|
createdAt: z.coerce.date(),
|
|
265
532
|
status: z.enum([
|
|
266
533
|
"ongoing",
|
|
267
534
|
"deployed",
|
|
268
535
|
"failed"
|
|
269
536
|
]),
|
|
270
|
-
|
|
537
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
538
|
+
environment: environmentSchema$1,
|
|
539
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
271
540
|
});
|
|
272
541
|
const serverFieldsSchema$1 = z.object({
|
|
273
542
|
$schema: z.string(),
|
|
@@ -324,17 +593,20 @@ const toolDefinitionSchema = z.object({
|
|
|
324
593
|
}).optional()
|
|
325
594
|
});
|
|
326
595
|
const positiveTestCaseSchema = z.object({
|
|
327
|
-
scenario: z.string(),
|
|
328
|
-
userPrompt: z.string(),
|
|
329
|
-
toolTriggered: z.string().optional(),
|
|
330
|
-
expectedOutput: z.string().optional()
|
|
596
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
597
|
+
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."),
|
|
598
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
599
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
331
600
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
332
601
|
const screenshotEntrySchema = z.object({
|
|
333
602
|
prompt: z.string(),
|
|
334
|
-
url: z.url()
|
|
603
|
+
url: z.url()
|
|
335
604
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
605
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
336
606
|
/** Accepts either a valid email or URL. */
|
|
337
607
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
608
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
609
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
338
610
|
const chatgptCategorySchema = z.enum([
|
|
339
611
|
"BUSINESS",
|
|
340
612
|
"COLLABORATION",
|
|
@@ -351,22 +623,315 @@ const chatgptCategorySchema = z.enum([
|
|
|
351
623
|
"TRAVEL"
|
|
352
624
|
]);
|
|
353
625
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
354
|
-
const
|
|
626
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
627
|
+
"AD",
|
|
628
|
+
"AE",
|
|
629
|
+
"AF",
|
|
630
|
+
"AG",
|
|
631
|
+
"AL",
|
|
632
|
+
"AM",
|
|
633
|
+
"AO",
|
|
634
|
+
"AR",
|
|
635
|
+
"AT",
|
|
636
|
+
"AU",
|
|
637
|
+
"AW",
|
|
638
|
+
"AX",
|
|
639
|
+
"AZ",
|
|
640
|
+
"BA",
|
|
641
|
+
"BB",
|
|
642
|
+
"BD",
|
|
643
|
+
"BE",
|
|
644
|
+
"BF",
|
|
645
|
+
"BG",
|
|
646
|
+
"BH",
|
|
647
|
+
"BI",
|
|
648
|
+
"BJ",
|
|
649
|
+
"BL",
|
|
650
|
+
"BM",
|
|
651
|
+
"BN",
|
|
652
|
+
"BO",
|
|
653
|
+
"BR",
|
|
654
|
+
"BS",
|
|
655
|
+
"BT",
|
|
656
|
+
"BW",
|
|
657
|
+
"BZ",
|
|
658
|
+
"CA",
|
|
659
|
+
"CD",
|
|
660
|
+
"CF",
|
|
661
|
+
"CG",
|
|
662
|
+
"CH",
|
|
663
|
+
"CI",
|
|
664
|
+
"CL",
|
|
665
|
+
"CM",
|
|
666
|
+
"CO",
|
|
667
|
+
"CR",
|
|
668
|
+
"CV",
|
|
669
|
+
"CY",
|
|
670
|
+
"CZ",
|
|
671
|
+
"DE",
|
|
672
|
+
"DJ",
|
|
673
|
+
"DK",
|
|
674
|
+
"DM",
|
|
675
|
+
"DO",
|
|
676
|
+
"DZ",
|
|
677
|
+
"EC",
|
|
678
|
+
"EE",
|
|
679
|
+
"EG",
|
|
680
|
+
"ER",
|
|
681
|
+
"ES",
|
|
682
|
+
"ET",
|
|
683
|
+
"FI",
|
|
684
|
+
"FJ",
|
|
685
|
+
"FM",
|
|
686
|
+
"FO",
|
|
687
|
+
"FR",
|
|
688
|
+
"GA",
|
|
689
|
+
"GB",
|
|
690
|
+
"GD",
|
|
691
|
+
"GE",
|
|
692
|
+
"GF",
|
|
693
|
+
"GH",
|
|
694
|
+
"GL",
|
|
695
|
+
"GM",
|
|
696
|
+
"GN",
|
|
697
|
+
"GP",
|
|
698
|
+
"GQ",
|
|
699
|
+
"GR",
|
|
700
|
+
"GT",
|
|
701
|
+
"GW",
|
|
702
|
+
"GY",
|
|
703
|
+
"HN",
|
|
704
|
+
"HR",
|
|
705
|
+
"HT",
|
|
706
|
+
"HU",
|
|
707
|
+
"ID",
|
|
708
|
+
"IE",
|
|
709
|
+
"IL",
|
|
710
|
+
"IN",
|
|
711
|
+
"IQ",
|
|
712
|
+
"IS",
|
|
713
|
+
"IT",
|
|
714
|
+
"JM",
|
|
715
|
+
"JO",
|
|
716
|
+
"JP",
|
|
717
|
+
"KE",
|
|
718
|
+
"KG",
|
|
719
|
+
"KH",
|
|
720
|
+
"KI",
|
|
721
|
+
"KM",
|
|
722
|
+
"KN",
|
|
723
|
+
"KR",
|
|
724
|
+
"KW",
|
|
725
|
+
"KY",
|
|
726
|
+
"KZ",
|
|
727
|
+
"LA",
|
|
728
|
+
"LB",
|
|
729
|
+
"LC",
|
|
730
|
+
"LI",
|
|
731
|
+
"LK",
|
|
732
|
+
"LR",
|
|
733
|
+
"LS",
|
|
734
|
+
"LT",
|
|
735
|
+
"LU",
|
|
736
|
+
"LV",
|
|
737
|
+
"LY",
|
|
738
|
+
"MA",
|
|
739
|
+
"MC",
|
|
740
|
+
"MD",
|
|
741
|
+
"ME",
|
|
742
|
+
"MF",
|
|
743
|
+
"MG",
|
|
744
|
+
"MH",
|
|
745
|
+
"MK",
|
|
746
|
+
"ML",
|
|
747
|
+
"MM",
|
|
748
|
+
"MN",
|
|
749
|
+
"MQ",
|
|
750
|
+
"MR",
|
|
751
|
+
"MT",
|
|
752
|
+
"MU",
|
|
753
|
+
"MV",
|
|
754
|
+
"MW",
|
|
755
|
+
"MX",
|
|
756
|
+
"MY",
|
|
757
|
+
"MZ",
|
|
758
|
+
"NA",
|
|
759
|
+
"NC",
|
|
760
|
+
"NE",
|
|
761
|
+
"NG",
|
|
762
|
+
"NI",
|
|
763
|
+
"NL",
|
|
764
|
+
"NO",
|
|
765
|
+
"NP",
|
|
766
|
+
"NR",
|
|
767
|
+
"NZ",
|
|
768
|
+
"OM",
|
|
769
|
+
"PA",
|
|
770
|
+
"PE",
|
|
771
|
+
"PF",
|
|
772
|
+
"PG",
|
|
773
|
+
"PH",
|
|
774
|
+
"PK",
|
|
775
|
+
"PL",
|
|
776
|
+
"PM",
|
|
777
|
+
"PS",
|
|
778
|
+
"PT",
|
|
779
|
+
"PW",
|
|
780
|
+
"PY",
|
|
781
|
+
"QA",
|
|
782
|
+
"RE",
|
|
783
|
+
"RO",
|
|
784
|
+
"RS",
|
|
785
|
+
"RW",
|
|
786
|
+
"SA",
|
|
787
|
+
"SB",
|
|
788
|
+
"SC",
|
|
789
|
+
"SD",
|
|
790
|
+
"SE",
|
|
791
|
+
"SG",
|
|
792
|
+
"SH",
|
|
793
|
+
"SI",
|
|
794
|
+
"SJ",
|
|
795
|
+
"SK",
|
|
796
|
+
"SL",
|
|
797
|
+
"SM",
|
|
798
|
+
"SN",
|
|
799
|
+
"SO",
|
|
800
|
+
"SR",
|
|
801
|
+
"SS",
|
|
802
|
+
"ST",
|
|
803
|
+
"SV",
|
|
804
|
+
"SZ",
|
|
805
|
+
"TD",
|
|
806
|
+
"TF",
|
|
807
|
+
"TG",
|
|
808
|
+
"TH",
|
|
809
|
+
"TJ",
|
|
810
|
+
"TL",
|
|
811
|
+
"TM",
|
|
812
|
+
"TN",
|
|
813
|
+
"TO",
|
|
814
|
+
"TR",
|
|
815
|
+
"TT",
|
|
816
|
+
"TV",
|
|
817
|
+
"TW",
|
|
818
|
+
"TZ",
|
|
819
|
+
"UA",
|
|
820
|
+
"UG",
|
|
821
|
+
"US",
|
|
822
|
+
"UY",
|
|
823
|
+
"UZ",
|
|
824
|
+
"VA",
|
|
825
|
+
"VC",
|
|
826
|
+
"VN",
|
|
827
|
+
"VU",
|
|
828
|
+
"WF",
|
|
829
|
+
"WS",
|
|
830
|
+
"YE",
|
|
831
|
+
"YT",
|
|
832
|
+
"ZA",
|
|
833
|
+
"ZM",
|
|
834
|
+
"ZW"
|
|
835
|
+
]);
|
|
836
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
837
|
+
z.object({ mode: z.literal("all") }),
|
|
838
|
+
z.object({
|
|
839
|
+
mode: z.literal("allow"),
|
|
840
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
841
|
+
}),
|
|
842
|
+
z.object({
|
|
843
|
+
mode: z.literal("block"),
|
|
844
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
845
|
+
})
|
|
846
|
+
]);
|
|
847
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
848
|
+
"am",
|
|
849
|
+
"ar",
|
|
850
|
+
"bg-BG",
|
|
851
|
+
"bn-BD",
|
|
852
|
+
"bs-BA",
|
|
853
|
+
"ca-ES",
|
|
854
|
+
"cs-CZ",
|
|
855
|
+
"da-DK",
|
|
856
|
+
"de-DE",
|
|
857
|
+
"el-GR",
|
|
858
|
+
"es-419",
|
|
859
|
+
"es-ES",
|
|
860
|
+
"et-EE",
|
|
861
|
+
"fi-FI",
|
|
862
|
+
"fr-CA",
|
|
863
|
+
"fr-FR",
|
|
864
|
+
"gu-IN",
|
|
865
|
+
"hi-IN",
|
|
866
|
+
"hr-HR",
|
|
867
|
+
"hu-HU",
|
|
868
|
+
"hy-AM",
|
|
869
|
+
"id-ID",
|
|
870
|
+
"is-IS",
|
|
871
|
+
"it-IT",
|
|
872
|
+
"ja-JP",
|
|
873
|
+
"ka-GE",
|
|
874
|
+
"kk",
|
|
875
|
+
"kn-IN",
|
|
876
|
+
"ko-KR",
|
|
877
|
+
"lt",
|
|
878
|
+
"lv-LV",
|
|
879
|
+
"mk-MK",
|
|
880
|
+
"ml",
|
|
881
|
+
"mn",
|
|
882
|
+
"mr-IN",
|
|
883
|
+
"ms-MY",
|
|
884
|
+
"my-MM",
|
|
885
|
+
"nb-NO",
|
|
886
|
+
"nl-NL",
|
|
887
|
+
"pa",
|
|
888
|
+
"pl-PL",
|
|
889
|
+
"pt-BR",
|
|
890
|
+
"pt-PT",
|
|
891
|
+
"ro-RO",
|
|
892
|
+
"ru-RU",
|
|
893
|
+
"sk-SK",
|
|
894
|
+
"sl-SI",
|
|
895
|
+
"so-SO",
|
|
896
|
+
"sq-AL",
|
|
897
|
+
"sr-RS",
|
|
898
|
+
"sv-SE",
|
|
899
|
+
"sw-TZ",
|
|
900
|
+
"ta-IN",
|
|
901
|
+
"te-IN",
|
|
902
|
+
"th-TH",
|
|
903
|
+
"tl",
|
|
904
|
+
"tr-TR",
|
|
905
|
+
"uk-UA",
|
|
906
|
+
"ur",
|
|
907
|
+
"vi-VN",
|
|
908
|
+
"zh-CN",
|
|
909
|
+
"zh-HK",
|
|
910
|
+
"zh-TW"
|
|
911
|
+
]);
|
|
355
912
|
const negativeTestCaseSchema = z.object({
|
|
356
913
|
scenario: z.string(),
|
|
357
914
|
userPrompt: z.string()
|
|
358
915
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
359
916
|
const chatgptToolJustificationSchema = z.object({
|
|
360
917
|
toolName: z.string(),
|
|
361
|
-
readOnlyJustification: z.string(),
|
|
362
|
-
openWorldJustification: z.string(),
|
|
363
|
-
destructiveJustification: z.string()
|
|
364
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
918
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
919
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
920
|
+
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.\"")
|
|
921
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
922
|
+
/**
|
|
923
|
+
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
924
|
+
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
925
|
+
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
926
|
+
*/
|
|
927
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
928
|
+
const chatgptDescriptionSchema = z.string();
|
|
365
929
|
const chatgptTranslationSchema = z.object({
|
|
366
|
-
locale:
|
|
367
|
-
tagline:
|
|
368
|
-
description:
|
|
930
|
+
locale: chatgptTranslationLocaleSchema,
|
|
931
|
+
tagline: chatgptTaglineSchema,
|
|
932
|
+
description: chatgptDescriptionSchema
|
|
369
933
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
934
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
370
935
|
/**
|
|
371
936
|
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
372
937
|
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
@@ -375,27 +940,38 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
375
940
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
376
941
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
377
942
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
378
|
-
tagline:
|
|
379
|
-
description:
|
|
943
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
944
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
380
945
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
381
946
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
382
|
-
companyUrl:
|
|
947
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
383
948
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
384
|
-
privacyPolicyUrl:
|
|
385
|
-
termsOfServiceUrl:
|
|
386
|
-
demoRecordingUrl:
|
|
949
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
950
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
951
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
387
952
|
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
|
|
388
|
-
serverUrl:
|
|
953
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
389
954
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
390
955
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
391
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
392
|
-
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output.
|
|
393
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases
|
|
394
|
-
screenshots: z.array(screenshotEntrySchema).describe("In-app screenshots paired with the user prompt that produced them. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max
|
|
956
|
+
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."),
|
|
957
|
+
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."),
|
|
958
|
+
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."),
|
|
959
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
395
960
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
396
|
-
allowedCountries: chatgptAllowedCountriesSchema.describe("
|
|
961
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
397
962
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
398
963
|
});
|
|
964
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
965
|
+
tagline: z.string().optional(),
|
|
966
|
+
companyUrl: z.string().optional(),
|
|
967
|
+
supportChannel: z.string().optional(),
|
|
968
|
+
privacyPolicyUrl: z.string().optional(),
|
|
969
|
+
termsOfServiceUrl: z.string().optional(),
|
|
970
|
+
demoRecordingUrl: z.string().optional(),
|
|
971
|
+
serverUrl: z.string().optional(),
|
|
972
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
973
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
974
|
+
});
|
|
399
975
|
chatgptSubmissionFormDataSchema.pick({
|
|
400
976
|
appName: true,
|
|
401
977
|
developerName: true,
|
|
@@ -412,7 +988,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
412
988
|
toolJustifications: true
|
|
413
989
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
414
990
|
const claudeCategorySchema = z.enum([
|
|
415
|
-
"
|
|
991
|
+
"Productivity",
|
|
416
992
|
"Communication",
|
|
417
993
|
"Data & Analytics",
|
|
418
994
|
"Development tools",
|
|
@@ -420,221 +996,171 @@ const claudeCategorySchema = z.enum([
|
|
|
420
996
|
"Consumer Health",
|
|
421
997
|
"Health & Life Sciences",
|
|
422
998
|
"Media & Entertainment",
|
|
423
|
-
"Commerce & Shopping"
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
"
|
|
427
|
-
"
|
|
428
|
-
"
|
|
999
|
+
"Commerce & Shopping",
|
|
1000
|
+
"Legal",
|
|
1001
|
+
"Sales and marketing",
|
|
1002
|
+
"Creative",
|
|
1003
|
+
"Nonprofit",
|
|
1004
|
+
"Education",
|
|
1005
|
+
"Other"
|
|
429
1006
|
]);
|
|
430
|
-
const
|
|
431
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1007
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
432
1008
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
433
|
-
"
|
|
434
|
-
"
|
|
435
|
-
"
|
|
1009
|
+
"read_only",
|
|
1010
|
+
"write_only",
|
|
1011
|
+
"read_write"
|
|
436
1012
|
]);
|
|
437
|
-
const
|
|
438
|
-
|
|
439
|
-
"
|
|
440
|
-
"
|
|
441
|
-
"
|
|
442
|
-
"
|
|
443
|
-
]);
|
|
444
|
-
const claudeThirdPartySchema = z.enum([
|
|
445
|
-
"Web access: Fetches information from the open web (e.g., web scraping, search engines, or browsing arbitrary URLs, not just connecting to a specific API)",
|
|
446
|
-
"Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
|
|
447
|
-
"Third-party data retrieval: Connects to external services that themselves retrieve data from other sources (e.g., workflow automation platforms or other services that aggregate or relay data from multiple third-party sources)",
|
|
448
|
-
"Third-party data modification: Can connect to external services that themselves create, update, or delete data in other sources (e.g., workflow automation platforms or other services that write to multiple third-party sources)",
|
|
449
|
-
"N/A"
|
|
1013
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1014
|
+
"oauth_dcr",
|
|
1015
|
+
"oauth_cimd",
|
|
1016
|
+
"oauth_anthropic_creds",
|
|
1017
|
+
"custom_connection",
|
|
1018
|
+
"none"
|
|
450
1019
|
]);
|
|
451
|
-
const
|
|
452
|
-
"
|
|
453
|
-
"
|
|
454
|
-
"
|
|
455
|
-
"GDPR compliant (if applicable)"
|
|
1020
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1021
|
+
"first_party",
|
|
1022
|
+
"proxied",
|
|
1023
|
+
"third_party"
|
|
456
1024
|
]);
|
|
457
|
-
const
|
|
458
|
-
|
|
459
|
-
"
|
|
460
|
-
"
|
|
1025
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1026
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1027
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1028
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1029
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1030
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1031
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1032
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1033
|
+
"Public documentation for this connector will be live by the publish date."
|
|
461
1034
|
]);
|
|
462
1035
|
/**
|
|
463
|
-
* Field order mirrors the
|
|
464
|
-
*
|
|
1036
|
+
* Field order mirrors the claude.ai directory submission wizard
|
|
1037
|
+
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1038
|
+
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
465
1039
|
*/
|
|
466
1040
|
const claudeSubmissionFormDataSchema = z.object({
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
(
|
|
477
|
-
|
|
478
|
-
(
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
•
|
|
496
|
-
•
|
|
497
|
-
•
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
• '
|
|
513
|
-
• '
|
|
514
|
-
• '
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
|
|
542
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
543
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
544
|
-
• 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
|
|
545
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
546
|
-
serverDocumentationLink: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. This is displayed in the Directory listing and must be publicly accessible without login. Minimum requirements for the docs page:
|
|
547
|
-
• What the connector does and its key capabilities
|
|
548
|
-
• How to connect/set it up (step by step)
|
|
549
|
-
• What each tool does (or at least the main ones)
|
|
550
|
-
• How to troubleshoot common issues
|
|
551
|
-
• A support contact or channel
|
|
552
|
-
Acceptable formats: a dedicated docs page, a help center article, a README on GitHub, or a blog post — as long as it's comprehensive. Note: Anthropic requires public documentation to be live by your publish date.`),
|
|
553
|
-
privacyPolicyUrl: z.url().describe(`URL to your privacy policy. This is mandatory and displayed in the directory listing. Missing or incomplete privacy policies result in immediate rejection. Your privacy policy must cover:
|
|
554
|
-
• What data you collect (and how)
|
|
555
|
-
• How you use the collected data
|
|
556
|
-
• Where and how long you store it
|
|
557
|
-
• Whether you share data with third parties (and who)
|
|
558
|
-
• How users can contact you about data concerns
|
|
559
|
-
The policy must be publicly accessible. If you don't have one yet, create one before submitting — there are free generators online, but make sure it accurately reflects your actual practices. If you're GDPR-compliant, your policy should reflect that.`),
|
|
560
|
-
supportChannel: supportChannelSchema.describe(`A URL or email address where users can get help with your connector. This is displayed in the Directory listing. Acceptable options:
|
|
561
|
-
• Email address (e.g. support@myapp.com)
|
|
562
|
-
• Link to a GitHub Issues page
|
|
563
|
-
• Link to a help center or support article
|
|
564
|
-
• Link to a Discord/Slack community
|
|
565
|
-
• Link to your documentation's troubleshooting section
|
|
566
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
567
|
-
testingCredentials: z.string().describe(`Provide login credentials for a test account that Anthropic reviewers can use to verify your server works end-to-end. Critical requirements:
|
|
568
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
569
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
570
|
-
• If your service uses Google OAuth or another OAuth that requires email verification, use mcp-review@anthropic.com as the account email — Anthropic has access to this inbox.
|
|
571
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
572
|
-
• If your service requires API keys instead of a password, provide those.
|
|
573
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
574
|
-
tools: z.array(toolDefinitionSchema).describe(`A comma-separated list of all tools your MCP server exposes. Use the format: tool_name (Human-Readable Name). The tool_name is the internal identifier (snake_case, max 64 characters). The Human-Readable Name is what users see.
|
|
575
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
576
|
-
Reviewers test every single tool you list here — don't list tools that don't work. Also: do not have a single catch-all tool like api_request(method, endpoint) — Anthropic rejects these. Each action should be its own purpose-built tool.`),
|
|
577
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
578
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
579
|
-
• 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
|
|
580
|
-
This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
|
|
581
|
-
testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
|
|
582
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
583
|
-
• Format: SVG only
|
|
584
|
-
• Aspect ratio: square (1:1)
|
|
585
|
-
• Should work on a light background
|
|
586
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
587
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
588
|
-
logoDark: z.string().optional().describe(`Optional dark-mode variant of the connector logo. Same specs as the light variant (SVG, square 1:1) but designed to read on a dark background. Leave empty if the light logo already works on dark.`),
|
|
589
|
-
screenshots: z.array(screenshotEntrySchema).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
|
|
590
|
-
• 3–5 images is ideal
|
|
591
|
-
• Minimum 1000px width, PNG format preferred
|
|
592
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
593
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
594
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
595
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
596
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1041
|
+
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
|
|
1042
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1043
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1044
|
+
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
|
|
1045
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1046
|
+
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.
|
|
1047
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1048
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1049
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1050
|
+
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
|
|
1051
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1052
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1053
|
+
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
|
|
1054
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1055
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1056
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1057
|
+
by your publish date.`),
|
|
1058
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1059
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1060
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1061
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1062
|
+
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
|
|
1063
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1064
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1065
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1066
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1067
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1068
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1069
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1070
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1071
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1072
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1073
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1074
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1075
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1076
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1077
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1078
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1079
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1080
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1081
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1082
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1083
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1084
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1085
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1086
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1087
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1088
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1089
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1090
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1091
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1092
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1093
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1094
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1095
|
+
fully populated account.`),
|
|
1096
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1097
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1098
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1099
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1100
|
+
});
|
|
1101
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1102
|
+
serverUrl: z.string().optional(),
|
|
1103
|
+
name: z.string().optional(),
|
|
1104
|
+
slug: z.string().optional(),
|
|
1105
|
+
oneLiner: z.string().optional(),
|
|
1106
|
+
description: z.string().optional(),
|
|
1107
|
+
iconUrl: z.string().optional(),
|
|
1108
|
+
documentation: z.string().optional(),
|
|
1109
|
+
support: z.string().optional(),
|
|
1110
|
+
privacyPolicy: z.string().optional(),
|
|
1111
|
+
companyWebsite: z.string().optional(),
|
|
1112
|
+
primaryContactEmail: z.string().optional(),
|
|
1113
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1114
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
597
1115
|
});
|
|
598
1116
|
claudeSubmissionFormDataSchema.pick({
|
|
599
|
-
companyName: true,
|
|
600
|
-
appName: true,
|
|
601
|
-
mcpUrlType: true,
|
|
602
1117
|
serverUrl: true,
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
transportSupport: true,
|
|
1118
|
+
name: true,
|
|
1119
|
+
slug: true,
|
|
1120
|
+
companyName: true,
|
|
607
1121
|
primaryContactEmail: true,
|
|
608
1122
|
primaryContactName: true,
|
|
1123
|
+
readWriteCapabilities: true,
|
|
609
1124
|
authentication: true,
|
|
610
|
-
|
|
611
|
-
|
|
1125
|
+
apiOwnership: true,
|
|
1126
|
+
personalHealthData: true
|
|
612
1127
|
}).extend({
|
|
613
1128
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
614
|
-
|
|
1129
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1130
|
+
});
|
|
1131
|
+
/**
|
|
1132
|
+
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1133
|
+
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1134
|
+
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1135
|
+
* colocated with the Claude contract.
|
|
1136
|
+
*/
|
|
1137
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1138
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1139
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1140
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1141
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1142
|
+
});
|
|
1143
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1144
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1145
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
615
1146
|
});
|
|
616
|
-
claudeSubmissionFormDataSchema.pick({
|
|
617
|
-
tagline: true,
|
|
618
|
-
description: true,
|
|
619
|
-
category: true,
|
|
620
|
-
testCases: true
|
|
621
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
622
1147
|
const submissionMetaFieldsSchema = z.object({
|
|
623
1148
|
id: z.string(),
|
|
624
1149
|
environmentId: z.string(),
|
|
1150
|
+
auditId: z.string().nullable(),
|
|
625
1151
|
createdAt: z.coerce.date(),
|
|
626
1152
|
updatedAt: z.coerce.date()
|
|
627
1153
|
});
|
|
628
1154
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
629
1155
|
platform: z.literal("claudeai"),
|
|
630
|
-
formData:
|
|
1156
|
+
formData: claudeSubmissionDraftSchema
|
|
631
1157
|
});
|
|
632
1158
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
633
1159
|
platform: z.literal("chatgpt"),
|
|
634
|
-
formData:
|
|
1160
|
+
formData: chatgptSubmissionDraftSchema
|
|
635
1161
|
});
|
|
636
1162
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
637
|
-
z.union([
|
|
1163
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
638
1164
|
const subscriptionPlanSchema = z.enum([
|
|
639
1165
|
"pro",
|
|
640
1166
|
"business",
|
|
@@ -658,6 +1184,12 @@ z.object({
|
|
|
658
1184
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
659
1185
|
});
|
|
660
1186
|
//#endregion
|
|
1187
|
+
//#region src/auth-scope.ts
|
|
1188
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1189
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1190
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1191
|
+
const AUTH_SCOPE_USER = "user";
|
|
1192
|
+
//#endregion
|
|
661
1193
|
//#region src/schemas.ts
|
|
662
1194
|
const RESERVED_KEYS = [
|
|
663
1195
|
"_HANDLER",
|
|
@@ -797,7 +1329,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
797
1329
|
id: z.string(),
|
|
798
1330
|
name: z.string(),
|
|
799
1331
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
800
|
-
urls: z.array(z.
|
|
1332
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
801
1333
|
createdAt: z.coerce.date(),
|
|
802
1334
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
803
1335
|
}));
|
|
@@ -873,6 +1405,9 @@ const listProjectsContractV1 = oc.route({
|
|
|
873
1405
|
description: "List all projects for a team",
|
|
874
1406
|
tags: ["projects"],
|
|
875
1407
|
successDescription: "The list of projects"
|
|
1408
|
+
}).errors({
|
|
1409
|
+
NOT_FOUND: {},
|
|
1410
|
+
BAD_REQUEST: {}
|
|
876
1411
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
877
1412
|
const createProjectContractV1 = oc.route({
|
|
878
1413
|
path: "/v1/projects",
|
|
@@ -883,7 +1418,8 @@ const createProjectContractV1 = oc.route({
|
|
|
883
1418
|
successDescription: "The project has been created successfully"
|
|
884
1419
|
}).errors({
|
|
885
1420
|
NOT_FOUND: {},
|
|
886
|
-
BAD_REQUEST: {}
|
|
1421
|
+
BAD_REQUEST: {},
|
|
1422
|
+
FORBIDDEN: {}
|
|
887
1423
|
}).input(z.object({
|
|
888
1424
|
teamId: z.string().optional(),
|
|
889
1425
|
name: z.string().trim().min(1).max(100),
|
|
@@ -968,7 +1504,10 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
968
1504
|
description: "Delete an environment variable by ID",
|
|
969
1505
|
tags: ["environments"],
|
|
970
1506
|
successDescription: "The environment variable has been deleted successfully"
|
|
971
|
-
}).errors({
|
|
1507
|
+
}).errors({
|
|
1508
|
+
NOT_FOUND: {},
|
|
1509
|
+
BAD_REQUEST: {}
|
|
1510
|
+
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
972
1511
|
const deleteProjectContractV1 = oc.route({
|
|
973
1512
|
path: "/v1/projects/{projectId}",
|
|
974
1513
|
method: "DELETE",
|
|
@@ -986,7 +1525,8 @@ const updateProjectContractV1 = oc.route({
|
|
|
986
1525
|
successDescription: "The project has been updated successfully"
|
|
987
1526
|
}).errors({
|
|
988
1527
|
NOT_FOUND: {},
|
|
989
|
-
BAD_REQUEST: {}
|
|
1528
|
+
BAD_REQUEST: {},
|
|
1529
|
+
FORBIDDEN: {}
|
|
990
1530
|
}).input(z.object({
|
|
991
1531
|
projectId: z.string().describe("The ID of the project"),
|
|
992
1532
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
@@ -1004,7 +1544,8 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1004
1544
|
BAD_REQUEST: {}
|
|
1005
1545
|
}).input(z.object({
|
|
1006
1546
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1007
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1547
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1548
|
+
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1008
1549
|
})).output(deploymentSchema);
|
|
1009
1550
|
const uploadDeploymentArtifactContractV1 = oc.route({
|
|
1010
1551
|
path: "/v1/deployments/upload",
|
|
@@ -1013,6 +1554,9 @@ const uploadDeploymentArtifactContractV1 = oc.route({
|
|
|
1013
1554
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1014
1555
|
tags: ["deployments"],
|
|
1015
1556
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1557
|
+
}).errors({
|
|
1558
|
+
NOT_FOUND: {},
|
|
1559
|
+
BAD_REQUEST: {}
|
|
1016
1560
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1017
1561
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1018
1562
|
token: z.string().describe("Token to identify the source archive"),
|
|
@@ -1186,7 +1730,7 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1186
1730
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1187
1731
|
tags: ["tunnels"],
|
|
1188
1732
|
successDescription: "The tunnel ticket"
|
|
1189
|
-
}).output(z.object({
|
|
1733
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1190
1734
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1191
1735
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1192
1736
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
@@ -1262,7 +1806,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1262
1806
|
name: z.string().min(1).max(100).optional(),
|
|
1263
1807
|
description: z.string().min(1).max(500).optional(),
|
|
1264
1808
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1265
|
-
examplePrompts: z.array(playgroundExamplePromptSchema).max(
|
|
1809
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1266
1810
|
})).output(playgroundOutputSchema);
|
|
1267
1811
|
const createBeaconContractV1 = oc.route({
|
|
1268
1812
|
path: "/v1/beacon/audits",
|
|
@@ -1340,4 +1884,4 @@ const contract = {
|
|
|
1340
1884
|
}
|
|
1341
1885
|
};
|
|
1342
1886
|
//#endregion
|
|
1343
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1887
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|