@alpic-ai/api 0.0.0-dev.gecb758d → 0.0.0-dev.gecc2a6b
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 +1522 -58
- package/dist/index.mjs +486 -149
- 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({
|
|
@@ -533,6 +529,246 @@ z.enum([
|
|
|
533
529
|
"DEBUG",
|
|
534
530
|
"ERROR"
|
|
535
531
|
]);
|
|
532
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
533
|
+
const MCP_CLIENT_GROUPS = [
|
|
534
|
+
{
|
|
535
|
+
id: "claude_code",
|
|
536
|
+
label: "Claude Code",
|
|
537
|
+
vendor: "anthropic",
|
|
538
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
539
|
+
},
|
|
540
|
+
{
|
|
541
|
+
id: "claude",
|
|
542
|
+
label: "Claude",
|
|
543
|
+
vendor: "anthropic",
|
|
544
|
+
rawNames: [
|
|
545
|
+
"Anthropic/ClaudeAI",
|
|
546
|
+
"claude-ai",
|
|
547
|
+
"claude",
|
|
548
|
+
"Claude",
|
|
549
|
+
"claude-desktop",
|
|
550
|
+
"claude-desktop-3p"
|
|
551
|
+
]
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
id: "claude_mobile",
|
|
555
|
+
label: "Claude mobile",
|
|
556
|
+
vendor: "anthropic",
|
|
557
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
id: "claude_cowork",
|
|
561
|
+
label: "Claude Cowork",
|
|
562
|
+
vendor: "anthropic",
|
|
563
|
+
rawNames: ["Anthropic/Cowork"]
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
id: "claude_toolbox",
|
|
567
|
+
label: "Claude Toolbox",
|
|
568
|
+
vendor: "anthropic",
|
|
569
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
id: "anthropic_api",
|
|
573
|
+
label: "Anthropic API",
|
|
574
|
+
vendor: "anthropic",
|
|
575
|
+
rawNames: ["Anthropic/API"]
|
|
576
|
+
},
|
|
577
|
+
{
|
|
578
|
+
id: "anthropic_connector_refresh",
|
|
579
|
+
label: "Anthropic (connector refresh)",
|
|
580
|
+
vendor: "anthropic",
|
|
581
|
+
rawNames: ["Anthropic"]
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
id: "codex",
|
|
585
|
+
label: "Codex",
|
|
586
|
+
vendor: "openai",
|
|
587
|
+
rawNames: [
|
|
588
|
+
"codex-mcp-client",
|
|
589
|
+
"codex",
|
|
590
|
+
"Codex",
|
|
591
|
+
"codex-cli",
|
|
592
|
+
"openai-mcp (Codex)"
|
|
593
|
+
]
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
id: "chatgpt",
|
|
597
|
+
label: "ChatGPT",
|
|
598
|
+
vendor: "openai",
|
|
599
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
600
|
+
},
|
|
601
|
+
{
|
|
602
|
+
id: "openai_responses_api",
|
|
603
|
+
label: "OpenAI Responses API",
|
|
604
|
+
vendor: "openai",
|
|
605
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
id: "openai_agent_builder",
|
|
609
|
+
label: "OpenAI Agent Builder",
|
|
610
|
+
vendor: "openai",
|
|
611
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
612
|
+
},
|
|
613
|
+
{
|
|
614
|
+
id: "openai_other",
|
|
615
|
+
label: "OpenAI Other",
|
|
616
|
+
vendor: "openai",
|
|
617
|
+
rawNames: ["openai-mcp"]
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
id: "cursor",
|
|
621
|
+
label: "Cursor",
|
|
622
|
+
vendor: "cursor",
|
|
623
|
+
rawNames: [
|
|
624
|
+
"cursor-vscode",
|
|
625
|
+
"Cursor",
|
|
626
|
+
"cursor"
|
|
627
|
+
]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cline",
|
|
631
|
+
label: "Cline",
|
|
632
|
+
vendor: "cline",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"Cline",
|
|
635
|
+
"cline",
|
|
636
|
+
"@cline/core"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "github_copilot",
|
|
641
|
+
label: "GitHub Copilot",
|
|
642
|
+
vendor: "githubCopilot",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Copilot",
|
|
645
|
+
"github-copilot-developer",
|
|
646
|
+
"Copilot MCP Gateway",
|
|
647
|
+
"Xcode/copilot-xcode"
|
|
648
|
+
]
|
|
649
|
+
},
|
|
650
|
+
{
|
|
651
|
+
id: "gemini_cli",
|
|
652
|
+
label: "Gemini CLI",
|
|
653
|
+
vendor: "google",
|
|
654
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
655
|
+
},
|
|
656
|
+
{
|
|
657
|
+
id: "antigravity",
|
|
658
|
+
label: "Antigravity",
|
|
659
|
+
vendor: "google",
|
|
660
|
+
rawNames: ["antigravity-client"]
|
|
661
|
+
},
|
|
662
|
+
{
|
|
663
|
+
id: "gemini",
|
|
664
|
+
label: "Gemini",
|
|
665
|
+
vendor: "google",
|
|
666
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
id: "windsurf",
|
|
670
|
+
label: "Windsurf",
|
|
671
|
+
vendor: "windsurf",
|
|
672
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
673
|
+
},
|
|
674
|
+
{
|
|
675
|
+
id: "mistral",
|
|
676
|
+
label: "Mistral / Le Chat",
|
|
677
|
+
vendor: "mistral",
|
|
678
|
+
rawNames: ["Mistral"],
|
|
679
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
680
|
+
},
|
|
681
|
+
{
|
|
682
|
+
id: "n8n",
|
|
683
|
+
label: "n8n",
|
|
684
|
+
vendor: "n8n",
|
|
685
|
+
rawNames: [
|
|
686
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
687
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
688
|
+
"n8n"
|
|
689
|
+
]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "alpic_playground",
|
|
693
|
+
label: "Alpic Playground",
|
|
694
|
+
vendor: "alpic",
|
|
695
|
+
rawNames: ["alpic-playground", "playground"]
|
|
696
|
+
},
|
|
697
|
+
{
|
|
698
|
+
id: "opencode",
|
|
699
|
+
label: "opencode",
|
|
700
|
+
vendor: "opencode",
|
|
701
|
+
rawNames: ["opencode"]
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
id: "zed",
|
|
705
|
+
label: "Zed",
|
|
706
|
+
vendor: "zed",
|
|
707
|
+
rawNames: ["Zed", "zed"]
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
id: "zapier",
|
|
711
|
+
label: "Zapier",
|
|
712
|
+
vendor: "zapier",
|
|
713
|
+
rawNames: ["Zapier", "zapier"]
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
id: "make",
|
|
717
|
+
label: "Make",
|
|
718
|
+
vendor: "make",
|
|
719
|
+
rawNames: ["Make", "make"]
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
id: "librechat",
|
|
723
|
+
label: "LibreChat",
|
|
724
|
+
vendor: "mcp",
|
|
725
|
+
rawNames: ["LibreChat", "librechat"]
|
|
726
|
+
},
|
|
727
|
+
{
|
|
728
|
+
id: "jan",
|
|
729
|
+
label: "Jan",
|
|
730
|
+
vendor: "mcp",
|
|
731
|
+
rawNames: ["Jan", "jan"]
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
id: "goose",
|
|
735
|
+
label: "goose",
|
|
736
|
+
vendor: "mcp",
|
|
737
|
+
rawNames: ["goose", "Goose"]
|
|
738
|
+
},
|
|
739
|
+
{
|
|
740
|
+
id: "mcphost",
|
|
741
|
+
label: "mcphost",
|
|
742
|
+
vendor: "mcp",
|
|
743
|
+
rawNames: ["mcphost"]
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
id: "mcporter",
|
|
747
|
+
label: "mcporter",
|
|
748
|
+
vendor: "mcp",
|
|
749
|
+
rawNames: ["mcporter"]
|
|
750
|
+
},
|
|
751
|
+
{
|
|
752
|
+
id: "rmcp",
|
|
753
|
+
label: "rmcp",
|
|
754
|
+
vendor: "mcp",
|
|
755
|
+
rawNames: ["rmcp"]
|
|
756
|
+
},
|
|
757
|
+
{
|
|
758
|
+
id: "unnamed_client",
|
|
759
|
+
label: "Unnamed client",
|
|
760
|
+
vendor: "mcp",
|
|
761
|
+
rawNames: [
|
|
762
|
+
"mcp",
|
|
763
|
+
"unknown",
|
|
764
|
+
""
|
|
765
|
+
]
|
|
766
|
+
}
|
|
767
|
+
];
|
|
768
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
769
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
770
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
771
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
536
772
|
const runtimeSchema = z.enum([
|
|
537
773
|
"python3.13",
|
|
538
774
|
"python3.14",
|
|
@@ -610,15 +846,7 @@ z.object({
|
|
|
610
846
|
serverFields: serverFieldsSchema$1,
|
|
611
847
|
source: z.enum(["registry", "defaults"])
|
|
612
848
|
});
|
|
613
|
-
/**
|
|
614
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
615
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
616
|
-
*
|
|
617
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
618
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
619
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
620
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
621
|
-
*/
|
|
849
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
622
850
|
const clampStringField = (field) => {
|
|
623
851
|
const max = field.maxLength;
|
|
624
852
|
if (max === null) return field;
|
|
@@ -964,11 +1192,7 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
964
1192
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
965
1193
|
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
966
1194
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
967
|
-
/**
|
|
968
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
969
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
970
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
971
|
-
*/
|
|
1195
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
972
1196
|
const chatgptTaglineSchema = z.string().max(30);
|
|
973
1197
|
const chatgptDescriptionSchema = z.string();
|
|
974
1198
|
const chatgptTranslationSchema = z.object({
|
|
@@ -977,10 +1201,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
977
1201
|
description: chatgptDescriptionSchema
|
|
978
1202
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
979
1203
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
980
|
-
/**
|
|
981
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
982
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
983
|
-
*/
|
|
1204
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
984
1205
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
985
1206
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
986
1207
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
@@ -1077,11 +1298,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1077
1298
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1078
1299
|
"Public documentation for this connector will be live by the publish date."
|
|
1079
1300
|
]);
|
|
1080
|
-
/**
|
|
1081
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1082
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1083
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1084
|
-
*/
|
|
1301
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1085
1302
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1086
1303
|
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1087
1304
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1173,12 +1390,7 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1173
1390
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1174
1391
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1175
1392
|
});
|
|
1176
|
-
/**
|
|
1177
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1178
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1179
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1180
|
-
* colocated with the Claude contract.
|
|
1181
|
-
*/
|
|
1393
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1182
1394
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1183
1395
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1184
1396
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
@@ -1206,6 +1418,11 @@ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
|
1206
1418
|
});
|
|
1207
1419
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1208
1420
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1421
|
+
z.literal([
|
|
1422
|
+
100,
|
|
1423
|
+
75,
|
|
1424
|
+
50
|
|
1425
|
+
]);
|
|
1209
1426
|
const subscriptionPlanSchema = z.enum([
|
|
1210
1427
|
"pro",
|
|
1211
1428
|
"business",
|
|
@@ -1354,21 +1571,20 @@ const deploymentSchema = z.object({
|
|
|
1354
1571
|
isCurrent: z.boolean(),
|
|
1355
1572
|
deploymentPageUrl: z.url().nullable()
|
|
1356
1573
|
});
|
|
1357
|
-
const
|
|
1574
|
+
const isValidTimeInput = (value) => {
|
|
1358
1575
|
if (ms(value) !== void 0) return true;
|
|
1359
1576
|
return !Number.isNaN(new Date(value).getTime());
|
|
1360
1577
|
};
|
|
1361
|
-
const
|
|
1578
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1579
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1580
|
+
const createEnvironmentContractV1 = base.route({
|
|
1362
1581
|
path: "/v1/environments",
|
|
1363
1582
|
method: "POST",
|
|
1364
1583
|
summary: "Create an environment",
|
|
1365
1584
|
description: "Create an environment for a project",
|
|
1366
1585
|
tags: ["environments"],
|
|
1367
1586
|
successDescription: "The environment has been created successfully"
|
|
1368
|
-
}).errors({
|
|
1369
|
-
NOT_FOUND: {},
|
|
1370
|
-
BAD_REQUEST: {}
|
|
1371
|
-
}).input(z.object({
|
|
1587
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1372
1588
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1373
1589
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1374
1590
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1381,7 +1597,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1381
1597
|
createdAt: z.coerce.date(),
|
|
1382
1598
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1383
1599
|
}));
|
|
1384
|
-
const getEnvironmentContractV1 =
|
|
1600
|
+
const getEnvironmentContractV1 = base.route({
|
|
1385
1601
|
path: "/v1/environments/{environmentId}",
|
|
1386
1602
|
method: "GET",
|
|
1387
1603
|
summary: "Get an environment",
|
|
@@ -1438,7 +1654,7 @@ const projectOutputSchema = z.object({
|
|
|
1438
1654
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1439
1655
|
environments: z.array(environmentSchema)
|
|
1440
1656
|
});
|
|
1441
|
-
const getProjectContractV1 =
|
|
1657
|
+
const getProjectContractV1 = base.route({
|
|
1442
1658
|
path: "/v1/projects/{projectId}",
|
|
1443
1659
|
method: "GET",
|
|
1444
1660
|
summary: "Get a project",
|
|
@@ -1446,18 +1662,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1446
1662
|
tags: ["projects"],
|
|
1447
1663
|
successDescription: "The project details"
|
|
1448
1664
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1449
|
-
const listProjectsContractV1 =
|
|
1665
|
+
const listProjectsContractV1 = base.route({
|
|
1450
1666
|
path: "/v1/projects",
|
|
1451
1667
|
method: "GET",
|
|
1452
1668
|
summary: "List projects",
|
|
1453
1669
|
description: "List all projects for a team",
|
|
1454
1670
|
tags: ["projects"],
|
|
1455
1671
|
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({
|
|
1672
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1673
|
+
const createProjectContractV1 = base.route({
|
|
1461
1674
|
path: "/v1/projects",
|
|
1462
1675
|
method: "POST",
|
|
1463
1676
|
summary: "Create a project",
|
|
@@ -1466,7 +1679,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1466
1679
|
successDescription: "The project has been created successfully"
|
|
1467
1680
|
}).errors({
|
|
1468
1681
|
NOT_FOUND: {},
|
|
1469
|
-
BAD_REQUEST: {},
|
|
1470
1682
|
FORBIDDEN: {}
|
|
1471
1683
|
}).input(z.object({
|
|
1472
1684
|
teamId: z.string().optional(),
|
|
@@ -1507,7 +1719,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1507
1719
|
isSecret: z.boolean(),
|
|
1508
1720
|
createdAt: z.coerce.date()
|
|
1509
1721
|
});
|
|
1510
|
-
const listEnvironmentVariablesContractV1 =
|
|
1722
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1511
1723
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1512
1724
|
method: "GET",
|
|
1513
1725
|
summary: "List environment variables",
|
|
@@ -1515,48 +1727,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1515
1727
|
tags: ["environments"],
|
|
1516
1728
|
successDescription: "The list of environment variables"
|
|
1517
1729
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1518
|
-
const createEnvironmentVariablesContractV1 =
|
|
1730
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1519
1731
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1520
1732
|
method: "POST",
|
|
1521
1733
|
summary: "Add environment variables",
|
|
1522
1734
|
description: "Add one or more environment variables to an environment",
|
|
1523
1735
|
tags: ["environments"],
|
|
1524
1736
|
successDescription: "The environment variables have been added successfully"
|
|
1525
|
-
}).errors({
|
|
1526
|
-
NOT_FOUND: {},
|
|
1527
|
-
BAD_REQUEST: {}
|
|
1528
|
-
}).input(z.object({
|
|
1737
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1529
1738
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1530
1739
|
environmentVariables: environmentVariablesSchema
|
|
1531
1740
|
})).output(z.object({ success: z.literal(true) }));
|
|
1532
|
-
const updateEnvironmentVariableContractV1 =
|
|
1741
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1533
1742
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1534
1743
|
method: "PATCH",
|
|
1535
1744
|
summary: "Update an environment variable",
|
|
1536
1745
|
description: "Update an environment variable by ID",
|
|
1537
1746
|
tags: ["environments"],
|
|
1538
1747
|
successDescription: "The environment variable has been updated successfully"
|
|
1539
|
-
}).errors({
|
|
1540
|
-
NOT_FOUND: {},
|
|
1541
|
-
BAD_REQUEST: {}
|
|
1542
|
-
}).input(z.object({
|
|
1748
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1543
1749
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1544
1750
|
key: environmentVariableSchema.shape.key,
|
|
1545
1751
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1546
1752
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1547
1753
|
})).output(z.object({ success: z.literal(true) }));
|
|
1548
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1754
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1549
1755
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1550
1756
|
method: "DELETE",
|
|
1551
1757
|
summary: "Delete an environment variable",
|
|
1552
1758
|
description: "Delete an environment variable by ID",
|
|
1553
1759
|
tags: ["environments"],
|
|
1554
1760
|
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({
|
|
1761
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1762
|
+
const deleteProjectContractV1 = base.route({
|
|
1560
1763
|
path: "/v1/projects/{projectId}",
|
|
1561
1764
|
method: "DELETE",
|
|
1562
1765
|
summary: "Delete a project",
|
|
@@ -1564,7 +1767,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1564
1767
|
tags: ["projects"],
|
|
1565
1768
|
successDescription: "The project has been deleted successfully"
|
|
1566
1769
|
}).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 =
|
|
1770
|
+
const updateProjectContractV1 = base.route({
|
|
1568
1771
|
path: "/v1/projects/{projectId}",
|
|
1569
1772
|
method: "PATCH",
|
|
1570
1773
|
summary: "Update a project",
|
|
@@ -1573,14 +1776,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1573
1776
|
successDescription: "The project has been updated successfully"
|
|
1574
1777
|
}).errors({
|
|
1575
1778
|
NOT_FOUND: {},
|
|
1576
|
-
BAD_REQUEST: {},
|
|
1577
1779
|
FORBIDDEN: {}
|
|
1578
1780
|
}).input(z.object({
|
|
1579
1781
|
projectId: z.string().describe("The ID of the project"),
|
|
1580
1782
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1581
1783
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1582
1784
|
})).output(projectOutputSchema);
|
|
1583
|
-
const deployEnvironmentContractV1 =
|
|
1785
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1584
1786
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1585
1787
|
method: "POST",
|
|
1586
1788
|
summary: "Deploy an environment",
|
|
@@ -1589,29 +1791,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1589
1791
|
successDescription: "The environment has been deployed successfully"
|
|
1590
1792
|
}).errors({
|
|
1591
1793
|
NOT_FOUND: {},
|
|
1592
|
-
BAD_REQUEST: {},
|
|
1593
1794
|
CONFLICT: {}
|
|
1594
1795
|
}).input(z.object({
|
|
1595
1796
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1596
1797
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1597
1798
|
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1598
1799
|
})).output(deploymentSchema);
|
|
1599
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1800
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1600
1801
|
path: "/v1/deployments/upload",
|
|
1601
1802
|
method: "POST",
|
|
1602
1803
|
summary: "Upload deployment artifacts",
|
|
1603
1804
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1604
1805
|
tags: ["deployments"],
|
|
1605
1806
|
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({
|
|
1807
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1610
1808
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1611
1809
|
token: z.string().describe("Token to identify the source archive"),
|
|
1612
1810
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1613
1811
|
}));
|
|
1614
|
-
const listDeploymentsContractV1 =
|
|
1812
|
+
const listDeploymentsContractV1 = base.route({
|
|
1615
1813
|
path: "/v1/projects/{projectId}/deployments",
|
|
1616
1814
|
method: "GET",
|
|
1617
1815
|
summary: "List project deployments",
|
|
@@ -1623,7 +1821,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1623
1821
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1624
1822
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1625
1823
|
})).output(z.array(deploymentSchema));
|
|
1626
|
-
const getDeploymentContractV1 =
|
|
1824
|
+
const getDeploymentContractV1 = base.route({
|
|
1627
1825
|
path: "/v1/deployments/{deploymentId}",
|
|
1628
1826
|
method: "GET",
|
|
1629
1827
|
summary: "Get a deployment",
|
|
@@ -1646,20 +1844,17 @@ const logEntrySchema = z.object({
|
|
|
1646
1844
|
method: z.string().optional(),
|
|
1647
1845
|
durationInMs: z.number().optional()
|
|
1648
1846
|
});
|
|
1649
|
-
const getLogsContractV1 =
|
|
1847
|
+
const getLogsContractV1 = base.route({
|
|
1650
1848
|
path: "/v1/environments/{environmentId}/logs",
|
|
1651
1849
|
method: "GET",
|
|
1652
1850
|
summary: "Get logs",
|
|
1653
1851
|
description: "Get logs for an environment",
|
|
1654
1852
|
tags: ["environments"],
|
|
1655
1853
|
successDescription: "The logs"
|
|
1656
|
-
}).errors({
|
|
1657
|
-
NOT_FOUND: {},
|
|
1658
|
-
BAD_REQUEST: {}
|
|
1659
|
-
}).input(z.object({
|
|
1854
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1660
1855
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1661
|
-
since:
|
|
1662
|
-
until:
|
|
1856
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1857
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1663
1858
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1664
1859
|
level: z.array(z.enum([
|
|
1665
1860
|
"INFO",
|
|
@@ -1673,17 +1868,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1673
1868
|
logs: z.array(logEntrySchema),
|
|
1674
1869
|
nextToken: z.string().nullable()
|
|
1675
1870
|
}));
|
|
1676
|
-
const getLatestLogsContractV1 =
|
|
1871
|
+
const getLatestLogsContractV1 = base.route({
|
|
1677
1872
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1678
1873
|
method: "GET",
|
|
1679
1874
|
summary: "Get latest logs",
|
|
1680
1875
|
description: "Get the N most recent logs for an environment",
|
|
1681
1876
|
tags: ["environments"],
|
|
1682
1877
|
successDescription: "The latest logs"
|
|
1683
|
-
}).errors({
|
|
1684
|
-
NOT_FOUND: {},
|
|
1685
|
-
BAD_REQUEST: {}
|
|
1686
|
-
}).input(z.object({
|
|
1878
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1687
1879
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1688
1880
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1689
1881
|
level: z.array(z.enum([
|
|
@@ -1694,7 +1886,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1694
1886
|
])).optional().describe("Filter by log level"),
|
|
1695
1887
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1696
1888
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1697
|
-
const getDeploymentLogsContractV1 =
|
|
1889
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1698
1890
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1699
1891
|
method: "GET",
|
|
1700
1892
|
summary: "Get deployment logs",
|
|
@@ -1721,17 +1913,14 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1721
1913
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1722
1914
|
task_count: z.array(analyticsDataPointSchema)
|
|
1723
1915
|
});
|
|
1724
|
-
const getProjectAnalyticsContractV1 =
|
|
1916
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1725
1917
|
path: "/v1/analytics/{projectId}",
|
|
1726
1918
|
method: "GET",
|
|
1727
1919
|
summary: "Get project analytics",
|
|
1728
1920
|
description: "Get analytics data for a project over a time range",
|
|
1729
1921
|
tags: ["analytics"],
|
|
1730
1922
|
successDescription: "The project analytics data"
|
|
1731
|
-
}).errors({
|
|
1732
|
-
NOT_FOUND: {},
|
|
1733
|
-
BAD_REQUEST: {}
|
|
1734
|
-
}).input(z.object({
|
|
1923
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1735
1924
|
projectId: z.string().describe("The ID of the project"),
|
|
1736
1925
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1737
1926
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
@@ -1746,7 +1935,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1746
1935
|
}),
|
|
1747
1936
|
timeSeries: analyticsTimeSeriesSchema
|
|
1748
1937
|
}));
|
|
1749
|
-
const
|
|
1938
|
+
const paginatedInsightsInputShape = {
|
|
1939
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1940
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1941
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1942
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1943
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1944
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1945
|
+
};
|
|
1946
|
+
const listIntentsContractV1 = base.route({
|
|
1947
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1948
|
+
method: "GET",
|
|
1949
|
+
summary: "List intents",
|
|
1950
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1951
|
+
tags: ["insights"],
|
|
1952
|
+
successDescription: "The grouped user intents"
|
|
1953
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1954
|
+
...paginatedInsightsInputShape,
|
|
1955
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1956
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
1957
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1958
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
1959
|
+
})).output(z.object({
|
|
1960
|
+
intents: z.array(z.object({
|
|
1961
|
+
id: z.string(),
|
|
1962
|
+
intentIds: z.array(z.string()).min(1),
|
|
1963
|
+
environmentId: z.string(),
|
|
1964
|
+
message: z.string(),
|
|
1965
|
+
toolName: z.string(),
|
|
1966
|
+
createdAt: z.coerce.date(),
|
|
1967
|
+
occurrenceCount: z.number().int().positive(),
|
|
1968
|
+
clientName: z.string().nullable(),
|
|
1969
|
+
clientId: z.string().nullable(),
|
|
1970
|
+
categories: z.array(z.object({
|
|
1971
|
+
id: z.string(),
|
|
1972
|
+
name: z.string(),
|
|
1973
|
+
color: intentCategoryColorSchema
|
|
1974
|
+
}))
|
|
1975
|
+
})),
|
|
1976
|
+
totalCount: z.number().int().nonnegative()
|
|
1977
|
+
}));
|
|
1978
|
+
const listFeedbacksContractV1 = base.route({
|
|
1979
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
1980
|
+
method: "GET",
|
|
1981
|
+
summary: "List feedbacks",
|
|
1982
|
+
description: "List user feedback for an environment over a time range",
|
|
1983
|
+
tags: ["insights"],
|
|
1984
|
+
successDescription: "The user feedback"
|
|
1985
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1986
|
+
...paginatedInsightsInputShape,
|
|
1987
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
1988
|
+
})).output(z.object({
|
|
1989
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
1990
|
+
totalCount: z.number().int().nonnegative()
|
|
1991
|
+
}));
|
|
1992
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
1993
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
1994
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
1995
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
1996
|
+
method: "GET",
|
|
1997
|
+
summary: "List intent categories",
|
|
1998
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
1999
|
+
tags: ["insights"],
|
|
2000
|
+
successDescription: "The intent categories"
|
|
2001
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2002
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2003
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2004
|
+
method: "POST",
|
|
2005
|
+
summary: "Create an intent category",
|
|
2006
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2007
|
+
tags: ["insights"],
|
|
2008
|
+
successDescription: "The created intent category"
|
|
2009
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2010
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2011
|
+
name: intentCategoryNameSchema,
|
|
2012
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2013
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2014
|
+
})).output(intentCategorySchema);
|
|
2015
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2016
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2017
|
+
method: "PATCH",
|
|
2018
|
+
summary: "Update an intent category",
|
|
2019
|
+
description: "Rename or recolor an intent category",
|
|
2020
|
+
tags: ["insights"],
|
|
2021
|
+
successDescription: "The updated intent category"
|
|
2022
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2023
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2024
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2025
|
+
name: intentCategoryNameSchema.optional(),
|
|
2026
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2027
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2028
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2029
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2030
|
+
method: "DELETE",
|
|
2031
|
+
summary: "Delete an intent category",
|
|
2032
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2033
|
+
tags: ["insights"],
|
|
2034
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2035
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2036
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2037
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2038
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2039
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2040
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2041
|
+
method: "POST",
|
|
2042
|
+
summary: "Link an intent category",
|
|
2043
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2044
|
+
tags: ["insights"],
|
|
2045
|
+
successDescription: "The intents have been linked successfully"
|
|
2046
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2047
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2048
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2049
|
+
intentIds: categorizableIntentIdsSchema
|
|
2050
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2051
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2052
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2053
|
+
method: "POST",
|
|
2054
|
+
summary: "Unlink an intent category",
|
|
2055
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2056
|
+
tags: ["insights"],
|
|
2057
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2058
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2059
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2060
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2061
|
+
intentIds: categorizableIntentIdsSchema
|
|
2062
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2063
|
+
const listTeamsContractV1 = base.route({
|
|
1750
2064
|
path: "/v1/teams",
|
|
1751
2065
|
method: "GET",
|
|
1752
2066
|
summary: "List teams",
|
|
@@ -1759,7 +2073,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1759
2073
|
createdAt: z.coerce.date(),
|
|
1760
2074
|
hasStripeAccount: z.boolean()
|
|
1761
2075
|
})));
|
|
1762
|
-
const
|
|
2076
|
+
const getTeamUsageContractV1 = base.route({
|
|
2077
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2078
|
+
method: "GET",
|
|
2079
|
+
summary: "Get team usage",
|
|
2080
|
+
description: "Get the MCP request usage of a team for its current billing window. A team that has made no request in the window reports zero.",
|
|
2081
|
+
tags: ["teams"],
|
|
2082
|
+
successDescription: "The current billing window usage"
|
|
2083
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2084
|
+
teamId: z.string(),
|
|
2085
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2086
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2087
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2088
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2089
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2090
|
+
}));
|
|
2091
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1763
2092
|
path: "/v1/tunnels/ticket",
|
|
1764
2093
|
method: "GET",
|
|
1765
2094
|
summary: "Get a tunnel ticket",
|
|
@@ -1771,16 +2100,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1771
2100
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1772
2101
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1773
2102
|
}));
|
|
1774
|
-
const publishServerContractV1 =
|
|
2103
|
+
const publishServerContractV1 = base.route({
|
|
1775
2104
|
path: "/v1/distribution/publish",
|
|
1776
2105
|
method: "POST",
|
|
1777
2106
|
summary: "Publish a server to the MCP registry",
|
|
1778
2107
|
tags: ["distribution"],
|
|
1779
2108
|
successDescription: "The server has been published successfully"
|
|
1780
|
-
}).errors({
|
|
1781
|
-
NOT_FOUND: {},
|
|
1782
|
-
BAD_REQUEST: {}
|
|
1783
|
-
}).input(z.object({
|
|
2109
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1784
2110
|
projectId: z.string(),
|
|
1785
2111
|
domain: z.string(),
|
|
1786
2112
|
title: z.string().min(1).max(100),
|
|
@@ -1789,17 +2115,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1789
2115
|
iconSrc: z.url().max(255).optional(),
|
|
1790
2116
|
dryRun: z.boolean().optional()
|
|
1791
2117
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1792
|
-
const getServerInfoContractV1 =
|
|
2118
|
+
const getServerInfoContractV1 = base.route({
|
|
1793
2119
|
path: "/v1/distribution/get",
|
|
1794
2120
|
method: "GET",
|
|
1795
2121
|
summary: "Get server info",
|
|
1796
2122
|
description: "Get info about a server",
|
|
1797
2123
|
tags: ["distribution"],
|
|
1798
2124
|
successDescription: "The server info"
|
|
1799
|
-
}).errors({
|
|
1800
|
-
NOT_FOUND: {},
|
|
1801
|
-
BAD_REQUEST: {}
|
|
1802
|
-
}).input(z.object({
|
|
2125
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1803
2126
|
projectId: z.string(),
|
|
1804
2127
|
domain: z.string()
|
|
1805
2128
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1818,7 +2141,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1818
2141
|
isPlaygroundEnabled: z.boolean(),
|
|
1819
2142
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1820
2143
|
});
|
|
1821
|
-
const getPlaygroundContractV1 =
|
|
2144
|
+
const getPlaygroundContractV1 = base.route({
|
|
1822
2145
|
path: "/v1/environments/{environmentId}/playground",
|
|
1823
2146
|
method: "GET",
|
|
1824
2147
|
summary: "Get playground configuration",
|
|
@@ -1826,17 +2149,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1826
2149
|
tags: ["environments"],
|
|
1827
2150
|
successDescription: "The playground configuration"
|
|
1828
2151
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1829
|
-
const upsertPlaygroundContractV1 =
|
|
2152
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1830
2153
|
path: "/v1/environments/{environmentId}/playground",
|
|
1831
2154
|
method: "PUT",
|
|
1832
2155
|
summary: "Update playground configuration",
|
|
1833
2156
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1834
2157
|
tags: ["environments"],
|
|
1835
2158
|
successDescription: "The updated playground configuration"
|
|
1836
|
-
}).errors({
|
|
1837
|
-
NOT_FOUND: {},
|
|
1838
|
-
BAD_REQUEST: {}
|
|
1839
|
-
}).input(z.object({
|
|
2159
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1840
2160
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1841
2161
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1842
2162
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1844,7 +2164,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1844
2164
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1845
2165
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1846
2166
|
})).output(playgroundOutputSchema);
|
|
1847
|
-
const createBeaconContractV1 =
|
|
2167
|
+
const createBeaconContractV1 = base.route({
|
|
1848
2168
|
path: "/v1/beacon/audits",
|
|
1849
2169
|
method: "POST",
|
|
1850
2170
|
summary: "Create a beacon audit",
|
|
@@ -1853,7 +2173,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1853
2173
|
successDescription: "The audit has been created"
|
|
1854
2174
|
}).errors({
|
|
1855
2175
|
NOT_FOUND: {},
|
|
1856
|
-
BAD_REQUEST: {},
|
|
1857
2176
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1858
2177
|
}).input(z.object({
|
|
1859
2178
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1861,7 +2180,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1861
2180
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1862
2181
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1863
2182
|
})).output(z.object({ id: z.string() }));
|
|
1864
|
-
const getBeaconContractV1 =
|
|
2183
|
+
const getBeaconContractV1 = base.route({
|
|
1865
2184
|
path: "/v1/beacon/audits/{auditId}",
|
|
1866
2185
|
method: "GET",
|
|
1867
2186
|
summary: "Get a beacon audit",
|
|
@@ -1877,8 +2196,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1877
2196
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1878
2197
|
}));
|
|
1879
2198
|
const contract = {
|
|
1880
|
-
teams: {
|
|
2199
|
+
teams: {
|
|
2200
|
+
list: { v1: listTeamsContractV1 },
|
|
2201
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2202
|
+
},
|
|
1881
2203
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2204
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2205
|
+
intentCategories: {
|
|
2206
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2207
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2208
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2209
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2210
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2211
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2212
|
+
},
|
|
2213
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1882
2214
|
deployments: {
|
|
1883
2215
|
list: { v1: listDeploymentsContractV1 },
|
|
1884
2216
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1919,5 +2251,10 @@ const contract = {
|
|
|
1919
2251
|
get: { v1: getBeaconContractV1 }
|
|
1920
2252
|
}
|
|
1921
2253
|
};
|
|
2254
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2255
|
+
const contractForDocs = {
|
|
2256
|
+
...contract,
|
|
2257
|
+
deployments: deploymentsForDocs
|
|
2258
|
+
};
|
|
1922
2259
|
//#endregion
|
|
1923
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2260
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|