@alpic-ai/api 0.0.0-dev.gd9b541c → 0.0.0-dev.gd9e9ea8
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.
- package/dist/index.d.mts +647 -85
- package/dist/index.mjs +520 -149
- package/package.json +5 -5
package/dist/index.mjs
CHANGED
|
@@ -256,6 +256,16 @@ z.object({
|
|
|
256
256
|
clientSecret: z.string(),
|
|
257
257
|
clientScopes: z.array(z.string())
|
|
258
258
|
});
|
|
259
|
+
z.enum([
|
|
260
|
+
"opening_balance",
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"refund",
|
|
266
|
+
"admin_adjustment"
|
|
267
|
+
]);
|
|
268
|
+
z.enum(["playground"]);
|
|
259
269
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
270
|
"ongoing",
|
|
261
271
|
"deployed",
|
|
@@ -283,33 +293,18 @@ const deploymentSummarySchema = z.object({
|
|
|
283
293
|
createdAt: z.coerce.date(),
|
|
284
294
|
updatedAt: z.coerce.date()
|
|
285
295
|
});
|
|
286
|
-
/**
|
|
287
|
-
* Public environment
|
|
288
|
-
*
|
|
289
|
-
* Answers anonymously and exposes no OAuth metadata.
|
|
290
|
-
*/
|
|
296
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
291
297
|
const publicEnvironmentSchema = z.object({
|
|
292
298
|
allowsAnonymous: z.literal(true),
|
|
293
299
|
oAuthMetadata: z.strictObject({})
|
|
294
300
|
});
|
|
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
|
-
*/
|
|
301
|
+
/** 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
302
|
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
302
303
|
allowsAnonymous: z.boolean(),
|
|
303
304
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
304
305
|
scope: z.string().optional()
|
|
305
306
|
});
|
|
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
|
-
*/
|
|
307
|
+
/** 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
308
|
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
314
309
|
allowsAnonymous: z.boolean(),
|
|
315
310
|
oAuthMetadata: z.object({
|
|
@@ -318,12 +313,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
318
313
|
}),
|
|
319
314
|
scope: z.string().optional()
|
|
320
315
|
});
|
|
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
|
-
*/
|
|
316
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
317
|
const standaloneEnvironmentSchema = z.object({
|
|
328
318
|
allowsAnonymous: z.boolean(),
|
|
329
319
|
oAuthMetadata: z.object({
|
|
@@ -332,13 +322,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
332
322
|
}),
|
|
333
323
|
scope: z.string().optional()
|
|
334
324
|
});
|
|
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
|
-
*/
|
|
325
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
342
326
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
343
327
|
allowsAnonymous: z.literal(false),
|
|
344
328
|
oAuthMetadata: z.strictObject({}),
|
|
@@ -428,12 +412,13 @@ z.object({
|
|
|
428
412
|
collectUserData: z.boolean(),
|
|
429
413
|
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
430
414
|
});
|
|
431
|
-
z.object({
|
|
415
|
+
const feedbackSchema = z.object({
|
|
432
416
|
id: z.string(),
|
|
433
417
|
createdAt: z.coerce.date(),
|
|
434
418
|
environmentId: z.string(),
|
|
435
419
|
content: z.string(),
|
|
436
|
-
source: z.enum(["model", "user"])
|
|
420
|
+
source: z.enum(["model", "user"]),
|
|
421
|
+
clientName: z.string().nullable()
|
|
437
422
|
});
|
|
438
423
|
z.object({
|
|
439
424
|
content: z.string(),
|
|
@@ -449,7 +434,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
449
434
|
"pink",
|
|
450
435
|
"gray"
|
|
451
436
|
]);
|
|
452
|
-
intentCategoryColorSchema.options;
|
|
437
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
453
438
|
const intentCategorySchema = z.object({
|
|
454
439
|
id: z.string(),
|
|
455
440
|
createdAt: z.coerce.date(),
|
|
@@ -457,7 +442,7 @@ const intentCategorySchema = z.object({
|
|
|
457
442
|
name: z.string(),
|
|
458
443
|
color: intentCategoryColorSchema
|
|
459
444
|
});
|
|
460
|
-
z.object({
|
|
445
|
+
const intentCategorySummarySchema = z.object({
|
|
461
446
|
id: z.string(),
|
|
462
447
|
name: z.string(),
|
|
463
448
|
color: intentCategoryColorSchema,
|
|
@@ -469,6 +454,7 @@ z.object({
|
|
|
469
454
|
environmentId: z.string(),
|
|
470
455
|
toolName: z.string(),
|
|
471
456
|
message: z.string(),
|
|
457
|
+
clientName: z.string().nullable(),
|
|
472
458
|
categories: z.array(intentCategorySchema)
|
|
473
459
|
});
|
|
474
460
|
const signalCategorySchema = z.object({
|
|
@@ -527,12 +513,262 @@ z.object({
|
|
|
527
513
|
createdAt: z.coerce.date(),
|
|
528
514
|
updatedAt: z.coerce.date()
|
|
529
515
|
});
|
|
516
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
517
|
+
type: z.literal("mcp_request"),
|
|
518
|
+
method: z.string()
|
|
519
|
+
});
|
|
520
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
521
|
+
type: z.literal("mcp_error"),
|
|
522
|
+
method: z.string(),
|
|
523
|
+
error: z.string()
|
|
524
|
+
});
|
|
525
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
530
526
|
z.enum([
|
|
531
527
|
"INFO",
|
|
532
528
|
"WARNING",
|
|
533
529
|
"DEBUG",
|
|
534
530
|
"ERROR"
|
|
535
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]));
|
|
536
772
|
const runtimeSchema = z.enum([
|
|
537
773
|
"python3.13",
|
|
538
774
|
"python3.14",
|
|
@@ -610,15 +846,7 @@ z.object({
|
|
|
610
846
|
serverFields: serverFieldsSchema$1,
|
|
611
847
|
source: z.enum(["registry", "defaults"])
|
|
612
848
|
});
|
|
613
|
-
/**
|
|
614
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
615
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
616
|
-
*
|
|
617
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
618
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
619
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
620
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
621
|
-
*/
|
|
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. */
|
|
622
850
|
const clampStringField = (field) => {
|
|
623
851
|
const max = field.maxLength;
|
|
624
852
|
if (max === null) return field;
|
|
@@ -964,11 +1192,7 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
964
1192
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
965
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.\"")
|
|
966
1194
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
967
|
-
/**
|
|
968
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
969
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
970
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
971
|
-
*/
|
|
1195
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
972
1196
|
const chatgptTaglineSchema = z.string().max(30);
|
|
973
1197
|
const chatgptDescriptionSchema = z.string();
|
|
974
1198
|
const chatgptTranslationSchema = z.object({
|
|
@@ -977,10 +1201,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
977
1201
|
description: chatgptDescriptionSchema
|
|
978
1202
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
979
1203
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
980
|
-
/**
|
|
981
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
982
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
983
|
-
*/
|
|
1204
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
984
1205
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
985
1206
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
986
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."),
|
|
@@ -1077,11 +1298,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1077
1298
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1078
1299
|
"Public documentation for this connector will be live by the publish date."
|
|
1079
1300
|
]);
|
|
1080
|
-
/**
|
|
1081
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1082
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1083
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1084
|
-
*/
|
|
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. */
|
|
1085
1302
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1086
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
|
|
1087
1304
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1173,12 +1390,7 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1173
1390
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1174
1391
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1175
1392
|
});
|
|
1176
|
-
/**
|
|
1177
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1178
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1179
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1180
|
-
* colocated with the Claude contract.
|
|
1181
|
-
*/
|
|
1393
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1182
1394
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1183
1395
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1184
1396
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
@@ -1206,6 +1418,11 @@ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
|
1206
1418
|
});
|
|
1207
1419
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1208
1420
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1421
|
+
z.literal([
|
|
1422
|
+
100,
|
|
1423
|
+
75,
|
|
1424
|
+
50
|
|
1425
|
+
]);
|
|
1209
1426
|
const subscriptionPlanSchema = z.enum([
|
|
1210
1427
|
"pro",
|
|
1211
1428
|
"business",
|
|
@@ -1223,11 +1440,50 @@ const customerUsageSchema = z.object({
|
|
|
1223
1440
|
periodEnd: z.number()
|
|
1224
1441
|
});
|
|
1225
1442
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1443
|
+
z.object({ balanceInNanoUSD: z.number() });
|
|
1226
1444
|
z.object({
|
|
1227
1445
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1228
1446
|
customerUsage: customerUsageSchema.nullable(),
|
|
1229
1447
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1230
1448
|
});
|
|
1449
|
+
const telemetrySignalSchema = z.enum([
|
|
1450
|
+
"logs",
|
|
1451
|
+
"metrics",
|
|
1452
|
+
"traces"
|
|
1453
|
+
]);
|
|
1454
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1455
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1456
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1457
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1458
|
+
const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
|
|
1459
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1460
|
+
id: z.string(),
|
|
1461
|
+
name: otlpHeaderNameSchema,
|
|
1462
|
+
value: otlpHeaderValueSchema,
|
|
1463
|
+
isSecret: z.boolean()
|
|
1464
|
+
});
|
|
1465
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1466
|
+
"credentials",
|
|
1467
|
+
"wrong-path",
|
|
1468
|
+
"wrong-protocol",
|
|
1469
|
+
"invalid-payload",
|
|
1470
|
+
"partial-rejection",
|
|
1471
|
+
"blocked-target",
|
|
1472
|
+
"timeout",
|
|
1473
|
+
"unreachable",
|
|
1474
|
+
"receiver-error",
|
|
1475
|
+
"unexpected-status"
|
|
1476
|
+
]);
|
|
1477
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1478
|
+
z.object({
|
|
1479
|
+
id: z.string(),
|
|
1480
|
+
signal: telemetrySignalSchema,
|
|
1481
|
+
endpoint: otlpEndpointSchema,
|
|
1482
|
+
protocol: otlpProtocolSchema,
|
|
1483
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1484
|
+
status: telemetryDestinationStatusSchema,
|
|
1485
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1486
|
+
});
|
|
1231
1487
|
//#endregion
|
|
1232
1488
|
//#region src/auth-scope.ts
|
|
1233
1489
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1354,21 +1610,20 @@ const deploymentSchema = z.object({
|
|
|
1354
1610
|
isCurrent: z.boolean(),
|
|
1355
1611
|
deploymentPageUrl: z.url().nullable()
|
|
1356
1612
|
});
|
|
1357
|
-
const
|
|
1613
|
+
const isValidTimeInput = (value) => {
|
|
1358
1614
|
if (ms(value) !== void 0) return true;
|
|
1359
1615
|
return !Number.isNaN(new Date(value).getTime());
|
|
1360
1616
|
};
|
|
1361
|
-
const
|
|
1617
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1618
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1619
|
+
const createEnvironmentContractV1 = base.route({
|
|
1362
1620
|
path: "/v1/environments",
|
|
1363
1621
|
method: "POST",
|
|
1364
1622
|
summary: "Create an environment",
|
|
1365
1623
|
description: "Create an environment for a project",
|
|
1366
1624
|
tags: ["environments"],
|
|
1367
1625
|
successDescription: "The environment has been created successfully"
|
|
1368
|
-
}).errors({
|
|
1369
|
-
NOT_FOUND: {},
|
|
1370
|
-
BAD_REQUEST: {}
|
|
1371
|
-
}).input(z.object({
|
|
1626
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1372
1627
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1373
1628
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1374
1629
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1381,7 +1636,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1381
1636
|
createdAt: z.coerce.date(),
|
|
1382
1637
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1383
1638
|
}));
|
|
1384
|
-
const getEnvironmentContractV1 =
|
|
1639
|
+
const getEnvironmentContractV1 = base.route({
|
|
1385
1640
|
path: "/v1/environments/{environmentId}",
|
|
1386
1641
|
method: "GET",
|
|
1387
1642
|
summary: "Get an environment",
|
|
@@ -1438,7 +1693,7 @@ const projectOutputSchema = z.object({
|
|
|
1438
1693
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1439
1694
|
environments: z.array(environmentSchema)
|
|
1440
1695
|
});
|
|
1441
|
-
const getProjectContractV1 =
|
|
1696
|
+
const getProjectContractV1 = base.route({
|
|
1442
1697
|
path: "/v1/projects/{projectId}",
|
|
1443
1698
|
method: "GET",
|
|
1444
1699
|
summary: "Get a project",
|
|
@@ -1446,18 +1701,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1446
1701
|
tags: ["projects"],
|
|
1447
1702
|
successDescription: "The project details"
|
|
1448
1703
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1449
|
-
const listProjectsContractV1 =
|
|
1704
|
+
const listProjectsContractV1 = base.route({
|
|
1450
1705
|
path: "/v1/projects",
|
|
1451
1706
|
method: "GET",
|
|
1452
1707
|
summary: "List projects",
|
|
1453
1708
|
description: "List all projects for a team",
|
|
1454
1709
|
tags: ["projects"],
|
|
1455
1710
|
successDescription: "The list of projects"
|
|
1456
|
-
}).errors({
|
|
1457
|
-
|
|
1458
|
-
BAD_REQUEST: {}
|
|
1459
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1460
|
-
const createProjectContractV1 = oc.route({
|
|
1711
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1712
|
+
const createProjectContractV1 = base.route({
|
|
1461
1713
|
path: "/v1/projects",
|
|
1462
1714
|
method: "POST",
|
|
1463
1715
|
summary: "Create a project",
|
|
@@ -1466,7 +1718,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1466
1718
|
successDescription: "The project has been created successfully"
|
|
1467
1719
|
}).errors({
|
|
1468
1720
|
NOT_FOUND: {},
|
|
1469
|
-
BAD_REQUEST: {},
|
|
1470
1721
|
FORBIDDEN: {}
|
|
1471
1722
|
}).input(z.object({
|
|
1472
1723
|
teamId: z.string().optional(),
|
|
@@ -1507,7 +1758,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1507
1758
|
isSecret: z.boolean(),
|
|
1508
1759
|
createdAt: z.coerce.date()
|
|
1509
1760
|
});
|
|
1510
|
-
const listEnvironmentVariablesContractV1 =
|
|
1761
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1511
1762
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1512
1763
|
method: "GET",
|
|
1513
1764
|
summary: "List environment variables",
|
|
@@ -1515,48 +1766,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1515
1766
|
tags: ["environments"],
|
|
1516
1767
|
successDescription: "The list of environment variables"
|
|
1517
1768
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1518
|
-
const createEnvironmentVariablesContractV1 =
|
|
1769
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1519
1770
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1520
1771
|
method: "POST",
|
|
1521
1772
|
summary: "Add environment variables",
|
|
1522
1773
|
description: "Add one or more environment variables to an environment",
|
|
1523
1774
|
tags: ["environments"],
|
|
1524
1775
|
successDescription: "The environment variables have been added successfully"
|
|
1525
|
-
}).errors({
|
|
1526
|
-
NOT_FOUND: {},
|
|
1527
|
-
BAD_REQUEST: {}
|
|
1528
|
-
}).input(z.object({
|
|
1776
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1529
1777
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1530
1778
|
environmentVariables: environmentVariablesSchema
|
|
1531
1779
|
})).output(z.object({ success: z.literal(true) }));
|
|
1532
|
-
const updateEnvironmentVariableContractV1 =
|
|
1780
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1533
1781
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1534
1782
|
method: "PATCH",
|
|
1535
1783
|
summary: "Update an environment variable",
|
|
1536
1784
|
description: "Update an environment variable by ID",
|
|
1537
1785
|
tags: ["environments"],
|
|
1538
1786
|
successDescription: "The environment variable has been updated successfully"
|
|
1539
|
-
}).errors({
|
|
1540
|
-
NOT_FOUND: {},
|
|
1541
|
-
BAD_REQUEST: {}
|
|
1542
|
-
}).input(z.object({
|
|
1787
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1543
1788
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1544
1789
|
key: environmentVariableSchema.shape.key,
|
|
1545
1790
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1546
1791
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1547
1792
|
})).output(z.object({ success: z.literal(true) }));
|
|
1548
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1793
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1549
1794
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1550
1795
|
method: "DELETE",
|
|
1551
1796
|
summary: "Delete an environment variable",
|
|
1552
1797
|
description: "Delete an environment variable by ID",
|
|
1553
1798
|
tags: ["environments"],
|
|
1554
1799
|
successDescription: "The environment variable has been deleted successfully"
|
|
1555
|
-
}).errors({
|
|
1556
|
-
|
|
1557
|
-
BAD_REQUEST: {}
|
|
1558
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1559
|
-
const deleteProjectContractV1 = oc.route({
|
|
1800
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1801
|
+
const deleteProjectContractV1 = base.route({
|
|
1560
1802
|
path: "/v1/projects/{projectId}",
|
|
1561
1803
|
method: "DELETE",
|
|
1562
1804
|
summary: "Delete a project",
|
|
@@ -1564,7 +1806,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1564
1806
|
tags: ["projects"],
|
|
1565
1807
|
successDescription: "The project has been deleted successfully"
|
|
1566
1808
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1567
|
-
const updateProjectContractV1 =
|
|
1809
|
+
const updateProjectContractV1 = base.route({
|
|
1568
1810
|
path: "/v1/projects/{projectId}",
|
|
1569
1811
|
method: "PATCH",
|
|
1570
1812
|
summary: "Update a project",
|
|
@@ -1573,14 +1815,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1573
1815
|
successDescription: "The project has been updated successfully"
|
|
1574
1816
|
}).errors({
|
|
1575
1817
|
NOT_FOUND: {},
|
|
1576
|
-
BAD_REQUEST: {},
|
|
1577
1818
|
FORBIDDEN: {}
|
|
1578
1819
|
}).input(z.object({
|
|
1579
1820
|
projectId: z.string().describe("The ID of the project"),
|
|
1580
1821
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1581
1822
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1582
1823
|
})).output(projectOutputSchema);
|
|
1583
|
-
const deployEnvironmentContractV1 =
|
|
1824
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1584
1825
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1585
1826
|
method: "POST",
|
|
1586
1827
|
summary: "Deploy an environment",
|
|
@@ -1589,29 +1830,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1589
1830
|
successDescription: "The environment has been deployed successfully"
|
|
1590
1831
|
}).errors({
|
|
1591
1832
|
NOT_FOUND: {},
|
|
1592
|
-
BAD_REQUEST: {},
|
|
1593
1833
|
CONFLICT: {}
|
|
1594
1834
|
}).input(z.object({
|
|
1595
1835
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1596
1836
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1597
1837
|
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.")
|
|
1598
1838
|
})).output(deploymentSchema);
|
|
1599
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1839
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1600
1840
|
path: "/v1/deployments/upload",
|
|
1601
1841
|
method: "POST",
|
|
1602
1842
|
summary: "Upload deployment artifacts",
|
|
1603
1843
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1604
1844
|
tags: ["deployments"],
|
|
1605
1845
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1606
|
-
}).errors({
|
|
1607
|
-
NOT_FOUND: {},
|
|
1608
|
-
BAD_REQUEST: {}
|
|
1609
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1846
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1610
1847
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1611
1848
|
token: z.string().describe("Token to identify the source archive"),
|
|
1612
1849
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1613
1850
|
}));
|
|
1614
|
-
const listDeploymentsContractV1 =
|
|
1851
|
+
const listDeploymentsContractV1 = base.route({
|
|
1615
1852
|
path: "/v1/projects/{projectId}/deployments",
|
|
1616
1853
|
method: "GET",
|
|
1617
1854
|
summary: "List project deployments",
|
|
@@ -1623,7 +1860,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1623
1860
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1624
1861
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1625
1862
|
})).output(z.array(deploymentSchema));
|
|
1626
|
-
const getDeploymentContractV1 =
|
|
1863
|
+
const getDeploymentContractV1 = base.route({
|
|
1627
1864
|
path: "/v1/deployments/{deploymentId}",
|
|
1628
1865
|
method: "GET",
|
|
1629
1866
|
summary: "Get a deployment",
|
|
@@ -1646,20 +1883,17 @@ const logEntrySchema = z.object({
|
|
|
1646
1883
|
method: z.string().optional(),
|
|
1647
1884
|
durationInMs: z.number().optional()
|
|
1648
1885
|
});
|
|
1649
|
-
const getLogsContractV1 =
|
|
1886
|
+
const getLogsContractV1 = base.route({
|
|
1650
1887
|
path: "/v1/environments/{environmentId}/logs",
|
|
1651
1888
|
method: "GET",
|
|
1652
1889
|
summary: "Get logs",
|
|
1653
1890
|
description: "Get logs for an environment",
|
|
1654
1891
|
tags: ["environments"],
|
|
1655
1892
|
successDescription: "The logs"
|
|
1656
|
-
}).errors({
|
|
1657
|
-
NOT_FOUND: {},
|
|
1658
|
-
BAD_REQUEST: {}
|
|
1659
|
-
}).input(z.object({
|
|
1893
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1660
1894
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1661
|
-
since:
|
|
1662
|
-
until:
|
|
1895
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1896
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1663
1897
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1664
1898
|
level: z.array(z.enum([
|
|
1665
1899
|
"INFO",
|
|
@@ -1673,17 +1907,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1673
1907
|
logs: z.array(logEntrySchema),
|
|
1674
1908
|
nextToken: z.string().nullable()
|
|
1675
1909
|
}));
|
|
1676
|
-
const getLatestLogsContractV1 =
|
|
1910
|
+
const getLatestLogsContractV1 = base.route({
|
|
1677
1911
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1678
1912
|
method: "GET",
|
|
1679
1913
|
summary: "Get latest logs",
|
|
1680
1914
|
description: "Get the N most recent logs for an environment",
|
|
1681
1915
|
tags: ["environments"],
|
|
1682
1916
|
successDescription: "The latest logs"
|
|
1683
|
-
}).errors({
|
|
1684
|
-
NOT_FOUND: {},
|
|
1685
|
-
BAD_REQUEST: {}
|
|
1686
|
-
}).input(z.object({
|
|
1917
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1687
1918
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1688
1919
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1689
1920
|
level: z.array(z.enum([
|
|
@@ -1694,7 +1925,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1694
1925
|
])).optional().describe("Filter by log level"),
|
|
1695
1926
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1696
1927
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1697
|
-
const getDeploymentLogsContractV1 =
|
|
1928
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1698
1929
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1699
1930
|
method: "GET",
|
|
1700
1931
|
summary: "Get deployment logs",
|
|
@@ -1721,22 +1952,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1721
1952
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1722
1953
|
task_count: z.array(analyticsDataPointSchema)
|
|
1723
1954
|
});
|
|
1724
|
-
const getProjectAnalyticsContractV1 =
|
|
1955
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1725
1956
|
path: "/v1/analytics/{projectId}",
|
|
1726
1957
|
method: "GET",
|
|
1727
1958
|
summary: "Get project analytics",
|
|
1728
1959
|
description: "Get analytics data for a project over a time range",
|
|
1729
1960
|
tags: ["analytics"],
|
|
1730
1961
|
successDescription: "The project analytics data"
|
|
1731
|
-
}).errors({
|
|
1732
|
-
NOT_FOUND: {},
|
|
1733
|
-
BAD_REQUEST: {}
|
|
1734
|
-
}).input(z.object({
|
|
1962
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1735
1963
|
projectId: z.string().describe("The ID of the project"),
|
|
1736
1964
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1737
1965
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1738
1966
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1739
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
1967
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => Intl.supportedValuesOf("timeZone").includes(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1740
1968
|
metadata: z.object({
|
|
1741
1969
|
startTimestamp: z.number(),
|
|
1742
1970
|
endTimestamp: z.number(),
|
|
@@ -1746,7 +1974,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1746
1974
|
}),
|
|
1747
1975
|
timeSeries: analyticsTimeSeriesSchema
|
|
1748
1976
|
}));
|
|
1749
|
-
const
|
|
1977
|
+
const paginatedInsightsInputShape = {
|
|
1978
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1979
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1980
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1981
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1982
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1983
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1984
|
+
};
|
|
1985
|
+
const listIntentsContractV1 = base.route({
|
|
1986
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1987
|
+
method: "GET",
|
|
1988
|
+
summary: "List intents",
|
|
1989
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1990
|
+
tags: ["insights"],
|
|
1991
|
+
successDescription: "The grouped user intents"
|
|
1992
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1993
|
+
...paginatedInsightsInputShape,
|
|
1994
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1995
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
1996
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1997
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
1998
|
+
})).output(z.object({
|
|
1999
|
+
intents: z.array(z.object({
|
|
2000
|
+
id: z.string(),
|
|
2001
|
+
intentIds: z.array(z.string()).min(1),
|
|
2002
|
+
environmentId: z.string(),
|
|
2003
|
+
message: z.string(),
|
|
2004
|
+
toolName: z.string(),
|
|
2005
|
+
createdAt: z.coerce.date(),
|
|
2006
|
+
occurrenceCount: z.number().int().positive(),
|
|
2007
|
+
clientName: z.string().nullable(),
|
|
2008
|
+
clientId: z.string().nullable(),
|
|
2009
|
+
categories: z.array(z.object({
|
|
2010
|
+
id: z.string(),
|
|
2011
|
+
name: z.string(),
|
|
2012
|
+
color: intentCategoryColorSchema
|
|
2013
|
+
}))
|
|
2014
|
+
})),
|
|
2015
|
+
totalCount: z.number().int().nonnegative()
|
|
2016
|
+
}));
|
|
2017
|
+
const listFeedbacksContractV1 = base.route({
|
|
2018
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2019
|
+
method: "GET",
|
|
2020
|
+
summary: "List feedbacks",
|
|
2021
|
+
description: "List user feedback for an environment over a time range",
|
|
2022
|
+
tags: ["insights"],
|
|
2023
|
+
successDescription: "The user feedback"
|
|
2024
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2025
|
+
...paginatedInsightsInputShape,
|
|
2026
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2027
|
+
})).output(z.object({
|
|
2028
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2029
|
+
totalCount: z.number().int().nonnegative()
|
|
2030
|
+
}));
|
|
2031
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2032
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2033
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2034
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2035
|
+
method: "GET",
|
|
2036
|
+
summary: "List intent categories",
|
|
2037
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2038
|
+
tags: ["insights"],
|
|
2039
|
+
successDescription: "The intent categories"
|
|
2040
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2041
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2042
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2043
|
+
method: "POST",
|
|
2044
|
+
summary: "Create an intent category",
|
|
2045
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2046
|
+
tags: ["insights"],
|
|
2047
|
+
successDescription: "The created intent category"
|
|
2048
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2049
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2050
|
+
name: intentCategoryNameSchema,
|
|
2051
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2052
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2053
|
+
})).output(intentCategorySchema);
|
|
2054
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2055
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2056
|
+
method: "PATCH",
|
|
2057
|
+
summary: "Update an intent category",
|
|
2058
|
+
description: "Rename or recolor an intent category",
|
|
2059
|
+
tags: ["insights"],
|
|
2060
|
+
successDescription: "The updated intent category"
|
|
2061
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2062
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2063
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2064
|
+
name: intentCategoryNameSchema.optional(),
|
|
2065
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2066
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2067
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2068
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2069
|
+
method: "DELETE",
|
|
2070
|
+
summary: "Delete an intent category",
|
|
2071
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2072
|
+
tags: ["insights"],
|
|
2073
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2074
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2075
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2076
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2077
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2078
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2079
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2080
|
+
method: "POST",
|
|
2081
|
+
summary: "Link an intent category",
|
|
2082
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2083
|
+
tags: ["insights"],
|
|
2084
|
+
successDescription: "The intents have been linked successfully"
|
|
2085
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2086
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2087
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2088
|
+
intentIds: categorizableIntentIdsSchema
|
|
2089
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2090
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2091
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2092
|
+
method: "POST",
|
|
2093
|
+
summary: "Unlink an intent category",
|
|
2094
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2095
|
+
tags: ["insights"],
|
|
2096
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2097
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2098
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2099
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2100
|
+
intentIds: categorizableIntentIdsSchema
|
|
2101
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2102
|
+
const listTeamsContractV1 = base.route({
|
|
1750
2103
|
path: "/v1/teams",
|
|
1751
2104
|
method: "GET",
|
|
1752
2105
|
summary: "List teams",
|
|
@@ -1759,7 +2112,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1759
2112
|
createdAt: z.coerce.date(),
|
|
1760
2113
|
hasStripeAccount: z.boolean()
|
|
1761
2114
|
})));
|
|
1762
|
-
const
|
|
2115
|
+
const getTeamUsageContractV1 = base.route({
|
|
2116
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2117
|
+
method: "GET",
|
|
2118
|
+
summary: "Get team usage",
|
|
2119
|
+
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.",
|
|
2120
|
+
tags: ["teams"],
|
|
2121
|
+
successDescription: "The current billing window usage"
|
|
2122
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2123
|
+
teamId: z.string(),
|
|
2124
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2125
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2126
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2127
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2128
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2129
|
+
}));
|
|
2130
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1763
2131
|
path: "/v1/tunnels/ticket",
|
|
1764
2132
|
method: "GET",
|
|
1765
2133
|
summary: "Get a tunnel ticket",
|
|
@@ -1771,16 +2139,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1771
2139
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1772
2140
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1773
2141
|
}));
|
|
1774
|
-
const publishServerContractV1 =
|
|
2142
|
+
const publishServerContractV1 = base.route({
|
|
1775
2143
|
path: "/v1/distribution/publish",
|
|
1776
2144
|
method: "POST",
|
|
1777
2145
|
summary: "Publish a server to the MCP registry",
|
|
1778
2146
|
tags: ["distribution"],
|
|
1779
2147
|
successDescription: "The server has been published successfully"
|
|
1780
|
-
}).errors({
|
|
1781
|
-
NOT_FOUND: {},
|
|
1782
|
-
BAD_REQUEST: {}
|
|
1783
|
-
}).input(z.object({
|
|
2148
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1784
2149
|
projectId: z.string(),
|
|
1785
2150
|
domain: z.string(),
|
|
1786
2151
|
title: z.string().min(1).max(100),
|
|
@@ -1789,17 +2154,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1789
2154
|
iconSrc: z.url().max(255).optional(),
|
|
1790
2155
|
dryRun: z.boolean().optional()
|
|
1791
2156
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1792
|
-
const getServerInfoContractV1 =
|
|
2157
|
+
const getServerInfoContractV1 = base.route({
|
|
1793
2158
|
path: "/v1/distribution/get",
|
|
1794
2159
|
method: "GET",
|
|
1795
2160
|
summary: "Get server info",
|
|
1796
2161
|
description: "Get info about a server",
|
|
1797
2162
|
tags: ["distribution"],
|
|
1798
2163
|
successDescription: "The server info"
|
|
1799
|
-
}).errors({
|
|
1800
|
-
NOT_FOUND: {},
|
|
1801
|
-
BAD_REQUEST: {}
|
|
1802
|
-
}).input(z.object({
|
|
2164
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1803
2165
|
projectId: z.string(),
|
|
1804
2166
|
domain: z.string()
|
|
1805
2167
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1818,7 +2180,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1818
2180
|
isPlaygroundEnabled: z.boolean(),
|
|
1819
2181
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1820
2182
|
});
|
|
1821
|
-
const getPlaygroundContractV1 =
|
|
2183
|
+
const getPlaygroundContractV1 = base.route({
|
|
1822
2184
|
path: "/v1/environments/{environmentId}/playground",
|
|
1823
2185
|
method: "GET",
|
|
1824
2186
|
summary: "Get playground configuration",
|
|
@@ -1826,17 +2188,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1826
2188
|
tags: ["environments"],
|
|
1827
2189
|
successDescription: "The playground configuration"
|
|
1828
2190
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1829
|
-
const upsertPlaygroundContractV1 =
|
|
2191
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1830
2192
|
path: "/v1/environments/{environmentId}/playground",
|
|
1831
2193
|
method: "PUT",
|
|
1832
2194
|
summary: "Update playground configuration",
|
|
1833
2195
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1834
2196
|
tags: ["environments"],
|
|
1835
2197
|
successDescription: "The updated playground configuration"
|
|
1836
|
-
}).errors({
|
|
1837
|
-
NOT_FOUND: {},
|
|
1838
|
-
BAD_REQUEST: {}
|
|
1839
|
-
}).input(z.object({
|
|
2198
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1840
2199
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1841
2200
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1842
2201
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1844,7 +2203,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1844
2203
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1845
2204
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1846
2205
|
})).output(playgroundOutputSchema);
|
|
1847
|
-
const createBeaconContractV1 =
|
|
2206
|
+
const createBeaconContractV1 = base.route({
|
|
1848
2207
|
path: "/v1/beacon/audits",
|
|
1849
2208
|
method: "POST",
|
|
1850
2209
|
summary: "Create a beacon audit",
|
|
@@ -1853,7 +2212,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1853
2212
|
successDescription: "The audit has been created"
|
|
1854
2213
|
}).errors({
|
|
1855
2214
|
NOT_FOUND: {},
|
|
1856
|
-
BAD_REQUEST: {},
|
|
1857
2215
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1858
2216
|
}).input(z.object({
|
|
1859
2217
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1861,7 +2219,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1861
2219
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1862
2220
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1863
2221
|
})).output(z.object({ id: z.string() }));
|
|
1864
|
-
const getBeaconContractV1 =
|
|
2222
|
+
const getBeaconContractV1 = base.route({
|
|
1865
2223
|
path: "/v1/beacon/audits/{auditId}",
|
|
1866
2224
|
method: "GET",
|
|
1867
2225
|
summary: "Get a beacon audit",
|
|
@@ -1877,8 +2235,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1877
2235
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1878
2236
|
}));
|
|
1879
2237
|
const contract = {
|
|
1880
|
-
teams: {
|
|
2238
|
+
teams: {
|
|
2239
|
+
list: { v1: listTeamsContractV1 },
|
|
2240
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2241
|
+
},
|
|
1881
2242
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2243
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2244
|
+
intentCategories: {
|
|
2245
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2246
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2247
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2248
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2249
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2250
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2251
|
+
},
|
|
2252
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1882
2253
|
deployments: {
|
|
1883
2254
|
list: { v1: listDeploymentsContractV1 },
|
|
1884
2255
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1925,4 +2296,4 @@ const contractForDocs = {
|
|
|
1925
2296
|
deployments: deploymentsForDocs
|
|
1926
2297
|
};
|
|
1927
2298
|
//#endregion
|
|
1928
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2299
|
+
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 };
|