@alpic-ai/api 0.0.0-dev.ge4f76e7 → 0.0.0-dev.ge50aa78

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 +1534 -59
  2. package/dist/index.mjs +594 -193
  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,9 +373,13 @@ 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
343
382
  ]);
344
- const allowedPlatformSchema = platformSchema;
345
383
  const playgroundModelSchema = z.enum([
346
384
  "global.anthropic.claude-haiku-4-5-20251001-v1:0",
347
385
  "global.anthropic.claude-sonnet-4-5-20250929-v1:0",
@@ -381,14 +419,16 @@ z.object({
381
419
  collectRequestPayload: z.boolean(),
382
420
  collectResponsePayload: z.boolean(),
383
421
  collectErrorMessage: z.boolean(),
384
- collectUserData: z.boolean()
422
+ collectUserData: z.boolean(),
423
+ identityTraitKey: z.string().min(1).max(200).nullable()
385
424
  });
386
- z.object({
425
+ const feedbackSchema = z.object({
387
426
  id: z.string(),
388
427
  createdAt: z.coerce.date(),
389
428
  environmentId: z.string(),
390
429
  content: z.string(),
391
- source: z.enum(["model", "user"])
430
+ source: z.enum(["model", "user"]),
431
+ clientName: z.string().nullable()
392
432
  });
393
433
  z.object({
394
434
  content: z.string(),
@@ -404,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
404
444
  "pink",
405
445
  "gray"
406
446
  ]);
407
- intentCategoryColorSchema.options;
447
+ const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
408
448
  const intentCategorySchema = z.object({
409
449
  id: z.string(),
410
450
  createdAt: z.coerce.date(),
@@ -412,7 +452,7 @@ const intentCategorySchema = z.object({
412
452
  name: z.string(),
413
453
  color: intentCategoryColorSchema
414
454
  });
415
- z.object({
455
+ const intentCategorySummarySchema = z.object({
416
456
  id: z.string(),
417
457
  name: z.string(),
418
458
  color: intentCategoryColorSchema,
@@ -424,6 +464,7 @@ z.object({
424
464
  environmentId: z.string(),
425
465
  toolName: z.string(),
426
466
  message: z.string(),
467
+ clientName: z.string().nullable(),
427
468
  categories: z.array(intentCategorySchema)
428
469
  });
429
470
  const signalCategorySchema = z.object({
@@ -488,6 +529,246 @@ z.enum([
488
529
  "DEBUG",
489
530
  "ERROR"
490
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]));
491
772
  const runtimeSchema = z.enum([
492
773
  "python3.13",
493
774
  "python3.14",
@@ -565,15 +846,7 @@ z.object({
565
846
  serverFields: serverFieldsSchema$1,
566
847
  source: z.enum(["registry", "defaults"])
567
848
  });
568
- /**
569
- * Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
570
- * rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
571
- *
572
- * NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
573
- * `minLength`, and the description. Any other validators on the source field (`.regex()`,
574
- * `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
575
- * free-text length caps only. A field with `null` `maxLength` is returned unchanged.
576
- */
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. */
577
850
  const clampStringField = (field) => {
578
851
  const max = field.maxLength;
579
852
  if (max === null) return field;
@@ -600,8 +873,9 @@ const positiveTestCaseSchema = z.object({
600
873
  }).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
601
874
  const screenshotEntrySchema = z.object({
602
875
  prompt: z.string(),
603
- url: z.url().or(z.literal(""))
876
+ url: z.url()
604
877
  }).describe("Each screenshot: the user prompt that produced it + the image URL.");
878
+ const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
605
879
  /** Accepts either a valid email or URL. */
606
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" });
607
881
  /** A URL field whose error spells out that the scheme is required. */
@@ -918,11 +1192,7 @@ const chatgptToolJustificationSchema = z.object({
918
1192
  openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
919
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.\"")
920
1194
  }).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
921
- /**
922
- * Base copy fields, defined once and reused by both the submission form and per-locale
923
- * translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
924
- * path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
925
- */
1195
+ /** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
926
1196
  const chatgptTaglineSchema = z.string().max(30);
927
1197
  const chatgptDescriptionSchema = z.string();
928
1198
  const chatgptTranslationSchema = z.object({
@@ -931,10 +1201,7 @@ const chatgptTranslationSchema = z.object({
931
1201
  description: chatgptDescriptionSchema
932
1202
  }).describe("Locale-scoped override for tagline + description. English (US) is the default.");
933
1203
  chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
934
- /**
935
- * Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
936
- * When adding/removing/reordering fields, keep this in sync with the sheet.
937
- */
1204
+ /** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
938
1205
  const chatgptSubmissionFormDataSchema = z.object({
939
1206
  logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
940
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."),
@@ -960,6 +1227,17 @@ const chatgptSubmissionFormDataSchema = z.object({
960
1227
  allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
961
1228
  releaseNotes: z.string().describe("Publicly displayed on the app details page.")
962
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
+ });
963
1241
  chatgptSubmissionFormDataSchema.pick({
964
1242
  appName: true,
965
1243
  developerName: true,
@@ -1020,11 +1298,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
1020
1298
  "My connector does not collect conversation data beyond what is needed for its function.",
1021
1299
  "Public documentation for this connector will be live by the publish date."
1022
1300
  ]);
1023
- /**
1024
- * Field order mirrors the claude.ai directory submission wizard
1025
- * (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
1026
- * When adding/removing/reordering fields, keep this in sync with the wizard.
1027
- */
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. */
1028
1302
  const claudeSubmissionFormDataSchema = z.object({
1029
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
1030
1304
  from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
@@ -1086,6 +1360,21 @@ fully populated account.`),
1086
1360
  submission. Each is an attestation you are legally agreeing to by submitting.`),
1087
1361
  additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
1088
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()
1377
+ });
1089
1378
  claudeSubmissionFormDataSchema.pick({
1090
1379
  serverUrl: true,
1091
1380
  name: true,
@@ -1101,12 +1390,7 @@ claudeSubmissionFormDataSchema.pick({
1101
1390
  connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
1102
1391
  testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
1103
1392
  });
1104
- /**
1105
- * Narrative fields the LLM-backed generation step produces for Claude submissions.
1106
- * This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
1107
- * the strict form shape. Keep transforms here rather than in callers so generation leniency is
1108
- * colocated with the Claude contract.
1109
- */
1393
+ /** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
1110
1394
  const claudeAiGeneratedFormDataRawSchema = z.object({
1111
1395
  oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
1112
1396
  description: claudeSubmissionFormDataSchema.shape.description,
@@ -1126,14 +1410,19 @@ const submissionMetaFieldsSchema = z.object({
1126
1410
  });
1127
1411
  const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
1128
1412
  platform: z.literal("claudeai"),
1129
- formData: claudeSubmissionFormDataSchema.partial()
1413
+ formData: claudeSubmissionDraftSchema
1130
1414
  });
1131
1415
  const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
1132
1416
  platform: z.literal("chatgpt"),
1133
- formData: chatgptSubmissionFormDataSchema.partial()
1417
+ formData: chatgptSubmissionDraftSchema
1134
1418
  });
1135
1419
  z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
1136
- z.union([claudeSubmissionFormDataSchema.partial(), chatgptSubmissionFormDataSchema.partial()]);
1420
+ z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
1421
+ z.literal([
1422
+ 100,
1423
+ 75,
1424
+ 50
1425
+ ]);
1137
1426
  const subscriptionPlanSchema = z.enum([
1138
1427
  "pro",
1139
1428
  "business",
@@ -1198,7 +1487,10 @@ const RESERVED_KEYS = [
1198
1487
  "BUILD_ARG_START_COMMAND",
1199
1488
  "ALPIC_HOST",
1200
1489
  "ALPIC_CUSTOM_DOMAINS",
1201
- "ALPIC_INTENT_META_KEY"
1490
+ "ALPIC_INTENT_META_KEY",
1491
+ "ALPIC_FEEDBACK_META_KEY",
1492
+ "ALPIC_EVENTS_META_KEY",
1493
+ "ALPIC_IDENTIFY_META_KEY"
1202
1494
  ];
1203
1495
  const environmentVariableSchema = z.object({
1204
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"),
@@ -1279,21 +1571,20 @@ const deploymentSchema = z.object({
1279
1571
  isCurrent: z.boolean(),
1280
1572
  deploymentPageUrl: z.url().nullable()
1281
1573
  });
1282
- const isValidLogTimeInput = (value) => {
1574
+ const isValidTimeInput = (value) => {
1283
1575
  if (ms(value) !== void 0) return true;
1284
1576
  return !Number.isNaN(new Date(value).getTime());
1285
1577
  };
1286
- 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({
1287
1581
  path: "/v1/environments",
1288
1582
  method: "POST",
1289
1583
  summary: "Create an environment",
1290
1584
  description: "Create an environment for a project",
1291
1585
  tags: ["environments"],
1292
1586
  successDescription: "The environment has been created successfully"
1293
- }).errors({
1294
- NOT_FOUND: {},
1295
- BAD_REQUEST: {}
1296
- }).input(z.object({
1587
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1297
1588
  projectId: z.string().describe("The ID of the project to create the environment for"),
1298
1589
  name: z.string().min(1).describe("The name of the environment"),
1299
1590
  sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
@@ -1306,7 +1597,7 @@ const createEnvironmentContractV1 = oc.route({
1306
1597
  createdAt: z.coerce.date(),
1307
1598
  projectId: z.string().describe("The ID of the project the environment belongs to")
1308
1599
  }));
1309
- const getEnvironmentContractV1 = oc.route({
1600
+ const getEnvironmentContractV1 = base.route({
1310
1601
  path: "/v1/environments/{environmentId}",
1311
1602
  method: "GET",
1312
1603
  summary: "Get an environment",
@@ -1363,7 +1654,7 @@ const projectOutputSchema = z.object({
1363
1654
  productionEnvironment: productionEnvironmentSchema.nullable(),
1364
1655
  environments: z.array(environmentSchema)
1365
1656
  });
1366
- const getProjectContractV1 = oc.route({
1657
+ const getProjectContractV1 = base.route({
1367
1658
  path: "/v1/projects/{projectId}",
1368
1659
  method: "GET",
1369
1660
  summary: "Get a project",
@@ -1371,18 +1662,15 @@ const getProjectContractV1 = oc.route({
1371
1662
  tags: ["projects"],
1372
1663
  successDescription: "The project details"
1373
1664
  }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
1374
- const listProjectsContractV1 = oc.route({
1665
+ const listProjectsContractV1 = base.route({
1375
1666
  path: "/v1/projects",
1376
1667
  method: "GET",
1377
1668
  summary: "List projects",
1378
1669
  description: "List all projects for a team",
1379
1670
  tags: ["projects"],
1380
1671
  successDescription: "The list of projects"
1381
- }).errors({
1382
- NOT_FOUND: {},
1383
- BAD_REQUEST: {}
1384
- }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
1385
- 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({
1386
1674
  path: "/v1/projects",
1387
1675
  method: "POST",
1388
1676
  summary: "Create a project",
@@ -1391,7 +1679,6 @@ const createProjectContractV1 = oc.route({
1391
1679
  successDescription: "The project has been created successfully"
1392
1680
  }).errors({
1393
1681
  NOT_FOUND: {},
1394
- BAD_REQUEST: {},
1395
1682
  FORBIDDEN: {}
1396
1683
  }).input(z.object({
1397
1684
  teamId: z.string().optional(),
@@ -1432,7 +1719,7 @@ const environmentVariableOutputSchema = z.object({
1432
1719
  isSecret: z.boolean(),
1433
1720
  createdAt: z.coerce.date()
1434
1721
  });
1435
- const listEnvironmentVariablesContractV1 = oc.route({
1722
+ const listEnvironmentVariablesContractV1 = base.route({
1436
1723
  path: "/v1/environments/{environmentId}/environment-variables",
1437
1724
  method: "GET",
1438
1725
  summary: "List environment variables",
@@ -1440,48 +1727,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
1440
1727
  tags: ["environments"],
1441
1728
  successDescription: "The list of environment variables"
1442
1729
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
1443
- const createEnvironmentVariablesContractV1 = oc.route({
1730
+ const createEnvironmentVariablesContractV1 = base.route({
1444
1731
  path: "/v1/environments/{environmentId}/environment-variables",
1445
1732
  method: "POST",
1446
1733
  summary: "Add environment variables",
1447
1734
  description: "Add one or more environment variables to an environment",
1448
1735
  tags: ["environments"],
1449
1736
  successDescription: "The environment variables have been added successfully"
1450
- }).errors({
1451
- NOT_FOUND: {},
1452
- BAD_REQUEST: {}
1453
- }).input(z.object({
1737
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1454
1738
  environmentId: z.string().describe("The ID of the environment"),
1455
1739
  environmentVariables: environmentVariablesSchema
1456
1740
  })).output(z.object({ success: z.literal(true) }));
1457
- const updateEnvironmentVariableContractV1 = oc.route({
1741
+ const updateEnvironmentVariableContractV1 = base.route({
1458
1742
  path: "/v1/environment-variables/{environmentVariableId}",
1459
1743
  method: "PATCH",
1460
1744
  summary: "Update an environment variable",
1461
1745
  description: "Update an environment variable by ID",
1462
1746
  tags: ["environments"],
1463
1747
  successDescription: "The environment variable has been updated successfully"
1464
- }).errors({
1465
- NOT_FOUND: {},
1466
- BAD_REQUEST: {}
1467
- }).input(z.object({
1748
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1468
1749
  environmentVariableId: z.string().describe("The ID of the environment variable"),
1469
1750
  key: environmentVariableSchema.shape.key,
1470
1751
  value: environmentVariableSchema.shape.value.optional(),
1471
1752
  isSecret: environmentVariableSchema.shape.isSecret.optional()
1472
1753
  })).output(z.object({ success: z.literal(true) }));
1473
- const deleteEnvironmentVariableContractV1 = oc.route({
1754
+ const deleteEnvironmentVariableContractV1 = base.route({
1474
1755
  path: "/v1/environment-variables/{environmentVariableId}",
1475
1756
  method: "DELETE",
1476
1757
  summary: "Delete an environment variable",
1477
1758
  description: "Delete an environment variable by ID",
1478
1759
  tags: ["environments"],
1479
1760
  successDescription: "The environment variable has been deleted successfully"
1480
- }).errors({
1481
- NOT_FOUND: {},
1482
- BAD_REQUEST: {}
1483
- }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
1484
- 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({
1485
1763
  path: "/v1/projects/{projectId}",
1486
1764
  method: "DELETE",
1487
1765
  summary: "Delete a project",
@@ -1489,7 +1767,7 @@ const deleteProjectContractV1 = oc.route({
1489
1767
  tags: ["projects"],
1490
1768
  successDescription: "The project has been deleted successfully"
1491
1769
  }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
1492
- const updateProjectContractV1 = oc.route({
1770
+ const updateProjectContractV1 = base.route({
1493
1771
  path: "/v1/projects/{projectId}",
1494
1772
  method: "PATCH",
1495
1773
  summary: "Update a project",
@@ -1498,14 +1776,13 @@ const updateProjectContractV1 = oc.route({
1498
1776
  successDescription: "The project has been updated successfully"
1499
1777
  }).errors({
1500
1778
  NOT_FOUND: {},
1501
- BAD_REQUEST: {},
1502
1779
  FORBIDDEN: {}
1503
1780
  }).input(z.object({
1504
1781
  projectId: z.string().describe("The ID of the project"),
1505
1782
  name: z.string().min(1).max(100).optional().describe("The new name for the project"),
1506
1783
  sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
1507
1784
  })).output(projectOutputSchema);
1508
- const deployEnvironmentContractV1 = oc.route({
1785
+ const deployEnvironmentContractV1 = base.route({
1509
1786
  path: "/v1/environments/{environmentId}/deploy",
1510
1787
  method: "POST",
1511
1788
  summary: "Deploy an environment",
@@ -1514,27 +1791,25 @@ const deployEnvironmentContractV1 = oc.route({
1514
1791
  successDescription: "The environment has been deployed successfully"
1515
1792
  }).errors({
1516
1793
  NOT_FOUND: {},
1517
- BAD_REQUEST: {}
1794
+ CONFLICT: {}
1518
1795
  }).input(z.object({
1519
1796
  environmentId: z.string().describe("The ID of the environment to deploy"),
1520
- 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.")
1521
1799
  })).output(deploymentSchema);
1522
- const uploadDeploymentArtifactContractV1 = oc.route({
1800
+ const uploadDeploymentArtifactContractV1 = base.route({
1523
1801
  path: "/v1/deployments/upload",
1524
1802
  method: "POST",
1525
1803
  summary: "Upload deployment artifacts",
1526
1804
  description: "Return a presigned S3 URL to upload a deployment artifact",
1527
1805
  tags: ["deployments"],
1528
1806
  successDescription: "The presigned upload URL has been generated successfully"
1529
- }).errors({
1530
- NOT_FOUND: {},
1531
- BAD_REQUEST: {}
1532
- }).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({
1533
1808
  uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
1534
1809
  token: z.string().describe("Token to identify the source archive"),
1535
1810
  expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
1536
1811
  }));
1537
- const listDeploymentsContractV1 = oc.route({
1812
+ const listDeploymentsContractV1 = base.route({
1538
1813
  path: "/v1/projects/{projectId}/deployments",
1539
1814
  method: "GET",
1540
1815
  summary: "List project deployments",
@@ -1546,7 +1821,7 @@ const listDeploymentsContractV1 = oc.route({
1546
1821
  status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
1547
1822
  environmentId: z.string().optional().describe("Filter by environment ID")
1548
1823
  })).output(z.array(deploymentSchema));
1549
- const getDeploymentContractV1 = oc.route({
1824
+ const getDeploymentContractV1 = base.route({
1550
1825
  path: "/v1/deployments/{deploymentId}",
1551
1826
  method: "GET",
1552
1827
  summary: "Get a deployment",
@@ -1554,20 +1829,32 @@ const getDeploymentContractV1 = oc.route({
1554
1829
  tags: ["deployments"],
1555
1830
  successDescription: "The deployment details"
1556
1831
  }).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
1557
- 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({
1558
1848
  path: "/v1/environments/{environmentId}/logs",
1559
1849
  method: "GET",
1560
1850
  summary: "Get logs",
1561
1851
  description: "Get logs for an environment",
1562
1852
  tags: ["environments"],
1563
1853
  successDescription: "The logs"
1564
- }).errors({
1565
- NOT_FOUND: {},
1566
- BAD_REQUEST: {}
1567
- }).input(z.object({
1854
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1568
1855
  environmentId: z.string().describe("The ID of the environment"),
1569
- 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)"),
1570
- 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"),
1571
1858
  limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
1572
1859
  level: z.array(z.enum([
1573
1860
  "INFO",
@@ -1578,34 +1865,17 @@ const getLogsContractV1 = oc.route({
1578
1865
  search: z.string().optional().describe("Filter pattern to search for in log content"),
1579
1866
  nextToken: z.string().optional().describe("Pagination token from a previous response")
1580
1867
  })).output(z.object({
1581
- logs: z.array(z.object({
1582
- timestamp: z.coerce.date(),
1583
- type: z.enum([
1584
- "START",
1585
- "END",
1586
- "INFO",
1587
- "ERROR",
1588
- "WARNING",
1589
- "DEBUG"
1590
- ]),
1591
- requestId: z.string(),
1592
- content: z.string().optional(),
1593
- method: z.string().optional(),
1594
- durationInMs: z.number().optional()
1595
- })),
1868
+ logs: z.array(logEntrySchema),
1596
1869
  nextToken: z.string().nullable()
1597
1870
  }));
1598
- const getLatestLogsContractV1 = oc.route({
1871
+ const getLatestLogsContractV1 = base.route({
1599
1872
  path: "/v1/environments/{environmentId}/latest-logs",
1600
1873
  method: "GET",
1601
1874
  summary: "Get latest logs",
1602
1875
  description: "Get the N most recent logs for an environment",
1603
1876
  tags: ["environments"],
1604
1877
  successDescription: "The latest logs"
1605
- }).errors({
1606
- NOT_FOUND: {},
1607
- BAD_REQUEST: {}
1608
- }).input(z.object({
1878
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1609
1879
  environmentId: z.string().describe("The ID of the environment"),
1610
1880
  limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
1611
1881
  level: z.array(z.enum([
@@ -1615,22 +1885,8 @@ const getLatestLogsContractV1 = oc.route({
1615
1885
  "DEBUG"
1616
1886
  ])).optional().describe("Filter by log level"),
1617
1887
  search: z.string().optional().describe("Filter pattern to search for in log content")
1618
- })).output(z.object({ logs: z.array(z.object({
1619
- timestamp: z.coerce.date(),
1620
- type: z.enum([
1621
- "START",
1622
- "END",
1623
- "INFO",
1624
- "ERROR",
1625
- "WARNING",
1626
- "DEBUG"
1627
- ]),
1628
- requestId: z.string(),
1629
- content: z.string().optional(),
1630
- method: z.string().optional(),
1631
- durationInMs: z.number().optional()
1632
- })) }));
1633
- const getDeploymentLogsContractV1 = oc.route({
1888
+ })).output(z.object({ logs: z.array(logEntrySchema) }));
1889
+ const getDeploymentLogsContractV1 = base.route({
1634
1890
  path: "/v1/deployments/{deploymentId}/logs",
1635
1891
  method: "GET",
1636
1892
  summary: "Get deployment logs",
@@ -1657,17 +1913,14 @@ const analyticsTimeSeriesSchema = z.object({
1657
1913
  output_token_mean: z.array(analyticsDataPointSchema),
1658
1914
  task_count: z.array(analyticsDataPointSchema)
1659
1915
  });
1660
- const getProjectAnalyticsContractV1 = oc.route({
1916
+ const getProjectAnalyticsContractV1 = base.route({
1661
1917
  path: "/v1/analytics/{projectId}",
1662
1918
  method: "GET",
1663
1919
  summary: "Get project analytics",
1664
1920
  description: "Get analytics data for a project over a time range",
1665
1921
  tags: ["analytics"],
1666
1922
  successDescription: "The project analytics data"
1667
- }).errors({
1668
- NOT_FOUND: {},
1669
- BAD_REQUEST: {}
1670
- }).input(z.object({
1923
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1671
1924
  projectId: z.string().describe("The ID of the project"),
1672
1925
  startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
1673
1926
  endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
@@ -1682,7 +1935,132 @@ const getProjectAnalyticsContractV1 = oc.route({
1682
1935
  }),
1683
1936
  timeSeries: analyticsTimeSeriesSchema
1684
1937
  }));
1685
- 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({
1686
2064
  path: "/v1/teams",
1687
2065
  method: "GET",
1688
2066
  summary: "List teams",
@@ -1695,7 +2073,22 @@ const listTeamsContractV1 = oc.route({
1695
2073
  createdAt: z.coerce.date(),
1696
2074
  hasStripeAccount: z.boolean()
1697
2075
  })));
1698
- 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({
1699
2092
  path: "/v1/tunnels/ticket",
1700
2093
  method: "GET",
1701
2094
  summary: "Get a tunnel ticket",
@@ -1707,16 +2100,13 @@ const getTunnelTicketContractV1 = oc.route({
1707
2100
  ticket: z.string().describe("The signed tunnel ticket"),
1708
2101
  tunnelHost: z.string().describe("The tunnel host to connect to")
1709
2102
  }));
1710
- const publishServerContractV1 = oc.route({
2103
+ const publishServerContractV1 = base.route({
1711
2104
  path: "/v1/distribution/publish",
1712
2105
  method: "POST",
1713
2106
  summary: "Publish a server to the MCP registry",
1714
2107
  tags: ["distribution"],
1715
2108
  successDescription: "The server has been published successfully"
1716
- }).errors({
1717
- NOT_FOUND: {},
1718
- BAD_REQUEST: {}
1719
- }).input(z.object({
2109
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1720
2110
  projectId: z.string(),
1721
2111
  domain: z.string(),
1722
2112
  title: z.string().min(1).max(100),
@@ -1725,17 +2115,14 @@ const publishServerContractV1 = oc.route({
1725
2115
  iconSrc: z.url().max(255).optional(),
1726
2116
  dryRun: z.boolean().optional()
1727
2117
  })).output(z.object({ serverFields: serverFieldsSchema }));
1728
- const getServerInfoContractV1 = oc.route({
2118
+ const getServerInfoContractV1 = base.route({
1729
2119
  path: "/v1/distribution/get",
1730
2120
  method: "GET",
1731
2121
  summary: "Get server info",
1732
2122
  description: "Get info about a server",
1733
2123
  tags: ["distribution"],
1734
2124
  successDescription: "The server info"
1735
- }).errors({
1736
- NOT_FOUND: {},
1737
- BAD_REQUEST: {}
1738
- }).input(z.object({
2125
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1739
2126
  projectId: z.string(),
1740
2127
  domain: z.string()
1741
2128
  })).output(z.object({ serverFields: serverFieldsSchema }));
@@ -1754,7 +2141,7 @@ const playgroundOutputSchema = z.object({
1754
2141
  isPlaygroundEnabled: z.boolean(),
1755
2142
  serverMetadata: playgroundServerMetadataOutputSchema.nullable()
1756
2143
  });
1757
- const getPlaygroundContractV1 = oc.route({
2144
+ const getPlaygroundContractV1 = base.route({
1758
2145
  path: "/v1/environments/{environmentId}/playground",
1759
2146
  method: "GET",
1760
2147
  summary: "Get playground configuration",
@@ -1762,17 +2149,14 @@ const getPlaygroundContractV1 = oc.route({
1762
2149
  tags: ["environments"],
1763
2150
  successDescription: "The playground configuration"
1764
2151
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
1765
- const upsertPlaygroundContractV1 = oc.route({
2152
+ const upsertPlaygroundContractV1 = base.route({
1766
2153
  path: "/v1/environments/{environmentId}/playground",
1767
2154
  method: "PUT",
1768
2155
  summary: "Update playground configuration",
1769
2156
  description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
1770
2157
  tags: ["environments"],
1771
2158
  successDescription: "The updated playground configuration"
1772
- }).errors({
1773
- NOT_FOUND: {},
1774
- BAD_REQUEST: {}
1775
- }).input(z.object({
2159
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1776
2160
  environmentId: z.string().describe("The ID of the environment"),
1777
2161
  isPlaygroundEnabled: z.boolean().optional(),
1778
2162
  name: z.string().min(1).max(100).optional(),
@@ -1780,7 +2164,7 @@ const upsertPlaygroundContractV1 = oc.route({
1780
2164
  headers: z.array(playgroundHeaderSchema).optional(),
1781
2165
  examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
1782
2166
  })).output(playgroundOutputSchema);
1783
- const createBeaconContractV1 = oc.route({
2167
+ const createBeaconContractV1 = base.route({
1784
2168
  path: "/v1/beacon/audits",
1785
2169
  method: "POST",
1786
2170
  summary: "Create a beacon audit",
@@ -1789,7 +2173,6 @@ const createBeaconContractV1 = oc.route({
1789
2173
  successDescription: "The audit has been created"
1790
2174
  }).errors({
1791
2175
  NOT_FOUND: {},
1792
- BAD_REQUEST: {},
1793
2176
  DNS_RESOLUTION_FAILED: { status: 400 }
1794
2177
  }).input(z.object({
1795
2178
  targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
@@ -1797,7 +2180,7 @@ const createBeaconContractV1 = oc.route({
1797
2180
  projectId: z.string().optional().describe("The project ID to associate the audit with"),
1798
2181
  excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
1799
2182
  })).output(z.object({ id: z.string() }));
1800
- const getBeaconContractV1 = oc.route({
2183
+ const getBeaconContractV1 = base.route({
1801
2184
  path: "/v1/beacon/audits/{auditId}",
1802
2185
  method: "GET",
1803
2186
  summary: "Get a beacon audit",
@@ -1813,8 +2196,21 @@ const getBeaconContractV1 = oc.route({
1813
2196
  report: auditReportWithScreenshotsSchema.nullable()
1814
2197
  }));
1815
2198
  const contract = {
1816
- teams: { list: { v1: listTeamsContractV1 } },
2199
+ teams: {
2200
+ list: { v1: listTeamsContractV1 },
2201
+ getUsage: { v1: getTeamUsageContractV1 }
2202
+ },
1817
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 } },
1818
2214
  deployments: {
1819
2215
  list: { v1: listDeploymentsContractV1 },
1820
2216
  get: { v1: getDeploymentContractV1 },
@@ -1855,5 +2251,10 @@ const contract = {
1855
2251
  get: { v1: getBeaconContractV1 }
1856
2252
  }
1857
2253
  };
2254
+ const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
2255
+ const contractForDocs = {
2256
+ ...contract,
2257
+ deployments: deploymentsForDocs
2258
+ };
1858
2259
  //#endregion
1859
- export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, 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 };