@alpic-ai/api 0.0.0-dev.gfbdef08 → 0.0.0-dev.gfbf0e1a

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.mjs CHANGED
@@ -1,6 +1,174 @@
1
1
  import { z } from "zod";
2
+ import * as z$1 from "zod/v4";
2
3
  import { oc } from "@orpc/contract";
3
4
  import ms from "ms";
5
+ //#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.29.0_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
6
+ /**
7
+ * Reusable URL validation that disallows javascript: scheme
8
+ */
9
+ const SafeUrlSchema = z$1.url().superRefine((val, ctx) => {
10
+ if (!URL.canParse(val)) {
11
+ ctx.addIssue({
12
+ code: z$1.ZodIssueCode.custom,
13
+ message: "URL must be parseable",
14
+ fatal: true
15
+ });
16
+ return z$1.NEVER;
17
+ }
18
+ }).refine((url) => {
19
+ const u = new URL(url);
20
+ return u.protocol !== "javascript:" && u.protocol !== "data:" && u.protocol !== "vbscript:";
21
+ }, { message: "URL cannot use javascript:, data:, or vbscript: scheme" });
22
+ /**
23
+ * RFC 9728 OAuth Protected Resource Metadata
24
+ */
25
+ const OAuthProtectedResourceMetadataSchema = z$1.looseObject({
26
+ resource: z$1.string().url(),
27
+ authorization_servers: z$1.array(SafeUrlSchema).optional(),
28
+ jwks_uri: z$1.string().url().optional(),
29
+ scopes_supported: z$1.array(z$1.string()).optional(),
30
+ bearer_methods_supported: z$1.array(z$1.string()).optional(),
31
+ resource_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
32
+ resource_name: z$1.string().optional(),
33
+ resource_documentation: z$1.string().optional(),
34
+ resource_policy_uri: z$1.string().url().optional(),
35
+ resource_tos_uri: z$1.string().url().optional(),
36
+ tls_client_certificate_bound_access_tokens: z$1.boolean().optional(),
37
+ authorization_details_types_supported: z$1.array(z$1.string()).optional(),
38
+ dpop_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
39
+ dpop_bound_access_tokens_required: z$1.boolean().optional()
40
+ });
41
+ /**
42
+ * RFC 8414 OAuth 2.0 Authorization Server Metadata
43
+ */
44
+ const OAuthMetadataSchema = z$1.looseObject({
45
+ issuer: z$1.string(),
46
+ authorization_endpoint: SafeUrlSchema,
47
+ token_endpoint: SafeUrlSchema,
48
+ registration_endpoint: SafeUrlSchema.optional(),
49
+ scopes_supported: z$1.array(z$1.string()).optional(),
50
+ response_types_supported: z$1.array(z$1.string()),
51
+ response_modes_supported: z$1.array(z$1.string()).optional(),
52
+ grant_types_supported: z$1.array(z$1.string()).optional(),
53
+ token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
54
+ token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
55
+ service_documentation: SafeUrlSchema.optional(),
56
+ revocation_endpoint: SafeUrlSchema.optional(),
57
+ revocation_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
58
+ revocation_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
59
+ introspection_endpoint: z$1.string().optional(),
60
+ introspection_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
61
+ introspection_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
62
+ code_challenge_methods_supported: z$1.array(z$1.string()).optional(),
63
+ client_id_metadata_document_supported: z$1.boolean().optional()
64
+ });
65
+ /**
66
+ * OpenID Connect Discovery 1.0 Provider Metadata
67
+ * see: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
68
+ */
69
+ const OpenIdProviderMetadataSchema = z$1.looseObject({
70
+ issuer: z$1.string(),
71
+ authorization_endpoint: SafeUrlSchema,
72
+ token_endpoint: SafeUrlSchema,
73
+ userinfo_endpoint: SafeUrlSchema.optional(),
74
+ jwks_uri: SafeUrlSchema,
75
+ registration_endpoint: SafeUrlSchema.optional(),
76
+ scopes_supported: z$1.array(z$1.string()).optional(),
77
+ response_types_supported: z$1.array(z$1.string()),
78
+ response_modes_supported: z$1.array(z$1.string()).optional(),
79
+ grant_types_supported: z$1.array(z$1.string()).optional(),
80
+ acr_values_supported: z$1.array(z$1.string()).optional(),
81
+ subject_types_supported: z$1.array(z$1.string()),
82
+ id_token_signing_alg_values_supported: z$1.array(z$1.string()),
83
+ id_token_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
84
+ id_token_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
85
+ userinfo_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
86
+ userinfo_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
87
+ userinfo_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
88
+ request_object_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
89
+ request_object_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
90
+ request_object_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
91
+ token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
92
+ token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
93
+ display_values_supported: z$1.array(z$1.string()).optional(),
94
+ claim_types_supported: z$1.array(z$1.string()).optional(),
95
+ claims_supported: z$1.array(z$1.string()).optional(),
96
+ service_documentation: z$1.string().optional(),
97
+ claims_locales_supported: z$1.array(z$1.string()).optional(),
98
+ ui_locales_supported: z$1.array(z$1.string()).optional(),
99
+ claims_parameter_supported: z$1.boolean().optional(),
100
+ request_parameter_supported: z$1.boolean().optional(),
101
+ request_uri_parameter_supported: z$1.boolean().optional(),
102
+ require_request_uri_registration: z$1.boolean().optional(),
103
+ op_policy_uri: SafeUrlSchema.optional(),
104
+ op_tos_uri: SafeUrlSchema.optional(),
105
+ client_id_metadata_document_supported: z$1.boolean().optional()
106
+ });
107
+ /**
108
+ * OpenID Connect Discovery metadata that may include OAuth 2.0 fields
109
+ * This schema represents the real-world scenario where OIDC providers
110
+ * return a mix of OpenID Connect and OAuth 2.0 metadata fields
111
+ */
112
+ const OpenIdProviderDiscoveryMetadataSchema = z$1.object({
113
+ ...OpenIdProviderMetadataSchema.shape,
114
+ ...OAuthMetadataSchema.pick({ code_challenge_methods_supported: true }).shape
115
+ });
116
+ z$1.object({
117
+ access_token: z$1.string(),
118
+ id_token: z$1.string().optional(),
119
+ token_type: z$1.string(),
120
+ expires_in: z$1.coerce.number().optional(),
121
+ scope: z$1.string().optional(),
122
+ refresh_token: z$1.string().optional()
123
+ }).strip();
124
+ z$1.object({
125
+ error: z$1.string(),
126
+ error_description: z$1.string().optional(),
127
+ error_uri: z$1.string().optional()
128
+ });
129
+ /**
130
+ * Optional version of SafeUrlSchema that allows empty string for retrocompatibility on tos_uri and logo_uri
131
+ */
132
+ const OptionalSafeUrlSchema = SafeUrlSchema.optional().or(z$1.literal("").transform(() => void 0));
133
+ /**
134
+ * RFC 7591 OAuth 2.0 Dynamic Client Registration metadata
135
+ */
136
+ const OAuthClientMetadataSchema = z$1.object({
137
+ redirect_uris: z$1.array(SafeUrlSchema),
138
+ token_endpoint_auth_method: z$1.string().optional(),
139
+ grant_types: z$1.array(z$1.string()).optional(),
140
+ response_types: z$1.array(z$1.string()).optional(),
141
+ client_name: z$1.string().optional(),
142
+ client_uri: SafeUrlSchema.optional(),
143
+ logo_uri: OptionalSafeUrlSchema,
144
+ scope: z$1.string().optional(),
145
+ contacts: z$1.array(z$1.string()).optional(),
146
+ tos_uri: OptionalSafeUrlSchema,
147
+ policy_uri: z$1.string().optional(),
148
+ jwks_uri: SafeUrlSchema.optional(),
149
+ jwks: z$1.any().optional(),
150
+ software_id: z$1.string().optional(),
151
+ software_version: z$1.string().optional(),
152
+ software_statement: z$1.string().optional()
153
+ }).strip();
154
+ /**
155
+ * RFC 7591 OAuth 2.0 Dynamic Client Registration client information
156
+ */
157
+ const OAuthClientInformationSchema = z$1.object({
158
+ client_id: z$1.string(),
159
+ client_secret: z$1.string().optional(),
160
+ client_id_issued_at: z$1.number().optional(),
161
+ client_secret_expires_at: z$1.number().optional()
162
+ }).strip();
163
+ OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
164
+ z$1.object({
165
+ error: z$1.string(),
166
+ error_description: z$1.string().optional()
167
+ }).strip();
168
+ z$1.object({
169
+ token: z$1.string(),
170
+ token_type_hint: z$1.string().optional()
171
+ }).strip();
4
172
  const platformSchema = z.enum(["chatgpt", "claudeai"]);
