@alpic-ai/api 0.0.0-dev.ge8867f0 → 0.0.0-dev.gea1c14d

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(),
@@ -260,7 +510,7 @@ z.object({
260
510
  productionEnvironment: environmentWithDomainsSchema.nullable()
261
511
  });
262
512
  z.object({
263
- domain: z.string(),
513
+ name: z.string(),
264
514
  createdAt: z.coerce.date(),
265
515
  status: z.enum([
266
516
  "ongoing",
@@ -324,10 +574,10 @@ const toolDefinitionSchema = z.object({
324
574
  }).optional()
325
575
  });
326
576
  const positiveTestCaseSchema = z.object({
327
- scenario: z.string(),
328
- userPrompt: z.string(),
329
- toolTriggered: z.string().optional(),
330
- expectedOutput: z.string().optional()
577
+ scenario: z.string().describe("Short label for what this case demonstrates."),
578
+ 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."),
579
+ toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
580
+ expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
331
581
  }).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
332
582
  const screenshotEntrySchema = z.object({
333
583
  prompt: z.string(),
@@ -335,6 +585,8 @@ const screenshotEntrySchema = z.object({
335
585
  }).describe("Each screenshot: the user prompt that produced it + the image URL.");
336
586
  /** Accepts either a valid email or URL. */
337
587
  const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
588
+ /** A URL field whose error spells out that the scheme is required. */
589
+ const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
338
590
  const chatgptCategorySchema = z.enum([
339
591
  "BUSINESS",
340
592
  "COLLABORATION",
@@ -351,22 +603,315 @@ const chatgptCategorySchema = z.enum([
351
603
  "TRAVEL"
352
604
  ]);
353
605
  const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
354
- const chatgptAllowedCountriesSchema = z.enum(["Allow all", "Restrict to specific countries"]);
606
+ const chatgptCountryCodeSchema = z.enum([
607
+ "AD",
608
+ "AE",
609
+ "AF",
610
+ "AG",
611
+ "AL",
612
+ "AM",
613
+ "AO",
614
+ "AR",
615
+ "AT",
616
+ "AU",
617
+ "AW",
618
+ "AX",
619
+ "AZ",
620
+ "BA",
621
+ "BB",
622
+ "BD",
623
+ "BE",
624
+ "BF",
625
+ "BG",
626
+ "BH",
627
+ "BI",
628
+ "BJ",
629
+ "BL",
630
+ "BM",
631
+ "BN",
632
+ "BO",
633
+ "BR",
634
+ "BS",
635
+ "BT",
636
+ "BW",
637
+ "BZ",
638
+ "CA",
639
+ "CD",
640
+ "CF",
641
+ "CG",
642
+ "CH",
643
+ "CI",
644
+ "CL",
645
+ "CM",
646
+ "CO",
647
+ "CR",
648
+ "CV",
649
+ "CY",
650
+ "CZ",
651
+ "DE",
652
+ "DJ",
653
+ "DK",
654
+ "DM",
655
+ "DO",
656
+ "DZ",
657
+ "EC",
658
+ "EE",
659
+ "EG",
660
+ "ER",
661
+ "ES",
662
+ "ET",
663
+ "FI",
664
+ "FJ",
665
+ "FM",
666
+ "FO",
667
+ "FR",
668
+ "GA",
669
+ "GB",
670
+ "GD",
671
+ "GE",
672
+ "GF",
673
+ "GH",
674
+ "GL",
675
+ "GM",
676
+ "GN",
677
+ "GP",
678
+ "GQ",
679
+ "GR",
680
+ "GT",
681
+ "GW",
682
+ "GY",
683
+ "HN",
684
+ "HR",
685
+ "HT",
686
+ "HU",
687
+ "ID",
688
+ "IE",
689
+ "IL",
690
+ "IN",
691
+ "IQ",
692
+ "IS",
693
+ "IT",
694
+ "JM",
695
+ "JO",
696
+ "JP",
697
+ "KE",
698
+ "KG",
699
+ "KH",
700
+ "KI",
701
+ "KM",
702
+ "KN",
703
+ "KR",
704
+ "KW",
705
+ "KY",
706
+ "KZ",
707
+ "LA",
708
+ "LB",
709
+ "LC",
710
+ "LI",
711
+ "LK",
712
+ "LR",
713
+ "LS",
714
+ "LT",
715
+ "LU",
716
+ "LV",
717
+ "LY",
718
+ "MA",
719
+ "MC",
720
+ "MD",
721
+ "ME",
722
+ "MF",
723
+ "MG",
724
+ "MH",
725
+ "MK",
726
+ "ML",
727
+ "MM",
728
+ "MN",
729
+ "MQ",
730
+ "MR",
731
+ "MT",
732
+ "MU",
733
+ "MV",
734
+ "MW",
735
+ "MX",
736
+ "MY",
737
+ "MZ",
738
+ "NA",
739
+ "NC",
740
+ "NE",
741
+ "NG",
742
+ "NI",
743
+ "NL",
744
+ "NO",
745
+ "NP",
746
+ "NR",
747
+ "NZ",
748
+ "OM",
749
+ "PA",
750
+ "PE",
751
+ "PF",
752
+ "PG",
753
+ "PH",
754
+ "PK",
755
+ "PL",
756
+ "PM",
757
+ "PS",
758
+ "PT",
759
+ "PW",
760
+ "PY",
761
+ "QA",
762
+ "RE",
763
+ "RO",
764
+ "RS",
765
+ "RW",
766
+ "SA",
767
+ "SB",
768
+ "SC",
769
+ "SD",
770
+ "SE",
771
+ "SG",
772
+ "SH",
773
+ "SI",
774
+ "SJ",
775
+ "SK",
776
+ "SL",
777
+ "SM",
778
+ "SN",
779
+ "SO",
780
+ "SR",
781
+ "SS",
782
+ "ST",
783
+ "SV",
784
+ "SZ",
785
+ "TD",
786
+ "TF",
787
+ "TG",
788
+ "TH",
789
+ "TJ",
790
+ "TL",
791
+ "TM",
792
+ "TN",
793
+ "TO",
794
+ "TR",
795
+ "TT",
796
+ "TV",
797
+ "TW",
798
+ "TZ",
799
+ "UA",
800
+ "UG",
801
+ "US",
802
+ "UY",
803
+ "UZ",
804
+ "VA",
805
+ "VC",
806
+ "VN",
807
+ "VU",
808
+ "WF",
809
+ "WS",
810
+ "YE",
811
+ "YT",
812
+ "ZA",
813
+ "ZM",
814
+ "ZW"
815
+ ]);
816
+ const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
817
+ z.object({ mode: z.literal("all") }),
818
+ z.object({
819
+ mode: z.literal("allow"),
820
+ countries: z.array(chatgptCountryCodeSchema)
821
+ }),
822
+ z.object({
823
+ mode: z.literal("block"),
824
+ countries: z.array(chatgptCountryCodeSchema)
825
+ })
826
+ ]);
827
+ const chatgptTranslationLocaleSchema = z.enum([
828
+ "am",
829
+ "ar",
830
+ "bg-BG",
831
+ "bn-BD",
832
+ "bs-BA",
833
+ "ca-ES",
834
+ "cs-CZ",
835
+ "da-DK",
836
+ "de-DE",
837
+ "el-GR",
838
+ "es-419",
839
+ "es-ES",
840
+ "et-EE",
841
+ "fi-FI",
842
+ "fr-CA",
843
+ "fr-FR",
844
+ "gu-IN",
845
+ "hi-IN",
846
+ "hr-HR",
847
+ "hu-HU",
848
+ "hy-AM",
849
+ "id-ID",
850
+ "is-IS",
851
+ "it-IT",
852
+ "ja-JP",
853
+ "ka-GE",
854
+ "kk",
855
+ "kn-IN",
856
+ "ko-KR",
857
+ "lt",
858
+ "lv-LV",
859
+ "mk-MK",
860
+ "ml",
861
+ "mn",
862
+ "mr-IN",
863
+ "ms-MY",
864
+ "my-MM",
865
+ "nb-NO",
866
+ "nl-NL",
867
+ "pa",
868
+ "pl-PL",
869
+ "pt-BR",
870
+ "pt-PT",
871
+ "ro-RO",
872
+ "ru-RU",
873
+ "sk-SK",
874
+ "sl-SI",
875
+ "so-SO",
876
+ "sq-AL",
877
+ "sr-RS",
878
+ "sv-SE",
879
+ "sw-TZ",
880
+ "ta-IN",
881
+ "te-IN",
882
+ "th-TH",
883
+ "tl",
884
+ "tr-TR",
885
+ "uk-UA",
886
+ "ur",
887
+ "vi-VN",
888
+ "zh-CN",
889
+ "zh-HK",
890
+ "zh-TW"
891
+ ]);
355
892
  const negativeTestCaseSchema = z.object({
356
893
  scenario: z.string(),
357
894
  userPrompt: z.string()
358
895
  }).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
359
896
  const chatgptToolJustificationSchema = z.object({
360
897
  toolName: z.string(),
361
- readOnlyJustification: z.string(),
362
- openWorldJustification: z.string(),
363
- destructiveJustification: z.string()
364
- }).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
898
+ readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
899
+ openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
900
+ 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.\"")
901
+ }).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
902
+ /**
903
+ * Base copy fields, defined once and reused by both the submission form and per-locale
904
+ * translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
905
+ * path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
906
+ */
907
+ const chatgptTaglineSchema = z.string().max(30);
908
+ const chatgptDescriptionSchema = z.string();
365
909
  const chatgptTranslationSchema = z.object({
366
- locale: z.string(),
367
- tagline: z.string().optional(),
368
- description: z.string().optional()
910
+ locale: chatgptTranslationLocaleSchema,
911
+ tagline: chatgptTaglineSchema,
912
+ description: chatgptDescriptionSchema
369
913
  }).describe("Locale-scoped override for tagline + description. English (US) is the default.");
914
+ chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
370
915
  /**
371
916
  * Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
372
917
  * When adding/removing/reordering fields, keep this in sync with the sheet.
@@ -375,25 +920,25 @@ const chatgptSubmissionFormDataSchema = z.object({
375
920
  logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
376
921
  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."),
377
922
  appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
378
- tagline: z.string().max(30).describe("Plain-language phrase focused on function and user value. 30 chars max."),
379
- description: z.string().describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
923
+ tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
924
+ 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)."),
380
925
  category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
381
926
  developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
382
- companyUrl: z.url().describe("Your company's main website URL."),
927
+ companyUrl: urlField.describe("Your company's main website URL."),
383
928
  supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
384
- privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
385
- termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
386
- 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."),
929
+ privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
930
+ termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
931
+ 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."),
387
932
  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."),
388
- serverUrl: z.url().describe("URL of the MCP server."),
933
+ serverUrl: urlField.describe("URL of the MCP server."),
389
934
  authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
390
935
  tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
391
- toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
392
- 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."),
393
- negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
394
- 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."),
936
+ 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."),
937
+ 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."),
938
+ 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."),
939
+ 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."),
395
940
  translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
396
- allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
941
+ allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
397
942
  releaseNotes: z.string().describe("Publicly displayed on the app details page.")
398
943
  });
399
944
  chatgptSubmissionFormDataSchema.pick({
@@ -412,7 +957,7 @@ chatgptSubmissionFormDataSchema.pick({
412
957
  toolJustifications: true
413
958
  }).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
414
959
  const claudeCategorySchema = z.enum([
415
- "Business & Productivity",
960
+ "Productivity",
416
961
  "Communication",
417
962
  "Data & Analytics",
418
963
  "Development tools",
@@ -420,208 +965,143 @@ const claudeCategorySchema = z.enum([
420
965
  "Consumer Health",
421
966
  "Health & Life Sciences",
422
967
  "Media & Entertainment",
423
- "Commerce & Shopping"
968
+ "Commerce & Shopping",
969
+ "Legal",
970
+ "Sales and marketing",
971
+ "Creative",
972
+ "Nonprofit",
973
+ "Education",
974
+ "Other"
424
975
  ]);
425
- const claudeAuthenticationSchema = z.enum([
426
- "No auth needed",
427
- "OAuth 2.0",
428
- "Custom URL"
429
- ]);
430
- const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
431
- z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
976
+ const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
432
977
  const claudeReadWriteCapabilitiesSchema = z.enum([
433
- "Read Only",
434
- "Write Only",
435
- "Read + Write"
436
- ]);
437
- const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
438
- const claudeTestedSurfaceSchema = z.enum([
439
- "Claude.ai (web)",
440
- "Claude Desktop",
441
- "Claude Code",
442
- "Cowork"
978
+ "read_only",
979
+ "write_only",
980
+ "read_write"
443
981
  ]);
444
- const claudeThirdPartySchema = z.enum([
445
- "Web access: Fetches information from the open web (e.g., web scraping, search engines, or browsing arbitrary URLs, not just connecting to a specific API)",
446
- "Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
447
- "Third-party data retrieval: Connects to external services that themselves retrieve data from other sources (e.g., workflow automation platforms or other services that aggregate or relay data from multiple third-party sources)",
448
- "Third-party data modification: Can connect to external services that themselves create, update, or delete data in other sources (e.g., workflow automation platforms or other services that write to multiple third-party sources)",
449
- "N/A"
982
+ const claudeAuthenticationSchema = z.enum([
983
+ "oauth_dcr",
984
+ "oauth_cimd",
985
+ "oauth_anthropic_creds",
986
+ "custom_connection",
987
+ "none"
450
988
  ]);
451
- const claudeDataHandlingSchema = z.enum([
452
- "Server only accesses data explicitly requested by user",
453
- "No data is stored beyond session requirements",
454
- "Data transmission is encrypted (HTTPS/TLS)",
455
- "GDPR compliant (if applicable)"
989
+ const claudeApiOwnershipSchema = z.enum([
990
+ "first_party",
991
+ "proxied",
992
+ "third_party"
456
993
  ]);
457
- const claudeSponsoredContentSchema = z.enum([
458
- "No, there is no sponsored content or advertisements",
459
- "Yes, there are banner ads or other paid visual elements",
460
- "Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement"
994
+ const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
995
+ const claudePolicyAcknowledgementSchema = z.enum([
996
+ "I have read and understand the MCP Directory developer guidelines.",
997
+ "My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
998
+ "My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
999
+ "My connector does not use AI models to generate images, video, or audio.",
1000
+ "Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
1001
+ "My connector does not collect conversation data beyond what is needed for its function.",
1002
+ "Public documentation for this connector will be live by the publish date."
461
1003
  ]);
462
1004
  /**
463
- * Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
464
- * When adding/removing/reordering fields, keep this in sync with the sheet.
1005
+ * Field order mirrors the claude.ai directory submission wizard
1006
+ * (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
1007
+ * When adding/removing/reordering fields, keep this in sync with the wizard.
465
1008
  */
466
1009
  const claudeSubmissionFormDataSchema = z.object({
467
- 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."),
468
- 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."),
469
- 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."),
470
- 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."),
471
- 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."),
472
- 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."),
473
- appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
474
-
475
- Rules:
476
- (1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
477
- (2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
478
- (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.`),
479
- mcpUrlType: claudeMcpUrlTypeSchema.describe(`Choose how your server URL works:
480
- • 'Universal URL': one single URL that all users connect to (most common). Example: https://mcp.myapp.com
481
- • 'Custom MCP URLs': each user gets their own unique URL (e.g. based on their workspace or instance).
482
- 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.`),
483
- 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/
484
- 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.`),
485
- 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.
486
- 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...'`),
487
- 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.`),
488
- 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.
489
- Best format: [Use case]: [exact prompt]"
490
- Example for a task manager:
491
- 1. Create a task: 'Create a task called Review Q3 report, due Friday, assigned to Alice'
492
- 2. Search tasks: 'Show me all open bugs in the Mobile project'
493
- 3. Update status: 'Mark the Deploy v2.1 task as done'"`),
494
- connectionRequirements: z.string().describe(`Describe any prerequisites a user must have before they can connect your server. Be exhaustive. Examples of things to mention:
495
- • Account type required (free vs paid plan)
496
- • Admin permissions or specific roles needed
497
- • Geographic restrictions (e.g. 'US only' or 'Not available in EU')
498
- • If users need to provide their own server URL or instance domain
499
- • Any setup steps needed before connecting (e.g. 'Enable API access in your account settings')
500
- If there are genuinely no special requirements, write exactly: 'No special requirements.'`),
501
- readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`Select the option that best describes what your server can do:
502
-
503
- 'Read Only': your tools only fetch/retrieve data (GET operations). Claude cannot modify anything via your server.
504
- 'Write Only': your tools only create/update/delete data (rare).
505
- 'Read + Write': your tools can both retrieve AND modify data (most common for full-featured connectors).
506
-
507
- 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. `),
508
- isMcpApp: z.boolean().describe(`Select 'Yes' if your MCP server renders interactive UI elements (aka widgets or views) inside the Claude conversation.
509
- Select 'No' if your server only returns text/data responses.
510
- 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.`),
511
- thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe(`Multi-select all that apply to your server's behavior:
512
- • 'Web access' — your server fetches arbitrary URLs, scrapes websites, or makes open-ended HTTP requests to the web (not just your own API).
513
- • 'Third-party AI model integration' — your server calls another AI model (e.g. OpenAI, Gemini, Cohere) as part of its processing.
514
- • '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.
515
- • 'Third-party data modification' — your server modifies data via such a platform.
516
- • 'N/A' — your server only calls your own first-party API and does nothing else. Select this only if none of the above apply.`),
517
- 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:
518
- • 'Server only accesses data explicitly requested by user' — your server doesn't silently read unrelated user data.
519
- • 'No data is stored beyond session requirements' — you don't log or retain conversation data after the session.
520
- • 'Data transmission is encrypted (HTTPS/TLS)' — all data in transit is encrypted. This should always apply for remote servers.
521
- • '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.
522
- Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
523
- 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.
524
- Select 'No' for the vast majority of business/productivity/dev tools. When in doubt, select 'No'. This field triggers additional compliance review if 'Yes'.`),
525
- category: claudeCategorySchema.describe(`Select the category that best describes your connector. This determines where it appears in the directory's browse experience. Choose the most specific fit:
526
- • Business & Productivity — project management, CRM, HR, office tools
527
- • Communication — email, chat, messaging, notifications
528
- • Data & Analytics — dashboards, reporting, databases, BI tools
529
- • Development tools — code repositories, CI/CD, issue trackers, monitoring
530
- • Financial Services — accounting, invoicing, fintech (note: financial transaction execution is not permitted)
531
- • Consumer Health — fitness, wellness, personal health tracking
532
- • Health & Life Sciences — clinical, pharma, medical professional tools
533
- • Media & Entertainment — content, publishing, streaming
534
- • Commerce & Shopping — e-commerce, inventory, orders
535
- Anthropic's submission form only accepts a single category.`),
536
- 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:
537
- • '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.
538
- • '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.
539
- • '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.
540
- 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'.`),
541
- authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
542
- transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
543
- • 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
544
- • '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.
545
- If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
546
- 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:
547
- • What the connector does and its key capabilities
548
- • How to connect/set it up (step by step)
549
- • What each tool does (or at least the main ones)
550
- • How to troubleshoot common issues
551
- • A support contact or channel
552
- 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.`),
553
- 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:
554
- • What data you collect (and how)
555
- • How you use the collected data
556
- • Where and how long you store it
557
- • Whether you share data with third parties (and who)
558
- • How users can contact you about data concerns
559
- 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.`),
560
- 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:
561
- • Email address (e.g. support@myapp.com)
562
- • Link to a GitHub Issues page
563
- • Link to a help center or support article
564
- • Link to a Discord/Slack community
565
- • Link to your documentation's troubleshooting section
566
- Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
567
- 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:
568
- • The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
569
- • No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
570
- • 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.
571
- • Credentials must remain valid for at least 30 days from submission.
572
- • If your service requires API keys instead of a password, provide those.
573
- Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
574
- 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.
575
- Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
576
- 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.`),
577
- toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
578
- • 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
579
- • '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).
580
- 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.`),
581
- testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
582
- logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
583
- • Format: SVG only
584
- • Aspect ratio: square (1:1)
585
- • Should work on a light background
586
- • Provide via URL (Google Drive link is fine) or upload directly
587
- Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
588
- 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.`),
589
- 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:
590
- • 3–5 images is ideal
591
- • Minimum 1000px width, PNG format preferred
592
- • Each screenshot is paired with the user prompt that produced it
593
- • Crop to just the relevant part of the Claude interface (the tool response area)
594
- • Show your connector doing something impressive and useful — real data, real results
595
- • If you're an MCP App, include screenshots of your interactive UI elements
596
- These images appear in your directory listing and are a key factor in driving user installs.`)
1010
+ 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
1011
+ from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
1012
+ The server must be publicly accessible without VPN or whitelisting.`),
1013
+ 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
1014
+ own or have the right to use this name. Max 100 characters.`),
1015
+ 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.
1016
+ PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
1017
+ oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
1018
+ phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
1019
+ 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
1020
+ claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
1021
+ categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
1022
+ 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
1023
+ (recommended); upload a custom icon only to override it.`),
1024
+ documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
1025
+ accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
1026
+ by your publish date.`),
1027
+ support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
1028
+ used to notify you of security or compliance issues, so make sure it's actively monitored.`),
1029
+ privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
1030
+ what data you collect, how you use and store it, and whether you share it with third parties.`),
1031
+ 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
1032
+ it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
1033
+ primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
1034
+ type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
1035
+ connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
1036
+ permissions'). If there are genuinely no special requirements, say so explicitly.`),
1037
+ readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
1038
+ • 'read_only': retrieves data but never modifies it.
1039
+ • 'write_only': creates or modifies data but does not read it.
1040
+ • 'read_write': both retrieves and modifies data (most common).`),
1041
+ companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
1042
+ companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
1043
+ primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
1044
+ primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
1045
+ primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
1046
+ anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
1047
+ authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
1048
+ • 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
1049
+ • 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
1050
+ • 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
1051
+ • 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
1052
+ • 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
1053
+ partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
1054
+ apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
1055
+ • 'first_party': the MCP server calls your own production APIs.
1056
+ • 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
1057
+ • 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
1058
+ personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
1059
+ No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
1060
+ sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
1061
+ No → false, Yes → true, or { other: explanation }.`),
1062
+ testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
1063
+ the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
1064
+ fully populated account.`),
1065
+ selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
1066
+ policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
1067
+ submission. Each is an attestation you are legally agreeing to by submitting.`),
1068
+ additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
597
1069
  });
