@alpic-ai/api 0.0.0-dev.gd9d8e80 → 0.0.0-dev.gd9ebdf8

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 +6298 -84
  2. package/dist/index.mjs +1043 -395
  3. package/package.json +26 -10
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.5.4/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,22 @@ 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
+ "cato",
183
+ "cloudflare",
184
+ "fastly"
185
+ ];
186
+ const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
187
+ const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
177
188
  const auditStatusSchema = z.enum([
178
189
  "pending",
179
190
  "partial",
@@ -246,6 +257,25 @@ z.object({
246
257
  clientSecret: z.string(),
247
258
  clientScopes: z.array(z.string())
248
259
  });
260
+ const creditEntryReasonSchema = z.enum([
261
+ "free_seed",
262
+ "paid_conversion_floor",
263
+ "top_up",
264
+ "usage",
265
+ "admin_adjustment"
266
+ ]);
267
+ z.enum(["playground"]);
268
+ z.number().int().min(500);
269
+ const creditActivityEntrySchema = z.object({
270
+ reason: creditEntryReasonSchema,
271
+ day: z.number(),
272
+ amountInNanoUSD: z.number(),
273
+ messageCount: z.number().nullable()
274
+ });
275
+ z.object({
276
+ balanceInNanoUSD: z.number(),
277
+ recentActivity: z.array(creditActivityEntrySchema)
278
+ });
249
279
  const deploymentStatusSchema$1 = z.enum([
250
280
  "ongoing",
251
281
  "deployed",
@@ -273,34 +303,51 @@ const deploymentSummarySchema = z.object({
273
303
  createdAt: z.coerce.date(),
274
304
  updatedAt: z.coerce.date()
275
305
  });
276
- /**
277
- * Public environment
278
- *
279
- * No OAuth metadata exposed.
280
- */
306
+ /** Public environment: answers anonymously and exposes no OAuth metadata. */
281
307
  const publicEnvironmentSchema = z.object({
308
+ allowsAnonymous: z.literal(true),
309
+ oAuthMetadata: z.strictObject({})
310
+ });
311
+ /** 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. */
312
+ const externalResourceMetadataEnvironmentSchema = z.object({
313
+ allowsAnonymous: z.boolean(),
314
+ oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
315
+ scope: z.string().optional()
316
+ });
317
+ /** 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. */
318
+ const externalAuthorizationServerEnvironmentSchema = z.object({
319
+ allowsAnonymous: z.boolean(),
320
+ oAuthMetadata: z.object({
321
+ externalAuthorizationServerUrl: z.url(),
322
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
323
+ }),
324
+ scope: z.string().optional()
325
+ });
326
+ /** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
327
+ const standaloneEnvironmentSchema = z.object({
328
+ allowsAnonymous: z.boolean(),
329
+ oAuthMetadata: z.object({
330
+ authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
331
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
332
+ }),
333
+ scope: z.string().optional()
334
+ });
335
+ /** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
336
+ const protectedWithoutDiscoveryEnvironmentSchema = z.object({
337
+ allowsAnonymous: z.literal(false),
338
+ oAuthMetadata: z.strictObject({}),
339
+ scope: z.string().optional()
340
+ });
341
+ const legacyPublicEnvironmentSchema = z.object({
282
342
  isPublic: z.literal(true),
283
343
  oAuthMetadata: z.undefined().optional()
284
344
  });
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({
345
+ const legacyExternalResourceMetadataEnvironmentSchema = z.object({
292
346
  isPublic: z.literal(false),
293
347
  oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
294
348
  scope: z.string().optional()
295
349
  });
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({
350
+ const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
304
351
  isPublic: z.literal(false),
305
352
  oAuthMetadata: z.object({
306
353
  externalAuthorizationServerUrl: z.url(),
@@ -308,13 +355,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
308
355
  }),
309
356
  scope: z.string().optional()
310
357
  });
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({
358
+ const legacyStandaloneEnvironmentSchema = z.object({
318
359
  isPublic: z.literal(false),
319
360
  oAuthMetadata: z.object({
320
361
  authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
@@ -322,14 +363,7 @@ const standaloneEnvironmentSchema = z.object({
322
363
  }),
323
364
  scope: z.string().optional()
324
365
  });
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({
366
+ const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
333
367
  isPublic: z.literal(false),
334
368
  oAuthMetadata: z.strictObject({}),
335
369
  scope: z.string().optional()
@@ -339,11 +373,21 @@ z.union([
339
373
  externalResourceMetadataEnvironmentSchema,
340
374
  externalAuthorizationServerEnvironmentSchema,
341
375
  standaloneEnvironmentSchema,
342
- protectedWithoutDiscoveryEnvironmentSchema
376
+ protectedWithoutDiscoveryEnvironmentSchema,
377
+ legacyPublicEnvironmentSchema,
378
+ legacyExternalResourceMetadataEnvironmentSchema,
379
+ legacyExternalAuthorizationServerEnvironmentSchema,
380
+ legacyStandaloneEnvironmentSchema,
381
+ legacyProtectedWithoutDiscoveryEnvironmentSchema
382
+ ]);
383
+ const playgroundModelSchema = z.enum([
384
+ "global.anthropic.claude-haiku-4-5-20251001-v1:0",
385
+ "global.anthropic.claude-sonnet-4-5-20250929-v1:0",
386
+ "openai.gpt-5.4",
387
+ "openai.gpt-5.5"
343
388
  ]);
344
- const allowedPlatformSchema = platformSchema;
345
389
  const environmentDomainSchema = z.object({
346
- domain: z.string(),
390
+ name: z.string(),
347
391
  status: z.enum([
348
392
  "ongoing",
349
393
  "deployed",
@@ -361,6 +405,7 @@ const environmentSchema$1 = z.object({
361
405
  latestDeployment: deploymentSummarySchema.optional(),
362
406
  openaiAppsChallenge: z.string().nullable().optional(),
363
407
  isPlaygroundEnabled: z.boolean(),
408
+ playgroundModel: playgroundModelSchema,
364
409
  isIpWhitelistEnabled: z.boolean(),
365
410
  ipAllowlist: z.array(z.string()).nullable(),
366
411
  allowedPlatforms: z.array(allowedPlatformSchema),
@@ -370,11 +415,20 @@ const environmentSchema$1 = z.object({
370
415
  });
371
416
  const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
372
417
  z.object({
418
+ sessionReplayEnabled: z.boolean(),
419
+ collectRequestPayload: z.boolean(),
420
+ collectResponsePayload: z.boolean(),
421
+ collectErrorMessage: z.boolean(),
422
+ collectUserData: z.boolean(),
423
+ identityTraitKey: z.string().min(1).max(200).nullable()
424
+ });
425
+ const feedbackSchema = z.object({
373
426
  id: z.string(),
374
427
  createdAt: z.coerce.date(),
375
428
  environmentId: z.string(),
376
429
  content: z.string(),
377
- source: z.enum(["model", "user"])
430
+ source: z.enum(["model", "user"]),
431
+ clientName: z.string().nullable()
378
432
  });
379
433
  z.object({
380
434
  content: z.string(),
@@ -390,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
390
444
  "pink",
391
445
  "gray"
392
446
  ]);
393
- intentCategoryColorSchema.options;
447
+ const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
394
448
  const intentCategorySchema = z.object({
395
449
  id: z.string(),
396
450
  createdAt: z.coerce.date(),
@@ -398,7 +452,7 @@ const intentCategorySchema = z.object({
398
452
  name: z.string(),
399
453
  color: intentCategoryColorSchema
400
454
  });
401
- z.object({
455
+ const intentCategorySummarySchema = z.object({
402
456
  id: z.string(),
403
457
  name: z.string(),
404
458
  color: intentCategoryColorSchema,
@@ -410,6 +464,7 @@ z.object({
410
464
  environmentId: z.string(),
411
465
  toolName: z.string(),
412
466
  message: z.string(),
467
+ clientName: z.string().nullable(),
413
468
  categories: z.array(intentCategorySchema)
414
469
  });
415
470
  const signalCategorySchema = z.object({
@@ -468,12 +523,262 @@ z.object({
468
523
  createdAt: z.coerce.date(),
469
524
  updatedAt: z.coerce.date()
470
525
  });
526
+ const alpicMcpRequestLogSchema = z.object({
527
+ type: z.literal("mcp_request"),
528
+ method: z.string()
529
+ });
530
+ const alpicMcpErrorLogSchema = z.object({
531
+ type: z.literal("mcp_error"),
532
+ method: z.string(),
533
+ error: z.string()
534
+ });
535
+ z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
471
536
  z.enum([
472
537
  "INFO",
473
538
  "WARNING",
474
539
  "DEBUG",
475
540
  "ERROR"
476
541
  ]);
542
+ /** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
543
+ const MCP_CLIENT_GROUPS = [
544
+ {
545
+ id: "claude_code",
546
+ label: "Claude Code",
547
+ vendor: "anthropic",
548
+ rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
549
+ },
550
+ {
551
+ id: "claude",
552
+ label: "Claude",
553
+ vendor: "anthropic",
554
+ rawNames: [
555
+ "Anthropic/ClaudeAI",
556
+ "claude-ai",
557
+ "claude",
558
+ "Claude",
559
+ "claude-desktop",
560
+ "claude-desktop-3p"
561
+ ]
562
+ },
563
+ {
564
+ id: "claude_mobile",
565
+ label: "Claude mobile",
566
+ vendor: "anthropic",
567
+ rawNames: ["claude-ios", "ClaudeAndroid"]
568
+ },
569
+ {
570
+ id: "claude_cowork",
571
+ label: "Claude Cowork",
572
+ vendor: "anthropic",
573
+ rawNames: ["Anthropic/Cowork"]
574
+ },
575
+ {
576
+ id: "claude_toolbox",
577
+ label: "Claude Toolbox",
578
+ vendor: "anthropic",
579
+ rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
580
+ },
581
+ {
582
+ id: "anthropic_api",
583
+ label: "Anthropic API",
584
+ vendor: "anthropic",
585
+ rawNames: ["Anthropic/API"]
586
+ },
587
+ {
588
+ id: "anthropic_connector_refresh",
589
+ label: "Anthropic (connector refresh)",
590
+ vendor: "anthropic",
591
+ rawNames: ["Anthropic"]
592
+ },
593
+ {
594
+ id: "codex",
595
+ label: "Codex",
596
+ vendor: "openai",
597
+ rawNames: [
598
+ "codex-mcp-client",
599
+ "codex",
600
+ "Codex",
601
+ "codex-cli",
602
+ "openai-mcp (Codex)"
603
+ ]
604
+ },
605
+ {
606
+ id: "chatgpt",
607
+ label: "ChatGPT",
608
+ vendor: "openai",
609
+ rawNames: ["openai-mcp (ChatGPT)"]
610
+ },
611
+ {
612
+ id: "openai_responses_api",
613
+ label: "OpenAI Responses API",
614
+ vendor: "openai",
615
+ rawNames: ["openai-mcp (Responses API)"]
616
+ },
617
+ {
618
+ id: "openai_agent_builder",
619
+ label: "OpenAI Agent Builder",
620
+ vendor: "openai",
621
+ rawNames: ["openai-mcp (Agent Builder)"]
622
+ },
623
+ {
624
+ id: "openai_other",
625
+ label: "OpenAI Other",
626
+ vendor: "openai",
627
+ rawNames: ["openai-mcp"]
628
+ },
629
+ {
630
+ id: "cursor",
631
+ label: "Cursor",
632
+ vendor: "cursor",
633
+ rawNames: [
634
+ "cursor-vscode",
635
+ "Cursor",
636
+ "cursor"
637
+ ]
638
+ },
639
+ {
640
+ id: "cline",
641
+ label: "Cline",
642
+ vendor: "cline",
643
+ rawNames: [
644
+ "Cline",
645
+ "cline",
646
+ "@cline/core"
647
+ ]
648
+ },
649
+ {
650
+ id: "github_copilot",
651
+ label: "GitHub Copilot",
652
+ vendor: "githubCopilot",
653
+ rawNames: [
654
+ "Copilot",
655
+ "github-copilot-developer",
656
+ "Copilot MCP Gateway",
657
+ "Xcode/copilot-xcode"
658
+ ]
659
+ },
660
+ {
661
+ id: "gemini_cli",
662
+ label: "Gemini CLI",
663
+ vendor: "google",
664
+ rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
665
+ },
666
+ {
667
+ id: "antigravity",
668
+ label: "Antigravity",
669
+ vendor: "google",
670
+ rawNames: ["antigravity-client"]
671
+ },
672
+ {
673
+ id: "gemini",
674
+ label: "Gemini",
675
+ vendor: "google",
676
+ rawNames: ["Gemini", "google-ai-edge-gallery"]
677
+ },
678
+ {
679
+ id: "windsurf",
680
+ label: "Windsurf",
681
+ vendor: "windsurf",
682
+ rawNames: ["Windsurf", "windsurf-client"]
683
+ },
684
+ {
685
+ id: "mistral",
686
+ label: "Mistral / Le Chat",
687
+ vendor: "mistral",
688
+ rawNames: ["Mistral"],
689
+ rawNamePrefixes: ["connector:custom-mcp:"]
690
+ },
691
+ {
692
+ id: "n8n",
693
+ label: "n8n",
694
+ vendor: "n8n",
695
+ rawNames: [
696
+ "@n8n/n8n-nodes-langchain.mcpClient",
697
+ "@n8n/n8n-nodes-langchain.mcpClientTool",
698
+ "n8n"
699
+ ]
700
+ },
701
+ {
702
+ id: "alpic_playground",
703
+ label: "Alpic Playground",
704
+ vendor: "alpic",
705
+ rawNames: ["alpic-playground", "playground"]
706
+ },
707
+ {
708
+ id: "opencode",
709
+ label: "opencode",
710
+ vendor: "opencode",
711
+ rawNames: ["opencode"]
712
+ },
713
+ {
714
+ id: "zed",
715
+ label: "Zed",
716
+ vendor: "zed",
717
+ rawNames: ["Zed", "zed"]
718
+ },
719
+ {
720
+ id: "zapier",
721
+ label: "Zapier",
722
+ vendor: "zapier",
723
+ rawNames: ["Zapier", "zapier"]
724
+ },
725
+ {
726
+ id: "make",
727
+ label: "Make",
728
+ vendor: "make",
729
+ rawNames: ["Make", "make"]
730
+ },
731
+ {
732
+ id: "librechat",
733
+ label: "LibreChat",
734
+ vendor: "mcp",
735
+ rawNames: ["LibreChat", "librechat"]
736
+ },
737
+ {
738
+ id: "jan",
739
+ label: "Jan",
740
+ vendor: "mcp",
741
+ rawNames: ["Jan", "jan"]
742
+ },
743
+ {
744
+ id: "goose",
745
+ label: "goose",
746
+ vendor: "mcp",
747
+ rawNames: ["goose", "Goose"]
748
+ },
749
+ {
750
+ id: "mcphost",
751
+ label: "mcphost",
752
+ vendor: "mcp",
753
+ rawNames: ["mcphost"]
754
+ },
755
+ {
756
+ id: "mcporter",
757
+ label: "mcporter",
758
+ vendor: "mcp",
759
+ rawNames: ["mcporter"]
760
+ },
761
+ {
762
+ id: "rmcp",
763
+ label: "rmcp",
764
+ vendor: "mcp",
765
+ rawNames: ["rmcp"]
766
+ },
767
+ {
768
+ id: "unnamed_client",
769
+ label: "Unnamed client",
770
+ vendor: "mcp",
771
+ rawNames: [
772
+ "mcp",
773
+ "unknown",
774
+ ""
775
+ ]
776
+ }
777
+ ];
778
+ /** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
779
+ const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
780
+ new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
781
+ new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
477
782
  const runtimeSchema = z.enum([
478
783
  "python3.13",
479
784
  "python3.14",
@@ -502,15 +807,27 @@ z.object({
502
807
  environments: z.array(environmentWithDomainsSchema),
503
808
  productionEnvironment: environmentWithDomainsSchema.nullable()
504
809
  });
810
+ const domainFailureReasonSchema = z.enum([
811
+ "caa",
812
+ "dns",
813
+ "invalid_domain",
814
+ "other"
815
+ ]);
816
+ const projectDomainMappingSchema = z.object({
817
+ pathPrefix: z.string(),
818
+ environment: environmentSchema$1
819
+ });
505
820
  z.object({
506
- domain: z.string(),
821
+ name: z.string(),
507
822
  createdAt: z.coerce.date(),
508
823
  status: z.enum([
509
824
  "ongoing",
510
825
  "deployed",
511
826
  "failed"
512
827
  ]),
513
- environment: environmentSchema$1
828
+ failureReason: domainFailureReasonSchema.nullable(),
829
+ environment: environmentSchema$1,
830
+ mappings: z.array(projectDomainMappingSchema)
514
831
  });
515
832
  const serverFieldsSchema$1 = z.object({
516
833
  $schema: z.string(),
@@ -539,15 +856,7 @@ z.object({
539
856
  serverFields: serverFieldsSchema$1,
540
857
  source: z.enum(["registry", "defaults"])
541
858
  });
542
- /**
543
- * Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
544
- * rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
545
- *
546
- * NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
547
- * `minLength`, and the description. Any other validators on the source field (`.regex()`,
548
- * `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
549
- * free-text length caps only. A field with `null` `maxLength` is returned unchanged.
550
- */
859
+ /** 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. */
551
860
  const clampStringField = (field) => {
552
861
  const max = field.maxLength;
553
862
  if (max === null) return field;
@@ -555,6 +864,10 @@ const clampStringField = (field) => {
555
864
  const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
556
865
  return field.description ? withMin.describe(field.description) : withMin;
557
866
  };
867
+ const unboundedArrayField = (field) => {
868
+ const unbounded = z.array(field.element);
869
+ return field.description ? unbounded.describe(field.description) : unbounded;
870
+ };
558
871
  const toolDefinitionSchema = z.object({
559
872
  name: z.string(),
560
873
  title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
@@ -567,17 +880,31 @@ const toolDefinitionSchema = z.object({
567
880
  }).optional()
568
881
  });
569
882
  const positiveTestCaseSchema = z.object({
570
- scenario: z.string().describe("Short label for what this case demonstrates."),
571
- 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."),
883
+ scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
884
+ userPrompt: z.string().min(1).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."),
572
885
  toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
573
886
  expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
574
- }).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
887
+ }).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
888
+ const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
889
+ scenario: z.string().optional(),
890
+ userPrompt: z.string().optional()
891
+ });
892
+ const blankPositiveTestCase = () => ({
893
+ scenario: "",
894
+ userPrompt: "",
895
+ toolTriggered: "",
896
+ expectedOutput: ""
897
+ });
898
+ const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
575
899
  const screenshotEntrySchema = z.object({
576
900
  prompt: z.string(),
577
- url: z.url().or(z.literal(""))
901
+ url: z.url()
578
902
  }).describe("Each screenshot: the user prompt that produced it + the image URL.");
903
+ const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
579
904
  /** Accepts either a valid email or URL. */
580
905
  const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
906
+ /** A URL field whose error spells out that the scheme is required. */
907
+ const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
581
908
  const chatgptCategorySchema = z.enum([
582
909
  "BUSINESS",
583
910
  "COLLABORATION",
@@ -881,20 +1208,25 @@ const chatgptTranslationLocaleSchema = z.enum([
881
1208
  "zh-TW"
882
1209
  ]);
883
1210
  const negativeTestCaseSchema = z.object({
884
- scenario: z.string(),
885
- userPrompt: z.string()
886
- }).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
1211
+ scenario: z.string().min(1),
1212
+ userPrompt: z.string().min(1)
1213
+ }).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
1214
+ const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
1215
+ scenario: z.string().optional(),
1216
+ userPrompt: z.string().optional()
1217
+ });
1218
+ const blankNegativeTestCase = () => ({
1219
+ scenario: "",
1220
+ userPrompt: ""
1221
+ });
1222
+ const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
887
1223
  const chatgptToolJustificationSchema = z.object({
888
1224
  toolName: z.string(),
889
1225
  readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
890
1226
  openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
891
1227
  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.\"")
892
1228
  }).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
893
- /**
894
- * Base copy fields, defined once and reused by both the submission form and per-locale
895
- * translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
896
- * path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
897
- */
1229
+ /** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
898
1230
  const chatgptTaglineSchema = z.string().max(30);
899
1231
  const chatgptDescriptionSchema = z.string();
900
1232
  const chatgptTranslationSchema = z.object({
@@ -903,10 +1235,7 @@ const chatgptTranslationSchema = z.object({
903
1235
  description: chatgptDescriptionSchema
904
1236
  }).describe("Locale-scoped override for tagline + description. English (US) is the default.");
905
1237
  chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
906
- /**
907
- * Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
908
- * When adding/removing/reordering fields, keep this in sync with the sheet.
909
- */
1238
+ /** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
910
1239
  const chatgptSubmissionFormDataSchema = z.object({
911
1240
  logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
912
1241
  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."),
@@ -915,40 +1244,64 @@ const chatgptSubmissionFormDataSchema = z.object({
915
1244
  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)."),
916
1245
  category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
917
1246
  developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
918
- companyUrl: z.url().describe("Your company's main website URL."),
1247
+ companyUrl: urlField.describe("Your company's main website URL."),
919
1248
  supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
920
- privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
921
- termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
922
- 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."),
1249
+ privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
1250
+ termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
1251
+ 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."),
923
1252
  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."),
924
- serverUrl: z.url().describe("URL of the MCP server."),
1253
+ serverUrl: urlField.describe("URL of the MCP server."),
925
1254
  authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
926
1255
  tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
927
1256
  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."),
928
- 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."),
929
- 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."),
930
- screenshots: z.array(screenshotEntrySchema).max(3).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 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
1257
+ skills: z.array(chatgptSkillSchema).optional().describe("Skills the server exposes over MCP (auto-populated from the production server's manifest). Left unset when the server does not advertise the skills extension, which is a different state from advertising it and exposing none."),
1258
+ testCases: z.array(positiveTestCaseSchema).length(5).describe("Exactly 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."),
1259
+ negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 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."),
1260
+ 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."),
931
1261
  translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
932
1262
  allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
933
1263
  releaseNotes: z.string().describe("Publicly displayed on the app details page.")
934
1264
  });
935
- chatgptSubmissionFormDataSchema.pick({
1265
+ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
1266
+ tagline: z.string().optional(),
1267
+ companyUrl: z.string().optional(),
1268
+ supportChannel: z.string().optional(),
1269
+ privacyPolicyUrl: z.string().optional(),
1270
+ termsOfServiceUrl: z.string().optional(),
1271
+ demoRecordingUrl: z.string().optional(),
1272
+ serverUrl: z.string().optional(),
1273
+ screenshots: z.array(screenshotDraftEntrySchema).optional(),
1274
+ testCases: z.array(positiveTestCaseDraftSchema).optional(),
1275
+ negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
1276
+ translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
1277
+ });
1278
+ /** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
1279
+ const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
936
1280
  appName: true,
937
1281
  developerName: true,
938
1282
  serverUrl: true,
939
1283
  tools: true,
1284
+ skills: true,
940
1285
  authentication: true
941
1286
  });
942
- chatgptSubmissionFormDataSchema.pick({
1287
+ /** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
1288
+ const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
943
1289
  tagline: true,
944
1290
  description: true,
945
1291
  category: true,
946
1292
  testCases: true,
947
1293
  negativeTestCases: true,
948
1294
  toolJustifications: true
949
- }).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
1295
+ }).extend({
1296
+ testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
1297
+ negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
1298
+ }).extend({
1299
+ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
1300
+ testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
1301
+ negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
1302
+ });
950
1303
  const claudeCategorySchema = z.enum([
951
- "Business & Productivity",
1304
+ "Productivity",
952
1305
  "Communication",
953
1306
  "Data & Analytics",
954
1307
  "Development tools",
@@ -956,221 +1309,222 @@ const claudeCategorySchema = z.enum([
956
1309
  "Consumer Health",
957
1310
  "Health & Life Sciences",
958
1311
  "Media & Entertainment",
959
- "Commerce & Shopping"
960
- ]);
961
- const claudeAuthenticationSchema = z.enum([
962
- "No auth needed",
963
- "OAuth 2.0",
964
- "Custom URL"
1312
+ "Commerce & Shopping",
1313
+ "Legal",
1314
+ "Sales and marketing",
1315
+ "Creative",
1316
+ "Nonprofit",
1317
+ "Education",
1318
+ "Other"
965
1319
  ]);
966
- const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
967
- z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
1320
+ const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
968
1321
  const claudeReadWriteCapabilitiesSchema = z.enum([
969
- "Read Only",
970
- "Write Only",
971
- "Read + Write"
1322
+ "read_only",
1323
+ "write_only",
1324
+ "read_write"
972
1325
  ]);
973
- const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
974
- const claudeTestedSurfaceSchema = z.enum([
975
- "Claude.ai (web)",
976
- "Claude Desktop",
977
- "Claude Code",
978
- "Cowork"
979
- ]);
980
- const claudeThirdPartySchema = z.enum([
981
- "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)",
982
- "Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
983
- "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)",
984
- "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)",
985
- "N/A"
1326
+ const claudeAuthenticationSchema = z.enum([
1327
+ "oauth_dcr",
1328
+ "oauth_cimd",
1329
+ "oauth_anthropic_creds",
1330
+ "custom_connection",
1331
+ "none"
986
1332
  ]);
987
- const claudeDataHandlingSchema = z.enum([
988
- "Server only accesses data explicitly requested by user",
989
- "No data is stored beyond session requirements",
990
- "Data transmission is encrypted (HTTPS/TLS)",
991
- "GDPR compliant (if applicable)"
1333
+ const claudeApiOwnershipSchema = z.enum([
1334
+ "first_party",
1335
+ "proxied",
1336
+ "third_party"
992
1337
  ]);
993
- const claudeSponsoredContentSchema = z.enum([
994
- "No, there is no sponsored content or advertisements",
995
- "Yes, there are banner ads or other paid visual elements",
996
- "Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement"
1338
+ const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
1339
+ const claudePolicyAcknowledgementSchema = z.enum([
1340
+ "I have read and understand the MCP Directory developer guidelines.",
1341
+ "My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
1342
+ "My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
1343
+ "My connector does not use AI models to generate images, video, or audio.",
1344
+ "Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
1345
+ "My connector does not collect conversation data beyond what is needed for its function.",
1346
+ "Public documentation for this connector will be live by the publish date."
997
1347
  ]);
998
- /**
999
- * Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
1000
- * When adding/removing/reordering fields, keep this in sync with the sheet.
1001
- */
1348
+ /** 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. */
1002
1349
  const claudeSubmissionFormDataSchema = z.object({
1003
- 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."),
1004
- 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."),
1005
- 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."),
1006
- 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."),
1007
- 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."),
1008
- 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."),
1009
- appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
1010
-
1011
- Rules:
1012
- (1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
1013
- (2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
1014
- (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.`),
1015
- mcpUrlType: claudeMcpUrlTypeSchema.describe(`Choose how your server URL works:
1016
- • 'Universal URL': one single URL that all users connect to (most common). Example: https://mcp.myapp.com
1017
- • 'Custom MCP URLs': each user gets their own unique URL (e.g. based on their workspace or instance).
1018
- 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.`),
1019
- 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/
1020
- 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.`),
1021
- 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.
1022
- 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...'`),
1023
- 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.`),
1024
- 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.
1025
- Best format: [Use case]: [exact prompt]"
1026
- Example for a task manager:
1027
- 1. Create a task: 'Create a task called Review Q3 report, due Friday, assigned to Alice'
1028
- 2. Search tasks: 'Show me all open bugs in the Mobile project'
1029
- 3. Update status: 'Mark the Deploy v2.1 task as done'"`),
1030
- connectionRequirements: z.string().describe(`Describe any prerequisites a user must have before they can connect your server. Be exhaustive. Examples of things to mention:
1031
- • Account type required (free vs paid plan)
1032
- • Admin permissions or specific roles needed
1033
- • Geographic restrictions (e.g. 'US only' or 'Not available in EU')
1034
- • If users need to provide their own server URL or instance domain
1035
- • Any setup steps needed before connecting (e.g. 'Enable API access in your account settings')
1036
- If there are genuinely no special requirements, write exactly: 'No special requirements.'`),
1037
- readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`Select the option that best describes what your server can do:
1038
-
1039
- 'Read Only': your tools only fetch/retrieve data (GET operations). Claude cannot modify anything via your server.
1040
- 'Write Only': your tools only create/update/delete data (rare).
1041
- 'Read + Write': your tools can both retrieve AND modify data (most common for full-featured connectors).
1042
-
1043
- 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. `),
1044
- isMcpApp: z.boolean().describe(`Select 'Yes' if your MCP server renders interactive UI elements (aka widgets or views) inside the Claude conversation.
1045
- Select 'No' if your server only returns text/data responses.
1046
- 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.`),
1047
- thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe(`Multi-select all that apply to your server's behavior:
1048
- • 'Web access' — your server fetches arbitrary URLs, scrapes websites, or makes open-ended HTTP requests to the web (not just your own API).
1049
- • 'Third-party AI model integration' — your server calls another AI model (e.g. OpenAI, Gemini, Cohere) as part of its processing.
1050
- • '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.
1051
- • 'Third-party data modification' — your server modifies data via such a platform.
1052
- • 'N/A' — your server only calls your own first-party API and does nothing else. Select this only if none of the above apply.`),
1053
- 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:
1054
- • 'Server only accesses data explicitly requested by user' — your server doesn't silently read unrelated user data.
1055
- • 'No data is stored beyond session requirements' — you don't log or retain conversation data after the session.
1056
- • 'Data transmission is encrypted (HTTPS/TLS)' — all data in transit is encrypted. This should always apply for remote servers.
1057
- • '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.
1058
- Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
1059
- 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.
1060
- Select 'No' for the vast majority of business/productivity/dev tools. When in doubt, select 'No'. This field triggers additional compliance review if 'Yes'.`),
1061
- 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:
1062
- • Business & Productivity — project management, CRM, HR, office tools
1063
- • Communication — email, chat, messaging, notifications
1064
- • Data & Analytics — dashboards, reporting, databases, BI tools
1065
- • Development tools — code repositories, CI/CD, issue trackers, monitoring
1066
- • Financial Services — accounting, invoicing, fintech (note: financial transaction execution is not permitted)
1067
- • Consumer Health — fitness, wellness, personal health tracking
1068
- • Health & Life Sciences — clinical, pharma, medical professional tools
1069
- • Media & Entertainment — content, publishing, streaming
1070
- • Commerce & Shopping — e-commerce, inventory, orders
1071
- Anthropic's submission form only accepts a single category.`),
1072
- 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:
1073
- • '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.
1074
- • '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.
1075
- • '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.
1076
- 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'.`),
1077
- authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
1078
- transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
1079
- • 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
1080
- • '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.
1081
- If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
1082
- 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:
1083
- • What the connector does and its key capabilities
1084
- • How to connect/set it up (step by step)
1085
- • What each tool does (or at least the main ones)
1086
- • How to troubleshoot common issues
1087
- • A support contact or channel
1088
- 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.`),
1089
- 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:
1090
- • What data you collect (and how)
1091
- • How you use the collected data
1092
- • Where and how long you store it
1093
- • Whether you share data with third parties (and who)
1094
- • How users can contact you about data concerns
1095
- 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.`),
1096
- 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:
1097
- • Email address (e.g. support@myapp.com)
1098
- • Link to a GitHub Issues page
1099
- • Link to a help center or support article
1100
- • Link to a Discord/Slack community
1101
- • Link to your documentation's troubleshooting section
1102
- Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
1103
- 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:
1104
- • The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
1105
- • No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
1106
- • 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.
1107
- • Credentials must remain valid for at least 30 days from submission.
1108
- • If your service requires API keys instead of a password, provide those.
1109
- Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
1110
- 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.
1111
- Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
1112
- 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.`),
1113
- toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
1114
- • 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
1115
- • '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).
1116
- 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.`),
1117
- 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.`),
1118
- logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
1119
- • Format: SVG only
1120
- • Aspect ratio: square (1:1)
1121
- • Should work on a light background
1122
- • Provide via URL (Google Drive link is fine) or upload directly
1123
- Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
1124
- 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.`),
1125
- 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:
1126
- • 3–5 images is ideal
1127
- • Minimum 1000px width, PNG format preferred
1128
- • Each screenshot is paired with the user prompt that produced it
1129
- • Crop to just the relevant part of the Claude interface (the tool response area)
1130
- • Show your connector doing something impressive and useful — real data, real results
1131
- • If you're an MCP App, include screenshots of your interactive UI elements
1132
- These images appear in your directory listing and are a key factor in driving user installs.`)
1133
- });
1134
- claudeSubmissionFormDataSchema.pick({
1135
- companyName: true,
1136
- appName: true,
1137
- mcpUrlType: true,
1350
+ 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
1351
+ from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
1352
+ The server must be publicly accessible without VPN or whitelisting.`),
1353
+ 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
1354
+ own or have the right to use this name. Max 100 characters.`),
1355
+ 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.
1356
+ PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
1357
+ oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
1358
+ phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
1359
+ 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
1360
+ claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
1361
+ categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
1362
+ 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
1363
+ (recommended); upload a custom icon only to override it.`),
1364
+ documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
1365
+ accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
1366
+ by your publish date.`),
1367
+ support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
1368
+ used to notify you of security or compliance issues, so make sure it's actively monitored.`),
1369
+ privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
1370
+ what data you collect, how you use and store it, and whether you share it with third parties.`),
1371
+ 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
1372
+ it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
1373
+ primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
1374
+ type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
1375
+ connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
1376
+ permissions'). If there are genuinely no special requirements, say so explicitly.`),
1377
+ readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
1378
+ • 'read_only': retrieves data but never modifies it.
1379
+ • 'write_only': creates or modifies data but does not read it.
1380
+ • 'read_write': both retrieves and modifies data (most common).`),
1381
+ companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
1382
+ companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
1383
+ primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
1384
+ primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
1385
+ primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
1386
+ anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
1387
+ authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
1388
+ • 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
1389
+ • 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
1390
+ • 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
1391
+ • 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
1392
+ • 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
1393
+ partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
1394
+ apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
1395
+ • 'first_party': the MCP server calls your own production APIs.
1396
+ • 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
1397
+ • 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
1398
+ personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
1399
+ No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
1400
+ sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
1401
+ No → false, Yes → true, or { other: explanation }.`),
1402
+ testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
1403
+ the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
1404
+ fully populated account.`),
1405
+ selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
1406
+ policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
1407
+ submission. Each is an attestation you are legally agreeing to by submitting.`),
1408
+ additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
1409
+ });
1410
+ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
1411
+ serverUrl: z.string().optional(),
1412
+ name: z.string().optional(),
1413
+ slug: z.string().optional(),
1414
+ oneLiner: z.string().optional(),
1415
+ description: z.string().optional(),
1416
+ iconUrl: z.string().optional(),
1417
+ documentation: z.string().optional(),
1418
+ support: z.string().optional(),
1419
+ privacyPolicy: z.string().optional(),
1420
+ companyWebsite: z.string().optional(),
1421
+ primaryContactEmail: z.string().optional(),
1422
+ categories: z.array(claudeCategorySchema).optional(),
1423
+ screenshots: z.array(screenshotDraftEntrySchema).optional()
1424
+ });
1425
+ /** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
1426
+ const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
1138
1427
  serverUrl: true,
1139
- tools: true,
1140
- readWriteCapabilities: true,
1141
- isMcpApp: true,
1142
- transportSupport: true,
1428
+ name: true,
1429
+ slug: true,
1430
+ companyName: true,
1143
1431
  primaryContactEmail: true,
1144
1432
  primaryContactName: true,
1433
+ readWriteCapabilities: true,
1145
1434
  authentication: true,
1146
- personalDataHealthAccess: true,
1147
- testedSurfaces: true
1435
+ apiOwnership: true,
1436
+ personalHealthData: true
1148
1437
  }).extend({
1149
1438
  connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
1150
- testingCredentials: claudeSubmissionFormDataSchema.shape.testingCredentials.optional()
1439
+ testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
1440
+ });
1441
+ /** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
1442
+ const claudeAiGeneratedFormDataRawSchema = z.object({
1443
+ oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
1444
+ description: claudeSubmissionFormDataSchema.shape.description,
1445
+ categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
1446
+ primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
1447
+ });
1448
+ const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
1449
+ oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
1450
+ categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
1451
+ });
1452
+ function provenanceByField(prefillShape, aiGeneratedShape) {
1453
+ const byField = {};
1454
+ for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
1455
+ for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
1456
+ return byField;
1457
+ }
1458
+ provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
1459
+ const urlVerificationOutcomeSchema = z.enum([
1460
+ "pass",
1461
+ "fail",
1462
+ "unverified"
1463
+ ]);
1464
+ const VERIFIABLE_URL_FIELDS = {
1465
+ chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
1466
+ claudeai: ["privacyPolicy"]
1467
+ };
1468
+ const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
1469
+ const policyDisclosureSchema = z.enum([
1470
+ "dataCategories",
1471
+ "purposesOfUse",
1472
+ "recipients",
1473
+ "retention"
1474
+ ]);
1475
+ const urlVerificationFieldResultSchema = z.object({
1476
+ field: verifiableUrlFieldSchema,
1477
+ url: z.string(),
1478
+ outcome: urlVerificationOutcomeSchema,
1479
+ reason: z.string(),
1480
+ concerns: z.array(z.string()).optional(),
1481
+ scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
1482
+ });
1483
+ const urlVerificationSchema = z.object({
1484
+ verifiedAt: z.coerce.date(),
1485
+ results: z.array(urlVerificationFieldResultSchema)
1486
+ });
1487
+ const pageKindSchema = z.enum([
1488
+ "expectedDocument",
1489
+ "errorPage",
1490
+ "loginWall",
1491
+ "parkedDomain",
1492
+ "comingSoon",
1493
+ "marketingPage",
1494
+ "unrelatedDocument"
1495
+ ]);
1496
+ z.object({
1497
+ pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
1498
+ reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
1499
+ missingDisclosures: z.array(policyDisclosureSchema).describe("For a privacy policy only: which of the four required disclosures the text does not cover. Empty for every other page kind.")
1151
1500
  });
1152
- claudeSubmissionFormDataSchema.pick({
1153
- tagline: true,
1154
- description: true,
1155
- category: true,
1156
- testCases: true
1157
- }).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
1158
1501
  const submissionMetaFieldsSchema = z.object({
1159
1502
  id: z.string(),
1160
1503
  environmentId: z.string(),
1504
+ auditId: z.string().nullable(),
1505
+ urlVerification: urlVerificationSchema.nullable().default(null),
1161
1506
  createdAt: z.coerce.date(),
1162
1507
  updatedAt: z.coerce.date()
1163
1508
  });
1164
1509
  const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
1165
1510
  platform: z.literal("claudeai"),
1166
- formData: claudeSubmissionFormDataSchema.partial()
1511
+ formData: claudeSubmissionDraftSchema,
1512
+ prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
1167
1513
  });
1168
1514
  const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
1169
1515
  platform: z.literal("chatgpt"),
1170
- formData: chatgptSubmissionFormDataSchema.partial()
1516
+ formData: chatgptSubmissionDraftSchema,
1517
+ prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
1171
1518
  });
1172
- z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
1173
- z.union([claudeSubmissionFormDataSchema.partial(), chatgptSubmissionFormDataSchema.partial()]);
1519
+ const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
1520
+ z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
1521
+ /** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
1522
+ const submissionSchema = submissionSchemaInternal;
1523
+ z.literal([
1524
+ 100,
1525
+ 75,
1526
+ 50
1527
+ ]);
1174
1528
  const subscriptionPlanSchema = z.enum([
1175
1529
  "pro",
1176
1530
  "business",
@@ -1182,17 +1536,102 @@ const customerCreditsSchema = z.object({
1182
1536
  expiresAt: z.number().nullable(),
1183
1537
  currency: z.string()
1184
1538
  });
1185
- const customerUsageSchema = z.object({
1186
- amountInCents: z.number(),
1187
- currency: z.string(),
1188
- periodEnd: z.number()
1189
- });
1190
1539
  const partnerDiscountSchema = z.object({ endsAt: z.number() });
1191
1540
  z.object({
1192
1541
  customerCredits: customerCreditsSchema.nullable(),
1193
- customerUsage: customerUsageSchema.nullable(),
1194
1542
  partnerDiscount: partnerDiscountSchema.nullable()
1195
1543
  });
1544
+ const metricsQueueEventSchema = z.object({
1545
+ ts: z.number().int(),
1546
+ method: z.string(),
1547
+ tool: z.string().nullable(),
1548
+ client: z.string(),
1549
+ sessionId: z.string().nullable(),
1550
+ durationMs: z.number().int(),
1551
+ outputTokens: z.number().int().nullable(),
1552
+ errorType: z.enum([
1553
+ "mcp_error",
1554
+ "tool_error",
1555
+ "timeout"
1556
+ ]).nullable(),
1557
+ errorCode: z.number().int().nullable()
1558
+ });
1559
+ z.object({
1560
+ v: z.literal(1),
1561
+ envId: z.string(),
1562
+ events: z.array(metricsQueueEventSchema)
1563
+ });
1564
+ z.object({ v: z.number() });
1565
+ const telemetrySignalSchema = z.enum([
1566
+ "logs",
1567
+ "metrics",
1568
+ "traces"
1569
+ ]);
1570
+ const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
1571
+ const otlpEndpointSchema = z.string().trim().min(1).max(2048);
1572
+ const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
1573
+ const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
1574
+ const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
1575
+ const telemetryDestinationHeaderSchema = z.object({
1576
+ id: z.string(),
1577
+ name: otlpHeaderNameSchema,
1578
+ value: otlpHeaderValueSchema,
1579
+ isSecret: z.boolean()
1580
+ });
1581
+ const otlpPushFailureReasonSchema = z.enum([
1582
+ "credentials",
1583
+ "wrong-path",
1584
+ "wrong-protocol",
1585
+ "invalid-payload",
1586
+ "partial-rejection",
1587
+ "blocked-target",
1588
+ "timeout",
1589
+ "unreachable",
1590
+ "receiver-error",
1591
+ "unexpected-status"
1592
+ ]);
1593
+ const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
1594
+ z.object({
1595
+ id: z.string(),
1596
+ signal: telemetrySignalSchema,
1597
+ endpoint: otlpEndpointSchema,
1598
+ protocol: otlpProtocolSchema,
1599
+ headers: z.array(telemetryDestinationHeaderSchema),
1600
+ status: telemetryDestinationStatusSchema,
1601
+ lastFailureReason: otlpPushFailureReasonSchema.nullable()
1602
+ });
1603
+ const webhookEventSchema = z.enum([
1604
+ "deployment.succeeded",
1605
+ "deployment.failed",
1606
+ "deployment.canceled"
1607
+ ]);
1608
+ const webhookDestinationStatusSchema = z.enum(["active", "suspended"]);
1609
+ const webhookDeliveryFailureReasonSchema = z.enum([
1610
+ "credentials",
1611
+ "blocked-target",
1612
+ "timeout",
1613
+ "unreachable",
1614
+ "receiver-error",
1615
+ "unexpected-status"
1616
+ ]);
1617
+ const webhookUrlSchema = z.url({
1618
+ protocol: /^https$/,
1619
+ error: "Enter a valid HTTPS URL"
1620
+ }).max(2048, "Webhook URL must be at most 2048 characters");
1621
+ const webhookEventsSchema = z.array(webhookEventSchema).min(1, "Select at least one event").refine((events) => new Set(events).size === events.length, "Events must be unique");
1622
+ z.object({
1623
+ id: z.string(),
1624
+ url: webhookUrlSchema,
1625
+ events: webhookEventsSchema,
1626
+ status: webhookDestinationStatusSchema,
1627
+ lastFailureReason: webhookDeliveryFailureReasonSchema.nullable()
1628
+ }).extend({ secret: z.string().min(1) });
1629
+ //#endregion
1630
+ //#region src/auth-scope.ts
1631
+ /** Accepts an API key or OAuth access token (default for most routes). */
1632
+ const AUTH_SCOPE_ANY = "any";
1633
+ /** Requires a user OAuth access token; API keys are not accepted. */
1634
+ const AUTH_SCOPE_USER = "user";
1196
1635
  //#endregion
1197
1636
  //#region src/schemas.ts
1198
1637
  const RESERVED_KEYS = [
@@ -1229,7 +1668,10 @@ const RESERVED_KEYS = [
1229
1668
  "BUILD_ARG_START_COMMAND",
1230
1669
  "ALPIC_HOST",
1231
1670
  "ALPIC_CUSTOM_DOMAINS",
1232
- "ALPIC_INTENT_META_KEY"
1671
+ "ALPIC_INTENT_META_KEY",
1672
+ "ALPIC_FEEDBACK_META_KEY",
1673
+ "ALPIC_EVENTS_META_KEY",
1674
+ "ALPIC_IDENTIFY_META_KEY"
1233
1675
  ];
1234
1676
  const environmentVariableSchema = z.object({
1235
1677
  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"),
@@ -1282,6 +1724,14 @@ const serverFieldsSchema = z.object({
1282
1724
  });
1283
1725
  //#endregion
1284
1726
  //#region src/api.contract.ts
1727
+ const isValidIanaTimeZone = (timeZone) => {
1728
+ try {
1729
+ new Intl.DateTimeFormat("en-US", { timeZone });
1730
+ return true;
1731
+ } catch {
1732
+ return false;
1733
+ }
1734
+ };
1285
1735
  const deploymentStatusSchema = z.enum([
1286
1736
  "ongoing",
1287
1737
  "deployed",
@@ -1310,21 +1760,20 @@ const deploymentSchema = z.object({
1310
1760
  isCurrent: z.boolean(),
1311
1761
  deploymentPageUrl: z.url().nullable()
1312
1762
  });
1313
- const isValidLogTimeInput = (value) => {
1763
+ const isValidTimeInput = (value) => {
1314
1764
  if (ms(value) !== void 0) return true;
1315
1765
  return !Number.isNaN(new Date(value).getTime());
1316
1766
  };
1317
- const createEnvironmentContractV1 = oc.route({
1767
+ const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
1768
+ const base = oc.errors({ BAD_REQUEST: {} });
1769
+ const createEnvironmentContractV1 = base.route({
1318
1770
  path: "/v1/environments",
1319
1771
  method: "POST",
1320
1772
  summary: "Create an environment",
1321
1773
  description: "Create an environment for a project",
1322
1774
  tags: ["environments"],
1323
1775
  successDescription: "The environment has been created successfully"
1324
- }).errors({
1325
- NOT_FOUND: {},
1326
- BAD_REQUEST: {}
1327
- }).input(z.object({
1776
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1328
1777
  projectId: z.string().describe("The ID of the project to create the environment for"),
1329
1778
  name: z.string().min(1).describe("The name of the environment"),
1330
1779
  sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
@@ -1337,7 +1786,7 @@ const createEnvironmentContractV1 = oc.route({
1337
1786
  createdAt: z.coerce.date(),
1338
1787
  projectId: z.string().describe("The ID of the project the environment belongs to")
1339
1788
  }));
1340
- const getEnvironmentContractV1 = oc.route({
1789
+ const getEnvironmentContractV1 = base.route({
1341
1790
  path: "/v1/environments/{environmentId}",
1342
1791
  method: "GET",
1343
1792
  summary: "Get an environment",
@@ -1353,6 +1802,14 @@ const getEnvironmentContractV1 = oc.route({
1353
1802
  createdAt: z.coerce.date(),
1354
1803
  projectId: z.string()
1355
1804
  }));
1805
+ const deleteEnvironmentContractV1 = base.route({
1806
+ path: "/v1/environments/{environmentId}",
1807
+ method: "DELETE",
1808
+ summary: "Delete an environment",
1809
+ description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
1810
+ tags: ["environments"],
1811
+ successDescription: "The environment has been deleted successfully"
1812
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
1356
1813
  const domainSchema = z.object({
1357
1814
  domain: z.string(),
1358
1815
  status: z.enum([
@@ -1394,7 +1851,7 @@ const projectOutputSchema = z.object({
1394
1851
  productionEnvironment: productionEnvironmentSchema.nullable(),
1395
1852
  environments: z.array(environmentSchema)
1396
1853
  });
1397
- const getProjectContractV1 = oc.route({
1854
+ const getProjectContractV1 = base.route({
1398
1855
  path: "/v1/projects/{projectId}",
1399
1856
  method: "GET",
1400
1857
  summary: "Get a project",
@@ -1402,18 +1859,15 @@ const getProjectContractV1 = oc.route({
1402
1859
  tags: ["projects"],
1403
1860
  successDescription: "The project details"
1404
1861
  }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
1405
- const listProjectsContractV1 = oc.route({
1862
+ const listProjectsContractV1 = base.route({
1406
1863
  path: "/v1/projects",
1407
1864
  method: "GET",
1408
1865
  summary: "List projects",
1409
1866
  description: "List all projects for a team",
1410
1867
  tags: ["projects"],
1411
1868
  successDescription: "The list of projects"
1412
- }).errors({
1413
- NOT_FOUND: {},
1414
- BAD_REQUEST: {}
1415
- }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
1416
- const createProjectContractV1 = oc.route({
1869
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
1870
+ const createProjectContractV1 = base.route({
1417
1871
  path: "/v1/projects",
1418
1872
  method: "POST",
1419
1873
  summary: "Create a project",
@@ -1422,7 +1876,7 @@ const createProjectContractV1 = oc.route({
1422
1876
  successDescription: "The project has been created successfully"
1423
1877
  }).errors({
1424
1878
  NOT_FOUND: {},
1425
- BAD_REQUEST: {}
1879
+ FORBIDDEN: {}
1426
1880
  }).input(z.object({
1427
1881
  teamId: z.string().optional(),
1428
1882
  name: z.string().trim().min(1).max(100),
@@ -1462,7 +1916,7 @@ const environmentVariableOutputSchema = z.object({
1462
1916
  isSecret: z.boolean(),
1463
1917
  createdAt: z.coerce.date()
1464
1918
  });
1465
- const listEnvironmentVariablesContractV1 = oc.route({
1919
+ const listEnvironmentVariablesContractV1 = base.route({
1466
1920
  path: "/v1/environments/{environmentId}/environment-variables",
1467
1921
  method: "GET",
1468
1922
  summary: "List environment variables",
@@ -1470,48 +1924,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
1470
1924
  tags: ["environments"],
1471
1925
  successDescription: "The list of environment variables"
1472
1926
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
1473
- const createEnvironmentVariablesContractV1 = oc.route({
1927
+ const createEnvironmentVariablesContractV1 = base.route({
1474
1928
  path: "/v1/environments/{environmentId}/environment-variables",
1475
1929
  method: "POST",
1476
1930
  summary: "Add environment variables",
1477
1931
  description: "Add one or more environment variables to an environment",
1478
1932
  tags: ["environments"],
1479
1933
  successDescription: "The environment variables have been added successfully"
1480
- }).errors({
1481
- NOT_FOUND: {},
1482
- BAD_REQUEST: {}
1483
- }).input(z.object({
1934
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1484
1935
  environmentId: z.string().describe("The ID of the environment"),
1485
1936
  environmentVariables: environmentVariablesSchema
1486
1937
  })).output(z.object({ success: z.literal(true) }));
1487
- const updateEnvironmentVariableContractV1 = oc.route({
1938
+ const updateEnvironmentVariableContractV1 = base.route({
1488
1939
  path: "/v1/environment-variables/{environmentVariableId}",
1489
1940
  method: "PATCH",
1490
1941
  summary: "Update an environment variable",
1491
1942
  description: "Update an environment variable by ID",
1492
1943
  tags: ["environments"],
1493
1944
  successDescription: "The environment variable has been updated successfully"
1494
- }).errors({
1495
- NOT_FOUND: {},
1496
- BAD_REQUEST: {}
1497
- }).input(z.object({
1945
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1498
1946
  environmentVariableId: z.string().describe("The ID of the environment variable"),
1499
1947
  key: environmentVariableSchema.shape.key,
1500
1948
  value: environmentVariableSchema.shape.value.optional(),
1501
1949
  isSecret: environmentVariableSchema.shape.isSecret.optional()
1502
1950
  })).output(z.object({ success: z.literal(true) }));
1503
- const deleteEnvironmentVariableContractV1 = oc.route({
1951
+ const deleteEnvironmentVariableContractV1 = base.route({
1504
1952
  path: "/v1/environment-variables/{environmentVariableId}",
1505
1953
  method: "DELETE",
1506
1954
  summary: "Delete an environment variable",
1507
1955
  description: "Delete an environment variable by ID",
1508
1956
  tags: ["environments"],
1509
1957
  successDescription: "The environment variable has been deleted successfully"
1510
- }).errors({
1511
- NOT_FOUND: {},
1512
- BAD_REQUEST: {}
1513
- }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
1514
- const deleteProjectContractV1 = oc.route({
1958
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
1959
+ const deleteProjectContractV1 = base.route({
1515
1960
  path: "/v1/projects/{projectId}",
1516
1961
  method: "DELETE",
1517
1962
  summary: "Delete a project",
@@ -1519,7 +1964,7 @@ const deleteProjectContractV1 = oc.route({
1519
1964
  tags: ["projects"],
1520
1965
  successDescription: "The project has been deleted successfully"
1521
1966
  }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
1522
- const updateProjectContractV1 = oc.route({
1967
+ const updateProjectContractV1 = base.route({
1523
1968
  path: "/v1/projects/{projectId}",
1524
1969
  method: "PATCH",
1525
1970
  summary: "Update a project",
@@ -1528,13 +1973,13 @@ const updateProjectContractV1 = oc.route({
1528
1973
  successDescription: "The project has been updated successfully"
1529
1974
  }).errors({
1530
1975
  NOT_FOUND: {},
1531
- BAD_REQUEST: {}
1976
+ FORBIDDEN: {}
1532
1977
  }).input(z.object({
1533
1978
  projectId: z.string().describe("The ID of the project"),
1534
1979
  name: z.string().min(1).max(100).optional().describe("The new name for the project"),
1535
1980
  sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
1536
1981
  })).output(projectOutputSchema);
1537
- const deployEnvironmentContractV1 = oc.route({
1982
+ const deployEnvironmentContractV1 = base.route({
1538
1983
  path: "/v1/environments/{environmentId}/deploy",
1539
1984
  method: "POST",
1540
1985
  summary: "Deploy an environment",
@@ -1543,27 +1988,25 @@ const deployEnvironmentContractV1 = oc.route({
1543
1988
  successDescription: "The environment has been deployed successfully"
1544
1989
  }).errors({
1545
1990
  NOT_FOUND: {},
1546
- BAD_REQUEST: {}
1991
+ CONFLICT: {}
1547
1992
  }).input(z.object({
1548
1993
  environmentId: z.string().describe("The ID of the environment to deploy"),
1549
- token: z.string().describe("The token to identify the source archive").optional()
1994
+ token: z.string().describe("The token to identify the source archive").optional(),
1995
+ 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.")
1550
1996
  })).output(deploymentSchema);
1551
- const uploadDeploymentArtifactContractV1 = oc.route({
1997
+ const uploadDeploymentArtifactContractV1 = base.route({
1552
1998
  path: "/v1/deployments/upload",
1553
1999
  method: "POST",
1554
2000
  summary: "Upload deployment artifacts",
1555
2001
  description: "Return a presigned S3 URL to upload a deployment artifact",
1556
2002
  tags: ["deployments"],
1557
2003
  successDescription: "The presigned upload URL has been generated successfully"
1558
- }).errors({
1559
- NOT_FOUND: {},
1560
- BAD_REQUEST: {}
1561
- }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
2004
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
1562
2005
  uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
1563
2006
  token: z.string().describe("Token to identify the source archive"),
1564
2007
  expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
1565
2008
  }));
1566
- const listDeploymentsContractV1 = oc.route({
2009
+ const listDeploymentsContractV1 = base.route({
1567
2010
  path: "/v1/projects/{projectId}/deployments",
1568
2011
  method: "GET",
1569
2012
  summary: "List project deployments",
@@ -1575,7 +2018,7 @@ const listDeploymentsContractV1 = oc.route({
1575
2018
  status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
1576
2019
  environmentId: z.string().optional().describe("Filter by environment ID")
1577
2020
  })).output(z.array(deploymentSchema));
1578
- const getDeploymentContractV1 = oc.route({
2021
+ const getDeploymentContractV1 = base.route({
1579
2022
  path: "/v1/deployments/{deploymentId}",
1580
2023
  method: "GET",
1581
2024
  summary: "Get a deployment",
@@ -1583,20 +2026,32 @@ const getDeploymentContractV1 = oc.route({
1583
2026
  tags: ["deployments"],
1584
2027
  successDescription: "The deployment details"
1585
2028
  }).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
1586
- const getLogsContractV1 = oc.route({
2029
+ const logEntrySchema = z.object({
2030
+ timestamp: z.coerce.date(),
2031
+ type: z.enum([
2032
+ "START",
2033
+ "END",
2034
+ "INFO",
2035
+ "ERROR",
2036
+ "WARNING",
2037
+ "DEBUG"
2038
+ ]),
2039
+ requestId: z.string(),
2040
+ content: z.string().optional(),
2041
+ method: z.string().optional(),
2042
+ durationInMs: z.number().optional()
2043
+ });
2044
+ const getLogsContractV1 = base.route({
1587
2045
  path: "/v1/environments/{environmentId}/logs",
1588
2046
  method: "GET",
1589
2047
  summary: "Get logs",
1590
2048
  description: "Get logs for an environment",
1591
2049
  tags: ["environments"],
1592
2050
  successDescription: "The logs"
1593
- }).errors({
1594
- NOT_FOUND: {},
1595
- BAD_REQUEST: {}
1596
- }).input(z.object({
2051
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1597
2052
  environmentId: z.string().describe("The ID of the environment"),
1598
- 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)"),
1599
- 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"),
2053
+ since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
2054
+ until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
1600
2055
  limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
1601
2056
  level: z.array(z.enum([
1602
2057
  "INFO",
@@ -1607,34 +2062,17 @@ const getLogsContractV1 = oc.route({
1607
2062
  search: z.string().optional().describe("Filter pattern to search for in log content"),
1608
2063
  nextToken: z.string().optional().describe("Pagination token from a previous response")
1609
2064
  })).output(z.object({
1610
- logs: z.array(z.object({
1611
- timestamp: z.coerce.date(),
1612
- type: z.enum([
1613
- "START",
1614
- "END",
1615
- "INFO",
1616
- "ERROR",
1617
- "WARNING",
1618
- "DEBUG"
1619
- ]),
1620
- requestId: z.string(),
1621
- content: z.string().optional(),
1622
- method: z.string().optional(),
1623
- durationInMs: z.number().optional()
1624
- })),
2065
+ logs: z.array(logEntrySchema),
1625
2066
  nextToken: z.string().nullable()
1626
2067
  }));
1627
- const getLatestLogsContractV1 = oc.route({
2068
+ const getLatestLogsContractV1 = base.route({
1628
2069
  path: "/v1/environments/{environmentId}/latest-logs",
1629
2070
  method: "GET",
1630
2071
  summary: "Get latest logs",
1631
2072
  description: "Get the N most recent logs for an environment",
1632
2073
  tags: ["environments"],
1633
2074
  successDescription: "The latest logs"
1634
- }).errors({
1635
- NOT_FOUND: {},
1636
- BAD_REQUEST: {}
1637
- }).input(z.object({
2075
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1638
2076
  environmentId: z.string().describe("The ID of the environment"),
1639
2077
  limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
1640
2078
  level: z.array(z.enum([
@@ -1644,22 +2082,8 @@ const getLatestLogsContractV1 = oc.route({
1644
2082
  "DEBUG"
1645
2083
  ])).optional().describe("Filter by log level"),
1646
2084
  search: z.string().optional().describe("Filter pattern to search for in log content")
1647
- })).output(z.object({ logs: z.array(z.object({
1648
- timestamp: z.coerce.date(),
1649
- type: z.enum([
1650
- "START",
1651
- "END",
1652
- "INFO",
1653
- "ERROR",
1654
- "WARNING",
1655
- "DEBUG"
1656
- ]),
1657
- requestId: z.string(),
1658
- content: z.string().optional(),
1659
- method: z.string().optional(),
1660
- durationInMs: z.number().optional()
1661
- })) }));
1662
- const getDeploymentLogsContractV1 = oc.route({
2085
+ })).output(z.object({ logs: z.array(logEntrySchema) }));
2086
+ const getDeploymentLogsContractV1 = base.route({
1663
2087
  path: "/v1/deployments/{deploymentId}/logs",
1664
2088
  method: "GET",
1665
2089
  summary: "Get deployment logs",
@@ -1686,22 +2110,19 @@ const analyticsTimeSeriesSchema = z.object({
1686
2110
  output_token_mean: z.array(analyticsDataPointSchema),
1687
2111
  task_count: z.array(analyticsDataPointSchema)
1688
2112
  });
1689
- const getProjectAnalyticsContractV1 = oc.route({
2113
+ const getProjectAnalyticsContractV1 = base.route({
1690
2114
  path: "/v1/analytics/{projectId}",
1691
2115
  method: "GET",
1692
2116
  summary: "Get project analytics",
1693
2117
  description: "Get analytics data for a project over a time range",
1694
2118
  tags: ["analytics"],
1695
2119
  successDescription: "The project analytics data"
1696
- }).errors({
1697
- NOT_FOUND: {},
1698
- BAD_REQUEST: {}
1699
- }).input(z.object({
2120
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1700
2121
  projectId: z.string().describe("The ID of the project"),
1701
2122
  startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
1702
2123
  endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
1703
2124
  timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
1704
- }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 744 * 60 * 60 * 1e3, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => Intl.supportedValuesOf("timeZone").includes(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
2125
+ }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => isValidIanaTimeZone(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
1705
2126
  metadata: z.object({
1706
2127
  startTimestamp: z.number(),
1707
2128
  endTimestamp: z.number(),
@@ -1711,7 +2132,132 @@ const getProjectAnalyticsContractV1 = oc.route({
1711
2132
  }),
1712
2133
  timeSeries: analyticsTimeSeriesSchema
1713
2134
  }));
1714
- const listTeamsContractV1 = oc.route({
2135
+ const paginatedInsightsInputShape = {
2136
+ environmentId: z.string().describe("The ID of the environment"),
2137
+ since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
2138
+ until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
2139
+ limit: z.coerce.number().int().min(1).max(200).default(50),
2140
+ offset: z.coerce.number().int().min(0).default(0),
2141
+ search: z.string().trim().min(1).max(200).optional()
2142
+ };
2143
+ const listIntentsContractV1 = base.route({
2144
+ path: "/v1/environments/{environmentId}/intents",
2145
+ method: "GET",
2146
+ summary: "List intents",
2147
+ description: "List grouped user intents for an environment over a time range",
2148
+ tags: ["insights"],
2149
+ successDescription: "The grouped user intents"
2150
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2151
+ ...paginatedInsightsInputShape,
2152
+ tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
2153
+ clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
2154
+ categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
2155
+ sortDir: z.enum(["asc", "desc"]).default("desc")
2156
+ })).output(z.object({
2157
+ intents: z.array(z.object({
2158
+ id: z.string(),
2159
+ intentIds: z.array(z.string()).min(1),
2160
+ environmentId: z.string(),
2161
+ message: z.string(),
2162
+ toolName: z.string(),
2163
+ createdAt: z.coerce.date(),
2164
+ occurrenceCount: z.number().int().positive(),
2165
+ clientName: z.string().nullable(),
2166
+ clientId: z.string().nullable(),
2167
+ categories: z.array(z.object({
2168
+ id: z.string(),
2169
+ name: z.string(),
2170
+ color: intentCategoryColorSchema
2171
+ }))
2172
+ })),
2173
+ totalCount: z.number().int().nonnegative()
2174
+ }));
2175
+ const listFeedbacksContractV1 = base.route({
2176
+ path: "/v1/environments/{environmentId}/feedbacks",
2177
+ method: "GET",
2178
+ summary: "List feedbacks",
2179
+ description: "List user feedback for an environment over a time range",
2180
+ tags: ["insights"],
2181
+ successDescription: "The user feedback"
2182
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2183
+ ...paginatedInsightsInputShape,
2184
+ clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
2185
+ })).output(z.object({
2186
+ feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
2187
+ totalCount: z.number().int().nonnegative()
2188
+ }));
2189
+ const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
2190
+ const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
2191
+ const listIntentCategoriesContractV1 = base.route({
2192
+ path: "/v1/environments/{environmentId}/intent-categories",
2193
+ method: "GET",
2194
+ summary: "List intent categories",
2195
+ description: "List intent categories for an environment, including how many intents each category is linked to",
2196
+ tags: ["insights"],
2197
+ successDescription: "The intent categories"
2198
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
2199
+ const createIntentCategoryContractV1 = base.route({
2200
+ path: "/v1/environments/{environmentId}/intent-categories",
2201
+ method: "POST",
2202
+ summary: "Create an intent category",
2203
+ description: "Create an intent category, optionally linking it to existing intents",
2204
+ tags: ["insights"],
2205
+ successDescription: "The created intent category"
2206
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2207
+ environmentId: z.string().describe("The ID of the environment"),
2208
+ name: intentCategoryNameSchema,
2209
+ color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
2210
+ intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
2211
+ })).output(intentCategorySchema);
2212
+ const updateIntentCategoryContractV1 = base.route({
2213
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
2214
+ method: "PATCH",
2215
+ summary: "Update an intent category",
2216
+ description: "Rename or recolor an intent category",
2217
+ tags: ["insights"],
2218
+ successDescription: "The updated intent category"
2219
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2220
+ environmentId: z.string().describe("The ID of the environment"),
2221
+ categoryId: z.string().describe("The ID of the category"),
2222
+ name: intentCategoryNameSchema.optional(),
2223
+ color: intentCategoryColorSchema.optional().describe("The category color")
2224
+ }).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
2225
+ const deleteIntentCategoryContractV1 = base.route({
2226
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
2227
+ method: "DELETE",
2228
+ summary: "Delete an intent category",
2229
+ description: "Delete an intent category; its intents are unlinked but not deleted",
2230
+ tags: ["insights"],
2231
+ successDescription: "The intent category has been deleted successfully"
2232
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2233
+ environmentId: z.string().describe("The ID of the environment"),
2234
+ categoryId: z.string().describe("The ID of the category")
2235
+ })).output(z.object({ success: z.literal(true) }));
2236
+ const linkIntentCategoryContractV1 = base.route({
2237
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
2238
+ method: "POST",
2239
+ summary: "Link an intent category",
2240
+ description: "Link an intent category to intents; already linked intents are ignored",
2241
+ tags: ["insights"],
2242
+ successDescription: "The intents have been linked successfully"
2243
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2244
+ environmentId: z.string().describe("The ID of the environment"),
2245
+ categoryId: z.string().describe("The ID of the category"),
2246
+ intentIds: categorizableIntentIdsSchema
2247
+ })).output(z.object({ success: z.literal(true) }));
2248
+ const unlinkIntentCategoryContractV1 = base.route({
2249
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
2250
+ method: "POST",
2251
+ summary: "Unlink an intent category",
2252
+ description: "Unlink an intent category from intents; intents without the category are ignored",
2253
+ tags: ["insights"],
2254
+ successDescription: "The intents have been unlinked successfully"
2255
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2256
+ environmentId: z.string().describe("The ID of the environment"),
2257
+ categoryId: z.string().describe("The ID of the category"),
2258
+ intentIds: categorizableIntentIdsSchema
2259
+ })).output(z.object({ success: z.literal(true) }));
2260
+ const listTeamsContractV1 = base.route({
1715
2261
  path: "/v1/teams",
1716
2262
  method: "GET",
1717
2263
  summary: "List teams",
@@ -1724,28 +2270,40 @@ const listTeamsContractV1 = oc.route({
1724
2270
  createdAt: z.coerce.date(),
1725
2271
  hasStripeAccount: z.boolean()
1726
2272
  })));
1727
- const getTunnelTicketContractV1 = oc.route({
2273
+ const getTeamUsageContractV1 = base.route({
2274
+ path: "/v1/teams/{teamId}/usage",
2275
+ method: "GET",
2276
+ summary: "Get team usage",
2277
+ description: "Get the MCP request usage of a team for its current billing window. A team that has made no request in the window reports zero.",
2278
+ tags: ["teams"],
2279
+ successDescription: "The current billing window usage"
2280
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
2281
+ teamId: z.string(),
2282
+ plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
2283
+ periodStart: z.coerce.date().describe("Start of the current billing window"),
2284
+ periodEnd: z.coerce.date().describe("End of the current billing window"),
2285
+ requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
2286
+ includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
2287
+ }));
2288
+ const getTunnelTicketContractV1 = base.route({
1728
2289
  path: "/v1/tunnels/ticket",
1729
2290
  method: "GET",
1730
2291
  summary: "Get a tunnel ticket",
1731
2292
  description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
1732
2293
  tags: ["tunnels"],
1733
2294
  successDescription: "The tunnel ticket"
1734
- }).errors({ FORBIDDEN: {} }).output(z.object({
2295
+ }).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
1735
2296
  subdomain: z.string().describe("The subdomain assigned to the user"),
1736
2297
  ticket: z.string().describe("The signed tunnel ticket"),
1737
2298
  tunnelHost: z.string().describe("The tunnel host to connect to")
1738
2299
  }));
1739
- const publishServerContractV1 = oc.route({
2300
+ const publishServerContractV1 = base.route({
1740
2301
  path: "/v1/distribution/publish",
1741
2302
  method: "POST",
1742
2303
  summary: "Publish a server to the MCP registry",
1743
2304
  tags: ["distribution"],
1744
2305
  successDescription: "The server has been published successfully"
1745
- }).errors({
1746
- NOT_FOUND: {},
1747
- BAD_REQUEST: {}
1748
- }).input(z.object({
2306
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1749
2307
  projectId: z.string(),
1750
2308
  domain: z.string(),
1751
2309
  title: z.string().min(1).max(100),
@@ -1754,17 +2312,14 @@ const publishServerContractV1 = oc.route({
1754
2312
  iconSrc: z.url().max(255).optional(),
1755
2313
  dryRun: z.boolean().optional()
1756
2314
  })).output(z.object({ serverFields: serverFieldsSchema }));
1757
- const getServerInfoContractV1 = oc.route({
2315
+ const getServerInfoContractV1 = base.route({
1758
2316
  path: "/v1/distribution/get",
1759
2317
  method: "GET",
1760
2318
  summary: "Get server info",
1761
2319
  description: "Get info about a server",
1762
2320
  tags: ["distribution"],
1763
2321
  successDescription: "The server info"
1764
- }).errors({
1765
- NOT_FOUND: {},
1766
- BAD_REQUEST: {}
1767
- }).input(z.object({
2322
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1768
2323
  projectId: z.string(),
1769
2324
  domain: z.string()
1770
2325
  })).output(z.object({ serverFields: serverFieldsSchema }));
@@ -1783,7 +2338,7 @@ const playgroundOutputSchema = z.object({
1783
2338
  isPlaygroundEnabled: z.boolean(),
1784
2339
  serverMetadata: playgroundServerMetadataOutputSchema.nullable()
1785
2340
  });
1786
- const getPlaygroundContractV1 = oc.route({
2341
+ const getPlaygroundContractV1 = base.route({
1787
2342
  path: "/v1/environments/{environmentId}/playground",
1788
2343
  method: "GET",
1789
2344
  summary: "Get playground configuration",
@@ -1791,17 +2346,14 @@ const getPlaygroundContractV1 = oc.route({
1791
2346
  tags: ["environments"],
1792
2347
  successDescription: "The playground configuration"
1793
2348
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
1794
- const upsertPlaygroundContractV1 = oc.route({
2349
+ const upsertPlaygroundContractV1 = base.route({
1795
2350
  path: "/v1/environments/{environmentId}/playground",
1796
2351
  method: "PUT",
1797
2352
  summary: "Update playground configuration",
1798
2353
  description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
1799
2354
  tags: ["environments"],
1800
2355
  successDescription: "The updated playground configuration"
1801
- }).errors({
1802
- NOT_FOUND: {},
1803
- BAD_REQUEST: {}
1804
- }).input(z.object({
2356
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1805
2357
  environmentId: z.string().describe("The ID of the environment"),
1806
2358
  isPlaygroundEnabled: z.boolean().optional(),
1807
2359
  name: z.string().min(1).max(100).optional(),
@@ -1809,7 +2361,7 @@ const upsertPlaygroundContractV1 = oc.route({
1809
2361
  headers: z.array(playgroundHeaderSchema).optional(),
1810
2362
  examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
1811
2363
  })).output(playgroundOutputSchema);
1812
- const createBeaconContractV1 = oc.route({
2364
+ const createBeaconContractV1 = base.route({
1813
2365
  path: "/v1/beacon/audits",
1814
2366
  method: "POST",
1815
2367
  summary: "Create a beacon audit",
@@ -1818,7 +2370,6 @@ const createBeaconContractV1 = oc.route({
1818
2370
  successDescription: "The audit has been created"
1819
2371
  }).errors({
1820
2372
  NOT_FOUND: {},
1821
- BAD_REQUEST: {},
1822
2373
  DNS_RESOLUTION_FAILED: { status: 400 }
1823
2374
  }).input(z.object({
1824
2375
  targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
@@ -1826,7 +2377,7 @@ const createBeaconContractV1 = oc.route({
1826
2377
  projectId: z.string().optional().describe("The project ID to associate the audit with"),
1827
2378
  excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
1828
2379
  })).output(z.object({ id: z.string() }));
1829
- const getBeaconContractV1 = oc.route({
2380
+ const getBeaconContractV1 = base.route({
1830
2381
  path: "/v1/beacon/audits/{auditId}",
1831
2382
  method: "GET",
1832
2383
  summary: "Get a beacon audit",
@@ -1841,9 +2392,73 @@ const getBeaconContractV1 = oc.route({
1841
2392
  createdAt: z.coerce.date(),
1842
2393
  report: auditReportWithScreenshotsSchema.nullable()
1843
2394
  }));
2395
+ const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
2396
+ const submissionIdSchema = z.string().describe("The ID of the submission package");
2397
+ const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
2398
+ const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
2399
+ const createSubmissionContractV1 = base.route({
2400
+ path: "/v1/submissions",
2401
+ method: "POST",
2402
+ summary: "Create a submission package",
2403
+ description: "Create a submission package for an environment. Alpic reads the environment's live MCP server and prefills every field it can infer, so the response already carries the populated package. The environment must have a successful deployment and must not require authentication.",
2404
+ tags: ["submissions"],
2405
+ successDescription: "The created submission package, with its prefilled fields"
2406
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2407
+ environmentId: z.string().describe("The ID of the environment to build the package from"),
2408
+ platform: platformSchema.describe(PLATFORM_DESCRIPTION)
2409
+ })).output(submissionSchema);
2410
+ const listSubmissionsContractV1 = base.route({
2411
+ path: "/v1/projects/{projectId}/submissions",
2412
+ method: "GET",
2413
+ summary: "List submission packages",
2414
+ description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
2415
+ tags: ["submissions"],
2416
+ successDescription: "The list of submission packages"
2417
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2418
+ projectId: z.string().describe("The ID of the project"),
2419
+ environmentId: z.string().optional().describe("Filter by environment ID"),
2420
+ platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
2421
+ })).output(z.array(submissionSchema));
2422
+ const getSubmissionContractV1 = base.route({
2423
+ path: "/v1/submissions/{submissionId}",
2424
+ method: "GET",
2425
+ summary: "Get a submission package",
2426
+ description: "Get a submission package by ID, including its form data and the prefill it started from",
2427
+ tags: ["submissions"],
2428
+ successDescription: "The submission package"
2429
+ }).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
2430
+ const updateSubmissionContractV1 = base.route({
2431
+ path: "/v1/submissions/{submissionId}",
2432
+ method: "PUT",
2433
+ summary: "Update a submission package",
2434
+ description: "Update the form data of a submission package. Only the fields you send are changed; the rest are left as they are. Unknown field names are rejected rather than ignored, so a typo fails the call. `platform` must match the package's own platform.",
2435
+ tags: ["submissions"],
2436
+ successDescription: "The updated submission package"
2437
+ }).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
2438
+ submissionId: submissionIdSchema,
2439
+ platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
2440
+ formData: claudeSubmissionUpdateSchema
2441
+ }), z.object({
2442
+ submissionId: submissionIdSchema,
2443
+ platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
2444
+ formData: chatgptSubmissionUpdateSchema
2445
+ })])).output(submissionSchema);
1844
2446
  const contract = {
1845
- teams: { list: { v1: listTeamsContractV1 } },
2447
+ teams: {
2448
+ list: { v1: listTeamsContractV1 },
2449
+ getUsage: { v1: getTeamUsageContractV1 }
2450
+ },
1846
2451
  analytics: { get: { v1: getProjectAnalyticsContractV1 } },
2452
+ intents: { list: { v1: listIntentsContractV1 } },
2453
+ intentCategories: {
2454
+ list: { v1: listIntentCategoriesContractV1 },
2455
+ create: { v1: createIntentCategoryContractV1 },
2456
+ update: { v1: updateIntentCategoryContractV1 },
2457
+ delete: { v1: deleteIntentCategoryContractV1 },
2458
+ link: { v1: linkIntentCategoryContractV1 },
2459
+ unlink: { v1: unlinkIntentCategoryContractV1 }
2460
+ },
2461
+ feedbacks: { list: { v1: listFeedbacksContractV1 } },
1847
2462
  deployments: {
1848
2463
  list: { v1: listDeploymentsContractV1 },
1849
2464
  get: { v1: getDeploymentContractV1 },
@@ -1853,6 +2468,7 @@ const contract = {
1853
2468
  environments: {
1854
2469
  create: { v1: createEnvironmentContractV1 },
1855
2470
  get: { v1: getEnvironmentContractV1 },
2471
+ delete: { v1: deleteEnvironmentContractV1 },
1856
2472
  deploy: { v1: deployEnvironmentContractV1 },
1857
2473
  getLogs: { v1: getLogsContractV1 },
1858
2474
  getLatestLogs: { v1: getLatestLogsContractV1 }
@@ -1882,7 +2498,39 @@ const contract = {
1882
2498
  beacon: {
1883
2499
  create: { v1: createBeaconContractV1 },
1884
2500
  get: { v1: getBeaconContractV1 }
2501
+ },
2502
+ submissions: {
2503
+ create: { v1: createSubmissionContractV1 },
2504
+ list: { v1: listSubmissionsContractV1 },
2505
+ get: { v1: getSubmissionContractV1 },
2506
+ update: { v1: updateSubmissionContractV1 }
2507
+ }
2508
+ };
2509
+ const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
2510
+ const contractForDocs = {
2511
+ ...contract,
2512
+ deployments: deploymentsForDocs
2513
+ };
2514
+ /** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
2515
+ const OPENAPI_DOC_OPTIONS = {
2516
+ info: {
2517
+ title: "Alpic API",
2518
+ version: "1.0.0"
2519
+ },
2520
+ servers: [{ url: "https://api.alpic.ai" }],
2521
+ security: [{ bearerAuth: [] }],
2522
+ components: { securitySchemes: { bearerAuth: {
2523
+ type: "http",
2524
+ description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
2525
+ scheme: "bearer"
2526
+ } } },
2527
+ commonSchemas: {
2528
+ Submission: { schema: submissionSchema },
2529
+ ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
2530
+ ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
2531
+ ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
2532
+ ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
1885
2533
  }
1886
2534
  };
1887
2535
  //#endregion
1888
- export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
2536
+ export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, PLATFORM_LABELS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };