@alpic-ai/api 0.0.0-dev.gff1b65e → 0.0.0-dev.gff7fdac

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.
Files changed (3) hide show
  1. package/dist/index.d.mts +1087 -77
  2. package/dist/index.mjs +882 -352
  3. package/package.json +23 -7
package/dist/index.mjs CHANGED
@@ -2,7 +2,7 @@ import { z } from "zod";
2
2
  import * as z$1 from "zod/v4";
3
3
  import { oc } from "@orpc/contract";
4
4
  import ms from "ms";
5
- //#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.29.0_@cfworker+json-schema@4.1.1_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
5
+ //#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
6
6
  /**
7
7
  * Reusable URL validation that disallows javascript: scheme
8
8
  */
@@ -169,11 +169,21 @@ z$1.object({
169
169
  token: z$1.string(),
170
170
  token_type_hint: z$1.string().optional()
171
171
  }).strip();
172
- const platformSchema = z.enum(["chatgpt", "claudeai"]);
172
+ //#endregion
173
+ //#region ../domains/dist/index.mjs
174
+ const AI_PLATFORMS = ["chatgpt", "claudeai"];
175
+ const platformSchema = z.enum(AI_PLATFORMS);
173
176
  const PLATFORM_LABELS = {
174
177
  chatgpt: "ChatGPT",
175
178
  claudeai: "Claude.ai"
176
179
  };
