@alpic-ai/api 0.0.0-staging.g4df5fa1 → 0.0.0-staging.g4e55c76
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 +1226 -45
- package/dist/index.mjs +410 -151
- package/package.json +6 -6
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
|
*/
|
|
@@ -169,11 +169,21 @@ z$1.object({
|
|
|
169
169
|
token: z$1.string(),
|
|
170
170
|
token_type_hint: z$1.string().optional()
|
|
171
171
|
}).strip();
|
|
172
|
-
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
173
176
|
const PLATFORM_LABELS = {
|
|
174
177
|
chatgpt: "ChatGPT",
|
|
175
178
|
claudeai: "Claude.ai"
|
|
176
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cloudflare",
|
|
183
|
+
"fastly"
|
|
184
|
+
];
|
|
185
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
186
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
187
|
const auditStatusSchema = z.enum([
|
|
178
188
|
"pending",
|
|
179
189
|
"partial",
|
|
@@ -273,33 +283,18 @@ const deploymentSummarySchema = z.object({
|
|
|
273
283
|
createdAt: z.coerce.date(),
|
|
274
284
|
updatedAt: z.coerce.date()
|
|
275
285
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* Answers anonymously and exposes no OAuth metadata.
|
|
280
|
-
*/
|
|
286
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
287
|
const publicEnvironmentSchema = z.object({
|
|
282
288
|
allowsAnonymous: z.literal(true),
|
|
283
289
|
oAuthMetadata: z.strictObject({})
|
|
284
290
|
});
|
|
285
|
-
/**
|
|
286
|
-
* Protected environment with an external resource metadata URL
|
|
287
|
-
*
|
|
288
|
-
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
289
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
290
|
-
*/
|
|
291
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
291
292
|
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
292
293
|
allowsAnonymous: z.boolean(),
|
|
293
294
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
295
|
scope: z.string().optional()
|
|
295
296
|
});
|
|
296
|
-
/**
|
|
297
|
-
* Protected environment with an external authorization server URL
|
|
298
|
-
*
|
|
299
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
300
|
-
* An external authorization server URL is returned when requesting the endpoint.
|
|
301
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
302
|
-
*/
|
|
297
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
303
298
|
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
299
|
allowsAnonymous: z.boolean(),
|
|
305
300
|
oAuthMetadata: z.object({
|
|
@@ -308,12 +303,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
303
|
}),
|
|
309
304
|
scope: z.string().optional()
|
|
310
305
|
});
|
|
311
|
-
/**
|
|
312
|
-
* Standalone protected environment
|
|
313
|
-
*
|
|
314
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
315
|
-
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
316
|
-
*/
|
|
306
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
317
307
|
const standaloneEnvironmentSchema = z.object({
|
|
318
308
|
allowsAnonymous: z.boolean(),
|
|
319
309
|
oAuthMetadata: z.object({
|
|
@@ -322,13 +312,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
312
|
}),
|
|
323
313
|
scope: z.string().optional()
|
|
324
314
|
});
|
|
325
|
-
/**
|
|
326
|
-
* Protected environment without OAuth discovery
|
|
327
|
-
*
|
|
328
|
-
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
329
|
-
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
330
|
-
* are advertised. Clients must obtain credentials out-of-band.
|
|
331
|
-
*/
|
|
315
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
332
316
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
317
|
allowsAnonymous: z.literal(false),
|
|
334
318
|
oAuthMetadata: z.strictObject({}),
|
|
@@ -376,7 +360,6 @@ z.union([
|
|
|
376
360
|
legacyStandaloneEnvironmentSchema,
|
|
377
361
|
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
378
362
|
]);
|
|
379
|
-
const allowedPlatformSchema = platformSchema;
|
|
380
363
|
const playgroundModelSchema = z.enum([
|
|
381
364
|
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
382
365
|
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
@@ -416,14 +399,16 @@ z.object({
|
|
|
416
399
|
collectRequestPayload: z.boolean(),
|
|
417
400
|
collectResponsePayload: z.boolean(),
|
|
418
401
|
collectErrorMessage: z.boolean(),
|
|
419
|
-
collectUserData: z.boolean()
|
|
402
|
+
collectUserData: z.boolean(),
|
|
403
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
420
404
|
});
|
|
421
|
-
z.object({
|
|
405
|
+
const feedbackSchema = z.object({
|
|
422
406
|
id: z.string(),
|
|
423
407
|
createdAt: z.coerce.date(),
|
|
424
408
|
environmentId: z.string(),
|
|
425
409
|
content: z.string(),
|
|
426
|
-
source: z.enum(["model", "user"])
|
|
410
|
+
source: z.enum(["model", "user"]),
|
|
411
|
+
clientName: z.string().nullable()
|
|
427
412
|
});
|
|
428
413
|
z.object({
|
|
429
414
|
content: z.string(),
|
|
@@ -459,6 +444,7 @@ z.object({
|
|
|
459
444
|
environmentId: z.string(),
|
|
460
445
|
toolName: z.string(),
|
|
461
446
|
message: z.string(),
|
|
447
|
+
clientName: z.string().nullable(),
|
|
462
448
|
categories: z.array(intentCategorySchema)
|
|
463
449
|
});
|
|
464
450
|
const signalCategorySchema = z.object({
|
|
@@ -523,6 +509,246 @@ z.enum([
|
|
|
523
509
|
"DEBUG",
|
|
524
510
|
"ERROR"
|
|
525
511
|
]);
|
|
512
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
513
|
+
const MCP_CLIENT_GROUPS = [
|
|
514
|
+
{
|
|
515
|
+
id: "claude_code",
|
|
516
|
+
label: "Claude Code",
|
|
517
|
+
vendor: "anthropic",
|
|
518
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
519
|
+
},
|
|
520
|
+
{
|
|
521
|
+
id: "claude",
|
|
522
|
+
label: "Claude",
|
|
523
|
+
vendor: "anthropic",
|
|
524
|
+
rawNames: [
|
|
525
|
+
"Anthropic/ClaudeAI",
|
|
526
|
+
"claude-ai",
|
|
527
|
+
"claude",
|
|
528
|
+
"Claude",
|
|
529
|
+
"claude-desktop",
|
|
530
|
+
"claude-desktop-3p"
|
|
531
|
+
]
|
|
532
|
+
},
|
|
533
|
+
{
|
|
534
|
+
id: "claude_mobile",
|
|
535
|
+
label: "Claude mobile",
|
|
536
|
+
vendor: "anthropic",
|
|
537
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
538
|
+
},
|
|
539
|
+
{
|
|
540
|
+
id: "claude_cowork",
|
|
541
|
+
label: "Claude Cowork",
|
|
542
|
+
vendor: "anthropic",
|
|
543
|
+
rawNames: ["Anthropic/Cowork"]
|
|
544
|
+
},
|
|
545
|
+
{
|
|
546
|
+
id: "claude_toolbox",
|
|
547
|
+
label: "Claude Toolbox",
|
|
548
|
+
vendor: "anthropic",
|
|
549
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
id: "anthropic_api",
|
|
553
|
+
label: "Anthropic API",
|
|
554
|
+
vendor: "anthropic",
|
|
555
|
+
rawNames: ["Anthropic/API"]
|
|
556
|
+
},
|
|
557
|
+
{
|
|
558
|
+
id: "anthropic_connector_refresh",
|
|
559
|
+
label: "Anthropic (connector refresh)",
|
|
560
|
+
vendor: "anthropic",
|
|
561
|
+
rawNames: ["Anthropic"]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "codex",
|
|
565
|
+
label: "Codex",
|
|
566
|
+
vendor: "openai",
|
|
567
|
+
rawNames: [
|
|
568
|
+
"codex-mcp-client",
|
|
569
|
+
"codex",
|
|
570
|
+
"Codex",
|
|
571
|
+
"codex-cli",
|
|
572
|
+
"openai-mcp (Codex)"
|
|
573
|
+
]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "chatgpt",
|
|
577
|
+
label: "ChatGPT",
|
|
578
|
+
vendor: "openai",
|
|
579
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "openai_responses_api",
|
|
583
|
+
label: "OpenAI Responses API",
|
|
584
|
+
vendor: "openai",
|
|
585
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "openai_agent_builder",
|
|
589
|
+
label: "OpenAI Agent Builder",
|
|
590
|
+
vendor: "openai",
|
|
591
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "openai_other",
|
|
595
|
+
label: "OpenAI Other",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: ["openai-mcp"]
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
id: "cursor",
|
|
601
|
+
label: "Cursor",
|
|
602
|
+
vendor: "cursor",
|
|
603
|
+
rawNames: [
|
|
604
|
+
"cursor-vscode",
|
|
605
|
+
"Cursor",
|
|
606
|
+
"cursor"
|
|
607
|
+
]
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
id: "cline",
|
|
611
|
+
label: "Cline",
|
|
612
|
+
vendor: "cline",
|
|
613
|
+
rawNames: [
|
|
614
|
+
"Cline",
|
|
615
|
+
"cline",
|
|
616
|
+
"@cline/core"
|
|
617
|
+
]
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
id: "github_copilot",
|
|
621
|
+
label: "GitHub Copilot",
|
|
622
|
+
vendor: "githubCopilot",
|
|
623
|
+
rawNames: [
|
|
624
|
+
"Copilot",
|
|
625
|
+
"github-copilot-developer",
|
|
626
|
+
"Copilot MCP Gateway",
|
|
627
|
+
"Xcode/copilot-xcode"
|
|
628
|
+
]
|
|
629
|
+
},
|
|
630
|
+
{
|
|
631
|
+
id: "gemini_cli",
|
|
632
|
+
label: "Gemini CLI",
|
|
633
|
+
vendor: "google",
|
|
634
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
635
|
+
},
|
|
636
|
+
{
|
|
637
|
+
id: "antigravity",
|
|
638
|
+
label: "Antigravity",
|
|
639
|
+
vendor: "google",
|
|
640
|
+
rawNames: ["antigravity-client"]
|
|
641
|
+
},
|
|
642
|
+
{
|
|
643
|
+
id: "gemini",
|
|
644
|
+
label: "Gemini",
|
|
645
|
+
vendor: "google",
|
|
646
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
id: "windsurf",
|
|
650
|
+
label: "Windsurf",
|
|
651
|
+
vendor: "windsurf",
|
|
652
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
653
|
+
},
|
|
654
|
+
{
|
|
655
|
+
id: "mistral",
|
|
656
|
+
label: "Mistral / Le Chat",
|
|
657
|
+
vendor: "mistral",
|
|
658
|
+
rawNames: ["Mistral"],
|
|
659
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
id: "n8n",
|
|
663
|
+
label: "n8n",
|
|
664
|
+
vendor: "n8n",
|
|
665
|
+
rawNames: [
|
|
666
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
667
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
668
|
+
"n8n"
|
|
669
|
+
]
|
|
670
|
+
},
|
|
671
|
+
{
|
|
672
|
+
id: "alpic_playground",
|
|
673
|
+
label: "Alpic Playground",
|
|
674
|
+
vendor: "alpic",
|
|
675
|
+
rawNames: ["alpic-playground", "playground"]
|
|
676
|
+
},
|
|
677
|
+
{
|
|
678
|
+
id: "opencode",
|
|
679
|
+
label: "opencode",
|
|
680
|
+
vendor: "opencode",
|
|
681
|
+
rawNames: ["opencode"]
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
id: "zed",
|
|
685
|
+
label: "Zed",
|
|
686
|
+
vendor: "zed",
|
|
687
|
+
rawNames: ["Zed", "zed"]
|
|
688
|
+
},
|
|
689
|
+
{
|
|
690
|
+
id: "zapier",
|
|
691
|
+
label: "Zapier",
|
|
692
|
+
vendor: "zapier",
|
|
693
|
+
rawNames: ["Zapier", "zapier"]
|
|
694
|
+
},
|
|
695
|
+
{
|
|
696
|
+
id: "make",
|
|
697
|
+
label: "Make",
|
|
698
|
+
vendor: "make",
|
|
699
|
+
rawNames: ["Make", "make"]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "librechat",
|
|
703
|
+
label: "LibreChat",
|
|
704
|
+
vendor: "mcp",
|
|
705
|
+
rawNames: ["LibreChat", "librechat"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "jan",
|
|
709
|
+
label: "Jan",
|
|
710
|
+
vendor: "mcp",
|
|
711
|
+
rawNames: ["Jan", "jan"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "goose",
|
|
715
|
+
label: "goose",
|
|
716
|
+
vendor: "mcp",
|
|
717
|
+
rawNames: ["goose", "Goose"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "mcphost",
|
|
721
|
+
label: "mcphost",
|
|
722
|
+
vendor: "mcp",
|
|
723
|
+
rawNames: ["mcphost"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "mcporter",
|
|
727
|
+
label: "mcporter",
|
|
728
|
+
vendor: "mcp",
|
|
729
|
+
rawNames: ["mcporter"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "rmcp",
|
|
733
|
+
label: "rmcp",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["rmcp"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "unnamed_client",
|
|
739
|
+
label: "Unnamed client",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: [
|
|
742
|
+
"mcp",
|
|
743
|
+
"unknown",
|
|
744
|
+
""
|
|
745
|
+
]
|
|
746
|
+
}
|
|
747
|
+
];
|
|
748
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
749
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
750
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
751
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
526
752
|
const runtimeSchema = z.enum([
|
|
527
753
|
"python3.13",
|
|
528
754
|
"python3.14",
|
|
@@ -600,15 +826,7 @@ z.object({
|
|
|
600
826
|
serverFields: serverFieldsSchema$1,
|
|
601
827
|
source: z.enum(["registry", "defaults"])
|
|
602
828
|
});
|
|
603
|
-
/**
|
|
604
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
605
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
606
|
-
*
|
|
607
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
608
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
609
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
610
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
611
|
-
*/
|
|
829
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
612
830
|
const clampStringField = (field) => {
|
|
613
831
|
const max = field.maxLength;
|
|
614
832
|
if (max === null) return field;
|
|
@@ -954,11 +1172,7 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
954
1172
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
955
1173
|
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
956
1174
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
957
|
-
/**
|
|
958
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
959
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
960
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
961
|
-
*/
|
|
1175
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
962
1176
|
const chatgptTaglineSchema = z.string().max(30);
|
|
963
1177
|
const chatgptDescriptionSchema = z.string();
|
|
964
1178
|
const chatgptTranslationSchema = z.object({
|
|
@@ -967,10 +1181,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
967
1181
|
description: chatgptDescriptionSchema
|
|
968
1182
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
969
1183
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
970
|
-
/**
|
|
971
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
972
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
973
|
-
*/
|
|
1184
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
974
1185
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
975
1186
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
976
1187
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
@@ -1067,11 +1278,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1067
1278
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1068
1279
|
"Public documentation for this connector will be live by the publish date."
|
|
1069
1280
|
]);
|
|
1070
|
-
/**
|
|
1071
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1072
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1073
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1074
|
-
*/
|
|
1281
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1075
1282
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1076
1283
|
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1077
1284
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1163,12 +1370,7 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1163
1370
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1164
1371
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1165
1372
|
});
|
|
1166
|
-
/**
|
|
1167
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1168
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1169
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1170
|
-
* colocated with the Claude contract.
|
|
1171
|
-
*/
|
|
1373
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1172
1374
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1173
1375
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1174
1376
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
@@ -1196,6 +1398,17 @@ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
|
1196
1398
|
});
|
|
1197
1399
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1198
1400
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1401
|
+
({
|
|
1402
|
+
free: 1e4,
|
|
1403
|
+
pro: 2e5,
|
|
1404
|
+
business: 2e6,
|
|
1405
|
+
enterprise: null
|
|
1406
|
+
}).free;
|
|
1407
|
+
z.literal([
|
|
1408
|
+
100,
|
|
1409
|
+
75,
|
|
1410
|
+
50
|
|
1411
|
+
]);
|
|
1199
1412
|
const subscriptionPlanSchema = z.enum([
|
|
1200
1413
|
"pro",
|
|
1201
1414
|
"business",
|
|
@@ -1213,6 +1426,7 @@ const customerUsageSchema = z.object({
|
|
|
1213
1426
|
periodEnd: z.number()
|
|
1214
1427
|
});
|
|
1215
1428
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1429
|
+
z.object({ balanceInNanoUSD: z.number() });
|
|
1216
1430
|
z.object({
|
|
1217
1431
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1218
1432
|
customerUsage: customerUsageSchema.nullable(),
|
|
@@ -1260,7 +1474,10 @@ const RESERVED_KEYS = [
|
|
|
1260
1474
|
"BUILD_ARG_START_COMMAND",
|
|
1261
1475
|
"ALPIC_HOST",
|
|
1262
1476
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1263
|
-
"ALPIC_INTENT_META_KEY"
|
|
1477
|
+
"ALPIC_INTENT_META_KEY",
|
|
1478
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1479
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1480
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1264
1481
|
];
|
|
1265
1482
|
const environmentVariableSchema = z.object({
|
|
1266
1483
|
key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
|
|
@@ -1341,21 +1558,20 @@ const deploymentSchema = z.object({
|
|
|
1341
1558
|
isCurrent: z.boolean(),
|
|
1342
1559
|
deploymentPageUrl: z.url().nullable()
|
|
1343
1560
|
});
|
|
1344
|
-
const
|
|
1561
|
+
const isValidTimeInput = (value) => {
|
|
1345
1562
|
if (ms(value) !== void 0) return true;
|
|
1346
1563
|
return !Number.isNaN(new Date(value).getTime());
|
|
1347
1564
|
};
|
|
1348
|
-
const
|
|
1565
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1566
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1567
|
+
const createEnvironmentContractV1 = base.route({
|
|
1349
1568
|
path: "/v1/environments",
|
|
1350
1569
|
method: "POST",
|
|
1351
1570
|
summary: "Create an environment",
|
|
1352
1571
|
description: "Create an environment for a project",
|
|
1353
1572
|
tags: ["environments"],
|
|
1354
1573
|
successDescription: "The environment has been created successfully"
|
|
1355
|
-
}).errors({
|
|
1356
|
-
NOT_FOUND: {},
|
|
1357
|
-
BAD_REQUEST: {}
|
|
1358
|
-
}).input(z.object({
|
|
1574
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1359
1575
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1360
1576
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1361
1577
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1368,7 +1584,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1368
1584
|
createdAt: z.coerce.date(),
|
|
1369
1585
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1370
1586
|
}));
|
|
1371
|
-
const getEnvironmentContractV1 =
|
|
1587
|
+
const getEnvironmentContractV1 = base.route({
|
|
1372
1588
|
path: "/v1/environments/{environmentId}",
|
|
1373
1589
|
method: "GET",
|
|
1374
1590
|
summary: "Get an environment",
|
|
@@ -1425,7 +1641,7 @@ const projectOutputSchema = z.object({
|
|
|
1425
1641
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1426
1642
|
environments: z.array(environmentSchema)
|
|
1427
1643
|
});
|
|
1428
|
-
const getProjectContractV1 =
|
|
1644
|
+
const getProjectContractV1 = base.route({
|
|
1429
1645
|
path: "/v1/projects/{projectId}",
|
|
1430
1646
|
method: "GET",
|
|
1431
1647
|
summary: "Get a project",
|
|
@@ -1433,18 +1649,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1433
1649
|
tags: ["projects"],
|
|
1434
1650
|
successDescription: "The project details"
|
|
1435
1651
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1436
|
-
const listProjectsContractV1 =
|
|
1652
|
+
const listProjectsContractV1 = base.route({
|
|
1437
1653
|
path: "/v1/projects",
|
|
1438
1654
|
method: "GET",
|
|
1439
1655
|
summary: "List projects",
|
|
1440
1656
|
description: "List all projects for a team",
|
|
1441
1657
|
tags: ["projects"],
|
|
1442
1658
|
successDescription: "The list of projects"
|
|
1443
|
-
}).errors({
|
|
1444
|
-
|
|
1445
|
-
BAD_REQUEST: {}
|
|
1446
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1447
|
-
const createProjectContractV1 = oc.route({
|
|
1659
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1660
|
+
const createProjectContractV1 = base.route({
|
|
1448
1661
|
path: "/v1/projects",
|
|
1449
1662
|
method: "POST",
|
|
1450
1663
|
summary: "Create a project",
|
|
@@ -1453,7 +1666,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1453
1666
|
successDescription: "The project has been created successfully"
|
|
1454
1667
|
}).errors({
|
|
1455
1668
|
NOT_FOUND: {},
|
|
1456
|
-
BAD_REQUEST: {},
|
|
1457
1669
|
FORBIDDEN: {}
|
|
1458
1670
|
}).input(z.object({
|
|
1459
1671
|
teamId: z.string().optional(),
|
|
@@ -1494,7 +1706,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1494
1706
|
isSecret: z.boolean(),
|
|
1495
1707
|
createdAt: z.coerce.date()
|
|
1496
1708
|
});
|
|
1497
|
-
const listEnvironmentVariablesContractV1 =
|
|
1709
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1498
1710
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1499
1711
|
method: "GET",
|
|
1500
1712
|
summary: "List environment variables",
|
|
@@ -1502,48 +1714,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1502
1714
|
tags: ["environments"],
|
|
1503
1715
|
successDescription: "The list of environment variables"
|
|
1504
1716
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1505
|
-
const createEnvironmentVariablesContractV1 =
|
|
1717
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1506
1718
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1507
1719
|
method: "POST",
|
|
1508
1720
|
summary: "Add environment variables",
|
|
1509
1721
|
description: "Add one or more environment variables to an environment",
|
|
1510
1722
|
tags: ["environments"],
|
|
1511
1723
|
successDescription: "The environment variables have been added successfully"
|
|
1512
|
-
}).errors({
|
|
1513
|
-
NOT_FOUND: {},
|
|
1514
|
-
BAD_REQUEST: {}
|
|
1515
|
-
}).input(z.object({
|
|
1724
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1516
1725
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1517
1726
|
environmentVariables: environmentVariablesSchema
|
|
1518
1727
|
})).output(z.object({ success: z.literal(true) }));
|
|
1519
|
-
const updateEnvironmentVariableContractV1 =
|
|
1728
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1520
1729
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1521
1730
|
method: "PATCH",
|
|
1522
1731
|
summary: "Update an environment variable",
|
|
1523
1732
|
description: "Update an environment variable by ID",
|
|
1524
1733
|
tags: ["environments"],
|
|
1525
1734
|
successDescription: "The environment variable has been updated successfully"
|
|
1526
|
-
}).errors({
|
|
1527
|
-
NOT_FOUND: {},
|
|
1528
|
-
BAD_REQUEST: {}
|
|
1529
|
-
}).input(z.object({
|
|
1735
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1530
1736
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1531
1737
|
key: environmentVariableSchema.shape.key,
|
|
1532
1738
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1533
1739
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1534
1740
|
})).output(z.object({ success: z.literal(true) }));
|
|
1535
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1741
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1536
1742
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1537
1743
|
method: "DELETE",
|
|
1538
1744
|
summary: "Delete an environment variable",
|
|
1539
1745
|
description: "Delete an environment variable by ID",
|
|
1540
1746
|
tags: ["environments"],
|
|
1541
1747
|
successDescription: "The environment variable has been deleted successfully"
|
|
1542
|
-
}).errors({
|
|
1543
|
-
|
|
1544
|
-
BAD_REQUEST: {}
|
|
1545
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1546
|
-
const deleteProjectContractV1 = oc.route({
|
|
1748
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1749
|
+
const deleteProjectContractV1 = base.route({
|
|
1547
1750
|
path: "/v1/projects/{projectId}",
|
|
1548
1751
|
method: "DELETE",
|
|
1549
1752
|
summary: "Delete a project",
|
|
@@ -1551,7 +1754,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1551
1754
|
tags: ["projects"],
|
|
1552
1755
|
successDescription: "The project has been deleted successfully"
|
|
1553
1756
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1554
|
-
const updateProjectContractV1 =
|
|
1757
|
+
const updateProjectContractV1 = base.route({
|
|
1555
1758
|
path: "/v1/projects/{projectId}",
|
|
1556
1759
|
method: "PATCH",
|
|
1557
1760
|
summary: "Update a project",
|
|
@@ -1560,14 +1763,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1560
1763
|
successDescription: "The project has been updated successfully"
|
|
1561
1764
|
}).errors({
|
|
1562
1765
|
NOT_FOUND: {},
|
|
1563
|
-
BAD_REQUEST: {},
|
|
1564
1766
|
FORBIDDEN: {}
|
|
1565
1767
|
}).input(z.object({
|
|
1566
1768
|
projectId: z.string().describe("The ID of the project"),
|
|
1567
1769
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1568
1770
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1569
1771
|
})).output(projectOutputSchema);
|
|
1570
|
-
const deployEnvironmentContractV1 =
|
|
1772
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1571
1773
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1572
1774
|
method: "POST",
|
|
1573
1775
|
summary: "Deploy an environment",
|
|
@@ -1576,28 +1778,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1576
1778
|
successDescription: "The environment has been deployed successfully"
|
|
1577
1779
|
}).errors({
|
|
1578
1780
|
NOT_FOUND: {},
|
|
1579
|
-
|
|
1781
|
+
CONFLICT: {}
|
|
1580
1782
|
}).input(z.object({
|
|
1581
1783
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1582
1784
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1583
1785
|
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.")
|
|
1584
1786
|
})).output(deploymentSchema);
|
|
1585
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1787
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1586
1788
|
path: "/v1/deployments/upload",
|
|
1587
1789
|
method: "POST",
|
|
1588
1790
|
summary: "Upload deployment artifacts",
|
|
1589
1791
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1590
1792
|
tags: ["deployments"],
|
|
1591
1793
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1592
|
-
}).errors({
|
|
1593
|
-
NOT_FOUND: {},
|
|
1594
|
-
BAD_REQUEST: {}
|
|
1595
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1794
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1596
1795
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1597
1796
|
token: z.string().describe("Token to identify the source archive"),
|
|
1598
1797
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1599
1798
|
}));
|
|
1600
|
-
const listDeploymentsContractV1 =
|
|
1799
|
+
const listDeploymentsContractV1 = base.route({
|
|
1601
1800
|
path: "/v1/projects/{projectId}/deployments",
|
|
1602
1801
|
method: "GET",
|
|
1603
1802
|
summary: "List project deployments",
|
|
@@ -1609,7 +1808,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1609
1808
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1610
1809
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1611
1810
|
})).output(z.array(deploymentSchema));
|
|
1612
|
-
const getDeploymentContractV1 =
|
|
1811
|
+
const getDeploymentContractV1 = base.route({
|
|
1613
1812
|
path: "/v1/deployments/{deploymentId}",
|
|
1614
1813
|
method: "GET",
|
|
1615
1814
|
summary: "Get a deployment",
|
|
@@ -1632,20 +1831,17 @@ const logEntrySchema = z.object({
|
|
|
1632
1831
|
method: z.string().optional(),
|
|
1633
1832
|
durationInMs: z.number().optional()
|
|
1634
1833
|
});
|
|
1635
|
-
const getLogsContractV1 =
|
|
1834
|
+
const getLogsContractV1 = base.route({
|
|
1636
1835
|
path: "/v1/environments/{environmentId}/logs",
|
|
1637
1836
|
method: "GET",
|
|
1638
1837
|
summary: "Get logs",
|
|
1639
1838
|
description: "Get logs for an environment",
|
|
1640
1839
|
tags: ["environments"],
|
|
1641
1840
|
successDescription: "The logs"
|
|
1642
|
-
}).errors({
|
|
1643
|
-
NOT_FOUND: {},
|
|
1644
|
-
BAD_REQUEST: {}
|
|
1645
|
-
}).input(z.object({
|
|
1841
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1646
1842
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1647
|
-
since:
|
|
1648
|
-
until:
|
|
1843
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1844
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1649
1845
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1650
1846
|
level: z.array(z.enum([
|
|
1651
1847
|
"INFO",
|
|
@@ -1659,17 +1855,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1659
1855
|
logs: z.array(logEntrySchema),
|
|
1660
1856
|
nextToken: z.string().nullable()
|
|
1661
1857
|
}));
|
|
1662
|
-
const getLatestLogsContractV1 =
|
|
1858
|
+
const getLatestLogsContractV1 = base.route({
|
|
1663
1859
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1664
1860
|
method: "GET",
|
|
1665
1861
|
summary: "Get latest logs",
|
|
1666
1862
|
description: "Get the N most recent logs for an environment",
|
|
1667
1863
|
tags: ["environments"],
|
|
1668
1864
|
successDescription: "The latest logs"
|
|
1669
|
-
}).errors({
|
|
1670
|
-
NOT_FOUND: {},
|
|
1671
|
-
BAD_REQUEST: {}
|
|
1672
|
-
}).input(z.object({
|
|
1865
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1673
1866
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1674
1867
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1675
1868
|
level: z.array(z.enum([
|
|
@@ -1680,7 +1873,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1680
1873
|
])).optional().describe("Filter by log level"),
|
|
1681
1874
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1682
1875
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1683
|
-
const getDeploymentLogsContractV1 =
|
|
1876
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1684
1877
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1685
1878
|
method: "GET",
|
|
1686
1879
|
summary: "Get deployment logs",
|
|
@@ -1707,17 +1900,14 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1707
1900
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1708
1901
|
task_count: z.array(analyticsDataPointSchema)
|
|
1709
1902
|
});
|
|
1710
|
-
const getProjectAnalyticsContractV1 =
|
|
1903
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1711
1904
|
path: "/v1/analytics/{projectId}",
|
|
1712
1905
|
method: "GET",
|
|
1713
1906
|
summary: "Get project analytics",
|
|
1714
1907
|
description: "Get analytics data for a project over a time range",
|
|
1715
1908
|
tags: ["analytics"],
|
|
1716
1909
|
successDescription: "The project analytics data"
|
|
1717
|
-
}).errors({
|
|
1718
|
-
NOT_FOUND: {},
|
|
1719
|
-
BAD_REQUEST: {}
|
|
1720
|
-
}).input(z.object({
|
|
1910
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1721
1911
|
projectId: z.string().describe("The ID of the project"),
|
|
1722
1912
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1723
1913
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
@@ -1732,7 +1922,61 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1732
1922
|
}),
|
|
1733
1923
|
timeSeries: analyticsTimeSeriesSchema
|
|
1734
1924
|
}));
|
|
1735
|
-
const
|
|
1925
|
+
const paginatedInsightsInputShape = {
|
|
1926
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1927
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1928
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1929
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1930
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1931
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1932
|
+
};
|
|
1933
|
+
const listIntentsContractV1 = base.route({
|
|
1934
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1935
|
+
method: "GET",
|
|
1936
|
+
summary: "List intents",
|
|
1937
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1938
|
+
tags: ["insights"],
|
|
1939
|
+
successDescription: "The grouped user intents"
|
|
1940
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1941
|
+
...paginatedInsightsInputShape,
|
|
1942
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1943
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
1944
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1945
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
1946
|
+
})).output(z.object({
|
|
1947
|
+
intents: z.array(z.object({
|
|
1948
|
+
id: z.string(),
|
|
1949
|
+
intentIds: z.array(z.string()).min(1),
|
|
1950
|
+
environmentId: z.string(),
|
|
1951
|
+
message: z.string(),
|
|
1952
|
+
toolName: z.string(),
|
|
1953
|
+
createdAt: z.coerce.date(),
|
|
1954
|
+
occurrenceCount: z.number().int().positive(),
|
|
1955
|
+
clientName: z.string().nullable(),
|
|
1956
|
+
clientId: z.string().nullable(),
|
|
1957
|
+
categories: z.array(z.object({
|
|
1958
|
+
id: z.string(),
|
|
1959
|
+
name: z.string(),
|
|
1960
|
+
color: intentCategoryColorSchema
|
|
1961
|
+
}))
|
|
1962
|
+
})),
|
|
1963
|
+
totalCount: z.number().int().nonnegative()
|
|
1964
|
+
}));
|
|
1965
|
+
const listFeedbacksContractV1 = base.route({
|
|
1966
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
1967
|
+
method: "GET",
|
|
1968
|
+
summary: "List feedbacks",
|
|
1969
|
+
description: "List user feedback for an environment over a time range",
|
|
1970
|
+
tags: ["insights"],
|
|
1971
|
+
successDescription: "The user feedback"
|
|
1972
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1973
|
+
...paginatedInsightsInputShape,
|
|
1974
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
1975
|
+
})).output(z.object({
|
|
1976
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
1977
|
+
totalCount: z.number().int().nonnegative()
|
|
1978
|
+
}));
|
|
1979
|
+
const listTeamsContractV1 = base.route({
|
|
1736
1980
|
path: "/v1/teams",
|
|
1737
1981
|
method: "GET",
|
|
1738
1982
|
summary: "List teams",
|
|
@@ -1745,7 +1989,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1745
1989
|
createdAt: z.coerce.date(),
|
|
1746
1990
|
hasStripeAccount: z.boolean()
|
|
1747
1991
|
})));
|
|
1748
|
-
const
|
|
1992
|
+
const getTeamUsageContractV1 = base.route({
|
|
1993
|
+
path: "/v1/teams/{teamId}/usage",
|
|
1994
|
+
method: "GET",
|
|
1995
|
+
summary: "Get team usage",
|
|
1996
|
+
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.",
|
|
1997
|
+
tags: ["teams"],
|
|
1998
|
+
successDescription: "The current billing window usage"
|
|
1999
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2000
|
+
teamId: z.string(),
|
|
2001
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2002
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2003
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2004
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2005
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2006
|
+
}));
|
|
2007
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1749
2008
|
path: "/v1/tunnels/ticket",
|
|
1750
2009
|
method: "GET",
|
|
1751
2010
|
summary: "Get a tunnel ticket",
|
|
@@ -1757,16 +2016,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1757
2016
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1758
2017
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1759
2018
|
}));
|
|
1760
|
-
const publishServerContractV1 =
|
|
2019
|
+
const publishServerContractV1 = base.route({
|
|
1761
2020
|
path: "/v1/distribution/publish",
|
|
1762
2021
|
method: "POST",
|
|
1763
2022
|
summary: "Publish a server to the MCP registry",
|
|
1764
2023
|
tags: ["distribution"],
|
|
1765
2024
|
successDescription: "The server has been published successfully"
|
|
1766
|
-
}).errors({
|
|
1767
|
-
NOT_FOUND: {},
|
|
1768
|
-
BAD_REQUEST: {}
|
|
1769
|
-
}).input(z.object({
|
|
2025
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1770
2026
|
projectId: z.string(),
|
|
1771
2027
|
domain: z.string(),
|
|
1772
2028
|
title: z.string().min(1).max(100),
|
|
@@ -1775,17 +2031,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1775
2031
|
iconSrc: z.url().max(255).optional(),
|
|
1776
2032
|
dryRun: z.boolean().optional()
|
|
1777
2033
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1778
|
-
const getServerInfoContractV1 =
|
|
2034
|
+
const getServerInfoContractV1 = base.route({
|
|
1779
2035
|
path: "/v1/distribution/get",
|
|
1780
2036
|
method: "GET",
|
|
1781
2037
|
summary: "Get server info",
|
|
1782
2038
|
description: "Get info about a server",
|
|
1783
2039
|
tags: ["distribution"],
|
|
1784
2040
|
successDescription: "The server info"
|
|
1785
|
-
}).errors({
|
|
1786
|
-
NOT_FOUND: {},
|
|
1787
|
-
BAD_REQUEST: {}
|
|
1788
|
-
}).input(z.object({
|
|
2041
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1789
2042
|
projectId: z.string(),
|
|
1790
2043
|
domain: z.string()
|
|
1791
2044
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1804,7 +2057,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1804
2057
|
isPlaygroundEnabled: z.boolean(),
|
|
1805
2058
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1806
2059
|
});
|
|
1807
|
-
const getPlaygroundContractV1 =
|
|
2060
|
+
const getPlaygroundContractV1 = base.route({
|
|
1808
2061
|
path: "/v1/environments/{environmentId}/playground",
|
|
1809
2062
|
method: "GET",
|
|
1810
2063
|
summary: "Get playground configuration",
|
|
@@ -1812,17 +2065,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1812
2065
|
tags: ["environments"],
|
|
1813
2066
|
successDescription: "The playground configuration"
|
|
1814
2067
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1815
|
-
const upsertPlaygroundContractV1 =
|
|
2068
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1816
2069
|
path: "/v1/environments/{environmentId}/playground",
|
|
1817
2070
|
method: "PUT",
|
|
1818
2071
|
summary: "Update playground configuration",
|
|
1819
2072
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1820
2073
|
tags: ["environments"],
|
|
1821
2074
|
successDescription: "The updated playground configuration"
|
|
1822
|
-
}).errors({
|
|
1823
|
-
NOT_FOUND: {},
|
|
1824
|
-
BAD_REQUEST: {}
|
|
1825
|
-
}).input(z.object({
|
|
2075
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1826
2076
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1827
2077
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1828
2078
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1830,7 +2080,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1830
2080
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1831
2081
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1832
2082
|
})).output(playgroundOutputSchema);
|
|
1833
|
-
const createBeaconContractV1 =
|
|
2083
|
+
const createBeaconContractV1 = base.route({
|
|
1834
2084
|
path: "/v1/beacon/audits",
|
|
1835
2085
|
method: "POST",
|
|
1836
2086
|
summary: "Create a beacon audit",
|
|
@@ -1839,7 +2089,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1839
2089
|
successDescription: "The audit has been created"
|
|
1840
2090
|
}).errors({
|
|
1841
2091
|
NOT_FOUND: {},
|
|
1842
|
-
BAD_REQUEST: {},
|
|
1843
2092
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1844
2093
|
}).input(z.object({
|
|
1845
2094
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1847,7 +2096,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1847
2096
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1848
2097
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1849
2098
|
})).output(z.object({ id: z.string() }));
|
|
1850
|
-
const getBeaconContractV1 =
|
|
2099
|
+
const getBeaconContractV1 = base.route({
|
|
1851
2100
|
path: "/v1/beacon/audits/{auditId}",
|
|
1852
2101
|
method: "GET",
|
|
1853
2102
|
summary: "Get a beacon audit",
|
|
@@ -1863,8 +2112,13 @@ const getBeaconContractV1 = oc.route({
|
|
|
1863
2112
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1864
2113
|
}));
|
|
1865
2114
|
const contract = {
|
|
1866
|
-
teams: {
|
|
2115
|
+
teams: {
|
|
2116
|
+
list: { v1: listTeamsContractV1 },
|
|
2117
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2118
|
+
},
|
|
1867
2119
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2120
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2121
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1868
2122
|
deployments: {
|
|
1869
2123
|
list: { v1: listDeploymentsContractV1 },
|
|
1870
2124
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1905,5 +2159,10 @@ const contract = {
|
|
|
1905
2159
|
get: { v1: getBeaconContractV1 }
|
|
1906
2160
|
}
|
|
1907
2161
|
};
|
|
2162
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2163
|
+
const contractForDocs = {
|
|
2164
|
+
...contract,
|
|
2165
|
+
deployments: deploymentsForDocs
|
|
2166
|
+
};
|
|
1908
2167
|
//#endregion
|
|
1909
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2168
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|