@alpic-ai/api 0.0.0-dev.gef1a773 → 0.0.0-dev.gef4493f
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 +530 -156
- 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.
|
|
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
|
*/
|
|
@@ -179,6 +179,7 @@ const PLATFORM_LABELS = {
|
|
|
179
179
|
};
|
|
180
180
|
const WAF_PLATFORMS = [
|
|
181
181
|
"akamai",
|
|
182
|
+
"cato",
|
|
182
183
|
"cloudflare",
|
|
183
184
|
"fastly"
|
|
184
185
|
];
|
|
@@ -256,6 +257,25 @@ z.object({
|
|
|
256
257
|
clientSecret: z.string(),
|
|
257
258
|
clientScopes: z.array(z.string())
|
|
258
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
259
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
280
|
"ongoing",
|
|
261
281
|
"deployed",
|
|
@@ -283,33 +303,18 @@ const deploymentSummarySchema = z.object({
|
|
|
283
303
|
createdAt: z.coerce.date(),
|
|
284
304
|
updatedAt: z.coerce.date()
|
|
285
305
|
});
|
|
286
|
-
/**
|
|
287
|
-
* Public environment
|
|
288
|
-
*
|
|
289
|
-
* Answers anonymously and exposes no OAuth metadata.
|
|
290
|
-
*/
|
|
306
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
291
307
|
const publicEnvironmentSchema = z.object({
|
|
292
308
|
allowsAnonymous: z.literal(true),
|
|
293
309
|
oAuthMetadata: z.strictObject({})
|
|
294
310
|
});
|
|
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
|
-
*/
|
|
311
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
301
312
|
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
302
313
|
allowsAnonymous: z.boolean(),
|
|
303
314
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
304
315
|
scope: z.string().optional()
|
|
305
316
|
});
|
|
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
|
-
*/
|
|
317
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
313
318
|
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
314
319
|
allowsAnonymous: z.boolean(),
|
|
315
320
|
oAuthMetadata: z.object({
|
|
@@ -318,12 +323,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
318
323
|
}),
|
|
319
324
|
scope: z.string().optional()
|
|
320
325
|
});
|
|
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
|
-
*/
|
|
326
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
327
|
const standaloneEnvironmentSchema = z.object({
|
|
328
328
|
allowsAnonymous: z.boolean(),
|
|
329
329
|
oAuthMetadata: z.object({
|
|
@@ -332,13 +332,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
332
332
|
}),
|
|
333
333
|
scope: z.string().optional()
|
|
334
334
|
});
|
|
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
|
-
*/
|
|
335
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
342
336
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
343
337
|
allowsAnonymous: z.literal(false),
|
|
344
338
|
oAuthMetadata: z.strictObject({}),
|
|
@@ -428,12 +422,13 @@ z.object({
|
|
|
428
422
|
collectUserData: z.boolean(),
|
|
429
423
|
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
430
424
|
});
|
|
431
|
-
z.object({
|
|
425
|
+
const feedbackSchema = z.object({
|
|
432
426
|
id: z.string(),
|
|
433
427
|
createdAt: z.coerce.date(),
|
|
434
428
|
environmentId: z.string(),
|
|
435
429
|
content: z.string(),
|
|
436
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
437
432
|
});
|
|
438
433
|
z.object({
|
|
439
434
|
content: z.string(),
|
|
@@ -449,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
449
444
|
"pink",
|
|
450
445
|
"gray"
|
|
451
446
|
]);
|
|
452
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
453
448
|
const intentCategorySchema = z.object({
|
|
454
449
|
id: z.string(),
|
|
455
450
|
createdAt: z.coerce.date(),
|
|
@@ -457,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
457
452
|
name: z.string(),
|
|
458
453
|
color: intentCategoryColorSchema
|
|
459
454
|
});
|
|
460
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
461
456
|
id: z.string(),
|
|
462
457
|
name: z.string(),
|
|
463
458
|
color: intentCategoryColorSchema,
|
|
@@ -469,6 +464,7 @@ z.object({
|
|
|
469
464
|
environmentId: z.string(),
|
|
470
465
|
toolName: z.string(),
|
|
471
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
472
468
|
categories: z.array(intentCategorySchema)
|
|
473
469
|
});
|
|
474
470
|
const signalCategorySchema = z.object({
|
|
@@ -527,12 +523,262 @@ z.object({
|
|
|
527
523
|
createdAt: z.coerce.date(),
|
|
528
524
|
updatedAt: z.coerce.date()
|
|
529
525
|
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
530
536
|
z.enum([
|
|
531
537
|
"INFO",
|
|
532
538
|
"WARNING",
|
|
533
539
|
"DEBUG",
|
|
534
540
|
"ERROR"
|
|
535
541
|
]);
|
|
542
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
|
+
const MCP_CLIENT_GROUPS = [
|
|
544
|
+
{
|
|
545
|
+
id: "claude_code",
|
|
546
|
+
label: "Claude Code",
|
|
547
|
+
vendor: "anthropic",
|
|
548
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
id: "claude",
|
|
552
|
+
label: "Claude",
|
|
553
|
+
vendor: "anthropic",
|
|
554
|
+
rawNames: [
|
|
555
|
+
"Anthropic/ClaudeAI",
|
|
556
|
+
"claude-ai",
|
|
557
|
+
"claude",
|
|
558
|
+
"Claude",
|
|
559
|
+
"claude-desktop",
|
|
560
|
+
"claude-desktop-3p"
|
|
561
|
+
]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "claude_mobile",
|
|
565
|
+
label: "Claude mobile",
|
|
566
|
+
vendor: "anthropic",
|
|
567
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
id: "claude_cowork",
|
|
571
|
+
label: "Claude Cowork",
|
|
572
|
+
vendor: "anthropic",
|
|
573
|
+
rawNames: ["Anthropic/Cowork"]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "claude_toolbox",
|
|
577
|
+
label: "Claude Toolbox",
|
|
578
|
+
vendor: "anthropic",
|
|
579
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "anthropic_api",
|
|
583
|
+
label: "Anthropic API",
|
|
584
|
+
vendor: "anthropic",
|
|
585
|
+
rawNames: ["Anthropic/API"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "anthropic_connector_refresh",
|
|
589
|
+
label: "Anthropic (connector refresh)",
|
|
590
|
+
vendor: "anthropic",
|
|
591
|
+
rawNames: ["Anthropic"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "codex",
|
|
595
|
+
label: "Codex",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: [
|
|
598
|
+
"codex-mcp-client",
|
|
599
|
+
"codex",
|
|
600
|
+
"Codex",
|
|
601
|
+
"codex-cli",
|
|
602
|
+
"openai-mcp (Codex)"
|
|
603
|
+
]
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
id: "chatgpt",
|
|
607
|
+
label: "ChatGPT",
|
|
608
|
+
vendor: "openai",
|
|
609
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
id: "openai_responses_api",
|
|
613
|
+
label: "OpenAI Responses API",
|
|
614
|
+
vendor: "openai",
|
|
615
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
id: "openai_agent_builder",
|
|
619
|
+
label: "OpenAI Agent Builder",
|
|
620
|
+
vendor: "openai",
|
|
621
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
id: "openai_other",
|
|
625
|
+
label: "OpenAI Other",
|
|
626
|
+
vendor: "openai",
|
|
627
|
+
rawNames: ["openai-mcp"]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cursor",
|
|
631
|
+
label: "Cursor",
|
|
632
|
+
vendor: "cursor",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"cursor-vscode",
|
|
635
|
+
"Cursor",
|
|
636
|
+
"cursor"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "cline",
|
|
641
|
+
label: "Cline",
|
|
642
|
+
vendor: "cline",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Cline",
|
|
645
|
+
"cline",
|
|
646
|
+
"@cline/core"
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
id: "github_copilot",
|
|
651
|
+
label: "GitHub Copilot",
|
|
652
|
+
vendor: "githubCopilot",
|
|
653
|
+
rawNames: [
|
|
654
|
+
"Copilot",
|
|
655
|
+
"github-copilot-developer",
|
|
656
|
+
"Copilot MCP Gateway",
|
|
657
|
+
"Xcode/copilot-xcode"
|
|
658
|
+
]
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
id: "gemini_cli",
|
|
662
|
+
label: "Gemini CLI",
|
|
663
|
+
vendor: "google",
|
|
664
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "antigravity",
|
|
668
|
+
label: "Antigravity",
|
|
669
|
+
vendor: "google",
|
|
670
|
+
rawNames: ["antigravity-client"]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "gemini",
|
|
674
|
+
label: "Gemini",
|
|
675
|
+
vendor: "google",
|
|
676
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
id: "windsurf",
|
|
680
|
+
label: "Windsurf",
|
|
681
|
+
vendor: "windsurf",
|
|
682
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
id: "mistral",
|
|
686
|
+
label: "Mistral / Le Chat",
|
|
687
|
+
vendor: "mistral",
|
|
688
|
+
rawNames: ["Mistral"],
|
|
689
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "n8n",
|
|
693
|
+
label: "n8n",
|
|
694
|
+
vendor: "n8n",
|
|
695
|
+
rawNames: [
|
|
696
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
698
|
+
"n8n"
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "alpic_playground",
|
|
703
|
+
label: "Alpic Playground",
|
|
704
|
+
vendor: "alpic",
|
|
705
|
+
rawNames: ["alpic-playground", "playground"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "opencode",
|
|
709
|
+
label: "opencode",
|
|
710
|
+
vendor: "opencode",
|
|
711
|
+
rawNames: ["opencode"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "zed",
|
|
715
|
+
label: "Zed",
|
|
716
|
+
vendor: "zed",
|
|
717
|
+
rawNames: ["Zed", "zed"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "zapier",
|
|
721
|
+
label: "Zapier",
|
|
722
|
+
vendor: "zapier",
|
|
723
|
+
rawNames: ["Zapier", "zapier"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "make",
|
|
727
|
+
label: "Make",
|
|
728
|
+
vendor: "make",
|
|
729
|
+
rawNames: ["Make", "make"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "librechat",
|
|
733
|
+
label: "LibreChat",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["LibreChat", "librechat"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "jan",
|
|
739
|
+
label: "Jan",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: ["Jan", "jan"]
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
id: "goose",
|
|
745
|
+
label: "goose",
|
|
746
|
+
vendor: "mcp",
|
|
747
|
+
rawNames: ["goose", "Goose"]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
id: "mcphost",
|
|
751
|
+
label: "mcphost",
|
|
752
|
+
vendor: "mcp",
|
|
753
|
+
rawNames: ["mcphost"]
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
id: "mcporter",
|
|
757
|
+
label: "mcporter",
|
|
758
|
+
vendor: "mcp",
|
|
759
|
+
rawNames: ["mcporter"]
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
id: "rmcp",
|
|
763
|
+
label: "rmcp",
|
|
764
|
+
vendor: "mcp",
|
|
765
|
+
rawNames: ["rmcp"]
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
id: "unnamed_client",
|
|
769
|
+
label: "Unnamed client",
|
|
770
|
+
vendor: "mcp",
|
|
771
|
+
rawNames: [
|
|
772
|
+
"mcp",
|
|
773
|
+
"unknown",
|
|
774
|
+
""
|
|
775
|
+
]
|
|
776
|
+
}
|
|
777
|
+
];
|
|
778
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
779
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
780
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
781
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
536
782
|
const runtimeSchema = z.enum([
|
|
537
783
|
"python3.13",
|
|
538
784
|
"python3.14",
|
|
@@ -610,15 +856,7 @@ z.object({
|
|
|
610
856
|
serverFields: serverFieldsSchema$1,
|
|
611
857
|
source: z.enum(["registry", "defaults"])
|
|
612
858
|
});
|
|
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
|
-
*/
|
|
859
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
622
860
|
const clampStringField = (field) => {
|
|
623
861
|
const max = field.maxLength;
|
|
624
862
|
if (max === null) return field;
|
|
@@ -964,11 +1202,7 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
964
1202
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
965
1203
|
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
1204
|
}).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
|
-
*/
|
|
1205
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
972
1206
|
const chatgptTaglineSchema = z.string().max(30);
|
|
973
1207
|
const chatgptDescriptionSchema = z.string();
|
|
974
1208
|
const chatgptTranslationSchema = z.object({
|
|
@@ -977,10 +1211,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
977
1211
|
description: chatgptDescriptionSchema
|
|
978
1212
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
979
1213
|
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
|
-
*/
|
|
1214
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
984
1215
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
985
1216
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
986
1217
|
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 +1308,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1077
1308
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1078
1309
|
"Public documentation for this connector will be live by the publish date."
|
|
1079
1310
|
]);
|
|
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
|
-
*/
|
|
1311
|
+
/** 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
1312
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1086
1313
|
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
1314
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1173,12 +1400,7 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1173
1400
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1174
1401
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1175
1402
|
});
|
|
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
|
-
*/
|
|
1403
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1182
1404
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1183
1405
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1184
1406
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
@@ -1206,6 +1428,11 @@ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
|
1206
1428
|
});
|
|
1207
1429
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1208
1430
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1431
|
+
z.literal([
|
|
1432
|
+
100,
|
|
1433
|
+
75,
|
|
1434
|
+
50
|
|
1435
|
+
]);
|
|
1209
1436
|
const subscriptionPlanSchema = z.enum([
|
|
1210
1437
|
"pro",
|
|
1211
1438
|
"business",
|
|
@@ -1217,17 +1444,49 @@ const customerCreditsSchema = z.object({
|
|
|
1217
1444
|
expiresAt: z.number().nullable(),
|
|
1218
1445
|
currency: z.string()
|
|
1219
1446
|
});
|
|
1220
|
-
const customerUsageSchema = z.object({
|
|
1221
|
-
amountInCents: z.number(),
|
|
1222
|
-
currency: z.string(),
|
|
1223
|
-
periodEnd: z.number()
|
|
1224
|
-
});
|
|
1225
1447
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1226
1448
|
z.object({
|
|
1227
1449
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1228
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1229
1450
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1230
1451
|
});
|
|
1452
|
+
const telemetrySignalSchema = z.enum([
|
|
1453
|
+
"logs",
|
|
1454
|
+
"metrics",
|
|
1455
|
+
"traces"
|
|
1456
|
+
]);
|
|
1457
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1458
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1459
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1460
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1461
|
+
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");
|
|
1462
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1463
|
+
id: z.string(),
|
|
1464
|
+
name: otlpHeaderNameSchema,
|
|
1465
|
+
value: otlpHeaderValueSchema,
|
|
1466
|
+
isSecret: z.boolean()
|
|
1467
|
+
});
|
|
1468
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1469
|
+
"credentials",
|
|
1470
|
+
"wrong-path",
|
|
1471
|
+
"wrong-protocol",
|
|
1472
|
+
"invalid-payload",
|
|
1473
|
+
"partial-rejection",
|
|
1474
|
+
"blocked-target",
|
|
1475
|
+
"timeout",
|
|
1476
|
+
"unreachable",
|
|
1477
|
+
"receiver-error",
|
|
1478
|
+
"unexpected-status"
|
|
1479
|
+
]);
|
|
1480
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1481
|
+
z.object({
|
|
1482
|
+
id: z.string(),
|
|
1483
|
+
signal: telemetrySignalSchema,
|
|
1484
|
+
endpoint: otlpEndpointSchema,
|
|
1485
|
+
protocol: otlpProtocolSchema,
|
|
1486
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1487
|
+
status: telemetryDestinationStatusSchema,
|
|
1488
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1489
|
+
});
|
|
1231
1490
|
//#endregion
|
|
1232
1491
|
//#region src/auth-scope.ts
|
|
1233
1492
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1354,21 +1613,20 @@ const deploymentSchema = z.object({
|
|
|
1354
1613
|
isCurrent: z.boolean(),
|
|
1355
1614
|
deploymentPageUrl: z.url().nullable()
|
|
1356
1615
|
});
|
|
1357
|
-
const
|
|
1616
|
+
const isValidTimeInput = (value) => {
|
|
1358
1617
|
if (ms(value) !== void 0) return true;
|
|
1359
1618
|
return !Number.isNaN(new Date(value).getTime());
|
|
1360
1619
|
};
|
|
1361
|
-
const
|
|
1620
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1621
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1622
|
+
const createEnvironmentContractV1 = base.route({
|
|
1362
1623
|
path: "/v1/environments",
|
|
1363
1624
|
method: "POST",
|
|
1364
1625
|
summary: "Create an environment",
|
|
1365
1626
|
description: "Create an environment for a project",
|
|
1366
1627
|
tags: ["environments"],
|
|
1367
1628
|
successDescription: "The environment has been created successfully"
|
|
1368
|
-
}).errors({
|
|
1369
|
-
NOT_FOUND: {},
|
|
1370
|
-
BAD_REQUEST: {}
|
|
1371
|
-
}).input(z.object({
|
|
1629
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1372
1630
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1373
1631
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1374
1632
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1381,7 +1639,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1381
1639
|
createdAt: z.coerce.date(),
|
|
1382
1640
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1383
1641
|
}));
|
|
1384
|
-
const getEnvironmentContractV1 =
|
|
1642
|
+
const getEnvironmentContractV1 = base.route({
|
|
1385
1643
|
path: "/v1/environments/{environmentId}",
|
|
1386
1644
|
method: "GET",
|
|
1387
1645
|
summary: "Get an environment",
|
|
@@ -1438,7 +1696,7 @@ const projectOutputSchema = z.object({
|
|
|
1438
1696
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1439
1697
|
environments: z.array(environmentSchema)
|
|
1440
1698
|
});
|
|
1441
|
-
const getProjectContractV1 =
|
|
1699
|
+
const getProjectContractV1 = base.route({
|
|
1442
1700
|
path: "/v1/projects/{projectId}",
|
|
1443
1701
|
method: "GET",
|
|
1444
1702
|
summary: "Get a project",
|
|
@@ -1446,18 +1704,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1446
1704
|
tags: ["projects"],
|
|
1447
1705
|
successDescription: "The project details"
|
|
1448
1706
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1449
|
-
const listProjectsContractV1 =
|
|
1707
|
+
const listProjectsContractV1 = base.route({
|
|
1450
1708
|
path: "/v1/projects",
|
|
1451
1709
|
method: "GET",
|
|
1452
1710
|
summary: "List projects",
|
|
1453
1711
|
description: "List all projects for a team",
|
|
1454
1712
|
tags: ["projects"],
|
|
1455
1713
|
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({
|
|
1714
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1715
|
+
const createProjectContractV1 = base.route({
|
|
1461
1716
|
path: "/v1/projects",
|
|
1462
1717
|
method: "POST",
|
|
1463
1718
|
summary: "Create a project",
|
|
@@ -1466,7 +1721,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1466
1721
|
successDescription: "The project has been created successfully"
|
|
1467
1722
|
}).errors({
|
|
1468
1723
|
NOT_FOUND: {},
|
|
1469
|
-
BAD_REQUEST: {},
|
|
1470
1724
|
FORBIDDEN: {}
|
|
1471
1725
|
}).input(z.object({
|
|
1472
1726
|
teamId: z.string().optional(),
|
|
@@ -1507,7 +1761,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1507
1761
|
isSecret: z.boolean(),
|
|
1508
1762
|
createdAt: z.coerce.date()
|
|
1509
1763
|
});
|
|
1510
|
-
const listEnvironmentVariablesContractV1 =
|
|
1764
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1511
1765
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1512
1766
|
method: "GET",
|
|
1513
1767
|
summary: "List environment variables",
|
|
@@ -1515,48 +1769,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1515
1769
|
tags: ["environments"],
|
|
1516
1770
|
successDescription: "The list of environment variables"
|
|
1517
1771
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1518
|
-
const createEnvironmentVariablesContractV1 =
|
|
1772
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1519
1773
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1520
1774
|
method: "POST",
|
|
1521
1775
|
summary: "Add environment variables",
|
|
1522
1776
|
description: "Add one or more environment variables to an environment",
|
|
1523
1777
|
tags: ["environments"],
|
|
1524
1778
|
successDescription: "The environment variables have been added successfully"
|
|
1525
|
-
}).errors({
|
|
1526
|
-
NOT_FOUND: {},
|
|
1527
|
-
BAD_REQUEST: {}
|
|
1528
|
-
}).input(z.object({
|
|
1779
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1529
1780
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1530
1781
|
environmentVariables: environmentVariablesSchema
|
|
1531
1782
|
})).output(z.object({ success: z.literal(true) }));
|
|
1532
|
-
const updateEnvironmentVariableContractV1 =
|
|
1783
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1533
1784
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1534
1785
|
method: "PATCH",
|
|
1535
1786
|
summary: "Update an environment variable",
|
|
1536
1787
|
description: "Update an environment variable by ID",
|
|
1537
1788
|
tags: ["environments"],
|
|
1538
1789
|
successDescription: "The environment variable has been updated successfully"
|
|
1539
|
-
}).errors({
|
|
1540
|
-
NOT_FOUND: {},
|
|
1541
|
-
BAD_REQUEST: {}
|
|
1542
|
-
}).input(z.object({
|
|
1790
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1543
1791
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1544
1792
|
key: environmentVariableSchema.shape.key,
|
|
1545
1793
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1546
1794
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1547
1795
|
})).output(z.object({ success: z.literal(true) }));
|
|
1548
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1796
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1549
1797
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1550
1798
|
method: "DELETE",
|
|
1551
1799
|
summary: "Delete an environment variable",
|
|
1552
1800
|
description: "Delete an environment variable by ID",
|
|
1553
1801
|
tags: ["environments"],
|
|
1554
1802
|
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({
|
|
1803
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1804
|
+
const deleteProjectContractV1 = base.route({
|
|
1560
1805
|
path: "/v1/projects/{projectId}",
|
|
1561
1806
|
method: "DELETE",
|
|
1562
1807
|
summary: "Delete a project",
|
|
@@ -1564,7 +1809,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1564
1809
|
tags: ["projects"],
|
|
1565
1810
|
successDescription: "The project has been deleted successfully"
|
|
1566
1811
|
}).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 =
|
|
1812
|
+
const updateProjectContractV1 = base.route({
|
|
1568
1813
|
path: "/v1/projects/{projectId}",
|
|
1569
1814
|
method: "PATCH",
|
|
1570
1815
|
summary: "Update a project",
|
|
@@ -1573,14 +1818,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1573
1818
|
successDescription: "The project has been updated successfully"
|
|
1574
1819
|
}).errors({
|
|
1575
1820
|
NOT_FOUND: {},
|
|
1576
|
-
BAD_REQUEST: {},
|
|
1577
1821
|
FORBIDDEN: {}
|
|
1578
1822
|
}).input(z.object({
|
|
1579
1823
|
projectId: z.string().describe("The ID of the project"),
|
|
1580
1824
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1581
1825
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1582
1826
|
})).output(projectOutputSchema);
|
|
1583
|
-
const deployEnvironmentContractV1 =
|
|
1827
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1584
1828
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1585
1829
|
method: "POST",
|
|
1586
1830
|
summary: "Deploy an environment",
|
|
@@ -1589,29 +1833,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1589
1833
|
successDescription: "The environment has been deployed successfully"
|
|
1590
1834
|
}).errors({
|
|
1591
1835
|
NOT_FOUND: {},
|
|
1592
|
-
BAD_REQUEST: {},
|
|
1593
1836
|
CONFLICT: {}
|
|
1594
1837
|
}).input(z.object({
|
|
1595
1838
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1596
1839
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1597
1840
|
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
1841
|
})).output(deploymentSchema);
|
|
1599
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1842
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1600
1843
|
path: "/v1/deployments/upload",
|
|
1601
1844
|
method: "POST",
|
|
1602
1845
|
summary: "Upload deployment artifacts",
|
|
1603
1846
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1604
1847
|
tags: ["deployments"],
|
|
1605
1848
|
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({
|
|
1849
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1610
1850
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1611
1851
|
token: z.string().describe("Token to identify the source archive"),
|
|
1612
1852
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1613
1853
|
}));
|
|
1614
|
-
const listDeploymentsContractV1 =
|
|
1854
|
+
const listDeploymentsContractV1 = base.route({
|
|
1615
1855
|
path: "/v1/projects/{projectId}/deployments",
|
|
1616
1856
|
method: "GET",
|
|
1617
1857
|
summary: "List project deployments",
|
|
@@ -1623,7 +1863,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1623
1863
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1624
1864
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1625
1865
|
})).output(z.array(deploymentSchema));
|
|
1626
|
-
const getDeploymentContractV1 =
|
|
1866
|
+
const getDeploymentContractV1 = base.route({
|
|
1627
1867
|
path: "/v1/deployments/{deploymentId}",
|
|
1628
1868
|
method: "GET",
|
|
1629
1869
|
summary: "Get a deployment",
|
|
@@ -1646,20 +1886,17 @@ const logEntrySchema = z.object({
|
|
|
1646
1886
|
method: z.string().optional(),
|
|
1647
1887
|
durationInMs: z.number().optional()
|
|
1648
1888
|
});
|
|
1649
|
-
const getLogsContractV1 =
|
|
1889
|
+
const getLogsContractV1 = base.route({
|
|
1650
1890
|
path: "/v1/environments/{environmentId}/logs",
|
|
1651
1891
|
method: "GET",
|
|
1652
1892
|
summary: "Get logs",
|
|
1653
1893
|
description: "Get logs for an environment",
|
|
1654
1894
|
tags: ["environments"],
|
|
1655
1895
|
successDescription: "The logs"
|
|
1656
|
-
}).errors({
|
|
1657
|
-
NOT_FOUND: {},
|
|
1658
|
-
BAD_REQUEST: {}
|
|
1659
|
-
}).input(z.object({
|
|
1896
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1660
1897
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1661
|
-
since:
|
|
1662
|
-
until:
|
|
1898
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1899
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1663
1900
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1664
1901
|
level: z.array(z.enum([
|
|
1665
1902
|
"INFO",
|
|
@@ -1673,17 +1910,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1673
1910
|
logs: z.array(logEntrySchema),
|
|
1674
1911
|
nextToken: z.string().nullable()
|
|
1675
1912
|
}));
|
|
1676
|
-
const getLatestLogsContractV1 =
|
|
1913
|
+
const getLatestLogsContractV1 = base.route({
|
|
1677
1914
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1678
1915
|
method: "GET",
|
|
1679
1916
|
summary: "Get latest logs",
|
|
1680
1917
|
description: "Get the N most recent logs for an environment",
|
|
1681
1918
|
tags: ["environments"],
|
|
1682
1919
|
successDescription: "The latest logs"
|
|
1683
|
-
}).errors({
|
|
1684
|
-
NOT_FOUND: {},
|
|
1685
|
-
BAD_REQUEST: {}
|
|
1686
|
-
}).input(z.object({
|
|
1920
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1687
1921
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1688
1922
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1689
1923
|
level: z.array(z.enum([
|
|
@@ -1694,7 +1928,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1694
1928
|
])).optional().describe("Filter by log level"),
|
|
1695
1929
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1696
1930
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1697
|
-
const getDeploymentLogsContractV1 =
|
|
1931
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1698
1932
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1699
1933
|
method: "GET",
|
|
1700
1934
|
summary: "Get deployment logs",
|
|
@@ -1721,22 +1955,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1721
1955
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1722
1956
|
task_count: z.array(analyticsDataPointSchema)
|
|
1723
1957
|
});
|
|
1724
|
-
const getProjectAnalyticsContractV1 =
|
|
1958
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1725
1959
|
path: "/v1/analytics/{projectId}",
|
|
1726
1960
|
method: "GET",
|
|
1727
1961
|
summary: "Get project analytics",
|
|
1728
1962
|
description: "Get analytics data for a project over a time range",
|
|
1729
1963
|
tags: ["analytics"],
|
|
1730
1964
|
successDescription: "The project analytics data"
|
|
1731
|
-
}).errors({
|
|
1732
|
-
NOT_FOUND: {},
|
|
1733
|
-
BAD_REQUEST: {}
|
|
1734
|
-
}).input(z.object({
|
|
1965
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1735
1966
|
projectId: z.string().describe("The ID of the project"),
|
|
1736
1967
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1737
1968
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1738
1969
|
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 <=
|
|
1970
|
+
}).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
1971
|
metadata: z.object({
|
|
1741
1972
|
startTimestamp: z.number(),
|
|
1742
1973
|
endTimestamp: z.number(),
|
|
@@ -1746,7 +1977,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1746
1977
|
}),
|
|
1747
1978
|
timeSeries: analyticsTimeSeriesSchema
|
|
1748
1979
|
}));
|
|
1749
|
-
const
|
|
1980
|
+
const paginatedInsightsInputShape = {
|
|
1981
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1982
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1983
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1984
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1985
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1986
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1987
|
+
};
|
|
1988
|
+
const listIntentsContractV1 = base.route({
|
|
1989
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1990
|
+
method: "GET",
|
|
1991
|
+
summary: "List intents",
|
|
1992
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1993
|
+
tags: ["insights"],
|
|
1994
|
+
successDescription: "The grouped user intents"
|
|
1995
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1996
|
+
...paginatedInsightsInputShape,
|
|
1997
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1998
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
1999
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2000
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2001
|
+
})).output(z.object({
|
|
2002
|
+
intents: z.array(z.object({
|
|
2003
|
+
id: z.string(),
|
|
2004
|
+
intentIds: z.array(z.string()).min(1),
|
|
2005
|
+
environmentId: z.string(),
|
|
2006
|
+
message: z.string(),
|
|
2007
|
+
toolName: z.string(),
|
|
2008
|
+
createdAt: z.coerce.date(),
|
|
2009
|
+
occurrenceCount: z.number().int().positive(),
|
|
2010
|
+
clientName: z.string().nullable(),
|
|
2011
|
+
clientId: z.string().nullable(),
|
|
2012
|
+
categories: z.array(z.object({
|
|
2013
|
+
id: z.string(),
|
|
2014
|
+
name: z.string(),
|
|
2015
|
+
color: intentCategoryColorSchema
|
|
2016
|
+
}))
|
|
2017
|
+
})),
|
|
2018
|
+
totalCount: z.number().int().nonnegative()
|
|
2019
|
+
}));
|
|
2020
|
+
const listFeedbacksContractV1 = base.route({
|
|
2021
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2022
|
+
method: "GET",
|
|
2023
|
+
summary: "List feedbacks",
|
|
2024
|
+
description: "List user feedback for an environment over a time range",
|
|
2025
|
+
tags: ["insights"],
|
|
2026
|
+
successDescription: "The user feedback"
|
|
2027
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2028
|
+
...paginatedInsightsInputShape,
|
|
2029
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2030
|
+
})).output(z.object({
|
|
2031
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2032
|
+
totalCount: z.number().int().nonnegative()
|
|
2033
|
+
}));
|
|
2034
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2035
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2036
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2037
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2038
|
+
method: "GET",
|
|
2039
|
+
summary: "List intent categories",
|
|
2040
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2041
|
+
tags: ["insights"],
|
|
2042
|
+
successDescription: "The intent categories"
|
|
2043
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2044
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2045
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2046
|
+
method: "POST",
|
|
2047
|
+
summary: "Create an intent category",
|
|
2048
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2049
|
+
tags: ["insights"],
|
|
2050
|
+
successDescription: "The created intent category"
|
|
2051
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2052
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2053
|
+
name: intentCategoryNameSchema,
|
|
2054
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2055
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2056
|
+
})).output(intentCategorySchema);
|
|
2057
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2058
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2059
|
+
method: "PATCH",
|
|
2060
|
+
summary: "Update an intent category",
|
|
2061
|
+
description: "Rename or recolor an intent category",
|
|
2062
|
+
tags: ["insights"],
|
|
2063
|
+
successDescription: "The updated intent category"
|
|
2064
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2065
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2066
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2067
|
+
name: intentCategoryNameSchema.optional(),
|
|
2068
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2069
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2070
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2071
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2072
|
+
method: "DELETE",
|
|
2073
|
+
summary: "Delete an intent category",
|
|
2074
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2075
|
+
tags: ["insights"],
|
|
2076
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2077
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2078
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2079
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2080
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2081
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2082
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2083
|
+
method: "POST",
|
|
2084
|
+
summary: "Link an intent category",
|
|
2085
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2086
|
+
tags: ["insights"],
|
|
2087
|
+
successDescription: "The intents have been linked successfully"
|
|
2088
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2089
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2090
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2091
|
+
intentIds: categorizableIntentIdsSchema
|
|
2092
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2093
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2094
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2095
|
+
method: "POST",
|
|
2096
|
+
summary: "Unlink an intent category",
|
|
2097
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2098
|
+
tags: ["insights"],
|
|
2099
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2100
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2101
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2102
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2103
|
+
intentIds: categorizableIntentIdsSchema
|
|
2104
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2105
|
+
const listTeamsContractV1 = base.route({
|
|
1750
2106
|
path: "/v1/teams",
|
|
1751
2107
|
method: "GET",
|
|
1752
2108
|
summary: "List teams",
|
|
@@ -1759,7 +2115,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1759
2115
|
createdAt: z.coerce.date(),
|
|
1760
2116
|
hasStripeAccount: z.boolean()
|
|
1761
2117
|
})));
|
|
1762
|
-
const
|
|
2118
|
+
const getTeamUsageContractV1 = base.route({
|
|
2119
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2120
|
+
method: "GET",
|
|
2121
|
+
summary: "Get team usage",
|
|
2122
|
+
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.",
|
|
2123
|
+
tags: ["teams"],
|
|
2124
|
+
successDescription: "The current billing window usage"
|
|
2125
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2126
|
+
teamId: z.string(),
|
|
2127
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2128
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2129
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2130
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2131
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2132
|
+
}));
|
|
2133
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1763
2134
|
path: "/v1/tunnels/ticket",
|
|
1764
2135
|
method: "GET",
|
|
1765
2136
|
summary: "Get a tunnel ticket",
|
|
@@ -1771,16 +2142,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1771
2142
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1772
2143
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1773
2144
|
}));
|
|
1774
|
-
const publishServerContractV1 =
|
|
2145
|
+
const publishServerContractV1 = base.route({
|
|
1775
2146
|
path: "/v1/distribution/publish",
|
|
1776
2147
|
method: "POST",
|
|
1777
2148
|
summary: "Publish a server to the MCP registry",
|
|
1778
2149
|
tags: ["distribution"],
|
|
1779
2150
|
successDescription: "The server has been published successfully"
|
|
1780
|
-
}).errors({
|
|
1781
|
-
NOT_FOUND: {},
|
|
1782
|
-
BAD_REQUEST: {}
|
|
1783
|
-
}).input(z.object({
|
|
2151
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1784
2152
|
projectId: z.string(),
|
|
1785
2153
|
domain: z.string(),
|
|
1786
2154
|
title: z.string().min(1).max(100),
|
|
@@ -1789,17 +2157,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1789
2157
|
iconSrc: z.url().max(255).optional(),
|
|
1790
2158
|
dryRun: z.boolean().optional()
|
|
1791
2159
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1792
|
-
const getServerInfoContractV1 =
|
|
2160
|
+
const getServerInfoContractV1 = base.route({
|
|
1793
2161
|
path: "/v1/distribution/get",
|
|
1794
2162
|
method: "GET",
|
|
1795
2163
|
summary: "Get server info",
|
|
1796
2164
|
description: "Get info about a server",
|
|
1797
2165
|
tags: ["distribution"],
|
|
1798
2166
|
successDescription: "The server info"
|
|
1799
|
-
}).errors({
|
|
1800
|
-
NOT_FOUND: {},
|
|
1801
|
-
BAD_REQUEST: {}
|
|
1802
|
-
}).input(z.object({
|
|
2167
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1803
2168
|
projectId: z.string(),
|
|
1804
2169
|
domain: z.string()
|
|
1805
2170
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1818,7 +2183,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1818
2183
|
isPlaygroundEnabled: z.boolean(),
|
|
1819
2184
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1820
2185
|
});
|
|
1821
|
-
const getPlaygroundContractV1 =
|
|
2186
|
+
const getPlaygroundContractV1 = base.route({
|
|
1822
2187
|
path: "/v1/environments/{environmentId}/playground",
|
|
1823
2188
|
method: "GET",
|
|
1824
2189
|
summary: "Get playground configuration",
|
|
@@ -1826,17 +2191,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1826
2191
|
tags: ["environments"],
|
|
1827
2192
|
successDescription: "The playground configuration"
|
|
1828
2193
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1829
|
-
const upsertPlaygroundContractV1 =
|
|
2194
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1830
2195
|
path: "/v1/environments/{environmentId}/playground",
|
|
1831
2196
|
method: "PUT",
|
|
1832
2197
|
summary: "Update playground configuration",
|
|
1833
2198
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1834
2199
|
tags: ["environments"],
|
|
1835
2200
|
successDescription: "The updated playground configuration"
|
|
1836
|
-
}).errors({
|
|
1837
|
-
NOT_FOUND: {},
|
|
1838
|
-
BAD_REQUEST: {}
|
|
1839
|
-
}).input(z.object({
|
|
2201
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1840
2202
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1841
2203
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1842
2204
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1844,7 +2206,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1844
2206
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1845
2207
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1846
2208
|
})).output(playgroundOutputSchema);
|
|
1847
|
-
const createBeaconContractV1 =
|
|
2209
|
+
const createBeaconContractV1 = base.route({
|
|
1848
2210
|
path: "/v1/beacon/audits",
|
|
1849
2211
|
method: "POST",
|
|
1850
2212
|
summary: "Create a beacon audit",
|
|
@@ -1853,7 +2215,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1853
2215
|
successDescription: "The audit has been created"
|
|
1854
2216
|
}).errors({
|
|
1855
2217
|
NOT_FOUND: {},
|
|
1856
|
-
BAD_REQUEST: {},
|
|
1857
2218
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1858
2219
|
}).input(z.object({
|
|
1859
2220
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1861,7 +2222,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1861
2222
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1862
2223
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1863
2224
|
})).output(z.object({ id: z.string() }));
|
|
1864
|
-
const getBeaconContractV1 =
|
|
2225
|
+
const getBeaconContractV1 = base.route({
|
|
1865
2226
|
path: "/v1/beacon/audits/{auditId}",
|
|
1866
2227
|
method: "GET",
|
|
1867
2228
|
summary: "Get a beacon audit",
|
|
@@ -1877,8 +2238,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1877
2238
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1878
2239
|
}));
|
|
1879
2240
|
const contract = {
|
|
1880
|
-
teams: {
|
|
2241
|
+
teams: {
|
|
2242
|
+
list: { v1: listTeamsContractV1 },
|
|
2243
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2244
|
+
},
|
|
1881
2245
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2246
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2247
|
+
intentCategories: {
|
|
2248
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2249
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2250
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2251
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2252
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2253
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2254
|
+
},
|
|
2255
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1882
2256
|
deployments: {
|
|
1883
2257
|
list: { v1: listDeploymentsContractV1 },
|
|
1884
2258
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1925,4 +2299,4 @@ const contractForDocs = {
|
|
|
1925
2299
|
deployments: deploymentsForDocs
|
|
1926
2300
|
};
|
|
1927
2301
|
//#endregion
|
|
1928
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2302
|
+
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 };
|