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