598
1070
  claudeSubmissionFormDataSchema.pick({
599
- companyName: true,
600
- appName: true,
601
- mcpUrlType: true,
602
1071
  serverUrl: true,
603
- tools: true,
604
- readWriteCapabilities: true,
605
- isMcpApp: true,
606
- transportSupport: true,
1072
+ name: true,
1073
+ slug: true,
1074
+ companyName: true,
607
1075
  primaryContactEmail: true,
608
1076
  primaryContactName: true,
1077
+ readWriteCapabilities: true,
609
1078
  authentication: true,
610
- personalDataHealthAccess: true,
611
- testedSurfaces: true
1079
+ apiOwnership: true,
1080
+ personalHealthData: true
612
1081
  }).extend({
613
1082
  connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
614
- testingCredentials: claudeSubmissionFormDataSchema.shape.testingCredentials.optional()
1083
+ testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
1084
+ });
1085
+ /**
1086
+ * Narrative fields the LLM-backed generation step produces for Claude submissions.
1087
+ * This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
1088
+ * the strict form shape. Keep transforms here rather than in callers so generation leniency is
1089
+ * colocated with the Claude contract.
1090
+ */
1091
+ const claudeAiGeneratedFormDataRawSchema = z.object({
1092
+ oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
1093
+ description: claudeSubmissionFormDataSchema.shape.description,
1094
+ categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
1095
+ primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
1096
+ });
1097
+ claudeAiGeneratedFormDataRawSchema.extend({
1098
+ oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
1099
+ categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
615
1100
  });
