@alpic-ai/api 0.0.0-dev.gec0fcf0 → 0.0.0-dev.gec52777
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 +1534 -59
- package/dist/index.mjs +684 -202
- package/package.json +24 -8
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,22 @@ 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
|
+
"cato",
|
|
183
|
+
"cloudflare",
|
|
184
|
+
"fastly"
|
|
185
|
+
];
|
|
186
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
187
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
188
|
const auditStatusSchema = z.enum([
|
|
178
189
|
"pending",
|
|
179
190
|
"partial",
|
|
@@ -246,6 +257,25 @@ z.object({
|
|
|
246
257
|
clientSecret: z.string(),
|
|
247
258
|
clientScopes: z.array(z.string())
|
|
248
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
249
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
250
280
|
"ongoing",
|
|
251
281
|
"deployed",
|
|
@@ -273,34 +303,51 @@ const deploymentSummarySchema = z.object({
|
|
|
273
303
|
createdAt: z.coerce.date(),
|
|
274
304
|
updatedAt: z.coerce.date()
|
|
275
305
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
306
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
307
|
const publicEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.literal(true),
|
|
309
|
+
oAuthMetadata: z.strictObject({})
|
|
310
|
+
});
|
|
311
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
312
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
313
|
+
allowsAnonymous: z.boolean(),
|
|
314
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
315
|
+
scope: z.string().optional()
|
|
316
|
+
});
|
|
317
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
318
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
319
|
+
allowsAnonymous: z.boolean(),
|
|
320
|
+
oAuthMetadata: z.object({
|
|
321
|
+
externalAuthorizationServerUrl: z.url(),
|
|
322
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
323
|
+
}),
|
|
324
|
+
scope: z.string().optional()
|
|
325
|
+
});
|
|
326
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
|
+
const standaloneEnvironmentSchema = z.object({
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
329
|
+
oAuthMetadata: z.object({
|
|
330
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
331
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
332
|
+
}),
|
|
333
|
+
scope: z.string().optional()
|
|
334
|
+
});
|
|
335
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
336
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
337
|
+
allowsAnonymous: z.literal(false),
|
|
338
|
+
oAuthMetadata: z.strictObject({}),
|
|
339
|
+
scope: z.string().optional()
|
|
340
|
+
});
|
|
341
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
342
|
isPublic: z.literal(true),
|
|
283
343
|
oAuthMetadata: z.undefined().optional()
|
|
284
344
|
});
|
|
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({
|
|
345
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
346
|
isPublic: z.literal(false),
|
|
293
347
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
348
|
scope: z.string().optional()
|
|
295
349
|
});
|
|
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({
|
|
350
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
351
|
isPublic: z.literal(false),
|
|
305
352
|
oAuthMetadata: z.object({
|
|
306
353
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +355,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
355
|
}),
|
|
309
356
|
scope: z.string().optional()
|
|
310
357
|
});
|
|
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({
|
|
358
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
359
|
isPublic: z.literal(false),
|
|
319
360
|
oAuthMetadata: z.object({
|
|
320
361
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +363,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
363
|
}),
|
|
323
364
|
scope: z.string().optional()
|
|
324
365
|
});
|
|
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({
|
|
366
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
367
|
isPublic: z.literal(false),
|
|
334
368
|
oAuthMetadata: z.strictObject({}),
|
|
335
369
|
scope: z.string().optional()
|
|
@@ -339,9 +373,19 @@ z.union([
|
|
|
339
373
|
externalResourceMetadataEnvironmentSchema,
|
|
340
374
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
375
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
376
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
377
|
+
legacyPublicEnvironmentSchema,
|
|
378
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
379
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
380
|
+
legacyStandaloneEnvironmentSchema,
|
|
381
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
382
|
+
]);
|
|
383
|
+
const playgroundModelSchema = z.enum([
|
|
384
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
385
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
386
|
+
"openai.gpt-5.4",
|
|
387
|
+
"openai.gpt-5.5"
|
|
343
388
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
389
|
const environmentDomainSchema = z.object({
|
|
346
390
|
name: z.string(),
|
|
347
391
|
status: z.enum([
|
|
@@ -361,6 +405,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
405
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
406
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
407
|
isPlaygroundEnabled: z.boolean(),
|
|
408
|
+
playgroundModel: playgroundModelSchema,
|
|
364
409
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
410
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
411
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -373,14 +418,17 @@ z.object({
|
|
|
373
418
|
sessionReplayEnabled: z.boolean(),
|
|
374
419
|
collectRequestPayload: z.boolean(),
|
|
375
420
|
collectResponsePayload: z.boolean(),
|
|
376
|
-
collectErrorMessage: z.boolean()
|
|
421
|
+
collectErrorMessage: z.boolean(),
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
377
424
|
});
|
|
378
|
-
z.object({
|
|
425
|
+
const feedbackSchema = z.object({
|
|
379
426
|
id: z.string(),
|
|
380
427
|
createdAt: z.coerce.date(),
|
|
381
428
|
environmentId: z.string(),
|
|
382
429
|
content: z.string(),
|
|
383
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
384
432
|
});
|
|
385
433
|
z.object({
|
|
386
434
|
content: z.string(),
|
|
@@ -396,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
396
444
|
"pink",
|
|
397
445
|
"gray"
|
|
398
446
|
]);
|
|
399
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
400
448
|
const intentCategorySchema = z.object({
|
|
401
449
|
id: z.string(),
|
|
402
450
|
createdAt: z.coerce.date(),
|
|
@@ -404,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
404
452
|
name: z.string(),
|
|
405
453
|
color: intentCategoryColorSchema
|
|
406
454
|
});
|
|
407
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
408
456
|
id: z.string(),
|
|
409
457
|
name: z.string(),
|
|
410
458
|
color: intentCategoryColorSchema,
|
|
@@ -416,6 +464,7 @@ z.object({
|
|
|
416
464
|
environmentId: z.string(),
|
|
417
465
|
toolName: z.string(),
|
|
418
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
419
468
|
categories: z.array(intentCategorySchema)
|
|
420
469
|
});
|
|
421
470
|
const signalCategorySchema = z.object({
|
|
@@ -474,12 +523,262 @@ z.object({
|
|
|
474
523
|
createdAt: z.coerce.date(),
|
|
475
524
|
updatedAt: z.coerce.date()
|
|
476
525
|
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
477
536
|
z.enum([
|
|
478
537
|
"INFO",
|
|
479
538
|
"WARNING",
|
|
480
539
|
"DEBUG",
|
|
481
540
|
"ERROR"
|
|
482
541
|
]);
|
|
542
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
|
+
const MCP_CLIENT_GROUPS = [
|
|
544
|
+
{
|
|
545
|
+
id: "claude_code",
|
|
546
|
+
label: "Claude Code",
|
|
547
|
+
vendor: "anthropic",
|
|
548
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
id: "claude",
|
|
552
|
+
label: "Claude",
|
|
553
|
+
vendor: "anthropic",
|
|
554
|
+
rawNames: [
|
|
555
|
+
"Anthropic/ClaudeAI",
|
|
556
|
+
"claude-ai",
|
|
557
|
+
"claude",
|
|
558
|
+
"Claude",
|
|
559
|
+
"claude-desktop",
|
|
560
|
+
"claude-desktop-3p"
|
|
561
|
+
]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "claude_mobile",
|
|
565
|
+
label: "Claude mobile",
|
|
566
|
+
vendor: "anthropic",
|
|
567
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
id: "claude_cowork",
|
|
571
|
+
label: "Claude Cowork",
|
|
572
|
+
vendor: "anthropic",
|
|
573
|
+
rawNames: ["Anthropic/Cowork"]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "claude_toolbox",
|
|
577
|
+
label: "Claude Toolbox",
|
|
578
|
+
vendor: "anthropic",
|
|
579
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "anthropic_api",
|
|
583
|
+
label: "Anthropic API",
|
|
584
|
+
vendor: "anthropic",
|
|
585
|
+
rawNames: ["Anthropic/API"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "anthropic_connector_refresh",
|
|
589
|
+
label: "Anthropic (connector refresh)",
|
|
590
|
+
vendor: "anthropic",
|
|
591
|
+
rawNames: ["Anthropic"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "codex",
|
|
595
|
+
label: "Codex",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: [
|
|
598
|
+
"codex-mcp-client",
|
|
599
|
+
"codex",
|
|
600
|
+
"Codex",
|
|
601
|
+
"codex-cli",
|
|
602
|
+
"openai-mcp (Codex)"
|
|
603
|
+
]
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
id: "chatgpt",
|
|
607
|
+
label: "ChatGPT",
|
|
608
|
+
vendor: "openai",
|
|
609
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
id: "openai_responses_api",
|
|
613
|
+
label: "OpenAI Responses API",
|
|
614
|
+
vendor: "openai",
|
|
615
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
id: "openai_agent_builder",
|
|
619
|
+
label: "OpenAI Agent Builder",
|
|
620
|
+
vendor: "openai",
|
|
621
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
id: "openai_other",
|
|
625
|
+
label: "OpenAI Other",
|
|
626
|
+
vendor: "openai",
|
|
627
|
+
rawNames: ["openai-mcp"]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cursor",
|
|
631
|
+
label: "Cursor",
|
|
632
|
+
vendor: "cursor",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"cursor-vscode",
|
|
635
|
+
"Cursor",
|
|
636
|
+
"cursor"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "cline",
|
|
641
|
+
label: "Cline",
|
|
642
|
+
vendor: "cline",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Cline",
|
|
645
|
+
"cline",
|
|
646
|
+
"@cline/core"
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
id: "github_copilot",
|
|
651
|
+
label: "GitHub Copilot",
|
|
652
|
+
vendor: "githubCopilot",
|
|
653
|
+
rawNames: [
|
|
654
|
+
"Copilot",
|
|
655
|
+
"github-copilot-developer",
|
|
656
|
+
"Copilot MCP Gateway",
|
|
657
|
+
"Xcode/copilot-xcode"
|
|
658
|
+
]
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
id: "gemini_cli",
|
|
662
|
+
label: "Gemini CLI",
|
|
663
|
+
vendor: "google",
|
|
664
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "antigravity",
|
|
668
|
+
label: "Antigravity",
|
|
669
|
+
vendor: "google",
|
|
670
|
+
rawNames: ["antigravity-client"]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "gemini",
|
|
674
|
+
label: "Gemini",
|
|
675
|
+
vendor: "google",
|
|
676
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
id: "windsurf",
|
|
680
|
+
label: "Windsurf",
|
|
681
|
+
vendor: "windsurf",
|
|
682
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
id: "mistral",
|
|
686
|
+
label: "Mistral / Le Chat",
|
|
687
|
+
vendor: "mistral",
|
|
688
|
+
rawNames: ["Mistral"],
|
|
689
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "n8n",
|
|
693
|
+
label: "n8n",
|
|
694
|
+
vendor: "n8n",
|
|
695
|
+
rawNames: [
|
|
696
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
698
|
+
"n8n"
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "alpic_playground",
|
|
703
|
+
label: "Alpic Playground",
|
|
704
|
+
vendor: "alpic",
|
|
705
|
+
rawNames: ["alpic-playground", "playground"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "opencode",
|
|
709
|
+
label: "opencode",
|
|
710
|
+
vendor: "opencode",
|
|
711
|
+
rawNames: ["opencode"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "zed",
|
|
715
|
+
label: "Zed",
|
|
716
|
+
vendor: "zed",
|
|
717
|
+
rawNames: ["Zed", "zed"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "zapier",
|
|
721
|
+
label: "Zapier",
|
|
722
|
+
vendor: "zapier",
|
|
723
|
+
rawNames: ["Zapier", "zapier"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "make",
|
|
727
|
+
label: "Make",
|
|
728
|
+
vendor: "make",
|
|
729
|
+
rawNames: ["Make", "make"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "librechat",
|
|
733
|
+
label: "LibreChat",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["LibreChat", "librechat"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "jan",
|
|
739
|
+
label: "Jan",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: ["Jan", "jan"]
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
id: "goose",
|
|
745
|
+
label: "goose",
|
|
746
|
+
vendor: "mcp",
|
|
747
|
+
rawNames: ["goose", "Goose"]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
id: "mcphost",
|
|
751
|
+
label: "mcphost",
|
|
752
|
+
vendor: "mcp",
|
|
753
|
+
rawNames: ["mcphost"]
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
id: "mcporter",
|
|
757
|
+
label: "mcporter",
|
|
758
|
+
vendor: "mcp",
|
|
759
|
+
rawNames: ["mcporter"]
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
id: "rmcp",
|
|
763
|
+
label: "rmcp",
|
|
764
|
+
vendor: "mcp",
|
|
765
|
+
rawNames: ["rmcp"]
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
id: "unnamed_client",
|
|
769
|
+
label: "Unnamed client",
|
|
770
|
+
vendor: "mcp",
|
|
771
|
+
rawNames: [
|
|
772
|
+
"mcp",
|
|
773
|
+
"unknown",
|
|
774
|
+
""
|
|
775
|
+
]
|
|
776
|
+
}
|
|
777
|
+
];
|
|
778
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
779
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
780
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
781
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
483
782
|
const runtimeSchema = z.enum([
|
|
484
783
|
"python3.13",
|
|
485
784
|
"python3.14",
|
|
@@ -508,6 +807,12 @@ z.object({
|
|
|
508
807
|
environments: z.array(environmentWithDomainsSchema),
|
|
509
808
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
510
809
|
});
|
|
810
|
+
const domainFailureReasonSchema = z.enum([
|
|
811
|
+
"caa",
|
|
812
|
+
"dns",
|
|
813
|
+
"invalid_domain",
|
|
814
|
+
"other"
|
|
815
|
+
]);
|
|
511
816
|
const projectDomainMappingSchema = z.object({
|
|
512
817
|
pathPrefix: z.string(),
|
|
513
818
|
environment: environmentSchema$1
|
|
@@ -520,6 +825,8 @@ z.object({
|
|
|
520
825
|
"deployed",
|
|
521
826
|
"failed"
|
|
522
827
|
]),
|
|
828
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
829
|
+
environment: environmentSchema$1,
|
|
523
830
|
mappings: z.array(projectDomainMappingSchema)
|
|
524
831
|
});
|
|
525
832
|
const serverFieldsSchema$1 = z.object({
|
|
@@ -549,15 +856,7 @@ z.object({
|
|
|
549
856
|
serverFields: serverFieldsSchema$1,
|
|
550
857
|
source: z.enum(["registry", "defaults"])
|
|
551
858
|
});
|
|
552
|
-
/**
|
|
553
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
554
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
555
|
-
*
|
|
556
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
557
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
558
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
559
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
560
|
-
*/
|
|
859
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
561
860
|
const clampStringField = (field) => {
|
|
562
861
|
const max = field.maxLength;
|
|
563
862
|
if (max === null) return field;
|
|
@@ -584,8 +883,9 @@ const positiveTestCaseSchema = z.object({
|
|
|
584
883
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
585
884
|
const screenshotEntrySchema = z.object({
|
|
586
885
|
prompt: z.string(),
|
|
587
|
-
url: z.url()
|
|
886
|
+
url: z.url()
|
|
588
887
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
888
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
589
889
|
/** Accepts either a valid email or URL. */
|
|
590
890
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
591
891
|
/** A URL field whose error spells out that the scheme is required. */
|
|
@@ -902,11 +1202,7 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
902
1202
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
903
1203
|
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
904
1204
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
905
|
-
/**
|
|
906
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
907
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
908
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
909
|
-
*/
|
|
1205
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
910
1206
|
const chatgptTaglineSchema = z.string().max(30);
|
|
911
1207
|
const chatgptDescriptionSchema = z.string();
|
|
912
1208
|
const chatgptTranslationSchema = z.object({
|
|
@@ -915,10 +1211,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
915
1211
|
description: chatgptDescriptionSchema
|
|
916
1212
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
917
1213
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
918
|
-
/**
|
|
919
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
920
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
921
|
-
*/
|
|
1214
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
922
1215
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
923
1216
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
924
1217
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
@@ -944,6 +1237,17 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
944
1237
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
945
1238
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
946
1239
|
});
|
|
1240
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1241
|
+
tagline: z.string().optional(),
|
|
1242
|
+
companyUrl: z.string().optional(),
|
|
1243
|
+
supportChannel: z.string().optional(),
|
|
1244
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1245
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1246
|
+
demoRecordingUrl: z.string().optional(),
|
|
1247
|
+
serverUrl: z.string().optional(),
|
|
1248
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1249
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1250
|
+
});
|
|
947
1251
|
chatgptSubmissionFormDataSchema.pick({
|
|
948
1252
|
appName: true,
|
|
949
1253
|
developerName: true,
|
|
@@ -1004,11 +1308,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1004
1308
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1005
1309
|
"Public documentation for this connector will be live by the publish date."
|
|
1006
1310
|
]);
|
|
1007
|
-
/**
|
|
1008
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1009
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1010
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1011
|
-
*/
|
|
1311
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1012
1312
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1013
1313
|
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1014
1314
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1022,8 +1322,8 @@ phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects i
|
|
|
1022
1322
|
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
|
|
1023
1323
|
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1024
1324
|
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1025
|
-
iconUrl: z.url().optional().describe(`Optional custom icon
|
|
1026
|
-
|
|
1325
|
+
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
|
|
1326
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1027
1327
|
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1028
1328
|
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1029
1329
|
by your publish date.`),
|
|
@@ -1031,6 +1331,8 @@ by your publish date.`),
|
|
|
1031
1331
|
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1032
1332
|
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1033
1333
|
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1334
|
+
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
|
|
1335
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1034
1336
|
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1035
1337
|
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1036
1338
|
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
@@ -1068,6 +1370,21 @@ fully populated account.`),
|
|
|
1068
1370
|
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1069
1371
|
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1070
1372
|
});
|
|
1373
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1374
|
+
serverUrl: z.string().optional(),
|
|
1375
|
+
name: z.string().optional(),
|
|
1376
|
+
slug: z.string().optional(),
|
|
1377
|
+
oneLiner: z.string().optional(),
|
|
1378
|
+
description: z.string().optional(),
|
|
1379
|
+
iconUrl: z.string().optional(),
|
|
1380
|
+
documentation: z.string().optional(),
|
|
1381
|
+
support: z.string().optional(),
|
|
1382
|
+
privacyPolicy: z.string().optional(),
|
|
1383
|
+
companyWebsite: z.string().optional(),
|
|
1384
|
+
primaryContactEmail: z.string().optional(),
|
|
1385
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1386
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1387
|
+
});
|
|
1071
1388
|
claudeSubmissionFormDataSchema.pick({
|
|
1072
1389
|
serverUrl: true,
|
|
1073
1390
|
name: true,
|
|
@@ -1083,12 +1400,7 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1083
1400
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1084
1401
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1085
1402
|
});
|
|
1086
|
-
/**
|
|
1087
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1088
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1089
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1090
|
-
* colocated with the Claude contract.
|
|
1091
|
-
*/
|
|
1403
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1092
1404
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1093
1405
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1094
1406
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
@@ -1108,14 +1420,19 @@ const submissionMetaFieldsSchema = z.object({
|
|
|
1108
1420
|
});
|
|
1109
1421
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1110
1422
|
platform: z.literal("claudeai"),
|
|
1111
|
-
formData:
|
|
1423
|
+
formData: claudeSubmissionDraftSchema
|
|
1112
1424
|
});
|
|
1113
1425
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1114
1426
|
platform: z.literal("chatgpt"),
|
|
1115
|
-
formData:
|
|
1427
|
+
formData: chatgptSubmissionDraftSchema
|
|
1116
1428
|
});
|
|
1117
1429
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1118
|
-
z.union([
|
|
1430
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1431
|
+
z.literal([
|
|
1432
|
+
100,
|
|
1433
|
+
75,
|
|
1434
|
+
50
|
|
1435
|
+
]);
|
|
1119
1436
|
const subscriptionPlanSchema = z.enum([
|
|
1120
1437
|
"pro",
|
|
1121
1438
|
"business",
|
|
@@ -1127,17 +1444,70 @@ const customerCreditsSchema = z.object({
|
|
|
1127
1444
|
expiresAt: z.number().nullable(),
|
|
1128
1445
|
currency: z.string()
|
|
1129
1446
|
});
|
|
1130
|
-
const customerUsageSchema = z.object({
|
|
1131
|
-
amountInCents: z.number(),
|
|
1132
|
-
currency: z.string(),
|
|
1133
|
-
periodEnd: z.number()
|
|
1134
|
-
});
|
|
1135
1447
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1136
1448
|
z.object({
|
|
1137
1449
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1138
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1139
1450
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1140
1451
|
});
|
|
1452
|
+
const metricsQueueEventSchema = z.object({
|
|
1453
|
+
ts: z.number().int(),
|
|
1454
|
+
method: z.string(),
|
|
1455
|
+
tool: z.string().nullable(),
|
|
1456
|
+
client: z.string(),
|
|
1457
|
+
sessionId: z.string().nullable(),
|
|
1458
|
+
durationMs: z.number().int(),
|
|
1459
|
+
outputTokens: z.number().int().nullable(),
|
|
1460
|
+
errorType: z.enum([
|
|
1461
|
+
"mcp_error",
|
|
1462
|
+
"tool_error",
|
|
1463
|
+
"timeout"
|
|
1464
|
+
]).nullable(),
|
|
1465
|
+
errorCode: z.number().int().nullable()
|
|
1466
|
+
});
|
|
1467
|
+
z.object({
|
|
1468
|
+
v: z.literal(1),
|
|
1469
|
+
envId: z.string(),
|
|
1470
|
+
events: z.array(metricsQueueEventSchema)
|
|
1471
|
+
});
|
|
1472
|
+
z.object({ v: z.number() });
|
|
1473
|
+
const telemetrySignalSchema = z.enum([
|
|
1474
|
+
"logs",
|
|
1475
|
+
"metrics",
|
|
1476
|
+
"traces"
|
|
1477
|
+
]);
|
|
1478
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1479
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1480
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1481
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1482
|
+
const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
|
|
1483
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1484
|
+
id: z.string(),
|
|
1485
|
+
name: otlpHeaderNameSchema,
|
|
1486
|
+
value: otlpHeaderValueSchema,
|
|
1487
|
+
isSecret: z.boolean()
|
|
1488
|
+
});
|
|
1489
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1490
|
+
"credentials",
|
|
1491
|
+
"wrong-path",
|
|
1492
|
+
"wrong-protocol",
|
|
1493
|
+
"invalid-payload",
|
|
1494
|
+
"partial-rejection",
|
|
1495
|
+
"blocked-target",
|
|
1496
|
+
"timeout",
|
|
1497
|
+
"unreachable",
|
|
1498
|
+
"receiver-error",
|
|
1499
|
+
"unexpected-status"
|
|
1500
|
+
]);
|
|
1501
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1502
|
+
z.object({
|
|
1503
|
+
id: z.string(),
|
|
1504
|
+
signal: telemetrySignalSchema,
|
|
1505
|
+
endpoint: otlpEndpointSchema,
|
|
1506
|
+
protocol: otlpProtocolSchema,
|
|
1507
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1508
|
+
status: telemetryDestinationStatusSchema,
|
|
1509
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1510
|
+
});
|
|
1141
1511
|
//#endregion
|
|
1142
1512
|
//#region src/auth-scope.ts
|
|
1143
1513
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1180,7 +1550,10 @@ const RESERVED_KEYS = [
|
|
|
1180
1550
|
"BUILD_ARG_START_COMMAND",
|
|
1181
1551
|
"ALPIC_HOST",
|
|
1182
1552
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1183
|
-
"ALPIC_INTENT_META_KEY"
|
|
1553
|
+
"ALPIC_INTENT_META_KEY",
|
|
1554
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1555
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1556
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1184
1557
|
];
|
|
1185
1558
|
const environmentVariableSchema = z.object({
|
|
1186
1559
|
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,21 +1634,20 @@ const deploymentSchema = z.object({
|
|
|
1261
1634
|
isCurrent: z.boolean(),
|
|
1262
1635
|
deploymentPageUrl: z.url().nullable()
|
|
1263
1636
|
});
|
|
1264
|
-
const
|
|
1637
|
+
const isValidTimeInput = (value) => {
|
|
1265
1638
|
if (ms(value) !== void 0) return true;
|
|
1266
1639
|
return !Number.isNaN(new Date(value).getTime());
|
|
1267
1640
|
};
|
|
1268
|
-
const
|
|
1641
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1642
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1643
|
+
const createEnvironmentContractV1 = base.route({
|
|
1269
1644
|
path: "/v1/environments",
|
|
1270
1645
|
method: "POST",
|
|
1271
1646
|
summary: "Create an environment",
|
|
1272
1647
|
description: "Create an environment for a project",
|
|
1273
1648
|
tags: ["environments"],
|
|
1274
1649
|
successDescription: "The environment has been created successfully"
|
|
1275
|
-
}).errors({
|
|
1276
|
-
NOT_FOUND: {},
|
|
1277
|
-
BAD_REQUEST: {}
|
|
1278
|
-
}).input(z.object({
|
|
1650
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1279
1651
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1280
1652
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1281
1653
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1288,7 +1660,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1288
1660
|
createdAt: z.coerce.date(),
|
|
1289
1661
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1290
1662
|
}));
|
|
1291
|
-
const getEnvironmentContractV1 =
|
|
1663
|
+
const getEnvironmentContractV1 = base.route({
|
|
1292
1664
|
path: "/v1/environments/{environmentId}",
|
|
1293
1665
|
method: "GET",
|
|
1294
1666
|
summary: "Get an environment",
|
|
@@ -1345,7 +1717,7 @@ const projectOutputSchema = z.object({
|
|
|
1345
1717
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1346
1718
|
environments: z.array(environmentSchema)
|
|
1347
1719
|
});
|
|
1348
|
-
const getProjectContractV1 =
|
|
1720
|
+
const getProjectContractV1 = base.route({
|
|
1349
1721
|
path: "/v1/projects/{projectId}",
|
|
1350
1722
|
method: "GET",
|
|
1351
1723
|
summary: "Get a project",
|
|
@@ -1353,18 +1725,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1353
1725
|
tags: ["projects"],
|
|
1354
1726
|
successDescription: "The project details"
|
|
1355
1727
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1356
|
-
const listProjectsContractV1 =
|
|
1728
|
+
const listProjectsContractV1 = base.route({
|
|
1357
1729
|
path: "/v1/projects",
|
|
1358
1730
|
method: "GET",
|
|
1359
1731
|
summary: "List projects",
|
|
1360
1732
|
description: "List all projects for a team",
|
|
1361
1733
|
tags: ["projects"],
|
|
1362
1734
|
successDescription: "The list of projects"
|
|
1363
|
-
}).errors({
|
|
1364
|
-
|
|
1365
|
-
BAD_REQUEST: {}
|
|
1366
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1367
|
-
const createProjectContractV1 = oc.route({
|
|
1735
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1736
|
+
const createProjectContractV1 = base.route({
|
|
1368
1737
|
path: "/v1/projects",
|
|
1369
1738
|
method: "POST",
|
|
1370
1739
|
summary: "Create a project",
|
|
@@ -1373,7 +1742,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1373
1742
|
successDescription: "The project has been created successfully"
|
|
1374
1743
|
}).errors({
|
|
1375
1744
|
NOT_FOUND: {},
|
|
1376
|
-
BAD_REQUEST: {},
|
|
1377
1745
|
FORBIDDEN: {}
|
|
1378
1746
|
}).input(z.object({
|
|
1379
1747
|
teamId: z.string().optional(),
|
|
@@ -1414,7 +1782,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1414
1782
|
isSecret: z.boolean(),
|
|
1415
1783
|
createdAt: z.coerce.date()
|
|
1416
1784
|
});
|
|
1417
|
-
const listEnvironmentVariablesContractV1 =
|
|
1785
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1418
1786
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1419
1787
|
method: "GET",
|
|
1420
1788
|
summary: "List environment variables",
|
|
@@ -1422,48 +1790,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1422
1790
|
tags: ["environments"],
|
|
1423
1791
|
successDescription: "The list of environment variables"
|
|
1424
1792
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1425
|
-
const createEnvironmentVariablesContractV1 =
|
|
1793
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1426
1794
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1427
1795
|
method: "POST",
|
|
1428
1796
|
summary: "Add environment variables",
|
|
1429
1797
|
description: "Add one or more environment variables to an environment",
|
|
1430
1798
|
tags: ["environments"],
|
|
1431
1799
|
successDescription: "The environment variables have been added successfully"
|
|
1432
|
-
}).errors({
|
|
1433
|
-
NOT_FOUND: {},
|
|
1434
|
-
BAD_REQUEST: {}
|
|
1435
|
-
}).input(z.object({
|
|
1800
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1436
1801
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1437
1802
|
environmentVariables: environmentVariablesSchema
|
|
1438
1803
|
})).output(z.object({ success: z.literal(true) }));
|
|
1439
|
-
const updateEnvironmentVariableContractV1 =
|
|
1804
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1440
1805
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1441
1806
|
method: "PATCH",
|
|
1442
1807
|
summary: "Update an environment variable",
|
|
1443
1808
|
description: "Update an environment variable by ID",
|
|
1444
1809
|
tags: ["environments"],
|
|
1445
1810
|
successDescription: "The environment variable has been updated successfully"
|
|
1446
|
-
}).errors({
|
|
1447
|
-
NOT_FOUND: {},
|
|
1448
|
-
BAD_REQUEST: {}
|
|
1449
|
-
}).input(z.object({
|
|
1811
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1450
1812
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1451
1813
|
key: environmentVariableSchema.shape.key,
|
|
1452
1814
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1453
1815
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1454
1816
|
})).output(z.object({ success: z.literal(true) }));
|
|
1455
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1817
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1456
1818
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1457
1819
|
method: "DELETE",
|
|
1458
1820
|
summary: "Delete an environment variable",
|
|
1459
1821
|
description: "Delete an environment variable by ID",
|
|
1460
1822
|
tags: ["environments"],
|
|
1461
1823
|
successDescription: "The environment variable has been deleted successfully"
|
|
1462
|
-
}).errors({
|
|
1463
|
-
|
|
1464
|
-
BAD_REQUEST: {}
|
|
1465
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1466
|
-
const deleteProjectContractV1 = oc.route({
|
|
1824
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1825
|
+
const deleteProjectContractV1 = base.route({
|
|
1467
1826
|
path: "/v1/projects/{projectId}",
|
|
1468
1827
|
method: "DELETE",
|
|
1469
1828
|
summary: "Delete a project",
|
|
@@ -1471,7 +1830,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1471
1830
|
tags: ["projects"],
|
|
1472
1831
|
successDescription: "The project has been deleted successfully"
|
|
1473
1832
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1474
|
-
const updateProjectContractV1 =
|
|
1833
|
+
const updateProjectContractV1 = base.route({
|
|
1475
1834
|
path: "/v1/projects/{projectId}",
|
|
1476
1835
|
method: "PATCH",
|
|
1477
1836
|
summary: "Update a project",
|
|
@@ -1480,14 +1839,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1480
1839
|
successDescription: "The project has been updated successfully"
|
|
1481
1840
|
}).errors({
|
|
1482
1841
|
NOT_FOUND: {},
|
|
1483
|
-
BAD_REQUEST: {},
|
|
1484
1842
|
FORBIDDEN: {}
|
|
1485
1843
|
}).input(z.object({
|
|
1486
1844
|
projectId: z.string().describe("The ID of the project"),
|
|
1487
1845
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1488
1846
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1489
1847
|
})).output(projectOutputSchema);
|
|
1490
|
-
const deployEnvironmentContractV1 =
|
|
1848
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1491
1849
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1492
1850
|
method: "POST",
|
|
1493
1851
|
summary: "Deploy an environment",
|
|
@@ -1496,27 +1854,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1496
1854
|
successDescription: "The environment has been deployed successfully"
|
|
1497
1855
|
}).errors({
|
|
1498
1856
|
NOT_FOUND: {},
|
|
1499
|
-
|
|
1857
|
+
CONFLICT: {}
|
|
1500
1858
|
}).input(z.object({
|
|
1501
1859
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1502
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1860
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1861
|
+
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.")
|
|
1503
1862
|
})).output(deploymentSchema);
|
|
1504
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1863
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1505
1864
|
path: "/v1/deployments/upload",
|
|
1506
1865
|
method: "POST",
|
|
1507
1866
|
summary: "Upload deployment artifacts",
|
|
1508
1867
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1509
1868
|
tags: ["deployments"],
|
|
1510
1869
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1511
|
-
}).errors({
|
|
1512
|
-
NOT_FOUND: {},
|
|
1513
|
-
BAD_REQUEST: {}
|
|
1514
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1870
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1515
1871
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1516
1872
|
token: z.string().describe("Token to identify the source archive"),
|
|
1517
1873
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1518
1874
|
}));
|
|
1519
|
-
const listDeploymentsContractV1 =
|
|
1875
|
+
const listDeploymentsContractV1 = base.route({
|
|
1520
1876
|
path: "/v1/projects/{projectId}/deployments",
|
|
1521
1877
|
method: "GET",
|
|
1522
1878
|
summary: "List project deployments",
|
|
@@ -1528,7 +1884,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1528
1884
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1529
1885
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1530
1886
|
})).output(z.array(deploymentSchema));
|
|
1531
|
-
const getDeploymentContractV1 =
|
|
1887
|
+
const getDeploymentContractV1 = base.route({
|
|
1532
1888
|
path: "/v1/deployments/{deploymentId}",
|
|
1533
1889
|
method: "GET",
|
|
1534
1890
|
summary: "Get a deployment",
|
|
@@ -1536,20 +1892,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1536
1892
|
tags: ["deployments"],
|
|
1537
1893
|
successDescription: "The deployment details"
|
|
1538
1894
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1539
|
-
const
|
|
1895
|
+
const logEntrySchema = z.object({
|
|
1896
|
+
timestamp: z.coerce.date(),
|
|
1897
|
+
type: z.enum([
|
|
1898
|
+
"START",
|
|
1899
|
+
"END",
|
|
1900
|
+
"INFO",
|
|
1901
|
+
"ERROR",
|
|
1902
|
+
"WARNING",
|
|
1903
|
+
"DEBUG"
|
|
1904
|
+
]),
|
|
1905
|
+
requestId: z.string(),
|
|
1906
|
+
content: z.string().optional(),
|
|
1907
|
+
method: z.string().optional(),
|
|
1908
|
+
durationInMs: z.number().optional()
|
|
1909
|
+
});
|
|
1910
|
+
const getLogsContractV1 = base.route({
|
|
1540
1911
|
path: "/v1/environments/{environmentId}/logs",
|
|
1541
1912
|
method: "GET",
|
|
1542
1913
|
summary: "Get logs",
|
|
1543
1914
|
description: "Get logs for an environment",
|
|
1544
1915
|
tags: ["environments"],
|
|
1545
1916
|
successDescription: "The logs"
|
|
1546
|
-
}).errors({
|
|
1547
|
-
NOT_FOUND: {},
|
|
1548
|
-
BAD_REQUEST: {}
|
|
1549
|
-
}).input(z.object({
|
|
1917
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1550
1918
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1551
|
-
since:
|
|
1552
|
-
until:
|
|
1919
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1920
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1553
1921
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1554
1922
|
level: z.array(z.enum([
|
|
1555
1923
|
"INFO",
|
|
@@ -1560,34 +1928,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1560
1928
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1561
1929
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1562
1930
|
})).output(z.object({
|
|
1563
|
-
logs: z.array(
|
|
1564
|
-
timestamp: z.coerce.date(),
|
|
1565
|
-
type: z.enum([
|
|
1566
|
-
"START",
|
|
1567
|
-
"END",
|
|
1568
|
-
"INFO",
|
|
1569
|
-
"ERROR",
|
|
1570
|
-
"WARNING",
|
|
1571
|
-
"DEBUG"
|
|
1572
|
-
]),
|
|
1573
|
-
requestId: z.string(),
|
|
1574
|
-
content: z.string().optional(),
|
|
1575
|
-
method: z.string().optional(),
|
|
1576
|
-
durationInMs: z.number().optional()
|
|
1577
|
-
})),
|
|
1931
|
+
logs: z.array(logEntrySchema),
|
|
1578
1932
|
nextToken: z.string().nullable()
|
|
1579
1933
|
}));
|
|
1580
|
-
const getLatestLogsContractV1 =
|
|
1934
|
+
const getLatestLogsContractV1 = base.route({
|
|
1581
1935
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1582
1936
|
method: "GET",
|
|
1583
1937
|
summary: "Get latest logs",
|
|
1584
1938
|
description: "Get the N most recent logs for an environment",
|
|
1585
1939
|
tags: ["environments"],
|
|
1586
1940
|
successDescription: "The latest logs"
|
|
1587
|
-
}).errors({
|
|
1588
|
-
NOT_FOUND: {},
|
|
1589
|
-
BAD_REQUEST: {}
|
|
1590
|
-
}).input(z.object({
|
|
1941
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1591
1942
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1592
1943
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1593
1944
|
level: z.array(z.enum([
|
|
@@ -1597,22 +1948,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1597
1948
|
"DEBUG"
|
|
1598
1949
|
])).optional().describe("Filter by log level"),
|
|
1599
1950
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1600
|
-
})).output(z.object({ logs: z.array(
|
|
1601
|
-
|
|
1602
|
-
type: z.enum([
|
|
1603
|
-
"START",
|
|
1604
|
-
"END",
|
|
1605
|
-
"INFO",
|
|
1606
|
-
"ERROR",
|
|
1607
|
-
"WARNING",
|
|
1608
|
-
"DEBUG"
|
|
1609
|
-
]),
|
|
1610
|
-
requestId: z.string(),
|
|
1611
|
-
content: z.string().optional(),
|
|
1612
|
-
method: z.string().optional(),
|
|
1613
|
-
durationInMs: z.number().optional()
|
|
1614
|
-
})) }));
|
|
1615
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1951
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1952
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1616
1953
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1617
1954
|
method: "GET",
|
|
1618
1955
|
summary: "Get deployment logs",
|
|
@@ -1639,22 +1976,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1639
1976
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1640
1977
|
task_count: z.array(analyticsDataPointSchema)
|
|
1641
1978
|
});
|
|
1642
|
-
const getProjectAnalyticsContractV1 =
|
|
1979
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1643
1980
|
path: "/v1/analytics/{projectId}",
|
|
1644
1981
|
method: "GET",
|
|
1645
1982
|
summary: "Get project analytics",
|
|
1646
1983
|
description: "Get analytics data for a project over a time range",
|
|
1647
1984
|
tags: ["analytics"],
|
|
1648
1985
|
successDescription: "The project analytics data"
|
|
1649
|
-
}).errors({
|
|
1650
|
-
NOT_FOUND: {},
|
|
1651
|
-
BAD_REQUEST: {}
|
|
1652
|
-
}).input(z.object({
|
|
1986
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1653
1987
|
projectId: z.string().describe("The ID of the project"),
|
|
1654
1988
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1655
1989
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1656
1990
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1657
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
1991
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => Intl.supportedValuesOf("timeZone").includes(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1658
1992
|
metadata: z.object({
|
|
1659
1993
|
startTimestamp: z.number(),
|
|
1660
1994
|
endTimestamp: z.number(),
|
|
@@ -1664,7 +1998,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1664
1998
|
}),
|
|
1665
1999
|
timeSeries: analyticsTimeSeriesSchema
|
|
1666
2000
|
}));
|
|
1667
|
-
const
|
|
2001
|
+
const paginatedInsightsInputShape = {
|
|
2002
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2003
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2004
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2005
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2006
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2007
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2008
|
+
};
|
|
2009
|
+
const listIntentsContractV1 = base.route({
|
|
2010
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2011
|
+
method: "GET",
|
|
2012
|
+
summary: "List intents",
|
|
2013
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2014
|
+
tags: ["insights"],
|
|
2015
|
+
successDescription: "The grouped user intents"
|
|
2016
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2017
|
+
...paginatedInsightsInputShape,
|
|
2018
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2019
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2020
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2021
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2022
|
+
})).output(z.object({
|
|
2023
|
+
intents: z.array(z.object({
|
|
2024
|
+
id: z.string(),
|
|
2025
|
+
intentIds: z.array(z.string()).min(1),
|
|
2026
|
+
environmentId: z.string(),
|
|
2027
|
+
message: z.string(),
|
|
2028
|
+
toolName: z.string(),
|
|
2029
|
+
createdAt: z.coerce.date(),
|
|
2030
|
+
occurrenceCount: z.number().int().positive(),
|
|
2031
|
+
clientName: z.string().nullable(),
|
|
2032
|
+
clientId: z.string().nullable(),
|
|
2033
|
+
categories: z.array(z.object({
|
|
2034
|
+
id: z.string(),
|
|
2035
|
+
name: z.string(),
|
|
2036
|
+
color: intentCategoryColorSchema
|
|
2037
|
+
}))
|
|
2038
|
+
})),
|
|
2039
|
+
totalCount: z.number().int().nonnegative()
|
|
2040
|
+
}));
|
|
2041
|
+
const listFeedbacksContractV1 = base.route({
|
|
2042
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2043
|
+
method: "GET",
|
|
2044
|
+
summary: "List feedbacks",
|
|
2045
|
+
description: "List user feedback for an environment over a time range",
|
|
2046
|
+
tags: ["insights"],
|
|
2047
|
+
successDescription: "The user feedback"
|
|
2048
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2049
|
+
...paginatedInsightsInputShape,
|
|
2050
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2051
|
+
})).output(z.object({
|
|
2052
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2053
|
+
totalCount: z.number().int().nonnegative()
|
|
2054
|
+
}));
|
|
2055
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2056
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2057
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2058
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2059
|
+
method: "GET",
|
|
2060
|
+
summary: "List intent categories",
|
|
2061
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2062
|
+
tags: ["insights"],
|
|
2063
|
+
successDescription: "The intent categories"
|
|
2064
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2065
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2066
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2067
|
+
method: "POST",
|
|
2068
|
+
summary: "Create an intent category",
|
|
2069
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2070
|
+
tags: ["insights"],
|
|
2071
|
+
successDescription: "The created intent category"
|
|
2072
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2073
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2074
|
+
name: intentCategoryNameSchema,
|
|
2075
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2076
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2077
|
+
})).output(intentCategorySchema);
|
|
2078
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2079
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2080
|
+
method: "PATCH",
|
|
2081
|
+
summary: "Update an intent category",
|
|
2082
|
+
description: "Rename or recolor an intent category",
|
|
2083
|
+
tags: ["insights"],
|
|
2084
|
+
successDescription: "The updated intent category"
|
|
2085
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2086
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2087
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2088
|
+
name: intentCategoryNameSchema.optional(),
|
|
2089
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2090
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2091
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2092
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2093
|
+
method: "DELETE",
|
|
2094
|
+
summary: "Delete an intent category",
|
|
2095
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2096
|
+
tags: ["insights"],
|
|
2097
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2098
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2099
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2100
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2101
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2102
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2103
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2104
|
+
method: "POST",
|
|
2105
|
+
summary: "Link an intent category",
|
|
2106
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2107
|
+
tags: ["insights"],
|
|
2108
|
+
successDescription: "The intents have been linked successfully"
|
|
2109
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2110
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2111
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2112
|
+
intentIds: categorizableIntentIdsSchema
|
|
2113
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2114
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2115
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2116
|
+
method: "POST",
|
|
2117
|
+
summary: "Unlink an intent category",
|
|
2118
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2119
|
+
tags: ["insights"],
|
|
2120
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2121
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2122
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2123
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2124
|
+
intentIds: categorizableIntentIdsSchema
|
|
2125
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2126
|
+
const listTeamsContractV1 = base.route({
|
|
1668
2127
|
path: "/v1/teams",
|
|
1669
2128
|
method: "GET",
|
|
1670
2129
|
summary: "List teams",
|
|
@@ -1677,7 +2136,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1677
2136
|
createdAt: z.coerce.date(),
|
|
1678
2137
|
hasStripeAccount: z.boolean()
|
|
1679
2138
|
})));
|
|
1680
|
-
const
|
|
2139
|
+
const getTeamUsageContractV1 = base.route({
|
|
2140
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2141
|
+
method: "GET",
|
|
2142
|
+
summary: "Get team usage",
|
|
2143
|
+
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.",
|
|
2144
|
+
tags: ["teams"],
|
|
2145
|
+
successDescription: "The current billing window usage"
|
|
2146
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2147
|
+
teamId: z.string(),
|
|
2148
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2149
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2150
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2151
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2152
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2153
|
+
}));
|
|
2154
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1681
2155
|
path: "/v1/tunnels/ticket",
|
|
1682
2156
|
method: "GET",
|
|
1683
2157
|
summary: "Get a tunnel ticket",
|
|
@@ -1689,16 +2163,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1689
2163
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1690
2164
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1691
2165
|
}));
|
|
1692
|
-
const publishServerContractV1 =
|
|
2166
|
+
const publishServerContractV1 = base.route({
|
|
1693
2167
|
path: "/v1/distribution/publish",
|
|
1694
2168
|
method: "POST",
|
|
1695
2169
|
summary: "Publish a server to the MCP registry",
|
|
1696
2170
|
tags: ["distribution"],
|
|
1697
2171
|
successDescription: "The server has been published successfully"
|
|
1698
|
-
}).errors({
|
|
1699
|
-
NOT_FOUND: {},
|
|
1700
|
-
BAD_REQUEST: {}
|
|
1701
|
-
}).input(z.object({
|
|
2172
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1702
2173
|
projectId: z.string(),
|
|
1703
2174
|
domain: z.string(),
|
|
1704
2175
|
title: z.string().min(1).max(100),
|
|
@@ -1707,17 +2178,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1707
2178
|
iconSrc: z.url().max(255).optional(),
|
|
1708
2179
|
dryRun: z.boolean().optional()
|
|
1709
2180
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1710
|
-
const getServerInfoContractV1 =
|
|
2181
|
+
const getServerInfoContractV1 = base.route({
|
|
1711
2182
|
path: "/v1/distribution/get",
|
|
1712
2183
|
method: "GET",
|
|
1713
2184
|
summary: "Get server info",
|
|
1714
2185
|
description: "Get info about a server",
|
|
1715
2186
|
tags: ["distribution"],
|
|
1716
2187
|
successDescription: "The server info"
|
|
1717
|
-
}).errors({
|
|
1718
|
-
NOT_FOUND: {},
|
|
1719
|
-
BAD_REQUEST: {}
|
|
1720
|
-
}).input(z.object({
|
|
2188
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1721
2189
|
projectId: z.string(),
|
|
1722
2190
|
domain: z.string()
|
|
1723
2191
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1736,7 +2204,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1736
2204
|
isPlaygroundEnabled: z.boolean(),
|
|
1737
2205
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1738
2206
|
});
|
|
1739
|
-
const getPlaygroundContractV1 =
|
|
2207
|
+
const getPlaygroundContractV1 = base.route({
|
|
1740
2208
|
path: "/v1/environments/{environmentId}/playground",
|
|
1741
2209
|
method: "GET",
|
|
1742
2210
|
summary: "Get playground configuration",
|
|
@@ -1744,17 +2212,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1744
2212
|
tags: ["environments"],
|
|
1745
2213
|
successDescription: "The playground configuration"
|
|
1746
2214
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1747
|
-
const upsertPlaygroundContractV1 =
|
|
2215
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1748
2216
|
path: "/v1/environments/{environmentId}/playground",
|
|
1749
2217
|
method: "PUT",
|
|
1750
2218
|
summary: "Update playground configuration",
|
|
1751
2219
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1752
2220
|
tags: ["environments"],
|
|
1753
2221
|
successDescription: "The updated playground configuration"
|
|
1754
|
-
}).errors({
|
|
1755
|
-
NOT_FOUND: {},
|
|
1756
|
-
BAD_REQUEST: {}
|
|
1757
|
-
}).input(z.object({
|
|
2222
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1758
2223
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1759
2224
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1760
2225
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1762,7 +2227,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1762
2227
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1763
2228
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1764
2229
|
})).output(playgroundOutputSchema);
|
|
1765
|
-
const createBeaconContractV1 =
|
|
2230
|
+
const createBeaconContractV1 = base.route({
|
|
1766
2231
|
path: "/v1/beacon/audits",
|
|
1767
2232
|
method: "POST",
|
|
1768
2233
|
summary: "Create a beacon audit",
|
|
@@ -1771,7 +2236,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1771
2236
|
successDescription: "The audit has been created"
|
|
1772
2237
|
}).errors({
|
|
1773
2238
|
NOT_FOUND: {},
|
|
1774
|
-
BAD_REQUEST: {},
|
|
1775
2239
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1776
2240
|
}).input(z.object({
|
|
1777
2241
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1779,7 +2243,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1779
2243
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1780
2244
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1781
2245
|
})).output(z.object({ id: z.string() }));
|
|
1782
|
-
const getBeaconContractV1 =
|
|
2246
|
+
const getBeaconContractV1 = base.route({
|
|
1783
2247
|
path: "/v1/beacon/audits/{auditId}",
|
|
1784
2248
|
method: "GET",
|
|
1785
2249
|
summary: "Get a beacon audit",
|
|
@@ -1795,8 +2259,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1795
2259
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1796
2260
|
}));
|
|
1797
2261
|
const contract = {
|
|
1798
|
-
teams: {
|
|
2262
|
+
teams: {
|
|
2263
|
+
list: { v1: listTeamsContractV1 },
|
|
2264
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2265
|
+
},
|
|
1799
2266
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2267
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2268
|
+
intentCategories: {
|
|
2269
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2270
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2271
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2272
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2273
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2274
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2275
|
+
},
|
|
2276
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1800
2277
|
deployments: {
|
|
1801
2278
|
list: { v1: listDeploymentsContractV1 },
|
|
1802
2279
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1837,5 +2314,10 @@ const contract = {
|
|
|
1837
2314
|
get: { v1: getBeaconContractV1 }
|
|
1838
2315
|
}
|
|
1839
2316
|
};
|
|
2317
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2318
|
+
const contractForDocs = {
|
|
2319
|
+
...contract,
|
|
2320
|
+
deployments: deploymentsForDocs
|
|
2321
|
+
};
|
|
1840
2322
|
//#endregion
|
|
1841
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2323
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|