@alpic-ai/api 0.0.0-staging.gc8bbd5f → 0.0.0-staging.gca24a3a
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 +1076 -47
- package/dist/index.mjs +454 -192
- package/package.json +23 -7
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,34 +283,51 @@ const deploymentSummarySchema = z.object({
|
|
|
273
283
|
createdAt: z.coerce.date(),
|
|
274
284
|
updatedAt: z.coerce.date()
|
|
275
285
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
286
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
287
|
const publicEnvironmentSchema = z.object({
|
|
288
|
+
allowsAnonymous: z.literal(true),
|
|
289
|
+
oAuthMetadata: z.strictObject({})
|
|
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. */
|
|
292
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
293
|
+
allowsAnonymous: z.boolean(),
|
|
294
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
295
|
+
scope: z.string().optional()
|
|
296
|
+
});
|
|
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. */
|
|
298
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
299
|
+
allowsAnonymous: z.boolean(),
|
|
300
|
+
oAuthMetadata: z.object({
|
|
301
|
+
externalAuthorizationServerUrl: z.url(),
|
|
302
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
303
|
+
}),
|
|
304
|
+
scope: z.string().optional()
|
|
305
|
+
});
|
|
306
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
307
|
+
const standaloneEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.boolean(),
|
|
309
|
+
oAuthMetadata: z.object({
|
|
310
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
311
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
312
|
+
}),
|
|
313
|
+
scope: z.string().optional()
|
|
314
|
+
});
|
|
315
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
316
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
317
|
+
allowsAnonymous: z.literal(false),
|
|
318
|
+
oAuthMetadata: z.strictObject({}),
|
|
319
|
+
scope: z.string().optional()
|
|
320
|
+
});
|
|
321
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
322
|
isPublic: z.literal(true),
|
|
283
323
|
oAuthMetadata: z.undefined().optional()
|
|
284
324
|
});
|
|
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
|
-
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
325
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
326
|
isPublic: z.literal(false),
|
|
293
327
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
328
|
scope: z.string().optional()
|
|
295
329
|
});
|
|
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
|
-
*/
|
|
303
|
-
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
330
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
331
|
isPublic: z.literal(false),
|
|
305
332
|
oAuthMetadata: z.object({
|
|
306
333
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +335,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
335
|
}),
|
|
309
336
|
scope: z.string().optional()
|
|
310
337
|
});
|
|
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
|
-
*/
|
|
317
|
-
const standaloneEnvironmentSchema = z.object({
|
|
338
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
339
|
isPublic: z.literal(false),
|
|
319
340
|
oAuthMetadata: z.object({
|
|
320
341
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +343,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
343
|
}),
|
|
323
344
|
scope: z.string().optional()
|
|
324
345
|
});
|
|
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
|
-
*/
|
|
332
|
-
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
346
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
347
|
isPublic: z.literal(false),
|
|
334
348
|
oAuthMetadata: z.strictObject({}),
|
|
335
349
|
scope: z.string().optional()
|
|
@@ -339,11 +353,21 @@ z.union([
|
|
|
339
353
|
externalResourceMetadataEnvironmentSchema,
|
|
340
354
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
355
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
356
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
357
|
+
legacyPublicEnvironmentSchema,
|
|
358
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
359
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
360
|
+
legacyStandaloneEnvironmentSchema,
|
|
361
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
362
|
+
]);
|
|
363
|
+
const playgroundModelSchema = z.enum([
|
|
364
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
365
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
366
|
+
"openai.gpt-5.4",
|
|
367
|
+
"openai.gpt-5.5"
|
|
343
368
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
369
|
const environmentDomainSchema = z.object({
|
|
346
|
-
|
|
370
|
+
name: z.string(),
|
|
347
371
|
status: z.enum([
|
|
348
372
|
"ongoing",
|
|
349
373
|
"deployed",
|
|
@@ -361,6 +385,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
385
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
386
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
387
|
isPlaygroundEnabled: z.boolean(),
|
|
388
|
+
playgroundModel: playgroundModelSchema,
|
|
364
389
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
390
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
391
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -373,14 +398,17 @@ z.object({
|
|
|
373
398
|
sessionReplayEnabled: z.boolean(),
|
|
374
399
|
collectRequestPayload: z.boolean(),
|
|
375
400
|
collectResponsePayload: z.boolean(),
|
|
376
|
-
collectErrorMessage: z.boolean()
|
|
401
|
+
collectErrorMessage: z.boolean(),
|
|
402
|
+
collectUserData: z.boolean(),
|
|
403
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
377
404
|
});
|
|
378
405
|
z.object({
|
|
379
406
|
id: z.string(),
|
|
380
407
|
createdAt: z.coerce.date(),
|
|
381
408
|
environmentId: z.string(),
|
|
382
409
|
content: z.string(),
|
|
383
|
-
source: z.enum(["model", "user"])
|
|
410
|
+
source: z.enum(["model", "user"]),
|
|
411
|
+
clientName: z.string().nullable()
|
|
384
412
|
});
|
|
385
413
|
z.object({
|
|
386
414
|
content: z.string(),
|
|
@@ -416,6 +444,7 @@ z.object({
|
|
|
416
444
|
environmentId: z.string(),
|
|
417
445
|
toolName: z.string(),
|
|
418
446
|
message: z.string(),
|
|
447
|
+
clientName: z.string().nullable(),
|
|
419
448
|
categories: z.array(intentCategorySchema)
|
|
420
449
|
});
|
|
421
450
|
const signalCategorySchema = z.object({
|
|
@@ -480,6 +509,246 @@ z.enum([
|
|
|
480
509
|
"DEBUG",
|
|
481
510
|
"ERROR"
|
|
482
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]));
|
|
483
752
|
const runtimeSchema = z.enum([
|
|
484
753
|
"python3.13",
|
|
485
754
|
"python3.14",
|
|
@@ -508,15 +777,27 @@ z.object({
|
|
|
508
777
|
environments: z.array(environmentWithDomainsSchema),
|
|
509
778
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
510
779
|
});
|
|
780
|
+
const domainFailureReasonSchema = z.enum([
|
|
781
|
+
"caa",
|
|
782
|
+
"dns",
|
|
783
|
+
"invalid_domain",
|
|
784
|
+
"other"
|
|
785
|
+
]);
|
|
786
|
+
const projectDomainMappingSchema = z.object({
|
|
787
|
+
pathPrefix: z.string(),
|
|
788
|
+
environment: environmentSchema$1
|
|
789
|
+
});
|
|
511
790
|
z.object({
|
|
512
|
-
|
|
791
|
+
name: z.string(),
|
|
513
792
|
createdAt: z.coerce.date(),
|
|
514
793
|
status: z.enum([
|
|
515
794
|
"ongoing",
|
|
516
795
|
"deployed",
|
|
517
796
|
"failed"
|
|
518
797
|
]),
|
|
519
|
-
|
|
798
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
799
|
+
environment: environmentSchema$1,
|
|
800
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
520
801
|
});
|
|
521
802
|
const serverFieldsSchema$1 = z.object({
|
|
522
803
|
$schema: z.string(),
|
|
@@ -545,15 +826,7 @@ z.object({
|
|
|
545
826
|
serverFields: serverFieldsSchema$1,
|
|
546
827
|
source: z.enum(["registry", "defaults"])
|
|
547
828
|
});
|
|
548
|
-
/**
|
|
549
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
550
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
551
|
-
*
|
|
552
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
553
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
554
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
555
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
556
|
-
*/
|
|
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. */
|
|
557
830
|
const clampStringField = (field) => {
|
|
558
831
|
const max = field.maxLength;
|
|
559
832
|
if (max === null) return field;
|
|
@@ -580,8 +853,9 @@ const positiveTestCaseSchema = z.object({
|
|
|
580
853
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
581
854
|
const screenshotEntrySchema = z.object({
|
|
582
855
|
prompt: z.string(),
|
|
583
|
-
url: z.url()
|
|
856
|
+
url: z.url()
|
|
584
857
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
858
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
585
859
|
/** Accepts either a valid email or URL. */
|
|
586
860
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
587
861
|
/** A URL field whose error spells out that the scheme is required. */
|
|
@@ -898,11 +1172,7 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
898
1172
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
899
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.\"")
|
|
900
1174
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
901
|
-
/**
|
|
902
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
903
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
904
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
905
|
-
*/
|
|
1175
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
906
1176
|
const chatgptTaglineSchema = z.string().max(30);
|
|
907
1177
|
const chatgptDescriptionSchema = z.string();
|
|
908
1178
|
const chatgptTranslationSchema = z.object({
|
|
@@ -911,10 +1181,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
911
1181
|
description: chatgptDescriptionSchema
|
|
912
1182
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
913
1183
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
914
|
-
/**
|
|
915
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
916
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
917
|
-
*/
|
|
1184
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
918
1185
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
919
1186
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
920
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."),
|
|
@@ -940,6 +1207,17 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
940
1207
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
941
1208
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
942
1209
|
});
|
|
1210
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1211
|
+
tagline: z.string().optional(),
|
|
1212
|
+
companyUrl: z.string().optional(),
|
|
1213
|
+
supportChannel: z.string().optional(),
|
|
1214
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1215
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1216
|
+
demoRecordingUrl: z.string().optional(),
|
|
1217
|
+
serverUrl: z.string().optional(),
|
|
1218
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1219
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1220
|
+
});
|
|
943
1221
|
chatgptSubmissionFormDataSchema.pick({
|
|
944
1222
|
appName: true,
|
|
945
1223
|
developerName: true,
|
|
@@ -1000,11 +1278,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1000
1278
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1001
1279
|
"Public documentation for this connector will be live by the publish date."
|
|
1002
1280
|
]);
|
|
1003
|
-
/**
|
|
1004
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1005
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1006
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1007
|
-
*/
|
|
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. */
|
|
1008
1282
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1009
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
|
|
1010
1284
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1018,8 +1292,8 @@ phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects i
|
|
|
1018
1292
|
description: z.string().max(2e3).describe(`A description of what your connector does and its key features, shown on the connector's detail page in
|
|
1019
1293
|
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1020
1294
|
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1021
|
-
iconUrl: z.url().optional().describe(`Optional custom icon
|
|
1022
|
-
|
|
1295
|
+
iconUrl: z.url().optional().describe(`Optional custom icon for the directory listing — a square SVG. By default the favicon from your MCP URL is used
|
|
1296
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1023
1297
|
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1024
1298
|
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1025
1299
|
by your publish date.`),
|
|
@@ -1027,6 +1301,8 @@ by your publish date.`),
|
|
|
1027
1301
|
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1028
1302
|
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1029
1303
|
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1304
|
+
screenshots: z.array(screenshotEntrySchema).optional().describe(`Carousel images shown on your connector's directory page (PNG). Each is paired with the user prompt that produced
|
|
1305
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1030
1306
|
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1031
1307
|
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1032
1308
|
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
@@ -1064,6 +1340,21 @@ fully populated account.`),
|
|
|
1064
1340
|
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1065
1341
|
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1066
1342
|
});
|
|
1343
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1344
|
+
serverUrl: z.string().optional(),
|
|
1345
|
+
name: z.string().optional(),
|
|
1346
|
+
slug: z.string().optional(),
|
|
1347
|
+
oneLiner: z.string().optional(),
|
|
1348
|
+
description: z.string().optional(),
|
|
1349
|
+
iconUrl: z.string().optional(),
|
|
1350
|
+
documentation: z.string().optional(),
|
|
1351
|
+
support: z.string().optional(),
|
|
1352
|
+
privacyPolicy: z.string().optional(),
|
|
1353
|
+
companyWebsite: z.string().optional(),
|
|
1354
|
+
primaryContactEmail: z.string().optional(),
|
|
1355
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1356
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1357
|
+
});
|
|
1067
1358
|
claudeSubmissionFormDataSchema.pick({
|
|
1068
1359
|
serverUrl: true,
|
|
1069
1360
|
name: true,
|
|
@@ -1079,12 +1370,7 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1079
1370
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1080
1371
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1081
1372
|
});
|
|
1082
|
-
/**
|
|
1083
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1084
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1085
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1086
|
-
* colocated with the Claude contract.
|
|
1087
|
-
*/
|
|
1373
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1088
1374
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1089
1375
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1090
1376
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
@@ -1104,14 +1390,14 @@ const submissionMetaFieldsSchema = z.object({
|
|
|
1104
1390
|
});
|
|
1105
1391
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1106
1392
|
platform: z.literal("claudeai"),
|
|
1107
|
-
formData:
|
|
1393
|
+
formData: claudeSubmissionDraftSchema
|
|
1108
1394
|
});
|
|
1109
1395
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1110
1396
|
platform: z.literal("chatgpt"),
|
|
1111
|
-
formData:
|
|
1397
|
+
formData: chatgptSubmissionDraftSchema
|
|
1112
1398
|
});
|
|
1113
1399
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1114
|
-
z.union([
|
|
1400
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1115
1401
|
const subscriptionPlanSchema = z.enum([
|
|
1116
1402
|
"pro",
|
|
1117
1403
|
"business",
|
|
@@ -1176,7 +1462,10 @@ const RESERVED_KEYS = [
|
|
|
1176
1462
|
"BUILD_ARG_START_COMMAND",
|
|
1177
1463
|
"ALPIC_HOST",
|
|
1178
1464
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1179
|
-
"ALPIC_INTENT_META_KEY"
|
|
1465
|
+
"ALPIC_INTENT_META_KEY",
|
|
1466
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1467
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1468
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1180
1469
|
];
|
|
1181
1470
|
const environmentVariableSchema = z.object({
|
|
1182
1471
|
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"),
|
|
@@ -1261,17 +1550,15 @@ const isValidLogTimeInput = (value) => {
|
|
|
1261
1550
|
if (ms(value) !== void 0) return true;
|
|
1262
1551
|
return !Number.isNaN(new Date(value).getTime());
|
|
1263
1552
|
};
|
|
1264
|
-
const
|
|
1553
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1554
|
+
const createEnvironmentContractV1 = base.route({
|
|
1265
1555
|
path: "/v1/environments",
|
|
1266
1556
|
method: "POST",
|
|
1267
1557
|
summary: "Create an environment",
|
|
1268
1558
|
description: "Create an environment for a project",
|
|
1269
1559
|
tags: ["environments"],
|
|
1270
1560
|
successDescription: "The environment has been created successfully"
|
|
1271
|
-
}).errors({
|
|
1272
|
-
NOT_FOUND: {},
|
|
1273
|
-
BAD_REQUEST: {}
|
|
1274
|
-
}).input(z.object({
|
|
1561
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1275
1562
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1276
1563
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1277
1564
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1284,7 +1571,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1284
1571
|
createdAt: z.coerce.date(),
|
|
1285
1572
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1286
1573
|
}));
|
|
1287
|
-
const getEnvironmentContractV1 =
|
|
1574
|
+
const getEnvironmentContractV1 = base.route({
|
|
1288
1575
|
path: "/v1/environments/{environmentId}",
|
|
1289
1576
|
method: "GET",
|
|
1290
1577
|
summary: "Get an environment",
|
|
@@ -1341,7 +1628,7 @@ const projectOutputSchema = z.object({
|
|
|
1341
1628
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1342
1629
|
environments: z.array(environmentSchema)
|
|
1343
1630
|
});
|
|
1344
|
-
const getProjectContractV1 =
|
|
1631
|
+
const getProjectContractV1 = base.route({
|
|
1345
1632
|
path: "/v1/projects/{projectId}",
|
|
1346
1633
|
method: "GET",
|
|
1347
1634
|
summary: "Get a project",
|
|
@@ -1349,18 +1636,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1349
1636
|
tags: ["projects"],
|
|
1350
1637
|
successDescription: "The project details"
|
|
1351
1638
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1352
|
-
const listProjectsContractV1 =
|
|
1639
|
+
const listProjectsContractV1 = base.route({
|
|
1353
1640
|
path: "/v1/projects",
|
|
1354
1641
|
method: "GET",
|
|
1355
1642
|
summary: "List projects",
|
|
1356
1643
|
description: "List all projects for a team",
|
|
1357
1644
|
tags: ["projects"],
|
|
1358
1645
|
successDescription: "The list of projects"
|
|
1359
|
-
}).errors({
|
|
1360
|
-
|
|
1361
|
-
BAD_REQUEST: {}
|
|
1362
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1363
|
-
const createProjectContractV1 = oc.route({
|
|
1646
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1647
|
+
const createProjectContractV1 = base.route({
|
|
1364
1648
|
path: "/v1/projects",
|
|
1365
1649
|
method: "POST",
|
|
1366
1650
|
summary: "Create a project",
|
|
@@ -1369,7 +1653,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1369
1653
|
successDescription: "The project has been created successfully"
|
|
1370
1654
|
}).errors({
|
|
1371
1655
|
NOT_FOUND: {},
|
|
1372
|
-
BAD_REQUEST: {},
|
|
1373
1656
|
FORBIDDEN: {}
|
|
1374
1657
|
}).input(z.object({
|
|
1375
1658
|
teamId: z.string().optional(),
|
|
@@ -1410,7 +1693,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1410
1693
|
isSecret: z.boolean(),
|
|
1411
1694
|
createdAt: z.coerce.date()
|
|
1412
1695
|
});
|
|
1413
|
-
const listEnvironmentVariablesContractV1 =
|
|
1696
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1414
1697
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1415
1698
|
method: "GET",
|
|
1416
1699
|
summary: "List environment variables",
|
|
@@ -1418,48 +1701,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1418
1701
|
tags: ["environments"],
|
|
1419
1702
|
successDescription: "The list of environment variables"
|
|
1420
1703
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1421
|
-
const createEnvironmentVariablesContractV1 =
|
|
1704
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1422
1705
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1423
1706
|
method: "POST",
|
|
1424
1707
|
summary: "Add environment variables",
|
|
1425
1708
|
description: "Add one or more environment variables to an environment",
|
|
1426
1709
|
tags: ["environments"],
|
|
1427
1710
|
successDescription: "The environment variables have been added successfully"
|
|
1428
|
-
}).errors({
|
|
1429
|
-
NOT_FOUND: {},
|
|
1430
|
-
BAD_REQUEST: {}
|
|
1431
|
-
}).input(z.object({
|
|
1711
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1432
1712
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1433
1713
|
environmentVariables: environmentVariablesSchema
|
|
1434
1714
|
})).output(z.object({ success: z.literal(true) }));
|
|
1435
|
-
const updateEnvironmentVariableContractV1 =
|
|
1715
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1436
1716
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1437
1717
|
method: "PATCH",
|
|
1438
1718
|
summary: "Update an environment variable",
|
|
1439
1719
|
description: "Update an environment variable by ID",
|
|
1440
1720
|
tags: ["environments"],
|
|
1441
1721
|
successDescription: "The environment variable has been updated successfully"
|
|
1442
|
-
}).errors({
|
|
1443
|
-
NOT_FOUND: {},
|
|
1444
|
-
BAD_REQUEST: {}
|
|
1445
|
-
}).input(z.object({
|
|
1722
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1446
1723
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1447
1724
|
key: environmentVariableSchema.shape.key,
|
|
1448
1725
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1449
1726
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1450
1727
|
})).output(z.object({ success: z.literal(true) }));
|
|
1451
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1728
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1452
1729
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1453
1730
|
method: "DELETE",
|
|
1454
1731
|
summary: "Delete an environment variable",
|
|
1455
1732
|
description: "Delete an environment variable by ID",
|
|
1456
1733
|
tags: ["environments"],
|
|
1457
1734
|
successDescription: "The environment variable has been deleted successfully"
|
|
1458
|
-
}).errors({
|
|
1459
|
-
|
|
1460
|
-
BAD_REQUEST: {}
|
|
1461
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1462
|
-
const deleteProjectContractV1 = oc.route({
|
|
1735
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1736
|
+
const deleteProjectContractV1 = base.route({
|
|
1463
1737
|
path: "/v1/projects/{projectId}",
|
|
1464
1738
|
method: "DELETE",
|
|
1465
1739
|
summary: "Delete a project",
|
|
@@ -1467,7 +1741,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1467
1741
|
tags: ["projects"],
|
|
1468
1742
|
successDescription: "The project has been deleted successfully"
|
|
1469
1743
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1470
|
-
const updateProjectContractV1 =
|
|
1744
|
+
const updateProjectContractV1 = base.route({
|
|
1471
1745
|
path: "/v1/projects/{projectId}",
|
|
1472
1746
|
method: "PATCH",
|
|
1473
1747
|
summary: "Update a project",
|
|
@@ -1476,14 +1750,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1476
1750
|
successDescription: "The project has been updated successfully"
|
|
1477
1751
|
}).errors({
|
|
1478
1752
|
NOT_FOUND: {},
|
|
1479
|
-
BAD_REQUEST: {},
|
|
1480
1753
|
FORBIDDEN: {}
|
|
1481
1754
|
}).input(z.object({
|
|
1482
1755
|
projectId: z.string().describe("The ID of the project"),
|
|
1483
1756
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1484
1757
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1485
1758
|
})).output(projectOutputSchema);
|
|
1486
|
-
const deployEnvironmentContractV1 =
|
|
1759
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1487
1760
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1488
1761
|
method: "POST",
|
|
1489
1762
|
summary: "Deploy an environment",
|
|
@@ -1492,27 +1765,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1492
1765
|
successDescription: "The environment has been deployed successfully"
|
|
1493
1766
|
}).errors({
|
|
1494
1767
|
NOT_FOUND: {},
|
|
1495
|
-
|
|
1768
|
+
CONFLICT: {}
|
|
1496
1769
|
}).input(z.object({
|
|
1497
1770
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1498
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1771
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1772
|
+
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.")
|
|
1499
1773
|
})).output(deploymentSchema);
|
|
1500
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1774
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1501
1775
|
path: "/v1/deployments/upload",
|
|
1502
1776
|
method: "POST",
|
|
1503
1777
|
summary: "Upload deployment artifacts",
|
|
1504
1778
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1505
1779
|
tags: ["deployments"],
|
|
1506
1780
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1507
|
-
}).errors({
|
|
1508
|
-
NOT_FOUND: {},
|
|
1509
|
-
BAD_REQUEST: {}
|
|
1510
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1781
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1511
1782
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1512
1783
|
token: z.string().describe("Token to identify the source archive"),
|
|
1513
1784
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1514
1785
|
}));
|
|
1515
|
-
const listDeploymentsContractV1 =
|
|
1786
|
+
const listDeploymentsContractV1 = base.route({
|
|
1516
1787
|
path: "/v1/projects/{projectId}/deployments",
|
|
1517
1788
|
method: "GET",
|
|
1518
1789
|
summary: "List project deployments",
|
|
@@ -1524,7 +1795,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1524
1795
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1525
1796
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1526
1797
|
})).output(z.array(deploymentSchema));
|
|
1527
|
-
const getDeploymentContractV1 =
|
|
1798
|
+
const getDeploymentContractV1 = base.route({
|
|
1528
1799
|
path: "/v1/deployments/{deploymentId}",
|
|
1529
1800
|
method: "GET",
|
|
1530
1801
|
summary: "Get a deployment",
|
|
@@ -1532,17 +1803,29 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1532
1803
|
tags: ["deployments"],
|
|
1533
1804
|
successDescription: "The deployment details"
|
|
1534
1805
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1535
|
-
const
|
|
1806
|
+
const logEntrySchema = z.object({
|
|
1807
|
+
timestamp: z.coerce.date(),
|
|
1808
|
+
type: z.enum([
|
|
1809
|
+
"START",
|
|
1810
|
+
"END",
|
|
1811
|
+
"INFO",
|
|
1812
|
+
"ERROR",
|
|
1813
|
+
"WARNING",
|
|
1814
|
+
"DEBUG"
|
|
1815
|
+
]),
|
|
1816
|
+
requestId: z.string(),
|
|
1817
|
+
content: z.string().optional(),
|
|
1818
|
+
method: z.string().optional(),
|
|
1819
|
+
durationInMs: z.number().optional()
|
|
1820
|
+
});
|
|
1821
|
+
const getLogsContractV1 = base.route({
|
|
1536
1822
|
path: "/v1/environments/{environmentId}/logs",
|
|
1537
1823
|
method: "GET",
|
|
1538
1824
|
summary: "Get logs",
|
|
1539
1825
|
description: "Get logs for an environment",
|
|
1540
1826
|
tags: ["environments"],
|
|
1541
1827
|
successDescription: "The logs"
|
|
1542
|
-
}).errors({
|
|
1543
|
-
NOT_FOUND: {},
|
|
1544
|
-
BAD_REQUEST: {}
|
|
1545
|
-
}).input(z.object({
|
|
1828
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1546
1829
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1547
1830
|
since: z.string().refine(isValidLogTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." }).optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1548
1831
|
until: z.string().refine(isValidLogTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." }).optional().describe("End time — ISO 8601 or relative"),
|
|
@@ -1556,34 +1839,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1556
1839
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1557
1840
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1558
1841
|
})).output(z.object({
|
|
1559
|
-
logs: z.array(
|
|
1560
|
-
timestamp: z.coerce.date(),
|
|
1561
|
-
type: z.enum([
|
|
1562
|
-
"START",
|
|
1563
|
-
"END",
|
|
1564
|
-
"INFO",
|
|
1565
|
-
"ERROR",
|
|
1566
|
-
"WARNING",
|
|
1567
|
-
"DEBUG"
|
|
1568
|
-
]),
|
|
1569
|
-
requestId: z.string(),
|
|
1570
|
-
content: z.string().optional(),
|
|
1571
|
-
method: z.string().optional(),
|
|
1572
|
-
durationInMs: z.number().optional()
|
|
1573
|
-
})),
|
|
1842
|
+
logs: z.array(logEntrySchema),
|
|
1574
1843
|
nextToken: z.string().nullable()
|
|
1575
1844
|
}));
|
|
1576
|
-
const getLatestLogsContractV1 =
|
|
1845
|
+
const getLatestLogsContractV1 = base.route({
|
|
1577
1846
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1578
1847
|
method: "GET",
|
|
1579
1848
|
summary: "Get latest logs",
|
|
1580
1849
|
description: "Get the N most recent logs for an environment",
|
|
1581
1850
|
tags: ["environments"],
|
|
1582
1851
|
successDescription: "The latest logs"
|
|
1583
|
-
}).errors({
|
|
1584
|
-
NOT_FOUND: {},
|
|
1585
|
-
BAD_REQUEST: {}
|
|
1586
|
-
}).input(z.object({
|
|
1852
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1587
1853
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1588
1854
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1589
1855
|
level: z.array(z.enum([
|
|
@@ -1593,22 +1859,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1593
1859
|
"DEBUG"
|
|
1594
1860
|
])).optional().describe("Filter by log level"),
|
|
1595
1861
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1596
|
-
})).output(z.object({ logs: z.array(
|
|
1597
|
-
|
|
1598
|
-
type: z.enum([
|
|
1599
|
-
"START",
|
|
1600
|
-
"END",
|
|
1601
|
-
"INFO",
|
|
1602
|
-
"ERROR",
|
|
1603
|
-
"WARNING",
|
|
1604
|
-
"DEBUG"
|
|
1605
|
-
]),
|
|
1606
|
-
requestId: z.string(),
|
|
1607
|
-
content: z.string().optional(),
|
|
1608
|
-
method: z.string().optional(),
|
|
1609
|
-
durationInMs: z.number().optional()
|
|
1610
|
-
})) }));
|
|
1611
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1862
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1863
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1612
1864
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1613
1865
|
method: "GET",
|
|
1614
1866
|
summary: "Get deployment logs",
|
|
@@ -1635,17 +1887,14 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1635
1887
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1636
1888
|
task_count: z.array(analyticsDataPointSchema)
|
|
1637
1889
|
});
|
|
1638
|
-
const getProjectAnalyticsContractV1 =
|
|
1890
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1639
1891
|
path: "/v1/analytics/{projectId}",
|
|
1640
1892
|
method: "GET",
|
|
1641
1893
|
summary: "Get project analytics",
|
|
1642
1894
|
description: "Get analytics data for a project over a time range",
|
|
1643
1895
|
tags: ["analytics"],
|
|
1644
1896
|
successDescription: "The project analytics data"
|
|
1645
|
-
}).errors({
|
|
1646
|
-
NOT_FOUND: {},
|
|
1647
|
-
BAD_REQUEST: {}
|
|
1648
|
-
}).input(z.object({
|
|
1897
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1649
1898
|
projectId: z.string().describe("The ID of the project"),
|
|
1650
1899
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1651
1900
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
@@ -1660,7 +1909,7 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1660
1909
|
}),
|
|
1661
1910
|
timeSeries: analyticsTimeSeriesSchema
|
|
1662
1911
|
}));
|
|
1663
|
-
const listTeamsContractV1 =
|
|
1912
|
+
const listTeamsContractV1 = base.route({
|
|
1664
1913
|
path: "/v1/teams",
|
|
1665
1914
|
method: "GET",
|
|
1666
1915
|
summary: "List teams",
|
|
@@ -1673,7 +1922,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1673
1922
|
createdAt: z.coerce.date(),
|
|
1674
1923
|
hasStripeAccount: z.boolean()
|
|
1675
1924
|
})));
|
|
1676
|
-
const
|
|
1925
|
+
const getTeamUsageContractV1 = base.route({
|
|
1926
|
+
path: "/v1/teams/{teamId}/usage",
|
|
1927
|
+
method: "GET",
|
|
1928
|
+
summary: "Get team usage",
|
|
1929
|
+
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.",
|
|
1930
|
+
tags: ["teams"],
|
|
1931
|
+
successDescription: "The current billing window usage"
|
|
1932
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
1933
|
+
teamId: z.string(),
|
|
1934
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
1935
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
1936
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
1937
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
1938
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
1939
|
+
}));
|
|
1940
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1677
1941
|
path: "/v1/tunnels/ticket",
|
|
1678
1942
|
method: "GET",
|
|
1679
1943
|
summary: "Get a tunnel ticket",
|
|
@@ -1685,16 +1949,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1685
1949
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1686
1950
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1687
1951
|
}));
|
|
1688
|
-
const publishServerContractV1 =
|
|
1952
|
+
const publishServerContractV1 = base.route({
|
|
1689
1953
|
path: "/v1/distribution/publish",
|
|
1690
1954
|
method: "POST",
|
|
1691
1955
|
summary: "Publish a server to the MCP registry",
|
|
1692
1956
|
tags: ["distribution"],
|
|
1693
1957
|
successDescription: "The server has been published successfully"
|
|
1694
|
-
}).errors({
|
|
1695
|
-
NOT_FOUND: {},
|
|
1696
|
-
BAD_REQUEST: {}
|
|
1697
|
-
}).input(z.object({
|
|
1958
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1698
1959
|
projectId: z.string(),
|
|
1699
1960
|
domain: z.string(),
|
|
1700
1961
|
title: z.string().min(1).max(100),
|
|
@@ -1703,17 +1964,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1703
1964
|
iconSrc: z.url().max(255).optional(),
|
|
1704
1965
|
dryRun: z.boolean().optional()
|
|
1705
1966
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1706
|
-
const getServerInfoContractV1 =
|
|
1967
|
+
const getServerInfoContractV1 = base.route({
|
|
1707
1968
|
path: "/v1/distribution/get",
|
|
1708
1969
|
method: "GET",
|
|
1709
1970
|
summary: "Get server info",
|
|
1710
1971
|
description: "Get info about a server",
|
|
1711
1972
|
tags: ["distribution"],
|
|
1712
1973
|
successDescription: "The server info"
|
|
1713
|
-
}).errors({
|
|
1714
|
-
NOT_FOUND: {},
|
|
1715
|
-
BAD_REQUEST: {}
|
|
1716
|
-
}).input(z.object({
|
|
1974
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1717
1975
|
projectId: z.string(),
|
|
1718
1976
|
domain: z.string()
|
|
1719
1977
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1732,7 +1990,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1732
1990
|
isPlaygroundEnabled: z.boolean(),
|
|
1733
1991
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1734
1992
|
});
|
|
1735
|
-
const getPlaygroundContractV1 =
|
|
1993
|
+
const getPlaygroundContractV1 = base.route({
|
|
1736
1994
|
path: "/v1/environments/{environmentId}/playground",
|
|
1737
1995
|
method: "GET",
|
|
1738
1996
|
summary: "Get playground configuration",
|
|
@@ -1740,17 +1998,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1740
1998
|
tags: ["environments"],
|
|
1741
1999
|
successDescription: "The playground configuration"
|
|
1742
2000
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1743
|
-
const upsertPlaygroundContractV1 =
|
|
2001
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1744
2002
|
path: "/v1/environments/{environmentId}/playground",
|
|
1745
2003
|
method: "PUT",
|
|
1746
2004
|
summary: "Update playground configuration",
|
|
1747
2005
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1748
2006
|
tags: ["environments"],
|
|
1749
2007
|
successDescription: "The updated playground configuration"
|
|
1750
|
-
}).errors({
|
|
1751
|
-
NOT_FOUND: {},
|
|
1752
|
-
BAD_REQUEST: {}
|
|
1753
|
-
}).input(z.object({
|
|
2008
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1754
2009
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1755
2010
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1756
2011
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1758,7 +2013,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1758
2013
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1759
2014
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1760
2015
|
})).output(playgroundOutputSchema);
|
|
1761
|
-
const createBeaconContractV1 =
|
|
2016
|
+
const createBeaconContractV1 = base.route({
|
|
1762
2017
|
path: "/v1/beacon/audits",
|
|
1763
2018
|
method: "POST",
|
|
1764
2019
|
summary: "Create a beacon audit",
|
|
@@ -1767,7 +2022,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1767
2022
|
successDescription: "The audit has been created"
|
|
1768
2023
|
}).errors({
|
|
1769
2024
|
NOT_FOUND: {},
|
|
1770
|
-
BAD_REQUEST: {},
|
|
1771
2025
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1772
2026
|
}).input(z.object({
|
|
1773
2027
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1775,7 +2029,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1775
2029
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1776
2030
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1777
2031
|
})).output(z.object({ id: z.string() }));
|
|
1778
|
-
const getBeaconContractV1 =
|
|
2032
|
+
const getBeaconContractV1 = base.route({
|
|
1779
2033
|
path: "/v1/beacon/audits/{auditId}",
|
|
1780
2034
|
method: "GET",
|
|
1781
2035
|
summary: "Get a beacon audit",
|
|
@@ -1791,7 +2045,10 @@ const getBeaconContractV1 = oc.route({
|
|
|
1791
2045
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1792
2046
|
}));
|
|
1793
2047
|
const contract = {
|
|
1794
|
-
teams: {
|
|
2048
|
+
teams: {
|
|
2049
|
+
list: { v1: listTeamsContractV1 },
|
|
2050
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2051
|
+
},
|
|
1795
2052
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
1796
2053
|
deployments: {
|
|
1797
2054
|
list: { v1: listDeploymentsContractV1 },
|
|
@@ -1833,5 +2090,10 @@ const contract = {
|
|
|
1833
2090
|
get: { v1: getBeaconContractV1 }
|
|
1834
2091
|
}
|
|
1835
2092
|
};
|
|
2093
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2094
|
+
const contractForDocs = {
|
|
2095
|
+
...contract,
|
|
2096
|
+
deployments: deploymentsForDocs
|
|
2097
|
+
};
|
|
1836
2098
|
//#endregion
|
|
1837
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2099
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|