@alpic-ai/api 0.0.0-dev.gf521008 → 0.0.0-dev.gf55835d
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 +678 -201
- 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",
|
|
@@ -1140,17 +1444,70 @@ const customerCreditsSchema = z.object({
|
|
|
1140
1444
|
expiresAt: z.number().nullable(),
|
|
1141
1445
|
currency: z.string()
|
|
1142
1446
|
});
|
|
1143
|
-
const customerUsageSchema = z.object({
|
|
1144
|
-
amountInCents: z.number(),
|
|
1145
|
-
currency: z.string(),
|
|
1146
|
-
periodEnd: z.number()
|
|
1147
|
-
});
|
|
1148
1447
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1149
1448
|
z.object({
|
|
1150
1449
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1151
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1152
1450
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1153
1451
|
});
|
|
1452
|
+
const metricsQueueEventSchema = z.object({
|
|
1453
|
+
ts: z.number().int(),
|
|
1454
|
+
method: z.string(),
|
|
1455
|
+
tool: z.string().nullable(),
|
|
1456
|
+
client: z.string(),
|
|
1457
|
+
sessionId: z.string().nullable(),
|
|
1458
|
+
durationMs: z.number().int(),
|
|
1459
|
+
outputTokens: z.number().int().nullable(),
|
|
1460
|
+
errorType: z.enum([
|
|
1461
|
+
"mcp_error",
|
|
1462
|
+
"tool_error",
|
|
1463
|
+
"timeout"
|
|
1464
|
+
]).nullable(),
|
|
1465
|
+
errorCode: z.number().int().nullable()
|
|
1466
|
+
});
|
|
1467
|
+
z.object({
|
|
1468
|
+
v: z.literal(1),
|
|
1469
|
+
envId: z.string(),
|
|
1470
|
+
events: z.array(metricsQueueEventSchema)
|
|
1471
|
+
});
|
|
1472
|
+
z.object({ v: z.number() });
|
|
1473
|
+
const telemetrySignalSchema = z.enum([
|
|
1474
|
+
"logs",
|
|
1475
|
+
"metrics",
|
|
1476
|
+
"traces"
|
|
1477
|
+
]);
|
|
1478
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1479
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1480
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1481
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1482
|
+
const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
|
|
1483
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1484
|
+
id: z.string(),
|
|
1485
|
+
name: otlpHeaderNameSchema,
|
|
1486
|
+
value: otlpHeaderValueSchema,
|
|
1487
|
+
isSecret: z.boolean()
|
|
1488
|
+
});
|
|
1489
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1490
|
+
"credentials",
|
|
1491
|
+
"wrong-path",
|
|
1492
|
+
"wrong-protocol",
|
|
1493
|
+
"invalid-payload",
|
|
1494
|
+
"partial-rejection",
|
|
1495
|
+
"blocked-target",
|
|
1496
|
+
"timeout",
|
|
1497
|
+
"unreachable",
|
|
1498
|
+
"receiver-error",
|
|
1499
|
+
"unexpected-status"
|
|
1500
|
+
]);
|
|
1501
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1502
|
+
z.object({
|
|
1503
|
+
id: z.string(),
|
|
1504
|
+
signal: telemetrySignalSchema,
|
|
1505
|
+
endpoint: otlpEndpointSchema,
|
|
1506
|
+
protocol: otlpProtocolSchema,
|
|
1507
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1508
|
+
status: telemetryDestinationStatusSchema,
|
|
1509
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1510
|
+
});
|
|
1154
1511
|
//#endregion
|
|
1155
1512
|
//#region src/auth-scope.ts
|
|
1156
1513
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1193,7 +1550,10 @@ const RESERVED_KEYS = [
|
|
|
1193
1550
|
"BUILD_ARG_START_COMMAND",
|
|
1194
1551
|
"ALPIC_HOST",
|
|
1195
1552
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1196
|
-
"ALPIC_INTENT_META_KEY"
|
|
1553
|
+
"ALPIC_INTENT_META_KEY",
|
|
1554
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1555
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1556
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1197
1557
|
];
|
|
1198
1558
|
const environmentVariableSchema = z.object({
|
|
1199
1559
|
key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
|
|
@@ -1246,6 +1606,14 @@ const serverFieldsSchema = z.object({
|
|
|
1246
1606
|
});
|
|
1247
1607
|
//#endregion
|
|
1248
1608
|
//#region src/api.contract.ts
|
|
1609
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1610
|
+
try {
|
|
1611
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1612
|
+
return true;
|
|
1613
|
+
} catch {
|
|
1614
|
+
return false;
|
|
1615
|
+
}
|
|
1616
|
+
};
|
|
1249
1617
|
const deploymentStatusSchema = z.enum([
|
|
1250
1618
|
"ongoing",
|
|
1251
1619
|
"deployed",
|
|
@@ -1274,21 +1642,20 @@ const deploymentSchema = z.object({
|
|
|
1274
1642
|
isCurrent: z.boolean(),
|
|
1275
1643
|
deploymentPageUrl: z.url().nullable()
|
|
1276
1644
|
});
|
|
1277
|
-
const
|
|
1645
|
+
const isValidTimeInput = (value) => {
|
|
1278
1646
|
if (ms(value) !== void 0) return true;
|
|
1279
1647
|
return !Number.isNaN(new Date(value).getTime());
|
|
1280
1648
|
};
|
|
1281
|
-
const
|
|
1649
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1650
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1651
|
+
const createEnvironmentContractV1 = base.route({
|
|
1282
1652
|
path: "/v1/environments",
|
|
1283
1653
|
method: "POST",
|
|
1284
1654
|
summary: "Create an environment",
|
|
1285
1655
|
description: "Create an environment for a project",
|
|
1286
1656
|
tags: ["environments"],
|
|
1287
1657
|
successDescription: "The environment has been created successfully"
|
|
1288
|
-
}).errors({
|
|
1289
|
-
NOT_FOUND: {},
|
|
1290
|
-
BAD_REQUEST: {}
|
|
1291
|
-
}).input(z.object({
|
|
1658
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1292
1659
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1293
1660
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1294
1661
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1301,7 +1668,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1301
1668
|
createdAt: z.coerce.date(),
|
|
1302
1669
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1303
1670
|
}));
|
|
1304
|
-
const getEnvironmentContractV1 =
|
|
1671
|
+
const getEnvironmentContractV1 = base.route({
|
|
1305
1672
|
path: "/v1/environments/{environmentId}",
|
|
1306
1673
|
method: "GET",
|
|
1307
1674
|
summary: "Get an environment",
|
|
@@ -1358,7 +1725,7 @@ const projectOutputSchema = z.object({
|
|
|
1358
1725
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1359
1726
|
environments: z.array(environmentSchema)
|
|
1360
1727
|
});
|
|
1361
|
-
const getProjectContractV1 =
|
|
1728
|
+
const getProjectContractV1 = base.route({
|
|
1362
1729
|
path: "/v1/projects/{projectId}",
|
|
1363
1730
|
method: "GET",
|
|
1364
1731
|
summary: "Get a project",
|
|
@@ -1366,18 +1733,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1366
1733
|
tags: ["projects"],
|
|
1367
1734
|
successDescription: "The project details"
|
|
1368
1735
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1369
|
-
const listProjectsContractV1 =
|
|
1736
|
+
const listProjectsContractV1 = base.route({
|
|
1370
1737
|
path: "/v1/projects",
|
|
1371
1738
|
method: "GET",
|
|
1372
1739
|
summary: "List projects",
|
|
1373
1740
|
description: "List all projects for a team",
|
|
1374
1741
|
tags: ["projects"],
|
|
1375
1742
|
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({
|
|
1743
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1744
|
+
const createProjectContractV1 = base.route({
|
|
1381
1745
|
path: "/v1/projects",
|
|
1382
1746
|
method: "POST",
|
|
1383
1747
|
summary: "Create a project",
|
|
@@ -1386,7 +1750,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1386
1750
|
successDescription: "The project has been created successfully"
|
|
1387
1751
|
}).errors({
|
|
1388
1752
|
NOT_FOUND: {},
|
|
1389
|
-
BAD_REQUEST: {},
|
|
1390
1753
|
FORBIDDEN: {}
|
|
1391
1754
|
}).input(z.object({
|
|
1392
1755
|
teamId: z.string().optional(),
|
|
@@ -1427,7 +1790,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1427
1790
|
isSecret: z.boolean(),
|
|
1428
1791
|
createdAt: z.coerce.date()
|
|
1429
1792
|
});
|
|
1430
|
-
const listEnvironmentVariablesContractV1 =
|
|
1793
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1431
1794
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1432
1795
|
method: "GET",
|
|
1433
1796
|
summary: "List environment variables",
|
|
@@ -1435,48 +1798,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1435
1798
|
tags: ["environments"],
|
|
1436
1799
|
successDescription: "The list of environment variables"
|
|
1437
1800
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1438
|
-
const createEnvironmentVariablesContractV1 =
|
|
1801
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1439
1802
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1440
1803
|
method: "POST",
|
|
1441
1804
|
summary: "Add environment variables",
|
|
1442
1805
|
description: "Add one or more environment variables to an environment",
|
|
1443
1806
|
tags: ["environments"],
|
|
1444
1807
|
successDescription: "The environment variables have been added successfully"
|
|
1445
|
-
}).errors({
|
|
1446
|
-
NOT_FOUND: {},
|
|
1447
|
-
BAD_REQUEST: {}
|
|
1448
|
-
}).input(z.object({
|
|
1808
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1449
1809
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1450
1810
|
environmentVariables: environmentVariablesSchema
|
|
1451
1811
|
})).output(z.object({ success: z.literal(true) }));
|
|
1452
|
-
const updateEnvironmentVariableContractV1 =
|
|
1812
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1453
1813
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1454
1814
|
method: "PATCH",
|
|
1455
1815
|
summary: "Update an environment variable",
|
|
1456
1816
|
description: "Update an environment variable by ID",
|
|
1457
1817
|
tags: ["environments"],
|
|
1458
1818
|
successDescription: "The environment variable has been updated successfully"
|
|
1459
|
-
}).errors({
|
|
1460
|
-
NOT_FOUND: {},
|
|
1461
|
-
BAD_REQUEST: {}
|
|
1462
|
-
}).input(z.object({
|
|
1819
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1463
1820
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1464
1821
|
key: environmentVariableSchema.shape.key,
|
|
1465
1822
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1466
1823
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1467
1824
|
})).output(z.object({ success: z.literal(true) }));
|
|
1468
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1825
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1469
1826
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1470
1827
|
method: "DELETE",
|
|
1471
1828
|
summary: "Delete an environment variable",
|
|
1472
1829
|
description: "Delete an environment variable by ID",
|
|
1473
1830
|
tags: ["environments"],
|
|
1474
1831
|
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({
|
|
1832
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1833
|
+
const deleteProjectContractV1 = base.route({
|
|
1480
1834
|
path: "/v1/projects/{projectId}",
|
|
1481
1835
|
method: "DELETE",
|
|
1482
1836
|
summary: "Delete a project",
|
|
@@ -1484,7 +1838,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1484
1838
|
tags: ["projects"],
|
|
1485
1839
|
successDescription: "The project has been deleted successfully"
|
|
1486
1840
|
}).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 =
|
|
1841
|
+
const updateProjectContractV1 = base.route({
|
|
1488
1842
|
path: "/v1/projects/{projectId}",
|
|
1489
1843
|
method: "PATCH",
|
|
1490
1844
|
summary: "Update a project",
|
|
@@ -1493,14 +1847,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1493
1847
|
successDescription: "The project has been updated successfully"
|
|
1494
1848
|
}).errors({
|
|
1495
1849
|
NOT_FOUND: {},
|
|
1496
|
-
BAD_REQUEST: {},
|
|
1497
1850
|
FORBIDDEN: {}
|
|
1498
1851
|
}).input(z.object({
|
|
1499
1852
|
projectId: z.string().describe("The ID of the project"),
|
|
1500
1853
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1501
1854
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1502
1855
|
})).output(projectOutputSchema);
|
|
1503
|
-
const deployEnvironmentContractV1 =
|
|
1856
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1504
1857
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1505
1858
|
method: "POST",
|
|
1506
1859
|
summary: "Deploy an environment",
|
|
@@ -1509,27 +1862,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1509
1862
|
successDescription: "The environment has been deployed successfully"
|
|
1510
1863
|
}).errors({
|
|
1511
1864
|
NOT_FOUND: {},
|
|
1512
|
-
|
|
1865
|
+
CONFLICT: {}
|
|
1513
1866
|
}).input(z.object({
|
|
1514
1867
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1515
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1868
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1869
|
+
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
1870
|
})).output(deploymentSchema);
|
|
1517
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1871
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1518
1872
|
path: "/v1/deployments/upload",
|
|
1519
1873
|
method: "POST",
|
|
1520
1874
|
summary: "Upload deployment artifacts",
|
|
1521
1875
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1522
1876
|
tags: ["deployments"],
|
|
1523
1877
|
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({
|
|
1878
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1528
1879
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1529
1880
|
token: z.string().describe("Token to identify the source archive"),
|
|
1530
1881
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1531
1882
|
}));
|
|
1532
|
-
const listDeploymentsContractV1 =
|
|
1883
|
+
const listDeploymentsContractV1 = base.route({
|
|
1533
1884
|
path: "/v1/projects/{projectId}/deployments",
|
|
1534
1885
|
method: "GET",
|
|
1535
1886
|
summary: "List project deployments",
|
|
@@ -1541,7 +1892,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1541
1892
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1542
1893
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1543
1894
|
})).output(z.array(deploymentSchema));
|
|
1544
|
-
const getDeploymentContractV1 =
|
|
1895
|
+
const getDeploymentContractV1 = base.route({
|
|
1545
1896
|
path: "/v1/deployments/{deploymentId}",
|
|
1546
1897
|
method: "GET",
|
|
1547
1898
|
summary: "Get a deployment",
|
|
@@ -1549,20 +1900,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1549
1900
|
tags: ["deployments"],
|
|
1550
1901
|
successDescription: "The deployment details"
|
|
1551
1902
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1552
|
-
const
|
|
1903
|
+
const logEntrySchema = z.object({
|
|
1904
|
+
timestamp: z.coerce.date(),
|
|
1905
|
+
type: z.enum([
|
|
1906
|
+
"START",
|
|
1907
|
+
"END",
|
|
1908
|
+
"INFO",
|
|
1909
|
+
"ERROR",
|
|
1910
|
+
"WARNING",
|
|
1911
|
+
"DEBUG"
|
|
1912
|
+
]),
|
|
1913
|
+
requestId: z.string(),
|
|
1914
|
+
content: z.string().optional(),
|
|
1915
|
+
method: z.string().optional(),
|
|
1916
|
+
durationInMs: z.number().optional()
|
|
1917
|
+
});
|
|
1918
|
+
const getLogsContractV1 = base.route({
|
|
1553
1919
|
path: "/v1/environments/{environmentId}/logs",
|
|
1554
1920
|
method: "GET",
|
|
1555
1921
|
summary: "Get logs",
|
|
1556
1922
|
description: "Get logs for an environment",
|
|
1557
1923
|
tags: ["environments"],
|
|
1558
1924
|
successDescription: "The logs"
|
|
1559
|
-
}).errors({
|
|
1560
|
-
NOT_FOUND: {},
|
|
1561
|
-
BAD_REQUEST: {}
|
|
1562
|
-
}).input(z.object({
|
|
1925
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1563
1926
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1564
|
-
since:
|
|
1565
|
-
until:
|
|
1927
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1928
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1566
1929
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1567
1930
|
level: z.array(z.enum([
|
|
1568
1931
|
"INFO",
|
|
@@ -1573,34 +1936,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1573
1936
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1574
1937
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1575
1938
|
})).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
|
-
})),
|
|
1939
|
+
logs: z.array(logEntrySchema),
|
|
1591
1940
|
nextToken: z.string().nullable()
|
|
1592
1941
|
}));
|
|
1593
|
-
const getLatestLogsContractV1 =
|
|
1942
|
+
const getLatestLogsContractV1 = base.route({
|
|
1594
1943
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1595
1944
|
method: "GET",
|
|
1596
1945
|
summary: "Get latest logs",
|
|
1597
1946
|
description: "Get the N most recent logs for an environment",
|
|
1598
1947
|
tags: ["environments"],
|
|
1599
1948
|
successDescription: "The latest logs"
|
|
1600
|
-
}).errors({
|
|
1601
|
-
NOT_FOUND: {},
|
|
1602
|
-
BAD_REQUEST: {}
|
|
1603
|
-
}).input(z.object({
|
|
1949
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1604
1950
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1605
1951
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1606
1952
|
level: z.array(z.enum([
|
|
@@ -1610,22 +1956,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1610
1956
|
"DEBUG"
|
|
1611
1957
|
])).optional().describe("Filter by log level"),
|
|
1612
1958
|
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({
|
|
1959
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1960
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1629
1961
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1630
1962
|
method: "GET",
|
|
1631
1963
|
summary: "Get deployment logs",
|
|
@@ -1652,22 +1984,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1652
1984
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1653
1985
|
task_count: z.array(analyticsDataPointSchema)
|
|
1654
1986
|
});
|
|
1655
|
-
const getProjectAnalyticsContractV1 =
|
|
1987
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1656
1988
|
path: "/v1/analytics/{projectId}",
|
|
1657
1989
|
method: "GET",
|
|
1658
1990
|
summary: "Get project analytics",
|
|
1659
1991
|
description: "Get analytics data for a project over a time range",
|
|
1660
1992
|
tags: ["analytics"],
|
|
1661
1993
|
successDescription: "The project analytics data"
|
|
1662
|
-
}).errors({
|
|
1663
|
-
NOT_FOUND: {},
|
|
1664
|
-
BAD_REQUEST: {}
|
|
1665
|
-
}).input(z.object({
|
|
1994
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1666
1995
|
projectId: z.string().describe("The ID of the project"),
|
|
1667
1996
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1668
1997
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1669
1998
|
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 <=
|
|
1999
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => isValidIanaTimeZone(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1671
2000
|
metadata: z.object({
|
|
1672
2001
|
startTimestamp: z.number(),
|
|
1673
2002
|
endTimestamp: z.number(),
|
|
@@ -1677,7 +2006,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1677
2006
|
}),
|
|
1678
2007
|
timeSeries: analyticsTimeSeriesSchema
|
|
1679
2008
|
}));
|
|
1680
|
-
const
|
|
2009
|
+
const paginatedInsightsInputShape = {
|
|
2010
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2011
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2012
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2013
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2014
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2015
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2016
|
+
};
|
|
2017
|
+
const listIntentsContractV1 = base.route({
|
|
2018
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2019
|
+
method: "GET",
|
|
2020
|
+
summary: "List intents",
|
|
2021
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2022
|
+
tags: ["insights"],
|
|
2023
|
+
successDescription: "The grouped user intents"
|
|
2024
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2025
|
+
...paginatedInsightsInputShape,
|
|
2026
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2027
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2028
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2029
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2030
|
+
})).output(z.object({
|
|
2031
|
+
intents: z.array(z.object({
|
|
2032
|
+
id: z.string(),
|
|
2033
|
+
intentIds: z.array(z.string()).min(1),
|
|
2034
|
+
environmentId: z.string(),
|
|
2035
|
+
message: z.string(),
|
|
2036
|
+
toolName: z.string(),
|
|
2037
|
+
createdAt: z.coerce.date(),
|
|
2038
|
+
occurrenceCount: z.number().int().positive(),
|
|
2039
|
+
clientName: z.string().nullable(),
|
|
2040
|
+
clientId: z.string().nullable(),
|
|
2041
|
+
categories: z.array(z.object({
|
|
2042
|
+
id: z.string(),
|
|
2043
|
+
name: z.string(),
|
|
2044
|
+
color: intentCategoryColorSchema
|
|
2045
|
+
}))
|
|
2046
|
+
})),
|
|
2047
|
+
totalCount: z.number().int().nonnegative()
|
|
2048
|
+
}));
|
|
2049
|
+
const listFeedbacksContractV1 = base.route({
|
|
2050
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2051
|
+
method: "GET",
|
|
2052
|
+
summary: "List feedbacks",
|
|
2053
|
+
description: "List user feedback for an environment over a time range",
|
|
2054
|
+
tags: ["insights"],
|
|
2055
|
+
successDescription: "The user feedback"
|
|
2056
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2057
|
+
...paginatedInsightsInputShape,
|
|
2058
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2059
|
+
})).output(z.object({
|
|
2060
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2061
|
+
totalCount: z.number().int().nonnegative()
|
|
2062
|
+
}));
|
|
2063
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2064
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2065
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2066
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2067
|
+
method: "GET",
|
|
2068
|
+
summary: "List intent categories",
|
|
2069
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2070
|
+
tags: ["insights"],
|
|
2071
|
+
successDescription: "The intent categories"
|
|
2072
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2073
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2074
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2075
|
+
method: "POST",
|
|
2076
|
+
summary: "Create an intent category",
|
|
2077
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2078
|
+
tags: ["insights"],
|
|
2079
|
+
successDescription: "The created intent category"
|
|
2080
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2081
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2082
|
+
name: intentCategoryNameSchema,
|
|
2083
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2084
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2085
|
+
})).output(intentCategorySchema);
|
|
2086
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2087
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2088
|
+
method: "PATCH",
|
|
2089
|
+
summary: "Update an intent category",
|
|
2090
|
+
description: "Rename or recolor an intent category",
|
|
2091
|
+
tags: ["insights"],
|
|
2092
|
+
successDescription: "The updated intent category"
|
|
2093
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2094
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2095
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2096
|
+
name: intentCategoryNameSchema.optional(),
|
|
2097
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2098
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2099
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2100
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2101
|
+
method: "DELETE",
|
|
2102
|
+
summary: "Delete an intent category",
|
|
2103
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2104
|
+
tags: ["insights"],
|
|
2105
|
+
successDescription: "The intent category has been deleted 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
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2110
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2111
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2112
|
+
method: "POST",
|
|
2113
|
+
summary: "Link an intent category",
|
|
2114
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2115
|
+
tags: ["insights"],
|
|
2116
|
+
successDescription: "The intents have been linked successfully"
|
|
2117
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2118
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2119
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2120
|
+
intentIds: categorizableIntentIdsSchema
|
|
2121
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2122
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2123
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2124
|
+
method: "POST",
|
|
2125
|
+
summary: "Unlink an intent category",
|
|
2126
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2127
|
+
tags: ["insights"],
|
|
2128
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2129
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2130
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2131
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2132
|
+
intentIds: categorizableIntentIdsSchema
|
|
2133
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2134
|
+
const listTeamsContractV1 = base.route({
|
|
1681
2135
|
path: "/v1/teams",
|
|
1682
2136
|
method: "GET",
|
|
1683
2137
|
summary: "List teams",
|
|
@@ -1690,7 +2144,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1690
2144
|
createdAt: z.coerce.date(),
|
|
1691
2145
|
hasStripeAccount: z.boolean()
|
|
1692
2146
|
})));
|
|
1693
|
-
const
|
|
2147
|
+
const getTeamUsageContractV1 = base.route({
|
|
2148
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2149
|
+
method: "GET",
|
|
2150
|
+
summary: "Get team usage",
|
|
2151
|
+
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.",
|
|
2152
|
+
tags: ["teams"],
|
|
2153
|
+
successDescription: "The current billing window usage"
|
|
2154
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2155
|
+
teamId: z.string(),
|
|
2156
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2157
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2158
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2159
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2160
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2161
|
+
}));
|
|
2162
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1694
2163
|
path: "/v1/tunnels/ticket",
|
|
1695
2164
|
method: "GET",
|
|
1696
2165
|
summary: "Get a tunnel ticket",
|
|
@@ -1702,16 +2171,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1702
2171
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1703
2172
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1704
2173
|
}));
|
|
1705
|
-
const publishServerContractV1 =
|
|
2174
|
+
const publishServerContractV1 = base.route({
|
|
1706
2175
|
path: "/v1/distribution/publish",
|
|
1707
2176
|
method: "POST",
|
|
1708
2177
|
summary: "Publish a server to the MCP registry",
|
|
1709
2178
|
tags: ["distribution"],
|
|
1710
2179
|
successDescription: "The server has been published successfully"
|
|
1711
|
-
}).errors({
|
|
1712
|
-
NOT_FOUND: {},
|
|
1713
|
-
BAD_REQUEST: {}
|
|
1714
|
-
}).input(z.object({
|
|
2180
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1715
2181
|
projectId: z.string(),
|
|
1716
2182
|
domain: z.string(),
|
|
1717
2183
|
title: z.string().min(1).max(100),
|
|
@@ -1720,17 +2186,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1720
2186
|
iconSrc: z.url().max(255).optional(),
|
|
1721
2187
|
dryRun: z.boolean().optional()
|
|
1722
2188
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1723
|
-
const getServerInfoContractV1 =
|
|
2189
|
+
const getServerInfoContractV1 = base.route({
|
|
1724
2190
|
path: "/v1/distribution/get",
|
|
1725
2191
|
method: "GET",
|
|
1726
2192
|
summary: "Get server info",
|
|
1727
2193
|
description: "Get info about a server",
|
|
1728
2194
|
tags: ["distribution"],
|
|
1729
2195
|
successDescription: "The server info"
|
|
1730
|
-
}).errors({
|
|
1731
|
-
NOT_FOUND: {},
|
|
1732
|
-
BAD_REQUEST: {}
|
|
1733
|
-
}).input(z.object({
|
|
2196
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1734
2197
|
projectId: z.string(),
|
|
1735
2198
|
domain: z.string()
|
|
1736
2199
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1749,7 +2212,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1749
2212
|
isPlaygroundEnabled: z.boolean(),
|
|
1750
2213
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1751
2214
|
});
|
|
1752
|
-
const getPlaygroundContractV1 =
|
|
2215
|
+
const getPlaygroundContractV1 = base.route({
|
|
1753
2216
|
path: "/v1/environments/{environmentId}/playground",
|
|
1754
2217
|
method: "GET",
|
|
1755
2218
|
summary: "Get playground configuration",
|
|
@@ -1757,17 +2220,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1757
2220
|
tags: ["environments"],
|
|
1758
2221
|
successDescription: "The playground configuration"
|
|
1759
2222
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1760
|
-
const upsertPlaygroundContractV1 =
|
|
2223
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1761
2224
|
path: "/v1/environments/{environmentId}/playground",
|
|
1762
2225
|
method: "PUT",
|
|
1763
2226
|
summary: "Update playground configuration",
|
|
1764
2227
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1765
2228
|
tags: ["environments"],
|
|
1766
2229
|
successDescription: "The updated playground configuration"
|
|
1767
|
-
}).errors({
|
|
1768
|
-
NOT_FOUND: {},
|
|
1769
|
-
BAD_REQUEST: {}
|
|
1770
|
-
}).input(z.object({
|
|
2230
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1771
2231
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1772
2232
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1773
2233
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1775,7 +2235,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1775
2235
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1776
2236
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1777
2237
|
})).output(playgroundOutputSchema);
|
|
1778
|
-
const createBeaconContractV1 =
|
|
2238
|
+
const createBeaconContractV1 = base.route({
|
|
1779
2239
|
path: "/v1/beacon/audits",
|
|
1780
2240
|
method: "POST",
|
|
1781
2241
|
summary: "Create a beacon audit",
|
|
@@ -1784,7 +2244,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1784
2244
|
successDescription: "The audit has been created"
|
|
1785
2245
|
}).errors({
|
|
1786
2246
|
NOT_FOUND: {},
|
|
1787
|
-
BAD_REQUEST: {},
|
|
1788
2247
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1789
2248
|
}).input(z.object({
|
|
1790
2249
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1792,7 +2251,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1792
2251
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1793
2252
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1794
2253
|
})).output(z.object({ id: z.string() }));
|
|
1795
|
-
const getBeaconContractV1 =
|
|
2254
|
+
const getBeaconContractV1 = base.route({
|
|
1796
2255
|
path: "/v1/beacon/audits/{auditId}",
|
|
1797
2256
|
method: "GET",
|
|
1798
2257
|
summary: "Get a beacon audit",
|
|
@@ -1808,8 +2267,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1808
2267
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1809
2268
|
}));
|
|
1810
2269
|
const contract = {
|
|
1811
|
-
teams: {
|
|
2270
|
+
teams: {
|
|
2271
|
+
list: { v1: listTeamsContractV1 },
|
|
2272
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2273
|
+
},
|
|
1812
2274
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2275
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2276
|
+
intentCategories: {
|
|
2277
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2278
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2279
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2280
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2281
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2282
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2283
|
+
},
|
|
2284
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1813
2285
|
deployments: {
|
|
1814
2286
|
list: { v1: listDeploymentsContractV1 },
|
|
1815
2287
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1850,5 +2322,10 @@ const contract = {
|
|
|
1850
2322
|
get: { v1: getBeaconContractV1 }
|
|
1851
2323
|
}
|
|
1852
2324
|
};
|
|
2325
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2326
|
+
const contractForDocs = {
|
|
2327
|
+
...contract,
|
|
2328
|
+
deployments: deploymentsForDocs
|
|
2329
|
+
};
|
|
1853
2330
|
//#endregion
|
|
1854
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2331
|
+
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 };
|