5
173
  const PLATFORM_LABELS = {
6
174
  chatgpt: "ChatGPT",
@@ -71,6 +239,13 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
71
239
  chatgpt: widgetScreenshotSchema.optional(),
72
240
  claudeai: widgetScreenshotSchema.optional()
73
241
  }) });
242
+ z.object({
243
+ id: z.string(),
244
+ environmentId: z.string(),
245
+ clientId: z.string(),
246
+ clientSecret: z.string(),
247
+ clientScopes: z.array(z.string())
248
+ });
74
249
  const deploymentStatusSchema$1 = z.enum([
75
250
  "ongoing",
76
251
  "deployed",
@@ -98,9 +273,77 @@ const deploymentSummarySchema = z.object({
98
273
  createdAt: z.coerce.date(),
99
274
  updatedAt: z.coerce.date()
100
275
  });
276
+ /**
277
+ * Public environment
278
+ *
279
+ * No OAuth metadata exposed.
280
+ */
281
+ const publicEnvironmentSchema = z.object({
282
+ isPublic: z.literal(true),
283
+ oAuthMetadata: z.undefined().optional()
284
+ });
285
+ /**
286
+ * Protected environment with an external resource metadata URL
287
+ *
288
+ * An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
289
+ * Everything that follows is handled outside of the MCP server scope.
290
+ */
291
+ const externalResourceMetadataEnvironmentSchema = z.object({
292
+ isPublic: z.literal(false),
293
+ oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
294
+ scope: z.string().optional()
295
+ });
296
+ /**
297
+ * Protected environment with an external authorization server URL
298
+ *
299
+ * The server itself exposes the /.well-known/oauth-protected-resource endpoint.
300
+ * An external authorization server URL is returned when requesting the endpoint.
301
+ * Everything that follows is handled outside of the MCP server scope.
302
+ */
303
+ const externalAuthorizationServerEnvironmentSchema = z.object({
304
+ isPublic: z.literal(false),
305
+ oAuthMetadata: z.object({
306
+ externalAuthorizationServerUrl: z.url(),
307
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
308
+ }),
309
+ scope: z.string().optional()
310
+ });
311
+ /**
312
+ * Standalone protected environment
313
+ *
314
+ * The server itself exposes the /.well-known/oauth-protected-resource endpoint.
315
+ * The server itself exposes the /.well-known/oauth-authorization-server endpoint.
316
+ */
317
+ const standaloneEnvironmentSchema = z.object({
318
+ isPublic: z.literal(false),
319
+ oAuthMetadata: z.object({
320
+ authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
321
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
322
+ }),
323
+ scope: z.string().optional()
324
+ });
325
+ /**
326
+ * Protected environment without OAuth discovery
327
+ *
328
+ * The server enforces authentication but exposes no OAuth discovery metadata.
329
+ * Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
330
+ * are advertised. Clients must obtain credentials out-of-band.
331
+ */
332
+ const protectedWithoutDiscoveryEnvironmentSchema = z.object({
333
+ isPublic: z.literal(false),
334
+ oAuthMetadata: z.strictObject({}),
335
+ scope: z.string().optional()
336
+ });
337
+ z.union([
338
+ publicEnvironmentSchema,
339
+ externalResourceMetadataEnvironmentSchema,
340
+ externalAuthorizationServerEnvironmentSchema,
341
+ standaloneEnvironmentSchema,
342
+ protectedWithoutDiscoveryEnvironmentSchema
343
+ ]);
101
344
  const allowedPlatformSchema = platformSchema;
102
345
  const environmentDomainSchema = z.object({
103
- domain: z.string(),
346
+ name: z.string(),
104
347
  status: z.enum([
105
348
  "ongoing",
106
349
  "deployed",
@@ -126,6 +369,13 @@ const environmentSchema$1 = z.object({
126
369
  updatedAt: z.coerce.date()
127
370
  });
128
371
  const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
372
+ z.object({
373
+ sessionReplayEnabled: z.boolean(),
374
+ collectRequestPayload: z.boolean(),
375
+ collectResponsePayload: z.boolean(),
376
+ collectErrorMessage: z.boolean(),
377
+ collectUserData: z.boolean()
378
+ });
129
379
  z.object({
130
380
  id: z.string(),
131
381
  createdAt: z.coerce.date(),
@@ -259,15 +509,27 @@ z.object({
259
509
  environments: z.array(environmentWithDomainsSchema),
260
510
  productionEnvironment: environmentWithDomainsSchema.nullable()
261
511
  });
512
+ const domainFailureReasonSchema = z.enum([
513
+ "caa",
514
+ "dns",
515
+ "invalid_domain",
516
+ "other"
517
+ ]);
518
+ const projectDomainMappingSchema = z.object({
519
+ pathPrefix: z.string(),
520
+ environment: environmentSchema$1
521
+ });
262
522
  z.object({
263
- domain: z.string(),
523
+ name: z.string(),
264
524
  createdAt: z.coerce.date(),
265
525
  status: z.enum([
266
526
  "ongoing",
267
527
  "deployed",
268
528
  "failed"
269
529
  ]),
270
- environment: environmentSchema$1
530
+ failureReason: domainFailureReasonSchema.nullable(),
531
+ environment: environmentSchema$1,
532
+ mappings: z.array(projectDomainMappingSchema)
271
533
  });
272
534
  const serverFieldsSchema$1 = z.object({
273
535
  $schema: z.string(),
@@ -296,6 +558,22 @@ z.object({
296
558
  serverFields: serverFieldsSchema$1,
297
559
  source: z.enum(["registry", "defaults"])
298
560
  });
561
+ /**
562
+ * Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
563
+ * rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
564
+ *
565
+ * NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
566
+ * `minLength`, and the description. Any other validators on the source field (`.regex()`,
567
+ * `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
568
+ * free-text length caps only. A field with `null` `maxLength` is returned unchanged.
569
+ */
570
+ const clampStringField = (field) => {
571
+ const max = field.maxLength;
572
+ if (max === null) return field;
573
+ const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
574
+ const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
575
+ return field.description ? withMin.describe(field.description) : withMin;
576
+ };
299
577
  const toolDefinitionSchema = z.object({
300
578
  name: z.string(),
301
579
  title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
@@ -308,17 +586,19 @@ const toolDefinitionSchema = z.object({
308
586
  }).optional()
309
587
  });
310
588
  const positiveTestCaseSchema = z.object({
311
- scenario: z.string(),
312
- userPrompt: z.string(),
313
- toolTriggered: z.string().optional(),
314
- expectedOutput: z.string().optional()
589
+ scenario: z.string().describe("Short label for what this case demonstrates."),
590
+ 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."),
591
+ toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
592
+ expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
315
593
  }).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
316
594
  const screenshotEntrySchema = z.object({
317
595
  prompt: z.string(),
318
- url: z.url()
596
+ url: z.url().or(z.literal(""))
319
597
  }).describe("Each screenshot: the user prompt that produced it + the image URL.");
320
598
  /** Accepts either a valid email or URL. */
321
599
  const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
600
+ /** A URL field whose error spells out that the scheme is required. */
601
+ const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
322
602
  const chatgptCategorySchema = z.enum([
323
603
  "BUSINESS",
324
604
  "COLLABORATION",
@@ -335,22 +615,315 @@ const chatgptCategorySchema = z.enum([
335
615
  "TRAVEL"
336
616
  ]);
337
617
  const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
338
- const chatgptAllowedCountriesSchema = z.enum(["Allow all", "Restrict to specific countries"]);
618
+ const chatgptCountryCodeSchema = z.enum([
619
+ "AD",
620
+ "AE",
621
+ "AF",
622
+ "AG",
623
+ "AL",
624
+ "AM",
625
+ "AO",
626
+ "AR",
627
+ "AT",
628
+ "AU",
629
+ "AW",
630
+ "AX",
631
+ "AZ",
632
+ "BA",
633
+ "BB",
634
+ "BD",
635
+ "BE",
636
+ "BF",
637
+ "BG",
638
+ "BH",
639
+ "BI",
640
+ "BJ",
641
+ "BL",
642
+ "BM",
643
+ "BN",
644
+ "BO",
645
+ "BR",
646
+ "BS",
647
+ "BT",
648
+ "BW",
649
+ "BZ",
650
+ "CA",
651
+ "CD",
652
+ "CF",
653
+ "CG",
654
+ "CH",
655
+ "CI",
656
+ "CL",
657
+ "CM",
658
+ "CO",
659
+ "CR",
660
+ "CV",
661
+ "CY",
662
+ "CZ",
663
+ "DE",
664
+ "DJ",
665
+ "DK",
666
+ "DM",
667
+ "DO",
668
+ "DZ",
669
+ "EC",
670
+ "EE",
671
+ "EG",
672
+ "ER",
673
+ "ES",
674
+ "ET",
675
+ "FI",
676
+ "FJ",
677
+ "FM",
678
+ "FO",
679
+ "FR",
680
+ "GA",
681
+ "GB",
682
+ "GD",
683
+ "GE",
684
+ "GF",
685
+ "GH",
686
+ "GL",
687
+ "GM",
688
+ "GN",
689
+ "GP",
690
+ "GQ",
691
+ "GR",
692
+ "GT",
693
+ "GW",
694
+ "GY",
695
+ "HN",
696
+ "HR",
697
+ "HT",
698
+ "HU",
699
+ "ID",
700
+ "IE",
701
+ "IL",
702
+ "IN",
703
+ "IQ",
704
+ "IS",
705
+ "IT",
706
+ "JM",
707
+ "JO",
708
+ "JP",
709
+ "KE",
710
+ "KG",
711
+ "KH",
712
+ "KI",
713
+ "KM",
714
+ "KN",
715
+ "KR",
716
+ "KW",
717
+ "KY",
718
+ "KZ",
719
+ "LA",
720
+ "LB",
721
+ "LC",
722
+ "LI",
723
+ "LK",
724
+ "LR",
725
+ "LS",
726
+ "LT",
727
+ "LU",
728
+ "LV",
729
+ "LY",
730
+ "MA",
731
+ "MC",
732
+ "MD",
733
+ "ME",
734
+ "MF",
735
+ "MG",
736
+ "MH",
737
+ "MK",
738
+ "ML",
739
+ "MM",
740
+ "MN",
741
+ "MQ",
742
+ "MR",
743
+ "MT",
744
+ "MU",
745
+ "MV",
746
+ "MW",
747
+ "MX",
748
+ "MY",
749
+ "MZ",
750
+ "NA",
751
+ "NC",
752
+ "NE",
753
+ "NG",
754
+ "NI",
755
+ "NL",
756
+ "NO",
757
+ "NP",
758
+ "NR",
759
+ "NZ",
760
+ "OM",
761
+ "PA",
762
+ "PE",
763
+ "PF",
764
+ "PG",
765
+ "PH",
766
+ "PK",
767
+ "PL",
768
+ "PM",
769
+ "PS",
770
+ "PT",
771
+ "PW",
772
+ "PY",
773
+ "QA",
774
+ "RE",
775
+ "RO",
776
+ "RS",
777
+ "RW",
778
+ "SA",
779
+ "SB",
780
+ "SC",
781
+ "SD",
782
+ "SE",
783
+ "SG",
784
+ "SH",
785
+ "SI",
786
+ "SJ",
787
+ "SK",
788
+ "SL",
789
+ "SM",
790
+ "SN",
791
+ "SO",
792
+ "SR",
793
+ "SS",
794
+ "ST",
795
+ "SV",
796
+ "SZ",
797
+ "TD",
798
+ "TF",
799
+ "TG",
800
+ "TH",
801
+ "TJ",
802
+ "TL",
803
+ "TM",
804
+ "TN",
805
+ "TO",
806
+ "TR",
807
+ "TT",
808
+ "TV",
809
+ "TW",
810
+ "TZ",
811
+ "UA",
812
+ "UG",
813
+ "US",
814
+ "UY",
815
+ "UZ",
816
+ "VA",
817
+ "VC",
818
+ "VN",
819
+ "VU",
820
+ "WF",
821
+ "WS",
822
+ "YE",
823
+ "YT",
824
+ "ZA",
825
+ "ZM",
826
+ "ZW"
827
+ ]);
828
+ const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
829
+ z.object({ mode: z.literal("all") }),
830
+ z.object({
831
+ mode: z.literal("allow"),
832
+ countries: z.array(chatgptCountryCodeSchema)
833
+ }),
834
+ z.object({
835
+ mode: z.literal("block"),
836
+ countries: z.array(chatgptCountryCodeSchema)
837
+ })
838
+ ]);
839
+ const chatgptTranslationLocaleSchema = z.enum([
840
+ "am",
841
+ "ar",
842
+ "bg-BG",
843
+ "bn-BD",
844
+ "bs-BA",
845
+ "ca-ES",
846
+ "cs-CZ",
847
+ "da-DK",
848
+ "de-DE",
849
+ "el-GR",
850
+ "es-419",
851
+ "es-ES",
852
+ "et-EE",
853
+ "fi-FI",
854
+ "fr-CA",
855
+ "fr-FR",
856
+ "gu-IN",
857
+ "hi-IN",
858
+ "hr-HR",
859
+ "hu-HU",
860
+ "hy-AM",
861
+ "id-ID",
862
+ "is-IS",
863
+ "it-IT",
864
+ "ja-JP",
865
+ "ka-GE",
866
+ "kk",
867
+ "kn-IN",
868
+ "ko-KR",
869
+ "lt",
870
+ "lv-LV",
871
+ "mk-MK",
872
+ "ml",
873
+ "mn",
874
+ "mr-IN",
875
+ "ms-MY",
876
+ "my-MM",
877
+ "nb-NO",
878
+ "nl-NL",
879
+ "pa",
880
+ "pl-PL",
881
+ "pt-BR",
882
+ "pt-PT",
883
+ "ro-RO",
884
+ "ru-RU",
885
+ "sk-SK",
886
+ "sl-SI",
887
+ "so-SO",
888
+ "sq-AL",
889
+ "sr-RS",
890
+ "sv-SE",
891
+ "sw-TZ",
892
+ "ta-IN",
893
+ "te-IN",
894
+ "th-TH",
895
+ "tl",
896
+ "tr-TR",
897
+ "uk-UA",
898
+ "ur",
899
+ "vi-VN",
900
+ "zh-CN",
901
+ "zh-HK",
902
+ "zh-TW"
903
+ ]);
339
904
  const negativeTestCaseSchema = z.object({
340
905
  scenario: z.string(),
341
906
  userPrompt: z.string()
342
907
  }).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
343
908
  const chatgptToolJustificationSchema = z.object({
344
909
  toolName: z.string(),
345
- readOnlyJustification: z.string(),
346
- openWorldJustification: z.string(),
347
- destructiveJustification: z.string()
348
- }).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
910
+ readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
911
+ openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
912
+ 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.\"")
913
+ }).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
914
+ /**
915
+ * Base copy fields, defined once and reused by both the submission form and per-locale
916
+ * translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
917
+ * path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
918
+ */
919
+ const chatgptTaglineSchema = z.string().max(30);
920
+ const chatgptDescriptionSchema = z.string();
349
921
  const chatgptTranslationSchema = z.object({
350
- locale: z.string(),
351
- tagline: z.string().optional(),
352
- description: z.string().optional()
922
+ locale: chatgptTranslationLocaleSchema,
923
+ tagline: chatgptTaglineSchema,
924
+ description: chatgptDescriptionSchema
353
925
  }).describe("Locale-scoped override for tagline + description. English (US) is the default.");
926
+ chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
354
927
  /**
355
928
  * Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
356
929
  * When adding/removing/reordering fields, keep this in sync with the sheet.
@@ -359,25 +932,25 @@ const chatgptSubmissionFormDataSchema = z.object({
359
932
  logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
360
933
  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."),
361
934
  appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
362
- tagline: z.string().max(30).describe("Plain-language phrase focused on function and user value. 30 chars max."),
363
- description: z.string().describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
935
+ tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
936
+ 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)."),
364
937
  category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
365
938
  developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
366
- companyUrl: z.url().describe("Your company's main website URL."),
939
+ companyUrl: urlField.describe("Your company's main website URL."),
367
940
  supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
368
- privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
369
- termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
370
- demoRecordingUrl: z.url().describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
941
+ privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
942
+ termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
943
+ 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."),
371
944
  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."),
372
- serverUrl: z.url().describe("URL of the MCP server."),
945
+ serverUrl: urlField.describe("URL of the MCP server."),
373
946
  authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
374
947
  tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
375
- toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
376
- testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Coverage over all major use cases."),
377
- negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
378
- screenshots: z.array(screenshotEntrySchema).describe("In-app screenshots paired with the user prompt that produced them. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 4 entries. First three are public. Images: 706px wide, 400–860px tall, PNG."),
948
+ 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."),
949
+ 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."),
950
+ 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."),
951
+ 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."),
379
952
  translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
380
- allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
953
+ allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
381
954
  releaseNotes: z.string().describe("Publicly displayed on the app details page.")
382
955
  });
383
956
  chatgptSubmissionFormDataSchema.pick({
@@ -394,9 +967,9 @@ chatgptSubmissionFormDataSchema.pick({
394
967
  testCases: true,
395
968
  negativeTestCases: true,
396
969
  toolJustifications: true
397
- });
970
+ }).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
398
971
  const claudeCategorySchema = z.enum([
399
- "Business & Productivity",
972
+ "Productivity",
400
973
  "Communication",
401
974
  "Data & Analytics",
402
975
  "Development tools",
@@ -404,194 +977,143 @@ const claudeCategorySchema = z.enum([
404
977
  "Consumer Health",
405
978
  "Health & Life Sciences",
406
979
  "Media & Entertainment",
407
- "Commerce & Shopping"
408
- ]);
409
- z.enum([
410
- "No auth needed",
411
- "OAuth 2.0",
412
- "Custom URL"
980
+ "Commerce & Shopping",
981
+ "Legal",
982
+ "Sales and marketing",
983
+ "Creative",
984
+ "Nonprofit",
985
+ "Education",
986
+ "Other"
413
987
  ]);
414
- const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
415
- z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
988
+ const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
416
989
  const claudeReadWriteCapabilitiesSchema = z.enum([
417
- "Read only",
418
- "Write only",
419
- "Read + write"
990
+ "read_only",
991
+ "write_only",
992
+ "read_write"
420
993
  ]);
421
- const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
422
- const claudeThirdPartySchema = z.enum([
423
- "Web access (open web fetch / scraping / arbitrary URLs)",
424
- "Third-party AI model integration",
425
- "Third-party data retrieval (via workflow / aggregator)",
426
- "Third-party data modification (via workflow / aggregator)",
427
- "N/A"
994
+ const claudeAuthenticationSchema = z.enum([
995
+ "oauth_dcr",
996
+ "oauth_cimd",
997
+ "oauth_anthropic_creds",
998
+ "custom_connection",
999
+ "none"
428
1000
  ]);
429
- const claudeDataHandlingSchema = z.enum([
430
- "Server only accesses data explicitly requested by user",
431
- "No data is stored beyond session requirements",
432
- "Data transmission is encrypted (HTTPS / TLS)",
433
- "GDPR compliant (if applicable)"
1001
+ const claudeApiOwnershipSchema = z.enum([
1002
+ "first_party",
1003
+ "proxied",
1004
+ "third_party"
434
1005
  ]);
435
- const claudeSponsoredContentSchema = z.enum([
436
- "No, there is no sponsored content or advertisements",
437
- "Yes, there are banner ads or other paid visual elements",
438
- "Yes, returned content or ranking is impacted by sponsorship or ad placement"
1006
+ const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
1007
+ const claudePolicyAcknowledgementSchema = z.enum([
1008
+ "I have read and understand the MCP Directory developer guidelines.",
1009
+ "My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
1010
+ "My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
1011
+ "My connector does not use AI models to generate images, video, or audio.",
1012
+ "Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
1013
+ "My connector does not collect conversation data beyond what is needed for its function.",
1014
+ "Public documentation for this connector will be live by the publish date."
439
1015
  ]);
440
1016
  /**
441
- * Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
442
- * When adding/removing/reordering fields, keep this in sync with the sheet.
1017
+ * Field order mirrors the claude.ai directory submission wizard
1018
+ * (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
1019
+ * When adding/removing/reordering fields, keep this in sync with the wizard.
443
1020
  */
444
1021
  const claudeSubmissionFormDataSchema = z.object({
445
- companyName: z.string().describe("Enter your company's legal name or the name under which your product is publicly known. This is used for internal tracking and may appear in directory listings."),
446
- companyUrl: z.url().describe("Your company's main website URL, e.g. https://mycompany.com. Must be a valid URL with https://. This should be the root domain of the company behind this MCP server."),
447
- primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. This person will receive review feedback, approval notices, and any follow-up questions."),
448
- primaryContactEmail: z.email().describe("Business email for the primary contact. Must be a valid email address. Anthropic uses this to communicate about your submission status, required changes, and post-listing issues. Avoid using personal email addresses."),
449
- primaryContactRole: z.string().optional().describe("The job title or role of the primary contact (e.g. 'CTO', 'Developer Relations Lead', 'Founder'). Optional but helps Anthropic route questions to the right person."),
450
- anthropicPointOfContact: z.string().optional().describe("If you have a direct contact at Anthropic (e.g. from a partnership or sales conversation), enter their name here. This is optional but can greatly help expedite the review process. Leave blank if you don't have one."),
451
- appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
452
-
453
- Rules:
454
- (1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
455
- (2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
456
- (3) You must own or have the right to use this brand name. For example, don't call it 'Google Drive Helper' if you're not Google.`),
457
- mcpUrlType: claudeMcpUrlTypeSchema.describe(`Choose how your server URL works:
458
- • 'Universal URL': one single URL that all users connect to (most common). Example: https://mcp.myapp.com
459
- • 'Custom MCP URLs': each user gets their own unique URL (e.g. based on their workspace or instance).
460
- If you choose this, you'll need to provide both a signup URL and a regex pattern that matches valid server URLs for your service.`),
461
- serverUrl: z.url().describe(`If 'Universal URL': enter the full https:// URL where your MCP server is hosted and reachable. Example: https://mcp.myapp.com/
462
- If 'Custom MCP URLs': provide (1) the signup/onboarding URL where users create an account, and (2) a regex pattern that matches all valid server URLs for your service (e.g. https://[a-z0-9-]+\\.myapp\\.com/mcp). The server must be publicly accessible without VPN or whitelisting required.`),
463
- tagline: z.string().max(55).describe(`A very short, punchy description shown below your server name in the directory listing. Max 55 characters including spaces.
464
- Think of it as a subtitle or elevator pitch fragment. Example: 'Manage tasks and projects in Linear' or 'Search and read your Notion workspace'. Avoid generic phrases like 'The best MCP server for...'`),
465
- description: z.string().describe(`A 50–100 word description of what your MCP server does. This appears in the connector's detail page inside Claude. Write it from a user perspective: what can users do with this connector? What are the key features/tools? Avoid marketing fluff. Be specific. Example: 'Connect Claude to your Linear workspace. Create and update issues, search projects, manage teams, and track engineering cycles, all from within Claude.' Anthropic reviewers check this for accuracy against your actual tools.`),
466
- testCases: z.array(positiveTestCaseSchema).describe(`Provide at least 3 concrete use cases, each with an example prompt a user could type to Claude. These are critical: Anthropic reviewers literally test your server using these prompts. Good examples are specific and demonstrate real value.
467
- Best format: [Use case]: [exact prompt]"
468
- Example for a task manager:
469
- 1. Create a task: 'Create a task called Review Q3 report, due Friday, assigned to Alice'
470
- 2. Search tasks: 'Show me all open bugs in the Mobile project'
471
- 3. Update status: 'Mark the Deploy v2.1 task as done'"`),
472
- connectionRequirements: z.string().describe(`Describe any prerequisites a user must have before they can connect your server. Be exhaustive. Examples of things to mention:
473
- • Account type required (free vs paid plan)
474
- • Admin permissions or specific roles needed
475
- • Geographic restrictions (e.g. 'US only' or 'Not available in EU')
476
- • If users need to provide their own server URL or instance domain
477
- • Any setup steps needed before connecting (e.g. 'Enable API access in your account settings')
478
- If there are genuinely no special requirements, write exactly: 'No special requirements.'`),
479
- readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`Select the option that best describes what your server can do:
480
-
481
- 'Read Only': your tools only fetch/retrieve data (GET operations). Claude cannot modify anything via your server.
482
- 'Write Only': your tools only create/update/delete data (rare).
483
- 'Read + Write': your tools can both retrieve AND modify data (most common for full-featured connectors).
484
-
485
- Note: Anthropic rejects catch-all tools that accept both safe (GET) and unsafe (POST, PUT, DELETE) HTTP methods via a parameter e.g. a single api_request(method, endpoint) tool. Each tool should have a fixed, specific purpose. `),
486
- isMcpApp: z.boolean().describe(`Select 'Yes' if your MCP server renders interactive UI elements (aka widgets or views) inside the Claude conversation.
487
- Select 'No' if your server only returns text/data responses.
488
- If 'Yes', you will also be required to provide screenshots of your UI (see Promotional Images section). MCP Apps are displayed with a special badge in the directory.`),
489
- thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe(`Multi-select all that apply to your server's behavior:
490
- • 'Web access' — your server fetches arbitrary URLs, scrapes websites, or makes open-ended HTTP requests to the web (not just your own API).
491
- • 'Third-party AI model integration' — your server calls another AI model (e.g. OpenAI, Gemini, Cohere) as part of its processing.
492
- • 'Third-party data retrieval' — your server retrieves data via a workflow or aggregator platform (e.g. Zapier, Make, n8n) rather than calling your own API directly.
493
- • 'Third-party data modification' — your server modifies data via such a platform.
494
- • 'N/A' — your server only calls your own first-party API and does nothing else. Select this only if none of the above apply.`),
495
- dataHandling: z.array(claudeDataHandlingSchema).describe(`Multi-select all data handling practices that accurately apply to your server. You must select at least 3. Key points:
496
- • 'Server only accesses data explicitly requested by user' — your server doesn't silently read unrelated user data.
497
- • 'No data is stored beyond session requirements' — you don't log or retain conversation data after the session.
498
- • 'Data transmission is encrypted (HTTPS/TLS)' — all data in transit is encrypted. This should always apply for remote servers.
499
- • 'GDPR compliant' — if you operate in the EU or serve EU users, check this only if you are genuinely compliant. Don't check it without having proper data processing agreements and procedures in place.
500
- Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
501
- personalDataHealthAccess: z.boolean().describe(`Select 'Yes' ONLY if your connector gives users access to their own personal health information — such as medical records, lab results, diagnoses, prescriptions, wearable health metrics (heart rate, sleep data, etc.), or mental health data.
502
- Select 'No' for the vast majority of business/productivity/dev tools. When in doubt, select 'No'. This field triggers additional compliance review if 'Yes'.`),
503
- categories: z.array(claudeCategorySchema).describe(`Select the category or categories that best describe your connector. This determines where it appears in the directory's browse experience. Choose the most specific fit:
504
- • Business & Productivity — project management, CRM, HR, office tools
505
- • Communication — email, chat, messaging, notifications
506
- • Data & Analytics — dashboards, reporting, databases, BI tools
507
- • Development tools — code repositories, CI/CD, issue trackers, monitoring
508
- • Financial Services — accounting, invoicing, fintech (note: financial transaction execution is not permitted)
509
- • Consumer Health — fitness, wellness, personal health tracking
510
- • Health & Life Sciences — clinical, pharma, medical professional tools
511
- • Media & Entertainment — content, publishing, streaming
512
- • Commerce & Shopping — e-commerce, inventory, orders
513
- Multiple categories are allowed if genuinely applicable.`),
514
- sponsoredContentsOrAdvertisement: claudeSponsoredContentSchema.describe(`Be honest here — advertising is not permitted in the Connectors Directory per Anthropic's policy. Select the option that accurately describes your server:
515
- • 'No, there is no sponsored content or advertisements' — the results your server returns are not influenced by paid placement or sponsorship. This is what almost all connectors should select.
516
- • 'Yes, there are banner ads or other paid visual elements' — your UI includes visual ads. NOTE: this will likely lead to rejection, as Anthropic prohibits advertising in Claude.
517
- • 'Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement' — paid results affect what you return. NOTE: this also likely leads to rejection.
518
- If your server returns organic results from a platform that has ads in its own UI (but your API results are not affected by ads), select 'No'.`),
519
- transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
520
- • 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
521
- • '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.
522
- If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
523
- 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:
524
- • What the connector does and its key capabilities
525
- • How to connect/set it up (step by step)
526
- • What each tool does (or at least the main ones)
527
- • How to troubleshoot common issues
528
- • A support contact or channel
529
- 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.`),
530
- 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:
531
- • What data you collect (and how)
532
- • How you use the collected data
533
- • Where and how long you store it
534
- • Whether you share data with third parties (and who)
535
- • How users can contact you about data concerns
536
- 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.`),
537
- 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:
538
- • Email address (e.g. support@myapp.com)
539
- • Link to a GitHub Issues page
540
- • Link to a help center or support article
541
- • Link to a Discord/Slack community
542
- • Link to your documentation's troubleshooting section
543
- Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
544
- 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:
545
- • The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
546
- • No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
547
- • 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.
548
- • Credentials must remain valid for at least 30 days from submission.
549
- • If your service requires API keys instead of a password, provide those.
550
- Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
551
- 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.
552
- Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
553
- 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.`),
554
- toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
555
- • 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
556
- • '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).
557
- 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.`),
558
- logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
559
- • Format: SVG only
560
- • Aspect ratio: square (1:1)
561
- • Should work on a light background
562
- • Provide via URL (Google Drive link is fine) or upload directly
563
- Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
564
- 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.`),
565
- 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:
566
- • 3–5 images is ideal
567
- • Minimum 1000px width, PNG format preferred
568
- • Each screenshot is paired with the user prompt that produced it
569
- • Crop to just the relevant part of the Claude interface (the tool response area)
570
- • Show your connector doing something impressive and useful — real data, real results
571
- • If you're an MCP App, include screenshots of your interactive UI elements
572
- These images appear in your directory listing and are a key factor in driving user installs.`)
1022
+ 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
1023
+ from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
1024
+ The server must be publicly accessible without VPN or whitelisting.`),
1025
+ 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
1026
+ own or have the right to use this name. Max 100 characters.`),
1027
+ 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.
1028
+ PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
1029
+ oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
1030
+ phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
1031
+ 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
1032
+ claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
1033
+ categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
1034
+ 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
1035
+ (recommended); upload a custom icon only to override it.`),
1036
+ documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
1037
+ accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
1038
+ by your publish date.`),
1039
+ support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
1040
+ used to notify you of security or compliance issues, so make sure it's actively monitored.`),
1041
+ privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
1042
+ what data you collect, how you use and store it, and whether you share it with third parties.`),
1043
+ 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
1044
+ it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
1045
+ primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
1046
+ type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
1047
+ connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
1048
+ permissions'). If there are genuinely no special requirements, say so explicitly.`),
1049
+ readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
1050
+ • 'read_only': retrieves data but never modifies it.
1051
+ • 'write_only': creates or modifies data but does not read it.
1052
+ • 'read_write': both retrieves and modifies data (most common).`),
1053
+ companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
1054
+ companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
1055
+ primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
1056
+ primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
1057
+ primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
1058
+ anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
1059
+ authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
1060
+ • 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
1061
+ • 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
1062
+ • 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
1063
+ • 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
1064
+ • 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
1065
+ partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
1066
+ apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
1067
+ • 'first_party': the MCP server calls your own production APIs.
1068
+ • 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
1069
+ • 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
1070
+ personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
1071
+ No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
1072
+ sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
1073
+ No → false, Yes → true, or { other: explanation }.`),
1074
+ testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
1075
+ the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
1076
+ fully populated account.`),
1077
+ selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
1078
+ policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
1079
+ submission. Each is an attestation you are legally agreeing to by submitting.`),
1080
+ additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
573
1081
  });