616
- claudeSubmissionFormDataSchema.pick({
617
- tagline: true,
618
- description: true,
619
- category: true,
620
- testCases: true
621
- }).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
622
1101
  const submissionMetaFieldsSchema = z.object({
623
1102
  id: z.string(),
624
1103
  environmentId: z.string(),
1104
+ auditId: z.string().nullable(),
625
1105
  createdAt: z.coerce.date(),
626
1106
  updatedAt: z.coerce.date()
627
1107
  });
@@ -658,6 +1138,12 @@ z.object({
658
1138
  partnerDiscount: partnerDiscountSchema.nullable()
659
1139
  });
660
1140
  //#endregion
1141
+ //#region src/auth-scope.ts
1142
+ /** Accepts an API key or OAuth access token (default for most routes). */
1143
+ const AUTH_SCOPE_ANY = "any";
1144
+ /** Requires a user OAuth access token; API keys are not accepted. */
1145
+ const AUTH_SCOPE_USER = "user";
1146
+ //#endregion
661
1147
  //#region src/schemas.ts
662
1148
  const RESERVED_KEYS = [
663
1149
  "_HANDLER",
@@ -797,7 +1283,7 @@ const createEnvironmentContractV1 = oc.route({
797
1283
  id: z.string(),
798
1284
  name: z.string(),
799
1285
  sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
800
- urls: z.array(z.string().url()).describe("The URLs of the MCP server"),
1286
+ urls: z.array(z.url()).describe("The URLs of the MCP server"),
801
1287
  createdAt: z.coerce.date(),
802
1288
  projectId: z.string().describe("The ID of the project the environment belongs to")
803
1289
  }));
