@alpic-ai/api 0.0.0-dev.gfdd78d0 → 0.0.0-dev.gfde8b9e
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 +649 -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,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,13 @@ 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
|
|
343
382
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
383
|
const playgroundModelSchema = z.enum([
|
|
346
384
|
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
347
385
|
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
@@ -381,14 +419,16 @@ z.object({
|
|
|
381
419
|
collectRequestPayload: z.boolean(),
|
|
382
420
|
collectResponsePayload: z.boolean(),
|
|
383
421
|
collectErrorMessage: z.boolean(),
|
|
384
|
-
collectUserData: z.boolean()
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
385
424
|
});
|
|
386
|
-
z.object({
|
|
425
|
+
const feedbackSchema = z.object({
|
|
387
426
|
id: z.string(),
|
|
388
427
|
createdAt: z.coerce.date(),
|
|
389
428
|
environmentId: z.string(),
|
|
390
429
|
content: z.string(),
|
|
391
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
392
432
|
});
|
|
393
433
|
z.object({
|
|
394
434
|
content: z.string(),
|
|
@@ -404,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
404
444
|
"pink",
|
|
405
445
|
"gray"
|
|
406
446
|
]);
|
|
407
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
408
448
|
const intentCategorySchema = z.object({
|
|
409
449
|
id: z.string(),
|
|
410
450
|
createdAt: z.coerce.date(),
|
|
@@ -412,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
412
452
|
name: z.string(),
|
|
413
453
|
color: intentCategoryColorSchema
|
|
414
454
|
});
|
|
415
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
416
456
|
id: z.string(),
|
|
417
457
|
name: z.string(),
|
|
418
458
|
color: intentCategoryColorSchema,
|
|
@@ -424,6 +464,7 @@ z.object({
|
|
|
424
464
|
environmentId: z.string(),
|
|
425
465
|
toolName: z.string(),
|
|
426
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
427
468
|
categories: z.array(intentCategorySchema)
|
|
428
469
|
});
|
|
429
470
|
const signalCategorySchema = z.object({
|
|
@@ -482,12 +523,262 @@ z.object({
|
|
|
482
523
|
createdAt: z.coerce.date(),
|
|
483
524
|
updatedAt: z.coerce.date()
|
|
484
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]);
|
|
485
536
|
z.enum([
|
|
486
537
|
"INFO",
|
|
487
538
|
"WARNING",
|
|
488
539
|
"DEBUG",
|
|
489
540
|
"ERROR"
|
|
490
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]));
|
|
491
782
|
const runtimeSchema = z.enum([
|
|
492
783
|
"python3.13",
|
|
493
784
|
"python3.14",
|
|
@@ -522,6 +813,10 @@ const domainFailureReasonSchema = z.enum([
|
|
|
522
813
|
"invalid_domain",
|
|
523
814
|
"other"
|
|
524
815
|
]);
|
|
816
|
+
const projectDomainMappingSchema = z.object({
|
|
817
|
+
pathPrefix: z.string(),
|
|
818
|
+
environment: environmentSchema$1
|
|
819
|
+
});
|
|
525
820
|
z.object({
|
|
526
821
|
name: z.string(),
|
|
527
822
|
createdAt: z.coerce.date(),
|
|
@@ -531,7 +826,8 @@ z.object({
|
|
|
531
826
|
"failed"
|
|
532
827
|
]),
|
|
533
828
|
failureReason: domainFailureReasonSchema.nullable(),
|
|
534
|
-
environment: environmentSchema$1
|
|
829
|
+
environment: environmentSchema$1,
|
|
830
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
535
831
|
});
|
|
536
832
|
const serverFieldsSchema$1 = z.object({
|
|
537
833
|
$schema: z.string(),
|
|
@@ -560,15 +856,7 @@ z.object({
|
|
|
560
856
|
serverFields: serverFieldsSchema$1,
|
|
561
857
|
source: z.enum(["registry", "defaults"])
|
|
562
858
|
});
|
|
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
|
-
*/
|
|
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. */
|
|
572
860
|
const clampStringField = (field) => {
|
|
573
861
|
const max = field.maxLength;
|
|
574
862
|
if (max === null) return field;
|
|
@@ -595,8 +883,9 @@ const positiveTestCaseSchema = z.object({
|
|
|
595
883
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
596
884
|
const screenshotEntrySchema = z.object({
|
|
597
885
|
prompt: z.string(),
|
|
598
|
-
url: z.url()
|
|
886
|
+
url: z.url()
|
|
599
887
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
888
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
600
889
|
/** Accepts either a valid email or URL. */
|
|
601
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" });
|
|
602
891
|
/** A URL field whose error spells out that the scheme is required. */
|
|
@@ -913,11 +1202,7 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
913
1202
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
914
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.\"")
|
|
915
1204
|
}).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
|
-
*/
|
|
1205
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
921
1206
|
const chatgptTaglineSchema = z.string().max(30);
|
|
922
1207
|
const chatgptDescriptionSchema = z.string();
|
|
923
1208
|
const chatgptTranslationSchema = z.object({
|
|
@@ -926,10 +1211,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
926
1211
|
description: chatgptDescriptionSchema
|
|
927
1212
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
928
1213
|
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
|
-
*/
|
|
1214
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
933
1215
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
934
1216
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
935
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."),
|
|
@@ -955,6 +1237,17 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
955
1237
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
956
1238
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
957
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
|
+
});
|
|
958
1251
|
chatgptSubmissionFormDataSchema.pick({
|
|
959
1252
|
appName: true,
|
|
960
1253
|
developerName: true,
|
|
@@ -1015,11 +1308,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1015
1308
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1016
1309
|
"Public documentation for this connector will be live by the publish date."
|
|
1017
1310
|
]);
|
|
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
|
-
*/
|
|
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. */
|
|
1023
1312
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1024
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
|
|
1025
1314
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1081,6 +1370,21 @@ fully populated account.`),
|
|
|
1081
1370
|
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1082
1371
|
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1083
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
|
+
});
|
|
1084
1388
|
claudeSubmissionFormDataSchema.pick({
|
|
1085
1389
|
serverUrl: true,
|
|
1086
1390
|
name: true,
|
|
@@ -1096,12 +1400,7 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1096
1400
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1097
1401
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1098
1402
|
});
|
|
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
|
-
*/
|
|
1403
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1105
1404
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1106
1405
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1107
1406
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
@@ -1121,14 +1420,19 @@ const submissionMetaFieldsSchema = z.object({
|
|
|
1121
1420
|
});
|
|
1122
1421
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1123
1422
|
platform: z.literal("claudeai"),
|
|
1124
|
-
formData:
|
|
1423
|
+
formData: claudeSubmissionDraftSchema
|
|
1125
1424
|
});
|
|
1126
1425
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1127
1426
|
platform: z.literal("chatgpt"),
|
|
1128
|
-
formData:
|
|
1427
|
+
formData: chatgptSubmissionDraftSchema
|
|
1129
1428
|
});
|
|
1130
1429
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1131
|
-
z.union([
|
|
1430
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1431
|
+
z.literal([
|
|
1432
|
+
100,
|
|
1433
|
+
75,
|
|
1434
|
+
50
|
|
1435
|
+
]);
|
|
1132
1436
|
const subscriptionPlanSchema = z.enum([
|
|
1133
1437
|
"pro",
|
|
1134
1438
|
"business",
|
|
@@ -1151,6 +1455,44 @@ z.object({
|
|
|
1151
1455
|
customerUsage: customerUsageSchema.nullable(),
|
|
1152
1456
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1153
1457
|
});
|
|
1458
|
+
const telemetrySignalSchema = z.enum([
|
|
1459
|
+
"logs",
|
|
1460
|
+
"metrics",
|
|
1461
|
+
"traces"
|
|
1462
|
+
]);
|
|
1463
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1464
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1465
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1466
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1467
|
+
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");
|
|
1468
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1469
|
+
id: z.string(),
|
|
1470
|
+
name: otlpHeaderNameSchema,
|
|
1471
|
+
value: otlpHeaderValueSchema,
|
|
1472
|
+
isSecret: z.boolean()
|
|
1473
|
+
});
|
|
1474
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1475
|
+
"credentials",
|
|
1476
|
+
"wrong-path",
|
|
1477
|
+
"wrong-protocol",
|
|
1478
|
+
"invalid-payload",
|
|
1479
|
+
"partial-rejection",
|
|
1480
|
+
"blocked-target",
|
|
1481
|
+
"timeout",
|
|
1482
|
+
"unreachable",
|
|
1483
|
+
"receiver-error",
|
|
1484
|
+
"unexpected-status"
|
|
1485
|
+
]);
|
|
1486
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1487
|
+
z.object({
|
|
1488
|
+
id: z.string(),
|
|
1489
|
+
signal: telemetrySignalSchema,
|
|
1490
|
+
endpoint: otlpEndpointSchema,
|
|
1491
|
+
protocol: otlpProtocolSchema,
|
|
1492
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1493
|
+
status: telemetryDestinationStatusSchema,
|
|
1494
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1495
|
+
});
|
|
1154
1496
|
//#endregion
|
|
1155
1497
|
//#region src/auth-scope.ts
|
|
1156
1498
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1193,7 +1535,10 @@ const RESERVED_KEYS = [
|
|
|
1193
1535
|
"BUILD_ARG_START_COMMAND",
|
|
1194
1536
|
"ALPIC_HOST",
|
|
1195
1537
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1196
|
-
"ALPIC_INTENT_META_KEY"
|
|
1538
|
+
"ALPIC_INTENT_META_KEY",
|
|
1539
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1540
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1541
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1197
1542
|
];
|
|
1198
1543
|
const environmentVariableSchema = z.object({
|
|
1199
1544
|
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 +1619,20 @@ const deploymentSchema = z.object({
|
|
|
1274
1619
|
isCurrent: z.boolean(),
|
|
1275
1620
|
deploymentPageUrl: z.url().nullable()
|
|
1276
1621
|
});
|
|
1277
|
-
const
|
|
1622
|
+
const isValidTimeInput = (value) => {
|
|
1278
1623
|
if (ms(value) !== void 0) return true;
|
|
1279
1624
|
return !Number.isNaN(new Date(value).getTime());
|
|
1280
1625
|
};
|
|
1281
|
-
const
|
|
1626
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1627
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1628
|
+
const createEnvironmentContractV1 = base.route({
|
|
1282
1629
|
path: "/v1/environments",
|
|
1283
1630
|
method: "POST",
|
|
1284
1631
|
summary: "Create an environment",
|
|
1285
1632
|
description: "Create an environment for a project",
|
|
1286
1633
|
tags: ["environments"],
|
|
1287
1634
|
successDescription: "The environment has been created successfully"
|
|
1288
|
-
}).errors({
|
|
1289
|
-
NOT_FOUND: {},
|
|
1290
|
-
BAD_REQUEST: {}
|
|
1291
|
-
}).input(z.object({
|
|
1635
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1292
1636
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1293
1637
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1294
1638
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1301,7 +1645,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1301
1645
|
createdAt: z.coerce.date(),
|
|
1302
1646
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1303
1647
|
}));
|
|
1304
|
-
const getEnvironmentContractV1 =
|
|
1648
|
+
const getEnvironmentContractV1 = base.route({
|
|
1305
1649
|
path: "/v1/environments/{environmentId}",
|
|
1306
1650
|
method: "GET",
|
|
1307
1651
|
summary: "Get an environment",
|
|
@@ -1358,7 +1702,7 @@ const projectOutputSchema = z.object({
|
|
|
1358
1702
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1359
1703
|
environments: z.array(environmentSchema)
|
|
1360
1704
|
});
|
|
1361
|
-
const getProjectContractV1 =
|
|
1705
|
+
const getProjectContractV1 = base.route({
|
|
1362
1706
|
path: "/v1/projects/{projectId}",
|
|
1363
1707
|
method: "GET",
|
|
1364
1708
|
summary: "Get a project",
|
|
@@ -1366,18 +1710,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1366
1710
|
tags: ["projects"],
|
|
1367
1711
|
successDescription: "The project details"
|
|
1368
1712
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1369
|
-
const listProjectsContractV1 =
|
|
1713
|
+
const listProjectsContractV1 = base.route({
|
|
1370
1714
|
path: "/v1/projects",
|
|
1371
1715
|
method: "GET",
|
|
1372
1716
|
summary: "List projects",
|
|
1373
1717
|
description: "List all projects for a team",
|
|
1374
1718
|
tags: ["projects"],
|
|
1375
1719
|
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({
|
|
1720
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1721
|
+
const createProjectContractV1 = base.route({
|
|
1381
1722
|
path: "/v1/projects",
|
|
1382
1723
|
method: "POST",
|
|
1383
1724
|
summary: "Create a project",
|
|
@@ -1386,7 +1727,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1386
1727
|
successDescription: "The project has been created successfully"
|
|
1387
1728
|
}).errors({
|
|
1388
1729
|
NOT_FOUND: {},
|
|
1389
|
-
BAD_REQUEST: {},
|
|
1390
1730
|
FORBIDDEN: {}
|
|
1391
1731
|
}).input(z.object({
|
|
1392
1732
|
teamId: z.string().optional(),
|
|
@@ -1427,7 +1767,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1427
1767
|
isSecret: z.boolean(),
|
|
1428
1768
|
createdAt: z.coerce.date()
|
|
1429
1769
|
});
|
|
1430
|
-
const listEnvironmentVariablesContractV1 =
|
|
1770
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1431
1771
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1432
1772
|
method: "GET",
|
|
1433
1773
|
summary: "List environment variables",
|
|
@@ -1435,48 +1775,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1435
1775
|
tags: ["environments"],
|
|
1436
1776
|
successDescription: "The list of environment variables"
|
|
1437
1777
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1438
|
-
const createEnvironmentVariablesContractV1 =
|
|
1778
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1439
1779
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1440
1780
|
method: "POST",
|
|
1441
1781
|
summary: "Add environment variables",
|
|
1442
1782
|
description: "Add one or more environment variables to an environment",
|
|
1443
1783
|
tags: ["environments"],
|
|
1444
1784
|
successDescription: "The environment variables have been added successfully"
|
|
1445
|
-
}).errors({
|
|
1446
|
-
NOT_FOUND: {},
|
|
1447
|
-
BAD_REQUEST: {}
|
|
1448
|
-
}).input(z.object({
|
|
1785
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1449
1786
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1450
1787
|
environmentVariables: environmentVariablesSchema
|
|
1451
1788
|
})).output(z.object({ success: z.literal(true) }));
|
|
1452
|
-
const updateEnvironmentVariableContractV1 =
|
|
1789
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1453
1790
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1454
1791
|
method: "PATCH",
|
|
1455
1792
|
summary: "Update an environment variable",
|
|
1456
1793
|
description: "Update an environment variable by ID",
|
|
1457
1794
|
tags: ["environments"],
|
|
1458
1795
|
successDescription: "The environment variable has been updated successfully"
|
|
1459
|
-
}).errors({
|
|
1460
|
-
NOT_FOUND: {},
|
|
1461
|
-
BAD_REQUEST: {}
|
|
1462
|
-
}).input(z.object({
|
|
1796
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1463
1797
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1464
1798
|
key: environmentVariableSchema.shape.key,
|
|
1465
1799
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1466
1800
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1467
1801
|
})).output(z.object({ success: z.literal(true) }));
|
|
1468
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1802
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1469
1803
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1470
1804
|
method: "DELETE",
|
|
1471
1805
|
summary: "Delete an environment variable",
|
|
1472
1806
|
description: "Delete an environment variable by ID",
|
|
1473
1807
|
tags: ["environments"],
|
|
1474
1808
|
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({
|
|
1809
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1810
|
+
const deleteProjectContractV1 = base.route({
|
|
1480
1811
|
path: "/v1/projects/{projectId}",
|
|
1481
1812
|
method: "DELETE",
|
|
1482
1813
|
summary: "Delete a project",
|
|
@@ -1484,7 +1815,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1484
1815
|
tags: ["projects"],
|
|
1485
1816
|
successDescription: "The project has been deleted successfully"
|
|
1486
1817
|
}).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 =
|
|
1818
|
+
const updateProjectContractV1 = base.route({
|
|
1488
1819
|
path: "/v1/projects/{projectId}",
|
|
1489
1820
|
method: "PATCH",
|
|
1490
1821
|
summary: "Update a project",
|
|
@@ -1493,14 +1824,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1493
1824
|
successDescription: "The project has been updated successfully"
|
|
1494
1825
|
}).errors({
|
|
1495
1826
|
NOT_FOUND: {},
|
|
1496
|
-
BAD_REQUEST: {},
|
|
1497
1827
|
FORBIDDEN: {}
|
|
1498
1828
|
}).input(z.object({
|
|
1499
1829
|
projectId: z.string().describe("The ID of the project"),
|
|
1500
1830
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1501
1831
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1502
1832
|
})).output(projectOutputSchema);
|
|
1503
|
-
const deployEnvironmentContractV1 =
|
|
1833
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1504
1834
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1505
1835
|
method: "POST",
|
|
1506
1836
|
summary: "Deploy an environment",
|
|
@@ -1509,27 +1839,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1509
1839
|
successDescription: "The environment has been deployed successfully"
|
|
1510
1840
|
}).errors({
|
|
1511
1841
|
NOT_FOUND: {},
|
|
1512
|
-
|
|
1842
|
+
CONFLICT: {}
|
|
1513
1843
|
}).input(z.object({
|
|
1514
1844
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1515
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1845
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1846
|
+
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
1847
|
})).output(deploymentSchema);
|
|
1517
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1848
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1518
1849
|
path: "/v1/deployments/upload",
|
|
1519
1850
|
method: "POST",
|
|
1520
1851
|
summary: "Upload deployment artifacts",
|
|
1521
1852
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1522
1853
|
tags: ["deployments"],
|
|
1523
1854
|
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({
|
|
1855
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1528
1856
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1529
1857
|
token: z.string().describe("Token to identify the source archive"),
|
|
1530
1858
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1531
1859
|
}));
|
|
1532
|
-
const listDeploymentsContractV1 =
|
|
1860
|
+
const listDeploymentsContractV1 = base.route({
|
|
1533
1861
|
path: "/v1/projects/{projectId}/deployments",
|
|
1534
1862
|
method: "GET",
|
|
1535
1863
|
summary: "List project deployments",
|
|
@@ -1541,7 +1869,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1541
1869
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1542
1870
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1543
1871
|
})).output(z.array(deploymentSchema));
|
|
1544
|
-
const getDeploymentContractV1 =
|
|
1872
|
+
const getDeploymentContractV1 = base.route({
|
|
1545
1873
|
path: "/v1/deployments/{deploymentId}",
|
|
1546
1874
|
method: "GET",
|
|
1547
1875
|
summary: "Get a deployment",
|
|
@@ -1549,20 +1877,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1549
1877
|
tags: ["deployments"],
|
|
1550
1878
|
successDescription: "The deployment details"
|
|
1551
1879
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1552
|
-
const
|
|
1880
|
+
const logEntrySchema = z.object({
|
|
1881
|
+
timestamp: z.coerce.date(),
|
|
1882
|
+
type: z.enum([
|
|
1883
|
+
"START",
|
|
1884
|
+
"END",
|
|
1885
|
+
"INFO",
|
|
1886
|
+
"ERROR",
|
|
1887
|
+
"WARNING",
|
|
1888
|
+
"DEBUG"
|
|
1889
|
+
]),
|
|
1890
|
+
requestId: z.string(),
|
|
1891
|
+
content: z.string().optional(),
|
|
1892
|
+
method: z.string().optional(),
|
|
1893
|
+
durationInMs: z.number().optional()
|
|
1894
|
+
});
|
|
1895
|
+
const getLogsContractV1 = base.route({
|
|
1553
1896
|
path: "/v1/environments/{environmentId}/logs",
|
|
1554
1897
|
method: "GET",
|
|
1555
1898
|
summary: "Get logs",
|
|
1556
1899
|
description: "Get logs for an environment",
|
|
1557
1900
|
tags: ["environments"],
|
|
1558
1901
|
successDescription: "The logs"
|
|
1559
|
-
}).errors({
|
|
1560
|
-
NOT_FOUND: {},
|
|
1561
|
-
BAD_REQUEST: {}
|
|
1562
|
-
}).input(z.object({
|
|
1902
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1563
1903
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1564
|
-
since:
|
|
1565
|
-
until:
|
|
1904
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1905
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1566
1906
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1567
1907
|
level: z.array(z.enum([
|
|
1568
1908
|
"INFO",
|
|
@@ -1573,34 +1913,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1573
1913
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1574
1914
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1575
1915
|
})).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
|
-
})),
|
|
1916
|
+
logs: z.array(logEntrySchema),
|
|
1591
1917
|
nextToken: z.string().nullable()
|
|
1592
1918
|
}));
|
|
1593
|
-
const getLatestLogsContractV1 =
|
|
1919
|
+
const getLatestLogsContractV1 = base.route({
|
|
1594
1920
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1595
1921
|
method: "GET",
|
|
1596
1922
|
summary: "Get latest logs",
|
|
1597
1923
|
description: "Get the N most recent logs for an environment",
|
|
1598
1924
|
tags: ["environments"],
|
|
1599
1925
|
successDescription: "The latest logs"
|
|
1600
|
-
}).errors({
|
|
1601
|
-
NOT_FOUND: {},
|
|
1602
|
-
BAD_REQUEST: {}
|
|
1603
|
-
}).input(z.object({
|
|
1926
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1604
1927
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1605
1928
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1606
1929
|
level: z.array(z.enum([
|
|
@@ -1610,22 +1933,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1610
1933
|
"DEBUG"
|
|
1611
1934
|
])).optional().describe("Filter by log level"),
|
|
1612
1935
|
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({
|
|
1936
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1937
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1629
1938
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1630
1939
|
method: "GET",
|
|
1631
1940
|
summary: "Get deployment logs",
|
|
@@ -1652,22 +1961,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1652
1961
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1653
1962
|
task_count: z.array(analyticsDataPointSchema)
|
|
1654
1963
|
});
|
|
1655
|
-
const getProjectAnalyticsContractV1 =
|
|
1964
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1656
1965
|
path: "/v1/analytics/{projectId}",
|
|
1657
1966
|
method: "GET",
|
|
1658
1967
|
summary: "Get project analytics",
|
|
1659
1968
|
description: "Get analytics data for a project over a time range",
|
|
1660
1969
|
tags: ["analytics"],
|
|
1661
1970
|
successDescription: "The project analytics data"
|
|
1662
|
-
}).errors({
|
|
1663
|
-
NOT_FOUND: {},
|
|
1664
|
-
BAD_REQUEST: {}
|
|
1665
|
-
}).input(z.object({
|
|
1971
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1666
1972
|
projectId: z.string().describe("The ID of the project"),
|
|
1667
1973
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1668
1974
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1669
1975
|
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 <=
|
|
1976
|
+
}).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
1977
|
metadata: z.object({
|
|
1672
1978
|
startTimestamp: z.number(),
|
|
1673
1979
|
endTimestamp: z.number(),
|
|
@@ -1677,7 +1983,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1677
1983
|
}),
|
|
1678
1984
|
timeSeries: analyticsTimeSeriesSchema
|
|
1679
1985
|
}));
|
|
1680
|
-
const
|
|
1986
|
+
const paginatedInsightsInputShape = {
|
|
1987
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1988
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1989
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1990
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1991
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1992
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1993
|
+
};
|
|
1994
|
+
const listIntentsContractV1 = base.route({
|
|
1995
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1996
|
+
method: "GET",
|
|
1997
|
+
summary: "List intents",
|
|
1998
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1999
|
+
tags: ["insights"],
|
|
2000
|
+
successDescription: "The grouped user intents"
|
|
2001
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2002
|
+
...paginatedInsightsInputShape,
|
|
2003
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2004
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2005
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2006
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2007
|
+
})).output(z.object({
|
|
2008
|
+
intents: z.array(z.object({
|
|
2009
|
+
id: z.string(),
|
|
2010
|
+
intentIds: z.array(z.string()).min(1),
|
|
2011
|
+
environmentId: z.string(),
|
|
2012
|
+
message: z.string(),
|
|
2013
|
+
toolName: z.string(),
|
|
2014
|
+
createdAt: z.coerce.date(),
|
|
2015
|
+
occurrenceCount: z.number().int().positive(),
|
|
2016
|
+
clientName: z.string().nullable(),
|
|
2017
|
+
clientId: z.string().nullable(),
|
|
2018
|
+
categories: z.array(z.object({
|
|
2019
|
+
id: z.string(),
|
|
2020
|
+
name: z.string(),
|
|
2021
|
+
color: intentCategoryColorSchema
|
|
2022
|
+
}))
|
|
2023
|
+
})),
|
|
2024
|
+
totalCount: z.number().int().nonnegative()
|
|
2025
|
+
}));
|
|
2026
|
+
const listFeedbacksContractV1 = base.route({
|
|
2027
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2028
|
+
method: "GET",
|
|
2029
|
+
summary: "List feedbacks",
|
|
2030
|
+
description: "List user feedback for an environment over a time range",
|
|
2031
|
+
tags: ["insights"],
|
|
2032
|
+
successDescription: "The user feedback"
|
|
2033
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2034
|
+
...paginatedInsightsInputShape,
|
|
2035
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2036
|
+
})).output(z.object({
|
|
2037
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2038
|
+
totalCount: z.number().int().nonnegative()
|
|
2039
|
+
}));
|
|
2040
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2041
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2042
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2043
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2044
|
+
method: "GET",
|
|
2045
|
+
summary: "List intent categories",
|
|
2046
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2047
|
+
tags: ["insights"],
|
|
2048
|
+
successDescription: "The intent categories"
|
|
2049
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2050
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2051
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2052
|
+
method: "POST",
|
|
2053
|
+
summary: "Create an intent category",
|
|
2054
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2055
|
+
tags: ["insights"],
|
|
2056
|
+
successDescription: "The created intent category"
|
|
2057
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2058
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2059
|
+
name: intentCategoryNameSchema,
|
|
2060
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2061
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2062
|
+
})).output(intentCategorySchema);
|
|
2063
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2064
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2065
|
+
method: "PATCH",
|
|
2066
|
+
summary: "Update an intent category",
|
|
2067
|
+
description: "Rename or recolor an intent category",
|
|
2068
|
+
tags: ["insights"],
|
|
2069
|
+
successDescription: "The updated intent category"
|
|
2070
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2071
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2072
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2073
|
+
name: intentCategoryNameSchema.optional(),
|
|
2074
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2075
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2076
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2077
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2078
|
+
method: "DELETE",
|
|
2079
|
+
summary: "Delete an intent category",
|
|
2080
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2081
|
+
tags: ["insights"],
|
|
2082
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2083
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2084
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2085
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2086
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2087
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2088
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2089
|
+
method: "POST",
|
|
2090
|
+
summary: "Link an intent category",
|
|
2091
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2092
|
+
tags: ["insights"],
|
|
2093
|
+
successDescription: "The intents have been linked successfully"
|
|
2094
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2095
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2096
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2097
|
+
intentIds: categorizableIntentIdsSchema
|
|
2098
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2099
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2100
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2101
|
+
method: "POST",
|
|
2102
|
+
summary: "Unlink an intent category",
|
|
2103
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2104
|
+
tags: ["insights"],
|
|
2105
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2106
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2107
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2108
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2109
|
+
intentIds: categorizableIntentIdsSchema
|
|
2110
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2111
|
+
const listTeamsContractV1 = base.route({
|
|
1681
2112
|
path: "/v1/teams",
|
|
1682
2113
|
method: "GET",
|
|
1683
2114
|
summary: "List teams",
|
|
@@ -1690,7 +2121,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1690
2121
|
createdAt: z.coerce.date(),
|
|
1691
2122
|
hasStripeAccount: z.boolean()
|
|
1692
2123
|
})));
|
|
1693
|
-
const
|
|
2124
|
+
const getTeamUsageContractV1 = base.route({
|
|
2125
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2126
|
+
method: "GET",
|
|
2127
|
+
summary: "Get team usage",
|
|
2128
|
+
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.",
|
|
2129
|
+
tags: ["teams"],
|
|
2130
|
+
successDescription: "The current billing window usage"
|
|
2131
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2132
|
+
teamId: z.string(),
|
|
2133
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2134
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2135
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2136
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2137
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2138
|
+
}));
|
|
2139
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1694
2140
|
path: "/v1/tunnels/ticket",
|
|
1695
2141
|
method: "GET",
|
|
1696
2142
|
summary: "Get a tunnel ticket",
|
|
@@ -1702,16 +2148,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1702
2148
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1703
2149
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1704
2150
|
}));
|
|
1705
|
-
const publishServerContractV1 =
|
|
2151
|
+
const publishServerContractV1 = base.route({
|
|
1706
2152
|
path: "/v1/distribution/publish",
|
|
1707
2153
|
method: "POST",
|
|
1708
2154
|
summary: "Publish a server to the MCP registry",
|
|
1709
2155
|
tags: ["distribution"],
|
|
1710
2156
|
successDescription: "The server has been published successfully"
|
|
1711
|
-
}).errors({
|
|
1712
|
-
NOT_FOUND: {},
|
|
1713
|
-
BAD_REQUEST: {}
|
|
1714
|
-
}).input(z.object({
|
|
2157
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1715
2158
|
projectId: z.string(),
|
|
1716
2159
|
domain: z.string(),
|
|
1717
2160
|
title: z.string().min(1).max(100),
|
|
@@ -1720,17 +2163,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1720
2163
|
iconSrc: z.url().max(255).optional(),
|
|
1721
2164
|
dryRun: z.boolean().optional()
|
|
1722
2165
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1723
|
-
const getServerInfoContractV1 =
|
|
2166
|
+
const getServerInfoContractV1 = base.route({
|
|
1724
2167
|
path: "/v1/distribution/get",
|
|
1725
2168
|
method: "GET",
|
|
1726
2169
|
summary: "Get server info",
|
|
1727
2170
|
description: "Get info about a server",
|
|
1728
2171
|
tags: ["distribution"],
|
|
1729
2172
|
successDescription: "The server info"
|
|
1730
|
-
}).errors({
|
|
1731
|
-
NOT_FOUND: {},
|
|
1732
|
-
BAD_REQUEST: {}
|
|
1733
|
-
}).input(z.object({
|
|
2173
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1734
2174
|
projectId: z.string(),
|
|
1735
2175
|
domain: z.string()
|
|
1736
2176
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1749,7 +2189,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1749
2189
|
isPlaygroundEnabled: z.boolean(),
|
|
1750
2190
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1751
2191
|
});
|
|
1752
|
-
const getPlaygroundContractV1 =
|
|
2192
|
+
const getPlaygroundContractV1 = base.route({
|
|
1753
2193
|
path: "/v1/environments/{environmentId}/playground",
|
|
1754
2194
|
method: "GET",
|
|
1755
2195
|
summary: "Get playground configuration",
|
|
@@ -1757,17 +2197,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1757
2197
|
tags: ["environments"],
|
|
1758
2198
|
successDescription: "The playground configuration"
|
|
1759
2199
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1760
|
-
const upsertPlaygroundContractV1 =
|
|
2200
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1761
2201
|
path: "/v1/environments/{environmentId}/playground",
|
|
1762
2202
|
method: "PUT",
|
|
1763
2203
|
summary: "Update playground configuration",
|
|
1764
2204
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1765
2205
|
tags: ["environments"],
|
|
1766
2206
|
successDescription: "The updated playground configuration"
|
|
1767
|
-
}).errors({
|
|
1768
|
-
NOT_FOUND: {},
|
|
1769
|
-
BAD_REQUEST: {}
|
|
1770
|
-
}).input(z.object({
|
|
2207
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1771
2208
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1772
2209
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1773
2210
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1775,7 +2212,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1775
2212
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1776
2213
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1777
2214
|
})).output(playgroundOutputSchema);
|
|
1778
|
-
const createBeaconContractV1 =
|
|
2215
|
+
const createBeaconContractV1 = base.route({
|
|
1779
2216
|
path: "/v1/beacon/audits",
|
|
1780
2217
|
method: "POST",
|
|
1781
2218
|
summary: "Create a beacon audit",
|
|
@@ -1784,7 +2221,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1784
2221
|
successDescription: "The audit has been created"
|
|
1785
2222
|
}).errors({
|
|
1786
2223
|
NOT_FOUND: {},
|
|
1787
|
-
BAD_REQUEST: {},
|
|
1788
2224
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1789
2225
|
}).input(z.object({
|
|
1790
2226
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1792,7 +2228,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1792
2228
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1793
2229
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1794
2230
|
})).output(z.object({ id: z.string() }));
|
|
1795
|
-
const getBeaconContractV1 =
|
|
2231
|
+
const getBeaconContractV1 = base.route({
|
|
1796
2232
|
path: "/v1/beacon/audits/{auditId}",
|
|
1797
2233
|
method: "GET",
|
|
1798
2234
|
summary: "Get a beacon audit",
|
|
@@ -1808,8 +2244,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1808
2244
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1809
2245
|
}));
|
|
1810
2246
|
const contract = {
|
|
1811
|
-
teams: {
|
|
2247
|
+
teams: {
|
|
2248
|
+
list: { v1: listTeamsContractV1 },
|
|
2249
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2250
|
+
},
|
|
1812
2251
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2252
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2253
|
+
intentCategories: {
|
|
2254
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2255
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2256
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2257
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2258
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2259
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2260
|
+
},
|
|
2261
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1813
2262
|
deployments: {
|
|
1814
2263
|
list: { v1: listDeploymentsContractV1 },
|
|
1815
2264
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1850,5 +2299,10 @@ const contract = {
|
|
|
1850
2299
|
get: { v1: getBeaconContractV1 }
|
|
1851
2300
|
}
|
|
1852
2301
|
};
|
|
2302
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2303
|
+
const contractForDocs = {
|
|
2304
|
+
...contract,
|
|
2305
|
+
deployments: deploymentsForDocs
|
|
2306
|
+
};
|
|
1853
2307
|
//#endregion
|
|
1854
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2308
|
+
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 };
|