180
+ const WAF_PLATFORMS = [
181
+ "akamai",
182
+ "cloudflare",
183
+ "fastly"
184
+ ];
185
+ const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
186
+ const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
177
187
  const auditStatusSchema = z.enum([
178
188
  "pending",
179
189
  "partial",
@@ -273,34 +283,51 @@ const deploymentSummarySchema = z.object({
273
283
  createdAt: z.coerce.date(),
274
284
  updatedAt: z.coerce.date()
275
285
  });
276
- /**
277
- * Public environment
278
- *
279
- * No OAuth metadata exposed.
280
- */
286
+ /** Public environment: answers anonymously and exposes no OAuth metadata. */
281
287
  const publicEnvironmentSchema = z.object({
288
+ allowsAnonymous: z.literal(true),
289
+ oAuthMetadata: z.strictObject({})
290
+ });
291
+ /** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
292
+ const externalResourceMetadataEnvironmentSchema = z.object({
293
+ allowsAnonymous: z.boolean(),
294
+ oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
295
+ scope: z.string().optional()
296
+ });
297
+ /** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
298
+ const externalAuthorizationServerEnvironmentSchema = z.object({
299
+ allowsAnonymous: z.boolean(),
300
+ oAuthMetadata: z.object({
301
+ externalAuthorizationServerUrl: z.url(),
302
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
303
+ }),
304
+ scope: z.string().optional()
305
+ });
306
+ /** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
307
+ const standaloneEnvironmentSchema = z.object({
308
+ allowsAnonymous: z.boolean(),
309
+ oAuthMetadata: z.object({
310
+ authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
311
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
312
+ }),
313
+ scope: z.string().optional()
314
+ });
315
+ /** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
316
+ const protectedWithoutDiscoveryEnvironmentSchema = z.object({
317
+ allowsAnonymous: z.literal(false),
318
+ oAuthMetadata: z.strictObject({}),
319
+ scope: z.string().optional()
320
+ });
321
+ const legacyPublicEnvironmentSchema = z.object({
282
322
  isPublic: z.literal(true),
283
323
  oAuthMetadata: z.undefined().optional()
284
324
  });
285
- /**
286
- * Protected environment with an external resource metadata URL
287
- *
288
- * An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
289
- * Everything that follows is handled outside of the MCP server scope.
290
- */
291
- const externalResourceMetadataEnvironmentSchema = z.object({
325
+ const legacyExternalResourceMetadataEnvironmentSchema = z.object({
292
326
  isPublic: z.literal(false),
293
327
  oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
294
328
  scope: z.string().optional()
295
329
  });
296
- /**
297
- * Protected environment with an external authorization server URL
298
- *
299
- * The server itself exposes the /.well-known/oauth-protected-resource endpoint.
300
- * An external authorization server URL is returned when requesting the endpoint.
301
- * Everything that follows is handled outside of the MCP server scope.
302
- */
303
- const externalAuthorizationServerEnvironmentSchema = z.object({
330
+ const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
304
331
  isPublic: z.literal(false),
305
332
  oAuthMetadata: z.object({
306
333
  externalAuthorizationServerUrl: z.url(),
@@ -308,13 +335,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
308
335
  }),
309
336
  scope: z.string().optional()
310
337
  });
311
- /**
312
- * Standalone protected environment
313
- *
314
- * The server itself exposes the /.well-known/oauth-protected-resource endpoint.
315
- * The server itself exposes the /.well-known/oauth-authorization-server endpoint.
316
- */
317
- const standaloneEnvironmentSchema = z.object({
338
+ const legacyStandaloneEnvironmentSchema = z.object({
318
339
  isPublic: z.literal(false),
319
340
  oAuthMetadata: z.object({
320
341
  authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
@@ -322,14 +343,7 @@ const standaloneEnvironmentSchema = z.object({
322
343
  }),
323
344
  scope: z.string().optional()
324
345
  });
325
- /**
326
- * Protected environment without OAuth discovery
327
- *
328
- * The server enforces authentication but exposes no OAuth discovery metadata.
329
- * Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
330
- * are advertised. Clients must obtain credentials out-of-band.
331
- */
332
- const protectedWithoutDiscoveryEnvironmentSchema = z.object({
346
+ const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
333
347
  isPublic: z.literal(false),
334
348
  oAuthMetadata: z.strictObject({}),
335
349
  scope: z.string().optional()
@@ -339,11 +353,21 @@ z.union([
339
353
  externalResourceMetadataEnvironmentSchema,
340
354
  externalAuthorizationServerEnvironmentSchema,
341
355
  standaloneEnvironmentSchema,
342
- protectedWithoutDiscoveryEnvironmentSchema
356
+ protectedWithoutDiscoveryEnvironmentSchema,
357
+ legacyPublicEnvironmentSchema,
358
+ legacyExternalResourceMetadataEnvironmentSchema,
359
+ legacyExternalAuthorizationServerEnvironmentSchema,
360
+ legacyStandaloneEnvironmentSchema,
361
+ legacyProtectedWithoutDiscoveryEnvironmentSchema
362
+ ]);
363
+ const playgroundModelSchema = z.enum([
364
+ "global.anthropic.claude-haiku-4-5-20251001-v1:0",
365
+ "global.anthropic.claude-sonnet-4-5-20250929-v1:0",
366
+ "openai.gpt-5.4",
367
+ "openai.gpt-5.5"
343
368
  ]);
344
- const allowedPlatformSchema = platformSchema;
345
369
  const environmentDomainSchema = z.object({
346
- domain: z.string(),
370
+ name: z.string(),
347
371
  status: z.enum([
348
372
  "ongoing",
349
373
  "deployed",
@@ -361,6 +385,7 @@ const environmentSchema$1 = z.object({
361
385
  latestDeployment: deploymentSummarySchema.optional(),
362
386
  openaiAppsChallenge: z.string().nullable().optional(),
363
387
  isPlaygroundEnabled: z.boolean(),
388
+ playgroundModel: playgroundModelSchema,
364
389
  isIpWhitelistEnabled: z.boolean(),
365
390
  ipAllowlist: z.array(z.string()).nullable(),
366
391
  allowedPlatforms: z.array(allowedPlatformSchema),
@@ -369,12 +394,21 @@ const environmentSchema$1 = z.object({
369
394
  updatedAt: z.coerce.date()
370
395
  });
371
396
  const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
397
+ z.object({
398
+ sessionReplayEnabled: z.boolean(),
399
+ collectRequestPayload: z.boolean(),
400
+ collectResponsePayload: z.boolean(),
401
+ collectErrorMessage: z.boolean(),
402
+ collectUserData: z.boolean(),
403
+ identityTraitKey: z.string().min(1).max(200).nullable()
404
+ });
372
405
  z.object({
373
406
  id: z.string(),
374
407
  createdAt: z.coerce.date(),
375
408
  environmentId: z.string(),
376
409
  content: z.string(),
377
- source: z.enum(["model", "user"])
410
+ source: z.enum(["model", "user"]),
411
+ clientName: z.string().nullable()
378
412
  });
379
413
  z.object({
380
414
  content: z.string(),
@@ -410,6 +444,7 @@ z.object({
410
444
  environmentId: z.string(),
411
445
  toolName: z.string(),
412
446
  message: z.string(),
447
+ clientName: z.string().nullable(),
413
448
  categories: z.array(intentCategorySchema)
414
449
  });
415
450
  const signalCategorySchema = z.object({
@@ -474,6 +509,246 @@ z.enum([
474
509
  "DEBUG",
475
510
  "ERROR"
476
511
  ]);
512
+ /** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
513
+ const MCP_CLIENT_GROUPS = [
514
+ {
515
+ id: "claude_code",
516
+ label: "Claude Code",
517
+ vendor: "anthropic",
518
+ rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
519
+ },
520
+ {
521
+ id: "claude",
522
+ label: "Claude",
523
+ vendor: "anthropic",
524
+ rawNames: [
525
+ "Anthropic/ClaudeAI",
526
+ "claude-ai",
527
+ "claude",
528
+ "Claude",
529
+ "claude-desktop",
530
+ "claude-desktop-3p"
531
+ ]
532
+ },
533
+ {
534
+ id: "claude_mobile",
535
+ label: "Claude mobile",
536
+ vendor: "anthropic",
537
+ rawNames: ["claude-ios", "ClaudeAndroid"]
538
+ },
539
+ {
540
+ id: "claude_cowork",
541
+ label: "Claude Cowork",
542
+ vendor: "anthropic",
543
+ rawNames: ["Anthropic/Cowork"]
544
+ },
545
+ {
546
+ id: "claude_toolbox",
547
+ label: "Claude Toolbox",
548
+ vendor: "anthropic",
549
+ rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
550
+ },
551
+ {
552
+ id: "anthropic_api",
553
+ label: "Anthropic API",
554
+ vendor: "anthropic",
555
+ rawNames: ["Anthropic/API"]
556
+ },
557
+ {
558
+ id: "anthropic_connector_refresh",
559
+ label: "Anthropic (connector refresh)",
560
+ vendor: "anthropic",
561
+ rawNames: ["Anthropic"]
562
+ },
563
+ {
564
+ id: "codex",
565
+ label: "Codex",
566
+ vendor: "openai",
567
+ rawNames: [
568
+ "codex-mcp-client",
569
+ "codex",
570
+ "Codex",
571
+ "codex-cli",
572
+ "openai-mcp (Codex)"
573
+ ]
574
+ },
575
+ {
576
+ id: "chatgpt",
577
+ label: "ChatGPT",
578
+ vendor: "openai",
579
+ rawNames: ["openai-mcp (ChatGPT)"]
580
+ },
581
+ {
582
+ id: "openai_responses_api",
583
+ label: "OpenAI Responses API",
584
+ vendor: "openai",
585
+ rawNames: ["openai-mcp (Responses API)"]
586
+ },
587
+ {
588
+ id: "openai_agent_builder",
589
+ label: "OpenAI Agent Builder",
590
+ vendor: "openai",
591
+ rawNames: ["openai-mcp (Agent Builder)"]
592
+ },
593
+ {
594
+ id: "openai_other",
595
+ label: "OpenAI Other",
596
+ vendor: "openai",
597
+ rawNames: ["openai-mcp"]
598
+ },
599
+ {
600
+ id: "cursor",
601
+ label: "Cursor",
602
+ vendor: "cursor",
603
+ rawNames: [
604
+ "cursor-vscode",
605
+ "Cursor",
606
+ "cursor"
607
+ ]
608
+ },
609
+ {
610
+ id: "cline",
611
+ label: "Cline",
612
+ vendor: "cline",
613
+ rawNames: [
614
+ "Cline",
615
+ "cline",
616
+ "@cline/core"
617
+ ]
618
+ },
619
+ {
620
+ id: "github_copilot",
621
+ label: "GitHub Copilot",
622
+ vendor: "githubCopilot",
623
+ rawNames: [
624
+ "Copilot",
625
+ "github-copilot-developer",
626
+ "Copilot MCP Gateway",
627
+ "Xcode/copilot-xcode"
628
+ ]
629
+ },
630
+ {
631
+ id: "gemini_cli",
632
+ label: "Gemini CLI",
633
+ vendor: "google",
634
+ rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
635
+ },
636
+ {
637
+ id: "antigravity",
638
+ label: "Antigravity",
639
+ vendor: "google",
640
+ rawNames: ["antigravity-client"]
641
+ },
642
+ {
643
+ id: "gemini",
644
+ label: "Gemini",
645
+ vendor: "google",
646
+ rawNames: ["Gemini", "google-ai-edge-gallery"]
647
+ },
648
+ {
649
+ id: "windsurf",
650
+ label: "Windsurf",
651
+ vendor: "windsurf",
652
+ rawNames: ["Windsurf", "windsurf-client"]
653
+ },
654
+ {
655
+ id: "mistral",
656
+ label: "Mistral / Le Chat",
657
+ vendor: "mistral",
658
+ rawNames: ["Mistral"],
659
+ rawNamePrefixes: ["connector:custom-mcp:"]
660
+ },
661
+ {
662
+ id: "n8n",
663
+ label: "n8n",
664
+ vendor: "n8n",
665
+ rawNames: [
666
+ "@n8n/n8n-nodes-langchain.mcpClient",
667
+ "@n8n/n8n-nodes-langchain.mcpClientTool",
668
+ "n8n"
669
+ ]
670
+ },
671
+ {
672
+ id: "alpic_playground",
673
+ label: "Alpic Playground",
674
+ vendor: "alpic",
675
+ rawNames: ["alpic-playground", "playground"]
676
+ },
677
+ {
678
+ id: "opencode",
679
+ label: "opencode",
680
+ vendor: "opencode",
681
+ rawNames: ["opencode"]
682
+ },
683
+ {
684
+ id: "zed",
685
+ label: "Zed",
686
+ vendor: "zed",
687
+ rawNames: ["Zed", "zed"]
688
+ },
689
+ {
690
+ id: "zapier",
691
+ label: "Zapier",
692
+ vendor: "zapier",
693
+ rawNames: ["Zapier", "zapier"]
694
+ },
695
+ {
696
+ id: "make",
697
+ label: "Make",
698
+ vendor: "make",
699
+ rawNames: ["Make", "make"]
700
+ },
701
+ {
702
+ id: "librechat",
703
+ label: "LibreChat",
704
+ vendor: "mcp",
705
+ rawNames: ["LibreChat", "librechat"]
706
+ },
707
+ {
708
+ id: "jan",
709
+ label: "Jan",
710
+ vendor: "mcp",
711
+ rawNames: ["Jan", "jan"]
712
+ },
713
+ {
714
+ id: "goose",
715
+ label: "goose",
716
+ vendor: "mcp",
717
+ rawNames: ["goose", "Goose"]
718
+ },
719
+ {
720
+ id: "mcphost",
721
+ label: "mcphost",
722
+ vendor: "mcp",
723
+ rawNames: ["mcphost"]
724
+ },
725
+ {
726
+ id: "mcporter",
727
+ label: "mcporter",
728
+ vendor: "mcp",
729
+ rawNames: ["mcporter"]
730
+ },
731
+ {
732
+ id: "rmcp",
733
+ label: "rmcp",
734
+ vendor: "mcp",
735
+ rawNames: ["rmcp"]
736
+ },
737
+ {
738
+ id: "unnamed_client",
739
+ label: "Unnamed client",
740
+ vendor: "mcp",
741
+ rawNames: [
742
+ "mcp",
743
+ "unknown",
744
+ ""
745
+ ]
746
+ }
747
+ ];
748
+ /** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
749
+ const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
750
+ new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
751
+ new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
477
752
  const runtimeSchema = z.enum([
478
753
  "python3.13",
479
754
  "python3.14",
@@ -502,15 +777,27 @@ z.object({
502
777
  environments: z.array(environmentWithDomainsSchema),
503
778
  productionEnvironment: environmentWithDomainsSchema.nullable()
504
779
  });
780
+ const domainFailureReasonSchema = z.enum([
781
+ "caa",
782
+ "dns",
783
+ "invalid_domain",
784
+ "other"
785
+ ]);
786
+ const projectDomainMappingSchema = z.object({
787
+ pathPrefix: z.string(),
788
+ environment: environmentSchema$1
789
+ });
505
790
  z.object({
506
- domain: z.string(),
791
+ name: z.string(),
507
792
  createdAt: z.coerce.date(),
508
793
  status: z.enum([
509
794
  "ongoing",
510
795
  "deployed",
511
796
  "failed"
512
797
  ]),
513
- environment: environmentSchema$1
798
+ failureReason: domainFailureReasonSchema.nullable(),
799
+ environment: environmentSchema$1,
800
+ mappings: z.array(projectDomainMappingSchema)
514
801
  });
515
802
  const serverFieldsSchema$1 = z.object({
516
803
  $schema: z.string(),
@@ -539,6 +826,14 @@ z.object({
539
826
  serverFields: serverFieldsSchema$1,
540
827
  source: z.enum(["registry", "defaults"])
541
828
  });
829
+ /** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
830
+ const clampStringField = (field) => {
831
+ const max = field.maxLength;
832
+ if (max === null) return field;
833
+ const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
834
+ const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
835
+ return field.description ? withMin.describe(field.description) : withMin;
836
+ };
542
837
  const toolDefinitionSchema = z.object({
543
838
  name: z.string(),
544
839
  title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
@@ -551,17 +846,20 @@ const toolDefinitionSchema = z.object({
551
846
  }).optional()
552
847
  });
553
848
  const positiveTestCaseSchema = z.object({
554
- scenario: z.string(),
555
- userPrompt: z.string(),
556
- toolTriggered: z.string().optional(),
557
- expectedOutput: z.string().optional()
849
+ scenario: z.string().describe("Short label for what this case demonstrates."),
850
+ 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."),
851
+ toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
852
+ expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
558
853
  }).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
559
854
  const screenshotEntrySchema = z.object({
560
855
  prompt: z.string(),
561
856
  url: z.url()
562
857
  }).describe("Each screenshot: the user prompt that produced it + the image URL.");
858
+ const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
563
859
  /** Accepts either a valid email or URL. */
564
860
  const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
861
+ /** A URL field whose error spells out that the scheme is required. */
862
+ const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
565
863
  const chatgptCategorySchema = z.enum([
566
864
  "BUSINESS",
567
865
  "COLLABORATION",
@@ -578,51 +876,348 @@ const chatgptCategorySchema = z.enum([
578
876
  "TRAVEL"
579
877
  ]);
580
878
  const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
581
- const chatgptAllowedCountriesSchema = z.enum(["Allow all", "Restrict to specific countries"]);
879
+ const chatgptCountryCodeSchema = z.enum([
880
+ "AD",
881
+ "AE",
882
+ "AF",
883
+ "AG",
884
+ "AL",
885
+ "AM",
886
+ "AO",
887
+ "AR",
888
+ "AT",
889
+ "AU",
890
+ "AW",
891
+ "AX",
892
+ "AZ",
893
+ "BA",
894
+ "BB",
895
+ "BD",
896
+ "BE",
897
+ "BF",
898
+ "BG",
899
+ "BH",
900
+ "BI",
901
+ "BJ",
902
+ "BL",
903
+ "BM",
904
+ "BN",
905
+ "BO",
906
+ "BR",
907
+ "BS",
908
+ "BT",
909
+ "BW",
910
+ "BZ",
911
+ "CA",
912
+ "CD",
913
+ "CF",
914
+ "CG",
915
+ "CH",
916
+ "CI",
917
+ "CL",
918
+ "CM",
919
+ "CO",
920
+ "CR",
921
+ "CV",
922
+ "CY",
923
+ "CZ",
924
+ "DE",
925
+ "DJ",
926
+ "DK",
927
+ "DM",
928
+ "DO",
929
+ "DZ",
930
+ "EC",
931
+ "EE",
932
+ "EG",
933
+ "ER",
934
+ "ES",
935
+ "ET",
936
+ "FI",
937
+ "FJ",
938
+ "FM",
939
+ "FO",
940
+ "FR",
941
+ "GA",
942
+ "GB",
943
+ "GD",
944
+ "GE",
945
+ "GF",
946
+ "GH",
947
+ "GL",
948
+ "GM",
949
+ "GN",
950
+ "GP",
951
+ "GQ",
952
+ "GR",
953
+ "GT",
954
+ "GW",
955
+ "GY",
956
+ "HN",
957
+ "HR",
958
+ "HT",
959
+ "HU",
960
+ "ID",
961
+ "IE",
962
+ "IL",
963
+ "IN",
964
+ "IQ",
965
+ "IS",
966
+ "IT",
967
+ "JM",
968
+ "JO",
969
+ "JP",
970
+ "KE",
971
+ "KG",
972
+ "KH",
973
+ "KI",
974
+ "KM",
975
+ "KN",
976
+ "KR",
977
+ "KW",
978
+ "KY",
979
+ "KZ",
980
+ "LA",
981
+ "LB",
982
+ "LC",
983
+ "LI",
984
+ "LK",
985
+ "LR",
986
+ "LS",
987
+ "LT",
988
+ "LU",
989
+ "LV",
990
+ "LY",
991
+ "MA",
992
+ "MC",
993
+ "MD",
994
+ "ME",
995
+ "MF",
996
+ "MG",
997
+ "MH",
998
+ "MK",
999
+ "ML",
1000
+ "MM",
1001
+ "MN",
1002
+ "MQ",
1003
+ "MR",
1004
+ "MT",
1005
+ "MU",
1006
+ "MV",
1007
+ "MW",
1008
+ "MX",
1009
+ "MY",
1010
+ "MZ",
1011
+ "NA",
1012
+ "NC",
1013
+ "NE",
1014
+ "NG",
1015
+ "NI",
1016
+ "NL",
1017
+ "NO",
1018
+ "NP",
1019
+ "NR",
1020
+ "NZ",
1021
+ "OM",
1022
+ "PA",
1023
+ "PE",
1024
+ "PF",
1025
+ "PG",
1026
+ "PH",
1027
+ "PK",
1028
+ "PL",
1029
+ "PM",
1030
+ "PS",
1031
+ "PT",
1032
+ "PW",
1033
+ "PY",
1034
+ "QA",
1035
+ "RE",
1036
+ "RO",
1037
+ "RS",
1038
+ "RW",
1039
+ "SA",
1040
+ "SB",
1041
+ "SC",
1042
+ "SD",
1043
+ "SE",
1044
+ "SG",
1045
+ "SH",
1046
+ "SI",
1047
+ "SJ",
1048
+ "SK",
1049
+ "SL",
1050
+ "SM",
1051
+ "SN",
1052
+ "SO",
1053
+ "SR",
1054
+ "SS",
1055
+ "ST",
1056
+ "SV",
1057
+ "SZ",
1058
+ "TD",
1059
+ "TF",
1060
+ "TG",
1061
+ "TH",
1062
+ "TJ",
1063
+ "TL",
1064
+ "TM",
1065
+ "TN",
1066
+ "TO",
1067
+ "TR",
1068
+ "TT",
1069
+ "TV",
1070
+ "TW",
1071
+ "TZ",
1072
+ "UA",
1073
+ "UG",
1074
+ "US",
1075
+ "UY",
1076
+ "UZ",
1077
+ "VA",
1078
+ "VC",
1079
+ "VN",
1080
+ "VU",
1081
+ "WF",
1082
+ "WS",
1083
+ "YE",
1084
+ "YT",
1085
+ "ZA",
1086
+ "ZM",
1087
+ "ZW"
1088
+ ]);
1089
+ const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
1090
+ z.object({ mode: z.literal("all") }),
1091
+ z.object({
1092
+ mode: z.literal("allow"),
1093
+ countries: z.array(chatgptCountryCodeSchema)
1094
+ }),
1095
+ z.object({
1096
+ mode: z.literal("block"),
1097
+ countries: z.array(chatgptCountryCodeSchema)
1098
+ })
1099
+ ]);
1100
+ const chatgptTranslationLocaleSchema = z.enum([
1101
+ "am",
1102
+ "ar",
1103
+ "bg-BG",
1104
+ "bn-BD",
1105
+ "bs-BA",
1106
+ "ca-ES",
1107
+ "cs-CZ",
1108
+ "da-DK",
1109
+ "de-DE",
1110
+ "el-GR",
1111
+ "es-419",
1112
+ "es-ES",
1113
+ "et-EE",
1114
+ "fi-FI",
1115
+ "fr-CA",
1116
+ "fr-FR",
1117
+ "gu-IN",
1118
+ "hi-IN",
1119
+ "hr-HR",
1120
+ "hu-HU",
1121
+ "hy-AM",
1122
+ "id-ID",
1123
+ "is-IS",
1124
+ "it-IT",
1125
+ "ja-JP",
1126
+ "ka-GE",
1127
+ "kk",
1128
+ "kn-IN",
1129
+ "ko-KR",
1130
+ "lt",
1131
+ "lv-LV",
1132
+ "mk-MK",
1133
+ "ml",
1134
+ "mn",
1135
+ "mr-IN",
1136
+ "ms-MY",
1137
+ "my-MM",
1138
+ "nb-NO",
1139
+ "nl-NL",
1140
+ "pa",
1141
+ "pl-PL",
1142
+ "pt-BR",
1143
+ "pt-PT",
1144
+ "ro-RO",
1145
+ "ru-RU",
1146
+ "sk-SK",
1147
+ "sl-SI",
1148
+ "so-SO",
1149
+ "sq-AL",
1150
+ "sr-RS",
1151
+ "sv-SE",
1152
+ "sw-TZ",
1153
+ "ta-IN",
1154
+ "te-IN",
1155
+ "th-TH",
1156
+ "tl",
1157
+ "tr-TR",
1158
+ "uk-UA",
1159
+ "ur",
1160
+ "vi-VN",
1161
+ "zh-CN",
1162
+ "zh-HK",
1163
+ "zh-TW"
1164
+ ]);
582
1165
  const negativeTestCaseSchema = z.object({
583
1166
  scenario: z.string(),
584
1167
  userPrompt: z.string()
585
1168
  }).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
586
1169
  const chatgptToolJustificationSchema = z.object({
587
1170
  toolName: z.string(),
588
- readOnlyJustification: z.string(),
589
- openWorldJustification: z.string(),
590
- destructiveJustification: z.string()
591
- }).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
1171
+ readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
1172
+ openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
1173
+ 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.\"")
1174
+ }).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
1175
+ /** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
1176
+ const chatgptTaglineSchema = z.string().max(30);
1177
+ const chatgptDescriptionSchema = z.string();
592
1178
  const chatgptTranslationSchema = z.object({
593
- locale: z.string(),
594
- tagline: z.string().optional(),
595
- description: z.string().optional()
1179
+ locale: chatgptTranslationLocaleSchema,
1180
+ tagline: chatgptTaglineSchema,
1181
+ description: chatgptDescriptionSchema
596
1182
  }).describe("Locale-scoped override for tagline + description. English (US) is the default.");
597
- /**
598
- * Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
599
- * When adding/removing/reordering fields, keep this in sync with the sheet.
600
- */
1183
+ chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
1184
+ /** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
601
1185
  const chatgptSubmissionFormDataSchema = z.object({
602
1186
  logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
603
1187
  logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
604
1188
  appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
605
- tagline: z.string().max(30).describe("Plain-language phrase focused on function and user value. 30 chars max."),
606
- description: z.string().describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
1189
+ tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
1190
+ description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
607
1191
  category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
608
1192
  developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
609
- companyUrl: z.url().describe("Your company's main website URL."),
1193
+ companyUrl: urlField.describe("Your company's main website URL."),
610
1194
  supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
611
- privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
612
- termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
613
- 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."),
1195
+ privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
1196
+ termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
1197
+ demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
614
1198
  appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
615
- serverUrl: z.url().describe("URL of the MCP server."),
1199
+ serverUrl: urlField.describe("URL of the MCP server."),
616
1200
  authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
617
1201
  tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
618
- toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
619
- testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Coverage over all major use cases."),
620
- negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
621
- screenshots: z.array(screenshotEntrySchema).describe("In-app screenshots paired with the user prompt that produced them. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 4 entries. First three are public. Images: 706px wide, 400–860px tall, PNG."),
1202
+ 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."),
1203
+ 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."),
1204
+ 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."),
1205
+ screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
622
1206
  translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
623
- allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
1207
+ allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
624
1208
  releaseNotes: z.string().describe("Publicly displayed on the app details page.")
625
1209
  });
1210
+ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
1211
+ tagline: z.string().optional(),
1212
+ companyUrl: z.string().optional(),
1213
+ supportChannel: z.string().optional(),
1214
+ privacyPolicyUrl: z.string().optional(),
1215
+ termsOfServiceUrl: z.string().optional(),
1216
+ demoRecordingUrl: z.string().optional(),
1217
+ serverUrl: z.string().optional(),
1218
+ screenshots: z.array(screenshotDraftEntrySchema).optional(),
1219
+ translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
1220
+ });
626
1221
  chatgptSubmissionFormDataSchema.pick({
627
1222
  appName: true,
628
1223
  developerName: true,
@@ -637,9 +1232,9 @@ chatgptSubmissionFormDataSchema.pick({
637
1232
  testCases: true,
638
1233
  negativeTestCases: true,
639
1234
  toolJustifications: true
640
- });
1235
+ }).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
641
1236
  const claudeCategorySchema = z.enum([
642
- "Business & Productivity",
1237
+ "Productivity",
643
1238
  "Communication",
644
1239
  "Data & Analytics",
645
1240
  "Development tools",
@@ -647,207 +1242,167 @@ const claudeCategorySchema = z.enum([
647
1242
  "Consumer Health",
648
1243
  "Health & Life Sciences",
649
1244
  "Media & Entertainment",
650
- "Commerce & Shopping"
651
- ]);
652
- z.enum([
653
- "No auth needed",
654
- "OAuth 2.0",
655
- "Custom URL"
1245
+ "Commerce & Shopping",
1246
+ "Legal",
1247
+ "Sales and marketing",
1248
+ "Creative",
1249
+ "Nonprofit",
1250
+ "Education",
1251
+ "Other"
656
1252
  ]);
657
- const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
658
- z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
1253
+ const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
659
1254
  const claudeReadWriteCapabilitiesSchema = z.enum([
660
- "Read only",
661
- "Write only",
662
- "Read + write"
1255
+ "read_only",
1256
+ "write_only",
1257
+ "read_write"
663
1258
  ]);
664
- const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
665
- const claudeThirdPartySchema = z.enum([
666
- "Web access (open web fetch / scraping / arbitrary URLs)",
667
- "Third-party AI model integration",
668
- "Third-party data retrieval (via workflow / aggregator)",
669
- "Third-party data modification (via workflow / aggregator)",
670
- "N/A"
1259
+ const claudeAuthenticationSchema = z.enum([
1260
+ "oauth_dcr",
1261
+ "oauth_cimd",
1262
+ "oauth_anthropic_creds",
1263
+ "custom_connection",
1264
+ "none"
671
1265
  ]);
672
- const claudeDataHandlingSchema = z.enum([
673
- "Server only accesses data explicitly requested by user",
674
- "No data is stored beyond session requirements",
675
- "Data transmission is encrypted (HTTPS / TLS)",
676
- "GDPR compliant (if applicable)"
1266
+ const claudeApiOwnershipSchema = z.enum([
1267
+ "first_party",
1268
+ "proxied",
1269
+ "third_party"
677
1270
  ]);
678
- const claudeSponsoredContentSchema = z.enum([
679
- "No, there is no sponsored content or advertisements",
680
- "Yes, there are banner ads or other paid visual elements",
681
- "Yes, returned content or ranking is impacted by sponsorship or ad placement"
1271
+ const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
1272
+ const claudePolicyAcknowledgementSchema = z.enum([
1273
+ "I have read and understand the MCP Directory developer guidelines.",
1274
+ "My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
1275
+ "My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
1276
+ "My connector does not use AI models to generate images, video, or audio.",
1277
+ "Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
1278
+ "My connector does not collect conversation data beyond what is needed for its function.",
1279
+ "Public documentation for this connector will be live by the publish date."
682
1280
  ]);
683
- /**
684
- * Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
685
- * When adding/removing/reordering fields, keep this in sync with the sheet.
686
- */
1281
+ /** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
687
1282
  const claudeSubmissionFormDataSchema = z.object({
688
- 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."),
689
- 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."),
690
- 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."),
691
- 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."),
692
- 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."),
693
- 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."),
694
- appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
695
-
696
- Rules:
697
- (1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
698
- (2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
699
- (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.`),
700
- mcpUrlType: claudeMcpUrlTypeSchema.describe(`Choose how your server URL works:
701
- • 'Universal URL': one single URL that all users connect to (most common). Example: https://mcp.myapp.com
702
- • 'Custom MCP URLs': each user gets their own unique URL (e.g. based on their workspace or instance).
703
- 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.`),
704
- 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/
705
- 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.`),
706
- 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.
707
- 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...'`),
708
- 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.`),
709
- 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.
710
- Best format: [Use case]: [exact prompt]"
711
- Example for a task manager:
712
- 1. Create a task: 'Create a task called Review Q3 report, due Friday, assigned to Alice'
713
- 2. Search tasks: 'Show me all open bugs in the Mobile project'
714
- 3. Update status: 'Mark the Deploy v2.1 task as done'"`),
715
- connectionRequirements: z.string().describe(`Describe any prerequisites a user must have before they can connect your server. Be exhaustive. Examples of things to mention:
716
- • Account type required (free vs paid plan)
717
- • Admin permissions or specific roles needed
718
- • Geographic restrictions (e.g. 'US only' or 'Not available in EU')
719
- • If users need to provide their own server URL or instance domain
720
- • Any setup steps needed before connecting (e.g. 'Enable API access in your account settings')
721
- If there are genuinely no special requirements, write exactly: 'No special requirements.'`),
722
- readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`Select the option that best describes what your server can do:
723
-
724
- 'Read Only': your tools only fetch/retrieve data (GET operations). Claude cannot modify anything via your server.
725
- 'Write Only': your tools only create/update/delete data (rare).
726
- 'Read + Write': your tools can both retrieve AND modify data (most common for full-featured connectors).
727
-
728
- 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. `),
729
- isMcpApp: z.boolean().describe(`Select 'Yes' if your MCP server renders interactive UI elements (aka widgets or views) inside the Claude conversation.
730
- Select 'No' if your server only returns text/data responses.
731
- 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.`),
732
- thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe(`Multi-select all that apply to your server's behavior:
733
- • 'Web access' — your server fetches arbitrary URLs, scrapes websites, or makes open-ended HTTP requests to the web (not just your own API).
734
- • 'Third-party AI model integration' — your server calls another AI model (e.g. OpenAI, Gemini, Cohere) as part of its processing.
735
- • '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.
736
- • 'Third-party data modification' — your server modifies data via such a platform.
737
- • 'N/A' — your server only calls your own first-party API and does nothing else. Select this only if none of the above apply.`),
738
- 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:
739
- • 'Server only accesses data explicitly requested by user' — your server doesn't silently read unrelated user data.
740
- • 'No data is stored beyond session requirements' — you don't log or retain conversation data after the session.
741
- • 'Data transmission is encrypted (HTTPS/TLS)' — all data in transit is encrypted. This should always apply for remote servers.
742
- • '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.
743
- Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
744
- 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.
745
- Select 'No' for the vast majority of business/productivity/dev tools. When in doubt, select 'No'. This field triggers additional compliance review if 'Yes'.`),
746
- 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:
747
- • Business & Productivity — project management, CRM, HR, office tools
748
- • Communication — email, chat, messaging, notifications
749
- • Data & Analytics — dashboards, reporting, databases, BI tools
750
- • Development tools — code repositories, CI/CD, issue trackers, monitoring
751
- • Financial Services — accounting, invoicing, fintech (note: financial transaction execution is not permitted)
752
- • Consumer Health — fitness, wellness, personal health tracking
753
- • Health & Life Sciences — clinical, pharma, medical professional tools
754
- • Media & Entertainment — content, publishing, streaming
755
- • Commerce & Shopping — e-commerce, inventory, orders
756
- Multiple categories are allowed if genuinely applicable.`),
757
- 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:
758
- • '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.
759
- • '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.
760
- • '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.
761
- 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'.`),
762
- transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
763
- • 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
764
- • 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
765
- If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
766
- serverDocumentationLink: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. This is displayed in the Directory listing and must be publicly accessible without login. Minimum requirements for the docs page:
767
- • What the connector does and its key capabilities
768
- • How to connect/set it up (step by step)
769
- • What each tool does (or at least the main ones)
770
- • How to troubleshoot common issues
771
- • A support contact or channel
772
- Acceptable formats: a dedicated docs page, a help center article, a README on GitHub, or a blog post — as long as it's comprehensive. Note: Anthropic requires public documentation to be live by your publish date.`),
773
- privacyPolicyUrl: z.url().describe(`URL to your privacy policy. This is mandatory and displayed in the directory listing. Missing or incomplete privacy policies result in immediate rejection. Your privacy policy must cover:
774
- • What data you collect (and how)
775
- • How you use the collected data
776
- • Where and how long you store it
777
- • Whether you share data with third parties (and who)
778
- • How users can contact you about data concerns
779
- The policy must be publicly accessible. If you don't have one yet, create one before submitting — there are free generators online, but make sure it accurately reflects your actual practices. If you're GDPR-compliant, your policy should reflect that.`),
780
- supportChannel: supportChannelSchema.describe(`A URL or email address where users can get help with your connector. This is displayed in the Directory listing. Acceptable options:
781
- • Email address (e.g. support@myapp.com)
782
- • Link to a GitHub Issues page
783
- • Link to a help center or support article
784
- • Link to a Discord/Slack community
785
- • Link to your documentation's troubleshooting section
786
- Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
787
- testingCredentials: z.string().describe(`Provide login credentials for a test account that Anthropic reviewers can use to verify your server works end-to-end. Critical requirements:
788
- • The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
789
- • No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
790
- • If your service uses Google OAuth or another OAuth that requires email verification, use mcp-review@anthropic.com as the account email — Anthropic has access to this inbox.
791
- • Credentials must remain valid for at least 30 days from submission.
792
- • If your service requires API keys instead of a password, provide those.
793
- Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
794
- tools: z.array(toolDefinitionSchema).describe(`A comma-separated list of all tools your MCP server exposes. Use the format: tool_name (Human-Readable Name). The tool_name is the internal identifier (snake_case, max 64 characters). The Human-Readable Name is what users see.
795
- Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
796
- Reviewers test every single tool you list here — don't list tools that don't work. Also: do not have a single catch-all tool like api_request(method, endpoint) — Anthropic rejects these. Each action should be its own purpose-built tool.`),
797
- toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
798
- • 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
799
- • 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
800
- This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
801
- logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
802
- • Format: SVG only
803
- • Aspect ratio: square (1:1)
804
- • Should work on a light background
805
- • Provide via URL (Google Drive link is fine) or upload directly
806
- Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
807
- logoDark: z.string().optional().describe(`Optional dark-mode variant of the connector logo. Same specs as the light variant (SVG, square 1:1) but designed to read on a dark background. Leave empty if the light logo already works on dark.`),
808
- screenshots: z.array(screenshotEntrySchema).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
809
- • 3–5 images is ideal
810
- • Minimum 1000px width, PNG format preferred
811
- • Each screenshot is paired with the user prompt that produced it
812
- • Crop to just the relevant part of the Claude interface (the tool response area)
813
- • Show your connector doing something impressive and useful — real data, real results
814
- • If you're an MCP App, include screenshots of your interactive UI elements
815
- These images appear in your directory listing and are a key factor in driving user installs.`)
1283
+ 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
1284
+ from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
1285
+ The server must be publicly accessible without VPN or whitelisting.`),
1286
+ 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
1287
+ own or have the right to use this name. Max 100 characters.`),
1288
+ 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.
1289
+ PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
1290
+ oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
1291
+ phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
1292
+ 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
1293
+ claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
1294
+ categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
1295
+ 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
1296
+ (recommended); upload a custom icon only to override it.`),
1297
+ documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
1298
+ accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
1299
+ by your publish date.`),
1300
+ support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
1301
+ used to notify you of security or compliance issues, so make sure it's actively monitored.`),
1302
+ privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
1303
+ what data you collect, how you use and store it, and whether you share it with third parties.`),
1304
+ 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
1305
+ it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
1306
+ primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
1307
+ type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
1308
+ connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
1309
+ permissions'). If there are genuinely no special requirements, say so explicitly.`),
1310
+ readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
1311
+ • 'read_only': retrieves data but never modifies it.
1312
+ • 'write_only': creates or modifies data but does not read it.
1313
+ • 'read_write': both retrieves and modifies data (most common).`),
1314
+ companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
1315
+ companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
1316
+ primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
1317
+ primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
1318
+ primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
1319
+ anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
1320
+ authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
1321
+ • 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
1322
+ • 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
1323
+ • 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
1324
+ • 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
1325
+ • 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
1326
+ partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
1327
+ apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
1328
+ • 'first_party': the MCP server calls your own production APIs.
1329
+ • 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
1330
+ • 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
1331
+ personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
1332
+ No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
1333
+ sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
1334
+ No → false, Yes → true, or { other: explanation }.`),
1335
+ testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
1336
+ the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
1337
+ fully populated account.`),
1338
+ selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
1339
+ policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
1340
+ submission. Each is an attestation you are legally agreeing to by submitting.`),
1341
+ additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
1342
+ });
1343
+ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
1344
+ serverUrl: z.string().optional(),
1345
+ name: z.string().optional(),
1346
+ slug: z.string().optional(),
1347
+ oneLiner: z.string().optional(),
1348
+ description: z.string().optional(),
1349
+ iconUrl: z.string().optional(),
1350
+ documentation: z.string().optional(),
1351
+ support: z.string().optional(),
1352
+ privacyPolicy: z.string().optional(),
1353
+ companyWebsite: z.string().optional(),
1354
+ primaryContactEmail: z.string().optional(),
1355
+ categories: z.array(claudeCategorySchema).optional(),
1356
+ screenshots: z.array(screenshotDraftEntrySchema).optional()
816
1357
  });
817
1358
  claudeSubmissionFormDataSchema.pick({
818
- companyName: true,
819
- appName: true,
820
- mcpUrlType: true,
821
1359
  serverUrl: true,
822
- tools: true,
823
- readWriteCapabilities: true,
824
- isMcpApp: true,
825
- transportSupport: true,
1360
+ name: true,
1361
+ slug: true,
1362
+ companyName: true,
826
1363
  primaryContactEmail: true,
827
- primaryContactName: true
1364
+ primaryContactName: true,
1365
+ readWriteCapabilities: true,
1366
+ authentication: true,
1367
+ apiOwnership: true,
1368
+ personalHealthData: true
1369
+ }).extend({
1370
+ connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
1371
+ testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
828
1372
  });
829
- claudeSubmissionFormDataSchema.pick({
830
- tagline: true,
831
- description: true,
832
- categories: true,
833
- testCases: true
1373
+ /** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
1374
+ const claudeAiGeneratedFormDataRawSchema = z.object({
1375
+ oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
1376
+ description: claudeSubmissionFormDataSchema.shape.description,
1377
+ categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
1378
+ primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
1379
+ });
1380
+ claudeAiGeneratedFormDataRawSchema.extend({
1381
+ oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
1382
+ categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
834
1383
  });
835
1384
  const submissionMetaFieldsSchema = z.object({
836
1385
  id: z.string(),
837
1386
  environmentId: z.string(),
1387
+ auditId: z.string().nullable(),
838
1388
  createdAt: z.coerce.date(),
839
1389
  updatedAt: z.coerce.date()
840
1390
  });
841
1391
  const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
842
1392
  platform: z.literal("claudeai"),
843
- formData: claudeSubmissionFormDataSchema.partial()
1393
+ formData: claudeSubmissionDraftSchema
844
1394
  });
845
1395
  const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
846
1396
  platform: z.literal("chatgpt"),
847
- formData: chatgptSubmissionFormDataSchema.partial()
1397
+ formData: chatgptSubmissionDraftSchema
848
1398
  });
849
1399
  z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
850
- z.union([claudeSubmissionFormDataSchema.partial(), chatgptSubmissionFormDataSchema.partial()]);
1400
+ z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
1401
+ z.literal([
1402
+ 100,
1403
+ 75,
1404
+ 50
1405
+ ]);
851
1406
  const subscriptionPlanSchema = z.enum([
852
1407
  "pro",
853
1408
  "business",
@@ -871,6 +1426,12 @@ z.object({
871
1426
  partnerDiscount: partnerDiscountSchema.nullable()
872
1427
  });
873
1428
  //#endregion
1429
+ //#region src/auth-scope.ts
1430
+ /** Accepts an API key or OAuth access token (default for most routes). */
1431
+ const AUTH_SCOPE_ANY = "any";
1432
+ /** Requires a user OAuth access token; API keys are not accepted. */
1433
+ const AUTH_SCOPE_USER = "user";
1434
+ //#endregion
874
1435
  //#region src/schemas.ts
875
1436
  const RESERVED_KEYS = [
876
1437
  "_HANDLER",
@@ -906,7 +1467,10 @@ const RESERVED_KEYS = [
906
1467
  "BUILD_ARG_START_COMMAND",
907
1468
  "ALPIC_HOST",
908
1469
  "ALPIC_CUSTOM_DOMAINS",
909
- "ALPIC_INTENT_META_KEY"
1470
+ "ALPIC_INTENT_META_KEY",
1471
+ "ALPIC_FEEDBACK_META_KEY",
1472
+ "ALPIC_EVENTS_META_KEY",
1473
+ "ALPIC_IDENTIFY_META_KEY"
910
1474
  ];
911
1475
  const environmentVariableSchema = z.object({
912
1476
  key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
@@ -991,17 +1555,15 @@ const isValidLogTimeInput = (value) => {
991
1555
  if (ms(value) !== void 0) return true;
992
1556
  return !Number.isNaN(new Date(value).getTime());
993
1557
  };
994
- const createEnvironmentContractV1 = oc.route({
1558
+ const base = oc.errors({ BAD_REQUEST: {} });
1559
+ const createEnvironmentContractV1 = base.route({
995
1560
  path: "/v1/environments",
996
1561
  method: "POST",
997
1562
  summary: "Create an environment",
998
1563
  description: "Create an environment for a project",
999
1564
  tags: ["environments"],
1000
1565
  successDescription: "The environment has been created successfully"
1001
- }).errors({
1002
- NOT_FOUND: {},
1003
- BAD_REQUEST: {}
1004
- }).input(z.object({
1566
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1005
1567
  projectId: z.string().describe("The ID of the project to create the environment for"),
1006
1568
  name: z.string().min(1).describe("The name of the environment"),
1007
1569
  sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
@@ -1010,11 +1572,11 @@ const createEnvironmentContractV1 = oc.route({
1010
1572
  id: z.string(),
1011
1573
  name: z.string(),
1012
1574
  sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
1013
- urls: z.array(z.string().url()).describe("The URLs of the MCP server"),
1575
+ urls: z.array(z.url()).describe("The URLs of the MCP server"),
1014
1576
  createdAt: z.coerce.date(),
1015
1577
  projectId: z.string().describe("The ID of the project the environment belongs to")
1016
1578
  }));
1017
- const getEnvironmentContractV1 = oc.route({
1579
+ const getEnvironmentContractV1 = base.route({
1018
1580
  path: "/v1/environments/{environmentId}",
1019
1581
  method: "GET",
1020
1582
  summary: "Get an environment",
@@ -1071,7 +1633,7 @@ const projectOutputSchema = z.object({
1071
1633
  productionEnvironment: productionEnvironmentSchema.nullable(),
1072
1634
  environments: z.array(environmentSchema)
1073
1635
  });
1074
- const getProjectContractV1 = oc.route({
1636
+ const getProjectContractV1 = base.route({
1075
1637
  path: "/v1/projects/{projectId}",
1076
1638
  method: "GET",
1077
1639
  summary: "Get a project",
@@ -1079,15 +1641,15 @@ const getProjectContractV1 = oc.route({
1079
1641
  tags: ["projects"],
1080
1642
  successDescription: "The project details"
1081
1643
  }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
1082
- const listProjectsContractV1 = oc.route({
1644
+ const listProjectsContractV1 = base.route({
1083
1645
  path: "/v1/projects",
1084
1646
  method: "GET",
1085
1647
  summary: "List projects",
1086
1648
  description: "List all projects for a team",
1087
1649
  tags: ["projects"],
1088
1650
  successDescription: "The list of projects"
1089
- }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
1090
- const createProjectContractV1 = oc.route({
1651
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
1652
+ const createProjectContractV1 = base.route({
1091
1653
  path: "/v1/projects",
1092
1654
  method: "POST",
1093
1655
  summary: "Create a project",
@@ -1096,7 +1658,7 @@ const createProjectContractV1 = oc.route({
1096
1658
  successDescription: "The project has been created successfully"
1097
1659
  }).errors({
1098
1660
  NOT_FOUND: {},
1099
- BAD_REQUEST: {}
1661
+ FORBIDDEN: {}
1100
1662
  }).input(z.object({
1101
1663
  teamId: z.string().optional(),
1102
1664
  name: z.string().trim().min(1).max(100),
@@ -1136,7 +1698,7 @@ const environmentVariableOutputSchema = z.object({
1136
1698
  isSecret: z.boolean(),
1137
1699
  createdAt: z.coerce.date()
1138
1700
  });
1139
- const listEnvironmentVariablesContractV1 = oc.route({
1701
+ const listEnvironmentVariablesContractV1 = base.route({
1140
1702
  path: "/v1/environments/{environmentId}/environment-variables",
1141
1703
  method: "GET",
1142
1704
  summary: "List environment variables",
@@ -1144,37 +1706,31 @@ const listEnvironmentVariablesContractV1 = oc.route({
1144
1706
  tags: ["environments"],
1145
1707
  successDescription: "The list of environment variables"
1146
1708
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
1147
- const createEnvironmentVariablesContractV1 = oc.route({
1709
+ const createEnvironmentVariablesContractV1 = base.route({
1148
1710
  path: "/v1/environments/{environmentId}/environment-variables",
1149
1711
  method: "POST",
1150
1712
  summary: "Add environment variables",
1151
1713
  description: "Add one or more environment variables to an environment",
1152
1714
  tags: ["environments"],
1153
1715
  successDescription: "The environment variables have been added successfully"
1154
- }).errors({
1155
- NOT_FOUND: {},
1156
- BAD_REQUEST: {}
1157
- }).input(z.object({
1716
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1158
1717
  environmentId: z.string().describe("The ID of the environment"),
1159
1718
  environmentVariables: environmentVariablesSchema
1160
1719
  })).output(z.object({ success: z.literal(true) }));
1161
- const updateEnvironmentVariableContractV1 = oc.route({
1720
+ const updateEnvironmentVariableContractV1 = base.route({
1162
1721
  path: "/v1/environment-variables/{environmentVariableId}",
1163
1722
  method: "PATCH",
1164
1723
  summary: "Update an environment variable",
1165
1724
  description: "Update an environment variable by ID",
1166
1725
  tags: ["environments"],
1167
1726
  successDescription: "The environment variable has been updated successfully"
1168
- }).errors({
1169
- NOT_FOUND: {},
1170
- BAD_REQUEST: {}
1171
- }).input(z.object({
1727
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1172
1728
  environmentVariableId: z.string().describe("The ID of the environment variable"),
1173
1729
  key: environmentVariableSchema.shape.key,
1174
1730
  value: environmentVariableSchema.shape.value.optional(),
1175
1731
  isSecret: environmentVariableSchema.shape.isSecret.optional()
1176
1732
  })).output(z.object({ success: z.literal(true) }));
1177
- const deleteEnvironmentVariableContractV1 = oc.route({
1733
+ const deleteEnvironmentVariableContractV1 = base.route({
1178
1734
  path: "/v1/environment-variables/{environmentVariableId}",
1179
1735
  method: "DELETE",
1180
1736
  summary: "Delete an environment variable",
@@ -1182,7 +1738,7 @@ const deleteEnvironmentVariableContractV1 = oc.route({
1182
1738
  tags: ["environments"],
1183
1739
  successDescription: "The environment variable has been deleted successfully"
1184
1740
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
1185
- const deleteProjectContractV1 = oc.route({
1741
+ const deleteProjectContractV1 = base.route({
1186
1742
  path: "/v1/projects/{projectId}",
1187
1743
  method: "DELETE",
1188
1744
  summary: "Delete a project",
@@ -1190,7 +1746,7 @@ const deleteProjectContractV1 = oc.route({
1190
1746
  tags: ["projects"],
1191
1747
  successDescription: "The project has been deleted successfully"
1192
1748
  }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
1193
- const updateProjectContractV1 = oc.route({
1749
+ const updateProjectContractV1 = base.route({
1194
1750
  path: "/v1/projects/{projectId}",
1195
1751
  method: "PATCH",
1196
1752
  summary: "Update a project",
@@ -1199,13 +1755,13 @@ const updateProjectContractV1 = oc.route({
1199
1755
  successDescription: "The project has been updated successfully"
1200
1756
  }).errors({
1201
1757
  NOT_FOUND: {},
1202
- BAD_REQUEST: {}
1758
+ FORBIDDEN: {}
1203
1759
  }).input(z.object({
1204
1760
  projectId: z.string().describe("The ID of the project"),
1205
1761
  name: z.string().min(1).max(100).optional().describe("The new name for the project"),
1206
1762
  sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
1207
1763
  })).output(projectOutputSchema);
1208
- const deployEnvironmentContractV1 = oc.route({
1764
+ const deployEnvironmentContractV1 = base.route({
1209
1765
  path: "/v1/environments/{environmentId}/deploy",
1210
1766
  method: "POST",
1211
1767
  summary: "Deploy an environment",
@@ -1214,24 +1770,25 @@ const deployEnvironmentContractV1 = oc.route({
1214
1770
  successDescription: "The environment has been deployed successfully"
1215
1771
  }).errors({
1216
1772
  NOT_FOUND: {},
1217
- BAD_REQUEST: {}
1773
+ CONFLICT: {}
1218
1774
  }).input(z.object({
1219
1775
  environmentId: z.string().describe("The ID of the environment to deploy"),
1220
- token: z.string().describe("The token to identify the source archive").optional()
1776
+ token: z.string().describe("The token to identify the source archive").optional(),
1777
+ settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
1221
1778
  })).output(deploymentSchema);
1222
- const uploadDeploymentArtifactContractV1 = oc.route({
1779
+ const uploadDeploymentArtifactContractV1 = base.route({
1223
1780
  path: "/v1/deployments/upload",
1224
1781
  method: "POST",
1225
1782
  summary: "Upload deployment artifacts",
1226
1783
  description: "Return a presigned S3 URL to upload a deployment artifact",
1227
1784
  tags: ["deployments"],
1228
1785
  successDescription: "The presigned upload URL has been generated successfully"
1229
- }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
1786
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
1230
1787
  uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
1231
1788
  token: z.string().describe("Token to identify the source archive"),
1232
1789
  expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
1233
1790
  }));
1234
- const listDeploymentsContractV1 = oc.route({
1791
+ const listDeploymentsContractV1 = base.route({
1235
1792
  path: "/v1/projects/{projectId}/deployments",
1236
1793
  method: "GET",
1237
1794
  summary: "List project deployments",
@@ -1243,7 +1800,7 @@ const listDeploymentsContractV1 = oc.route({
1243
1800
  status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
1244
1801
  environmentId: z.string().optional().describe("Filter by environment ID")
1245
1802
  })).output(z.array(deploymentSchema));
1246
- const getDeploymentContractV1 = oc.route({
1803
+ const getDeploymentContractV1 = base.route({
1247
1804
  path: "/v1/deployments/{deploymentId}",
1248
1805
  method: "GET",
1249
1806
  summary: "Get a deployment",
@@ -1251,17 +1808,29 @@ const getDeploymentContractV1 = oc.route({
1251
1808
  tags: ["deployments"],
1252
1809
  successDescription: "The deployment details"
1253
1810
  }).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
1254
- const getLogsContractV1 = oc.route({
1811
+ const logEntrySchema = z.object({
1812
+ timestamp: z.coerce.date(),
1813
+ type: z.enum([
1814
+ "START",
1815
+ "END",
1816
+ "INFO",
1817
+ "ERROR",
1818
+ "WARNING",
1819
+ "DEBUG"
1820
+ ]),
1821
+ requestId: z.string(),
1822
+ content: z.string().optional(),
1823
+ method: z.string().optional(),
1824
+ durationInMs: z.number().optional()
1825
+ });
1826
+ const getLogsContractV1 = base.route({
1255
1827
  path: "/v1/environments/{environmentId}/logs",
1256
1828
  method: "GET",
1257
1829
  summary: "Get logs",
1258
1830
  description: "Get logs for an environment",
1259
1831
  tags: ["environments"],
1260
1832
  successDescription: "The logs"
1261
- }).errors({
1262
- NOT_FOUND: {},
1263
- BAD_REQUEST: {}
1264
- }).input(z.object({
1833
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1265
1834
  environmentId: z.string().describe("The ID of the environment"),
1266
1835
  since: z.string().refine(isValidLogTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." }).optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
1267
1836
  until: z.string().refine(isValidLogTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." }).optional().describe("End time — ISO 8601 or relative"),
@@ -1275,34 +1844,17 @@ const getLogsContractV1 = oc.route({
1275
1844
  search: z.string().optional().describe("Filter pattern to search for in log content"),
1276
1845
  nextToken: z.string().optional().describe("Pagination token from a previous response")
1277
1846
  })).output(z.object({
1278
- logs: z.array(z.object({
1279
- timestamp: z.coerce.date(),
1280
- type: z.enum([
1281
- "START",
1282
- "END",
1283
- "INFO",
1284
- "ERROR",
1285
- "WARNING",
1286
- "DEBUG"
1287
- ]),
1288
- requestId: z.string(),
1289
- content: z.string().optional(),
1290
- method: z.string().optional(),
1291
- durationInMs: z.number().optional()
1292
- })),
1847
+ logs: z.array(logEntrySchema),
1293
1848
  nextToken: z.string().nullable()
1294
1849
  }));
1295
- const getLatestLogsContractV1 = oc.route({
1850
+ const getLatestLogsContractV1 = base.route({
1296
1851
  path: "/v1/environments/{environmentId}/latest-logs",
1297
1852
  method: "GET",
1298
1853
  summary: "Get latest logs",
1299
1854
  description: "Get the N most recent logs for an environment",
1300
1855
  tags: ["environments"],
1301
1856
  successDescription: "The latest logs"
1302
- }).errors({
1303
- NOT_FOUND: {},
1304
- BAD_REQUEST: {}
1305
- }).input(z.object({
1857
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1306
1858
  environmentId: z.string().describe("The ID of the environment"),
1307
1859
  limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
1308
1860
  level: z.array(z.enum([
@@ -1312,22 +1864,8 @@ const getLatestLogsContractV1 = oc.route({
1312
1864
  "DEBUG"
1313
1865
  ])).optional().describe("Filter by log level"),
1314
1866
  search: z.string().optional().describe("Filter pattern to search for in log content")
1315
- })).output(z.object({ logs: z.array(z.object({
1316
- timestamp: z.coerce.date(),
1317
- type: z.enum([
1318
- "START",
1319
- "END",
1320
- "INFO",
1321
- "ERROR",
1322
- "WARNING",
1323
- "DEBUG"
1324
- ]),
1325
- requestId: z.string(),
1326
- content: z.string().optional(),
1327
- method: z.string().optional(),
1328
- durationInMs: z.number().optional()
1329
- })) }));
1330
- const getDeploymentLogsContractV1 = oc.route({
1867
+ })).output(z.object({ logs: z.array(logEntrySchema) }));
1868
+ const getDeploymentLogsContractV1 = base.route({
1331
1869
  path: "/v1/deployments/{deploymentId}/logs",
1332
1870
  method: "GET",
1333
1871
  summary: "Get deployment logs",
@@ -1354,17 +1892,14 @@ const analyticsTimeSeriesSchema = z.object({
1354
1892
  output_token_mean: z.array(analyticsDataPointSchema),
1355
1893
  task_count: z.array(analyticsDataPointSchema)
1356
1894
  });
1357
- const getProjectAnalyticsContractV1 = oc.route({
1895
+ const getProjectAnalyticsContractV1 = base.route({
1358
1896
  path: "/v1/analytics/{projectId}",
1359
1897
  method: "GET",
1360
1898
  summary: "Get project analytics",
1361
1899
  description: "Get analytics data for a project over a time range",
1362
1900
  tags: ["analytics"],
1363
1901
  successDescription: "The project analytics data"
1364
- }).errors({
1365
- NOT_FOUND: {},
1366
- BAD_REQUEST: {}
1367
- }).input(z.object({
1902
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1368
1903
  projectId: z.string().describe("The ID of the project"),
1369
1904
  startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
1370
1905
  endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
@@ -1379,7 +1914,7 @@ const getProjectAnalyticsContractV1 = oc.route({
1379
1914
  }),
1380
1915
  timeSeries: analyticsTimeSeriesSchema
1381
1916
  }));
1382
- const listTeamsContractV1 = oc.route({
1917
+ const listTeamsContractV1 = base.route({
1383
1918
  path: "/v1/teams",
1384
1919
  method: "GET",
1385
1920
  summary: "List teams",
@@ -1392,28 +1927,25 @@ const listTeamsContractV1 = oc.route({
1392
1927
  createdAt: z.coerce.date(),
1393
1928
  hasStripeAccount: z.boolean()
1394
1929
  })));
1395
- const getTunnelTicketContractV1 = oc.route({
1930
+ const getTunnelTicketContractV1 = base.route({
1396
1931
  path: "/v1/tunnels/ticket",
1397
1932
  method: "GET",
1398
1933
  summary: "Get a tunnel ticket",
1399
1934
  description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
1400
1935
  tags: ["tunnels"],
1401
1936
  successDescription: "The tunnel ticket"
1402
- }).output(z.object({
1937
+ }).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
1403
1938
  subdomain: z.string().describe("The subdomain assigned to the user"),
1404
1939
  ticket: z.string().describe("The signed tunnel ticket"),
1405
1940
  tunnelHost: z.string().describe("The tunnel host to connect to")
1406
1941
  }));
1407
- const publishServerContractV1 = oc.route({
1942
+ const publishServerContractV1 = base.route({
1408
1943
  path: "/v1/distribution/publish",
1409
1944
  method: "POST",
1410
1945
  summary: "Publish a server to the MCP registry",
1411
1946
  tags: ["distribution"],
1412
1947
  successDescription: "The server has been published successfully"
1413
- }).errors({
1414
- NOT_FOUND: {},
1415
- BAD_REQUEST: {}
1416
- }).input(z.object({
1948
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1417
1949
  projectId: z.string(),
1418
1950
  domain: z.string(),
1419
1951
  title: z.string().min(1).max(100),
@@ -1422,17 +1954,14 @@ const publishServerContractV1 = oc.route({
1422
1954
  iconSrc: z.url().max(255).optional(),
1423
1955
  dryRun: z.boolean().optional()
1424
1956
  })).output(z.object({ serverFields: serverFieldsSchema }));
1425
- const getServerInfoContractV1 = oc.route({
1957
+ const getServerInfoContractV1 = base.route({
1426
1958
  path: "/v1/distribution/get",
1427
1959
  method: "GET",
1428
1960
  summary: "Get server info",
1429
1961
  description: "Get info about a server",
1430
1962
  tags: ["distribution"],
1431
1963
  successDescription: "The server info"
1432
- }).errors({
1433
- NOT_FOUND: {},
1434
- BAD_REQUEST: {}
1435
- }).input(z.object({
1964
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1436
1965
  projectId: z.string(),
1437
1966
  domain: z.string()
1438
1967
  })).output(z.object({ serverFields: serverFieldsSchema }));
@@ -1451,7 +1980,7 @@ const playgroundOutputSchema = z.object({
1451
1980
  isPlaygroundEnabled: z.boolean(),
1452
1981
  serverMetadata: playgroundServerMetadataOutputSchema.nullable()
1453
1982
  });
1454
- const getPlaygroundContractV1 = oc.route({
1983
+ const getPlaygroundContractV1 = base.route({
1455
1984
  path: "/v1/environments/{environmentId}/playground",
1456
1985
  method: "GET",
1457
1986
  summary: "Get playground configuration",
@@ -1459,17 +1988,14 @@ const getPlaygroundContractV1 = oc.route({
1459
1988
  tags: ["environments"],
1460
1989
  successDescription: "The playground configuration"
1461
1990
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
1462
- const upsertPlaygroundContractV1 = oc.route({
1991
+ const upsertPlaygroundContractV1 = base.route({
1463
1992
  path: "/v1/environments/{environmentId}/playground",
1464
1993
  method: "PUT",
1465
1994
  summary: "Update playground configuration",
1466
1995
  description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
1467
1996
  tags: ["environments"],
1468
1997
  successDescription: "The updated playground configuration"
1469
- }).errors({
1470
- NOT_FOUND: {},
1471
- BAD_REQUEST: {}
1472
- }).input(z.object({
1998
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1473
1999
  environmentId: z.string().describe("The ID of the environment"),
1474
2000
  isPlaygroundEnabled: z.boolean().optional(),
1475
2001
  name: z.string().min(1).max(100).optional(),
@@ -1477,7 +2003,7 @@ const upsertPlaygroundContractV1 = oc.route({
1477
2003
  headers: z.array(playgroundHeaderSchema).optional(),
1478
2004
  examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
1479
2005
  })).output(playgroundOutputSchema);
1480
- const createBeaconContractV1 = oc.route({
2006
+ const createBeaconContractV1 = base.route({
1481
2007
  path: "/v1/beacon/audits",
1482
2008
  method: "POST",
1483
2009
  summary: "Create a beacon audit",
@@ -1486,7 +2012,6 @@ const createBeaconContractV1 = oc.route({
1486
2012
  successDescription: "The audit has been created"
1487
2013
  }).errors({
1488
2014
  NOT_FOUND: {},
1489
- BAD_REQUEST: {},
1490
2015
  DNS_RESOLUTION_FAILED: { status: 400 }
1491
2016
  }).input(z.object({
1492
2017
  targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
@@ -1494,7 +2019,7 @@ const createBeaconContractV1 = oc.route({
1494
2019
  projectId: z.string().optional().describe("The project ID to associate the audit with"),
1495
2020
  excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
1496
2021
  })).output(z.object({ id: z.string() }));
1497
- const getBeaconContractV1 = oc.route({
2022
+ const getBeaconContractV1 = base.route({
1498
2023
  path: "/v1/beacon/audits/{auditId}",
1499
2024
  method: "GET",
1500
2025
  summary: "Get a beacon audit",
@@ -1552,5 +2077,10 @@ const contract = {
1552
2077
  get: { v1: getBeaconContractV1 }
1553
2078
  }
1554
2079
  };
2080
+ const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
2081
+ const contractForDocs = {
2082
+ ...contract,
2083
+ deployments: deploymentsForDocs
2084
+ };
1555
2085
  //#endregion
1556
- export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
2086
+ export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };