@alpic-ai/api 0.0.0-staging.gcbe17a4 → 0.0.0-staging.gccbd4e5
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 +692 -108
- package/dist/index.mjs +664 -171
- package/package.json +9 -9
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.5.4/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;
|
|
@@ -626,6 +864,10 @@ const clampStringField = (field) => {
|
|
|
626
864
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
627
865
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
628
866
|
};
|
|
867
|
+
const unboundedArrayField = (field) => {
|
|
868
|
+
const unbounded = z.array(field.element);
|
|
869
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
870
|
+
};
|
|
629
871
|
const toolDefinitionSchema = z.object({
|
|
630
872
|
name: z.string(),
|
|
631
873
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -638,11 +880,19 @@ const toolDefinitionSchema = z.object({
|
|
|
638
880
|
}).optional()
|
|
639
881
|
});
|
|
640
882
|
const positiveTestCaseSchema = z.object({
|
|
641
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
642
|
-
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
883
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
884
|
+
userPrompt: z.string().min(1).describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
643
885
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
644
886
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
645
|
-
}).
|
|
887
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
888
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial();
|
|
889
|
+
const blankPositiveTestCase = () => ({
|
|
890
|
+
scenario: "",
|
|
891
|
+
userPrompt: "",
|
|
892
|
+
toolTriggered: "",
|
|
893
|
+
expectedOutput: ""
|
|
894
|
+
});
|
|
895
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
646
896
|
const screenshotEntrySchema = z.object({
|
|
647
897
|
prompt: z.string(),
|
|
648
898
|
url: z.url()
|
|
@@ -955,20 +1205,21 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
955
1205
|
"zh-TW"
|
|
956
1206
|
]);
|
|
957
1207
|
const negativeTestCaseSchema = z.object({
|
|
958
|
-
scenario: z.string(),
|
|
959
|
-
userPrompt: z.string()
|
|
960
|
-
}).
|
|
1208
|
+
scenario: z.string().min(1),
|
|
1209
|
+
userPrompt: z.string().min(1)
|
|
1210
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1211
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial();
|
|
1212
|
+
const blankNegativeTestCase = () => ({
|
|
1213
|
+
scenario: "",
|
|
1214
|
+
userPrompt: ""
|
|
1215
|
+
});
|
|
961
1216
|
const chatgptToolJustificationSchema = z.object({
|
|
962
1217
|
toolName: z.string(),
|
|
963
1218
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
964
1219
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
965
1220
|
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
1221
|
}).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
|
-
*/
|
|
1222
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
972
1223
|
const chatgptTaglineSchema = z.string().max(30);
|
|
973
1224
|
const chatgptDescriptionSchema = z.string();
|
|
974
1225
|
const chatgptTranslationSchema = z.object({
|
|
@@ -977,10 +1228,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
977
1228
|
description: chatgptDescriptionSchema
|
|
978
1229
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
979
1230
|
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
|
-
*/
|
|
1231
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
984
1232
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
985
1233
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
986
1234
|
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."),
|
|
@@ -999,8 +1247,8 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
999
1247
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1000
1248
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1001
1249
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
1002
|
-
testCases: z.array(positiveTestCaseSchema).describe("
|
|
1003
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
1250
|
+
testCases: z.array(positiveTestCaseSchema).length(5).describe("Exactly 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
1251
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
1004
1252
|
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1005
1253
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1006
1254
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
@@ -1015,23 +1263,34 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1015
1263
|
demoRecordingUrl: z.string().optional(),
|
|
1016
1264
|
serverUrl: z.string().optional(),
|
|
1017
1265
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1266
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1267
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1018
1268
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1019
1269
|
});
|
|
1020
|
-
|
|
1270
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1271
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1021
1272
|
appName: true,
|
|
1022
1273
|
developerName: true,
|
|
1023
1274
|
serverUrl: true,
|
|
1024
1275
|
tools: true,
|
|
1025
1276
|
authentication: true
|
|
1026
1277
|
});
|
|
1027
|
-
|
|
1278
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1279
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1028
1280
|
tagline: true,
|
|
1029
1281
|
description: true,
|
|
1030
1282
|
category: true,
|
|
1031
1283
|
testCases: true,
|
|
1032
1284
|
negativeTestCases: true,
|
|
1033
1285
|
toolJustifications: true
|
|
1034
|
-
}).extend({
|
|
1286
|
+
}).extend({
|
|
1287
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1288
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1289
|
+
}).extend({
|
|
1290
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1291
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1292
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1293
|
+
});
|
|
1035
1294
|
const claudeCategorySchema = z.enum([
|
|
1036
1295
|
"Productivity",
|
|
1037
1296
|
"Communication",
|
|
@@ -1077,11 +1336,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1077
1336
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1078
1337
|
"Public documentation for this connector will be live by the publish date."
|
|
1079
1338
|
]);
|
|
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
|
-
*/
|
|
1339
|
+
/** 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
1340
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1086
1341
|
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
1342
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1158,7 +1413,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1158
1413
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1159
1414
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1160
1415
|
});
|
|
1161
|
-
|
|
1416
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1417
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1162
1418
|
serverUrl: true,
|
|
1163
1419
|
name: true,
|
|
1164
1420
|
slug: true,
|
|
@@ -1173,39 +1429,91 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1173
1429
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1174
1430
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1175
1431
|
});
|
|
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
|
-
*/
|
|
1432
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1182
1433
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1183
1434
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1184
1435
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1185
1436
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1186
1437
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1187
1438
|
});
|
|
1188
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1439
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1189
1440
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1190
1441
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1191
1442
|
});
|
|
1443
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1444
|
+
const byField = {};
|
|
1445
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1446
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1447
|
+
return byField;
|
|
1448
|
+
}
|
|
1449
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1450
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1451
|
+
"pass",
|
|
1452
|
+
"fail",
|
|
1453
|
+
"unverified"
|
|
1454
|
+
]);
|
|
1455
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1456
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1457
|
+
claudeai: ["privacyPolicy"]
|
|
1458
|
+
};
|
|
1459
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1460
|
+
const policyDisclosureSchema = z.enum([
|
|
1461
|
+
"dataCategories",
|
|
1462
|
+
"purposesOfUse",
|
|
1463
|
+
"recipients",
|
|
1464
|
+
"retention"
|
|
1465
|
+
]);
|
|
1466
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1467
|
+
field: verifiableUrlFieldSchema,
|
|
1468
|
+
url: z.string(),
|
|
1469
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1470
|
+
reason: z.string(),
|
|
1471
|
+
concerns: z.array(z.string()).optional(),
|
|
1472
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1473
|
+
});
|
|
1474
|
+
const urlVerificationSchema = z.object({
|
|
1475
|
+
verifiedAt: z.coerce.date(),
|
|
1476
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1477
|
+
});
|
|
1478
|
+
const pageKindSchema = z.enum([
|
|
1479
|
+
"expectedDocument",
|
|
1480
|
+
"errorPage",
|
|
1481
|
+
"loginWall",
|
|
1482
|
+
"parkedDomain",
|
|
1483
|
+
"comingSoon",
|
|
1484
|
+
"marketingPage",
|
|
1485
|
+
"unrelatedDocument"
|
|
1486
|
+
]);
|
|
1487
|
+
z.object({
|
|
1488
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1489
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1490
|
+
missingDisclosures: z.array(policyDisclosureSchema).describe("For a privacy policy only: which of the four required disclosures the text does not cover. Empty for every other page kind.")
|
|
1491
|
+
});
|
|
1192
1492
|
const submissionMetaFieldsSchema = z.object({
|
|
1193
1493
|
id: z.string(),
|
|
1194
1494
|
environmentId: z.string(),
|
|
1195
1495
|
auditId: z.string().nullable(),
|
|
1496
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1196
1497
|
createdAt: z.coerce.date(),
|
|
1197
1498
|
updatedAt: z.coerce.date()
|
|
1198
1499
|
});
|
|
1199
1500
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1200
1501
|
platform: z.literal("claudeai"),
|
|
1201
|
-
formData: claudeSubmissionDraftSchema
|
|
1502
|
+
formData: claudeSubmissionDraftSchema,
|
|
1503
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1202
1504
|
});
|
|
1203
1505
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1204
1506
|
platform: z.literal("chatgpt"),
|
|
1205
|
-
formData: chatgptSubmissionDraftSchema
|
|
1507
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1508
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1206
1509
|
});
|
|
1207
1510
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1208
1511
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1512
|
+
z.literal([
|
|
1513
|
+
100,
|
|
1514
|
+
75,
|
|
1515
|
+
50
|
|
1516
|
+
]);
|
|
1209
1517
|
const subscriptionPlanSchema = z.enum([
|
|
1210
1518
|
"pro",
|
|
1211
1519
|
"business",
|
|
@@ -1217,17 +1525,70 @@ const customerCreditsSchema = z.object({
|
|
|
1217
1525
|
expiresAt: z.number().nullable(),
|
|
1218
1526
|
currency: z.string()
|
|
1219
1527
|
});
|
|
1220
|
-
const customerUsageSchema = z.object({
|
|
1221
|
-
amountInCents: z.number(),
|
|
1222
|
-
currency: z.string(),
|
|
1223
|
-
periodEnd: z.number()
|
|
1224
|
-
});
|
|
1225
1528
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1226
1529
|
z.object({
|
|
1227
1530
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1228
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1229
1531
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1230
1532
|
});
|
|
1533
|
+
const metricsQueueEventSchema = z.object({
|
|
1534
|
+
ts: z.number().int(),
|
|
1535
|
+
method: z.string(),
|
|
1536
|
+
tool: z.string().nullable(),
|
|
1537
|
+
client: z.string(),
|
|
1538
|
+
sessionId: z.string().nullable(),
|
|
1539
|
+
durationMs: z.number().int(),
|
|
1540
|
+
outputTokens: z.number().int().nullable(),
|
|
1541
|
+
errorType: z.enum([
|
|
1542
|
+
"mcp_error",
|
|
1543
|
+
"tool_error",
|
|
1544
|
+
"timeout"
|
|
1545
|
+
]).nullable(),
|
|
1546
|
+
errorCode: z.number().int().nullable()
|
|
1547
|
+
});
|
|
1548
|
+
z.object({
|
|
1549
|
+
v: z.literal(1),
|
|
1550
|
+
envId: z.string(),
|
|
1551
|
+
events: z.array(metricsQueueEventSchema)
|
|
1552
|
+
});
|
|
1553
|
+
z.object({ v: z.number() });
|
|
1554
|
+
const telemetrySignalSchema = z.enum([
|
|
1555
|
+
"logs",
|
|
1556
|
+
"metrics",
|
|
1557
|
+
"traces"
|
|
1558
|
+
]);
|
|
1559
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1560
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1561
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1562
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1563
|
+
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");
|
|
1564
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1565
|
+
id: z.string(),
|
|
1566
|
+
name: otlpHeaderNameSchema,
|
|
1567
|
+
value: otlpHeaderValueSchema,
|
|
1568
|
+
isSecret: z.boolean()
|
|
1569
|
+
});
|
|
1570
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1571
|
+
"credentials",
|
|
1572
|
+
"wrong-path",
|
|
1573
|
+
"wrong-protocol",
|
|
1574
|
+
"invalid-payload",
|
|
1575
|
+
"partial-rejection",
|
|
1576
|
+
"blocked-target",
|
|
1577
|
+
"timeout",
|
|
1578
|
+
"unreachable",
|
|
1579
|
+
"receiver-error",
|
|
1580
|
+
"unexpected-status"
|
|
1581
|
+
]);
|
|
1582
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1583
|
+
z.object({
|
|
1584
|
+
id: z.string(),
|
|
1585
|
+
signal: telemetrySignalSchema,
|
|
1586
|
+
endpoint: otlpEndpointSchema,
|
|
1587
|
+
protocol: otlpProtocolSchema,
|
|
1588
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1589
|
+
status: telemetryDestinationStatusSchema,
|
|
1590
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1591
|
+
});
|
|
1231
1592
|
//#endregion
|
|
1232
1593
|
//#region src/auth-scope.ts
|
|
1233
1594
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1326,6 +1687,14 @@ const serverFieldsSchema = z.object({
|
|
|
1326
1687
|
});
|
|
1327
1688
|
//#endregion
|
|
1328
1689
|
//#region src/api.contract.ts
|
|
1690
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1691
|
+
try {
|
|
1692
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1693
|
+
return true;
|
|
1694
|
+
} catch {
|
|
1695
|
+
return false;
|
|
1696
|
+
}
|
|
1697
|
+
};
|
|
1329
1698
|
const deploymentStatusSchema = z.enum([
|
|
1330
1699
|
"ongoing",
|
|
1331
1700
|
"deployed",
|
|
@@ -1354,21 +1723,20 @@ const deploymentSchema = z.object({
|
|
|
1354
1723
|
isCurrent: z.boolean(),
|
|
1355
1724
|
deploymentPageUrl: z.url().nullable()
|
|
1356
1725
|
});
|
|
1357
|
-
const
|
|
1726
|
+
const isValidTimeInput = (value) => {
|
|
1358
1727
|
if (ms(value) !== void 0) return true;
|
|
1359
1728
|
return !Number.isNaN(new Date(value).getTime());
|
|
1360
1729
|
};
|
|
1361
|
-
const
|
|
1730
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1731
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1732
|
+
const createEnvironmentContractV1 = base.route({
|
|
1362
1733
|
path: "/v1/environments",
|
|
1363
1734
|
method: "POST",
|
|
1364
1735
|
summary: "Create an environment",
|
|
1365
1736
|
description: "Create an environment for a project",
|
|
1366
1737
|
tags: ["environments"],
|
|
1367
1738
|
successDescription: "The environment has been created successfully"
|
|
1368
|
-
}).errors({
|
|
1369
|
-
NOT_FOUND: {},
|
|
1370
|
-
BAD_REQUEST: {}
|
|
1371
|
-
}).input(z.object({
|
|
1739
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1372
1740
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1373
1741
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1374
1742
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1381,7 +1749,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1381
1749
|
createdAt: z.coerce.date(),
|
|
1382
1750
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1383
1751
|
}));
|
|
1384
|
-
const getEnvironmentContractV1 =
|
|
1752
|
+
const getEnvironmentContractV1 = base.route({
|
|
1385
1753
|
path: "/v1/environments/{environmentId}",
|
|
1386
1754
|
method: "GET",
|
|
1387
1755
|
summary: "Get an environment",
|
|
@@ -1397,6 +1765,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1397
1765
|
createdAt: z.coerce.date(),
|
|
1398
1766
|
projectId: z.string()
|
|
1399
1767
|
}));
|
|
1768
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1769
|
+
path: "/v1/environments/{environmentId}",
|
|
1770
|
+
method: "DELETE",
|
|
1771
|
+
summary: "Delete an environment",
|
|
1772
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1773
|
+
tags: ["environments"],
|
|
1774
|
+
successDescription: "The environment has been deleted successfully"
|
|
1775
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1400
1776
|
const domainSchema = z.object({
|
|
1401
1777
|
domain: z.string(),
|
|
1402
1778
|
status: z.enum([
|
|
@@ -1438,7 +1814,7 @@ const projectOutputSchema = z.object({
|
|
|
1438
1814
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1439
1815
|
environments: z.array(environmentSchema)
|
|
1440
1816
|
});
|
|
1441
|
-
const getProjectContractV1 =
|
|
1817
|
+
const getProjectContractV1 = base.route({
|
|
1442
1818
|
path: "/v1/projects/{projectId}",
|
|
1443
1819
|
method: "GET",
|
|
1444
1820
|
summary: "Get a project",
|
|
@@ -1446,18 +1822,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1446
1822
|
tags: ["projects"],
|
|
1447
1823
|
successDescription: "The project details"
|
|
1448
1824
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1449
|
-
const listProjectsContractV1 =
|
|
1825
|
+
const listProjectsContractV1 = base.route({
|
|
1450
1826
|
path: "/v1/projects",
|
|
1451
1827
|
method: "GET",
|
|
1452
1828
|
summary: "List projects",
|
|
1453
1829
|
description: "List all projects for a team",
|
|
1454
1830
|
tags: ["projects"],
|
|
1455
1831
|
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({
|
|
1832
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1833
|
+
const createProjectContractV1 = base.route({
|
|
1461
1834
|
path: "/v1/projects",
|
|
1462
1835
|
method: "POST",
|
|
1463
1836
|
summary: "Create a project",
|
|
@@ -1466,7 +1839,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1466
1839
|
successDescription: "The project has been created successfully"
|
|
1467
1840
|
}).errors({
|
|
1468
1841
|
NOT_FOUND: {},
|
|
1469
|
-
BAD_REQUEST: {},
|
|
1470
1842
|
FORBIDDEN: {}
|
|
1471
1843
|
}).input(z.object({
|
|
1472
1844
|
teamId: z.string().optional(),
|
|
@@ -1507,7 +1879,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1507
1879
|
isSecret: z.boolean(),
|
|
1508
1880
|
createdAt: z.coerce.date()
|
|
1509
1881
|
});
|
|
1510
|
-
const listEnvironmentVariablesContractV1 =
|
|
1882
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1511
1883
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1512
1884
|
method: "GET",
|
|
1513
1885
|
summary: "List environment variables",
|
|
@@ -1515,48 +1887,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1515
1887
|
tags: ["environments"],
|
|
1516
1888
|
successDescription: "The list of environment variables"
|
|
1517
1889
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1518
|
-
const createEnvironmentVariablesContractV1 =
|
|
1890
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1519
1891
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1520
1892
|
method: "POST",
|
|
1521
1893
|
summary: "Add environment variables",
|
|
1522
1894
|
description: "Add one or more environment variables to an environment",
|
|
1523
1895
|
tags: ["environments"],
|
|
1524
1896
|
successDescription: "The environment variables have been added successfully"
|
|
1525
|
-
}).errors({
|
|
1526
|
-
NOT_FOUND: {},
|
|
1527
|
-
BAD_REQUEST: {}
|
|
1528
|
-
}).input(z.object({
|
|
1897
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1529
1898
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1530
1899
|
environmentVariables: environmentVariablesSchema
|
|
1531
1900
|
})).output(z.object({ success: z.literal(true) }));
|
|
1532
|
-
const updateEnvironmentVariableContractV1 =
|
|
1901
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1533
1902
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1534
1903
|
method: "PATCH",
|
|
1535
1904
|
summary: "Update an environment variable",
|
|
1536
1905
|
description: "Update an environment variable by ID",
|
|
1537
1906
|
tags: ["environments"],
|
|
1538
1907
|
successDescription: "The environment variable has been updated successfully"
|
|
1539
|
-
}).errors({
|
|
1540
|
-
NOT_FOUND: {},
|
|
1541
|
-
BAD_REQUEST: {}
|
|
1542
|
-
}).input(z.object({
|
|
1908
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1543
1909
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1544
1910
|
key: environmentVariableSchema.shape.key,
|
|
1545
1911
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1546
1912
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1547
1913
|
})).output(z.object({ success: z.literal(true) }));
|
|
1548
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1914
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1549
1915
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1550
1916
|
method: "DELETE",
|
|
1551
1917
|
summary: "Delete an environment variable",
|
|
1552
1918
|
description: "Delete an environment variable by ID",
|
|
1553
1919
|
tags: ["environments"],
|
|
1554
1920
|
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({
|
|
1921
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1922
|
+
const deleteProjectContractV1 = base.route({
|
|
1560
1923
|
path: "/v1/projects/{projectId}",
|
|
1561
1924
|
method: "DELETE",
|
|
1562
1925
|
summary: "Delete a project",
|
|
@@ -1564,7 +1927,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1564
1927
|
tags: ["projects"],
|
|
1565
1928
|
successDescription: "The project has been deleted successfully"
|
|
1566
1929
|
}).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 =
|
|
1930
|
+
const updateProjectContractV1 = base.route({
|
|
1568
1931
|
path: "/v1/projects/{projectId}",
|
|
1569
1932
|
method: "PATCH",
|
|
1570
1933
|
summary: "Update a project",
|
|
@@ -1573,14 +1936,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1573
1936
|
successDescription: "The project has been updated successfully"
|
|
1574
1937
|
}).errors({
|
|
1575
1938
|
NOT_FOUND: {},
|
|
1576
|
-
BAD_REQUEST: {},
|
|
1577
1939
|
FORBIDDEN: {}
|
|
1578
1940
|
}).input(z.object({
|
|
1579
1941
|
projectId: z.string().describe("The ID of the project"),
|
|
1580
1942
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1581
1943
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1582
1944
|
})).output(projectOutputSchema);
|
|
1583
|
-
const deployEnvironmentContractV1 =
|
|
1945
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1584
1946
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1585
1947
|
method: "POST",
|
|
1586
1948
|
summary: "Deploy an environment",
|
|
@@ -1589,29 +1951,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1589
1951
|
successDescription: "The environment has been deployed successfully"
|
|
1590
1952
|
}).errors({
|
|
1591
1953
|
NOT_FOUND: {},
|
|
1592
|
-
BAD_REQUEST: {},
|
|
1593
1954
|
CONFLICT: {}
|
|
1594
1955
|
}).input(z.object({
|
|
1595
1956
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1596
1957
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1597
1958
|
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
1959
|
})).output(deploymentSchema);
|
|
1599
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1960
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1600
1961
|
path: "/v1/deployments/upload",
|
|
1601
1962
|
method: "POST",
|
|
1602
1963
|
summary: "Upload deployment artifacts",
|
|
1603
1964
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1604
1965
|
tags: ["deployments"],
|
|
1605
1966
|
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({
|
|
1967
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1610
1968
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1611
1969
|
token: z.string().describe("Token to identify the source archive"),
|
|
1612
1970
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1613
1971
|
}));
|
|
1614
|
-
const listDeploymentsContractV1 =
|
|
1972
|
+
const listDeploymentsContractV1 = base.route({
|
|
1615
1973
|
path: "/v1/projects/{projectId}/deployments",
|
|
1616
1974
|
method: "GET",
|
|
1617
1975
|
summary: "List project deployments",
|
|
@@ -1623,7 +1981,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1623
1981
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1624
1982
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1625
1983
|
})).output(z.array(deploymentSchema));
|
|
1626
|
-
const getDeploymentContractV1 =
|
|
1984
|
+
const getDeploymentContractV1 = base.route({
|
|
1627
1985
|
path: "/v1/deployments/{deploymentId}",
|
|
1628
1986
|
method: "GET",
|
|
1629
1987
|
summary: "Get a deployment",
|
|
@@ -1646,20 +2004,17 @@ const logEntrySchema = z.object({
|
|
|
1646
2004
|
method: z.string().optional(),
|
|
1647
2005
|
durationInMs: z.number().optional()
|
|
1648
2006
|
});
|
|
1649
|
-
const getLogsContractV1 =
|
|
2007
|
+
const getLogsContractV1 = base.route({
|
|
1650
2008
|
path: "/v1/environments/{environmentId}/logs",
|
|
1651
2009
|
method: "GET",
|
|
1652
2010
|
summary: "Get logs",
|
|
1653
2011
|
description: "Get logs for an environment",
|
|
1654
2012
|
tags: ["environments"],
|
|
1655
2013
|
successDescription: "The logs"
|
|
1656
|
-
}).errors({
|
|
1657
|
-
NOT_FOUND: {},
|
|
1658
|
-
BAD_REQUEST: {}
|
|
1659
|
-
}).input(z.object({
|
|
2014
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1660
2015
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1661
|
-
since:
|
|
1662
|
-
until:
|
|
2016
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2017
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1663
2018
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1664
2019
|
level: z.array(z.enum([
|
|
1665
2020
|
"INFO",
|
|
@@ -1673,17 +2028,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1673
2028
|
logs: z.array(logEntrySchema),
|
|
1674
2029
|
nextToken: z.string().nullable()
|
|
1675
2030
|
}));
|
|
1676
|
-
const getLatestLogsContractV1 =
|
|
2031
|
+
const getLatestLogsContractV1 = base.route({
|
|
1677
2032
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1678
2033
|
method: "GET",
|
|
1679
2034
|
summary: "Get latest logs",
|
|
1680
2035
|
description: "Get the N most recent logs for an environment",
|
|
1681
2036
|
tags: ["environments"],
|
|
1682
2037
|
successDescription: "The latest logs"
|
|
1683
|
-
}).errors({
|
|
1684
|
-
NOT_FOUND: {},
|
|
1685
|
-
BAD_REQUEST: {}
|
|
1686
|
-
}).input(z.object({
|
|
2038
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1687
2039
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1688
2040
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1689
2041
|
level: z.array(z.enum([
|
|
@@ -1694,7 +2046,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1694
2046
|
])).optional().describe("Filter by log level"),
|
|
1695
2047
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1696
2048
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1697
|
-
const getDeploymentLogsContractV1 =
|
|
2049
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1698
2050
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1699
2051
|
method: "GET",
|
|
1700
2052
|
summary: "Get deployment logs",
|
|
@@ -1721,22 +2073,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1721
2073
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1722
2074
|
task_count: z.array(analyticsDataPointSchema)
|
|
1723
2075
|
});
|
|
1724
|
-
const getProjectAnalyticsContractV1 =
|
|
2076
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1725
2077
|
path: "/v1/analytics/{projectId}",
|
|
1726
2078
|
method: "GET",
|
|
1727
2079
|
summary: "Get project analytics",
|
|
1728
2080
|
description: "Get analytics data for a project over a time range",
|
|
1729
2081
|
tags: ["analytics"],
|
|
1730
2082
|
successDescription: "The project analytics data"
|
|
1731
|
-
}).errors({
|
|
1732
|
-
NOT_FOUND: {},
|
|
1733
|
-
BAD_REQUEST: {}
|
|
1734
|
-
}).input(z.object({
|
|
2083
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1735
2084
|
projectId: z.string().describe("The ID of the project"),
|
|
1736
2085
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1737
2086
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1738
2087
|
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 <=
|
|
2088
|
+
}).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 }) => isValidIanaTimeZone(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1740
2089
|
metadata: z.object({
|
|
1741
2090
|
startTimestamp: z.number(),
|
|
1742
2091
|
endTimestamp: z.number(),
|
|
@@ -1746,7 +2095,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1746
2095
|
}),
|
|
1747
2096
|
timeSeries: analyticsTimeSeriesSchema
|
|
1748
2097
|
}));
|
|
1749
|
-
const
|
|
2098
|
+
const paginatedInsightsInputShape = {
|
|
2099
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2100
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2101
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2102
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2103
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2104
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2105
|
+
};
|
|
2106
|
+
const listIntentsContractV1 = base.route({
|
|
2107
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2108
|
+
method: "GET",
|
|
2109
|
+
summary: "List intents",
|
|
2110
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2111
|
+
tags: ["insights"],
|
|
2112
|
+
successDescription: "The grouped user intents"
|
|
2113
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2114
|
+
...paginatedInsightsInputShape,
|
|
2115
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2116
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2117
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2118
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2119
|
+
})).output(z.object({
|
|
2120
|
+
intents: z.array(z.object({
|
|
2121
|
+
id: z.string(),
|
|
2122
|
+
intentIds: z.array(z.string()).min(1),
|
|
2123
|
+
environmentId: z.string(),
|
|
2124
|
+
message: z.string(),
|
|
2125
|
+
toolName: z.string(),
|
|
2126
|
+
createdAt: z.coerce.date(),
|
|
2127
|
+
occurrenceCount: z.number().int().positive(),
|
|
2128
|
+
clientName: z.string().nullable(),
|
|
2129
|
+
clientId: z.string().nullable(),
|
|
2130
|
+
categories: z.array(z.object({
|
|
2131
|
+
id: z.string(),
|
|
2132
|
+
name: z.string(),
|
|
2133
|
+
color: intentCategoryColorSchema
|
|
2134
|
+
}))
|
|
2135
|
+
})),
|
|
2136
|
+
totalCount: z.number().int().nonnegative()
|
|
2137
|
+
}));
|
|
2138
|
+
const listFeedbacksContractV1 = base.route({
|
|
2139
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2140
|
+
method: "GET",
|
|
2141
|
+
summary: "List feedbacks",
|
|
2142
|
+
description: "List user feedback for an environment over a time range",
|
|
2143
|
+
tags: ["insights"],
|
|
2144
|
+
successDescription: "The user feedback"
|
|
2145
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2146
|
+
...paginatedInsightsInputShape,
|
|
2147
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2148
|
+
})).output(z.object({
|
|
2149
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2150
|
+
totalCount: z.number().int().nonnegative()
|
|
2151
|
+
}));
|
|
2152
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2153
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2154
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2155
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2156
|
+
method: "GET",
|
|
2157
|
+
summary: "List intent categories",
|
|
2158
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2159
|
+
tags: ["insights"],
|
|
2160
|
+
successDescription: "The intent categories"
|
|
2161
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2162
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2163
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2164
|
+
method: "POST",
|
|
2165
|
+
summary: "Create an intent category",
|
|
2166
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2167
|
+
tags: ["insights"],
|
|
2168
|
+
successDescription: "The created intent category"
|
|
2169
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2170
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2171
|
+
name: intentCategoryNameSchema,
|
|
2172
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2173
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2174
|
+
})).output(intentCategorySchema);
|
|
2175
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2176
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2177
|
+
method: "PATCH",
|
|
2178
|
+
summary: "Update an intent category",
|
|
2179
|
+
description: "Rename or recolor an intent category",
|
|
2180
|
+
tags: ["insights"],
|
|
2181
|
+
successDescription: "The updated intent category"
|
|
2182
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2183
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2184
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2185
|
+
name: intentCategoryNameSchema.optional(),
|
|
2186
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2187
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2188
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2189
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2190
|
+
method: "DELETE",
|
|
2191
|
+
summary: "Delete an intent category",
|
|
2192
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2193
|
+
tags: ["insights"],
|
|
2194
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2195
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2196
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2197
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2198
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2199
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2200
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2201
|
+
method: "POST",
|
|
2202
|
+
summary: "Link an intent category",
|
|
2203
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2204
|
+
tags: ["insights"],
|
|
2205
|
+
successDescription: "The intents have been linked successfully"
|
|
2206
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2207
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2208
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2209
|
+
intentIds: categorizableIntentIdsSchema
|
|
2210
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2211
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2212
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2213
|
+
method: "POST",
|
|
2214
|
+
summary: "Unlink an intent category",
|
|
2215
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2216
|
+
tags: ["insights"],
|
|
2217
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2218
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2219
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2220
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2221
|
+
intentIds: categorizableIntentIdsSchema
|
|
2222
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2223
|
+
const listTeamsContractV1 = base.route({
|
|
1750
2224
|
path: "/v1/teams",
|
|
1751
2225
|
method: "GET",
|
|
1752
2226
|
summary: "List teams",
|
|
@@ -1759,7 +2233,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1759
2233
|
createdAt: z.coerce.date(),
|
|
1760
2234
|
hasStripeAccount: z.boolean()
|
|
1761
2235
|
})));
|
|
1762
|
-
const
|
|
2236
|
+
const getTeamUsageContractV1 = base.route({
|
|
2237
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2238
|
+
method: "GET",
|
|
2239
|
+
summary: "Get team usage",
|
|
2240
|
+
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.",
|
|
2241
|
+
tags: ["teams"],
|
|
2242
|
+
successDescription: "The current billing window usage"
|
|
2243
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2244
|
+
teamId: z.string(),
|
|
2245
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2246
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2247
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2248
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2249
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2250
|
+
}));
|
|
2251
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1763
2252
|
path: "/v1/tunnels/ticket",
|
|
1764
2253
|
method: "GET",
|
|
1765
2254
|
summary: "Get a tunnel ticket",
|
|
@@ -1771,16 +2260,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1771
2260
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1772
2261
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1773
2262
|
}));
|
|
1774
|
-
const publishServerContractV1 =
|
|
2263
|
+
const publishServerContractV1 = base.route({
|
|
1775
2264
|
path: "/v1/distribution/publish",
|
|
1776
2265
|
method: "POST",
|
|
1777
2266
|
summary: "Publish a server to the MCP registry",
|
|
1778
2267
|
tags: ["distribution"],
|
|
1779
2268
|
successDescription: "The server has been published successfully"
|
|
1780
|
-
}).errors({
|
|
1781
|
-
NOT_FOUND: {},
|
|
1782
|
-
BAD_REQUEST: {}
|
|
1783
|
-
}).input(z.object({
|
|
2269
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1784
2270
|
projectId: z.string(),
|
|
1785
2271
|
domain: z.string(),
|
|
1786
2272
|
title: z.string().min(1).max(100),
|
|
@@ -1789,17 +2275,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1789
2275
|
iconSrc: z.url().max(255).optional(),
|
|
1790
2276
|
dryRun: z.boolean().optional()
|
|
1791
2277
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1792
|
-
const getServerInfoContractV1 =
|
|
2278
|
+
const getServerInfoContractV1 = base.route({
|
|
1793
2279
|
path: "/v1/distribution/get",
|
|
1794
2280
|
method: "GET",
|
|
1795
2281
|
summary: "Get server info",
|
|
1796
2282
|
description: "Get info about a server",
|
|
1797
2283
|
tags: ["distribution"],
|
|
1798
2284
|
successDescription: "The server info"
|
|
1799
|
-
}).errors({
|
|
1800
|
-
NOT_FOUND: {},
|
|
1801
|
-
BAD_REQUEST: {}
|
|
1802
|
-
}).input(z.object({
|
|
2285
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1803
2286
|
projectId: z.string(),
|
|
1804
2287
|
domain: z.string()
|
|
1805
2288
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1818,7 +2301,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1818
2301
|
isPlaygroundEnabled: z.boolean(),
|
|
1819
2302
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1820
2303
|
});
|
|
1821
|
-
const getPlaygroundContractV1 =
|
|
2304
|
+
const getPlaygroundContractV1 = base.route({
|
|
1822
2305
|
path: "/v1/environments/{environmentId}/playground",
|
|
1823
2306
|
method: "GET",
|
|
1824
2307
|
summary: "Get playground configuration",
|
|
@@ -1826,17 +2309,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1826
2309
|
tags: ["environments"],
|
|
1827
2310
|
successDescription: "The playground configuration"
|
|
1828
2311
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1829
|
-
const upsertPlaygroundContractV1 =
|
|
2312
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1830
2313
|
path: "/v1/environments/{environmentId}/playground",
|
|
1831
2314
|
method: "PUT",
|
|
1832
2315
|
summary: "Update playground configuration",
|
|
1833
2316
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1834
2317
|
tags: ["environments"],
|
|
1835
2318
|
successDescription: "The updated playground configuration"
|
|
1836
|
-
}).errors({
|
|
1837
|
-
NOT_FOUND: {},
|
|
1838
|
-
BAD_REQUEST: {}
|
|
1839
|
-
}).input(z.object({
|
|
2319
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1840
2320
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1841
2321
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1842
2322
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1844,7 +2324,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1844
2324
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1845
2325
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1846
2326
|
})).output(playgroundOutputSchema);
|
|
1847
|
-
const createBeaconContractV1 =
|
|
2327
|
+
const createBeaconContractV1 = base.route({
|
|
1848
2328
|
path: "/v1/beacon/audits",
|
|
1849
2329
|
method: "POST",
|
|
1850
2330
|
summary: "Create a beacon audit",
|
|
@@ -1853,7 +2333,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1853
2333
|
successDescription: "The audit has been created"
|
|
1854
2334
|
}).errors({
|
|
1855
2335
|
NOT_FOUND: {},
|
|
1856
|
-
BAD_REQUEST: {},
|
|
1857
2336
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1858
2337
|
}).input(z.object({
|
|
1859
2338
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1861,7 +2340,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1861
2340
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1862
2341
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1863
2342
|
})).output(z.object({ id: z.string() }));
|
|
1864
|
-
const getBeaconContractV1 =
|
|
2343
|
+
const getBeaconContractV1 = base.route({
|
|
1865
2344
|
path: "/v1/beacon/audits/{auditId}",
|
|
1866
2345
|
method: "GET",
|
|
1867
2346
|
summary: "Get a beacon audit",
|
|
@@ -1877,8 +2356,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1877
2356
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1878
2357
|
}));
|
|
1879
2358
|
const contract = {
|
|
1880
|
-
teams: {
|
|
2359
|
+
teams: {
|
|
2360
|
+
list: { v1: listTeamsContractV1 },
|
|
2361
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2362
|
+
},
|
|
1881
2363
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2364
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2365
|
+
intentCategories: {
|
|
2366
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2367
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2368
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2369
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2370
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2371
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2372
|
+
},
|
|
2373
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1882
2374
|
deployments: {
|
|
1883
2375
|
list: { v1: listDeploymentsContractV1 },
|
|
1884
2376
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1888,6 +2380,7 @@ const contract = {
|
|
|
1888
2380
|
environments: {
|
|
1889
2381
|
create: { v1: createEnvironmentContractV1 },
|
|
1890
2382
|
get: { v1: getEnvironmentContractV1 },
|
|
2383
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1891
2384
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1892
2385
|
getLogs: { v1: getLogsContractV1 },
|
|
1893
2386
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1925,4 +2418,4 @@ const contractForDocs = {
|
|
|
1925
2418
|
deployments: deploymentsForDocs
|
|
1926
2419
|
};
|
|
1927
2420
|
//#endregion
|
|
1928
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2421
|
+
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 };
|