@alpic-ai/api 0.0.0-staging.gbac42d9 → 0.0.0-staging.gc61d87f
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 +15 -6
- package/dist/index.mjs +588 -33
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -29,7 +29,7 @@ declare const createEnvironmentContractV1: _$_orpc_contract0.ContractProcedureBu
|
|
|
29
29
|
id: z.ZodString;
|
|
30
30
|
name: z.ZodString;
|
|
31
31
|
sourceBranch: z.ZodNullable<z.ZodString>;
|
|
32
|
-
urls: z.ZodArray<z.
|
|
32
|
+
urls: z.ZodArray<z.ZodURL>;
|
|
33
33
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
34
34
|
projectId: z.ZodString;
|
|
35
35
|
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
@@ -165,7 +165,10 @@ declare const contract: {
|
|
|
165
165
|
uploadUrl: z.ZodURL;
|
|
166
166
|
token: z.ZodString;
|
|
167
167
|
expiresAt: z.ZodCoercedDate<unknown>;
|
|
168
|
-
}, z.core.$strip>, Record<never, never>,
|
|
168
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
169
|
+
NOT_FOUND: {};
|
|
170
|
+
BAD_REQUEST: {};
|
|
171
|
+
}>, Record<never, never>>;
|
|
169
172
|
};
|
|
170
173
|
getLogs: {
|
|
171
174
|
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
@@ -196,7 +199,7 @@ declare const contract: {
|
|
|
196
199
|
id: z.ZodString;
|
|
197
200
|
name: z.ZodString;
|
|
198
201
|
sourceBranch: z.ZodNullable<z.ZodString>;
|
|
199
|
-
urls: z.ZodArray<z.
|
|
202
|
+
urls: z.ZodArray<z.ZodURL>;
|
|
200
203
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
201
204
|
projectId: z.ZodString;
|
|
202
205
|
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
@@ -212,7 +215,7 @@ declare const contract: {
|
|
|
212
215
|
name: z.ZodString;
|
|
213
216
|
sourceBranch: z.ZodNullable<z.ZodString>;
|
|
214
217
|
mcpServerUrl: z.ZodString;
|
|
215
|
-
domains: z.ZodArray<z.
|
|
218
|
+
domains: z.ZodArray<z.ZodCustomStringFormat<"hostname">>;
|
|
216
219
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
217
220
|
projectId: z.ZodString;
|
|
218
221
|
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
@@ -365,6 +368,7 @@ declare const contract: {
|
|
|
365
368
|
success: z.ZodLiteral<true>;
|
|
366
369
|
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
367
370
|
NOT_FOUND: {};
|
|
371
|
+
BAD_REQUEST: {};
|
|
368
372
|
}>, Record<never, never>>;
|
|
369
373
|
};
|
|
370
374
|
};
|
|
@@ -593,7 +597,10 @@ declare const contract: {
|
|
|
593
597
|
completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
|
|
594
598
|
}, z.core.$strip>>;
|
|
595
599
|
}, z.core.$strip>>;
|
|
596
|
-
}, z.core.$strip>>, Record<never, never>,
|
|
600
|
+
}, z.core.$strip>>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
601
|
+
NOT_FOUND: {};
|
|
602
|
+
BAD_REQUEST: {};
|
|
603
|
+
}>, Record<never, never>>;
|
|
597
604
|
};
|
|
598
605
|
create: {
|
|
599
606
|
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
@@ -737,7 +744,9 @@ declare const contract: {
|
|
|
737
744
|
subdomain: z.ZodString;
|
|
738
745
|
ticket: z.ZodString;
|
|
739
746
|
tunnelHost: z.ZodString;
|
|
740
|
-
}, z.core.$strip>, Record<never, never>,
|
|
747
|
+
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
748
|
+
FORBIDDEN: {};
|
|
749
|
+
}>, Record<never, never>>;
|
|
741
750
|
};
|
|
742
751
|
};
|
|
743
752
|
distribution: {
|
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_@cfworker+json-schema@4.1.1_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,7 +239,14 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
|
|
|
71
239
|
chatgpt: widgetScreenshotSchema.optional(),
|
|
72
240
|
claudeai: widgetScreenshotSchema.optional()
|
|
73
241
|
}) });
|
|
74
|
-
z.
|
|
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
|
+
});
|
|
249
|
+
const deploymentStatusSchema$1 = z.enum([
|
|
75
250
|
"ongoing",
|
|
76
251
|
"deployed",
|
|
77
252
|
"failed",
|
|
@@ -81,6 +256,119 @@ z.object({
|
|
|
81
256
|
timestamp: z.coerce.date().optional(),
|
|
82
257
|
content: z.string().optional()
|
|
83
258
|
});
|
|
259
|
+
const deploymentSummarySchema = z.object({
|
|
260
|
+
id: z.string(),
|
|
261
|
+
status: deploymentStatusSchema$1,
|
|
262
|
+
sourceBucket: z.string().nullable(),
|
|
263
|
+
sourceObjectKey: z.string().nullable(),
|
|
264
|
+
sourceRef: z.string().nullable(),
|
|
265
|
+
sourceCommitId: z.string().nullable(),
|
|
266
|
+
sourceCommitMessage: z.string().nullable(),
|
|
267
|
+
environmentId: z.string(),
|
|
268
|
+
authorUsername: z.string().nullable(),
|
|
269
|
+
authorAvatarUrl: z.string().nullable(),
|
|
270
|
+
startedAt: z.coerce.date().nullable(),
|
|
271
|
+
completedAt: z.coerce.date().nullable(),
|
|
272
|
+
isCurrent: z.boolean().optional(),
|
|
273
|
+
createdAt: z.coerce.date(),
|
|
274
|
+
updatedAt: z.coerce.date()
|
|
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
|
+
]);
|
|
344
|
+
const allowedPlatformSchema = platformSchema;
|
|
345
|
+
const environmentDomainSchema = z.object({
|
|
346
|
+
domain: z.string(),
|
|
347
|
+
status: z.enum([
|
|
348
|
+
"ongoing",
|
|
349
|
+
"deployed",
|
|
350
|
+
"failed"
|
|
351
|
+
]),
|
|
352
|
+
createdAt: z.coerce.date(),
|
|
353
|
+
updatedAt: z.coerce.date()
|
|
354
|
+
});
|
|
355
|
+
const environmentSchema$1 = z.object({
|
|
356
|
+
id: z.string(),
|
|
357
|
+
name: z.string(),
|
|
358
|
+
sourceBranch: z.string().nullable(),
|
|
359
|
+
mcpServerUrl: z.string(),
|
|
360
|
+
activeDeployment: deploymentSummarySchema.optional(),
|
|
361
|
+
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
|
+
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
|
+
isPlaygroundEnabled: z.boolean(),
|
|
364
|
+
isIpWhitelistEnabled: z.boolean(),
|
|
365
|
+
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
|
+
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
367
|
+
projectId: z.string(),
|
|
368
|
+
createdAt: z.coerce.date(),
|
|
369
|
+
updatedAt: z.coerce.date()
|
|
370
|
+
});
|
|
371
|
+
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
84
372
|
z.object({
|
|
85
373
|
id: z.string(),
|
|
86
374
|
createdAt: z.coerce.date(),
|
|
@@ -92,6 +380,86 @@ z.object({
|
|
|
92
380
|
content: z.string(),
|
|
93
381
|
source: z.enum(["model", "user"])
|
|
94
382
|
});
|
|
383
|
+
const intentCategoryColorSchema = z.enum([
|
|
384
|
+
"red",
|
|
385
|
+
"orange",
|
|
386
|
+
"yellow",
|
|
387
|
+
"green",
|
|
388
|
+
"blue",
|
|
389
|
+
"purple",
|
|
390
|
+
"pink",
|
|
391
|
+
"gray"
|
|
392
|
+
]);
|
|
393
|
+
intentCategoryColorSchema.options;
|
|
394
|
+
const intentCategorySchema = z.object({
|
|
395
|
+
id: z.string(),
|
|
396
|
+
createdAt: z.coerce.date(),
|
|
397
|
+
environmentId: z.string(),
|
|
398
|
+
name: z.string(),
|
|
399
|
+
color: intentCategoryColorSchema
|
|
400
|
+
});
|
|
401
|
+
z.object({
|
|
402
|
+
id: z.string(),
|
|
403
|
+
name: z.string(),
|
|
404
|
+
color: intentCategoryColorSchema,
|
|
405
|
+
intentCount: z.number().int().nonnegative()
|
|
406
|
+
});
|
|
407
|
+
z.object({
|
|
408
|
+
id: z.string(),
|
|
409
|
+
createdAt: z.coerce.date(),
|
|
410
|
+
environmentId: z.string(),
|
|
411
|
+
toolName: z.string(),
|
|
412
|
+
message: z.string(),
|
|
413
|
+
categories: z.array(intentCategorySchema)
|
|
414
|
+
});
|
|
415
|
+
const signalCategorySchema = z.object({
|
|
416
|
+
id: z.string(),
|
|
417
|
+
name: z.string(),
|
|
418
|
+
color: intentCategoryColorSchema
|
|
419
|
+
});
|
|
420
|
+
z.discriminatedUnion("kind", [
|
|
421
|
+
z.object({
|
|
422
|
+
kind: z.literal("new"),
|
|
423
|
+
category: signalCategorySchema,
|
|
424
|
+
currentCount: z.number().int().nonnegative(),
|
|
425
|
+
currentShare: z.number()
|
|
426
|
+
}),
|
|
427
|
+
z.object({
|
|
428
|
+
kind: z.literal("resurging"),
|
|
429
|
+
category: signalCategorySchema,
|
|
430
|
+
currentCount: z.number().int().nonnegative(),
|
|
431
|
+
daysQuiet: z.number(),
|
|
432
|
+
currentShare: z.number()
|
|
433
|
+
}),
|
|
434
|
+
z.object({
|
|
435
|
+
kind: z.literal("spike"),
|
|
436
|
+
category: signalCategorySchema,
|
|
437
|
+
currentCount: z.number().int().nonnegative(),
|
|
438
|
+
previousCount: z.number().int().nonnegative(),
|
|
439
|
+
currentShare: z.number(),
|
|
440
|
+
previousShare: z.number(),
|
|
441
|
+
changeRatio: z.number()
|
|
442
|
+
}),
|
|
443
|
+
z.object({
|
|
444
|
+
kind: z.literal("declining"),
|
|
445
|
+
category: signalCategorySchema,
|
|
446
|
+
currentCount: z.number().int().nonnegative(),
|
|
447
|
+
previousCount: z.number().int().nonnegative(),
|
|
448
|
+
currentShare: z.number(),
|
|
449
|
+
previousShare: z.number(),
|
|
450
|
+
changeRatio: z.number()
|
|
451
|
+
})
|
|
452
|
+
]);
|
|
453
|
+
z.discriminatedUnion("kind", [z.object({
|
|
454
|
+
kind: z.literal("existing"),
|
|
455
|
+
categoryId: z.string(),
|
|
456
|
+
categoryName: z.string(),
|
|
457
|
+
intentIds: z.array(z.string())
|
|
458
|
+
}), z.object({
|
|
459
|
+
kind: z.literal("new"),
|
|
460
|
+
categoryName: z.string(),
|
|
461
|
+
intentIds: z.array(z.string())
|
|
462
|
+
})]);
|
|
95
463
|
z.object({
|
|
96
464
|
id: z.string(),
|
|
97
465
|
teamId: z.string(),
|
|
@@ -117,6 +485,76 @@ const transportSchema = z.enum([
|
|
|
117
485
|
"sse",
|
|
118
486
|
"streamablehttp"
|
|
119
487
|
]);
|
|
488
|
+
z.object({
|
|
489
|
+
id: z.string(),
|
|
490
|
+
name: z.string(),
|
|
491
|
+
teamId: z.string(),
|
|
492
|
+
sourceRepository: z.string().nullable(),
|
|
493
|
+
createdAt: z.coerce.date().optional(),
|
|
494
|
+
runtime: runtimeSchema,
|
|
495
|
+
transport: transportSchema.nullable(),
|
|
496
|
+
rootDirectory: z.string().nullable(),
|
|
497
|
+
installCommand: z.string().nullable(),
|
|
498
|
+
buildCommand: z.string().nullable(),
|
|
499
|
+
buildOutputDir: z.string().nullable(),
|
|
500
|
+
startCommand: z.string().nullable(),
|
|
501
|
+
fixedOutboundIp: z.boolean(),
|
|
502
|
+
environments: z.array(environmentWithDomainsSchema),
|
|
503
|
+
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
504
|
+
});
|
|
505
|
+
z.object({
|
|
506
|
+
domain: z.string(),
|
|
507
|
+
createdAt: z.coerce.date(),
|
|
508
|
+
status: z.enum([
|
|
509
|
+
"ongoing",
|
|
510
|
+
"deployed",
|
|
511
|
+
"failed"
|
|
512
|
+
]),
|
|
513
|
+
environment: environmentSchema$1
|
|
514
|
+
});
|
|
515
|
+
const serverFieldsSchema$1 = z.object({
|
|
516
|
+
$schema: z.string(),
|
|
517
|
+
name: z.string(),
|
|
518
|
+
description: z.string(),
|
|
519
|
+
version: z.string().optional(),
|
|
520
|
+
title: z.string().optional(),
|
|
521
|
+
websiteUrl: z.string().optional(),
|
|
522
|
+
icons: z.array(z.object({
|
|
523
|
+
src: z.string(),
|
|
524
|
+
mimeType: z.string().optional(),
|
|
525
|
+
sizes: z.array(z.string()).optional()
|
|
526
|
+
})).optional(),
|
|
527
|
+
remotes: z.array(z.object({
|
|
528
|
+
type: z.string(),
|
|
529
|
+
url: z.string().optional(),
|
|
530
|
+
headers: z.array(z.object({
|
|
531
|
+
name: z.string(),
|
|
532
|
+
description: z.string(),
|
|
533
|
+
isRequired: z.boolean().optional(),
|
|
534
|
+
isSecret: z.boolean().optional()
|
|
535
|
+
})).optional()
|
|
536
|
+
})).optional()
|
|
537
|
+
}).catchall(z.unknown());
|
|
538
|
+
z.object({
|
|
539
|
+
serverFields: serverFieldsSchema$1,
|
|
540
|
+
source: z.enum(["registry", "defaults"])
|
|
541
|
+
});
|
|
542
|
+
/**
|
|
543
|
+
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
544
|
+
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
545
|
+
*
|
|
546
|
+
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
547
|
+
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
548
|
+
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
549
|
+
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
550
|
+
*/
|
|
551
|
+
const clampStringField = (field) => {
|
|
552
|
+
const max = field.maxLength;
|
|
553
|
+
if (max === null) return field;
|
|
554
|
+
const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
|
|
555
|
+
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
556
|
+
return field.description ? withMin.describe(field.description) : withMin;
|
|
557
|
+
};
|
|
120
558
|
const toolDefinitionSchema = z.object({
|
|
121
559
|
name: z.string(),
|
|
122
560
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -134,6 +572,10 @@ const positiveTestCaseSchema = z.object({
|
|
|
134
572
|
toolTriggered: z.string().optional(),
|
|
135
573
|
expectedOutput: z.string().optional()
|
|
136
574
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
575
|
+
const screenshotEntrySchema = z.object({
|
|
576
|
+
prompt: z.string(),
|
|
577
|
+
url: z.url().or(z.literal(""))
|
|
578
|
+
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
137
579
|
/** Accepts either a valid email or URL. */
|
|
138
580
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
139
581
|
const chatgptCategorySchema = z.enum([
|
|
@@ -153,6 +595,71 @@ const chatgptCategorySchema = z.enum([
|
|
|
153
595
|
]);
|
|
154
596
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
155
597
|
const chatgptAllowedCountriesSchema = z.enum(["Allow all", "Restrict to specific countries"]);
|
|
598
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
599
|
+
"am",
|
|
600
|
+
"ar",
|
|
601
|
+
"bg-BG",
|
|
602
|
+
"bn-BD",
|
|
603
|
+
"bs-BA",
|
|
604
|
+
"ca-ES",
|
|
605
|
+
"cs-CZ",
|
|
606
|
+
"da-DK",
|
|
607
|
+
"de-DE",
|
|
608
|
+
"el-GR",
|
|
609
|
+
"es-419",
|
|
610
|
+
"es-ES",
|
|
611
|
+
"et-EE",
|
|
612
|
+
"fi-FI",
|
|
613
|
+
"fr-CA",
|
|
614
|
+
"fr-FR",
|
|
615
|
+
"gu-IN",
|
|
616
|
+
"hi-IN",
|
|
617
|
+
"hr-HR",
|
|
618
|
+
"hu-HU",
|
|
619
|
+
"hy-AM",
|
|
620
|
+
"id-ID",
|
|
621
|
+
"is-IS",
|
|
622
|
+
"it-IT",
|
|
623
|
+
"ja-JP",
|
|
624
|
+
"ka-GE",
|
|
625
|
+
"kk",
|
|
626
|
+
"kn-IN",
|
|
627
|
+
"ko-KR",
|
|
628
|
+
"lt",
|
|
629
|
+
"lv-LV",
|
|
630
|
+
"mk-MK",
|
|
631
|
+
"ml",
|
|
632
|
+
"mn",
|
|
633
|
+
"mr-IN",
|
|
634
|
+
"ms-MY",
|
|
635
|
+
"my-MM",
|
|
636
|
+
"nb-NO",
|
|
637
|
+
"nl-NL",
|
|
638
|
+
"pa",
|
|
639
|
+
"pl-PL",
|
|
640
|
+
"pt-BR",
|
|
641
|
+
"pt-PT",
|
|
642
|
+
"ro-RO",
|
|
643
|
+
"ru-RU",
|
|
644
|
+
"sk-SK",
|
|
645
|
+
"sl-SI",
|
|
646
|
+
"so-SO",
|
|
647
|
+
"sq-AL",
|
|
648
|
+
"sr-RS",
|
|
649
|
+
"sv-SE",
|
|
650
|
+
"sw-TZ",
|
|
651
|
+
"ta-IN",
|
|
652
|
+
"te-IN",
|
|
653
|
+
"th-TH",
|
|
654
|
+
"tl",
|
|
655
|
+
"tr-TR",
|
|
656
|
+
"uk-UA",
|
|
657
|
+
"ur",
|
|
658
|
+
"vi-VN",
|
|
659
|
+
"zh-CN",
|
|
660
|
+
"zh-HK",
|
|
661
|
+
"zh-TW"
|
|
662
|
+
]);
|
|
156
663
|
const negativeTestCaseSchema = z.object({
|
|
157
664
|
scenario: z.string(),
|
|
158
665
|
userPrompt: z.string()
|
|
@@ -163,21 +670,29 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
163
670
|
openWorldJustification: z.string(),
|
|
164
671
|
destructiveJustification: z.string()
|
|
165
672
|
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
673
|
+
/**
|
|
674
|
+
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
675
|
+
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
676
|
+
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
677
|
+
*/
|
|
678
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
679
|
+
const chatgptDescriptionSchema = z.string();
|
|
166
680
|
const chatgptTranslationSchema = z.object({
|
|
167
|
-
locale:
|
|
168
|
-
tagline:
|
|
169
|
-
description:
|
|
681
|
+
locale: chatgptTranslationLocaleSchema,
|
|
682
|
+
tagline: chatgptTaglineSchema,
|
|
683
|
+
description: chatgptDescriptionSchema
|
|
170
684
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
685
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
171
686
|
/**
|
|
172
687
|
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
173
688
|
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
174
689
|
*/
|
|
175
690
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
176
691
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
177
|
-
logoDark: z.string().describe("
|
|
692
|
+
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
178
693
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
179
|
-
tagline:
|
|
180
|
-
description:
|
|
694
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value. 30 chars max."),
|
|
695
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
|
|
181
696
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
182
697
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
183
698
|
companyUrl: z.url().describe("Your company's main website URL."),
|
|
@@ -192,7 +707,7 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
192
707
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
193
708
|
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Coverage over all major use cases."),
|
|
194
709
|
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
|
|
195
|
-
screenshots: z.array(
|
|
710
|
+
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 4 entries. First three are public. Images: 706px wide, 400–860px tall, PNG."),
|
|
196
711
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
197
712
|
allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
|
|
198
713
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
@@ -211,7 +726,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
211
726
|
testCases: true,
|
|
212
727
|
negativeTestCases: true,
|
|
213
728
|
toolJustifications: true
|
|
214
|
-
});
|
|
729
|
+
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
215
730
|
const claudeCategorySchema = z.enum([
|
|
216
731
|
"Business & Productivity",
|
|
217
732
|
"Communication",
|
|
@@ -223,7 +738,7 @@ const claudeCategorySchema = z.enum([
|
|
|
223
738
|
"Media & Entertainment",
|
|
224
739
|
"Commerce & Shopping"
|
|
225
740
|
]);
|
|
226
|
-
z.enum([
|
|
741
|
+
const claudeAuthenticationSchema = z.enum([
|
|
227
742
|
"No auth needed",
|
|
228
743
|
"OAuth 2.0",
|
|
229
744
|
"Custom URL"
|
|
@@ -231,28 +746,34 @@ z.enum([
|
|
|
231
746
|
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
232
747
|
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
233
748
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
234
|
-
"Read
|
|
235
|
-
"Write
|
|
236
|
-
"Read +
|
|
749
|
+
"Read Only",
|
|
750
|
+
"Write Only",
|
|
751
|
+
"Read + Write"
|
|
237
752
|
]);
|
|
238
753
|
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
754
|
+
const claudeTestedSurfaceSchema = z.enum([
|
|
755
|
+
"Claude.ai (web)",
|
|
756
|
+
"Claude Desktop",
|
|
757
|
+
"Claude Code",
|
|
758
|
+
"Cowork"
|
|
759
|
+
]);
|
|
239
760
|
const claudeThirdPartySchema = z.enum([
|
|
240
|
-
"Web access
|
|
241
|
-
"Third-party AI model integration",
|
|
242
|
-
"Third-party data retrieval (
|
|
243
|
-
"Third-party data modification (
|
|
761
|
+
"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)",
|
|
762
|
+
"Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
|
|
763
|
+
"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)",
|
|
764
|
+
"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)",
|
|
244
765
|
"N/A"
|
|
245
766
|
]);
|
|
246
767
|
const claudeDataHandlingSchema = z.enum([
|
|
247
768
|
"Server only accesses data explicitly requested by user",
|
|
248
769
|
"No data is stored beyond session requirements",
|
|
249
|
-
"Data transmission is encrypted (HTTPS
|
|
770
|
+
"Data transmission is encrypted (HTTPS/TLS)",
|
|
250
771
|
"GDPR compliant (if applicable)"
|
|
251
772
|
]);
|
|
252
773
|
const claudeSponsoredContentSchema = z.enum([
|
|
253
774
|
"No, there is no sponsored content or advertisements",
|
|
254
775
|
"Yes, there are banner ads or other paid visual elements",
|
|
255
|
-
"Yes, returned content or ranking is impacted by sponsorship or ad placement"
|
|
776
|
+
"Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement"
|
|
256
777
|
]);
|
|
257
778
|
/**
|
|
258
779
|
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
@@ -317,7 +838,7 @@ If 'Yes', you will also be required to provide screenshots of your UI (see Promo
|
|
|
317
838
|
Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
|
|
318
839
|
personalDataHealthAccess: z.boolean().describe(`Select 'Yes' ONLY if your connector gives users access to their own personal health information — such as medical records, lab results, diagnoses, prescriptions, wearable health metrics (heart rate, sleep data, etc.), or mental health data.
|
|
319
840
|
Select 'No' for the vast majority of business/productivity/dev tools. When in doubt, select 'No'. This field triggers additional compliance review if 'Yes'.`),
|
|
320
|
-
|
|
841
|
+
category: claudeCategorySchema.describe(`Select the category that best describes your connector. This determines where it appears in the directory's browse experience. Choose the most specific fit:
|
|
321
842
|
• Business & Productivity — project management, CRM, HR, office tools
|
|
322
843
|
• Communication — email, chat, messaging, notifications
|
|
323
844
|
• Data & Analytics — dashboards, reporting, databases, BI tools
|
|
@@ -327,12 +848,13 @@ Select 'No' for the vast majority of business/productivity/dev tools. When in do
|
|
|
327
848
|
• Health & Life Sciences — clinical, pharma, medical professional tools
|
|
328
849
|
• Media & Entertainment — content, publishing, streaming
|
|
329
850
|
• Commerce & Shopping — e-commerce, inventory, orders
|
|
330
|
-
|
|
851
|
+
Anthropic's submission form only accepts a single category.`),
|
|
331
852
|
sponsoredContentsOrAdvertisement: claudeSponsoredContentSchema.describe(`Be honest here — advertising is not permitted in the Connectors Directory per Anthropic's policy. Select the option that accurately describes your server:
|
|
332
853
|
• 'No, there is no sponsored content or advertisements' — the results your server returns are not influenced by paid placement or sponsorship. This is what almost all connectors should select.
|
|
333
854
|
• 'Yes, there are banner ads or other paid visual elements' — your UI includes visual ads. NOTE: this will likely lead to rejection, as Anthropic prohibits advertising in Claude.
|
|
334
855
|
• 'Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement' — paid results affect what you return. NOTE: this also likely leads to rejection.
|
|
335
856
|
If your server returns organic results from a platform that has ads in its own UI (but your API results are not affected by ads), select 'No'.`),
|
|
857
|
+
authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
|
|
336
858
|
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
337
859
|
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
338
860
|
• '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.
|
|
@@ -372,19 +894,21 @@ Reviewers test every single tool you list here — don't list tools that don't w
|
|
|
372
894
|
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
373
895
|
• 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
|
|
374
896
|
This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
|
|
375
|
-
|
|
897
|
+
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.`),
|
|
898
|
+
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
376
899
|
• Format: SVG only
|
|
377
900
|
• Aspect ratio: square (1:1)
|
|
378
|
-
• Should work on
|
|
901
|
+
• Should work on a light background
|
|
379
902
|
• Provide via URL (Google Drive link is fine) or upload directly
|
|
380
903
|
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
381
|
-
|
|
904
|
+
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.`),
|
|
905
|
+
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:
|
|
382
906
|
• 3–5 images is ideal
|
|
383
907
|
• Minimum 1000px width, PNG format preferred
|
|
908
|
+
• Each screenshot is paired with the user prompt that produced it
|
|
384
909
|
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
385
910
|
• Show your connector doing something impressive and useful — real data, real results
|
|
386
911
|
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
387
|
-
• Videos are also welcome
|
|
388
912
|
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
389
913
|
});
|
|
390
914
|
claudeSubmissionFormDataSchema.pick({
|
|
@@ -397,14 +921,20 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
397
921
|
isMcpApp: true,
|
|
398
922
|
transportSupport: true,
|
|
399
923
|
primaryContactEmail: true,
|
|
400
|
-
primaryContactName: true
|
|
924
|
+
primaryContactName: true,
|
|
925
|
+
authentication: true,
|
|
926
|
+
personalDataHealthAccess: true,
|
|
927
|
+
testedSurfaces: true
|
|
928
|
+
}).extend({
|
|
929
|
+
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
930
|
+
testingCredentials: claudeSubmissionFormDataSchema.shape.testingCredentials.optional()
|
|
401
931
|
});
|
|
402
932
|
claudeSubmissionFormDataSchema.pick({
|
|
403
933
|
tagline: true,
|
|
404
934
|
description: true,
|
|
405
|
-
|
|
935
|
+
category: true,
|
|
406
936
|
testCases: true
|
|
407
|
-
});
|
|
937
|
+
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
408
938
|
const submissionMetaFieldsSchema = z.object({
|
|
409
939
|
id: z.string(),
|
|
410
940
|
environmentId: z.string(),
|
|
@@ -427,6 +957,22 @@ const subscriptionPlanSchema = z.enum([
|
|
|
427
957
|
"enterprise"
|
|
428
958
|
]);
|
|
429
959
|
z.object({ plan: subscriptionPlanSchema.nullable() });
|
|
960
|
+
const customerCreditsSchema = z.object({
|
|
961
|
+
balanceInCents: z.number(),
|
|
962
|
+
expiresAt: z.number().nullable(),
|
|
963
|
+
currency: z.string()
|
|
964
|
+
});
|
|
965
|
+
const customerUsageSchema = z.object({
|
|
966
|
+
amountInCents: z.number(),
|
|
967
|
+
currency: z.string(),
|
|
968
|
+
periodEnd: z.number()
|
|
969
|
+
});
|
|
970
|
+
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
971
|
+
z.object({
|
|
972
|
+
customerCredits: customerCreditsSchema.nullable(),
|
|
973
|
+
customerUsage: customerUsageSchema.nullable(),
|
|
974
|
+
partnerDiscount: partnerDiscountSchema.nullable()
|
|
975
|
+
});
|
|
430
976
|
//#endregion
|
|
431
977
|
//#region src/schemas.ts
|
|
432
978
|
const RESERVED_KEYS = [
|
|
@@ -567,7 +1113,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
567
1113
|
id: z.string(),
|
|
568
1114
|
name: z.string(),
|
|
569
1115
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
570
|
-
urls: z.array(z.
|
|
1116
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
571
1117
|
createdAt: z.coerce.date(),
|
|
572
1118
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
573
1119
|
}));
|
|
@@ -583,7 +1129,7 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
583
1129
|
name: z.string(),
|
|
584
1130
|
sourceBranch: z.string().nullable(),
|
|
585
1131
|
mcpServerUrl: z.string(),
|
|
586
|
-
domains: z.array(z.
|
|
1132
|
+
domains: z.array(z.hostname()),
|
|
587
1133
|
createdAt: z.coerce.date(),
|
|
588
1134
|
projectId: z.string()
|
|
589
1135
|
}));
|
|
@@ -643,6 +1189,9 @@ const listProjectsContractV1 = oc.route({
|
|
|
643
1189
|
description: "List all projects for a team",
|
|
644
1190
|
tags: ["projects"],
|
|
645
1191
|
successDescription: "The list of projects"
|
|
1192
|
+
}).errors({
|
|
1193
|
+
NOT_FOUND: {},
|
|
1194
|
+
BAD_REQUEST: {}
|
|
646
1195
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
647
1196
|
const createProjectContractV1 = oc.route({
|
|
648
1197
|
path: "/v1/projects",
|
|
@@ -738,7 +1287,10 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
738
1287
|
description: "Delete an environment variable by ID",
|
|
739
1288
|
tags: ["environments"],
|
|
740
1289
|
successDescription: "The environment variable has been deleted successfully"
|
|
741
|
-
}).errors({
|
|
1290
|
+
}).errors({
|
|
1291
|
+
NOT_FOUND: {},
|
|
1292
|
+
BAD_REQUEST: {}
|
|
1293
|
+
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
742
1294
|
const deleteProjectContractV1 = oc.route({
|
|
743
1295
|
path: "/v1/projects/{projectId}",
|
|
744
1296
|
method: "DELETE",
|
|
@@ -783,6 +1335,9 @@ const uploadDeploymentArtifactContractV1 = oc.route({
|
|
|
783
1335
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
784
1336
|
tags: ["deployments"],
|
|
785
1337
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1338
|
+
}).errors({
|
|
1339
|
+
NOT_FOUND: {},
|
|
1340
|
+
BAD_REQUEST: {}
|
|
786
1341
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
787
1342
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
788
1343
|
token: z.string().describe("Token to identify the source archive"),
|
|
@@ -956,7 +1511,7 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
956
1511
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
957
1512
|
tags: ["tunnels"],
|
|
958
1513
|
successDescription: "The tunnel ticket"
|
|
959
|
-
}).output(z.object({
|
|
1514
|
+
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
960
1515
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
961
1516
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
962
1517
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
@@ -1032,7 +1587,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1032
1587
|
name: z.string().min(1).max(100).optional(),
|
|
1033
1588
|
description: z.string().min(1).max(500).optional(),
|
|
1034
1589
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1035
|
-
examplePrompts: z.array(playgroundExamplePromptSchema).max(
|
|
1590
|
+
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1036
1591
|
})).output(playgroundOutputSchema);
|
|
1037
1592
|
const createBeaconContractV1 = oc.route({
|
|
1038
1593
|
path: "/v1/beacon/audits",
|