@alpic-ai/api 0.0.0-dev.gf3c5c61 → 0.0.0-dev.gf480db6
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 +928 -2
- package/dist/index.mjs +275 -292
- package/package.json +23 -7
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -169,11 +169,21 @@ z$1.object({
|
|
|
169
169
|
token: z$1.string(),
|
|
170
170
|
token_type_hint: z$1.string().optional()
|
|
171
171
|
}).strip();
|
|
172
|
-
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
173
176
|
const PLATFORM_LABELS = {
|
|
174
177
|
chatgpt: "ChatGPT",
|
|
175
178
|
claudeai: "Claude.ai"
|
|
176
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cloudflare",
|
|
183
|
+
"fastly"
|
|
184
|
+
];
|
|
185
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
186
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
187
|
const auditStatusSchema = z.enum([
|
|
178
188
|
"pending",
|
|
179
189
|
"partial",
|
|
@@ -273,34 +283,51 @@ const deploymentSummarySchema = z.object({
|
|
|
273
283
|
createdAt: z.coerce.date(),
|
|
274
284
|
updatedAt: z.coerce.date()
|
|
275
285
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
286
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
287
|
const publicEnvironmentSchema = z.object({
|
|
288
|
+
allowsAnonymous: z.literal(true),
|
|
289
|
+
oAuthMetadata: z.strictObject({})
|
|
290
|
+
});
|
|
291
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
292
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
293
|
+
allowsAnonymous: z.boolean(),
|
|
294
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
295
|
+
scope: z.string().optional()
|
|
296
|
+
});
|
|
297
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
298
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
299
|
+
allowsAnonymous: z.boolean(),
|
|
300
|
+
oAuthMetadata: z.object({
|
|
301
|
+
externalAuthorizationServerUrl: z.url(),
|
|
302
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
303
|
+
}),
|
|
304
|
+
scope: z.string().optional()
|
|
305
|
+
});
|
|
306
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
307
|
+
const standaloneEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.boolean(),
|
|
309
|
+
oAuthMetadata: z.object({
|
|
310
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
311
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
312
|
+
}),
|
|
313
|
+
scope: z.string().optional()
|
|
314
|
+
});
|
|
315
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
316
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
317
|
+
allowsAnonymous: z.literal(false),
|
|
318
|
+
oAuthMetadata: z.strictObject({}),
|
|
319
|
+
scope: z.string().optional()
|
|
320
|
+
});
|
|
321
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
322
|
isPublic: z.literal(true),
|
|
283
323
|
oAuthMetadata: z.undefined().optional()
|
|
284
324
|
});
|
|
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({
|
|
325
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
326
|
isPublic: z.literal(false),
|
|
293
327
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
328
|
scope: z.string().optional()
|
|
295
329
|
});
|
|
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({
|
|
330
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
331
|
isPublic: z.literal(false),
|
|
305
332
|
oAuthMetadata: z.object({
|
|
306
333
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +335,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
335
|
}),
|
|
309
336
|
scope: z.string().optional()
|
|
310
337
|
});
|
|
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({
|
|
338
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
339
|
isPublic: z.literal(false),
|
|
319
340
|
oAuthMetadata: z.object({
|
|
320
341
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +343,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
343
|
}),
|
|
323
344
|
scope: z.string().optional()
|
|
324
345
|
});
|
|
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({
|
|
346
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
347
|
isPublic: z.literal(false),
|
|
334
348
|
oAuthMetadata: z.strictObject({}),
|
|
335
349
|
scope: z.string().optional()
|
|
@@ -339,11 +353,21 @@ z.union([
|
|
|
339
353
|
externalResourceMetadataEnvironmentSchema,
|
|
340
354
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
355
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
356
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
357
|
+
legacyPublicEnvironmentSchema,
|
|
358
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
359
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
360
|
+
legacyStandaloneEnvironmentSchema,
|
|
361
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
362
|
+
]);
|
|
363
|
+
const playgroundModelSchema = z.enum([
|
|
364
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
365
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
366
|
+
"openai.gpt-5.4",
|
|
367
|
+
"openai.gpt-5.5"
|
|
343
368
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
369
|
const environmentDomainSchema = z.object({
|
|
346
|
-
|
|
370
|
+
name: z.string(),
|
|
347
371
|
status: z.enum([
|
|
348
372
|
"ongoing",
|
|
349
373
|
"deployed",
|
|
@@ -361,6 +385,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
385
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
386
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
387
|
isPlaygroundEnabled: z.boolean(),
|
|
388
|
+
playgroundModel: playgroundModelSchema,
|
|
364
389
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
390
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
391
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -373,7 +398,9 @@ z.object({
|
|
|
373
398
|
sessionReplayEnabled: z.boolean(),
|
|
374
399
|
collectRequestPayload: z.boolean(),
|
|
375
400
|
collectResponsePayload: z.boolean(),
|
|
376
|
-
collectErrorMessage: z.boolean()
|
|
401
|
+
collectErrorMessage: z.boolean(),
|
|
402
|
+
collectUserData: z.boolean(),
|
|
403
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
377
404
|
});
|
|
378
405
|
z.object({
|
|
379
406
|
id: z.string(),
|
|
@@ -508,15 +535,27 @@ z.object({
|
|
|
508
535
|
environments: z.array(environmentWithDomainsSchema),
|
|
509
536
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
510
537
|
});
|
|
538
|
+
const domainFailureReasonSchema = z.enum([
|
|
539
|
+
"caa",
|
|
540
|
+
"dns",
|
|
541
|
+
"invalid_domain",
|
|
542
|
+
"other"
|
|
543
|
+
]);
|
|
544
|
+
const projectDomainMappingSchema = z.object({
|
|
545
|
+
pathPrefix: z.string(),
|
|
546
|
+
environment: environmentSchema$1
|
|
547
|
+
});
|
|
511
548
|
z.object({
|
|
512
|
-
|
|
549
|
+
name: z.string(),
|
|
513
550
|
createdAt: z.coerce.date(),
|
|
514
551
|
status: z.enum([
|
|
515
552
|
"ongoing",
|
|
516
553
|
"deployed",
|
|
517
554
|
"failed"
|
|
518
555
|
]),
|
|
519
|
-
|
|
556
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
557
|
+
environment: environmentSchema$1,
|
|
558
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
520
559
|
});
|
|
521
560
|
const serverFieldsSchema$1 = z.object({
|
|
522
561
|
$schema: z.string(),
|
|
@@ -545,15 +584,7 @@ z.object({
|
|
|
545
584
|
serverFields: serverFieldsSchema$1,
|
|
546
585
|
source: z.enum(["registry", "defaults"])
|
|
547
586
|
});
|
|
548
|
-
/**
|
|
549
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
550
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
551
|
-
*
|
|
552
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
553
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
554
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
555
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
556
|
-
*/
|
|
587
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
557
588
|
const clampStringField = (field) => {
|
|
558
589
|
const max = field.maxLength;
|
|
559
590
|
if (max === null) return field;
|
|
@@ -580,10 +611,13 @@ const positiveTestCaseSchema = z.object({
|
|
|
580
611
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
581
612
|
const screenshotEntrySchema = z.object({
|
|
582
613
|
prompt: z.string(),
|
|
583
|
-
url: z.url()
|
|
614
|
+
url: z.url()
|
|
584
615
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
616
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
585
617
|
/** Accepts either a valid email or URL. */
|
|
586
618
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
619
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
620
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
587
621
|
const chatgptCategorySchema = z.enum([
|
|
588
622
|
"BUSINESS",
|
|
589
623
|
"COLLABORATION",
|
|
@@ -896,11 +930,7 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
896
930
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
897
931
|
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.\"")
|
|
898
932
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
899
|
-
/**
|
|
900
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
901
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
902
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
903
|
-
*/
|
|
933
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
904
934
|
const chatgptTaglineSchema = z.string().max(30);
|
|
905
935
|
const chatgptDescriptionSchema = z.string();
|
|
906
936
|
const chatgptTranslationSchema = z.object({
|
|
@@ -909,10 +939,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
909
939
|
description: chatgptDescriptionSchema
|
|
910
940
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
911
941
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
912
|
-
/**
|
|
913
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
914
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
915
|
-
*/
|
|
942
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
916
943
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
917
944
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
918
945
|
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."),
|
|
@@ -921,23 +948,34 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
921
948
|
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)."),
|
|
922
949
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
923
950
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
924
|
-
companyUrl:
|
|
951
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
925
952
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
926
|
-
privacyPolicyUrl:
|
|
927
|
-
termsOfServiceUrl:
|
|
928
|
-
demoRecordingUrl:
|
|
953
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
954
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
955
|
+
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."),
|
|
929
956
|
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."),
|
|
930
|
-
serverUrl:
|
|
957
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
931
958
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
932
959
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
933
960
|
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."),
|
|
934
961
|
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."),
|
|
935
962
|
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."),
|
|
936
|
-
screenshots: z.array(screenshotEntrySchema).max(3).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 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
963
|
+
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."),
|
|
937
964
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
938
965
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
939
966
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
940
967
|
});
|
|
968
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
969
|
+
tagline: z.string().optional(),
|
|
970
|
+
companyUrl: z.string().optional(),
|
|
971
|
+
supportChannel: z.string().optional(),
|
|
972
|
+
privacyPolicyUrl: z.string().optional(),
|
|
973
|
+
termsOfServiceUrl: z.string().optional(),
|
|
974
|
+
demoRecordingUrl: z.string().optional(),
|
|
975
|
+
serverUrl: z.string().optional(),
|
|
976
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
977
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
978
|
+
});
|
|
941
979
|
chatgptSubmissionFormDataSchema.pick({
|
|
942
980
|
appName: true,
|
|
943
981
|
developerName: true,
|
|
@@ -954,7 +992,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
954
992
|
toolJustifications: true
|
|
955
993
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
956
994
|
const claudeCategorySchema = z.enum([
|
|
957
|
-
"
|
|
995
|
+
"Productivity",
|
|
958
996
|
"Communication",
|
|
959
997
|
"Data & Analytics",
|
|
960
998
|
"Development tools",
|
|
@@ -962,205 +1000,145 @@ const claudeCategorySchema = z.enum([
|
|
|
962
1000
|
"Consumer Health",
|
|
963
1001
|
"Health & Life Sciences",
|
|
964
1002
|
"Media & Entertainment",
|
|
965
|
-
"Commerce & Shopping"
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
"
|
|
969
|
-
"
|
|
970
|
-
"
|
|
1003
|
+
"Commerce & Shopping",
|
|
1004
|
+
"Legal",
|
|
1005
|
+
"Sales and marketing",
|
|
1006
|
+
"Creative",
|
|
1007
|
+
"Nonprofit",
|
|
1008
|
+
"Education",
|
|
1009
|
+
"Other"
|
|
971
1010
|
]);
|
|
972
|
-
const
|
|
973
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1011
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
974
1012
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
975
|
-
"
|
|
976
|
-
"
|
|
977
|
-
"
|
|
978
|
-
]);
|
|
979
|
-
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
980
|
-
const claudeTestedSurfaceSchema = z.enum([
|
|
981
|
-
"Claude.ai (web)",
|
|
982
|
-
"Claude Desktop",
|
|
983
|
-
"Claude Code",
|
|
984
|
-
"Cowork"
|
|
1013
|
+
"read_only",
|
|
1014
|
+
"write_only",
|
|
1015
|
+
"read_write"
|
|
985
1016
|
]);
|
|
986
|
-
const
|
|
987
|
-
"
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"
|
|
1017
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1018
|
+
"oauth_dcr",
|
|
1019
|
+
"oauth_cimd",
|
|
1020
|
+
"oauth_anthropic_creds",
|
|
1021
|
+
"custom_connection",
|
|
1022
|
+
"none"
|
|
992
1023
|
]);
|
|
993
|
-
const
|
|
994
|
-
"
|
|
995
|
-
"
|
|
996
|
-
"
|
|
997
|
-
"GDPR compliant (if applicable)"
|
|
1024
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1025
|
+
"first_party",
|
|
1026
|
+
"proxied",
|
|
1027
|
+
"third_party"
|
|
998
1028
|
]);
|
|
999
|
-
const
|
|
1000
|
-
|
|
1001
|
-
"
|
|
1002
|
-
"
|
|
1029
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1030
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1031
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1032
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1033
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1034
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1035
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1036
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1037
|
+
"Public documentation for this connector will be live by the publish date."
|
|
1003
1038
|
]);
|
|
1004
|
-
/**
|
|
1005
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
1006
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
1007
|
-
*/
|
|
1039
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1008
1040
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
(
|
|
1019
|
-
|
|
1020
|
-
(
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
•
|
|
1038
|
-
•
|
|
1039
|
-
•
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
• '
|
|
1055
|
-
• '
|
|
1056
|
-
• '
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
|
|
1084
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
1085
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
1086
|
-
• '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.
|
|
1087
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
1088
|
-
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:
|
|
1089
|
-
• What the connector does and its key capabilities
|
|
1090
|
-
• How to connect/set it up (step by step)
|
|
1091
|
-
• What each tool does (or at least the main ones)
|
|
1092
|
-
• How to troubleshoot common issues
|
|
1093
|
-
• A support contact or channel
|
|
1094
|
-
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.`),
|
|
1095
|
-
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:
|
|
1096
|
-
• What data you collect (and how)
|
|
1097
|
-
• How you use the collected data
|
|
1098
|
-
• Where and how long you store it
|
|
1099
|
-
• Whether you share data with third parties (and who)
|
|
1100
|
-
• How users can contact you about data concerns
|
|
1101
|
-
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.`),
|
|
1102
|
-
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:
|
|
1103
|
-
• Email address (e.g. support@myapp.com)
|
|
1104
|
-
• Link to a GitHub Issues page
|
|
1105
|
-
• Link to a help center or support article
|
|
1106
|
-
• Link to a Discord/Slack community
|
|
1107
|
-
• Link to your documentation's troubleshooting section
|
|
1108
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1109
|
-
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:
|
|
1110
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
1111
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
1112
|
-
• 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.
|
|
1113
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
1114
|
-
• If your service requires API keys instead of a password, provide those.
|
|
1115
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
1116
|
-
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.
|
|
1117
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
1118
|
-
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.`),
|
|
1119
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
1120
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
1121
|
-
• '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).
|
|
1122
|
-
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.`),
|
|
1123
|
-
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.`),
|
|
1124
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
1125
|
-
• Format: SVG only
|
|
1126
|
-
• Aspect ratio: square (1:1)
|
|
1127
|
-
• Should work on a light background
|
|
1128
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
1129
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
1130
|
-
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.`),
|
|
1131
|
-
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:
|
|
1132
|
-
• 3–5 images is ideal
|
|
1133
|
-
• Minimum 1000px width, PNG format preferred
|
|
1134
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
1135
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
1136
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
1137
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
1138
|
-
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()
|
|
1139
1115
|
});
|
|
1140
1116
|
claudeSubmissionFormDataSchema.pick({
|
|
1141
|
-
companyName: true,
|
|
1142
|
-
appName: true,
|
|
1143
|
-
mcpUrlType: true,
|
|
1144
1117
|
serverUrl: true,
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
transportSupport: true,
|
|
1118
|
+
name: true,
|
|
1119
|
+
slug: true,
|
|
1120
|
+
companyName: true,
|
|
1149
1121
|
primaryContactEmail: true,
|
|
1150
1122
|
primaryContactName: true,
|
|
1123
|
+
readWriteCapabilities: true,
|
|
1151
1124
|
authentication: true,
|
|
1152
|
-
|
|
1153
|
-
|
|
1125
|
+
apiOwnership: true,
|
|
1126
|
+
personalHealthData: true
|
|
1154
1127
|
}).extend({
|
|
1155
1128
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1156
|
-
|
|
1129
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1130
|
+
});
|
|
1131
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1132
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1133
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1134
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1135
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1136
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1137
|
+
});
|
|
1138
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1139
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1140
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1157
1141
|
});
|
|
1158
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1159
|
-
tagline: true,
|
|
1160
|
-
description: true,
|
|
1161
|
-
category: true,
|
|
1162
|
-
testCases: true
|
|
1163
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1164
1142
|
const submissionMetaFieldsSchema = z.object({
|
|
1165
1143
|
id: z.string(),
|
|
1166
1144
|
environmentId: z.string(),
|
|
@@ -1170,14 +1148,14 @@ const submissionMetaFieldsSchema = z.object({
|
|
|
1170
1148
|
});
|
|
1171
1149
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1172
1150
|
platform: z.literal("claudeai"),
|
|
1173
|
-
formData:
|
|
1151
|
+
formData: claudeSubmissionDraftSchema
|
|
1174
1152
|
});
|
|
1175
1153
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1176
1154
|
platform: z.literal("chatgpt"),
|
|
1177
|
-
formData:
|
|
1155
|
+
formData: chatgptSubmissionDraftSchema
|
|
1178
1156
|
});
|
|
1179
1157
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1180
|
-
z.union([
|
|
1158
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1181
1159
|
const subscriptionPlanSchema = z.enum([
|
|
1182
1160
|
"pro",
|
|
1183
1161
|
"business",
|
|
@@ -1201,6 +1179,12 @@ z.object({
|
|
|
1201
1179
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1202
1180
|
});
|
|
1203
1181
|
//#endregion
|
|
1182
|
+
//#region src/auth-scope.ts
|
|
1183
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1184
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1185
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1186
|
+
const AUTH_SCOPE_USER = "user";
|
|
1187
|
+
//#endregion
|
|
1204
1188
|
//#region src/schemas.ts
|
|
1205
1189
|
const RESERVED_KEYS = [
|
|
1206
1190
|
"_HANDLER",
|
|
@@ -1236,7 +1220,10 @@ const RESERVED_KEYS = [
|
|
|
1236
1220
|
"BUILD_ARG_START_COMMAND",
|
|
1237
1221
|
"ALPIC_HOST",
|
|
1238
1222
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1239
|
-
"ALPIC_INTENT_META_KEY"
|
|
1223
|
+
"ALPIC_INTENT_META_KEY",
|
|
1224
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1225
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1226
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1240
1227
|
];
|
|
1241
1228
|
const environmentVariableSchema = z.object({
|
|
1242
1229
|
key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
|
|
@@ -1429,7 +1416,8 @@ const createProjectContractV1 = oc.route({
|
|
|
1429
1416
|
successDescription: "The project has been created successfully"
|
|
1430
1417
|
}).errors({
|
|
1431
1418
|
NOT_FOUND: {},
|
|
1432
|
-
BAD_REQUEST: {}
|
|
1419
|
+
BAD_REQUEST: {},
|
|
1420
|
+
FORBIDDEN: {}
|
|
1433
1421
|
}).input(z.object({
|
|
1434
1422
|
teamId: z.string().optional(),
|
|
1435
1423
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1535,7 +1523,8 @@ const updateProjectContractV1 = oc.route({
|
|
|
1535
1523
|
successDescription: "The project has been updated successfully"
|
|
1536
1524
|
}).errors({
|
|
1537
1525
|
NOT_FOUND: {},
|
|
1538
|
-
BAD_REQUEST: {}
|
|
1526
|
+
BAD_REQUEST: {},
|
|
1527
|
+
FORBIDDEN: {}
|
|
1539
1528
|
}).input(z.object({
|
|
1540
1529
|
projectId: z.string().describe("The ID of the project"),
|
|
1541
1530
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
@@ -1550,10 +1539,12 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1550
1539
|
successDescription: "The environment has been deployed successfully"
|
|
1551
1540
|
}).errors({
|
|
1552
1541
|
NOT_FOUND: {},
|
|
1553
|
-
BAD_REQUEST: {}
|
|
1542
|
+
BAD_REQUEST: {},
|
|
1543
|
+
CONFLICT: {}
|
|
1554
1544
|
}).input(z.object({
|
|
1555
1545
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1556
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1546
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1547
|
+
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.")
|
|
1557
1548
|
})).output(deploymentSchema);
|
|
1558
1549
|
const uploadDeploymentArtifactContractV1 = oc.route({
|
|
1559
1550
|
path: "/v1/deployments/upload",
|
|
@@ -1590,6 +1581,21 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1590
1581
|
tags: ["deployments"],
|
|
1591
1582
|
successDescription: "The deployment details"
|
|
1592
1583
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1584
|
+
const logEntrySchema = z.object({
|
|
1585
|
+
timestamp: z.coerce.date(),
|
|
1586
|
+
type: z.enum([
|
|
1587
|
+
"START",
|
|
1588
|
+
"END",
|
|
1589
|
+
"INFO",
|
|
1590
|
+
"ERROR",
|
|
1591
|
+
"WARNING",
|
|
1592
|
+
"DEBUG"
|
|
1593
|
+
]),
|
|
1594
|
+
requestId: z.string(),
|
|
1595
|
+
content: z.string().optional(),
|
|
1596
|
+
method: z.string().optional(),
|
|
1597
|
+
durationInMs: z.number().optional()
|
|
1598
|
+
});
|
|
1593
1599
|
const getLogsContractV1 = oc.route({
|
|
1594
1600
|
path: "/v1/environments/{environmentId}/logs",
|
|
1595
1601
|
method: "GET",
|
|
@@ -1614,21 +1620,7 @@ const getLogsContractV1 = oc.route({
|
|
|
1614
1620
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1615
1621
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1616
1622
|
})).output(z.object({
|
|
1617
|
-
logs: z.array(
|
|
1618
|
-
timestamp: z.coerce.date(),
|
|
1619
|
-
type: z.enum([
|
|
1620
|
-
"START",
|
|
1621
|
-
"END",
|
|
1622
|
-
"INFO",
|
|
1623
|
-
"ERROR",
|
|
1624
|
-
"WARNING",
|
|
1625
|
-
"DEBUG"
|
|
1626
|
-
]),
|
|
1627
|
-
requestId: z.string(),
|
|
1628
|
-
content: z.string().optional(),
|
|
1629
|
-
method: z.string().optional(),
|
|
1630
|
-
durationInMs: z.number().optional()
|
|
1631
|
-
})),
|
|
1623
|
+
logs: z.array(logEntrySchema),
|
|
1632
1624
|
nextToken: z.string().nullable()
|
|
1633
1625
|
}));
|
|
1634
1626
|
const getLatestLogsContractV1 = oc.route({
|
|
@@ -1651,21 +1643,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1651
1643
|
"DEBUG"
|
|
1652
1644
|
])).optional().describe("Filter by log level"),
|
|
1653
1645
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1654
|
-
})).output(z.object({ logs: z.array(
|
|
1655
|
-
timestamp: z.coerce.date(),
|
|
1656
|
-
type: z.enum([
|
|
1657
|
-
"START",
|
|
1658
|
-
"END",
|
|
1659
|
-
"INFO",
|
|
1660
|
-
"ERROR",
|
|
1661
|
-
"WARNING",
|
|
1662
|
-
"DEBUG"
|
|
1663
|
-
]),
|
|
1664
|
-
requestId: z.string(),
|
|
1665
|
-
content: z.string().optional(),
|
|
1666
|
-
method: z.string().optional(),
|
|
1667
|
-
durationInMs: z.number().optional()
|
|
1668
|
-
})) }));
|
|
1646
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1669
1647
|
const getDeploymentLogsContractV1 = oc.route({
|
|
1670
1648
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1671
1649
|
method: "GET",
|
|
@@ -1738,7 +1716,7 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1738
1716
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1739
1717
|
tags: ["tunnels"],
|
|
1740
1718
|
successDescription: "The tunnel ticket"
|
|
1741
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1719
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1742
1720
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1743
1721
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1744
1722
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
@@ -1891,5 +1869,10 @@ const contract = {
|
|
|
1891
1869
|
get: { v1: getBeaconContractV1 }
|
|
1892
1870
|
}
|
|
1893
1871
|
};
|
|
1872
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
1873
|
+
const contractForDocs = {
|
|
1874
|
+
...contract,
|
|
1875
|
+
deployments: deploymentsForDocs
|
|
1876
|
+
};
|
|
1894
1877
|
//#endregion
|
|
1895
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1878
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|