@alpic-ai/api 0.0.0-dev.gfdd78d0 → 0.0.0-dev.gfdd7d71
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 +646 -195
- 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,21 @@ z$1.object({
|
|
|
169
169
|
token: z$1.string(),
|
|
170
170
|
token_type_hint: z$1.string().optional()
|
|
171
171
|
}).strip();
|
|
172
|
-
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
173
176
|
const PLATFORM_LABELS = {
|
|
174
177
|
chatgpt: "ChatGPT",
|
|
175
178
|
claudeai: "Claude.ai"
|
|
176
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cloudflare",
|
|
183
|
+
"fastly"
|
|
184
|
+
];
|
|
185
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
186
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
187
|
const auditStatusSchema = z.enum([
|
|
178
188
|
"pending",
|
|
179
189
|
"partial",
|
|
@@ -246,6 +256,16 @@ z.object({
|
|
|
246
256
|
clientSecret: z.string(),
|
|
247
257
|
clientScopes: z.array(z.string())
|
|
248
258
|
});
|
|
259
|
+
z.enum([
|
|
260
|
+
"opening_balance",
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"refund",
|
|
266
|
+
"admin_adjustment"
|
|
267
|
+
]);
|
|
268
|
+
z.enum(["playground"]);
|
|
249
269
|
const deploymentStatusSchema$1 = z.enum([
|
|
250
270
|
"ongoing",
|
|
251
271
|
"deployed",
|
|
@@ -273,34 +293,51 @@ const deploymentSummarySchema = z.object({
|
|
|
273
293
|
createdAt: z.coerce.date(),
|
|
274
294
|
updatedAt: z.coerce.date()
|
|
275
295
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
296
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
297
|
const publicEnvironmentSchema = z.object({
|
|
298
|
+
allowsAnonymous: z.literal(true),
|
|
299
|
+
oAuthMetadata: z.strictObject({})
|
|
300
|
+
});
|
|
301
|
+
/** 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. */
|
|
302
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
303
|
+
allowsAnonymous: z.boolean(),
|
|
304
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
305
|
+
scope: z.string().optional()
|
|
306
|
+
});
|
|
307
|
+
/** 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. */
|
|
308
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
309
|
+
allowsAnonymous: z.boolean(),
|
|
310
|
+
oAuthMetadata: z.object({
|
|
311
|
+
externalAuthorizationServerUrl: z.url(),
|
|
312
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
313
|
+
}),
|
|
314
|
+
scope: z.string().optional()
|
|
315
|
+
});
|
|
316
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
317
|
+
const standaloneEnvironmentSchema = z.object({
|
|
318
|
+
allowsAnonymous: z.boolean(),
|
|
319
|
+
oAuthMetadata: z.object({
|
|
320
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
321
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
322
|
+
}),
|
|
323
|
+
scope: z.string().optional()
|
|
324
|
+
});
|
|
325
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
326
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
327
|
+
allowsAnonymous: z.literal(false),
|
|
328
|
+
oAuthMetadata: z.strictObject({}),
|
|
329
|
+
scope: z.string().optional()
|
|
330
|
+
});
|
|
331
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
332
|
isPublic: z.literal(true),
|
|
283
333
|
oAuthMetadata: z.undefined().optional()
|
|
284
334
|
});
|
|
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({
|
|
335
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
336
|
isPublic: z.literal(false),
|
|
293
337
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
338
|
scope: z.string().optional()
|
|
295
339
|
});
|
|
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({
|
|
340
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
341
|
isPublic: z.literal(false),
|
|
305
342
|
oAuthMetadata: z.object({
|
|
306
343
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +345,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
345
|
}),
|
|
309
346
|
scope: z.string().optional()
|
|
310
347
|
});
|
|
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({
|
|
348
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
349
|
isPublic: z.literal(false),
|
|
319
350
|
oAuthMetadata: z.object({
|
|
320
351
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +353,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
353
|
}),
|
|
323
354
|
scope: z.string().optional()
|
|
324
355
|
});
|
|
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({
|
|
356
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
357
|
isPublic: z.literal(false),
|
|
334
358
|
oAuthMetadata: z.strictObject({}),
|
|
335
359
|
scope: z.string().optional()
|
|
@@ -339,9 +363,13 @@ z.union([
|
|
|
339
363
|
externalResourceMetadataEnvironmentSchema,
|
|
340
364
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
365
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
366
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
367
|
+
legacyPublicEnvironmentSchema,
|
|
368
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
369
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
370
|
+
legacyStandaloneEnvironmentSchema,
|
|
371
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
343
372
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
373
|
const playgroundModelSchema = z.enum([
|
|
346
374
|
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
347
375
|
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
@@ -381,14 +409,16 @@ z.object({
|
|
|
381
409
|
collectRequestPayload: z.boolean(),
|
|
382
410
|
collectResponsePayload: z.boolean(),
|
|
383
411
|
collectErrorMessage: z.boolean(),
|
|
384
|
-
collectUserData: z.boolean()
|
|
412
|
+
collectUserData: z.boolean(),
|
|
413
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
385
414
|
});
|
|
386
|
-
z.object({
|
|
415
|
+
const feedbackSchema = z.object({
|
|
387
416
|
id: z.string(),
|
|
388
417
|
createdAt: z.coerce.date(),
|
|
389
418
|
environmentId: z.string(),
|
|
390
419
|
content: z.string(),
|
|
391
|
-
source: z.enum(["model", "user"])
|
|
420
|
+
source: z.enum(["model", "user"]),
|
|
421
|
+
clientName: z.string().nullable()
|
|
392
422
|
});
|
|
393
423
|
z.object({
|
|
394
424
|
content: z.string(),
|
|
@@ -404,7 +434,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
404
434
|
"pink",
|
|
405
435
|
"gray"
|
|
406
436
|
]);
|
|
407
|
-
intentCategoryColorSchema.options;
|
|
437
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
408
438
|
const intentCategorySchema = z.object({
|
|
409
439
|
id: z.string(),
|
|
410
440
|
createdAt: z.coerce.date(),
|
|
@@ -412,7 +442,7 @@ const intentCategorySchema = z.object({
|
|
|
412
442
|
name: z.string(),
|
|
413
443
|
color: intentCategoryColorSchema
|
|
414
444
|
});
|
|
415
|
-
z.object({
|
|
445
|
+
const intentCategorySummarySchema = z.object({
|
|
416
446
|
id: z.string(),
|
|
417
447
|
name: z.string(),
|
|
418
448
|
color: intentCategoryColorSchema,
|
|
@@ -424,6 +454,7 @@ z.object({
|
|
|
424
454
|
environmentId: z.string(),
|
|
425
455
|
toolName: z.string(),
|
|
426
456
|
message: z.string(),
|
|
457
|
+
clientName: z.string().nullable(),
|
|
427
458
|
categories: z.array(intentCategorySchema)
|
|
428
459
|
});
|
|
429
460
|
const signalCategorySchema = z.object({
|
|
@@ -482,12 +513,262 @@ z.object({
|
|
|
482
513
|
createdAt: z.coerce.date(),
|
|
483
514
|
updatedAt: z.coerce.date()
|
|
484
515
|
});
|
|
516
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
517
|
+
type: z.literal("mcp_request"),
|
|
518
|
+
method: z.string()
|
|
519
|
+
});
|
|
520
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
521
|
+
type: z.literal("mcp_error"),
|
|
522
|
+
method: z.string(),
|
|
523
|
+
error: z.string()
|
|
524
|
+
});
|
|
525
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
485
526
|
z.enum([
|
|
486
527
|
"INFO",
|
|
487
528
|
"WARNING",
|
|
488
529
|
"DEBUG",
|
|
489
530
|
"ERROR"
|
|
490
531
|
]);
|
|
532
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
533
|
+
const MCP_CLIENT_GROUPS = [
|
|
534
|
+
{
|
|
535
|
+
id: "claude_code",
|
|
536
|
+
label: "Claude Code",
|
|
537
|
+
vendor: "anthropic",
|
|
538
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
539
|
+
},
|
|
540
|
+
{
|
|
541
|
+
id: "claude",
|
|
542
|
+
label: "Claude",
|
|
543
|
+
vendor: "anthropic",
|
|
544
|
+
rawNames: [
|
|
545
|
+
"Anthropic/ClaudeAI",
|
|
546
|
+
"claude-ai",
|
|
547
|
+
"claude",
|
|
548
|
+
"Claude",
|
|
549
|
+
"claude-desktop",
|
|
550
|
+
"claude-desktop-3p"
|
|
551
|
+
]
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
id: "claude_mobile",
|
|
555
|
+
label: "Claude mobile",
|
|
556
|
+
vendor: "anthropic",
|
|
557
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
id: "claude_cowork",
|
|
561
|
+
label: "Claude Cowork",
|
|
562
|
+
vendor: "anthropic",
|
|
563
|
+
rawNames: ["Anthropic/Cowork"]
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
id: "claude_toolbox",
|
|
567
|
+
label: "Claude Toolbox",
|
|
568
|
+
vendor: "anthropic",
|
|
569
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
id: "anthropic_api",
|
|
573
|
+
label: "Anthropic API",
|
|
574
|
+
vendor: "anthropic",
|
|
575
|
+
rawNames: ["Anthropic/API"]
|
|
576
|
+
},
|
|
577
|
+
{
|
|
578
|
+
id: "anthropic_connector_refresh",
|
|
579
|
+
label: "Anthropic (connector refresh)",
|
|
580
|
+
vendor: "anthropic",
|
|
581
|
+
rawNames: ["Anthropic"]
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
id: "codex",
|
|
585
|
+
label: "Codex",
|
|
586
|
+
vendor: "openai",
|
|
587
|
+
rawNames: [
|
|
588
|
+
"codex-mcp-client",
|
|
589
|
+
"codex",
|
|
590
|
+
"Codex",
|
|
591
|
+
"codex-cli",
|
|
592
|
+
"openai-mcp (Codex)"
|
|
593
|
+
]
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
id: "chatgpt",
|
|
597
|
+
label: "ChatGPT",
|
|
598
|
+
vendor: "openai",
|
|
599
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
600
|
+
},
|
|
601
|
+
{
|
|
602
|
+
id: "openai_responses_api",
|
|
603
|
+
label: "OpenAI Responses API",
|
|
604
|
+
vendor: "openai",
|
|
605
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
id: "openai_agent_builder",
|
|
609
|
+
label: "OpenAI Agent Builder",
|
|
610
|
+
vendor: "openai",
|
|
611
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
612
|
+
},
|
|
613
|
+
{
|
|
614
|
+
id: "openai_other",
|
|
615
|
+
label: "OpenAI Other",
|
|
616
|
+
vendor: "openai",
|
|
617
|
+
rawNames: ["openai-mcp"]
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
id: "cursor",
|
|
621
|
+
label: "Cursor",
|
|
622
|
+
vendor: "cursor",
|
|
623
|
+
rawNames: [
|
|
624
|
+
"cursor-vscode",
|
|
625
|
+
"Cursor",
|
|
626
|
+
"cursor"
|
|
627
|
+
]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cline",
|
|
631
|
+
label: "Cline",
|
|
632
|
+
vendor: "cline",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"Cline",
|
|
635
|
+
"cline",
|
|
636
|
+
"@cline/core"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "github_copilot",
|
|
641
|
+
label: "GitHub Copilot",
|
|
642
|
+
vendor: "githubCopilot",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Copilot",
|
|
645
|
+
"github-copilot-developer",
|
|
646
|
+
"Copilot MCP Gateway",
|
|
647
|
+
"Xcode/copilot-xcode"
|
|
648
|
+
]
|
|
649
|
+
},
|
|
650
|
+
{
|
|
651
|
+
id: "gemini_cli",
|
|
652
|
+
label: "Gemini CLI",
|
|
653
|
+
vendor: "google",
|
|
654
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
655
|
+
},
|
|
656
|
+
{
|
|
657
|
+
id: "antigravity",
|
|
658
|
+
label: "Antigravity",
|
|
659
|
+
vendor: "google",
|
|
660
|
+
rawNames: ["antigravity-client"]
|
|
661
|
+
},
|
|
662
|
+
{
|
|
663
|
+
id: "gemini",
|
|
664
|
+
label: "Gemini",
|
|
665
|
+
vendor: "google",
|
|
666
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
id: "windsurf",
|
|
670
|
+
label: "Windsurf",
|
|
671
|
+
vendor: "windsurf",
|
|
672
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
673
|
+
},
|
|
674
|
+
{
|
|
675
|
+
id: "mistral",
|
|
676
|
+
label: "Mistral / Le Chat",
|
|
677
|
+
vendor: "mistral",
|
|
678
|
+
rawNames: ["Mistral"],
|
|
679
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
680
|
+
},
|
|
681
|
+
{
|
|
682
|
+
id: "n8n",
|
|
683
|
+
label: "n8n",
|
|
684
|
+
vendor: "n8n",
|
|
685
|
+
rawNames: [
|
|
686
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
687
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
688
|
+
"n8n"
|
|
689
|
+
]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "alpic_playground",
|
|
693
|
+
label: "Alpic Playground",
|
|
694
|
+
vendor: "alpic",
|
|
695
|
+
rawNames: ["alpic-playground", "playground"]
|
|
696
|
+
},
|
|
697
|
+
{
|
|
698
|
+
id: "opencode",
|
|
699
|
+
label: "opencode",
|
|
700
|
+
vendor: "opencode",
|
|
701
|
+
rawNames: ["opencode"]
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
id: "zed",
|
|
705
|
+
label: "Zed",
|
|
706
|
+
vendor: "zed",
|
|
707
|
+
rawNames: ["Zed", "zed"]
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
id: "zapier",
|
|
711
|
+
label: "Zapier",
|
|
712
|
+
vendor: "zapier",
|
|
713
|
+
rawNames: ["Zapier", "zapier"]
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
id: "make",
|
|
717
|
+
label: "Make",
|
|
718
|
+
vendor: "make",
|
|
719
|
+
rawNames: ["Make", "make"]
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
id: "librechat",
|
|
723
|
+
label: "LibreChat",
|
|
724
|
+
vendor: "mcp",
|
|
725
|
+
rawNames: ["LibreChat", "librechat"]
|
|
726
|
+
},
|
|
727
|
+
{
|
|
728
|
+
id: "jan",
|
|
729
|
+
label: "Jan",
|
|
730
|
+
vendor: "mcp",
|
|
731
|
+
rawNames: ["Jan", "jan"]
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
id: "goose",
|
|
735
|
+
label: "goose",
|
|
736
|
+
vendor: "mcp",
|
|
737
|
+
rawNames: ["goose", "Goose"]
|
|
738
|
+
},
|
|
739
|
+
{
|
|
740
|
+
id: "mcphost",
|
|
741
|
+
label: "mcphost",
|
|
742
|
+
vendor: "mcp",
|
|
743
|
+
rawNames: ["mcphost"]
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
id: "mcporter",
|
|
747
|
+
label: "mcporter",
|
|
748
|
+
vendor: "mcp",
|
|
749
|
+
rawNames: ["mcporter"]
|
|
750
|
+
},
|
|
751
|
+
{
|
|
752
|
+
id: "rmcp",
|
|
753
|
+
label: "rmcp",
|
|
754
|
+
vendor: "mcp",
|
|
755
|
+
rawNames: ["rmcp"]
|
|
756
|
+
},
|
|
757
|
+
{
|
|
758
|
+
id: "unnamed_client",
|
|
759
|
+
label: "Unnamed client",
|
|
760
|
+
vendor: "mcp",
|
|
761
|
+
rawNames: [
|
|
762
|
+
"mcp",
|
|
763
|
+
"unknown",
|
|
764
|
+
""
|
|
765
|
+
]
|
|
766
|
+
}
|
|
767
|
+
];
|
|
768
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
769
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
770
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
771
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
491
772
|
const runtimeSchema = z.enum([
|
|
492
773
|
"python3.13",
|
|
493
774
|
"python3.14",
|
|
@@ -522,6 +803,10 @@ const domainFailureReasonSchema = z.enum([
|
|
|
522
803
|
"invalid_domain",
|
|
523
804
|
"other"
|
|
524
805
|
]);
|
|
806
|
+
const projectDomainMappingSchema = z.object({
|
|
807
|
+
pathPrefix: z.string(),
|
|
808
|
+
environment: environmentSchema$1
|
|
809
|
+
});
|
|
525
810
|
z.object({
|
|
526
811
|
name: z.string(),
|
|
527
812
|
createdAt: z.coerce.date(),
|
|
@@ -531,7 +816,8 @@ z.object({
|
|
|
531
816
|
"failed"
|
|
532
817
|
]),
|
|
533
818
|
failureReason: domainFailureReasonSchema.nullable(),
|
|
534
|
-
environment: environmentSchema$1
|
|
819
|
+
environment: environmentSchema$1,
|
|
820
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
535
821
|
});
|
|
536
822
|
const serverFieldsSchema$1 = z.object({
|
|
537
823
|
$schema: z.string(),
|
|
@@ -560,15 +846,7 @@ z.object({
|
|
|
560
846
|
serverFields: serverFieldsSchema$1,
|
|
561
847
|
source: z.enum(["registry", "defaults"])
|
|
562
848
|
});
|
|
563
|
-
/**
|
|
564
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
565
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
566
|
-
*
|
|
567
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
568
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
569
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
570
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
571
|
-
*/
|
|
849
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
572
850
|
const clampStringField = (field) => {
|
|
573
851
|
const max = field.maxLength;
|
|
574
852
|
if (max === null) return field;
|
|
@@ -595,8 +873,9 @@ const positiveTestCaseSchema = z.object({
|
|
|
595
873
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
596
874
|
const screenshotEntrySchema = z.object({
|
|
597
875
|
prompt: z.string(),
|
|
598
|
-
url: z.url()
|
|
876
|
+
url: z.url()
|
|
599
877
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
878
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
600
879
|
/** Accepts either a valid email or URL. */
|
|
601
880
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
602
881
|
/** A URL field whose error spells out that the scheme is required. */
|
|
@@ -913,11 +1192,7 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
913
1192
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
914
1193
|
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
915
1194
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
916
|
-
/**
|
|
917
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
918
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
919
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
920
|
-
*/
|
|
1195
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
921
1196
|
const chatgptTaglineSchema = z.string().max(30);
|
|
922
1197
|
const chatgptDescriptionSchema = z.string();
|
|
923
1198
|
const chatgptTranslationSchema = z.object({
|
|
@@ -926,10 +1201,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
926
1201
|
description: chatgptDescriptionSchema
|
|
927
1202
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
928
1203
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
929
|
-
/**
|
|
930
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
931
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
932
|
-
*/
|
|
1204
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
933
1205
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
934
1206
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
935
1207
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
@@ -955,6 +1227,17 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
955
1227
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
956
1228
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
957
1229
|
});
|
|
1230
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1231
|
+
tagline: z.string().optional(),
|
|
1232
|
+
companyUrl: z.string().optional(),
|
|
1233
|
+
supportChannel: z.string().optional(),
|
|
1234
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1235
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1236
|
+
demoRecordingUrl: z.string().optional(),
|
|
1237
|
+
serverUrl: z.string().optional(),
|
|
1238
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1239
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1240
|
+
});
|
|
958
1241
|
chatgptSubmissionFormDataSchema.pick({
|
|
959
1242
|
appName: true,
|
|
960
1243
|
developerName: true,
|
|
@@ -1015,11 +1298,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1015
1298
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1016
1299
|
"Public documentation for this connector will be live by the publish date."
|
|
1017
1300
|
]);
|
|
1018
|
-
/**
|
|
1019
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1020
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1021
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1022
|
-
*/
|
|
1301
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1023
1302
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1024
1303
|
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1025
1304
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1081,6 +1360,21 @@ fully populated account.`),
|
|
|
1081
1360
|
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1082
1361
|
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1083
1362
|
});
|
|
1363
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1364
|
+
serverUrl: z.string().optional(),
|
|
1365
|
+
name: z.string().optional(),
|
|
1366
|
+
slug: z.string().optional(),
|
|
1367
|
+
oneLiner: z.string().optional(),
|
|
1368
|
+
description: z.string().optional(),
|
|
1369
|
+
iconUrl: z.string().optional(),
|
|
1370
|
+
documentation: z.string().optional(),
|
|
1371
|
+
support: z.string().optional(),
|
|
1372
|
+
privacyPolicy: z.string().optional(),
|
|
1373
|
+
companyWebsite: z.string().optional(),
|
|
1374
|
+
primaryContactEmail: z.string().optional(),
|
|
1375
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1376
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1377
|
+
});
|
|
1084
1378
|
claudeSubmissionFormDataSchema.pick({
|
|
1085
1379
|
serverUrl: true,
|
|
1086
1380
|
name: true,
|
|
@@ -1096,12 +1390,7 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1096
1390
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1097
1391
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1098
1392
|
});
|
|
1099
|
-
/**
|
|
1100
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1101
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1102
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1103
|
-
* colocated with the Claude contract.
|
|
1104
|
-
*/
|
|
1393
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1105
1394
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1106
1395
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1107
1396
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
@@ -1121,14 +1410,19 @@ const submissionMetaFieldsSchema = z.object({
|
|
|
1121
1410
|
});
|
|
1122
1411
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1123
1412
|
platform: z.literal("claudeai"),
|
|
1124
|
-
formData:
|
|
1413
|
+
formData: claudeSubmissionDraftSchema
|
|
1125
1414
|
});
|
|
1126
1415
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1127
1416
|
platform: z.literal("chatgpt"),
|
|
1128
|
-
formData:
|
|
1417
|
+
formData: chatgptSubmissionDraftSchema
|
|
1129
1418
|
});
|
|
1130
1419
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1131
|
-
z.union([
|
|
1420
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1421
|
+
z.literal([
|
|
1422
|
+
100,
|
|
1423
|
+
75,
|
|
1424
|
+
50
|
|
1425
|
+
]);
|
|
1132
1426
|
const subscriptionPlanSchema = z.enum([
|
|
1133
1427
|
"pro",
|
|
1134
1428
|
"business",
|
|
@@ -1146,11 +1440,56 @@ const customerUsageSchema = z.object({
|
|
|
1146
1440
|
periodEnd: z.number()
|
|
1147
1441
|
});
|
|
1148
1442
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1443
|
+
z.object({ balanceInNanoUSD: z.number() });
|
|
1149
1444
|
z.object({
|
|
1150
1445
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1151
1446
|
customerUsage: customerUsageSchema.nullable(),
|
|
1152
1447
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1153
1448
|
});
|
|
1449
|
+
const telemetrySignalSchema = z.enum([
|
|
1450
|
+
"logs",
|
|
1451
|
+
"metrics",
|
|
1452
|
+
"traces"
|
|
1453
|
+
]);
|
|
1454
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1455
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1456
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1457
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1458
|
+
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");
|
|
1459
|
+
const logSeveritySchema = z.enum([
|
|
1460
|
+
"TRACE",
|
|
1461
|
+
"DEBUG",
|
|
1462
|
+
"INFO",
|
|
1463
|
+
"WARN",
|
|
1464
|
+
"ERROR",
|
|
1465
|
+
"FATAL"
|
|
1466
|
+
]);
|
|
1467
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1468
|
+
id: z.string(),
|
|
1469
|
+
name: otlpHeaderNameSchema,
|
|
1470
|
+
value: otlpHeaderValueSchema,
|
|
1471
|
+
isSecret: z.boolean()
|
|
1472
|
+
});
|
|
1473
|
+
z.object({
|
|
1474
|
+
id: z.string(),
|
|
1475
|
+
signal: telemetrySignalSchema,
|
|
1476
|
+
endpoint: otlpEndpointSchema,
|
|
1477
|
+
protocol: otlpProtocolSchema,
|
|
1478
|
+
minimumSeverity: logSeveritySchema,
|
|
1479
|
+
headers: z.array(telemetryDestinationHeaderSchema)
|
|
1480
|
+
});
|
|
1481
|
+
z.enum([
|
|
1482
|
+
"credentials",
|
|
1483
|
+
"wrong-path",
|
|
1484
|
+
"wrong-protocol",
|
|
1485
|
+
"invalid-payload",
|
|
1486
|
+
"partial-rejection",
|
|
1487
|
+
"blocked-target",
|
|
1488
|
+
"timeout",
|
|
1489
|
+
"unreachable",
|
|
1490
|
+
"receiver-error",
|
|
1491
|
+
"unexpected-status"
|
|
1492
|
+
]);
|
|
1154
1493
|
//#endregion
|
|
1155
1494
|
//#region src/auth-scope.ts
|
|
1156
1495
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1193,7 +1532,10 @@ const RESERVED_KEYS = [
|
|
|
1193
1532
|
"BUILD_ARG_START_COMMAND",
|
|
1194
1533
|
"ALPIC_HOST",
|
|
1195
1534
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1196
|
-
"ALPIC_INTENT_META_KEY"
|
|
1535
|
+
"ALPIC_INTENT_META_KEY",
|
|
1536
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1537
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1538
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1197
1539
|
];
|
|
1198
1540
|
const environmentVariableSchema = z.object({
|
|
1199
1541
|
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"),
|
|
@@ -1274,21 +1616,20 @@ const deploymentSchema = z.object({
|
|
|
1274
1616
|
isCurrent: z.boolean(),
|
|
1275
1617
|
deploymentPageUrl: z.url().nullable()
|
|
1276
1618
|
});
|
|
1277
|
-
const
|
|
1619
|
+
const isValidTimeInput = (value) => {
|
|
1278
1620
|
if (ms(value) !== void 0) return true;
|
|
1279
1621
|
return !Number.isNaN(new Date(value).getTime());
|
|
1280
1622
|
};
|
|
1281
|
-
const
|
|
1623
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1624
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1625
|
+
const createEnvironmentContractV1 = base.route({
|
|
1282
1626
|
path: "/v1/environments",
|
|
1283
1627
|
method: "POST",
|
|
1284
1628
|
summary: "Create an environment",
|
|
1285
1629
|
description: "Create an environment for a project",
|
|
1286
1630
|
tags: ["environments"],
|
|
1287
1631
|
successDescription: "The environment has been created successfully"
|
|
1288
|
-
}).errors({
|
|
1289
|
-
NOT_FOUND: {},
|
|
1290
|
-
BAD_REQUEST: {}
|
|
1291
|
-
}).input(z.object({
|
|
1632
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1292
1633
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1293
1634
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1294
1635
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1301,7 +1642,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1301
1642
|
createdAt: z.coerce.date(),
|
|
1302
1643
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1303
1644
|
}));
|
|
1304
|
-
const getEnvironmentContractV1 =
|
|
1645
|
+
const getEnvironmentContractV1 = base.route({
|
|
1305
1646
|
path: "/v1/environments/{environmentId}",
|
|
1306
1647
|
method: "GET",
|
|
1307
1648
|
summary: "Get an environment",
|
|
@@ -1358,7 +1699,7 @@ const projectOutputSchema = z.object({
|
|
|
1358
1699
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1359
1700
|
environments: z.array(environmentSchema)
|
|
1360
1701
|
});
|
|
1361
|
-
const getProjectContractV1 =
|
|
1702
|
+
const getProjectContractV1 = base.route({
|
|
1362
1703
|
path: "/v1/projects/{projectId}",
|
|
1363
1704
|
method: "GET",
|
|
1364
1705
|
summary: "Get a project",
|
|
@@ -1366,18 +1707,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1366
1707
|
tags: ["projects"],
|
|
1367
1708
|
successDescription: "The project details"
|
|
1368
1709
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1369
|
-
const listProjectsContractV1 =
|
|
1710
|
+
const listProjectsContractV1 = base.route({
|
|
1370
1711
|
path: "/v1/projects",
|
|
1371
1712
|
method: "GET",
|
|
1372
1713
|
summary: "List projects",
|
|
1373
1714
|
description: "List all projects for a team",
|
|
1374
1715
|
tags: ["projects"],
|
|
1375
1716
|
successDescription: "The list of projects"
|
|
1376
|
-
}).errors({
|
|
1377
|
-
|
|
1378
|
-
BAD_REQUEST: {}
|
|
1379
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1380
|
-
const createProjectContractV1 = oc.route({
|
|
1717
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1718
|
+
const createProjectContractV1 = base.route({
|
|
1381
1719
|
path: "/v1/projects",
|
|
1382
1720
|
method: "POST",
|
|
1383
1721
|
summary: "Create a project",
|
|
@@ -1386,7 +1724,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1386
1724
|
successDescription: "The project has been created successfully"
|
|
1387
1725
|
}).errors({
|
|
1388
1726
|
NOT_FOUND: {},
|
|
1389
|
-
BAD_REQUEST: {},
|
|
1390
1727
|
FORBIDDEN: {}
|
|
1391
1728
|
}).input(z.object({
|
|
1392
1729
|
teamId: z.string().optional(),
|
|
@@ -1427,7 +1764,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1427
1764
|
isSecret: z.boolean(),
|
|
1428
1765
|
createdAt: z.coerce.date()
|
|
1429
1766
|
});
|
|
1430
|
-
const listEnvironmentVariablesContractV1 =
|
|
1767
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1431
1768
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1432
1769
|
method: "GET",
|
|
1433
1770
|
summary: "List environment variables",
|
|
@@ -1435,48 +1772,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1435
1772
|
tags: ["environments"],
|
|
1436
1773
|
successDescription: "The list of environment variables"
|
|
1437
1774
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1438
|
-
const createEnvironmentVariablesContractV1 =
|
|
1775
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1439
1776
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1440
1777
|
method: "POST",
|
|
1441
1778
|
summary: "Add environment variables",
|
|
1442
1779
|
description: "Add one or more environment variables to an environment",
|
|
1443
1780
|
tags: ["environments"],
|
|
1444
1781
|
successDescription: "The environment variables have been added successfully"
|
|
1445
|
-
}).errors({
|
|
1446
|
-
NOT_FOUND: {},
|
|
1447
|
-
BAD_REQUEST: {}
|
|
1448
|
-
}).input(z.object({
|
|
1782
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1449
1783
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1450
1784
|
environmentVariables: environmentVariablesSchema
|
|
1451
1785
|
})).output(z.object({ success: z.literal(true) }));
|
|
1452
|
-
const updateEnvironmentVariableContractV1 =
|
|
1786
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1453
1787
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1454
1788
|
method: "PATCH",
|
|
1455
1789
|
summary: "Update an environment variable",
|
|
1456
1790
|
description: "Update an environment variable by ID",
|
|
1457
1791
|
tags: ["environments"],
|
|
1458
1792
|
successDescription: "The environment variable has been updated successfully"
|
|
1459
|
-
}).errors({
|
|
1460
|
-
NOT_FOUND: {},
|
|
1461
|
-
BAD_REQUEST: {}
|
|
1462
|
-
}).input(z.object({
|
|
1793
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1463
1794
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1464
1795
|
key: environmentVariableSchema.shape.key,
|
|
1465
1796
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1466
1797
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1467
1798
|
})).output(z.object({ success: z.literal(true) }));
|
|
1468
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1799
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1469
1800
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1470
1801
|
method: "DELETE",
|
|
1471
1802
|
summary: "Delete an environment variable",
|
|
1472
1803
|
description: "Delete an environment variable by ID",
|
|
1473
1804
|
tags: ["environments"],
|
|
1474
1805
|
successDescription: "The environment variable has been deleted successfully"
|
|
1475
|
-
}).errors({
|
|
1476
|
-
|
|
1477
|
-
BAD_REQUEST: {}
|
|
1478
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1479
|
-
const deleteProjectContractV1 = oc.route({
|
|
1806
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1807
|
+
const deleteProjectContractV1 = base.route({
|
|
1480
1808
|
path: "/v1/projects/{projectId}",
|
|
1481
1809
|
method: "DELETE",
|
|
1482
1810
|
summary: "Delete a project",
|
|
@@ -1484,7 +1812,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1484
1812
|
tags: ["projects"],
|
|
1485
1813
|
successDescription: "The project has been deleted successfully"
|
|
1486
1814
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1487
|
-
const updateProjectContractV1 =
|
|
1815
|
+
const updateProjectContractV1 = base.route({
|
|
1488
1816
|
path: "/v1/projects/{projectId}",
|
|
1489
1817
|
method: "PATCH",
|
|
1490
1818
|
summary: "Update a project",
|
|
@@ -1493,14 +1821,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1493
1821
|
successDescription: "The project has been updated successfully"
|
|
1494
1822
|
}).errors({
|
|
1495
1823
|
NOT_FOUND: {},
|
|
1496
|
-
BAD_REQUEST: {},
|
|
1497
1824
|
FORBIDDEN: {}
|
|
1498
1825
|
}).input(z.object({
|
|
1499
1826
|
projectId: z.string().describe("The ID of the project"),
|
|
1500
1827
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1501
1828
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1502
1829
|
})).output(projectOutputSchema);
|
|
1503
|
-
const deployEnvironmentContractV1 =
|
|
1830
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1504
1831
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1505
1832
|
method: "POST",
|
|
1506
1833
|
summary: "Deploy an environment",
|
|
@@ -1509,27 +1836,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1509
1836
|
successDescription: "The environment has been deployed successfully"
|
|
1510
1837
|
}).errors({
|
|
1511
1838
|
NOT_FOUND: {},
|
|
1512
|
-
|
|
1839
|
+
CONFLICT: {}
|
|
1513
1840
|
}).input(z.object({
|
|
1514
1841
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1515
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1842
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1843
|
+
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.")
|
|
1516
1844
|
})).output(deploymentSchema);
|
|
1517
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1845
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1518
1846
|
path: "/v1/deployments/upload",
|
|
1519
1847
|
method: "POST",
|
|
1520
1848
|
summary: "Upload deployment artifacts",
|
|
1521
1849
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1522
1850
|
tags: ["deployments"],
|
|
1523
1851
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1524
|
-
}).errors({
|
|
1525
|
-
NOT_FOUND: {},
|
|
1526
|
-
BAD_REQUEST: {}
|
|
1527
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1852
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1528
1853
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1529
1854
|
token: z.string().describe("Token to identify the source archive"),
|
|
1530
1855
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1531
1856
|
}));
|
|
1532
|
-
const listDeploymentsContractV1 =
|
|
1857
|
+
const listDeploymentsContractV1 = base.route({
|
|
1533
1858
|
path: "/v1/projects/{projectId}/deployments",
|
|
1534
1859
|
method: "GET",
|
|
1535
1860
|
summary: "List project deployments",
|
|
@@ -1541,7 +1866,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1541
1866
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1542
1867
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1543
1868
|
})).output(z.array(deploymentSchema));
|
|
1544
|
-
const getDeploymentContractV1 =
|
|
1869
|
+
const getDeploymentContractV1 = base.route({
|
|
1545
1870
|
path: "/v1/deployments/{deploymentId}",
|
|
1546
1871
|
method: "GET",
|
|
1547
1872
|
summary: "Get a deployment",
|
|
@@ -1549,20 +1874,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1549
1874
|
tags: ["deployments"],
|
|
1550
1875
|
successDescription: "The deployment details"
|
|
1551
1876
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1552
|
-
const
|
|
1877
|
+
const logEntrySchema = z.object({
|
|
1878
|
+
timestamp: z.coerce.date(),
|
|
1879
|
+
type: z.enum([
|
|
1880
|
+
"START",
|
|
1881
|
+
"END",
|
|
1882
|
+
"INFO",
|
|
1883
|
+
"ERROR",
|
|
1884
|
+
"WARNING",
|
|
1885
|
+
"DEBUG"
|
|
1886
|
+
]),
|
|
1887
|
+
requestId: z.string(),
|
|
1888
|
+
content: z.string().optional(),
|
|
1889
|
+
method: z.string().optional(),
|
|
1890
|
+
durationInMs: z.number().optional()
|
|
1891
|
+
});
|
|
1892
|
+
const getLogsContractV1 = base.route({
|
|
1553
1893
|
path: "/v1/environments/{environmentId}/logs",
|
|
1554
1894
|
method: "GET",
|
|
1555
1895
|
summary: "Get logs",
|
|
1556
1896
|
description: "Get logs for an environment",
|
|
1557
1897
|
tags: ["environments"],
|
|
1558
1898
|
successDescription: "The logs"
|
|
1559
|
-
}).errors({
|
|
1560
|
-
NOT_FOUND: {},
|
|
1561
|
-
BAD_REQUEST: {}
|
|
1562
|
-
}).input(z.object({
|
|
1899
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1563
1900
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1564
|
-
since:
|
|
1565
|
-
until:
|
|
1901
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1902
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1566
1903
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1567
1904
|
level: z.array(z.enum([
|
|
1568
1905
|
"INFO",
|
|
@@ -1573,34 +1910,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1573
1910
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1574
1911
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1575
1912
|
})).output(z.object({
|
|
1576
|
-
logs: z.array(
|
|
1577
|
-
timestamp: z.coerce.date(),
|
|
1578
|
-
type: z.enum([
|
|
1579
|
-
"START",
|
|
1580
|
-
"END",
|
|
1581
|
-
"INFO",
|
|
1582
|
-
"ERROR",
|
|
1583
|
-
"WARNING",
|
|
1584
|
-
"DEBUG"
|
|
1585
|
-
]),
|
|
1586
|
-
requestId: z.string(),
|
|
1587
|
-
content: z.string().optional(),
|
|
1588
|
-
method: z.string().optional(),
|
|
1589
|
-
durationInMs: z.number().optional()
|
|
1590
|
-
})),
|
|
1913
|
+
logs: z.array(logEntrySchema),
|
|
1591
1914
|
nextToken: z.string().nullable()
|
|
1592
1915
|
}));
|
|
1593
|
-
const getLatestLogsContractV1 =
|
|
1916
|
+
const getLatestLogsContractV1 = base.route({
|
|
1594
1917
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1595
1918
|
method: "GET",
|
|
1596
1919
|
summary: "Get latest logs",
|
|
1597
1920
|
description: "Get the N most recent logs for an environment",
|
|
1598
1921
|
tags: ["environments"],
|
|
1599
1922
|
successDescription: "The latest logs"
|
|
1600
|
-
}).errors({
|
|
1601
|
-
NOT_FOUND: {},
|
|
1602
|
-
BAD_REQUEST: {}
|
|
1603
|
-
}).input(z.object({
|
|
1923
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1604
1924
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1605
1925
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1606
1926
|
level: z.array(z.enum([
|
|
@@ -1610,22 +1930,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1610
1930
|
"DEBUG"
|
|
1611
1931
|
])).optional().describe("Filter by log level"),
|
|
1612
1932
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1613
|
-
})).output(z.object({ logs: z.array(
|
|
1614
|
-
|
|
1615
|
-
type: z.enum([
|
|
1616
|
-
"START",
|
|
1617
|
-
"END",
|
|
1618
|
-
"INFO",
|
|
1619
|
-
"ERROR",
|
|
1620
|
-
"WARNING",
|
|
1621
|
-
"DEBUG"
|
|
1622
|
-
]),
|
|
1623
|
-
requestId: z.string(),
|
|
1624
|
-
content: z.string().optional(),
|
|
1625
|
-
method: z.string().optional(),
|
|
1626
|
-
durationInMs: z.number().optional()
|
|
1627
|
-
})) }));
|
|
1628
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1933
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1934
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1629
1935
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1630
1936
|
method: "GET",
|
|
1631
1937
|
summary: "Get deployment logs",
|
|
@@ -1652,22 +1958,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1652
1958
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1653
1959
|
task_count: z.array(analyticsDataPointSchema)
|
|
1654
1960
|
});
|
|
1655
|
-
const getProjectAnalyticsContractV1 =
|
|
1961
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1656
1962
|
path: "/v1/analytics/{projectId}",
|
|
1657
1963
|
method: "GET",
|
|
1658
1964
|
summary: "Get project analytics",
|
|
1659
1965
|
description: "Get analytics data for a project over a time range",
|
|
1660
1966
|
tags: ["analytics"],
|
|
1661
1967
|
successDescription: "The project analytics data"
|
|
1662
|
-
}).errors({
|
|
1663
|
-
NOT_FOUND: {},
|
|
1664
|
-
BAD_REQUEST: {}
|
|
1665
|
-
}).input(z.object({
|
|
1968
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1666
1969
|
projectId: z.string().describe("The ID of the project"),
|
|
1667
1970
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1668
1971
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1669
1972
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1670
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
1973
|
+
}).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({
|
|
1671
1974
|
metadata: z.object({
|
|
1672
1975
|
startTimestamp: z.number(),
|
|
1673
1976
|
endTimestamp: z.number(),
|
|
@@ -1677,7 +1980,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1677
1980
|
}),
|
|
1678
1981
|
timeSeries: analyticsTimeSeriesSchema
|
|
1679
1982
|
}));
|
|
1680
|
-
const
|
|
1983
|
+
const paginatedInsightsInputShape = {
|
|
1984
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1985
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1986
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1987
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1988
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1989
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1990
|
+
};
|
|
1991
|
+
const listIntentsContractV1 = base.route({
|
|
1992
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1993
|
+
method: "GET",
|
|
1994
|
+
summary: "List intents",
|
|
1995
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1996
|
+
tags: ["insights"],
|
|
1997
|
+
successDescription: "The grouped user intents"
|
|
1998
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1999
|
+
...paginatedInsightsInputShape,
|
|
2000
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2001
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2002
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2003
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2004
|
+
})).output(z.object({
|
|
2005
|
+
intents: z.array(z.object({
|
|
2006
|
+
id: z.string(),
|
|
2007
|
+
intentIds: z.array(z.string()).min(1),
|
|
2008
|
+
environmentId: z.string(),
|
|
2009
|
+
message: z.string(),
|
|
2010
|
+
toolName: z.string(),
|
|
2011
|
+
createdAt: z.coerce.date(),
|
|
2012
|
+
occurrenceCount: z.number().int().positive(),
|
|
2013
|
+
clientName: z.string().nullable(),
|
|
2014
|
+
clientId: z.string().nullable(),
|
|
2015
|
+
categories: z.array(z.object({
|
|
2016
|
+
id: z.string(),
|
|
2017
|
+
name: z.string(),
|
|
2018
|
+
color: intentCategoryColorSchema
|
|
2019
|
+
}))
|
|
2020
|
+
})),
|
|
2021
|
+
totalCount: z.number().int().nonnegative()
|
|
2022
|
+
}));
|
|
2023
|
+
const listFeedbacksContractV1 = base.route({
|
|
2024
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2025
|
+
method: "GET",
|
|
2026
|
+
summary: "List feedbacks",
|
|
2027
|
+
description: "List user feedback for an environment over a time range",
|
|
2028
|
+
tags: ["insights"],
|
|
2029
|
+
successDescription: "The user feedback"
|
|
2030
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2031
|
+
...paginatedInsightsInputShape,
|
|
2032
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2033
|
+
})).output(z.object({
|
|
2034
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2035
|
+
totalCount: z.number().int().nonnegative()
|
|
2036
|
+
}));
|
|
2037
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2038
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2039
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2040
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2041
|
+
method: "GET",
|
|
2042
|
+
summary: "List intent categories",
|
|
2043
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2044
|
+
tags: ["insights"],
|
|
2045
|
+
successDescription: "The intent categories"
|
|
2046
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2047
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2048
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2049
|
+
method: "POST",
|
|
2050
|
+
summary: "Create an intent category",
|
|
2051
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2052
|
+
tags: ["insights"],
|
|
2053
|
+
successDescription: "The created intent category"
|
|
2054
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2055
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2056
|
+
name: intentCategoryNameSchema,
|
|
2057
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2058
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2059
|
+
})).output(intentCategorySchema);
|
|
2060
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2061
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2062
|
+
method: "PATCH",
|
|
2063
|
+
summary: "Update an intent category",
|
|
2064
|
+
description: "Rename or recolor an intent category",
|
|
2065
|
+
tags: ["insights"],
|
|
2066
|
+
successDescription: "The updated intent category"
|
|
2067
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2068
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2069
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2070
|
+
name: intentCategoryNameSchema.optional(),
|
|
2071
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2072
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2073
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2074
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2075
|
+
method: "DELETE",
|
|
2076
|
+
summary: "Delete an intent category",
|
|
2077
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2078
|
+
tags: ["insights"],
|
|
2079
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2080
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2081
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2082
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2083
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2084
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2085
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2086
|
+
method: "POST",
|
|
2087
|
+
summary: "Link an intent category",
|
|
2088
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2089
|
+
tags: ["insights"],
|
|
2090
|
+
successDescription: "The intents have been linked successfully"
|
|
2091
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2092
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2093
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2094
|
+
intentIds: categorizableIntentIdsSchema
|
|
2095
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2096
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2097
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2098
|
+
method: "POST",
|
|
2099
|
+
summary: "Unlink an intent category",
|
|
2100
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2101
|
+
tags: ["insights"],
|
|
2102
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2103
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2104
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2105
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2106
|
+
intentIds: categorizableIntentIdsSchema
|
|
2107
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2108
|
+
const listTeamsContractV1 = base.route({
|
|
1681
2109
|
path: "/v1/teams",
|
|
1682
2110
|
method: "GET",
|
|
1683
2111
|
summary: "List teams",
|
|
@@ -1690,7 +2118,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1690
2118
|
createdAt: z.coerce.date(),
|
|
1691
2119
|
hasStripeAccount: z.boolean()
|
|
1692
2120
|
})));
|
|
1693
|
-
const
|
|
2121
|
+
const getTeamUsageContractV1 = base.route({
|
|
2122
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2123
|
+
method: "GET",
|
|
2124
|
+
summary: "Get team usage",
|
|
2125
|
+
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.",
|
|
2126
|
+
tags: ["teams"],
|
|
2127
|
+
successDescription: "The current billing window usage"
|
|
2128
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2129
|
+
teamId: z.string(),
|
|
2130
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2131
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2132
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2133
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2134
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2135
|
+
}));
|
|
2136
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1694
2137
|
path: "/v1/tunnels/ticket",
|
|
1695
2138
|
method: "GET",
|
|
1696
2139
|
summary: "Get a tunnel ticket",
|
|
@@ -1702,16 +2145,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1702
2145
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1703
2146
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1704
2147
|
}));
|
|
1705
|
-
const publishServerContractV1 =
|
|
2148
|
+
const publishServerContractV1 = base.route({
|
|
1706
2149
|
path: "/v1/distribution/publish",
|
|
1707
2150
|
method: "POST",
|
|
1708
2151
|
summary: "Publish a server to the MCP registry",
|
|
1709
2152
|
tags: ["distribution"],
|
|
1710
2153
|
successDescription: "The server has been published successfully"
|
|
1711
|
-
}).errors({
|
|
1712
|
-
NOT_FOUND: {},
|
|
1713
|
-
BAD_REQUEST: {}
|
|
1714
|
-
}).input(z.object({
|
|
2154
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1715
2155
|
projectId: z.string(),
|
|
1716
2156
|
domain: z.string(),
|
|
1717
2157
|
title: z.string().min(1).max(100),
|
|
@@ -1720,17 +2160,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1720
2160
|
iconSrc: z.url().max(255).optional(),
|
|
1721
2161
|
dryRun: z.boolean().optional()
|
|
1722
2162
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1723
|
-
const getServerInfoContractV1 =
|
|
2163
|
+
const getServerInfoContractV1 = base.route({
|
|
1724
2164
|
path: "/v1/distribution/get",
|
|
1725
2165
|
method: "GET",
|
|
1726
2166
|
summary: "Get server info",
|
|
1727
2167
|
description: "Get info about a server",
|
|
1728
2168
|
tags: ["distribution"],
|
|
1729
2169
|
successDescription: "The server info"
|
|
1730
|
-
}).errors({
|
|
1731
|
-
NOT_FOUND: {},
|
|
1732
|
-
BAD_REQUEST: {}
|
|
1733
|
-
}).input(z.object({
|
|
2170
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1734
2171
|
projectId: z.string(),
|
|
1735
2172
|
domain: z.string()
|
|
1736
2173
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1749,7 +2186,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1749
2186
|
isPlaygroundEnabled: z.boolean(),
|
|
1750
2187
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1751
2188
|
});
|
|
1752
|
-
const getPlaygroundContractV1 =
|
|
2189
|
+
const getPlaygroundContractV1 = base.route({
|
|
1753
2190
|
path: "/v1/environments/{environmentId}/playground",
|
|
1754
2191
|
method: "GET",
|
|
1755
2192
|
summary: "Get playground configuration",
|
|
@@ -1757,17 +2194,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1757
2194
|
tags: ["environments"],
|
|
1758
2195
|
successDescription: "The playground configuration"
|
|
1759
2196
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1760
|
-
const upsertPlaygroundContractV1 =
|
|
2197
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1761
2198
|
path: "/v1/environments/{environmentId}/playground",
|
|
1762
2199
|
method: "PUT",
|
|
1763
2200
|
summary: "Update playground configuration",
|
|
1764
2201
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1765
2202
|
tags: ["environments"],
|
|
1766
2203
|
successDescription: "The updated playground configuration"
|
|
1767
|
-
}).errors({
|
|
1768
|
-
NOT_FOUND: {},
|
|
1769
|
-
BAD_REQUEST: {}
|
|
1770
|
-
}).input(z.object({
|
|
2204
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1771
2205
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1772
2206
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1773
2207
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1775,7 +2209,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1775
2209
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1776
2210
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1777
2211
|
})).output(playgroundOutputSchema);
|
|
1778
|
-
const createBeaconContractV1 =
|
|
2212
|
+
const createBeaconContractV1 = base.route({
|
|
1779
2213
|
path: "/v1/beacon/audits",
|
|
1780
2214
|
method: "POST",
|
|
1781
2215
|
summary: "Create a beacon audit",
|
|
@@ -1784,7 +2218,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1784
2218
|
successDescription: "The audit has been created"
|
|
1785
2219
|
}).errors({
|
|
1786
2220
|
NOT_FOUND: {},
|
|
1787
|
-
BAD_REQUEST: {},
|
|
1788
2221
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1789
2222
|
}).input(z.object({
|
|
1790
2223
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1792,7 +2225,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1792
2225
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1793
2226
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1794
2227
|
})).output(z.object({ id: z.string() }));
|
|
1795
|
-
const getBeaconContractV1 =
|
|
2228
|
+
const getBeaconContractV1 = base.route({
|
|
1796
2229
|
path: "/v1/beacon/audits/{auditId}",
|
|
1797
2230
|
method: "GET",
|
|
1798
2231
|
summary: "Get a beacon audit",
|
|
@@ -1808,8 +2241,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1808
2241
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1809
2242
|
}));
|
|
1810
2243
|
const contract = {
|
|
1811
|
-
teams: {
|
|
2244
|
+
teams: {
|
|
2245
|
+
list: { v1: listTeamsContractV1 },
|
|
2246
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2247
|
+
},
|
|
1812
2248
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2249
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2250
|
+
intentCategories: {
|
|
2251
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2252
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2253
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2254
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2255
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2256
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2257
|
+
},
|
|
2258
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1813
2259
|
deployments: {
|
|
1814
2260
|
list: { v1: listDeploymentsContractV1 },
|
|
1815
2261
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1850,5 +2296,10 @@ const contract = {
|
|
|
1850
2296
|
get: { v1: getBeaconContractV1 }
|
|
1851
2297
|
}
|
|
1852
2298
|
};
|
|
2299
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2300
|
+
const contractForDocs = {
|
|
2301
|
+
...contract,
|
|
2302
|
+
deployments: deploymentsForDocs
|
|
2303
|
+
};
|
|
1853
2304
|
//#endregion
|
|
1854
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2305
|
+
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 };
|