@alpic-ai/api 0.0.0-dev.ge70d649 → 0.0.0-dev.ge796b9a

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 +1064 -46
  2. package/dist/index.mjs +326 -145
  3. package/package.json +5 -5
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
  */
@@ -283,33 +283,18 @@ const deploymentSummarySchema = z.object({
283
283
  createdAt: z.coerce.date(),
284
284
  updatedAt: z.coerce.date()
285
285
  });
286
- /**
287
- * Public environment
288
- *
289
- * Answers anonymously and exposes no OAuth metadata.
290
- */
286
+ /** Public environment: answers anonymously and exposes no OAuth metadata. */
291
287
  const publicEnvironmentSchema = z.object({
292
288
  allowsAnonymous: z.literal(true),
293
289
  oAuthMetadata: z.strictObject({})
294
290
  });
295
- /**
296
- * Protected environment with an external resource metadata URL
297
- *
298
- * An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
299
- * Everything that follows is handled outside of the MCP server scope.
300
- */
291
+ /** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
301
292
  const externalResourceMetadataEnvironmentSchema = z.object({
302
293
  allowsAnonymous: z.boolean(),
303
294
  oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
304
295
  scope: z.string().optional()
305
296
  });
306
- /**
307
- * Protected environment with an external authorization server URL
308
- *
309
- * The server itself exposes the /.well-known/oauth-protected-resource endpoint.
310
- * An external authorization server URL is returned when requesting the endpoint.
311
- * Everything that follows is handled outside of the MCP server scope.
312
- */
297
+ /** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
313
298
  const externalAuthorizationServerEnvironmentSchema = z.object({
314
299
  allowsAnonymous: z.boolean(),
315
300
  oAuthMetadata: z.object({
@@ -318,12 +303,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
318
303
  }),
319
304
  scope: z.string().optional()
320
305
  });
321
- /**
322
- * Standalone protected environment
323
- *
324
- * The server itself exposes the /.well-known/oauth-protected-resource endpoint.
325
- * The server itself exposes the /.well-known/oauth-authorization-server endpoint.
326
- */
306
+ /** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
327
307
  const standaloneEnvironmentSchema = z.object({
328
308
  allowsAnonymous: z.boolean(),
329
309
  oAuthMetadata: z.object({
@@ -332,13 +312,7 @@ const standaloneEnvironmentSchema = z.object({
332
312
  }),
333
313
  scope: z.string().optional()
334
314
  });
335
- /**
336
- * Protected environment without OAuth discovery
337
- *
338
- * The server enforces authentication but exposes no OAuth discovery metadata.
339
- * Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
340
- * are advertised. Clients must obtain credentials out-of-band.
341
- */
315
+ /** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
342
316
  const protectedWithoutDiscoveryEnvironmentSchema = z.object({
343
317
  allowsAnonymous: z.literal(false),
344
318
  oAuthMetadata: z.strictObject({}),
@@ -425,14 +399,16 @@ z.object({
425
399
  collectRequestPayload: z.boolean(),
426
400
  collectResponsePayload: z.boolean(),
427
401
  collectErrorMessage: z.boolean(),
428
- collectUserData: z.boolean()
402
+ collectUserData: z.boolean(),
403
+ identityTraitKey: z.string().min(1).max(200).nullable()
429
404
  });
430
405
  z.object({
431
406
  id: z.string(),
432
407
  createdAt: z.coerce.date(),
433
408
  environmentId: z.string(),
434
409
  content: z.string(),
435
- source: z.enum(["model", "user"])
410
+ source: z.enum(["model", "user"]),
411
+ clientName: z.string().nullable()
436
412
  });
437
413
  z.object({
438
414
  content: z.string(),
@@ -468,6 +444,7 @@ z.object({
468
444
  environmentId: z.string(),
469
445
  toolName: z.string(),
470
446
  message: z.string(),
447
+ clientName: z.string().nullable(),
471
448
  categories: z.array(intentCategorySchema)
472
449
  });
473
450
  const signalCategorySchema = z.object({
@@ -532,6 +509,246 @@ z.enum([
532
509
  "DEBUG",
533
510
  "ERROR"
534
511
  ]);
512
+ /** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
513
+ const MCP_CLIENT_GROUPS = [
514
+ {
515
+ id: "claude_code",
516
+ label: "Claude Code",
517
+ vendor: "anthropic",
518
+ rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
519
+ },
520
+ {
521
+ id: "claude",
522
+ label: "Claude",
523
+ vendor: "anthropic",
524
+ rawNames: [
525
+ "Anthropic/ClaudeAI",
526
+ "claude-ai",
527
+ "claude",
528
+ "Claude",
529
+ "claude-desktop",
530
+ "claude-desktop-3p"
531
+ ]
532
+ },
533
+ {
534
+ id: "claude_mobile",
535
+ label: "Claude mobile",
536
+ vendor: "anthropic",
537
+ rawNames: ["claude-ios", "ClaudeAndroid"]
538
+ },
539
+ {
540
+ id: "claude_cowork",
541
+ label: "Claude Cowork",
542
+ vendor: "anthropic",
543
+ rawNames: ["Anthropic/Cowork"]
544
+ },
545
+ {
546
+ id: "claude_toolbox",
547
+ label: "Claude Toolbox",
548
+ vendor: "anthropic",
549
+ rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
550
+ },
551
+ {
552
+ id: "anthropic_api",
553
+ label: "Anthropic API",
554
+ vendor: "anthropic",
555
+ rawNames: ["Anthropic/API"]
556
+ },
557
+ {
558
+ id: "anthropic_connector_refresh",
559
+ label: "Anthropic (connector refresh)",
560
+ vendor: "anthropic",
561
+ rawNames: ["Anthropic"]
562
+ },
563
+ {
564
+ id: "codex",
565
+ label: "Codex",
566
+ vendor: "openai",
567
+ rawNames: [
568
+ "codex-mcp-client",
569
+ "codex",
570
+ "Codex",
571
+ "codex-cli",
572
+ "openai-mcp (Codex)"
573
+ ]
574
+ },
575
+ {
576
+ id: "chatgpt",
577
+ label: "ChatGPT",
578
+ vendor: "openai",
579
+ rawNames: ["openai-mcp (ChatGPT)"]
580
+ },
581
+ {
582
+ id: "openai_responses_api",
583
+ label: "OpenAI Responses API",
584
+ vendor: "openai",
585
+ rawNames: ["openai-mcp (Responses API)"]
586
+ },
587
+ {
588
+ id: "openai_agent_builder",
589
+ label: "OpenAI Agent Builder",
590
+ vendor: "openai",
591
+ rawNames: ["openai-mcp (Agent Builder)"]
592
+ },
593
+ {
594
+ id: "openai_other",
595
+ label: "OpenAI Other",
596
+ vendor: "openai",
597
+ rawNames: ["openai-mcp"]
598
+ },
599
+ {
600
+ id: "cursor",
601
+ label: "Cursor",
602
+ vendor: "cursor",
603
+ rawNames: [
604
+ "cursor-vscode",
605
+ "Cursor",
606
+ "cursor"
607
+ ]
608
+ },
609
+ {
610
+ id: "cline",
611
+ label: "Cline",
612
+ vendor: "cline",
613
+ rawNames: [
614
+ "Cline",
615
+ "cline",
616
+ "@cline/core"
617
+ ]
618
+ },
619
+ {
620
+ id: "github_copilot",
621
+ label: "GitHub Copilot",
622
+ vendor: "githubCopilot",
623
+ rawNames: [
624
+ "Copilot",
625
+ "github-copilot-developer",
626
+ "Copilot MCP Gateway",
627
+ "Xcode/copilot-xcode"
628
+ ]
629
+ },
630
+ {
631
+ id: "gemini_cli",
632
+ label: "Gemini CLI",
633
+ vendor: "google",
634
+ rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
635
+ },
636
+ {
637
+ id: "antigravity",
638
+ label: "Antigravity",
639
+ vendor: "google",
640
+ rawNames: ["antigravity-client"]
641
+ },
642
+ {
643
+ id: "gemini",
644
+ label: "Gemini",
645
+ vendor: "google",
646
+ rawNames: ["Gemini", "google-ai-edge-gallery"]
647
+ },
648
+ {
649
+ id: "windsurf",
650
+ label: "Windsurf",
651
+ vendor: "windsurf",
652
+ rawNames: ["Windsurf", "windsurf-client"]
653
+ },
654
+ {
655
+ id: "mistral",
656
+ label: "Mistral / Le Chat",
657
+ vendor: "mistral",
658
+ rawNames: ["Mistral"],
659
+ rawNamePrefixes: ["connector:custom-mcp:"]
660
+ },
661
+ {
662
+ id: "n8n",
663
+ label: "n8n",
664
+ vendor: "n8n",
665
+ rawNames: [
666
+ "@n8n/n8n-nodes-langchain.mcpClient",
667
+ "@n8n/n8n-nodes-langchain.mcpClientTool",
668
+ "n8n"
669
+ ]
670
+ },
671
+ {
672
+ id: "alpic_playground",
673
+ label: "Alpic Playground",
674
+ vendor: "alpic",
675
+ rawNames: ["alpic-playground", "playground"]
676
+ },
677
+ {
678
+ id: "opencode",
679
+ label: "opencode",
680
+ vendor: "opencode",
681
+ rawNames: ["opencode"]
682
+ },
683
+ {
684
+ id: "zed",
685
+ label: "Zed",
686
+ vendor: "zed",
687
+ rawNames: ["Zed", "zed"]
688
+ },
689
+ {
690
+ id: "zapier",
691
+ label: "Zapier",
692
+ vendor: "zapier",
693
+ rawNames: ["Zapier", "zapier"]
694
+ },
695
+ {
696
+ id: "make",
697
+ label: "Make",
698
+ vendor: "make",
699
+ rawNames: ["Make", "make"]
700
+ },
701
+ {
702
+ id: "librechat",
703
+ label: "LibreChat",
704
+ vendor: "mcp",
705
+ rawNames: ["LibreChat", "librechat"]
706
+ },
707
+ {
708
+ id: "jan",
709
+ label: "Jan",
710
+ vendor: "mcp",
711
+ rawNames: ["Jan", "jan"]
712
+ },
713
+ {
714
+ id: "goose",
715
+ label: "goose",
716
+ vendor: "mcp",
717
+ rawNames: ["goose", "Goose"]
718
+ },
719
+ {
720
+ id: "mcphost",
721
+ label: "mcphost",
722
+ vendor: "mcp",
723
+ rawNames: ["mcphost"]
724
+ },
725
+ {
726
+ id: "mcporter",
727
+ label: "mcporter",
728
+ vendor: "mcp",
729
+ rawNames: ["mcporter"]
730
+ },
731
+ {
732
+ id: "rmcp",
733
+ label: "rmcp",
734
+ vendor: "mcp",
735
+ rawNames: ["rmcp"]
736
+ },
737
+ {
738
+ id: "unnamed_client",
739
+ label: "Unnamed client",
740
+ vendor: "mcp",
741
+ rawNames: [
742
+ "mcp",
743
+ "unknown",
744
+ ""
745
+ ]
746
+ }
747
+ ];
748
+ /** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
749
+ const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
750
+ new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
751
+ new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
535
752
  const runtimeSchema = z.enum([
536
753
  "python3.13",
537
754
  "python3.14",
@@ -609,15 +826,7 @@ z.object({
609
826
  serverFields: serverFieldsSchema$1,
610
827
  source: z.enum(["registry", "defaults"])
611
828
  });
612
- /**
613
- * Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
614
- * rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
615
- *
616
- * NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
617
- * `minLength`, and the description. Any other validators on the source field (`.regex()`,
618
- * `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
619
- * free-text length caps only. A field with `null` `maxLength` is returned unchanged.
620
- */
829
+ /** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
621
830
  const clampStringField = (field) => {
622
831
  const max = field.maxLength;
623
832
  if (max === null) return field;
@@ -963,11 +1172,7 @@ const chatgptToolJustificationSchema = z.object({
963
1172
  openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
964
1173
  destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
965
1174
  }).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
966
- /**
967
- * Base copy fields, defined once and reused by both the submission form and per-locale
968
- * translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
969
- * path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
970
- */
1175
+ /** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
971
1176
  const chatgptTaglineSchema = z.string().max(30);
972
1177
  const chatgptDescriptionSchema = z.string();
973
1178
  const chatgptTranslationSchema = z.object({
@@ -976,10 +1181,7 @@ const chatgptTranslationSchema = z.object({
976
1181
  description: chatgptDescriptionSchema
977
1182
  }).describe("Locale-scoped override for tagline + description. English (US) is the default.");
978
1183
  chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
979
- /**
980
- * Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
981
- * When adding/removing/reordering fields, keep this in sync with the sheet.
982
- */
1184
+ /** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
983
1185
  const chatgptSubmissionFormDataSchema = z.object({
984
1186
  logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
985
1187
  logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
@@ -1076,11 +1278,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
1076
1278
  "My connector does not collect conversation data beyond what is needed for its function.",
1077
1279
  "Public documentation for this connector will be live by the publish date."
1078
1280
  ]);
1079
- /**
1080
- * Field order mirrors the claude.ai directory submission wizard
1081
- * (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
1082
- * When adding/removing/reordering fields, keep this in sync with the wizard.
1083
- */
1281
+ /** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
1084
1282
  const claudeSubmissionFormDataSchema = z.object({
1085
1283
  serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
1086
1284
  from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
@@ -1172,12 +1370,7 @@ claudeSubmissionFormDataSchema.pick({
1172
1370
  connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
1173
1371
  testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
1174
1372
  });
1175
- /**
1176
- * Narrative fields the LLM-backed generation step produces for Claude submissions.
1177
- * This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
1178
- * the strict form shape. Keep transforms here rather than in callers so generation leniency is
1179
- * colocated with the Claude contract.
1180
- */
1373
+ /** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
1181
1374
  const claudeAiGeneratedFormDataRawSchema = z.object({
1182
1375
  oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
1183
1376
  description: claudeSubmissionFormDataSchema.shape.description,
@@ -1222,6 +1415,7 @@ const customerUsageSchema = z.object({
1222
1415
  periodEnd: z.number()
1223
1416
  });
1224
1417
  const partnerDiscountSchema = z.object({ endsAt: z.number() });
1418
+ z.object({ balanceInNanoUSD: z.number() });
1225
1419
  z.object({
1226
1420
  customerCredits: customerCreditsSchema.nullable(),
1227
1421
  customerUsage: customerUsageSchema.nullable(),
@@ -1269,7 +1463,10 @@ const RESERVED_KEYS = [
1269
1463
  "BUILD_ARG_START_COMMAND",
1270
1464
  "ALPIC_HOST",
1271
1465
  "ALPIC_CUSTOM_DOMAINS",
1272
- "ALPIC_INTENT_META_KEY"
1466
+ "ALPIC_INTENT_META_KEY",
1467
+ "ALPIC_FEEDBACK_META_KEY",
1468
+ "ALPIC_EVENTS_META_KEY",
1469
+ "ALPIC_IDENTIFY_META_KEY"
1273
1470
  ];
1274
1471
  const environmentVariableSchema = z.object({
1275
1472
  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"),
@@ -1354,17 +1551,15 @@ const isValidLogTimeInput = (value) => {
1354
1551
  if (ms(value) !== void 0) return true;
1355
1552
  return !Number.isNaN(new Date(value).getTime());
1356
1553
  };
1357
- const createEnvironmentContractV1 = oc.route({
1554
+ const base = oc.errors({ BAD_REQUEST: {} });
1555
+ const createEnvironmentContractV1 = base.route({
1358
1556
  path: "/v1/environments",
1359
1557
  method: "POST",
1360
1558
  summary: "Create an environment",
1361
1559
  description: "Create an environment for a project",
1362
1560
  tags: ["environments"],
1363
1561
  successDescription: "The environment has been created successfully"
1364
- }).errors({
1365
- NOT_FOUND: {},
1366
- BAD_REQUEST: {}
1367
- }).input(z.object({
1562
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1368
1563
  projectId: z.string().describe("The ID of the project to create the environment for"),
1369
1564
  name: z.string().min(1).describe("The name of the environment"),
1370
1565
  sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
@@ -1377,7 +1572,7 @@ const createEnvironmentContractV1 = oc.route({
1377
1572
  createdAt: z.coerce.date(),
1378
1573
  projectId: z.string().describe("The ID of the project the environment belongs to")
1379
1574
  }));
1380
- const getEnvironmentContractV1 = oc.route({
1575
+ const getEnvironmentContractV1 = base.route({
1381
1576
  path: "/v1/environments/{environmentId}",
1382
1577
  method: "GET",
1383
1578
  summary: "Get an environment",
@@ -1434,7 +1629,7 @@ const projectOutputSchema = z.object({
1434
1629
  productionEnvironment: productionEnvironmentSchema.nullable(),
1435
1630
  environments: z.array(environmentSchema)
1436
1631
  });
1437
- const getProjectContractV1 = oc.route({
1632
+ const getProjectContractV1 = base.route({
1438
1633
  path: "/v1/projects/{projectId}",
1439
1634
  method: "GET",
1440
1635
  summary: "Get a project",
@@ -1442,18 +1637,15 @@ const getProjectContractV1 = oc.route({
1442
1637
  tags: ["projects"],
1443
1638
  successDescription: "The project details"
1444
1639
  }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
1445
- const listProjectsContractV1 = oc.route({
1640
+ const listProjectsContractV1 = base.route({
1446
1641
  path: "/v1/projects",
1447
1642
  method: "GET",
1448
1643
  summary: "List projects",
1449
1644
  description: "List all projects for a team",
1450
1645
  tags: ["projects"],
1451
1646
  successDescription: "The list of projects"
1452
- }).errors({
1453
- NOT_FOUND: {},
1454
- BAD_REQUEST: {}
1455
- }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
1456
- const createProjectContractV1 = oc.route({
1647
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
1648
+ const createProjectContractV1 = base.route({
1457
1649
  path: "/v1/projects",
1458
1650
  method: "POST",
1459
1651
  summary: "Create a project",
@@ -1462,7 +1654,6 @@ const createProjectContractV1 = oc.route({
1462
1654
  successDescription: "The project has been created successfully"
1463
1655
  }).errors({
1464
1656
  NOT_FOUND: {},
1465
- BAD_REQUEST: {},
1466
1657
  FORBIDDEN: {}
1467
1658
  }).input(z.object({
1468
1659
  teamId: z.string().optional(),
@@ -1503,7 +1694,7 @@ const environmentVariableOutputSchema = z.object({
1503
1694
  isSecret: z.boolean(),
1504
1695
  createdAt: z.coerce.date()
1505
1696
  });
1506
- const listEnvironmentVariablesContractV1 = oc.route({
1697
+ const listEnvironmentVariablesContractV1 = base.route({
1507
1698
  path: "/v1/environments/{environmentId}/environment-variables",
1508
1699
  method: "GET",
1509
1700
  summary: "List environment variables",
@@ -1511,48 +1702,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
1511
1702
  tags: ["environments"],
1512
1703
  successDescription: "The list of environment variables"
1513
1704
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
1514
- const createEnvironmentVariablesContractV1 = oc.route({
1705
+ const createEnvironmentVariablesContractV1 = base.route({
1515
1706
  path: "/v1/environments/{environmentId}/environment-variables",
1516
1707
  method: "POST",
1517
1708
  summary: "Add environment variables",
1518
1709
  description: "Add one or more environment variables to an environment",
1519
1710
  tags: ["environments"],
1520
1711
  successDescription: "The environment variables have been added successfully"
1521
- }).errors({
1522
- NOT_FOUND: {},
1523
- BAD_REQUEST: {}
1524
- }).input(z.object({
1712
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1525
1713
  environmentId: z.string().describe("The ID of the environment"),
1526
1714
  environmentVariables: environmentVariablesSchema
1527
1715
  })).output(z.object({ success: z.literal(true) }));
1528
- const updateEnvironmentVariableContractV1 = oc.route({
1716
+ const updateEnvironmentVariableContractV1 = base.route({
1529
1717
  path: "/v1/environment-variables/{environmentVariableId}",
1530
1718
  method: "PATCH",
1531
1719
  summary: "Update an environment variable",
1532
1720
  description: "Update an environment variable by ID",
1533
1721
  tags: ["environments"],
1534
1722
  successDescription: "The environment variable has been updated successfully"
1535
- }).errors({
1536
- NOT_FOUND: {},
1537
- BAD_REQUEST: {}
1538
- }).input(z.object({
1723
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1539
1724
  environmentVariableId: z.string().describe("The ID of the environment variable"),
1540
1725
  key: environmentVariableSchema.shape.key,
1541
1726
  value: environmentVariableSchema.shape.value.optional(),
1542
1727
  isSecret: environmentVariableSchema.shape.isSecret.optional()
1543
1728
  })).output(z.object({ success: z.literal(true) }));
1544
- const deleteEnvironmentVariableContractV1 = oc.route({
1729
+ const deleteEnvironmentVariableContractV1 = base.route({
1545
1730
  path: "/v1/environment-variables/{environmentVariableId}",
1546
1731
  method: "DELETE",
1547
1732
  summary: "Delete an environment variable",
1548
1733
  description: "Delete an environment variable by ID",
1549
1734
  tags: ["environments"],
1550
1735
  successDescription: "The environment variable has been deleted successfully"
1551
- }).errors({
1552
- NOT_FOUND: {},
1553
- BAD_REQUEST: {}
1554
- }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
1555
- const deleteProjectContractV1 = oc.route({
1736
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
1737
+ const deleteProjectContractV1 = base.route({
1556
1738
  path: "/v1/projects/{projectId}",
1557
1739
  method: "DELETE",
1558
1740
  summary: "Delete a project",
@@ -1560,7 +1742,7 @@ const deleteProjectContractV1 = oc.route({
1560
1742
  tags: ["projects"],
1561
1743
  successDescription: "The project has been deleted successfully"
1562
1744
  }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
1563
- const updateProjectContractV1 = oc.route({
1745
+ const updateProjectContractV1 = base.route({
1564
1746
  path: "/v1/projects/{projectId}",
1565
1747
  method: "PATCH",
1566
1748
  summary: "Update a project",
@@ -1569,14 +1751,13 @@ const updateProjectContractV1 = oc.route({
1569
1751
  successDescription: "The project has been updated successfully"
1570
1752
  }).errors({
1571
1753
  NOT_FOUND: {},
1572
- BAD_REQUEST: {},
1573
1754
  FORBIDDEN: {}
1574
1755
  }).input(z.object({
1575
1756
  projectId: z.string().describe("The ID of the project"),
1576
1757
  name: z.string().min(1).max(100).optional().describe("The new name for the project"),
1577
1758
  sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
1578
1759
  })).output(projectOutputSchema);
1579
- const deployEnvironmentContractV1 = oc.route({
1760
+ const deployEnvironmentContractV1 = base.route({
1580
1761
  path: "/v1/environments/{environmentId}/deploy",
1581
1762
  method: "POST",
1582
1763
  summary: "Deploy an environment",
@@ -1585,29 +1766,25 @@ const deployEnvironmentContractV1 = oc.route({
1585
1766
  successDescription: "The environment has been deployed successfully"
1586
1767
  }).errors({
1587
1768
  NOT_FOUND: {},
1588
- BAD_REQUEST: {},
1589
1769
  CONFLICT: {}
1590
1770
  }).input(z.object({
1591
1771
  environmentId: z.string().describe("The ID of the environment to deploy"),
1592
1772
  token: z.string().describe("The token to identify the source archive").optional(),
1593
1773
  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.")
1594
1774
  })).output(deploymentSchema);
1595
- const uploadDeploymentArtifactContractV1 = oc.route({
1775
+ const uploadDeploymentArtifactContractV1 = base.route({
1596
1776
  path: "/v1/deployments/upload",
1597
1777
  method: "POST",
1598
1778
  summary: "Upload deployment artifacts",
1599
1779
  description: "Return a presigned S3 URL to upload a deployment artifact",
1600
1780
  tags: ["deployments"],
1601
1781
  successDescription: "The presigned upload URL has been generated successfully"
1602
- }).errors({
1603
- NOT_FOUND: {},
1604
- BAD_REQUEST: {}
1605
- }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
1782
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
1606
1783
  uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
1607
1784
  token: z.string().describe("Token to identify the source archive"),
1608
1785
  expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
1609
1786
  }));
1610
- const listDeploymentsContractV1 = oc.route({
1787
+ const listDeploymentsContractV1 = base.route({
1611
1788
  path: "/v1/projects/{projectId}/deployments",
1612
1789
  method: "GET",
1613
1790
  summary: "List project deployments",
@@ -1619,7 +1796,7 @@ const listDeploymentsContractV1 = oc.route({
1619
1796
  status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
1620
1797
  environmentId: z.string().optional().describe("Filter by environment ID")
1621
1798
  })).output(z.array(deploymentSchema));
1622
- const getDeploymentContractV1 = oc.route({
1799
+ const getDeploymentContractV1 = base.route({
1623
1800
  path: "/v1/deployments/{deploymentId}",
1624
1801
  method: "GET",
1625
1802
  summary: "Get a deployment",
@@ -1642,17 +1819,14 @@ const logEntrySchema = z.object({
1642
1819
  method: z.string().optional(),
1643
1820
  durationInMs: z.number().optional()
1644
1821
  });
1645
- const getLogsContractV1 = oc.route({
1822
+ const getLogsContractV1 = base.route({
1646
1823
  path: "/v1/environments/{environmentId}/logs",
1647
1824
  method: "GET",
1648
1825
  summary: "Get logs",
1649
1826
  description: "Get logs for an environment",
1650
1827
  tags: ["environments"],
1651
1828
  successDescription: "The logs"
1652
- }).errors({
1653
- NOT_FOUND: {},
1654
- BAD_REQUEST: {}
1655
- }).input(z.object({
1829
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1656
1830
  environmentId: z.string().describe("The ID of the environment"),
1657
1831
  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)"),
1658
1832
  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"),
@@ -1669,17 +1843,14 @@ const getLogsContractV1 = oc.route({
1669
1843
  logs: z.array(logEntrySchema),
1670
1844
  nextToken: z.string().nullable()
1671
1845
  }));
1672
- const getLatestLogsContractV1 = oc.route({
1846
+ const getLatestLogsContractV1 = base.route({
1673
1847
  path: "/v1/environments/{environmentId}/latest-logs",
1674
1848
  method: "GET",
1675
1849
  summary: "Get latest logs",
1676
1850
  description: "Get the N most recent logs for an environment",
1677
1851
  tags: ["environments"],
1678
1852
  successDescription: "The latest logs"
1679
- }).errors({
1680
- NOT_FOUND: {},
1681
- BAD_REQUEST: {}
1682
- }).input(z.object({
1853
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1683
1854
  environmentId: z.string().describe("The ID of the environment"),
1684
1855
  limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
1685
1856
  level: z.array(z.enum([
@@ -1690,7 +1861,7 @@ const getLatestLogsContractV1 = oc.route({
1690
1861
  ])).optional().describe("Filter by log level"),
1691
1862
  search: z.string().optional().describe("Filter pattern to search for in log content")
1692
1863
  })).output(z.object({ logs: z.array(logEntrySchema) }));
1693
- const getDeploymentLogsContractV1 = oc.route({
1864
+ const getDeploymentLogsContractV1 = base.route({
1694
1865
  path: "/v1/deployments/{deploymentId}/logs",
1695
1866
  method: "GET",
1696
1867
  summary: "Get deployment logs",
@@ -1717,17 +1888,14 @@ const analyticsTimeSeriesSchema = z.object({
1717
1888
  output_token_mean: z.array(analyticsDataPointSchema),
1718
1889
  task_count: z.array(analyticsDataPointSchema)
1719
1890
  });
1720
- const getProjectAnalyticsContractV1 = oc.route({
1891
+ const getProjectAnalyticsContractV1 = base.route({
1721
1892
  path: "/v1/analytics/{projectId}",
1722
1893
  method: "GET",
1723
1894
  summary: "Get project analytics",
1724
1895
  description: "Get analytics data for a project over a time range",
1725
1896
  tags: ["analytics"],
1726
1897
  successDescription: "The project analytics data"
1727
- }).errors({
1728
- NOT_FOUND: {},
1729
- BAD_REQUEST: {}
1730
- }).input(z.object({
1898
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1731
1899
  projectId: z.string().describe("The ID of the project"),
1732
1900
  startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
1733
1901
  endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
@@ -1742,7 +1910,7 @@ const getProjectAnalyticsContractV1 = oc.route({
1742
1910
  }),
1743
1911
  timeSeries: analyticsTimeSeriesSchema
1744
1912
  }));
1745
- const listTeamsContractV1 = oc.route({
1913
+ const listTeamsContractV1 = base.route({
1746
1914
  path: "/v1/teams",
1747
1915
  method: "GET",
1748
1916
  summary: "List teams",
@@ -1755,7 +1923,22 @@ const listTeamsContractV1 = oc.route({
1755
1923
  createdAt: z.coerce.date(),
1756
1924
  hasStripeAccount: z.boolean()
1757
1925
  })));
1758
- const getTunnelTicketContractV1 = oc.route({
1926
+ const getTeamUsageContractV1 = base.route({
1927
+ path: "/v1/teams/{teamId}/usage",
1928
+ method: "GET",
1929
+ summary: "Get team usage",
1930
+ 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.",
1931
+ tags: ["teams"],
1932
+ successDescription: "The current billing window usage"
1933
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
1934
+ teamId: z.string(),
1935
+ plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
1936
+ periodStart: z.coerce.date().describe("Start of the current billing window"),
1937
+ periodEnd: z.coerce.date().describe("End of the current billing window"),
1938
+ requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
1939
+ includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
1940
+ }));
1941
+ const getTunnelTicketContractV1 = base.route({
1759
1942
  path: "/v1/tunnels/ticket",
1760
1943
  method: "GET",
1761
1944
  summary: "Get a tunnel ticket",
@@ -1767,16 +1950,13 @@ const getTunnelTicketContractV1 = oc.route({
1767
1950
  ticket: z.string().describe("The signed tunnel ticket"),
1768
1951
  tunnelHost: z.string().describe("The tunnel host to connect to")
1769
1952
  }));
1770
- const publishServerContractV1 = oc.route({
1953
+ const publishServerContractV1 = base.route({
1771
1954
  path: "/v1/distribution/publish",
1772
1955
  method: "POST",
1773
1956
  summary: "Publish a server to the MCP registry",
1774
1957
  tags: ["distribution"],
1775
1958
  successDescription: "The server has been published successfully"
1776
- }).errors({
1777
- NOT_FOUND: {},
1778
- BAD_REQUEST: {}
1779
- }).input(z.object({
1959
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1780
1960
  projectId: z.string(),
1781
1961
  domain: z.string(),
1782
1962
  title: z.string().min(1).max(100),
@@ -1785,17 +1965,14 @@ const publishServerContractV1 = oc.route({
1785
1965
  iconSrc: z.url().max(255).optional(),
1786
1966
  dryRun: z.boolean().optional()
1787
1967
  })).output(z.object({ serverFields: serverFieldsSchema }));
1788
- const getServerInfoContractV1 = oc.route({
1968
+ const getServerInfoContractV1 = base.route({
1789
1969
  path: "/v1/distribution/get",
1790
1970
  method: "GET",
1791
1971
  summary: "Get server info",
1792
1972
  description: "Get info about a server",
1793
1973
  tags: ["distribution"],
1794
1974
  successDescription: "The server info"
1795
- }).errors({
1796
- NOT_FOUND: {},
1797
- BAD_REQUEST: {}
1798
- }).input(z.object({
1975
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1799
1976
  projectId: z.string(),
1800
1977
  domain: z.string()
1801
1978
  })).output(z.object({ serverFields: serverFieldsSchema }));
@@ -1814,7 +1991,7 @@ const playgroundOutputSchema = z.object({
1814
1991
  isPlaygroundEnabled: z.boolean(),
1815
1992
  serverMetadata: playgroundServerMetadataOutputSchema.nullable()
1816
1993
  });
1817
- const getPlaygroundContractV1 = oc.route({
1994
+ const getPlaygroundContractV1 = base.route({
1818
1995
  path: "/v1/environments/{environmentId}/playground",
1819
1996
  method: "GET",
1820
1997
  summary: "Get playground configuration",
@@ -1822,17 +1999,14 @@ const getPlaygroundContractV1 = oc.route({
1822
1999
  tags: ["environments"],
1823
2000
  successDescription: "The playground configuration"
1824
2001
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
1825
- const upsertPlaygroundContractV1 = oc.route({
2002
+ const upsertPlaygroundContractV1 = base.route({
1826
2003
  path: "/v1/environments/{environmentId}/playground",
1827
2004
  method: "PUT",
1828
2005
  summary: "Update playground configuration",
1829
2006
  description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
1830
2007
  tags: ["environments"],
1831
2008
  successDescription: "The updated playground configuration"
1832
- }).errors({
1833
- NOT_FOUND: {},
1834
- BAD_REQUEST: {}
1835
- }).input(z.object({
2009
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1836
2010
  environmentId: z.string().describe("The ID of the environment"),
1837
2011
  isPlaygroundEnabled: z.boolean().optional(),
1838
2012
  name: z.string().min(1).max(100).optional(),
@@ -1840,7 +2014,7 @@ const upsertPlaygroundContractV1 = oc.route({
1840
2014
  headers: z.array(playgroundHeaderSchema).optional(),
1841
2015
  examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
1842
2016
  })).output(playgroundOutputSchema);
1843
- const createBeaconContractV1 = oc.route({
2017
+ const createBeaconContractV1 = base.route({
1844
2018
  path: "/v1/beacon/audits",
1845
2019
  method: "POST",
1846
2020
  summary: "Create a beacon audit",
@@ -1849,7 +2023,6 @@ const createBeaconContractV1 = oc.route({
1849
2023
  successDescription: "The audit has been created"
1850
2024
  }).errors({
1851
2025
  NOT_FOUND: {},
1852
- BAD_REQUEST: {},
1853
2026
  DNS_RESOLUTION_FAILED: { status: 400 }
1854
2027
  }).input(z.object({
1855
2028
  targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
@@ -1857,7 +2030,7 @@ const createBeaconContractV1 = oc.route({
1857
2030
  projectId: z.string().optional().describe("The project ID to associate the audit with"),
1858
2031
  excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
1859
2032
  })).output(z.object({ id: z.string() }));
1860
- const getBeaconContractV1 = oc.route({
2033
+ const getBeaconContractV1 = base.route({
1861
2034
  path: "/v1/beacon/audits/{auditId}",
1862
2035
  method: "GET",
1863
2036
  summary: "Get a beacon audit",
@@ -1873,7 +2046,10 @@ const getBeaconContractV1 = oc.route({
1873
2046
  report: auditReportWithScreenshotsSchema.nullable()
1874
2047
  }));
1875
2048
  const contract = {
1876
- teams: { list: { v1: listTeamsContractV1 } },
2049
+ teams: {
2050
+ list: { v1: listTeamsContractV1 },
2051
+ getUsage: { v1: getTeamUsageContractV1 }
2052
+ },
1877
2053
  analytics: { get: { v1: getProjectAnalyticsContractV1 } },
1878
2054
  deployments: {
1879
2055
  list: { v1: listDeploymentsContractV1 },
@@ -1915,5 +2091,10 @@ const contract = {
1915
2091
  get: { v1: getBeaconContractV1 }
1916
2092
  }
1917
2093
  };
2094
+ const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
2095
+ const contractForDocs = {
2096
+ ...contract,
2097
+ deployments: deploymentsForDocs
2098
+ };
1918
2099
  //#endregion
1919
- export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
2100
+ export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };