@alpic-ai/api 0.0.0-dev.gfbf0e1a → 0.0.0-dev.gfc07785
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 +1556 -59
- package/dist/index.mjs +688 -200
- package/package.json +26 -10
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -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),
|
|
@@ -374,14 +419,16 @@ z.object({
|
|
|
374
419
|
collectRequestPayload: z.boolean(),
|
|
375
420
|
collectResponsePayload: z.boolean(),
|
|
376
421
|
collectErrorMessage: z.boolean(),
|
|
377
|
-
collectUserData: z.boolean()
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
378
424
|
});
|
|
379
|
-
z.object({
|
|
425
|
+
const feedbackSchema = z.object({
|
|
380
426
|
id: z.string(),
|
|
381
427
|
createdAt: z.coerce.date(),
|
|
382
428
|
environmentId: z.string(),
|
|
383
429
|
content: z.string(),
|
|
384
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
385
432
|
});
|
|
386
433
|
z.object({
|
|
387
434
|
content: z.string(),
|
|
@@ -397,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
397
444
|
"pink",
|
|
398
445
|
"gray"
|
|
399
446
|
]);
|
|
400
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
401
448
|
const intentCategorySchema = z.object({
|
|
402
449
|
id: z.string(),
|
|
403
450
|
createdAt: z.coerce.date(),
|
|
@@ -405,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
405
452
|
name: z.string(),
|
|
406
453
|
color: intentCategoryColorSchema
|
|
407
454
|
});
|
|
408
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
409
456
|
id: z.string(),
|
|
410
457
|
name: z.string(),
|
|
411
458
|
color: intentCategoryColorSchema,
|
|
@@ -417,6 +464,7 @@ z.object({
|
|
|
417
464
|
environmentId: z.string(),
|
|
418
465
|
toolName: z.string(),
|
|
419
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
420
468
|
categories: z.array(intentCategorySchema)
|
|
421
469
|
});
|
|
422
470
|
const signalCategorySchema = z.object({
|
|
@@ -475,12 +523,262 @@ z.object({
|
|
|
475
523
|
createdAt: z.coerce.date(),
|
|
476
524
|
updatedAt: z.coerce.date()
|
|
477
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]);
|
|
478
536
|
z.enum([
|
|
479
537
|
"INFO",
|
|
480
538
|
"WARNING",
|
|
481
539
|
"DEBUG",
|
|
482
540
|
"ERROR"
|
|
483
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]));
|
|
484
782
|
const runtimeSchema = z.enum([
|
|
485
783
|
"python3.13",
|
|
486
784
|
"python3.14",
|
|
@@ -558,15 +856,7 @@ z.object({
|
|
|
558
856
|
serverFields: serverFieldsSchema$1,
|
|
559
857
|
source: z.enum(["registry", "defaults"])
|
|
560
858
|
});
|
|
561
|
-
/**
|
|
562
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
563
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
564
|
-
*
|
|
565
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
566
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
567
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
568
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
569
|
-
*/
|
|
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. */
|
|
570
860
|
const clampStringField = (field) => {
|
|
571
861
|
const max = field.maxLength;
|
|
572
862
|
if (max === null) return field;
|
|
@@ -593,8 +883,9 @@ const positiveTestCaseSchema = z.object({
|
|
|
593
883
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
594
884
|
const screenshotEntrySchema = z.object({
|
|
595
885
|
prompt: z.string(),
|
|
596
|
-
url: z.url()
|
|
886
|
+
url: z.url()
|
|
597
887
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
888
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
598
889
|
/** Accepts either a valid email or URL. */
|
|
599
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" });
|
|
600
891
|
/** A URL field whose error spells out that the scheme is required. */
|
|
@@ -911,11 +1202,7 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
911
1202
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
912
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.\"")
|
|
913
1204
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
914
|
-
/**
|
|
915
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
916
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
917
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
918
|
-
*/
|
|
1205
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
919
1206
|
const chatgptTaglineSchema = z.string().max(30);
|
|
920
1207
|
const chatgptDescriptionSchema = z.string();
|
|
921
1208
|
const chatgptTranslationSchema = z.object({
|
|
@@ -924,10 +1211,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
924
1211
|
description: chatgptDescriptionSchema
|
|
925
1212
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
926
1213
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
927
|
-
/**
|
|
928
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
929
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
930
|
-
*/
|
|
1214
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
931
1215
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
932
1216
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
933
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."),
|
|
@@ -953,6 +1237,17 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
953
1237
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
954
1238
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
955
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
|
+
});
|
|
956
1251
|
chatgptSubmissionFormDataSchema.pick({
|
|
957
1252
|
appName: true,
|
|
958
1253
|
developerName: true,
|
|
@@ -1013,11 +1308,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1013
1308
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1014
1309
|
"Public documentation for this connector will be live by the publish date."
|
|
1015
1310
|
]);
|
|
1016
|
-
/**
|
|
1017
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1018
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1019
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1020
|
-
*/
|
|
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. */
|
|
1021
1312
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1022
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
|
|
1023
1314
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1079,6 +1370,21 @@ fully populated account.`),
|
|
|
1079
1370
|
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1080
1371
|
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1081
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
|
+
});
|
|
1082
1388
|
claudeSubmissionFormDataSchema.pick({
|
|
1083
1389
|
serverUrl: true,
|
|
1084
1390
|
name: true,
|
|
@@ -1094,12 +1400,7 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1094
1400
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1095
1401
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1096
1402
|
});
|
|
1097
|
-
/**
|
|
1098
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1099
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1100
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1101
|
-
* colocated with the Claude contract.
|
|
1102
|
-
*/
|
|
1403
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1103
1404
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1104
1405
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1105
1406
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
@@ -1119,14 +1420,19 @@ const submissionMetaFieldsSchema = z.object({
|
|
|
1119
1420
|
});
|
|
1120
1421
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1121
1422
|
platform: z.literal("claudeai"),
|
|
1122
|
-
formData:
|
|
1423
|
+
formData: claudeSubmissionDraftSchema
|
|
1123
1424
|
});
|
|
1124
1425
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1125
1426
|
platform: z.literal("chatgpt"),
|
|
1126
|
-
formData:
|
|
1427
|
+
formData: chatgptSubmissionDraftSchema
|
|
1127
1428
|
});
|
|
1128
1429
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1129
|
-
z.union([
|
|
1430
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1431
|
+
z.literal([
|
|
1432
|
+
100,
|
|
1433
|
+
75,
|
|
1434
|
+
50
|
|
1435
|
+
]);
|
|
1130
1436
|
const subscriptionPlanSchema = z.enum([
|
|
1131
1437
|
"pro",
|
|
1132
1438
|
"business",
|
|
@@ -1138,17 +1444,70 @@ const customerCreditsSchema = z.object({
|
|
|
1138
1444
|
expiresAt: z.number().nullable(),
|
|
1139
1445
|
currency: z.string()
|
|
1140
1446
|
});
|
|
1141
|
-
const customerUsageSchema = z.object({
|
|
1142
|
-
amountInCents: z.number(),
|
|
1143
|
-
currency: z.string(),
|
|
1144
|
-
periodEnd: z.number()
|
|
1145
|
-
});
|
|
1146
1447
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1147
1448
|
z.object({
|
|
1148
1449
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1149
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1150
1450
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1151
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
|
+
});
|
|
1152
1511
|
//#endregion
|
|
1153
1512
|
//#region src/auth-scope.ts
|
|
1154
1513
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1191,7 +1550,10 @@ const RESERVED_KEYS = [
|
|
|
1191
1550
|
"BUILD_ARG_START_COMMAND",
|
|
1192
1551
|
"ALPIC_HOST",
|
|
1193
1552
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1194
|
-
"ALPIC_INTENT_META_KEY"
|
|
1553
|
+
"ALPIC_INTENT_META_KEY",
|
|
1554
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1555
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1556
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1195
1557
|
];
|
|
1196
1558
|
const environmentVariableSchema = z.object({
|
|
1197
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"),
|
|
@@ -1244,6 +1606,14 @@ const serverFieldsSchema = z.object({
|
|
|
1244
1606
|
});
|
|
1245
1607
|
//#endregion
|
|
1246
1608
|
//#region src/api.contract.ts
|
|
1609
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1610
|
+
try {
|
|
1611
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1612
|
+
return true;
|
|
1613
|
+
} catch {
|
|
1614
|
+
return false;
|
|
1615
|
+
}
|
|
1616
|
+
};
|
|
1247
1617
|
const deploymentStatusSchema = z.enum([
|
|
1248
1618
|
"ongoing",
|
|
1249
1619
|
"deployed",
|
|
@@ -1272,21 +1642,20 @@ const deploymentSchema = z.object({
|
|
|
1272
1642
|
isCurrent: z.boolean(),
|
|
1273
1643
|
deploymentPageUrl: z.url().nullable()
|
|
1274
1644
|
});
|
|
1275
|
-
const
|
|
1645
|
+
const isValidTimeInput = (value) => {
|
|
1276
1646
|
if (ms(value) !== void 0) return true;
|
|
1277
1647
|
return !Number.isNaN(new Date(value).getTime());
|
|
1278
1648
|
};
|
|
1279
|
-
const
|
|
1649
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1650
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1651
|
+
const createEnvironmentContractV1 = base.route({
|
|
1280
1652
|
path: "/v1/environments",
|
|
1281
1653
|
method: "POST",
|
|
1282
1654
|
summary: "Create an environment",
|
|
1283
1655
|
description: "Create an environment for a project",
|
|
1284
1656
|
tags: ["environments"],
|
|
1285
1657
|
successDescription: "The environment has been created successfully"
|
|
1286
|
-
}).errors({
|
|
1287
|
-
NOT_FOUND: {},
|
|
1288
|
-
BAD_REQUEST: {}
|
|
1289
|
-
}).input(z.object({
|
|
1658
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1290
1659
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1291
1660
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1292
1661
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1299,7 +1668,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1299
1668
|
createdAt: z.coerce.date(),
|
|
1300
1669
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1301
1670
|
}));
|
|
1302
|
-
const getEnvironmentContractV1 =
|
|
1671
|
+
const getEnvironmentContractV1 = base.route({
|
|
1303
1672
|
path: "/v1/environments/{environmentId}",
|
|
1304
1673
|
method: "GET",
|
|
1305
1674
|
summary: "Get an environment",
|
|
@@ -1315,6 +1684,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1315
1684
|
createdAt: z.coerce.date(),
|
|
1316
1685
|
projectId: z.string()
|
|
1317
1686
|
}));
|
|
1687
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1688
|
+
path: "/v1/environments/{environmentId}",
|
|
1689
|
+
method: "DELETE",
|
|
1690
|
+
summary: "Delete an environment",
|
|
1691
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1692
|
+
tags: ["environments"],
|
|
1693
|
+
successDescription: "The environment has been deleted successfully"
|
|
1694
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1318
1695
|
const domainSchema = z.object({
|
|
1319
1696
|
domain: z.string(),
|
|
1320
1697
|
status: z.enum([
|
|
@@ -1356,7 +1733,7 @@ const projectOutputSchema = z.object({
|
|
|
1356
1733
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1357
1734
|
environments: z.array(environmentSchema)
|
|
1358
1735
|
});
|
|
1359
|
-
const getProjectContractV1 =
|
|
1736
|
+
const getProjectContractV1 = base.route({
|
|
1360
1737
|
path: "/v1/projects/{projectId}",
|
|
1361
1738
|
method: "GET",
|
|
1362
1739
|
summary: "Get a project",
|
|
@@ -1364,18 +1741,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1364
1741
|
tags: ["projects"],
|
|
1365
1742
|
successDescription: "The project details"
|
|
1366
1743
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1367
|
-
const listProjectsContractV1 =
|
|
1744
|
+
const listProjectsContractV1 = base.route({
|
|
1368
1745
|
path: "/v1/projects",
|
|
1369
1746
|
method: "GET",
|
|
1370
1747
|
summary: "List projects",
|
|
1371
1748
|
description: "List all projects for a team",
|
|
1372
1749
|
tags: ["projects"],
|
|
1373
1750
|
successDescription: "The list of projects"
|
|
1374
|
-
}).errors({
|
|
1375
|
-
|
|
1376
|
-
BAD_REQUEST: {}
|
|
1377
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1378
|
-
const createProjectContractV1 = oc.route({
|
|
1751
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1752
|
+
const createProjectContractV1 = base.route({
|
|
1379
1753
|
path: "/v1/projects",
|
|
1380
1754
|
method: "POST",
|
|
1381
1755
|
summary: "Create a project",
|
|
@@ -1384,7 +1758,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1384
1758
|
successDescription: "The project has been created successfully"
|
|
1385
1759
|
}).errors({
|
|
1386
1760
|
NOT_FOUND: {},
|
|
1387
|
-
BAD_REQUEST: {},
|
|
1388
1761
|
FORBIDDEN: {}
|
|
1389
1762
|
}).input(z.object({
|
|
1390
1763
|
teamId: z.string().optional(),
|
|
@@ -1425,7 +1798,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1425
1798
|
isSecret: z.boolean(),
|
|
1426
1799
|
createdAt: z.coerce.date()
|
|
1427
1800
|
});
|
|
1428
|
-
const listEnvironmentVariablesContractV1 =
|
|
1801
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1429
1802
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1430
1803
|
method: "GET",
|
|
1431
1804
|
summary: "List environment variables",
|
|
@@ -1433,48 +1806,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1433
1806
|
tags: ["environments"],
|
|
1434
1807
|
successDescription: "The list of environment variables"
|
|
1435
1808
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1436
|
-
const createEnvironmentVariablesContractV1 =
|
|
1809
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1437
1810
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1438
1811
|
method: "POST",
|
|
1439
1812
|
summary: "Add environment variables",
|
|
1440
1813
|
description: "Add one or more environment variables to an environment",
|
|
1441
1814
|
tags: ["environments"],
|
|
1442
1815
|
successDescription: "The environment variables have been added successfully"
|
|
1443
|
-
}).errors({
|
|
1444
|
-
NOT_FOUND: {},
|
|
1445
|
-
BAD_REQUEST: {}
|
|
1446
|
-
}).input(z.object({
|
|
1816
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1447
1817
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1448
1818
|
environmentVariables: environmentVariablesSchema
|
|
1449
1819
|
})).output(z.object({ success: z.literal(true) }));
|
|
1450
|
-
const updateEnvironmentVariableContractV1 =
|
|
1820
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1451
1821
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1452
1822
|
method: "PATCH",
|
|
1453
1823
|
summary: "Update an environment variable",
|
|
1454
1824
|
description: "Update an environment variable by ID",
|
|
1455
1825
|
tags: ["environments"],
|
|
1456
1826
|
successDescription: "The environment variable has been updated successfully"
|
|
1457
|
-
}).errors({
|
|
1458
|
-
NOT_FOUND: {},
|
|
1459
|
-
BAD_REQUEST: {}
|
|
1460
|
-
}).input(z.object({
|
|
1827
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1461
1828
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1462
1829
|
key: environmentVariableSchema.shape.key,
|
|
1463
1830
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1464
1831
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1465
1832
|
})).output(z.object({ success: z.literal(true) }));
|
|
1466
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1833
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1467
1834
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1468
1835
|
method: "DELETE",
|
|
1469
1836
|
summary: "Delete an environment variable",
|
|
1470
1837
|
description: "Delete an environment variable by ID",
|
|
1471
1838
|
tags: ["environments"],
|
|
1472
1839
|
successDescription: "The environment variable has been deleted successfully"
|
|
1473
|
-
}).errors({
|
|
1474
|
-
|
|
1475
|
-
BAD_REQUEST: {}
|
|
1476
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1477
|
-
const deleteProjectContractV1 = oc.route({
|
|
1840
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1841
|
+
const deleteProjectContractV1 = base.route({
|
|
1478
1842
|
path: "/v1/projects/{projectId}",
|
|
1479
1843
|
method: "DELETE",
|
|
1480
1844
|
summary: "Delete a project",
|
|
@@ -1482,7 +1846,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1482
1846
|
tags: ["projects"],
|
|
1483
1847
|
successDescription: "The project has been deleted successfully"
|
|
1484
1848
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1485
|
-
const updateProjectContractV1 =
|
|
1849
|
+
const updateProjectContractV1 = base.route({
|
|
1486
1850
|
path: "/v1/projects/{projectId}",
|
|
1487
1851
|
method: "PATCH",
|
|
1488
1852
|
summary: "Update a project",
|
|
@@ -1491,14 +1855,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1491
1855
|
successDescription: "The project has been updated successfully"
|
|
1492
1856
|
}).errors({
|
|
1493
1857
|
NOT_FOUND: {},
|
|
1494
|
-
BAD_REQUEST: {},
|
|
1495
1858
|
FORBIDDEN: {}
|
|
1496
1859
|
}).input(z.object({
|
|
1497
1860
|
projectId: z.string().describe("The ID of the project"),
|
|
1498
1861
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1499
1862
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1500
1863
|
})).output(projectOutputSchema);
|
|
1501
|
-
const deployEnvironmentContractV1 =
|
|
1864
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1502
1865
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1503
1866
|
method: "POST",
|
|
1504
1867
|
summary: "Deploy an environment",
|
|
@@ -1507,27 +1870,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1507
1870
|
successDescription: "The environment has been deployed successfully"
|
|
1508
1871
|
}).errors({
|
|
1509
1872
|
NOT_FOUND: {},
|
|
1510
|
-
|
|
1873
|
+
CONFLICT: {}
|
|
1511
1874
|
}).input(z.object({
|
|
1512
1875
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1513
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1876
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1877
|
+
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.")
|
|
1514
1878
|
})).output(deploymentSchema);
|
|
1515
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1879
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1516
1880
|
path: "/v1/deployments/upload",
|
|
1517
1881
|
method: "POST",
|
|
1518
1882
|
summary: "Upload deployment artifacts",
|
|
1519
1883
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1520
1884
|
tags: ["deployments"],
|
|
1521
1885
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1522
|
-
}).errors({
|
|
1523
|
-
NOT_FOUND: {},
|
|
1524
|
-
BAD_REQUEST: {}
|
|
1525
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1886
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1526
1887
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1527
1888
|
token: z.string().describe("Token to identify the source archive"),
|
|
1528
1889
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1529
1890
|
}));
|
|
1530
|
-
const listDeploymentsContractV1 =
|
|
1891
|
+
const listDeploymentsContractV1 = base.route({
|
|
1531
1892
|
path: "/v1/projects/{projectId}/deployments",
|
|
1532
1893
|
method: "GET",
|
|
1533
1894
|
summary: "List project deployments",
|
|
@@ -1539,7 +1900,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1539
1900
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1540
1901
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1541
1902
|
})).output(z.array(deploymentSchema));
|
|
1542
|
-
const getDeploymentContractV1 =
|
|
1903
|
+
const getDeploymentContractV1 = base.route({
|
|
1543
1904
|
path: "/v1/deployments/{deploymentId}",
|
|
1544
1905
|
method: "GET",
|
|
1545
1906
|
summary: "Get a deployment",
|
|
@@ -1547,20 +1908,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1547
1908
|
tags: ["deployments"],
|
|
1548
1909
|
successDescription: "The deployment details"
|
|
1549
1910
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1550
|
-
const
|
|
1911
|
+
const logEntrySchema = z.object({
|
|
1912
|
+
timestamp: z.coerce.date(),
|
|
1913
|
+
type: z.enum([
|
|
1914
|
+
"START",
|
|
1915
|
+
"END",
|
|
1916
|
+
"INFO",
|
|
1917
|
+
"ERROR",
|
|
1918
|
+
"WARNING",
|
|
1919
|
+
"DEBUG"
|
|
1920
|
+
]),
|
|
1921
|
+
requestId: z.string(),
|
|
1922
|
+
content: z.string().optional(),
|
|
1923
|
+
method: z.string().optional(),
|
|
1924
|
+
durationInMs: z.number().optional()
|
|
1925
|
+
});
|
|
1926
|
+
const getLogsContractV1 = base.route({
|
|
1551
1927
|
path: "/v1/environments/{environmentId}/logs",
|
|
1552
1928
|
method: "GET",
|
|
1553
1929
|
summary: "Get logs",
|
|
1554
1930
|
description: "Get logs for an environment",
|
|
1555
1931
|
tags: ["environments"],
|
|
1556
1932
|
successDescription: "The logs"
|
|
1557
|
-
}).errors({
|
|
1558
|
-
NOT_FOUND: {},
|
|
1559
|
-
BAD_REQUEST: {}
|
|
1560
|
-
}).input(z.object({
|
|
1933
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1561
1934
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1562
|
-
since:
|
|
1563
|
-
until:
|
|
1935
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1936
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1564
1937
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1565
1938
|
level: z.array(z.enum([
|
|
1566
1939
|
"INFO",
|
|
@@ -1571,34 +1944,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1571
1944
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1572
1945
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1573
1946
|
})).output(z.object({
|
|
1574
|
-
logs: z.array(
|
|
1575
|
-
timestamp: z.coerce.date(),
|
|
1576
|
-
type: z.enum([
|
|
1577
|
-
"START",
|
|
1578
|
-
"END",
|
|
1579
|
-
"INFO",
|
|
1580
|
-
"ERROR",
|
|
1581
|
-
"WARNING",
|
|
1582
|
-
"DEBUG"
|
|
1583
|
-
]),
|
|
1584
|
-
requestId: z.string(),
|
|
1585
|
-
content: z.string().optional(),
|
|
1586
|
-
method: z.string().optional(),
|
|
1587
|
-
durationInMs: z.number().optional()
|
|
1588
|
-
})),
|
|
1947
|
+
logs: z.array(logEntrySchema),
|
|
1589
1948
|
nextToken: z.string().nullable()
|
|
1590
1949
|
}));
|
|
1591
|
-
const getLatestLogsContractV1 =
|
|
1950
|
+
const getLatestLogsContractV1 = base.route({
|
|
1592
1951
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1593
1952
|
method: "GET",
|
|
1594
1953
|
summary: "Get latest logs",
|
|
1595
1954
|
description: "Get the N most recent logs for an environment",
|
|
1596
1955
|
tags: ["environments"],
|
|
1597
1956
|
successDescription: "The latest logs"
|
|
1598
|
-
}).errors({
|
|
1599
|
-
NOT_FOUND: {},
|
|
1600
|
-
BAD_REQUEST: {}
|
|
1601
|
-
}).input(z.object({
|
|
1957
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1602
1958
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1603
1959
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1604
1960
|
level: z.array(z.enum([
|
|
@@ -1608,22 +1964,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1608
1964
|
"DEBUG"
|
|
1609
1965
|
])).optional().describe("Filter by log level"),
|
|
1610
1966
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1611
|
-
})).output(z.object({ logs: z.array(
|
|
1612
|
-
|
|
1613
|
-
type: z.enum([
|
|
1614
|
-
"START",
|
|
1615
|
-
"END",
|
|
1616
|
-
"INFO",
|
|
1617
|
-
"ERROR",
|
|
1618
|
-
"WARNING",
|
|
1619
|
-
"DEBUG"
|
|
1620
|
-
]),
|
|
1621
|
-
requestId: z.string(),
|
|
1622
|
-
content: z.string().optional(),
|
|
1623
|
-
method: z.string().optional(),
|
|
1624
|
-
durationInMs: z.number().optional()
|
|
1625
|
-
})) }));
|
|
1626
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1967
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1968
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1627
1969
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1628
1970
|
method: "GET",
|
|
1629
1971
|
summary: "Get deployment logs",
|
|
@@ -1650,22 +1992,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1650
1992
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1651
1993
|
task_count: z.array(analyticsDataPointSchema)
|
|
1652
1994
|
});
|
|
1653
|
-
const getProjectAnalyticsContractV1 =
|
|
1995
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1654
1996
|
path: "/v1/analytics/{projectId}",
|
|
1655
1997
|
method: "GET",
|
|
1656
1998
|
summary: "Get project analytics",
|
|
1657
1999
|
description: "Get analytics data for a project over a time range",
|
|
1658
2000
|
tags: ["analytics"],
|
|
1659
2001
|
successDescription: "The project analytics data"
|
|
1660
|
-
}).errors({
|
|
1661
|
-
NOT_FOUND: {},
|
|
1662
|
-
BAD_REQUEST: {}
|
|
1663
|
-
}).input(z.object({
|
|
2002
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1664
2003
|
projectId: z.string().describe("The ID of the project"),
|
|
1665
2004
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1666
2005
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1667
2006
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1668
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2007
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => isValidIanaTimeZone(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1669
2008
|
metadata: z.object({
|
|
1670
2009
|
startTimestamp: z.number(),
|
|
1671
2010
|
endTimestamp: z.number(),
|
|
@@ -1675,7 +2014,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1675
2014
|
}),
|
|
1676
2015
|
timeSeries: analyticsTimeSeriesSchema
|
|
1677
2016
|
}));
|
|
1678
|
-
const
|
|
2017
|
+
const paginatedInsightsInputShape = {
|
|
2018
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2019
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2020
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2021
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2022
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2023
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2024
|
+
};
|
|
2025
|
+
const listIntentsContractV1 = base.route({
|
|
2026
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2027
|
+
method: "GET",
|
|
2028
|
+
summary: "List intents",
|
|
2029
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2030
|
+
tags: ["insights"],
|
|
2031
|
+
successDescription: "The grouped user intents"
|
|
2032
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2033
|
+
...paginatedInsightsInputShape,
|
|
2034
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2035
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2036
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2037
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2038
|
+
})).output(z.object({
|
|
2039
|
+
intents: z.array(z.object({
|
|
2040
|
+
id: z.string(),
|
|
2041
|
+
intentIds: z.array(z.string()).min(1),
|
|
2042
|
+
environmentId: z.string(),
|
|
2043
|
+
message: z.string(),
|
|
2044
|
+
toolName: z.string(),
|
|
2045
|
+
createdAt: z.coerce.date(),
|
|
2046
|
+
occurrenceCount: z.number().int().positive(),
|
|
2047
|
+
clientName: z.string().nullable(),
|
|
2048
|
+
clientId: z.string().nullable(),
|
|
2049
|
+
categories: z.array(z.object({
|
|
2050
|
+
id: z.string(),
|
|
2051
|
+
name: z.string(),
|
|
2052
|
+
color: intentCategoryColorSchema
|
|
2053
|
+
}))
|
|
2054
|
+
})),
|
|
2055
|
+
totalCount: z.number().int().nonnegative()
|
|
2056
|
+
}));
|
|
2057
|
+
const listFeedbacksContractV1 = base.route({
|
|
2058
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2059
|
+
method: "GET",
|
|
2060
|
+
summary: "List feedbacks",
|
|
2061
|
+
description: "List user feedback for an environment over a time range",
|
|
2062
|
+
tags: ["insights"],
|
|
2063
|
+
successDescription: "The user feedback"
|
|
2064
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2065
|
+
...paginatedInsightsInputShape,
|
|
2066
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2067
|
+
})).output(z.object({
|
|
2068
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2069
|
+
totalCount: z.number().int().nonnegative()
|
|
2070
|
+
}));
|
|
2071
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2072
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2073
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2074
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2075
|
+
method: "GET",
|
|
2076
|
+
summary: "List intent categories",
|
|
2077
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2078
|
+
tags: ["insights"],
|
|
2079
|
+
successDescription: "The intent categories"
|
|
2080
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2081
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2082
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2083
|
+
method: "POST",
|
|
2084
|
+
summary: "Create an intent category",
|
|
2085
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2086
|
+
tags: ["insights"],
|
|
2087
|
+
successDescription: "The created intent category"
|
|
2088
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2089
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2090
|
+
name: intentCategoryNameSchema,
|
|
2091
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2092
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2093
|
+
})).output(intentCategorySchema);
|
|
2094
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2095
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2096
|
+
method: "PATCH",
|
|
2097
|
+
summary: "Update an intent category",
|
|
2098
|
+
description: "Rename or recolor an intent category",
|
|
2099
|
+
tags: ["insights"],
|
|
2100
|
+
successDescription: "The updated intent category"
|
|
2101
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2102
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2103
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2104
|
+
name: intentCategoryNameSchema.optional(),
|
|
2105
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2106
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2107
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2108
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2109
|
+
method: "DELETE",
|
|
2110
|
+
summary: "Delete an intent category",
|
|
2111
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2112
|
+
tags: ["insights"],
|
|
2113
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2114
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2115
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2116
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2117
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2118
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2119
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2120
|
+
method: "POST",
|
|
2121
|
+
summary: "Link an intent category",
|
|
2122
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2123
|
+
tags: ["insights"],
|
|
2124
|
+
successDescription: "The intents have been linked successfully"
|
|
2125
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2126
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2127
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2128
|
+
intentIds: categorizableIntentIdsSchema
|
|
2129
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2130
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2131
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2132
|
+
method: "POST",
|
|
2133
|
+
summary: "Unlink an intent category",
|
|
2134
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2135
|
+
tags: ["insights"],
|
|
2136
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2137
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2138
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2139
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2140
|
+
intentIds: categorizableIntentIdsSchema
|
|
2141
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2142
|
+
const listTeamsContractV1 = base.route({
|
|
1679
2143
|
path: "/v1/teams",
|
|
1680
2144
|
method: "GET",
|
|
1681
2145
|
summary: "List teams",
|
|
@@ -1688,7 +2152,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1688
2152
|
createdAt: z.coerce.date(),
|
|
1689
2153
|
hasStripeAccount: z.boolean()
|
|
1690
2154
|
})));
|
|
1691
|
-
const
|
|
2155
|
+
const getTeamUsageContractV1 = base.route({
|
|
2156
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2157
|
+
method: "GET",
|
|
2158
|
+
summary: "Get team usage",
|
|
2159
|
+
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.",
|
|
2160
|
+
tags: ["teams"],
|
|
2161
|
+
successDescription: "The current billing window usage"
|
|
2162
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2163
|
+
teamId: z.string(),
|
|
2164
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2165
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2166
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2167
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2168
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2169
|
+
}));
|
|
2170
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1692
2171
|
path: "/v1/tunnels/ticket",
|
|
1693
2172
|
method: "GET",
|
|
1694
2173
|
summary: "Get a tunnel ticket",
|
|
@@ -1700,16 +2179,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1700
2179
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1701
2180
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1702
2181
|
}));
|
|
1703
|
-
const publishServerContractV1 =
|
|
2182
|
+
const publishServerContractV1 = base.route({
|
|
1704
2183
|
path: "/v1/distribution/publish",
|
|
1705
2184
|
method: "POST",
|
|
1706
2185
|
summary: "Publish a server to the MCP registry",
|
|
1707
2186
|
tags: ["distribution"],
|
|
1708
2187
|
successDescription: "The server has been published successfully"
|
|
1709
|
-
}).errors({
|
|
1710
|
-
NOT_FOUND: {},
|
|
1711
|
-
BAD_REQUEST: {}
|
|
1712
|
-
}).input(z.object({
|
|
2188
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1713
2189
|
projectId: z.string(),
|
|
1714
2190
|
domain: z.string(),
|
|
1715
2191
|
title: z.string().min(1).max(100),
|
|
@@ -1718,17 +2194,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1718
2194
|
iconSrc: z.url().max(255).optional(),
|
|
1719
2195
|
dryRun: z.boolean().optional()
|
|
1720
2196
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1721
|
-
const getServerInfoContractV1 =
|
|
2197
|
+
const getServerInfoContractV1 = base.route({
|
|
1722
2198
|
path: "/v1/distribution/get",
|
|
1723
2199
|
method: "GET",
|
|
1724
2200
|
summary: "Get server info",
|
|
1725
2201
|
description: "Get info about a server",
|
|
1726
2202
|
tags: ["distribution"],
|
|
1727
2203
|
successDescription: "The server info"
|
|
1728
|
-
}).errors({
|
|
1729
|
-
NOT_FOUND: {},
|
|
1730
|
-
BAD_REQUEST: {}
|
|
1731
|
-
}).input(z.object({
|
|
2204
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1732
2205
|
projectId: z.string(),
|
|
1733
2206
|
domain: z.string()
|
|
1734
2207
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1747,7 +2220,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1747
2220
|
isPlaygroundEnabled: z.boolean(),
|
|
1748
2221
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1749
2222
|
});
|
|
1750
|
-
const getPlaygroundContractV1 =
|
|
2223
|
+
const getPlaygroundContractV1 = base.route({
|
|
1751
2224
|
path: "/v1/environments/{environmentId}/playground",
|
|
1752
2225
|
method: "GET",
|
|
1753
2226
|
summary: "Get playground configuration",
|
|
@@ -1755,17 +2228,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1755
2228
|
tags: ["environments"],
|
|
1756
2229
|
successDescription: "The playground configuration"
|
|
1757
2230
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1758
|
-
const upsertPlaygroundContractV1 =
|
|
2231
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1759
2232
|
path: "/v1/environments/{environmentId}/playground",
|
|
1760
2233
|
method: "PUT",
|
|
1761
2234
|
summary: "Update playground configuration",
|
|
1762
2235
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1763
2236
|
tags: ["environments"],
|
|
1764
2237
|
successDescription: "The updated playground configuration"
|
|
1765
|
-
}).errors({
|
|
1766
|
-
NOT_FOUND: {},
|
|
1767
|
-
BAD_REQUEST: {}
|
|
1768
|
-
}).input(z.object({
|
|
2238
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1769
2239
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1770
2240
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1771
2241
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1773,7 +2243,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1773
2243
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1774
2244
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1775
2245
|
})).output(playgroundOutputSchema);
|
|
1776
|
-
const createBeaconContractV1 =
|
|
2246
|
+
const createBeaconContractV1 = base.route({
|
|
1777
2247
|
path: "/v1/beacon/audits",
|
|
1778
2248
|
method: "POST",
|
|
1779
2249
|
summary: "Create a beacon audit",
|
|
@@ -1782,7 +2252,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1782
2252
|
successDescription: "The audit has been created"
|
|
1783
2253
|
}).errors({
|
|
1784
2254
|
NOT_FOUND: {},
|
|
1785
|
-
BAD_REQUEST: {},
|
|
1786
2255
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1787
2256
|
}).input(z.object({
|
|
1788
2257
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1790,7 +2259,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1790
2259
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1791
2260
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1792
2261
|
})).output(z.object({ id: z.string() }));
|
|
1793
|
-
const getBeaconContractV1 =
|
|
2262
|
+
const getBeaconContractV1 = base.route({
|
|
1794
2263
|
path: "/v1/beacon/audits/{auditId}",
|
|
1795
2264
|
method: "GET",
|
|
1796
2265
|
summary: "Get a beacon audit",
|
|
@@ -1806,8 +2275,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1806
2275
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1807
2276
|
}));
|
|
1808
2277
|
const contract = {
|
|
1809
|
-
teams: {
|
|
2278
|
+
teams: {
|
|
2279
|
+
list: { v1: listTeamsContractV1 },
|
|
2280
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2281
|
+
},
|
|
1810
2282
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2283
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2284
|
+
intentCategories: {
|
|
2285
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2286
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2287
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2288
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2289
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2290
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2291
|
+
},
|
|
2292
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1811
2293
|
deployments: {
|
|
1812
2294
|
list: { v1: listDeploymentsContractV1 },
|
|
1813
2295
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1817,6 +2299,7 @@ const contract = {
|
|
|
1817
2299
|
environments: {
|
|
1818
2300
|
create: { v1: createEnvironmentContractV1 },
|
|
1819
2301
|
get: { v1: getEnvironmentContractV1 },
|
|
2302
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1820
2303
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1821
2304
|
getLogs: { v1: getLogsContractV1 },
|
|
1822
2305
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1848,5 +2331,10 @@ const contract = {
|
|
|
1848
2331
|
get: { v1: getBeaconContractV1 }
|
|
1849
2332
|
}
|
|
1850
2333
|
};
|
|
2334
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2335
|
+
const contractForDocs = {
|
|
2336
|
+
...contract,
|
|
2337
|
+
deployments: deploymentsForDocs
|
|
2338
|
+
};
|
|
1851
2339
|
//#endregion
|
|
1852
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2340
|
+
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 };
|