@@ -873,6 +1359,9 @@ const listProjectsContractV1 = oc.route({
873
1359
  description: "List all projects for a team",
874
1360
  tags: ["projects"],
875
1361
  successDescription: "The list of projects"
1362
+ }).errors({
1363
+ NOT_FOUND: {},
1364
+ BAD_REQUEST: {}
876
1365
  }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
877
1366
  const createProjectContractV1 = oc.route({
878
1367
  path: "/v1/projects",
@@ -883,7 +1372,8 @@ const createProjectContractV1 = oc.route({
883
1372
  successDescription: "The project has been created successfully"
884
1373
  }).errors({
885
1374
  NOT_FOUND: {},
886
- BAD_REQUEST: {}
1375
+ BAD_REQUEST: {},
1376
+ FORBIDDEN: {}
887
1377
  }).input(z.object({
888
1378
  teamId: z.string().optional(),
889
1379
  name: z.string().trim().min(1).max(100),
@@ -968,7 +1458,10 @@ const deleteEnvironmentVariableContractV1 = oc.route({
968
1458
  description: "Delete an environment variable by ID",
969
1459
  tags: ["environments"],
970
1460
  successDescription: "The environment variable has been deleted successfully"
971
- }).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
1461
+ }).errors({
1462
+ NOT_FOUND: {},
1463
+ BAD_REQUEST: {}
1464
+ }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
972
1465
  const deleteProjectContractV1 = oc.route({
973
1466
  path: "/v1/projects/{projectId}",
974
1467
  method: "DELETE",
@@ -986,7 +1479,8 @@ const updateProjectContractV1 = oc.route({
986
1479
  successDescription: "The project has been updated successfully"
987
1480
  }).errors({
988
1481
  NOT_FOUND: {},
989
- BAD_REQUEST: {}
1482
+ BAD_REQUEST: {},
1483
+ FORBIDDEN: {}
990
1484
  }).input(z.object({
991
1485
  projectId: z.string().describe("The ID of the project"),
992
1486
  name: z.string().min(1).max(100).optional().describe("The new name for the project"),
@@ -1013,6 +1507,9 @@ const uploadDeploymentArtifactContractV1 = oc.route({
1013
1507
  description: "Return a presigned S3 URL to upload a deployment artifact",
1014
1508
  tags: ["deployments"],
1015
1509
  successDescription: "The presigned upload URL has been generated successfully"
1510
+ }).errors({
1511
+ NOT_FOUND: {},
1512
+ BAD_REQUEST: {}
1016
1513
  }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
1017
1514
  uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
1018
1515
  token: z.string().describe("Token to identify the source archive"),
@@ -1186,7 +1683,7 @@ const getTunnelTicketContractV1 = oc.route({
1186
1683
  description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
1187
1684
  tags: ["tunnels"],
1188
1685
  successDescription: "The tunnel ticket"
1189
- }).output(z.object({
1686
+ }).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
1190
1687
  subdomain: z.string().describe("The subdomain assigned to the user"),
1191
1688
  ticket: z.string().describe("The signed tunnel ticket"),
1192
1689
  tunnelHost: z.string().describe("The tunnel host to connect to")
@@ -1262,7 +1759,7 @@ const upsertPlaygroundContractV1 = oc.route({
1262
1759
  name: z.string().min(1).max(100).optional(),
1263
1760
  description: z.string().min(1).max(500).optional(),
1264
1761
  headers: z.array(playgroundHeaderSchema).optional(),
1265
- examplePrompts: z.array(playgroundExamplePromptSchema).max(3).optional()
1762
+ examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
1266
1763
  })).output(playgroundOutputSchema);
1267
1764
  const createBeaconContractV1 = oc.route({
1268
1765
  path: "/v1/beacon/audits",
@@ -1340,4 +1837,4 @@ const contract = {
1340
1837
  }
1341
1838
  };
1342
1839
  //#endregion
1343
- export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
1840
+ export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };