@alpic-ai/api 0.0.0-dev.gf024eb9 → 0.0.0-dev.gf032af2

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 +1536 -48
  2. package/dist/index.mjs +741 -376
  3. package/package.json +24 -8
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_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
5
+ //#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
6
6
  /**
7
7
  * Reusable URL validation that disallows javascript: scheme
8
8
  */
@@ -169,11 +169,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),
@@ -373,14 +418,17 @@ z.object({
373
418
  sessionReplayEnabled: z.boolean(),
374
419
  collectRequestPayload: z.boolean(),
375
420
  collectResponsePayload: z.boolean(),
376
- collectErrorMessage: z.boolean()
421
+ collectErrorMessage: z.boolean(),
422
+ collectUserData: z.boolean(),
423
+ identityTraitKey: z.string().min(1).max(200).nullable()
377
424
  });
378
- z.object({
425
+ const feedbackSchema = z.object({
379
426
  id: z.string(),
380
427
  createdAt: z.coerce.date(),
381
428
  environmentId: z.string(),
382
429
  content: z.string(),
383
- source: z.enum(["model", "user"])
430
+ source: z.enum(["model", "user"]),
431
+ clientName: z.string().nullable()
384
432
  });
385
433
  z.object({
386
434
  content: z.string(),
@@ -396,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
396
444
  "pink",
397
445
  "gray"
398
446
  ]);
399
- intentCategoryColorSchema.options;
447
+ const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
400
448
  const intentCategorySchema = z.object({
401
449
  id: z.string(),
402
450
  createdAt: z.coerce.date(),
@@ -404,7 +452,7 @@ const intentCategorySchema = z.object({
404
452
  name: z.string(),
405
453
  color: intentCategoryColorSchema
406
454
  });
407
- z.object({
455
+ const intentCategorySummarySchema = z.object({
408
456
  id: z.string(),
409
457
  name: z.string(),
410
458
  color: intentCategoryColorSchema,
@@ -416,6 +464,7 @@ z.object({
416
464
  environmentId: z.string(),
417
465
  toolName: z.string(),
418
466
  message: z.string(),
467
+ clientName: z.string().nullable(),
419
468
  categories: z.array(intentCategorySchema)
420
469
  });
421
470
  const signalCategorySchema = z.object({
@@ -480,6 +529,246 @@ z.enum([
480
529
  "DEBUG",
481
530
  "ERROR"
482
531
  ]);
532
+ /** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
533
+ const MCP_CLIENT_GROUPS = [
534
+ {
535
+ id: "claude_code",
536
+ label: "Claude Code",
537
+ vendor: "anthropic",
538
+ rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
539
+ },
540
+ {
541
+ id: "claude",
542
+ label: "Claude",
543
+ vendor: "anthropic",
544
+ rawNames: [
545
+ "Anthropic/ClaudeAI",
546
+ "claude-ai",
547
+ "claude",
548
+ "Claude",
549
+ "claude-desktop",
550
+ "claude-desktop-3p"
551
+ ]
552
+ },
553
+ {
554
+ id: "claude_mobile",
555
+ label: "Claude mobile",
556
+ vendor: "anthropic",
557
+ rawNames: ["claude-ios", "ClaudeAndroid"]
558
+ },
559
+ {
560
+ id: "claude_cowork",
561
+ label: "Claude Cowork",
562
+ vendor: "anthropic",
563
+ rawNames: ["Anthropic/Cowork"]
564
+ },
565
+ {
566
+ id: "claude_toolbox",
567
+ label: "Claude Toolbox",
568
+ vendor: "anthropic",
569
+ rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
570
+ },
571
+ {
572
+ id: "anthropic_api",
573
+ label: "Anthropic API",
574
+ vendor: "anthropic",
575
+ rawNames: ["Anthropic/API"]
576
+ },
577
+ {
578
+ id: "anthropic_connector_refresh",
579
+ label: "Anthropic (connector refresh)",
580
+ vendor: "anthropic",
581
+ rawNames: ["Anthropic"]
582
+ },
583
+ {
584
+ id: "codex",
585
+ label: "Codex",
586
+ vendor: "openai",
587
+ rawNames: [
588
+ "codex-mcp-client",
589
+ "codex",
590
+ "Codex",
591
+ "codex-cli",
592
+ "openai-mcp (Codex)"
593
+ ]
594
+ },
595
+ {
596
+ id: "chatgpt",
597
+ label: "ChatGPT",
598
+ vendor: "openai",
599
+ rawNames: ["openai-mcp (ChatGPT)"]
600
+ },
601
+ {
602
+ id: "openai_responses_api",
603
+ label: "OpenAI Responses API",
604
+ vendor: "openai",
605
+ rawNames: ["openai-mcp (Responses API)"]
606
+ },
607
+ {
608
+ id: "openai_agent_builder",
609
+ label: "OpenAI Agent Builder",
610
+ vendor: "openai",
611
+ rawNames: ["openai-mcp (Agent Builder)"]
612
+ },
613
+ {
614
+ id: "openai_other",
615
+ label: "OpenAI Other",
616
+ vendor: "openai",
617
+ rawNames: ["openai-mcp"]
618
+ },
619
+ {
620
+ id: "cursor",
621
+ label: "Cursor",
622
+ vendor: "cursor",
623
+ rawNames: [
624
+ "cursor-vscode",
625
+ "Cursor",
626
+ "cursor"
627
+ ]
628
+ },
629
+ {
630
+ id: "cline",
631
+ label: "Cline",
632
+ vendor: "cline",
633
+ rawNames: [
634
+ "Cline",
635
+ "cline",
636
+ "@cline/core"
637
+ ]
638
+ },
639
+ {
640
+ id: "github_copilot",
641
+ label: "GitHub Copilot",
642
+ vendor: "githubCopilot",
643
+ rawNames: [
644
+ "Copilot",
645
+ "github-copilot-developer",
646
+ "Copilot MCP Gateway",
647
+ "Xcode/copilot-xcode"
648
+ ]
649
+ },
650
+ {
651
+ id: "gemini_cli",
652
+ label: "Gemini CLI",
653
+ vendor: "google",
654
+ rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
655
+ },
656
+ {
657
+ id: "antigravity",
658
+ label: "Antigravity",
659
+ vendor: "google",
660
+ rawNames: ["antigravity-client"]
661
+ },
662
+ {
663
+ id: "gemini",
664
+ label: "Gemini",
665
+ vendor: "google",
666
+ rawNames: ["Gemini", "google-ai-edge-gallery"]
667
+ },
668
+ {
669
+ id: "windsurf",
670
+ label: "Windsurf",
671
+ vendor: "windsurf",
672
+ rawNames: ["Windsurf", "windsurf-client"]
673
+ },
674
+ {
675
+ id: "mistral",
676
+ label: "Mistral / Le Chat",
677
+ vendor: "mistral",
678
+ rawNames: ["Mistral"],
679
+ rawNamePrefixes: ["connector:custom-mcp:"]
680
+ },
681
+ {
682
+ id: "n8n",
683
+ label: "n8n",
684
+ vendor: "n8n",
685
+ rawNames: [
686
+ "@n8n/n8n-nodes-langchain.mcpClient",
687
+ "@n8n/n8n-nodes-langchain.mcpClientTool",
688
+ "n8n"
689
+ ]
690
+ },
691
+ {
692
+ id: "alpic_playground",
693
+ label: "Alpic Playground",
694
+ vendor: "alpic",
695
+ rawNames: ["alpic-playground", "playground"]
696
+ },
697
+ {
698
+ id: "opencode",
699
+ label: "opencode",
700
+ vendor: "opencode",
701
+ rawNames: ["opencode"]
702
+ },
703
+ {
704
+ id: "zed",
705
+ label: "Zed",
706
+ vendor: "zed",
707
+ rawNames: ["Zed", "zed"]
708
+ },
709
+ {
710
+ id: "zapier",
711
+ label: "Zapier",
712
+ vendor: "zapier",
713
+ rawNames: ["Zapier", "zapier"]
714
+ },
715
+ {
716
+ id: "make",
717
+ label: "Make",
718
+ vendor: "make",
719
+ rawNames: ["Make", "make"]
720
+ },
721
+ {
722
+ id: "librechat",
723
+ label: "LibreChat",
724
+ vendor: "mcp",
725
+ rawNames: ["LibreChat", "librechat"]
726
+ },
727
+ {
728
+ id: "jan",
729
+ label: "Jan",
730
+ vendor: "mcp",
731
+ rawNames: ["Jan", "jan"]
732
+ },
733
+ {
734
+ id: "goose",
735
+ label: "goose",
736
+ vendor: "mcp",
737
+ rawNames: ["goose", "Goose"]
738
+ },
739
+ {
740
+ id: "mcphost",
741
+ label: "mcphost",
742
+ vendor: "mcp",
743
+ rawNames: ["mcphost"]
744
+ },
745
+ {
746
+ id: "mcporter",
747
+ label: "mcporter",
748
+ vendor: "mcp",
749
+ rawNames: ["mcporter"]
750
+ },
751
+ {
752
+ id: "rmcp",
753
+ label: "rmcp",
754
+ vendor: "mcp",
755
+ rawNames: ["rmcp"]
756
+ },
757
+ {
758
+ id: "unnamed_client",
759
+ label: "Unnamed client",
760
+ vendor: "mcp",
761
+ rawNames: [
762
+ "mcp",
763
+ "unknown",
764
+ ""
765
+ ]
766
+ }
767
+ ];
768
+ /** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
769
+ const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
770
+ new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
771
+ new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
483
772
  const runtimeSchema = z.enum([
484
773
  "python3.13",
485
774
  "python3.14",
@@ -508,15 +797,27 @@ z.object({
508
797
  environments: z.array(environmentWithDomainsSchema),
509
798
  productionEnvironment: environmentWithDomainsSchema.nullable()
510
799
  });
800
+ const domainFailureReasonSchema = z.enum([
801
+ "caa",
802
+ "dns",
803
+ "invalid_domain",
804
+ "other"
805
+ ]);
806
+ const projectDomainMappingSchema = z.object({
807
+ pathPrefix: z.string(),
808
+ environment: environmentSchema$1
809
+ });
511
810
  z.object({
512
- domain: z.string(),
811
+ name: z.string(),
513
812
  createdAt: z.coerce.date(),
514
813
  status: z.enum([
515
814
  "ongoing",
516
815
  "deployed",
517
816
  "failed"
518
817
  ]),
519
- environment: environmentSchema$1
818
+ failureReason: domainFailureReasonSchema.nullable(),
819
+ environment: environmentSchema$1,
820
+ mappings: z.array(projectDomainMappingSchema)
520
821
  });
521
822
  const serverFieldsSchema$1 = z.object({
522
823
  $schema: z.string(),
@@ -545,15 +846,7 @@ z.object({
545
846
  serverFields: serverFieldsSchema$1,
546
847
  source: z.enum(["registry", "defaults"])
547
848
  });
548
- /**
549
- * Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
550
- * rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
551
- *
552
- * NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
553
- * `minLength`, and the description. Any other validators on the source field (`.regex()`,
554
- * `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
555
- * free-text length caps only. A field with `null` `maxLength` is returned unchanged.
556
- */
849
+ /** 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. */
557
850
  const clampStringField = (field) => {
558
851
  const max = field.maxLength;
559
852
  if (max === null) return field;
@@ -580,10 +873,13 @@ const positiveTestCaseSchema = z.object({
580
873
  }).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
581
874
  const screenshotEntrySchema = z.object({
582
875
  prompt: z.string(),
583
- url: z.url().or(z.literal(""))
876
+ url: z.url()
584
877
  }).describe("Each screenshot: the user prompt that produced it + the image URL.");
878
+ const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
585
879
  /** Accepts either a valid email or URL. */
586
880
  const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
881
+ /** A URL field whose error spells out that the scheme is required. */
882
+ const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
587
883
  const chatgptCategorySchema = z.enum([
588
884
  "BUSINESS",
589
885
  "COLLABORATION",
@@ -896,11 +1192,7 @@ const chatgptToolJustificationSchema = z.object({
896
1192
  openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
897
1193
  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.\"")
898
1194
  }).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
899
- /**
900
- * Base copy fields, defined once and reused by both the submission form and per-locale
901
- * translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
902
- * path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
903
- */
1195
+ /** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
904
1196
  const chatgptTaglineSchema = z.string().max(30);
905
1197
  const chatgptDescriptionSchema = z.string();
906
1198
  const chatgptTranslationSchema = z.object({
@@ -909,10 +1201,7 @@ const chatgptTranslationSchema = z.object({
909
1201
  description: chatgptDescriptionSchema
910
1202
  }).describe("Locale-scoped override for tagline + description. English (US) is the default.");
911
1203
  chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
912
- /**
913
- * Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
914
- * When adding/removing/reordering fields, keep this in sync with the sheet.
915
- */
1204
+ /** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
916
1205
  const chatgptSubmissionFormDataSchema = z.object({
917
1206
  logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
918
1207
  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."),
@@ -921,23 +1210,34 @@ const chatgptSubmissionFormDataSchema = z.object({
921
1210
  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)."),
922
1211
  category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
923
1212
  developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
924
- companyUrl: z.url().describe("Your company's main website URL."),
1213
+ companyUrl: urlField.describe("Your company's main website URL."),
925
1214
  supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
926
- privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
927
- termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
928
- 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."),
1215
+ privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
1216
+ termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
1217
+ 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."),
929
1218
  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."),
930
- serverUrl: z.url().describe("URL of the MCP server."),
1219
+ serverUrl: urlField.describe("URL of the MCP server."),
931
1220
  authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
932
1221
  tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
933
1222
  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."),
934
1223
  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."),
935
1224
  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."),
936
- 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."),
1225
+ 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."),
937
1226
  translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
938
1227
  allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
939
1228
  releaseNotes: z.string().describe("Publicly displayed on the app details page.")
940
1229
  });
1230
+ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
1231
+ tagline: z.string().optional(),
1232
+ companyUrl: z.string().optional(),
1233
+ supportChannel: z.string().optional(),
1234
+ privacyPolicyUrl: z.string().optional(),
1235
+ termsOfServiceUrl: z.string().optional(),
1236
+ demoRecordingUrl: z.string().optional(),
1237
+ serverUrl: z.string().optional(),
1238
+ screenshots: z.array(screenshotDraftEntrySchema).optional(),
1239
+ translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
1240
+ });
941
1241
  chatgptSubmissionFormDataSchema.pick({
942
1242
  appName: true,
943
1243
  developerName: true,
@@ -954,7 +1254,7 @@ chatgptSubmissionFormDataSchema.pick({
954
1254
  toolJustifications: true
955
1255
  }).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
956
1256
  const claudeCategorySchema = z.enum([
957
- "Business & Productivity",
1257
+ "Productivity",
958
1258
  "Communication",
959
1259
  "Data & Analytics",
960
1260
  "Development tools",
@@ -962,205 +1262,145 @@ const claudeCategorySchema = z.enum([
962
1262
  "Consumer Health",
963
1263
  "Health & Life Sciences",
964
1264
  "Media & Entertainment",
965
- "Commerce & Shopping"
1265
+ "Commerce & Shopping",
1266
+ "Legal",
1267
+ "Sales and marketing",
1268
+ "Creative",
1269
+ "Nonprofit",
1270
+ "Education",
1271
+ "Other"
966
1272
  ]);
967
- const claudeAuthenticationSchema = z.enum([
968
- "No auth needed",
969
- "OAuth 2.0",
970
- "Custom URL"
971
- ]);
972
- const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
973
- z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
1273
+ const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
974
1274
  const claudeReadWriteCapabilitiesSchema = z.enum([
975
- "Read Only",
976
- "Write Only",
977
- "Read + Write"
978
- ]);
979
- const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
980
- const claudeTestedSurfaceSchema = z.enum([
981
- "Claude.ai (web)",
982
- "Claude Desktop",
983
- "Claude Code",
984
- "Cowork"
1275
+ "read_only",
1276
+ "write_only",
1277
+ "read_write"
985
1278
  ]);
986
- const claudeThirdPartySchema = z.enum([
987
- "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)",
988
- "Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
989
- "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)",
990
- "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)",
991
- "N/A"
1279
+ const claudeAuthenticationSchema = z.enum([
1280
+ "oauth_dcr",
1281
+ "oauth_cimd",
1282
+ "oauth_anthropic_creds",
1283
+ "custom_connection",
1284
+ "none"
992
1285
  ]);
993
- const claudeDataHandlingSchema = z.enum([
994
- "Server only accesses data explicitly requested by user",
995
- "No data is stored beyond session requirements",
996
- "Data transmission is encrypted (HTTPS/TLS)",
997
- "GDPR compliant (if applicable)"
1286
+ const claudeApiOwnershipSchema = z.enum([
1287
+ "first_party",
1288
+ "proxied",
1289
+ "third_party"
998
1290
  ]);
999
- const claudeSponsoredContentSchema = z.enum([
1000
- "No, there is no sponsored content or advertisements",
1001
- "Yes, there are banner ads or other paid visual elements",
1002
- "Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement"
1291
+ const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
1292
+ const claudePolicyAcknowledgementSchema = z.enum([
1293
+ "I have read and understand the MCP Directory developer guidelines.",
1294
+ "My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
1295
+ "My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
1296
+ "My connector does not use AI models to generate images, video, or audio.",
1297
+ "Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
1298
+ "My connector does not collect conversation data beyond what is needed for its function.",
1299
+ "Public documentation for this connector will be live by the publish date."
1003
1300
  ]);
1004
- /**
1005
- * Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
1006
- * When adding/removing/reordering fields, keep this in sync with the sheet.
1007
- */
1301
+ /** 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. */
1008
1302
  const claudeSubmissionFormDataSchema = z.object({
1009
- 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."),
1010
- 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."),
1011
- 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."),
1012
- 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."),
1013
- 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."),
1014
- 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."),
1015
- appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
1016
-
1017
- Rules:
1018
- (1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
1019
- (2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
1020
- (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.`),
1021
- mcpUrlType: claudeMcpUrlTypeSchema.describe(`Choose how your server URL works:
1022
- • 'Universal URL': one single URL that all users connect to (most common). Example: https://mcp.myapp.com
1023
- • 'Custom MCP URLs': each user gets their own unique URL (e.g. based on their workspace or instance).
1024
- 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.`),
1025
- 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/
1026
- 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.`),
1027
- 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.
1028
- 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...'`),
1029
- 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.`),
1030
- 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.
1031
- Best format: [Use case]: [exact prompt]"
1032
- Example for a task manager:
1033
- 1. Create a task: 'Create a task called Review Q3 report, due Friday, assigned to Alice'
1034
- 2. Search tasks: 'Show me all open bugs in the Mobile project'
1035
- 3. Update status: 'Mark the Deploy v2.1 task as done'"`),
1036
- connectionRequirements: z.string().describe(`Describe any prerequisites a user must have before they can connect your server. Be exhaustive. Examples of things to mention:
1037
- • Account type required (free vs paid plan)
1038
- • Admin permissions or specific roles needed
1039
- • Geographic restrictions (e.g. 'US only' or 'Not available in EU')
1040
- • If users need to provide their own server URL or instance domain
1041
- • Any setup steps needed before connecting (e.g. 'Enable API access in your account settings')
1042
- If there are genuinely no special requirements, write exactly: 'No special requirements.'`),
1043
- readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`Select the option that best describes what your server can do:
1044
-
1045
- 'Read Only': your tools only fetch/retrieve data (GET operations). Claude cannot modify anything via your server.
1046
- 'Write Only': your tools only create/update/delete data (rare).
1047
- 'Read + Write': your tools can both retrieve AND modify data (most common for full-featured connectors).
1048
-
1049
- 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. `),
1050
- isMcpApp: z.boolean().describe(`Select 'Yes' if your MCP server renders interactive UI elements (aka widgets or views) inside the Claude conversation.
1051
- Select 'No' if your server only returns text/data responses.
1052
- 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.`),
1053
- thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe(`Multi-select all that apply to your server's behavior:
1054
- • 'Web access' — your server fetches arbitrary URLs, scrapes websites, or makes open-ended HTTP requests to the web (not just your own API).
1055
- • 'Third-party AI model integration' — your server calls another AI model (e.g. OpenAI, Gemini, Cohere) as part of its processing.
1056
- • '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.
1057
- • 'Third-party data modification' — your server modifies data via such a platform.
1058
- • 'N/A' — your server only calls your own first-party API and does nothing else. Select this only if none of the above apply.`),
1059
- 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:
1060
- • 'Server only accesses data explicitly requested by user' — your server doesn't silently read unrelated user data.
1061
- • 'No data is stored beyond session requirements' — you don't log or retain conversation data after the session.
1062
- • 'Data transmission is encrypted (HTTPS/TLS)' — all data in transit is encrypted. This should always apply for remote servers.
1063
- • '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.
1064
- Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
1065
- 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.
1066
- Select 'No' for the vast majority of business/productivity/dev tools. When in doubt, select 'No'. This field triggers additional compliance review if 'Yes'.`),
1067
- 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:
1068
- • Business & Productivity — project management, CRM, HR, office tools
1069
- • Communication — email, chat, messaging, notifications
1070
- • Data & Analytics — dashboards, reporting, databases, BI tools
1071
- • Development tools — code repositories, CI/CD, issue trackers, monitoring
1072
- • Financial Services — accounting, invoicing, fintech (note: financial transaction execution is not permitted)
1073
- • Consumer Health — fitness, wellness, personal health tracking
1074
- • Health & Life Sciences — clinical, pharma, medical professional tools
1075
- • Media & Entertainment — content, publishing, streaming
1076
- • Commerce & Shopping — e-commerce, inventory, orders
1077
- Anthropic's submission form only accepts a single category.`),
1078
- 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:
1079
- • '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.
1080
- • '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.
1081
- • '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.
1082
- 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'.`),
1083
- authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
1084
- transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
1085
- • 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
1086
- • '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.
1087
- If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
1088
- 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:
1089
- • What the connector does and its key capabilities
1090
- • How to connect/set it up (step by step)
1091
- • What each tool does (or at least the main ones)
1092
- • How to troubleshoot common issues
1093
- • A support contact or channel
1094
- 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.`),
1095
- 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:
1096
- • What data you collect (and how)
1097
- • How you use the collected data
1098
- • Where and how long you store it
1099
- • Whether you share data with third parties (and who)
1100
- • How users can contact you about data concerns
1101
- 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.`),
1102
- 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:
1103
- • Email address (e.g. support@myapp.com)
1104
- • Link to a GitHub Issues page
1105
- • Link to a help center or support article
1106
- • Link to a Discord/Slack community
1107
- • Link to your documentation's troubleshooting section
1108
- Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
1109
- 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:
1110
- • The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
1111
- • No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
1112
- • 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.
1113
- • Credentials must remain valid for at least 30 days from submission.
1114
- • If your service requires API keys instead of a password, provide those.
1115
- Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
1116
- 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.
1117
- Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
1118
- 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.`),
1119
- toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
1120
- • 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
1121
- • '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).
1122
- 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.`),
1123
- 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.`),
1124
- logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
1125
- • Format: SVG only
1126
- • Aspect ratio: square (1:1)
1127
- • Should work on a light background
1128
- • Provide via URL (Google Drive link is fine) or upload directly
1129
- Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
1130
- 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.`),
1131
- 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:
1132
- • 3–5 images is ideal
1133
- • Minimum 1000px width, PNG format preferred
1134
- • Each screenshot is paired with the user prompt that produced it
1135
- • Crop to just the relevant part of the Claude interface (the tool response area)
1136
- • Show your connector doing something impressive and useful — real data, real results
1137
- • If you're an MCP App, include screenshots of your interactive UI elements
1138
- These images appear in your directory listing and are a key factor in driving user installs.`)
1303
+ 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
1304
+ from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
1305
+ The server must be publicly accessible without VPN or whitelisting.`),
1306
+ 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
1307
+ own or have the right to use this name. Max 100 characters.`),
1308
+ 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.
1309
+ PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
1310
+ oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
1311
+ phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
1312
+ 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
1313
+ claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
1314
+ categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
1315
+ 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
1316
+ (recommended); upload a custom icon only to override it.`),
1317
+ documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
1318
+ accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
1319
+ by your publish date.`),
1320
+ support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
1321
+ used to notify you of security or compliance issues, so make sure it's actively monitored.`),
1322
+ privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
1323
+ what data you collect, how you use and store it, and whether you share it with third parties.`),
1324
+ 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
1325
+ it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
1326
+ primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
1327
+ type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
1328
+ connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
1329
+ permissions'). If there are genuinely no special requirements, say so explicitly.`),
1330
+ readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
1331
+ • 'read_only': retrieves data but never modifies it.
1332
+ • 'write_only': creates or modifies data but does not read it.
1333
+ • 'read_write': both retrieves and modifies data (most common).`),
1334
+ companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
1335
+ companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
1336
+ primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
1337
+ primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
1338
+ primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
1339
+ anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
1340
+ authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
1341
+ • 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
1342
+ • 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
1343
+ • 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
1344
+ • 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
1345
+ • 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
1346
+ partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
1347
+ apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
1348
+ • 'first_party': the MCP server calls your own production APIs.
1349
+ • 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
1350
+ • 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
1351
+ personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
1352
+ No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
1353
+ sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
1354
+ No → false, Yes → true, or { other: explanation }.`),
1355
+ testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
1356
+ the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
1357
+ fully populated account.`),
1358
+ selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
1359
+ policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
1360
+ submission. Each is an attestation you are legally agreeing to by submitting.`),
1361
+ additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
1362
+ });
1363
+ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
1364
+ serverUrl: z.string().optional(),
1365
+ name: z.string().optional(),
1366
+ slug: z.string().optional(),
1367
+ oneLiner: z.string().optional(),
1368
+ description: z.string().optional(),
1369
+ iconUrl: z.string().optional(),
1370
+ documentation: z.string().optional(),
1371
+ support: z.string().optional(),
1372
+ privacyPolicy: z.string().optional(),
1373
+ companyWebsite: z.string().optional(),
1374
+ primaryContactEmail: z.string().optional(),
1375
+ categories: z.array(claudeCategorySchema).optional(),
1376
+ screenshots: z.array(screenshotDraftEntrySchema).optional()
1139
1377
  });
1140
1378
  claudeSubmissionFormDataSchema.pick({
1141
- companyName: true,
1142
- appName: true,
1143
- mcpUrlType: true,
1144
1379
  serverUrl: true,
1145
- tools: true,
1146
- readWriteCapabilities: true,
1147
- isMcpApp: true,
1148
- transportSupport: true,
1380
+ name: true,
1381
+ slug: true,
1382
+ companyName: true,
1149
1383
  primaryContactEmail: true,
1150
1384
  primaryContactName: true,
1385
+ readWriteCapabilities: true,
1151
1386
  authentication: true,
1152
- personalDataHealthAccess: true,
1153
- testedSurfaces: true
1387
+ apiOwnership: true,
1388
+ personalHealthData: true
1154
1389
  }).extend({
1155
1390
  connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
1156
- testingCredentials: claudeSubmissionFormDataSchema.shape.testingCredentials.optional()
1391
+ testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
1392
+ });
1393
+ /** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
1394
+ const claudeAiGeneratedFormDataRawSchema = z.object({
1395
+ oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
1396
+ description: claudeSubmissionFormDataSchema.shape.description,
1397
+ categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
1398
+ primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
1399
+ });
1400
+ claudeAiGeneratedFormDataRawSchema.extend({
1401
+ oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
1402
+ categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
1157
1403
  });
1158
- claudeSubmissionFormDataSchema.pick({
1159
- tagline: true,
1160
- description: true,
1161
- category: true,
1162
- testCases: true
1163
- }).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
1164
1404
  const submissionMetaFieldsSchema = z.object({
1165
1405
  id: z.string(),
1166
1406
  environmentId: z.string(),
@@ -1170,14 +1410,19 @@ const submissionMetaFieldsSchema = z.object({
1170
1410
  });
1171
1411
  const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
1172
1412
  platform: z.literal("claudeai"),
1173
- formData: claudeSubmissionFormDataSchema.partial()
1413
+ formData: claudeSubmissionDraftSchema
1174
1414
  });
1175
1415
  const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
1176
1416
  platform: z.literal("chatgpt"),
1177
- formData: chatgptSubmissionFormDataSchema.partial()
1417
+ formData: chatgptSubmissionDraftSchema
1178
1418
  });
1179
1419
  z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
1180
- z.union([claudeSubmissionFormDataSchema.partial(), chatgptSubmissionFormDataSchema.partial()]);
1420
+ z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
1421
+ z.literal([
1422
+ 100,
1423
+ 75,
1424
+ 50
1425
+ ]);
1181
1426
  const subscriptionPlanSchema = z.enum([
1182
1427
  "pro",
1183
1428
  "business",
@@ -1201,6 +1446,12 @@ z.object({
1201
1446
  partnerDiscount: partnerDiscountSchema.nullable()
1202
1447
  });
1203
1448
  //#endregion
1449
+ //#region src/auth-scope.ts
1450
+ /** Accepts an API key or OAuth access token (default for most routes). */
1451
+ const AUTH_SCOPE_ANY = "any";
1452
+ /** Requires a user OAuth access token; API keys are not accepted. */
1453
+ const AUTH_SCOPE_USER = "user";
1454
+ //#endregion
1204
1455
  //#region src/schemas.ts
1205
1456
  const RESERVED_KEYS = [
1206
1457
  "_HANDLER",
@@ -1236,7 +1487,10 @@ const RESERVED_KEYS = [
1236
1487
  "BUILD_ARG_START_COMMAND",
1237
1488
  "ALPIC_HOST",
1238
1489
  "ALPIC_CUSTOM_DOMAINS",
1239
- "ALPIC_INTENT_META_KEY"
1490
+ "ALPIC_INTENT_META_KEY",
1491
+ "ALPIC_FEEDBACK_META_KEY",
1492
+ "ALPIC_EVENTS_META_KEY",
1493
+ "ALPIC_IDENTIFY_META_KEY"
1240
1494
  ];
1241
1495
  const environmentVariableSchema = z.object({
1242
1496
  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"),
@@ -1317,21 +1571,20 @@ const deploymentSchema = z.object({
1317
1571
  isCurrent: z.boolean(),
1318
1572
  deploymentPageUrl: z.url().nullable()
1319
1573
  });
1320
- const isValidLogTimeInput = (value) => {
1574
+ const isValidTimeInput = (value) => {
1321
1575
  if (ms(value) !== void 0) return true;
1322
1576
  return !Number.isNaN(new Date(value).getTime());
1323
1577
  };
1324
- const createEnvironmentContractV1 = oc.route({
1578
+ const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
1579
+ const base = oc.errors({ BAD_REQUEST: {} });
1580
+ const createEnvironmentContractV1 = base.route({
1325
1581
  path: "/v1/environments",
1326
1582
  method: "POST",
1327
1583
  summary: "Create an environment",
1328
1584
  description: "Create an environment for a project",
1329
1585
  tags: ["environments"],
1330
1586
  successDescription: "The environment has been created successfully"
1331
- }).errors({
1332
- NOT_FOUND: {},
1333
- BAD_REQUEST: {}
1334
- }).input(z.object({
1587
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1335
1588
  projectId: z.string().describe("The ID of the project to create the environment for"),
1336
1589
  name: z.string().min(1).describe("The name of the environment"),
1337
1590
  sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
@@ -1344,7 +1597,7 @@ const createEnvironmentContractV1 = oc.route({
1344
1597
  createdAt: z.coerce.date(),
1345
1598
  projectId: z.string().describe("The ID of the project the environment belongs to")
1346
1599
  }));
1347
- const getEnvironmentContractV1 = oc.route({
1600
+ const getEnvironmentContractV1 = base.route({
1348
1601
  path: "/v1/environments/{environmentId}",
1349
1602
  method: "GET",
1350
1603
  summary: "Get an environment",
@@ -1401,7 +1654,7 @@ const projectOutputSchema = z.object({
1401
1654
  productionEnvironment: productionEnvironmentSchema.nullable(),
1402
1655
  environments: z.array(environmentSchema)
1403
1656
  });
1404
- const getProjectContractV1 = oc.route({
1657
+ const getProjectContractV1 = base.route({
1405
1658
  path: "/v1/projects/{projectId}",
1406
1659
  method: "GET",
1407
1660
  summary: "Get a project",
@@ -1409,18 +1662,15 @@ const getProjectContractV1 = oc.route({
1409
1662
  tags: ["projects"],
1410
1663
  successDescription: "The project details"
1411
1664
  }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
1412
- const listProjectsContractV1 = oc.route({
1665
+ const listProjectsContractV1 = base.route({
1413
1666
  path: "/v1/projects",
1414
1667
  method: "GET",
1415
1668
  summary: "List projects",
1416
1669
  description: "List all projects for a team",
1417
1670
  tags: ["projects"],
1418
1671
  successDescription: "The list of projects"
1419
- }).errors({
1420
- NOT_FOUND: {},
1421
- BAD_REQUEST: {}
1422
- }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
1423
- const createProjectContractV1 = oc.route({
1672
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
1673
+ const createProjectContractV1 = base.route({
1424
1674
  path: "/v1/projects",
1425
1675
  method: "POST",
1426
1676
  summary: "Create a project",
@@ -1429,7 +1679,7 @@ const createProjectContractV1 = oc.route({
1429
1679
  successDescription: "The project has been created successfully"
1430
1680
  }).errors({
1431
1681
  NOT_FOUND: {},
1432
- BAD_REQUEST: {}
1682
+ FORBIDDEN: {}
1433
1683
  }).input(z.object({
1434
1684
  teamId: z.string().optional(),
1435
1685
  name: z.string().trim().min(1).max(100),
@@ -1469,7 +1719,7 @@ const environmentVariableOutputSchema = z.object({
1469
1719
  isSecret: z.boolean(),
1470
1720
  createdAt: z.coerce.date()
1471
1721
  });
1472
- const listEnvironmentVariablesContractV1 = oc.route({
1722
+ const listEnvironmentVariablesContractV1 = base.route({
1473
1723
  path: "/v1/environments/{environmentId}/environment-variables",
1474
1724
  method: "GET",
1475
1725
  summary: "List environment variables",
@@ -1477,48 +1727,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
1477
1727
  tags: ["environments"],
1478
1728
  successDescription: "The list of environment variables"
1479
1729
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
1480
- const createEnvironmentVariablesContractV1 = oc.route({
1730
+ const createEnvironmentVariablesContractV1 = base.route({
1481
1731
  path: "/v1/environments/{environmentId}/environment-variables",
1482
1732
  method: "POST",
1483
1733
  summary: "Add environment variables",
1484
1734
  description: "Add one or more environment variables to an environment",
1485
1735
  tags: ["environments"],
1486
1736
  successDescription: "The environment variables have been added successfully"
1487
- }).errors({
1488
- NOT_FOUND: {},
1489
- BAD_REQUEST: {}
1490
- }).input(z.object({
1737
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1491
1738
  environmentId: z.string().describe("The ID of the environment"),
1492
1739
  environmentVariables: environmentVariablesSchema
1493
1740
  })).output(z.object({ success: z.literal(true) }));
1494
- const updateEnvironmentVariableContractV1 = oc.route({
1741
+ const updateEnvironmentVariableContractV1 = base.route({
1495
1742
  path: "/v1/environment-variables/{environmentVariableId}",
1496
1743
  method: "PATCH",
1497
1744
  summary: "Update an environment variable",
1498
1745
  description: "Update an environment variable by ID",
1499
1746
  tags: ["environments"],
1500
1747
  successDescription: "The environment variable has been updated successfully"
1501
- }).errors({
1502
- NOT_FOUND: {},
1503
- BAD_REQUEST: {}
1504
- }).input(z.object({
1748
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1505
1749
  environmentVariableId: z.string().describe("The ID of the environment variable"),
1506
1750
  key: environmentVariableSchema.shape.key,
1507
1751
  value: environmentVariableSchema.shape.value.optional(),
1508
1752
  isSecret: environmentVariableSchema.shape.isSecret.optional()
1509
1753
  })).output(z.object({ success: z.literal(true) }));
1510
- const deleteEnvironmentVariableContractV1 = oc.route({
1754
+ const deleteEnvironmentVariableContractV1 = base.route({
1511
1755
  path: "/v1/environment-variables/{environmentVariableId}",
1512
1756
  method: "DELETE",
1513
1757
  summary: "Delete an environment variable",
1514
1758
  description: "Delete an environment variable by ID",
1515
1759
  tags: ["environments"],
1516
1760
  successDescription: "The environment variable has been deleted successfully"
1517
- }).errors({
1518
- NOT_FOUND: {},
1519
- BAD_REQUEST: {}
1520
- }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
1521
- const deleteProjectContractV1 = oc.route({
1761
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
1762
+ const deleteProjectContractV1 = base.route({
1522
1763
  path: "/v1/projects/{projectId}",
1523
1764
  method: "DELETE",
1524
1765
  summary: "Delete a project",
@@ -1526,7 +1767,7 @@ const deleteProjectContractV1 = oc.route({
1526
1767
  tags: ["projects"],
1527
1768
  successDescription: "The project has been deleted successfully"
1528
1769
  }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
1529
- const updateProjectContractV1 = oc.route({
1770
+ const updateProjectContractV1 = base.route({
1530
1771
  path: "/v1/projects/{projectId}",
1531
1772
  method: "PATCH",
1532
1773
  summary: "Update a project",
@@ -1535,13 +1776,13 @@ const updateProjectContractV1 = oc.route({
1535
1776
  successDescription: "The project has been updated successfully"
1536
1777
  }).errors({
1537
1778
  NOT_FOUND: {},
1538
- BAD_REQUEST: {}
1779
+ FORBIDDEN: {}
1539
1780
  }).input(z.object({
1540
1781
  projectId: z.string().describe("The ID of the project"),
1541
1782
  name: z.string().min(1).max(100).optional().describe("The new name for the project"),
1542
1783
  sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
1543
1784
  })).output(projectOutputSchema);
1544
- const deployEnvironmentContractV1 = oc.route({
1785
+ const deployEnvironmentContractV1 = base.route({
1545
1786
  path: "/v1/environments/{environmentId}/deploy",
1546
1787
  method: "POST",
1547
1788
  summary: "Deploy an environment",
@@ -1550,27 +1791,25 @@ const deployEnvironmentContractV1 = oc.route({
1550
1791
  successDescription: "The environment has been deployed successfully"
1551
1792
  }).errors({
1552
1793
  NOT_FOUND: {},
1553
- BAD_REQUEST: {}
1794
+ CONFLICT: {}
1554
1795
  }).input(z.object({
1555
1796
  environmentId: z.string().describe("The ID of the environment to deploy"),
1556
- token: z.string().describe("The token to identify the source archive").optional()
1797
+ token: z.string().describe("The token to identify the source archive").optional(),
1798
+ 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.")
1557
1799
  })).output(deploymentSchema);
1558
- const uploadDeploymentArtifactContractV1 = oc.route({
1800
+ const uploadDeploymentArtifactContractV1 = base.route({
1559
1801
  path: "/v1/deployments/upload",
1560
1802
  method: "POST",
1561
1803
  summary: "Upload deployment artifacts",
1562
1804
  description: "Return a presigned S3 URL to upload a deployment artifact",
1563
1805
  tags: ["deployments"],
1564
1806
  successDescription: "The presigned upload URL has been generated successfully"
1565
- }).errors({
1566
- NOT_FOUND: {},
1567
- BAD_REQUEST: {}
1568
- }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
1807
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
1569
1808
  uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
1570
1809
  token: z.string().describe("Token to identify the source archive"),
1571
1810
  expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
1572
1811
  }));
1573
- const listDeploymentsContractV1 = oc.route({
1812
+ const listDeploymentsContractV1 = base.route({
1574
1813
  path: "/v1/projects/{projectId}/deployments",
1575
1814
  method: "GET",
1576
1815
  summary: "List project deployments",
@@ -1582,7 +1821,7 @@ const listDeploymentsContractV1 = oc.route({
1582
1821
  status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
1583
1822
  environmentId: z.string().optional().describe("Filter by environment ID")
1584
1823
  })).output(z.array(deploymentSchema));
1585
- const getDeploymentContractV1 = oc.route({
1824
+ const getDeploymentContractV1 = base.route({
1586
1825
  path: "/v1/deployments/{deploymentId}",
1587
1826
  method: "GET",
1588
1827
  summary: "Get a deployment",
@@ -1590,20 +1829,32 @@ const getDeploymentContractV1 = oc.route({
1590
1829
  tags: ["deployments"],
1591
1830
  successDescription: "The deployment details"
1592
1831
  }).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
1593
- const getLogsContractV1 = oc.route({
1832
+ const logEntrySchema = z.object({
1833
+ timestamp: z.coerce.date(),
1834
+ type: z.enum([
1835
+ "START",
1836
+ "END",
1837
+ "INFO",
1838
+ "ERROR",
1839
+ "WARNING",
1840
+ "DEBUG"
1841
+ ]),
1842
+ requestId: z.string(),
1843
+ content: z.string().optional(),
1844
+ method: z.string().optional(),
1845
+ durationInMs: z.number().optional()
1846
+ });
1847
+ const getLogsContractV1 = base.route({
1594
1848
  path: "/v1/environments/{environmentId}/logs",
1595
1849
  method: "GET",
1596
1850
  summary: "Get logs",
1597
1851
  description: "Get logs for an environment",
1598
1852
  tags: ["environments"],
1599
1853
  successDescription: "The logs"
1600
- }).errors({
1601
- NOT_FOUND: {},
1602
- BAD_REQUEST: {}
1603
- }).input(z.object({
1854
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1604
1855
  environmentId: z.string().describe("The ID of the environment"),
1605
- 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)"),
1606
- 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"),
1856
+ since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
1857
+ until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
1607
1858
  limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
1608
1859
  level: z.array(z.enum([
1609
1860
  "INFO",
@@ -1614,34 +1865,17 @@ const getLogsContractV1 = oc.route({
1614
1865
  search: z.string().optional().describe("Filter pattern to search for in log content"),
1615
1866
  nextToken: z.string().optional().describe("Pagination token from a previous response")
1616
1867
  })).output(z.object({
1617
- logs: z.array(z.object({
1618
- timestamp: z.coerce.date(),
1619
- type: z.enum([
1620
- "START",
1621
- "END",
1622
- "INFO",
1623
- "ERROR",
1624
- "WARNING",
1625
- "DEBUG"
1626
- ]),
1627
- requestId: z.string(),
1628
- content: z.string().optional(),
1629
- method: z.string().optional(),
1630
- durationInMs: z.number().optional()
1631
- })),
1868
+ logs: z.array(logEntrySchema),
1632
1869
  nextToken: z.string().nullable()
1633
1870
  }));
1634
- const getLatestLogsContractV1 = oc.route({
1871
+ const getLatestLogsContractV1 = base.route({
1635
1872
  path: "/v1/environments/{environmentId}/latest-logs",
1636
1873
  method: "GET",
1637
1874
  summary: "Get latest logs",
1638
1875
  description: "Get the N most recent logs for an environment",
1639
1876
  tags: ["environments"],
1640
1877
  successDescription: "The latest logs"
1641
- }).errors({
1642
- NOT_FOUND: {},
1643
- BAD_REQUEST: {}
1644
- }).input(z.object({
1878
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1645
1879
  environmentId: z.string().describe("The ID of the environment"),
1646
1880
  limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
1647
1881
  level: z.array(z.enum([
@@ -1651,22 +1885,8 @@ const getLatestLogsContractV1 = oc.route({
1651
1885
  "DEBUG"
1652
1886
  ])).optional().describe("Filter by log level"),
1653
1887
  search: z.string().optional().describe("Filter pattern to search for in log content")
1654
- })).output(z.object({ logs: z.array(z.object({
1655
- timestamp: z.coerce.date(),
1656
- type: z.enum([
1657
- "START",
1658
- "END",
1659
- "INFO",
1660
- "ERROR",
1661
- "WARNING",
1662
- "DEBUG"
1663
- ]),
1664
- requestId: z.string(),
1665
- content: z.string().optional(),
1666
- method: z.string().optional(),
1667
- durationInMs: z.number().optional()
1668
- })) }));
1669
- const getDeploymentLogsContractV1 = oc.route({
1888
+ })).output(z.object({ logs: z.array(logEntrySchema) }));
1889
+ const getDeploymentLogsContractV1 = base.route({
1670
1890
  path: "/v1/deployments/{deploymentId}/logs",
1671
1891
  method: "GET",
1672
1892
  summary: "Get deployment logs",
@@ -1693,17 +1913,14 @@ const analyticsTimeSeriesSchema = z.object({
1693
1913
  output_token_mean: z.array(analyticsDataPointSchema),
1694
1914
  task_count: z.array(analyticsDataPointSchema)
1695
1915
  });
1696
- const getProjectAnalyticsContractV1 = oc.route({
1916
+ const getProjectAnalyticsContractV1 = base.route({
1697
1917
  path: "/v1/analytics/{projectId}",
1698
1918
  method: "GET",
1699
1919
  summary: "Get project analytics",
1700
1920
  description: "Get analytics data for a project over a time range",
1701
1921
  tags: ["analytics"],
1702
1922
  successDescription: "The project analytics data"
1703
- }).errors({
1704
- NOT_FOUND: {},
1705
- BAD_REQUEST: {}
1706
- }).input(z.object({
1923
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1707
1924
  projectId: z.string().describe("The ID of the project"),
1708
1925
  startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
1709
1926
  endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
@@ -1718,7 +1935,132 @@ const getProjectAnalyticsContractV1 = oc.route({
1718
1935
  }),
1719
1936
  timeSeries: analyticsTimeSeriesSchema
1720
1937
  }));
1721
- const listTeamsContractV1 = oc.route({
1938
+ const paginatedInsightsInputShape = {
1939
+ environmentId: z.string().describe("The ID of the environment"),
1940
+ since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
1941
+ until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
1942
+ limit: z.coerce.number().int().min(1).max(200).default(50),
1943
+ offset: z.coerce.number().int().min(0).default(0),
1944
+ search: z.string().trim().min(1).max(200).optional()
1945
+ };
1946
+ const listIntentsContractV1 = base.route({
1947
+ path: "/v1/environments/{environmentId}/intents",
1948
+ method: "GET",
1949
+ summary: "List intents",
1950
+ description: "List grouped user intents for an environment over a time range",
1951
+ tags: ["insights"],
1952
+ successDescription: "The grouped user intents"
1953
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1954
+ ...paginatedInsightsInputShape,
1955
+ tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
1956
+ clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
1957
+ categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
1958
+ sortDir: z.enum(["asc", "desc"]).default("desc")
1959
+ })).output(z.object({
1960
+ intents: z.array(z.object({
1961
+ id: z.string(),
1962
+ intentIds: z.array(z.string()).min(1),
1963
+ environmentId: z.string(),
1964
+ message: z.string(),
1965
+ toolName: z.string(),
1966
+ createdAt: z.coerce.date(),
1967
+ occurrenceCount: z.number().int().positive(),
1968
+ clientName: z.string().nullable(),
1969
+ clientId: z.string().nullable(),
1970
+ categories: z.array(z.object({
1971
+ id: z.string(),
1972
+ name: z.string(),
1973
+ color: intentCategoryColorSchema
1974
+ }))
1975
+ })),
1976
+ totalCount: z.number().int().nonnegative()
1977
+ }));
1978
+ const listFeedbacksContractV1 = base.route({
1979
+ path: "/v1/environments/{environmentId}/feedbacks",
1980
+ method: "GET",
1981
+ summary: "List feedbacks",
1982
+ description: "List user feedback for an environment over a time range",
1983
+ tags: ["insights"],
1984
+ successDescription: "The user feedback"
1985
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1986
+ ...paginatedInsightsInputShape,
1987
+ clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
1988
+ })).output(z.object({
1989
+ feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
1990
+ totalCount: z.number().int().nonnegative()
1991
+ }));
1992
+ const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
1993
+ const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
1994
+ const listIntentCategoriesContractV1 = base.route({
1995
+ path: "/v1/environments/{environmentId}/intent-categories",
1996
+ method: "GET",
1997
+ summary: "List intent categories",
1998
+ description: "List intent categories for an environment, including how many intents each category is linked to",
1999
+ tags: ["insights"],
2000
+ successDescription: "The intent categories"
2001
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
2002
+ const createIntentCategoryContractV1 = base.route({
2003
+ path: "/v1/environments/{environmentId}/intent-categories",
2004
+ method: "POST",
2005
+ summary: "Create an intent category",
2006
+ description: "Create an intent category, optionally linking it to existing intents",
2007
+ tags: ["insights"],
2008
+ successDescription: "The created intent category"
2009
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2010
+ environmentId: z.string().describe("The ID of the environment"),
2011
+ name: intentCategoryNameSchema,
2012
+ color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
2013
+ intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
2014
+ })).output(intentCategorySchema);
2015
+ const updateIntentCategoryContractV1 = base.route({
2016
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
2017
+ method: "PATCH",
2018
+ summary: "Update an intent category",
2019
+ description: "Rename or recolor an intent category",
2020
+ tags: ["insights"],
2021
+ successDescription: "The updated intent category"
2022
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2023
+ environmentId: z.string().describe("The ID of the environment"),
2024
+ categoryId: z.string().describe("The ID of the category"),
2025
+ name: intentCategoryNameSchema.optional(),
2026
+ color: intentCategoryColorSchema.optional().describe("The category color")
2027
+ }).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
2028
+ const deleteIntentCategoryContractV1 = base.route({
2029
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
2030
+ method: "DELETE",
2031
+ summary: "Delete an intent category",
2032
+ description: "Delete an intent category; its intents are unlinked but not deleted",
2033
+ tags: ["insights"],
2034
+ successDescription: "The intent category has been deleted successfully"
2035
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2036
+ environmentId: z.string().describe("The ID of the environment"),
2037
+ categoryId: z.string().describe("The ID of the category")
2038
+ })).output(z.object({ success: z.literal(true) }));
2039
+ const linkIntentCategoryContractV1 = base.route({
2040
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
2041
+ method: "POST",
2042
+ summary: "Link an intent category",
2043
+ description: "Link an intent category to intents; already linked intents are ignored",
2044
+ tags: ["insights"],
2045
+ successDescription: "The intents have been linked successfully"
2046
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2047
+ environmentId: z.string().describe("The ID of the environment"),
2048
+ categoryId: z.string().describe("The ID of the category"),
2049
+ intentIds: categorizableIntentIdsSchema
2050
+ })).output(z.object({ success: z.literal(true) }));
2051
+ const unlinkIntentCategoryContractV1 = base.route({
2052
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
2053
+ method: "POST",
2054
+ summary: "Unlink an intent category",
2055
+ description: "Unlink an intent category from intents; intents without the category are ignored",
2056
+ tags: ["insights"],
2057
+ successDescription: "The intents have been unlinked successfully"
2058
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2059
+ environmentId: z.string().describe("The ID of the environment"),
2060
+ categoryId: z.string().describe("The ID of the category"),
2061
+ intentIds: categorizableIntentIdsSchema
2062
+ })).output(z.object({ success: z.literal(true) }));
2063
+ const listTeamsContractV1 = base.route({
1722
2064
  path: "/v1/teams",
1723
2065
  method: "GET",
1724
2066
  summary: "List teams",
@@ -1731,28 +2073,40 @@ const listTeamsContractV1 = oc.route({
1731
2073
  createdAt: z.coerce.date(),
1732
2074
  hasStripeAccount: z.boolean()
1733
2075
  })));
1734
- const getTunnelTicketContractV1 = oc.route({
2076
+ const getTeamUsageContractV1 = base.route({
2077
+ path: "/v1/teams/{teamId}/usage",
2078
+ method: "GET",
2079
+ summary: "Get team usage",
2080
+ 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.",
2081
+ tags: ["teams"],
2082
+ successDescription: "The current billing window usage"
2083
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
2084
+ teamId: z.string(),
2085
+ plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
2086
+ periodStart: z.coerce.date().describe("Start of the current billing window"),
2087
+ periodEnd: z.coerce.date().describe("End of the current billing window"),
2088
+ requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
2089
+ includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
2090
+ }));
2091
+ const getTunnelTicketContractV1 = base.route({
1735
2092
  path: "/v1/tunnels/ticket",
1736
2093
  method: "GET",
1737
2094
  summary: "Get a tunnel ticket",
1738
2095
  description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
1739
2096
  tags: ["tunnels"],
1740
2097
  successDescription: "The tunnel ticket"
1741
- }).errors({ FORBIDDEN: {} }).output(z.object({
2098
+ }).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
1742
2099
  subdomain: z.string().describe("The subdomain assigned to the user"),
1743
2100
  ticket: z.string().describe("The signed tunnel ticket"),
1744
2101
  tunnelHost: z.string().describe("The tunnel host to connect to")
1745
2102
  }));
1746
- const publishServerContractV1 = oc.route({
2103
+ const publishServerContractV1 = base.route({
1747
2104
  path: "/v1/distribution/publish",
1748
2105
  method: "POST",
1749
2106
  summary: "Publish a server to the MCP registry",
1750
2107
  tags: ["distribution"],
1751
2108
  successDescription: "The server has been published successfully"
1752
- }).errors({
1753
- NOT_FOUND: {},
1754
- BAD_REQUEST: {}
1755
- }).input(z.object({
2109
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1756
2110
  projectId: z.string(),
1757
2111
  domain: z.string(),
1758
2112
  title: z.string().min(1).max(100),
@@ -1761,17 +2115,14 @@ const publishServerContractV1 = oc.route({
1761
2115
  iconSrc: z.url().max(255).optional(),
1762
2116
  dryRun: z.boolean().optional()
1763
2117
  })).output(z.object({ serverFields: serverFieldsSchema }));
1764
- const getServerInfoContractV1 = oc.route({
2118
+ const getServerInfoContractV1 = base.route({
1765
2119
  path: "/v1/distribution/get",
1766
2120
  method: "GET",
1767
2121
  summary: "Get server info",
1768
2122
  description: "Get info about a server",
1769
2123
  tags: ["distribution"],
1770
2124
  successDescription: "The server info"
1771
- }).errors({
1772
- NOT_FOUND: {},
1773
- BAD_REQUEST: {}
1774
- }).input(z.object({
2125
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1775
2126
  projectId: z.string(),
1776
2127
  domain: z.string()
1777
2128
  })).output(z.object({ serverFields: serverFieldsSchema }));
@@ -1790,7 +2141,7 @@ const playgroundOutputSchema = z.object({
1790
2141
  isPlaygroundEnabled: z.boolean(),
1791
2142
  serverMetadata: playgroundServerMetadataOutputSchema.nullable()
1792
2143
  });
1793
- const getPlaygroundContractV1 = oc.route({
2144
+ const getPlaygroundContractV1 = base.route({
1794
2145
  path: "/v1/environments/{environmentId}/playground",
1795
2146
  method: "GET",
1796
2147
  summary: "Get playground configuration",
@@ -1798,17 +2149,14 @@ const getPlaygroundContractV1 = oc.route({
1798
2149
  tags: ["environments"],
1799
2150
  successDescription: "The playground configuration"
1800
2151
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
1801
- const upsertPlaygroundContractV1 = oc.route({
2152
+ const upsertPlaygroundContractV1 = base.route({
1802
2153
  path: "/v1/environments/{environmentId}/playground",
1803
2154
  method: "PUT",
1804
2155
  summary: "Update playground configuration",
1805
2156
  description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
1806
2157
  tags: ["environments"],
1807
2158
  successDescription: "The updated playground configuration"
1808
- }).errors({
1809
- NOT_FOUND: {},
1810
- BAD_REQUEST: {}
1811
- }).input(z.object({
2159
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1812
2160
  environmentId: z.string().describe("The ID of the environment"),
1813
2161
  isPlaygroundEnabled: z.boolean().optional(),
1814
2162
  name: z.string().min(1).max(100).optional(),
@@ -1816,7 +2164,7 @@ const upsertPlaygroundContractV1 = oc.route({
1816
2164
  headers: z.array(playgroundHeaderSchema).optional(),
1817
2165
  examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
1818
2166
  })).output(playgroundOutputSchema);
1819
- const createBeaconContractV1 = oc.route({
2167
+ const createBeaconContractV1 = base.route({
1820
2168
  path: "/v1/beacon/audits",
1821
2169
  method: "POST",
1822
2170
  summary: "Create a beacon audit",
@@ -1825,7 +2173,6 @@ const createBeaconContractV1 = oc.route({
1825
2173
  successDescription: "The audit has been created"
1826
2174
  }).errors({
1827
2175
  NOT_FOUND: {},
1828
- BAD_REQUEST: {},
1829
2176
  DNS_RESOLUTION_FAILED: { status: 400 }
1830
2177
  }).input(z.object({
1831
2178
  targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
@@ -1833,7 +2180,7 @@ const createBeaconContractV1 = oc.route({
1833
2180
  projectId: z.string().optional().describe("The project ID to associate the audit with"),
1834
2181
  excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
1835
2182
  })).output(z.object({ id: z.string() }));
1836
- const getBeaconContractV1 = oc.route({
2183
+ const getBeaconContractV1 = base.route({
1837
2184
  path: "/v1/beacon/audits/{auditId}",
1838
2185
  method: "GET",
1839
2186
  summary: "Get a beacon audit",
@@ -1849,8 +2196,21 @@ const getBeaconContractV1 = oc.route({
1849
2196
  report: auditReportWithScreenshotsSchema.nullable()
1850
2197
  }));
1851
2198
  const contract = {
1852
- teams: { list: { v1: listTeamsContractV1 } },
2199
+ teams: {
2200
+ list: { v1: listTeamsContractV1 },
2201
+ getUsage: { v1: getTeamUsageContractV1 }
2202
+ },
1853
2203
  analytics: { get: { v1: getProjectAnalyticsContractV1 } },
2204
+ intents: { list: { v1: listIntentsContractV1 } },
2205
+ intentCategories: {
2206
+ list: { v1: listIntentCategoriesContractV1 },
2207
+ create: { v1: createIntentCategoryContractV1 },
2208
+ update: { v1: updateIntentCategoryContractV1 },
2209
+ delete: { v1: deleteIntentCategoryContractV1 },
2210
+ link: { v1: linkIntentCategoryContractV1 },
2211
+ unlink: { v1: unlinkIntentCategoryContractV1 }
2212
+ },
2213
+ feedbacks: { list: { v1: listFeedbacksContractV1 } },
1854
2214
  deployments: {
1855
2215
  list: { v1: listDeploymentsContractV1 },
1856
2216
  get: { v1: getDeploymentContractV1 },
@@ -1891,5 +2251,10 @@ const contract = {
1891
2251
  get: { v1: getBeaconContractV1 }
1892
2252
  }
1893
2253
  };
2254
+ const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
2255
+ const contractForDocs = {
2256
+ ...contract,
2257
+ deployments: deploymentsForDocs
2258
+ };
1894
2259
  //#endregion
1895
- export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
2260
+ export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };