@alpic-ai/api 0.0.0-staging.g430b4ff → 0.0.0-staging.g450ef33
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +91 -60
- package/dist/index.mjs +611 -249
- 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.29.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.29.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",
|
|
@@ -276,11 +286,11 @@ const deploymentSummarySchema = z.object({
|
|
|
276
286
|
/**
|
|
277
287
|
* Public environment
|
|
278
288
|
*
|
|
279
|
-
*
|
|
289
|
+
* Answers anonymously and exposes no OAuth metadata.
|
|
280
290
|
*/
|
|
281
291
|
const publicEnvironmentSchema = z.object({
|
|
282
|
-
|
|
283
|
-
oAuthMetadata: z.
|
|
292
|
+
allowsAnonymous: z.literal(true),
|
|
293
|
+
oAuthMetadata: z.strictObject({})
|
|
284
294
|
});
|
|
285
295
|
/**
|
|
286
296
|
* Protected environment with an external resource metadata URL
|
|
@@ -289,7 +299,7 @@ const publicEnvironmentSchema = z.object({
|
|
|
289
299
|
* Everything that follows is handled outside of the MCP server scope.
|
|
290
300
|
*/
|
|
291
301
|
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
292
|
-
|
|
302
|
+
allowsAnonymous: z.boolean(),
|
|
293
303
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
304
|
scope: z.string().optional()
|
|
295
305
|
});
|
|
@@ -301,7 +311,7 @@ const externalResourceMetadataEnvironmentSchema = z.object({
|
|
|
301
311
|
* Everything that follows is handled outside of the MCP server scope.
|
|
302
312
|
*/
|
|
303
313
|
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
|
-
|
|
314
|
+
allowsAnonymous: z.boolean(),
|
|
305
315
|
oAuthMetadata: z.object({
|
|
306
316
|
externalAuthorizationServerUrl: z.url(),
|
|
307
317
|
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
@@ -315,7 +325,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
315
325
|
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
316
326
|
*/
|
|
317
327
|
const standaloneEnvironmentSchema = z.object({
|
|
318
|
-
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
319
329
|
oAuthMetadata: z.object({
|
|
320
330
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
321
331
|
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
@@ -330,6 +340,36 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
330
340
|
* are advertised. Clients must obtain credentials out-of-band.
|
|
331
341
|
*/
|
|
332
342
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
343
|
+
allowsAnonymous: z.literal(false),
|
|
344
|
+
oAuthMetadata: z.strictObject({}),
|
|
345
|
+
scope: z.string().optional()
|
|
346
|
+
});
|
|
347
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
348
|
+
isPublic: z.literal(true),
|
|
349
|
+
oAuthMetadata: z.undefined().optional()
|
|
350
|
+
});
|
|
351
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
352
|
+
isPublic: z.literal(false),
|
|
353
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
354
|
+
scope: z.string().optional()
|
|
355
|
+
});
|
|
356
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
357
|
+
isPublic: z.literal(false),
|
|
358
|
+
oAuthMetadata: z.object({
|
|
359
|
+
externalAuthorizationServerUrl: z.url(),
|
|
360
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
361
|
+
}),
|
|
362
|
+
scope: z.string().optional()
|
|
363
|
+
});
|
|
364
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
365
|
+
isPublic: z.literal(false),
|
|
366
|
+
oAuthMetadata: z.object({
|
|
367
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
368
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
369
|
+
}),
|
|
370
|
+
scope: z.string().optional()
|
|
371
|
+
});
|
|
372
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
373
|
isPublic: z.literal(false),
|
|
334
374
|
oAuthMetadata: z.strictObject({}),
|
|
335
375
|
scope: z.string().optional()
|
|
@@ -339,11 +379,21 @@ z.union([
|
|
|
339
379
|
externalResourceMetadataEnvironmentSchema,
|
|
340
380
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
381
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
382
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
383
|
+
legacyPublicEnvironmentSchema,
|
|
384
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
385
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
386
|
+
legacyStandaloneEnvironmentSchema,
|
|
387
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
388
|
+
]);
|
|
389
|
+
const playgroundModelSchema = z.enum([
|
|
390
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
391
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
392
|
+
"openai.gpt-5.4",
|
|
393
|
+
"openai.gpt-5.5"
|
|
343
394
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
395
|
const environmentDomainSchema = z.object({
|
|
346
|
-
|
|
396
|
+
name: z.string(),
|
|
347
397
|
status: z.enum([
|
|
348
398
|
"ongoing",
|
|
349
399
|
"deployed",
|
|
@@ -361,6 +411,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
411
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
412
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
413
|
isPlaygroundEnabled: z.boolean(),
|
|
414
|
+
playgroundModel: playgroundModelSchema,
|
|
364
415
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
416
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
417
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -369,6 +420,13 @@ const environmentSchema$1 = z.object({
|
|
|
369
420
|
updatedAt: z.coerce.date()
|
|
370
421
|
});
|
|
371
422
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
423
|
+
z.object({
|
|
424
|
+
sessionReplayEnabled: z.boolean(),
|
|
425
|
+
collectRequestPayload: z.boolean(),
|
|
426
|
+
collectResponsePayload: z.boolean(),
|
|
427
|
+
collectErrorMessage: z.boolean(),
|
|
428
|
+
collectUserData: z.boolean()
|
|
429
|
+
});
|
|
372
430
|
z.object({
|
|
373
431
|
id: z.string(),
|
|
374
432
|
createdAt: z.coerce.date(),
|
|
@@ -502,15 +560,27 @@ z.object({
|
|
|
502
560
|
environments: z.array(environmentWithDomainsSchema),
|
|
503
561
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
504
562
|
});
|
|
563
|
+
const domainFailureReasonSchema = z.enum([
|
|
564
|
+
"caa",
|
|
565
|
+
"dns",
|
|
566
|
+
"invalid_domain",
|
|
567
|
+
"other"
|
|
568
|
+
]);
|
|
569
|
+
const projectDomainMappingSchema = z.object({
|
|
570
|
+
pathPrefix: z.string(),
|
|
571
|
+
environment: environmentSchema$1
|
|
572
|
+
});
|
|
505
573
|
z.object({
|
|
506
|
-
|
|
574
|
+
name: z.string(),
|
|
507
575
|
createdAt: z.coerce.date(),
|
|
508
576
|
status: z.enum([
|
|
509
577
|
"ongoing",
|
|
510
578
|
"deployed",
|
|
511
579
|
"failed"
|
|
512
580
|
]),
|
|
513
|
-
|
|
581
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
582
|
+
environment: environmentSchema$1,
|
|
583
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
514
584
|
});
|
|
515
585
|
const serverFieldsSchema$1 = z.object({
|
|
516
586
|
$schema: z.string(),
|
|
@@ -539,6 +609,22 @@ z.object({
|
|
|
539
609
|
serverFields: serverFieldsSchema$1,
|
|
540
610
|
source: z.enum(["registry", "defaults"])
|
|
541
611
|
});
|
|
612
|
+
/**
|
|
613
|
+
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
614
|
+
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
615
|
+
*
|
|
616
|
+
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
617
|
+
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
618
|
+
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
619
|
+
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
620
|
+
*/
|
|
621
|
+
const clampStringField = (field) => {
|
|
622
|
+
const max = field.maxLength;
|
|
623
|
+
if (max === null) return field;
|
|
624
|
+
const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
|
|
625
|
+
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
626
|
+
return field.description ? withMin.describe(field.description) : withMin;
|
|
627
|
+
};
|
|
542
628
|
const toolDefinitionSchema = z.object({
|
|
543
629
|
name: z.string(),
|
|
544
630
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -551,17 +637,20 @@ const toolDefinitionSchema = z.object({
|
|
|
551
637
|
}).optional()
|
|
552
638
|
});
|
|
553
639
|
const positiveTestCaseSchema = z.object({
|
|
554
|
-
scenario: z.string(),
|
|
555
|
-
userPrompt: z.string(),
|
|
556
|
-
toolTriggered: z.string().optional(),
|
|
557
|
-
expectedOutput: z.string().optional()
|
|
640
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
641
|
+
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
642
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
643
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
558
644
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
559
645
|
const screenshotEntrySchema = z.object({
|
|
560
646
|
prompt: z.string(),
|
|
561
647
|
url: z.url()
|
|
562
648
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
649
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
563
650
|
/** Accepts either a valid email or URL. */
|
|
564
651
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
652
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
653
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
565
654
|
const chatgptCategorySchema = z.enum([
|
|
566
655
|
"BUSINESS",
|
|
567
656
|
"COLLABORATION",
|
|
@@ -578,22 +667,315 @@ const chatgptCategorySchema = z.enum([
|
|
|
578
667
|
"TRAVEL"
|
|
579
668
|
]);
|
|
580
669
|
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
581
|
-
const
|
|
670
|
+
const chatgptCountryCodeSchema = z.enum([
|
|
671
|
+
"AD",
|
|
672
|
+
"AE",
|
|
673
|
+
"AF",
|
|
674
|
+
"AG",
|
|
675
|
+
"AL",
|
|
676
|
+
"AM",
|
|
677
|
+
"AO",
|
|
678
|
+
"AR",
|
|
679
|
+
"AT",
|
|
680
|
+
"AU",
|
|
681
|
+
"AW",
|
|
682
|
+
"AX",
|
|
683
|
+
"AZ",
|
|
684
|
+
"BA",
|
|
685
|
+
"BB",
|
|
686
|
+
"BD",
|
|
687
|
+
"BE",
|
|
688
|
+
"BF",
|
|
689
|
+
"BG",
|
|
690
|
+
"BH",
|
|
691
|
+
"BI",
|
|
692
|
+
"BJ",
|
|
693
|
+
"BL",
|
|
694
|
+
"BM",
|
|
695
|
+
"BN",
|
|
696
|
+
"BO",
|
|
697
|
+
"BR",
|
|
698
|
+
"BS",
|
|
699
|
+
"BT",
|
|
700
|
+
"BW",
|
|
701
|
+
"BZ",
|
|
702
|
+
"CA",
|
|
703
|
+
"CD",
|
|
704
|
+
"CF",
|
|
705
|
+
"CG",
|
|
706
|
+
"CH",
|
|
707
|
+
"CI",
|
|
708
|
+
"CL",
|
|
709
|
+
"CM",
|
|
710
|
+
"CO",
|
|
711
|
+
"CR",
|
|
712
|
+
"CV",
|
|
713
|
+
"CY",
|
|
714
|
+
"CZ",
|
|
715
|
+
"DE",
|
|
716
|
+
"DJ",
|
|
717
|
+
"DK",
|
|
718
|
+
"DM",
|
|
719
|
+
"DO",
|
|
720
|
+
"DZ",
|
|
721
|
+
"EC",
|
|
722
|
+
"EE",
|
|
723
|
+
"EG",
|
|
724
|
+
"ER",
|
|
725
|
+
"ES",
|
|
726
|
+
"ET",
|
|
727
|
+
"FI",
|
|
728
|
+
"FJ",
|
|
729
|
+
"FM",
|
|
730
|
+
"FO",
|
|
731
|
+
"FR",
|
|
732
|
+
"GA",
|
|
733
|
+
"GB",
|
|
734
|
+
"GD",
|
|
735
|
+
"GE",
|
|
736
|
+
"GF",
|
|
737
|
+
"GH",
|
|
738
|
+
"GL",
|
|
739
|
+
"GM",
|
|
740
|
+
"GN",
|
|
741
|
+
"GP",
|
|
742
|
+
"GQ",
|
|
743
|
+
"GR",
|
|
744
|
+
"GT",
|
|
745
|
+
"GW",
|
|
746
|
+
"GY",
|
|
747
|
+
"HN",
|
|
748
|
+
"HR",
|
|
749
|
+
"HT",
|
|
750
|
+
"HU",
|
|
751
|
+
"ID",
|
|
752
|
+
"IE",
|
|
753
|
+
"IL",
|
|
754
|
+
"IN",
|
|
755
|
+
"IQ",
|
|
756
|
+
"IS",
|
|
757
|
+
"IT",
|
|
758
|
+
"JM",
|
|
759
|
+
"JO",
|
|
760
|
+
"JP",
|
|
761
|
+
"KE",
|
|
762
|
+
"KG",
|
|
763
|
+
"KH",
|
|
764
|
+
"KI",
|
|
765
|
+
"KM",
|
|
766
|
+
"KN",
|
|
767
|
+
"KR",
|
|
768
|
+
"KW",
|
|
769
|
+
"KY",
|
|
770
|
+
"KZ",
|
|
771
|
+
"LA",
|
|
772
|
+
"LB",
|
|
773
|
+
"LC",
|
|
774
|
+
"LI",
|
|
775
|
+
"LK",
|
|
776
|
+
"LR",
|
|
777
|
+
"LS",
|
|
778
|
+
"LT",
|
|
779
|
+
"LU",
|
|
780
|
+
"LV",
|
|
781
|
+
"LY",
|
|
782
|
+
"MA",
|
|
783
|
+
"MC",
|
|
784
|
+
"MD",
|
|
785
|
+
"ME",
|
|
786
|
+
"MF",
|
|
787
|
+
"MG",
|
|
788
|
+
"MH",
|
|
789
|
+
"MK",
|
|
790
|
+
"ML",
|
|
791
|
+
"MM",
|
|
792
|
+
"MN",
|
|
793
|
+
"MQ",
|
|
794
|
+
"MR",
|
|
795
|
+
"MT",
|
|
796
|
+
"MU",
|
|
797
|
+
"MV",
|
|
798
|
+
"MW",
|
|
799
|
+
"MX",
|
|
800
|
+
"MY",
|
|
801
|
+
"MZ",
|
|
802
|
+
"NA",
|
|
803
|
+
"NC",
|
|
804
|
+
"NE",
|
|
805
|
+
"NG",
|
|
806
|
+
"NI",
|
|
807
|
+
"NL",
|
|
808
|
+
"NO",
|
|
809
|
+
"NP",
|
|
810
|
+
"NR",
|
|
811
|
+
"NZ",
|
|
812
|
+
"OM",
|
|
813
|
+
"PA",
|
|
814
|
+
"PE",
|
|
815
|
+
"PF",
|
|
816
|
+
"PG",
|
|
817
|
+
"PH",
|
|
818
|
+
"PK",
|
|
819
|
+
"PL",
|
|
820
|
+
"PM",
|
|
821
|
+
"PS",
|
|
822
|
+
"PT",
|
|
823
|
+
"PW",
|
|
824
|
+
"PY",
|
|
825
|
+
"QA",
|
|
826
|
+
"RE",
|
|
827
|
+
"RO",
|
|
828
|
+
"RS",
|
|
829
|
+
"RW",
|
|
830
|
+
"SA",
|
|
831
|
+
"SB",
|
|
832
|
+
"SC",
|
|
833
|
+
"SD",
|
|
834
|
+
"SE",
|
|
835
|
+
"SG",
|
|
836
|
+
"SH",
|
|
837
|
+
"SI",
|
|
838
|
+
"SJ",
|
|
839
|
+
"SK",
|
|
840
|
+
"SL",
|
|
841
|
+
"SM",
|
|
842
|
+
"SN",
|
|
843
|
+
"SO",
|
|
844
|
+
"SR",
|
|
845
|
+
"SS",
|
|
846
|
+
"ST",
|
|
847
|
+
"SV",
|
|
848
|
+
"SZ",
|
|
849
|
+
"TD",
|
|
850
|
+
"TF",
|
|
851
|
+
"TG",
|
|
852
|
+
"TH",
|
|
853
|
+
"TJ",
|
|
854
|
+
"TL",
|
|
855
|
+
"TM",
|
|
856
|
+
"TN",
|
|
857
|
+
"TO",
|
|
858
|
+
"TR",
|
|
859
|
+
"TT",
|
|
860
|
+
"TV",
|
|
861
|
+
"TW",
|
|
862
|
+
"TZ",
|
|
863
|
+
"UA",
|
|
864
|
+
"UG",
|
|
865
|
+
"US",
|
|
866
|
+
"UY",
|
|
867
|
+
"UZ",
|
|
868
|
+
"VA",
|
|
869
|
+
"VC",
|
|
870
|
+
"VN",
|
|
871
|
+
"VU",
|
|
872
|
+
"WF",
|
|
873
|
+
"WS",
|
|
874
|
+
"YE",
|
|
875
|
+
"YT",
|
|
876
|
+
"ZA",
|
|
877
|
+
"ZM",
|
|
878
|
+
"ZW"
|
|
879
|
+
]);
|
|
880
|
+
const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
|
|
881
|
+
z.object({ mode: z.literal("all") }),
|
|
882
|
+
z.object({
|
|
883
|
+
mode: z.literal("allow"),
|
|
884
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
885
|
+
}),
|
|
886
|
+
z.object({
|
|
887
|
+
mode: z.literal("block"),
|
|
888
|
+
countries: z.array(chatgptCountryCodeSchema)
|
|
889
|
+
})
|
|
890
|
+
]);
|
|
891
|
+
const chatgptTranslationLocaleSchema = z.enum([
|
|
892
|
+
"am",
|
|
893
|
+
"ar",
|
|
894
|
+
"bg-BG",
|
|
895
|
+
"bn-BD",
|
|
896
|
+
"bs-BA",
|
|
897
|
+
"ca-ES",
|
|
898
|
+
"cs-CZ",
|
|
899
|
+
"da-DK",
|
|
900
|
+
"de-DE",
|
|
901
|
+
"el-GR",
|
|
902
|
+
"es-419",
|
|
903
|
+
"es-ES",
|
|
904
|
+
"et-EE",
|
|
905
|
+
"fi-FI",
|
|
906
|
+
"fr-CA",
|
|
907
|
+
"fr-FR",
|
|
908
|
+
"gu-IN",
|
|
909
|
+
"hi-IN",
|
|
910
|
+
"hr-HR",
|
|
911
|
+
"hu-HU",
|
|
912
|
+
"hy-AM",
|
|
913
|
+
"id-ID",
|
|
914
|
+
"is-IS",
|
|
915
|
+
"it-IT",
|
|
916
|
+
"ja-JP",
|
|
917
|
+
"ka-GE",
|
|
918
|
+
"kk",
|
|
919
|
+
"kn-IN",
|
|
920
|
+
"ko-KR",
|
|
921
|
+
"lt",
|
|
922
|
+
"lv-LV",
|
|
923
|
+
"mk-MK",
|
|
924
|
+
"ml",
|
|
925
|
+
"mn",
|
|
926
|
+
"mr-IN",
|
|
927
|
+
"ms-MY",
|
|
928
|
+
"my-MM",
|
|
929
|
+
"nb-NO",
|
|
930
|
+
"nl-NL",
|
|
931
|
+
"pa",
|
|
932
|
+
"pl-PL",
|
|
933
|
+
"pt-BR",
|
|
934
|
+
"pt-PT",
|
|
935
|
+
"ro-RO",
|
|
936
|
+
"ru-RU",
|
|
937
|
+
"sk-SK",
|
|
938
|
+
"sl-SI",
|
|
939
|
+
"so-SO",
|
|
940
|
+
"sq-AL",
|
|
941
|
+
"sr-RS",
|
|
942
|
+
"sv-SE",
|
|
943
|
+
"sw-TZ",
|
|
944
|
+
"ta-IN",
|
|
945
|
+
"te-IN",
|
|
946
|
+
"th-TH",
|
|
947
|
+
"tl",
|
|
948
|
+
"tr-TR",
|
|
949
|
+
"uk-UA",
|
|
950
|
+
"ur",
|
|
951
|
+
"vi-VN",
|
|
952
|
+
"zh-CN",
|
|
953
|
+
"zh-HK",
|
|
954
|
+
"zh-TW"
|
|
955
|
+
]);
|
|
582
956
|
const negativeTestCaseSchema = z.object({
|
|
583
957
|
scenario: z.string(),
|
|
584
958
|
userPrompt: z.string()
|
|
585
959
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
586
960
|
const chatgptToolJustificationSchema = z.object({
|
|
587
961
|
toolName: z.string(),
|
|
588
|
-
readOnlyJustification: z.string(),
|
|
589
|
-
openWorldJustification: z.string(),
|
|
590
|
-
destructiveJustification: z.string()
|
|
591
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
962
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
963
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
964
|
+
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.\"")
|
|
965
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
966
|
+
/**
|
|
967
|
+
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
968
|
+
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
969
|
+
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
970
|
+
*/
|
|
971
|
+
const chatgptTaglineSchema = z.string().max(30);
|
|
972
|
+
const chatgptDescriptionSchema = z.string();
|
|
592
973
|
const chatgptTranslationSchema = z.object({
|
|
593
|
-
locale:
|
|
594
|
-
tagline:
|
|
595
|
-
description:
|
|
974
|
+
locale: chatgptTranslationLocaleSchema,
|
|
975
|
+
tagline: chatgptTaglineSchema,
|
|
976
|
+
description: chatgptDescriptionSchema
|
|
596
977
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
978
|
+
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
597
979
|
/**
|
|
598
980
|
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
599
981
|
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
@@ -602,27 +984,38 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
602
984
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
603
985
|
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."),
|
|
604
986
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
605
|
-
tagline:
|
|
606
|
-
description:
|
|
987
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
988
|
+
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)."),
|
|
607
989
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
608
990
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
609
|
-
companyUrl:
|
|
991
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
610
992
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
611
|
-
privacyPolicyUrl:
|
|
612
|
-
termsOfServiceUrl:
|
|
613
|
-
demoRecordingUrl:
|
|
993
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
994
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
995
|
+
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."),
|
|
614
996
|
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."),
|
|
615
|
-
serverUrl:
|
|
997
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
616
998
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
617
999
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
618
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
619
|
-
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output.
|
|
620
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases
|
|
621
|
-
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
|
|
1000
|
+
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."),
|
|
1001
|
+
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."),
|
|
1002
|
+
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."),
|
|
1003
|
+
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."),
|
|
622
1004
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
623
|
-
allowedCountries: chatgptAllowedCountriesSchema.describe("
|
|
1005
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
624
1006
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
625
1007
|
});
|
|
1008
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1009
|
+
tagline: z.string().optional(),
|
|
1010
|
+
companyUrl: z.string().optional(),
|
|
1011
|
+
supportChannel: z.string().optional(),
|
|
1012
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1013
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1014
|
+
demoRecordingUrl: z.string().optional(),
|
|
1015
|
+
serverUrl: z.string().optional(),
|
|
1016
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1017
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1018
|
+
});
|
|
626
1019
|
chatgptSubmissionFormDataSchema.pick({
|
|
627
1020
|
appName: true,
|
|
628
1021
|
developerName: true,
|
|
@@ -637,9 +1030,9 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
637
1030
|
testCases: true,
|
|
638
1031
|
negativeTestCases: true,
|
|
639
1032
|
toolJustifications: true
|
|
640
|
-
});
|
|
1033
|
+
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
641
1034
|
const claudeCategorySchema = z.enum([
|
|
642
|
-
"
|
|
1035
|
+
"Productivity",
|
|
643
1036
|
"Communication",
|
|
644
1037
|
"Data & Analytics",
|
|
645
1038
|
"Development tools",
|
|
@@ -647,207 +1040,171 @@ const claudeCategorySchema = z.enum([
|
|
|
647
1040
|
"Consumer Health",
|
|
648
1041
|
"Health & Life Sciences",
|
|
649
1042
|
"Media & Entertainment",
|
|
650
|
-
"Commerce & Shopping"
|
|
1043
|
+
"Commerce & Shopping",
|
|
1044
|
+
"Legal",
|
|
1045
|
+
"Sales and marketing",
|
|
1046
|
+
"Creative",
|
|
1047
|
+
"Nonprofit",
|
|
1048
|
+
"Education",
|
|
1049
|
+
"Other"
|
|
651
1050
|
]);
|
|
652
|
-
|
|
653
|
-
"No auth needed",
|
|
654
|
-
"OAuth 2.0",
|
|
655
|
-
"Custom URL"
|
|
656
|
-
]);
|
|
657
|
-
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
658
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1051
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
659
1052
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
660
|
-
"
|
|
661
|
-
"
|
|
662
|
-
"
|
|
1053
|
+
"read_only",
|
|
1054
|
+
"write_only",
|
|
1055
|
+
"read_write"
|
|
663
1056
|
]);
|
|
664
|
-
const
|
|
665
|
-
|
|
666
|
-
"
|
|
667
|
-
"
|
|
668
|
-
"
|
|
669
|
-
"
|
|
670
|
-
"N/A"
|
|
1057
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1058
|
+
"oauth_dcr",
|
|
1059
|
+
"oauth_cimd",
|
|
1060
|
+
"oauth_anthropic_creds",
|
|
1061
|
+
"custom_connection",
|
|
1062
|
+
"none"
|
|
671
1063
|
]);
|
|
672
|
-
const
|
|
673
|
-
"
|
|
674
|
-
"
|
|
675
|
-
"
|
|
676
|
-
"GDPR compliant (if applicable)"
|
|
1064
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1065
|
+
"first_party",
|
|
1066
|
+
"proxied",
|
|
1067
|
+
"third_party"
|
|
677
1068
|
]);
|
|
678
|
-
const
|
|
679
|
-
|
|
680
|
-
"
|
|
681
|
-
"
|
|
1069
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1070
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1071
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1072
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1073
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1074
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1075
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1076
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1077
|
+
"Public documentation for this connector will be live by the publish date."
|
|
682
1078
|
]);
|
|
683
1079
|
/**
|
|
684
|
-
* Field order mirrors the
|
|
685
|
-
*
|
|
1080
|
+
* Field order mirrors the claude.ai directory submission wizard
|
|
1081
|
+
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1082
|
+
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
686
1083
|
*/
|
|
687
1084
|
const claudeSubmissionFormDataSchema = z.object({
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
(
|
|
698
|
-
|
|
699
|
-
(
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
•
|
|
717
|
-
•
|
|
718
|
-
•
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
• '
|
|
734
|
-
• '
|
|
735
|
-
• '
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
763
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
764
|
-
• '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.
|
|
765
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
766
|
-
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:
|
|
767
|
-
• What the connector does and its key capabilities
|
|
768
|
-
• How to connect/set it up (step by step)
|
|
769
|
-
• What each tool does (or at least the main ones)
|
|
770
|
-
• How to troubleshoot common issues
|
|
771
|
-
• A support contact or channel
|
|
772
|
-
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.`),
|
|
773
|
-
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:
|
|
774
|
-
• What data you collect (and how)
|
|
775
|
-
• How you use the collected data
|
|
776
|
-
• Where and how long you store it
|
|
777
|
-
• Whether you share data with third parties (and who)
|
|
778
|
-
• How users can contact you about data concerns
|
|
779
|
-
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.`),
|
|
780
|
-
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:
|
|
781
|
-
• Email address (e.g. support@myapp.com)
|
|
782
|
-
• Link to a GitHub Issues page
|
|
783
|
-
• Link to a help center or support article
|
|
784
|
-
• Link to a Discord/Slack community
|
|
785
|
-
• Link to your documentation's troubleshooting section
|
|
786
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
787
|
-
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:
|
|
788
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
789
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
790
|
-
• 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.
|
|
791
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
792
|
-
• If your service requires API keys instead of a password, provide those.
|
|
793
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
794
|
-
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.
|
|
795
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
796
|
-
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.`),
|
|
797
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
798
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
799
|
-
• '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).
|
|
800
|
-
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.`),
|
|
801
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
802
|
-
• Format: SVG only
|
|
803
|
-
• Aspect ratio: square (1:1)
|
|
804
|
-
• Should work on a light background
|
|
805
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
806
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
807
|
-
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.`),
|
|
808
|
-
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:
|
|
809
|
-
• 3–5 images is ideal
|
|
810
|
-
• Minimum 1000px width, PNG format preferred
|
|
811
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
812
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
813
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
814
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
815
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1085
|
+
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
|
|
1086
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1087
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1088
|
+
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
|
|
1089
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1090
|
+
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.
|
|
1091
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1092
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1093
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1094
|
+
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
|
|
1095
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1096
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1097
|
+
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
|
|
1098
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1099
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1100
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1101
|
+
by your publish date.`),
|
|
1102
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1103
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1104
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1105
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1106
|
+
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
|
|
1107
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1108
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1109
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1110
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1111
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1112
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1113
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1114
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1115
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1116
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1117
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1118
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1119
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1120
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1121
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1122
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1123
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1124
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1125
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1126
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1127
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1128
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1129
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1130
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1131
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1132
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1133
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1134
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1135
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1136
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1137
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1138
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1139
|
+
fully populated account.`),
|
|
1140
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1141
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1142
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1143
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1144
|
+
});
|
|
1145
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1146
|
+
serverUrl: z.string().optional(),
|
|
1147
|
+
name: z.string().optional(),
|
|
1148
|
+
slug: z.string().optional(),
|
|
1149
|
+
oneLiner: z.string().optional(),
|
|
1150
|
+
description: z.string().optional(),
|
|
1151
|
+
iconUrl: z.string().optional(),
|
|
1152
|
+
documentation: z.string().optional(),
|
|
1153
|
+
support: z.string().optional(),
|
|
1154
|
+
privacyPolicy: z.string().optional(),
|
|
1155
|
+
companyWebsite: z.string().optional(),
|
|
1156
|
+
primaryContactEmail: z.string().optional(),
|
|
1157
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1158
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
816
1159
|
});
|
|
817
1160
|
claudeSubmissionFormDataSchema.pick({
|
|
818
|
-
companyName: true,
|
|
819
|
-
appName: true,
|
|
820
|
-
mcpUrlType: true,
|
|
821
1161
|
serverUrl: true,
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
transportSupport: true,
|
|
1162
|
+
name: true,
|
|
1163
|
+
slug: true,
|
|
1164
|
+
companyName: true,
|
|
826
1165
|
primaryContactEmail: true,
|
|
827
|
-
primaryContactName: true
|
|
1166
|
+
primaryContactName: true,
|
|
1167
|
+
readWriteCapabilities: true,
|
|
1168
|
+
authentication: true,
|
|
1169
|
+
apiOwnership: true,
|
|
1170
|
+
personalHealthData: true
|
|
1171
|
+
}).extend({
|
|
1172
|
+
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1173
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
828
1174
|
});
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
1175
|
+
/**
|
|
1176
|
+
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1177
|
+
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1178
|
+
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1179
|
+
* colocated with the Claude contract.
|
|
1180
|
+
*/
|
|
1181
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1182
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1183
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1184
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1185
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1186
|
+
});
|
|
1187
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1188
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1189
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
834
1190
|
});
|
|
835
1191
|
const submissionMetaFieldsSchema = z.object({
|
|
836
1192
|
id: z.string(),
|
|
837
1193
|
environmentId: z.string(),
|
|
1194
|
+
auditId: z.string().nullable(),
|
|
838
1195
|
createdAt: z.coerce.date(),
|
|
839
1196
|
updatedAt: z.coerce.date()
|
|
840
1197
|
});
|
|
841
1198
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
842
1199
|
platform: z.literal("claudeai"),
|
|
843
|
-
formData:
|
|
1200
|
+
formData: claudeSubmissionDraftSchema
|
|
844
1201
|
});
|
|
845
1202
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
846
1203
|
platform: z.literal("chatgpt"),
|
|
847
|
-
formData:
|
|
1204
|
+
formData: chatgptSubmissionDraftSchema
|
|
848
1205
|
});
|
|
849
1206
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
850
|
-
z.union([
|
|
1207
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
851
1208
|
const subscriptionPlanSchema = z.enum([
|
|
852
1209
|
"pro",
|
|
853
1210
|
"business",
|
|
@@ -871,6 +1228,12 @@ z.object({
|
|
|
871
1228
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
872
1229
|
});
|
|
873
1230
|
//#endregion
|
|
1231
|
+
//#region src/auth-scope.ts
|
|
1232
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1233
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1234
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1235
|
+
const AUTH_SCOPE_USER = "user";
|
|
1236
|
+
//#endregion
|
|
874
1237
|
//#region src/schemas.ts
|
|
875
1238
|
const RESERVED_KEYS = [
|
|
876
1239
|
"_HANDLER",
|
|
@@ -1010,7 +1373,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1010
1373
|
id: z.string(),
|
|
1011
1374
|
name: z.string(),
|
|
1012
1375
|
sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
|
|
1013
|
-
urls: z.array(z.
|
|
1376
|
+
urls: z.array(z.url()).describe("The URLs of the MCP server"),
|
|
1014
1377
|
createdAt: z.coerce.date(),
|
|
1015
1378
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1016
1379
|
}));
|
|
@@ -1086,6 +1449,9 @@ const listProjectsContractV1 = oc.route({
|
|
|
1086
1449
|
description: "List all projects for a team",
|
|
1087
1450
|
tags: ["projects"],
|
|
1088
1451
|
successDescription: "The list of projects"
|
|
1452
|
+
}).errors({
|
|
1453
|
+
NOT_FOUND: {},
|
|
1454
|
+
BAD_REQUEST: {}
|
|
1089
1455
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1090
1456
|
const createProjectContractV1 = oc.route({
|
|
1091
1457
|
path: "/v1/projects",
|
|
@@ -1096,7 +1462,8 @@ const createProjectContractV1 = oc.route({
|
|
|
1096
1462
|
successDescription: "The project has been created successfully"
|
|
1097
1463
|
}).errors({
|
|
1098
1464
|
NOT_FOUND: {},
|
|
1099
|
-
BAD_REQUEST: {}
|
|
1465
|
+
BAD_REQUEST: {},
|
|
1466
|
+
FORBIDDEN: {}
|
|
1100
1467
|
}).input(z.object({
|
|
1101
1468
|
teamId: z.string().optional(),
|
|
1102
1469
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1181,7 +1548,10 @@ const deleteEnvironmentVariableContractV1 = oc.route({
|
|
|
1181
1548
|
description: "Delete an environment variable by ID",
|
|
1182
1549
|
tags: ["environments"],
|
|
1183
1550
|
successDescription: "The environment variable has been deleted successfully"
|
|
1184
|
-
}).errors({
|
|
1551
|
+
}).errors({
|
|
1552
|
+
NOT_FOUND: {},
|
|
1553
|
+
BAD_REQUEST: {}
|
|
1554
|
+
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1185
1555
|
const deleteProjectContractV1 = oc.route({
|
|
1186
1556
|
path: "/v1/projects/{projectId}",
|
|
1187
1557
|
method: "DELETE",
|
|
@@ -1199,7 +1569,8 @@ const updateProjectContractV1 = oc.route({
|
|
|
1199
1569
|
successDescription: "The project has been updated successfully"
|
|
1200
1570
|
}).errors({
|
|
1201
1571
|
NOT_FOUND: {},
|
|
1202
|
-
BAD_REQUEST: {}
|
|
1572
|
+
BAD_REQUEST: {},
|
|
1573
|
+
FORBIDDEN: {}
|
|
1203
1574
|
}).input(z.object({
|
|
1204
1575
|
projectId: z.string().describe("The ID of the project"),
|
|
1205
1576
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
@@ -1217,7 +1588,8 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1217
1588
|
BAD_REQUEST: {}
|
|
1218
1589
|
}).input(z.object({
|
|
1219
1590
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1220
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1591
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1592
|
+
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.")
|
|
1221
1593
|
})).output(deploymentSchema);
|
|
1222
1594
|
const uploadDeploymentArtifactContractV1 = oc.route({
|
|
1223
1595
|
path: "/v1/deployments/upload",
|
|
@@ -1226,6 +1598,9 @@ const uploadDeploymentArtifactContractV1 = oc.route({
|
|
|
1226
1598
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1227
1599
|
tags: ["deployments"],
|
|
1228
1600
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1601
|
+
}).errors({
|
|
1602
|
+
NOT_FOUND: {},
|
|
1603
|
+
BAD_REQUEST: {}
|
|
1229
1604
|
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1230
1605
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1231
1606
|
token: z.string().describe("Token to identify the source archive"),
|
|
@@ -1251,6 +1626,21 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1251
1626
|
tags: ["deployments"],
|
|
1252
1627
|
successDescription: "The deployment details"
|
|
1253
1628
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1629
|
+
const logEntrySchema = z.object({
|
|
1630
|
+
timestamp: z.coerce.date(),
|
|
1631
|
+
type: z.enum([
|
|
1632
|
+
"START",
|
|
1633
|
+
"END",
|
|
1634
|
+
"INFO",
|
|
1635
|
+
"ERROR",
|
|
1636
|
+
"WARNING",
|
|
1637
|
+
"DEBUG"
|
|
1638
|
+
]),
|
|
1639
|
+
requestId: z.string(),
|
|
1640
|
+
content: z.string().optional(),
|
|
1641
|
+
method: z.string().optional(),
|
|
1642
|
+
durationInMs: z.number().optional()
|
|
1643
|
+
});
|
|
1254
1644
|
const getLogsContractV1 = oc.route({
|
|
1255
1645
|
path: "/v1/environments/{environmentId}/logs",
|
|
1256
1646
|
method: "GET",
|
|
@@ -1275,21 +1665,7 @@ const getLogsContractV1 = oc.route({
|
|
|
1275
1665
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1276
1666
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1277
1667
|
})).output(z.object({
|
|
1278
|
-
logs: z.array(
|
|
1279
|
-
timestamp: z.coerce.date(),
|
|
1280
|
-
type: z.enum([
|
|
1281
|
-
"START",
|
|
1282
|
-
"END",
|
|
1283
|
-
"INFO",
|
|
1284
|
-
"ERROR",
|
|
1285
|
-
"WARNING",
|
|
1286
|
-
"DEBUG"
|
|
1287
|
-
]),
|
|
1288
|
-
requestId: z.string(),
|
|
1289
|
-
content: z.string().optional(),
|
|
1290
|
-
method: z.string().optional(),
|
|
1291
|
-
durationInMs: z.number().optional()
|
|
1292
|
-
})),
|
|
1668
|
+
logs: z.array(logEntrySchema),
|
|
1293
1669
|
nextToken: z.string().nullable()
|
|
1294
1670
|
}));
|
|
1295
1671
|
const getLatestLogsContractV1 = oc.route({
|
|
@@ -1312,21 +1688,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1312
1688
|
"DEBUG"
|
|
1313
1689
|
])).optional().describe("Filter by log level"),
|
|
1314
1690
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1315
|
-
})).output(z.object({ logs: z.array(
|
|
1316
|
-
timestamp: z.coerce.date(),
|
|
1317
|
-
type: z.enum([
|
|
1318
|
-
"START",
|
|
1319
|
-
"END",
|
|
1320
|
-
"INFO",
|
|
1321
|
-
"ERROR",
|
|
1322
|
-
"WARNING",
|
|
1323
|
-
"DEBUG"
|
|
1324
|
-
]),
|
|
1325
|
-
requestId: z.string(),
|
|
1326
|
-
content: z.string().optional(),
|
|
1327
|
-
method: z.string().optional(),
|
|
1328
|
-
durationInMs: z.number().optional()
|
|
1329
|
-
})) }));
|
|
1691
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1330
1692
|
const getDeploymentLogsContractV1 = oc.route({
|
|
1331
1693
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1332
1694
|
method: "GET",
|
|
@@ -1399,7 +1761,7 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1399
1761
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1400
1762
|
tags: ["tunnels"],
|
|
1401
1763
|
successDescription: "The tunnel ticket"
|
|
1402
|
-
}).output(z.object({
|
|
1764
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1403
1765
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1404
1766
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1405
1767
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
@@ -1553,4 +1915,4 @@ const contract = {
|
|
|
1553
1915
|
}
|
|
1554
1916
|
};
|
|
1555
1917
|
//#endregion
|
|
1556
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1918
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|