574
1082
  claudeSubmissionFormDataSchema.pick({
575
- companyName: true,
576
- appName: true,
577
- mcpUrlType: true,
578
1083
  serverUrl: true,
579
- tools: true,
580
- readWriteCapabilities: true,
581
- isMcpApp: true,
582
- transportSupport: true,
1084
+ name: true,
1085
+ slug: true,
1086
+ companyName: true,
583
1087
  primaryContactEmail: true,
584
- primaryContactName: true
1088
+ primaryContactName: true,
1089
+ readWriteCapabilities: true,
1090
+ authentication: true,
1091
+ apiOwnership: true,
1092
+ personalHealthData: true
1093
+ }).extend({
1094
+ connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
1095
+ testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
585
1096
  });
586
- claudeSubmissionFormDataSchema.pick({
587
- tagline: true,
588
- description: true,
589
- categories: true,
590
- testCases: true
1097
+ /**
1098
+ * Narrative fields the LLM-backed generation step produces for Claude submissions.
1099
+ * This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
1100
+ * the strict form shape. Keep transforms here rather than in callers so generation leniency is
1101
+ * colocated with the Claude contract.
1102
+ */
1103
+ const claudeAiGeneratedFormDataRawSchema = z.object({
1104
+ oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
1105
+ description: claudeSubmissionFormDataSchema.shape.description,
1106
+ categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
1107
+ primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
1108
+ });
1109
+ claudeAiGeneratedFormDataRawSchema.extend({
1110
+ oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
1111
+ categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
591
1112
  });
592
1113
  const submissionMetaFieldsSchema = z.object({
593
1114
  id: z.string(),
594
1115
  environmentId: z.string(),
1116
+ auditId: z.string().nullable(),
595
1117
  createdAt: z.coerce.date(),
596
1118
  updatedAt: z.coerce.date()
597
1119
  });
@@ -628,6 +1150,12 @@ z.object({
628
1150
  partnerDiscount: partnerDiscountSchema.nullable()
629
1151
  });
630
1152
  //#endregion
1153
+ //#region src/auth-scope.ts
1154
+ /** Accepts an API key or OAuth access token (default for most routes). */
1155
+ const AUTH_SCOPE_ANY = "any";
1156
+ /** Requires a user OAuth access token; API keys are not accepted. */
1157
+ const AUTH_SCOPE_USER = "user";
1158
+ //#endregion
631
1159
  //#region src/schemas.ts
632
1160
  const RESERVED_KEYS = [
633
1161
  "_HANDLER",
@@ -767,7 +1295,7 @@ const createEnvironmentContractV1 = oc.route({
767
1295
  id: z.string(),
768
1296
  name: z.string(),
769
1297
  sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
770
- urls: z.array(z.string().url()).describe("The URLs of the MCP server"),
1298
+ urls: z.array(z.url()).describe("The URLs of the MCP server"),
771
1299
  createdAt: z.coerce.date(),
772
1300
  projectId: z.string().describe("The ID of the project the environment belongs to")
773
1301
  }));
@@ -843,6 +1371,9 @@ const listProjectsContractV1 = oc.route({
843
1371
  description: "List all projects for a team",
844
1372
  tags: ["projects"],
845
1373
  successDescription: "The list of projects"
1374
+ }).errors({
1375
+ NOT_FOUND: {},
1376
+ BAD_REQUEST: {}
846
1377
  }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
847
1378
  const createProjectContractV1 = oc.route({
848
1379
  path: "/v1/projects",
@@ -853,7 +1384,8 @@ const createProjectContractV1 = oc.route({
853
1384
  successDescription: "The project has been created successfully"
854
1385
  }).errors({
855
1386
  NOT_FOUND: {},
856
- BAD_REQUEST: {}
1387
+ BAD_REQUEST: {},
1388
+ FORBIDDEN: {}
857
1389
  }).input(z.object({
858
1390
  teamId: z.string().optional(),
859
1391
  name: z.string().trim().min(1).max(100),
@@ -938,7 +1470,10 @@ const deleteEnvironmentVariableContractV1 = oc.route({
938
1470
  description: "Delete an environment variable by ID",
939
1471
  tags: ["environments"],
940
1472
  successDescription: "The environment variable has been deleted successfully"
941
- }).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
1473
+ }).errors({
1474
+ NOT_FOUND: {},
1475
+ BAD_REQUEST: {}
1476
+ }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
942
1477
  const deleteProjectContractV1 = oc.route({
943
1478
  path: "/v1/projects/{projectId}",
944
1479
  method: "DELETE",
@@ -956,7 +1491,8 @@ const updateProjectContractV1 = oc.route({
956
1491
  successDescription: "The project has been updated successfully"
957
1492
  }).errors({
958
1493
  NOT_FOUND: {},
959
- BAD_REQUEST: {}
1494
+ BAD_REQUEST: {},
1495
+ FORBIDDEN: {}
960
1496
  }).input(z.object({
961
1497
  projectId: z.string().describe("The ID of the project"),
962
1498
  name: z.string().min(1).max(100).optional().describe("The new name for the project"),
@@ -983,6 +1519,9 @@ const uploadDeploymentArtifactContractV1 = oc.route({
983
1519
  description: "Return a presigned S3 URL to upload a deployment artifact",
984
1520
  tags: ["deployments"],
985
1521
  successDescription: "The presigned upload URL has been generated successfully"
1522
+ }).errors({
1523
+ NOT_FOUND: {},
1524
+ BAD_REQUEST: {}
986
1525
  }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
987
1526
  uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
988
1527
  token: z.string().describe("Token to identify the source archive"),
@@ -1156,7 +1695,7 @@ const getTunnelTicketContractV1 = oc.route({
1156
1695
  description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
1157
1696
  tags: ["tunnels"],
1158
1697
  successDescription: "The tunnel ticket"
1159
- }).output(z.object({
1698
+ }).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
1160
1699
  subdomain: z.string().describe("The subdomain assigned to the user"),
1161
1700
  ticket: z.string().describe("The signed tunnel ticket"),
1162
1701
  tunnelHost: z.string().describe("The tunnel host to connect to")
@@ -1310,4 +1849,4 @@ const contract = {
1310
1849
  }
1311
1850
  };
1312
1851
  //#endregion
1313
- export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
1852
+ export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };