@alpic-ai/api 0.0.0-dev.gf5cd963 → 0.0.0-dev.gf60a82f
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 +1559 -62
- package/dist/index.mjs +801 -217
- package/package.json +26 -10
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -169,11 +169,22 @@ z$1.object({
|
|
|
169
169
|
token: z$1.string(),
|
|
170
170
|
token_type_hint: z$1.string().optional()
|
|
171
171
|
}).strip();
|
|
172
|
-
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
173
176
|
const PLATFORM_LABELS = {
|
|
174
177
|
chatgpt: "ChatGPT",
|
|
175
178
|
claudeai: "Claude.ai"
|
|
176
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cato",
|
|
183
|
+
"cloudflare",
|
|
184
|
+
"fastly"
|
|
185
|
+
];
|
|
186
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
187
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
188
|
const auditStatusSchema = z.enum([
|
|
178
189
|
"pending",
|
|
179
190
|
"partial",
|
|
@@ -246,6 +257,25 @@ z.object({
|
|
|
246
257
|
clientSecret: z.string(),
|
|
247
258
|
clientScopes: z.array(z.string())
|
|
248
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
249
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
250
280
|
"ongoing",
|
|
251
281
|
"deployed",
|
|
@@ -273,34 +303,51 @@ const deploymentSummarySchema = z.object({
|
|
|
273
303
|
createdAt: z.coerce.date(),
|
|
274
304
|
updatedAt: z.coerce.date()
|
|
275
305
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
306
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
307
|
const publicEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.literal(true),
|
|
309
|
+
oAuthMetadata: z.strictObject({})
|
|
310
|
+
});
|
|
311
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
312
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
313
|
+
allowsAnonymous: z.boolean(),
|
|
314
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
315
|
+
scope: z.string().optional()
|
|
316
|
+
});
|
|
317
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
318
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
319
|
+
allowsAnonymous: z.boolean(),
|
|
320
|
+
oAuthMetadata: z.object({
|
|
321
|
+
externalAuthorizationServerUrl: z.url(),
|
|
322
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
323
|
+
}),
|
|
324
|
+
scope: z.string().optional()
|
|
325
|
+
});
|
|
326
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
|
+
const standaloneEnvironmentSchema = z.object({
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
329
|
+
oAuthMetadata: z.object({
|
|
330
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
331
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
332
|
+
}),
|
|
333
|
+
scope: z.string().optional()
|
|
334
|
+
});
|
|
335
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
336
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
337
|
+
allowsAnonymous: z.literal(false),
|
|
338
|
+
oAuthMetadata: z.strictObject({}),
|
|
339
|
+
scope: z.string().optional()
|
|
340
|
+
});
|
|
341
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
342
|
isPublic: z.literal(true),
|
|
283
343
|
oAuthMetadata: z.undefined().optional()
|
|
284
344
|
});
|
|
285
|
-
|
|
286
|
-
* Protected environment with an external resource metadata URL
|
|
287
|
-
*
|
|
288
|
-
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
289
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
290
|
-
*/
|
|
291
|
-
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
345
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
346
|
isPublic: z.literal(false),
|
|
293
347
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
348
|
scope: z.string().optional()
|
|
295
349
|
});
|
|
296
|
-
|
|
297
|
-
* Protected environment with an external authorization server URL
|
|
298
|
-
*
|
|
299
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
300
|
-
* An external authorization server URL is returned when requesting the endpoint.
|
|
301
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
302
|
-
*/
|
|
303
|
-
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
350
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
351
|
isPublic: z.literal(false),
|
|
305
352
|
oAuthMetadata: z.object({
|
|
306
353
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +355,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
355
|
}),
|
|
309
356
|
scope: z.string().optional()
|
|
310
357
|
});
|
|
311
|
-
|
|
312
|
-
* Standalone protected environment
|
|
313
|
-
*
|
|
314
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
315
|
-
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
316
|
-
*/
|
|
317
|
-
const standaloneEnvironmentSchema = z.object({
|
|
358
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
359
|
isPublic: z.literal(false),
|
|
319
360
|
oAuthMetadata: z.object({
|
|
320
361
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +363,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
363
|
}),
|
|
323
364
|
scope: z.string().optional()
|
|
324
365
|
});
|
|
325
|
-
|
|
326
|
-
* Protected environment without OAuth discovery
|
|
327
|
-
*
|
|
328
|
-
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
329
|
-
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
330
|
-
* are advertised. Clients must obtain credentials out-of-band.
|
|
331
|
-
*/
|
|
332
|
-
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
366
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
367
|
isPublic: z.literal(false),
|
|
334
368
|
oAuthMetadata: z.strictObject({}),
|
|
335
369
|
scope: z.string().optional()
|
|
@@ -339,9 +373,19 @@ z.union([
|
|
|
339
373
|
externalResourceMetadataEnvironmentSchema,
|
|
340
374
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
375
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
376
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
377
|
+
legacyPublicEnvironmentSchema,
|
|
378
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
379
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
380
|
+
legacyStandaloneEnvironmentSchema,
|
|
381
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
382
|
+
]);
|
|
383
|
+
const playgroundModelSchema = z.enum([
|
|
384
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
385
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
386
|
+
"openai.gpt-5.4",
|
|
387
|
+
"openai.gpt-5.5"
|
|
343
388
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
389
|
const environmentDomainSchema = z.object({
|
|
346
390
|
name: z.string(),
|
|
347
391
|
status: z.enum([
|
|
@@ -361,6 +405,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
405
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
406
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
407
|
isPlaygroundEnabled: z.boolean(),
|
|
408
|
+
playgroundModel: playgroundModelSchema,
|
|
364
409
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
410
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
411
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -373,14 +418,17 @@ z.object({
|
|
|
373
418
|
sessionReplayEnabled: z.boolean(),
|
|
374
419
|
collectRequestPayload: z.boolean(),
|
|
375
420
|
collectResponsePayload: z.boolean(),
|
|
376
|
-
collectErrorMessage: z.boolean()
|
|
421
|
+
collectErrorMessage: z.boolean(),
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
377
424
|
});
|
|
378
|
-
z.object({
|
|
425
|
+
const feedbackSchema = z.object({
|
|
379
426
|
id: z.string(),
|
|
380
427
|
createdAt: z.coerce.date(),
|
|
381
428
|
environmentId: z.string(),
|
|
382
429
|
content: z.string(),
|
|
383
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
384
432
|
});
|
|
385
433
|
z.object({
|
|
386
434
|
content: z.string(),
|
|
@@ -396,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
396
444
|
"pink",
|
|
397
445
|
"gray"
|
|
398
446
|
]);
|
|
399
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
400
448
|
const intentCategorySchema = z.object({
|
|
401
449
|
id: z.string(),
|
|
402
450
|
createdAt: z.coerce.date(),
|
|
@@ -404,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
404
452
|
name: z.string(),
|
|
405
453
|
color: intentCategoryColorSchema
|
|
406
454
|
});
|
|
407
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
408
456
|
id: z.string(),
|
|
409
457
|
name: z.string(),
|
|
410
458
|
color: intentCategoryColorSchema,
|
|
@@ -416,6 +464,7 @@ z.object({
|
|
|
416
464
|
environmentId: z.string(),
|
|
417
465
|
toolName: z.string(),
|
|
418
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
419
468
|
categories: z.array(intentCategorySchema)
|
|
420
469
|
});
|
|
421
470
|
const signalCategorySchema = z.object({
|
|
@@ -474,12 +523,262 @@ z.object({
|
|
|
474
523
|
createdAt: z.coerce.date(),
|
|
475
524
|
updatedAt: z.coerce.date()
|
|
476
525
|
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
477
536
|
z.enum([
|
|
478
537
|
"INFO",
|
|
479
538
|
"WARNING",
|
|
480
539
|
"DEBUG",
|
|
481
540
|
"ERROR"
|
|
482
541
|
]);
|
|
542
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
|
+
const MCP_CLIENT_GROUPS = [
|
|
544
|
+
{
|
|
545
|
+
id: "claude_code",
|
|
546
|
+
label: "Claude Code",
|
|
547
|
+
vendor: "anthropic",
|
|
548
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
id: "claude",
|
|
552
|
+
label: "Claude",
|
|
553
|
+
vendor: "anthropic",
|
|
554
|
+
rawNames: [
|
|
555
|
+
"Anthropic/ClaudeAI",
|
|
556
|
+
"claude-ai",
|
|
557
|
+
"claude",
|
|
558
|
+
"Claude",
|
|
559
|
+
"claude-desktop",
|
|
560
|
+
"claude-desktop-3p"
|
|
561
|
+
]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "claude_mobile",
|
|
565
|
+
label: "Claude mobile",
|
|
566
|
+
vendor: "anthropic",
|
|
567
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
id: "claude_cowork",
|
|
571
|
+
label: "Claude Cowork",
|
|
572
|
+
vendor: "anthropic",
|
|
573
|
+
rawNames: ["Anthropic/Cowork"]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "claude_toolbox",
|
|
577
|
+
label: "Claude Toolbox",
|
|
578
|
+
vendor: "anthropic",
|
|
579
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "anthropic_api",
|
|
583
|
+
label: "Anthropic API",
|
|
584
|
+
vendor: "anthropic",
|
|
585
|
+
rawNames: ["Anthropic/API"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "anthropic_connector_refresh",
|
|
589
|
+
label: "Anthropic (connector refresh)",
|
|
590
|
+
vendor: "anthropic",
|
|
591
|
+
rawNames: ["Anthropic"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "codex",
|
|
595
|
+
label: "Codex",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: [
|
|
598
|
+
"codex-mcp-client",
|
|
599
|
+
"codex",
|
|
600
|
+
"Codex",
|
|
601
|
+
"codex-cli",
|
|
602
|
+
"openai-mcp (Codex)"
|
|
603
|
+
]
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
id: "chatgpt",
|
|
607
|
+
label: "ChatGPT",
|
|
608
|
+
vendor: "openai",
|
|
609
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
id: "openai_responses_api",
|
|
613
|
+
label: "OpenAI Responses API",
|
|
614
|
+
vendor: "openai",
|
|
615
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
id: "openai_agent_builder",
|
|
619
|
+
label: "OpenAI Agent Builder",
|
|
620
|
+
vendor: "openai",
|
|
621
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
id: "openai_other",
|
|
625
|
+
label: "OpenAI Other",
|
|
626
|
+
vendor: "openai",
|
|
627
|
+
rawNames: ["openai-mcp"]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cursor",
|
|
631
|
+
label: "Cursor",
|
|
632
|
+
vendor: "cursor",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"cursor-vscode",
|
|
635
|
+
"Cursor",
|
|
636
|
+
"cursor"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "cline",
|
|
641
|
+
label: "Cline",
|
|
642
|
+
vendor: "cline",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Cline",
|
|
645
|
+
"cline",
|
|
646
|
+
"@cline/core"
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
id: "github_copilot",
|
|
651
|
+
label: "GitHub Copilot",
|
|
652
|
+
vendor: "githubCopilot",
|
|
653
|
+
rawNames: [
|
|
654
|
+
"Copilot",
|
|
655
|
+
"github-copilot-developer",
|
|
656
|
+
"Copilot MCP Gateway",
|
|
657
|
+
"Xcode/copilot-xcode"
|
|
658
|
+
]
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
id: "gemini_cli",
|
|
662
|
+
label: "Gemini CLI",
|
|
663
|
+
vendor: "google",
|
|
664
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "antigravity",
|
|
668
|
+
label: "Antigravity",
|
|
669
|
+
vendor: "google",
|
|
670
|
+
rawNames: ["antigravity-client"]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "gemini",
|
|
674
|
+
label: "Gemini",
|
|
675
|
+
vendor: "google",
|
|
676
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
id: "windsurf",
|
|
680
|
+
label: "Windsurf",
|
|
681
|
+
vendor: "windsurf",
|
|
682
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
id: "mistral",
|
|
686
|
+
label: "Mistral / Le Chat",
|
|
687
|
+
vendor: "mistral",
|
|
688
|
+
rawNames: ["Mistral"],
|
|
689
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "n8n",
|
|
693
|
+
label: "n8n",
|
|
694
|
+
vendor: "n8n",
|
|
695
|
+
rawNames: [
|
|
696
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
698
|
+
"n8n"
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "alpic_playground",
|
|
703
|
+
label: "Alpic Playground",
|
|
704
|
+
vendor: "alpic",
|
|
705
|
+
rawNames: ["alpic-playground", "playground"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "opencode",
|
|
709
|
+
label: "opencode",
|
|
710
|
+
vendor: "opencode",
|
|
711
|
+
rawNames: ["opencode"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "zed",
|
|
715
|
+
label: "Zed",
|
|
716
|
+
vendor: "zed",
|
|
717
|
+
rawNames: ["Zed", "zed"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "zapier",
|
|
721
|
+
label: "Zapier",
|
|
722
|
+
vendor: "zapier",
|
|
723
|
+
rawNames: ["Zapier", "zapier"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "make",
|
|
727
|
+
label: "Make",
|
|
728
|
+
vendor: "make",
|
|
729
|
+
rawNames: ["Make", "make"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "librechat",
|
|
733
|
+
label: "LibreChat",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["LibreChat", "librechat"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "jan",
|
|
739
|
+
label: "Jan",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: ["Jan", "jan"]
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
id: "goose",
|
|
745
|
+
label: "goose",
|
|
746
|
+
vendor: "mcp",
|
|
747
|
+
rawNames: ["goose", "Goose"]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
id: "mcphost",
|
|
751
|
+
label: "mcphost",
|
|
752
|
+
vendor: "mcp",
|
|
753
|
+
rawNames: ["mcphost"]
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
id: "mcporter",
|
|
757
|
+
label: "mcporter",
|
|
758
|
+
vendor: "mcp",
|
|
759
|
+
rawNames: ["mcporter"]
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
id: "rmcp",
|
|
763
|
+
label: "rmcp",
|
|
764
|
+
vendor: "mcp",
|
|
765
|
+
rawNames: ["rmcp"]
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
id: "unnamed_client",
|
|
769
|
+
label: "Unnamed client",
|
|
770
|
+
vendor: "mcp",
|
|
771
|
+
rawNames: [
|
|
772
|
+
"mcp",
|
|
773
|
+
"unknown",
|
|
774
|
+
""
|
|
775
|
+
]
|
|
776
|
+
}
|
|
777
|
+
];
|
|
778
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
779
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
780
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
781
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
483
782
|
const runtimeSchema = z.enum([
|
|
484
783
|
"python3.13",
|
|
485
784
|
"python3.14",
|
|
@@ -508,6 +807,16 @@ z.object({
|
|
|
508
807
|
environments: z.array(environmentWithDomainsSchema),
|
|
509
808
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
510
809
|
});
|
|
810
|
+
const domainFailureReasonSchema = z.enum([
|
|
811
|
+
"caa",
|
|
812
|
+
"dns",
|
|
813
|
+
"invalid_domain",
|
|
814
|
+
"other"
|
|
815
|
+
]);
|
|
816
|
+
const projectDomainMappingSchema = z.object({
|
|
817
|
+
pathPrefix: z.string(),
|
|
818
|
+
environment: environmentSchema$1
|
|
819
|
+
});
|
|
511
820
|
z.object({
|
|
512
821
|
name: z.string(),
|
|
513
822
|
createdAt: z.coerce.date(),
|
|
@@ -516,7 +825,9 @@ z.object({
|
|
|
516
825
|
"deployed",
|
|
517
826
|
"failed"
|
|
518
827
|
]),
|
|
519
|
-
|
|
828
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
829
|
+
environment: environmentSchema$1,
|
|
830
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
520
831
|
});
|
|
521
832
|
const serverFieldsSchema$1 = z.object({
|
|
522
833
|
$schema: z.string(),
|
|
@@ -545,15 +856,7 @@ z.object({
|
|
|
545
856
|
serverFields: serverFieldsSchema$1,
|
|
546
857
|
source: z.enum(["registry", "defaults"])
|
|
547
858
|
});
|
|
548
|
-
/**
|
|
549
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
550
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
551
|
-
*
|
|
552
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
553
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
554
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
555
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
556
|
-
*/
|
|
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. */
|
|
557
860
|
const clampStringField = (field) => {
|
|
558
861
|
const max = field.maxLength;
|
|
559
862
|
if (max === null) return field;
|
|
@@ -573,15 +876,24 @@ const toolDefinitionSchema = z.object({
|
|
|
573
876
|
}).optional()
|
|
574
877
|
});
|
|
575
878
|
const positiveTestCaseSchema = z.object({
|
|
576
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
577
|
-
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
879
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
880
|
+
userPrompt: z.string().min(1).describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
578
881
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
579
882
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
580
|
-
}).
|
|
883
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
884
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial();
|
|
885
|
+
const blankPositiveTestCase = () => ({
|
|
886
|
+
scenario: "",
|
|
887
|
+
userPrompt: "",
|
|
888
|
+
toolTriggered: "",
|
|
889
|
+
expectedOutput: ""
|
|
890
|
+
});
|
|
891
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
581
892
|
const screenshotEntrySchema = z.object({
|
|
582
893
|
prompt: z.string(),
|
|
583
|
-
url: z.url()
|
|
894
|
+
url: z.url()
|
|
584
895
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
896
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
585
897
|
/** Accepts either a valid email or URL. */
|
|
586
898
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
587
899
|
/** A URL field whose error spells out that the scheme is required. */
|
|
@@ -889,20 +1201,21 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
889
1201
|
"zh-TW"
|
|
890
1202
|
]);
|
|
891
1203
|
const negativeTestCaseSchema = z.object({
|
|
892
|
-
scenario: z.string(),
|
|
893
|
-
userPrompt: z.string()
|
|
894
|
-
}).
|
|
1204
|
+
scenario: z.string().min(1),
|
|
1205
|
+
userPrompt: z.string().min(1)
|
|
1206
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1207
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial();
|
|
1208
|
+
const blankNegativeTestCase = () => ({
|
|
1209
|
+
scenario: "",
|
|
1210
|
+
userPrompt: ""
|
|
1211
|
+
});
|
|
895
1212
|
const chatgptToolJustificationSchema = z.object({
|
|
896
1213
|
toolName: z.string(),
|
|
897
1214
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
898
1215
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
899
1216
|
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.\"")
|
|
900
1217
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
901
|
-
/**
|
|
902
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
903
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
904
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
905
|
-
*/
|
|
1218
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
906
1219
|
const chatgptTaglineSchema = z.string().max(30);
|
|
907
1220
|
const chatgptDescriptionSchema = z.string();
|
|
908
1221
|
const chatgptTranslationSchema = z.object({
|
|
@@ -911,10 +1224,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
911
1224
|
description: chatgptDescriptionSchema
|
|
912
1225
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
913
1226
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
914
|
-
/**
|
|
915
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
916
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
917
|
-
*/
|
|
1227
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
918
1228
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
919
1229
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
920
1230
|
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."),
|
|
@@ -933,28 +1243,47 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
933
1243
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
934
1244
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
935
1245
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
936
|
-
testCases: z.array(positiveTestCaseSchema).describe("
|
|
937
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
1246
|
+
testCases: z.array(positiveTestCaseSchema).length(5).describe("Exactly 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
1247
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
938
1248
|
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
939
1249
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
940
1250
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
941
1251
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
942
1252
|
});
|
|
943
|
-
chatgptSubmissionFormDataSchema.
|
|
1253
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1254
|
+
tagline: z.string().optional(),
|
|
1255
|
+
companyUrl: z.string().optional(),
|
|
1256
|
+
supportChannel: z.string().optional(),
|
|
1257
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1258
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1259
|
+
demoRecordingUrl: z.string().optional(),
|
|
1260
|
+
serverUrl: z.string().optional(),
|
|
1261
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1262
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1263
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1264
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1265
|
+
});
|
|
1266
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1267
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
944
1268
|
appName: true,
|
|
945
1269
|
developerName: true,
|
|
946
1270
|
serverUrl: true,
|
|
947
1271
|
tools: true,
|
|
948
1272
|
authentication: true
|
|
949
1273
|
});
|
|
950
|
-
|
|
1274
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1275
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
951
1276
|
tagline: true,
|
|
952
1277
|
description: true,
|
|
953
1278
|
category: true,
|
|
954
1279
|
testCases: true,
|
|
955
1280
|
negativeTestCases: true,
|
|
956
1281
|
toolJustifications: true
|
|
957
|
-
}).extend({
|
|
1282
|
+
}).extend({
|
|
1283
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1284
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1285
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1286
|
+
});
|
|
958
1287
|
const claudeCategorySchema = z.enum([
|
|
959
1288
|
"Productivity",
|
|
960
1289
|
"Communication",
|
|
@@ -1000,11 +1329,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1000
1329
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1001
1330
|
"Public documentation for this connector will be live by the publish date."
|
|
1002
1331
|
]);
|
|
1003
|
-
/**
|
|
1004
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1005
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1006
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1007
|
-
*/
|
|
1332
|
+
/** 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. */
|
|
1008
1333
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1009
1334
|
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
|
|
1010
1335
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1018,8 +1343,8 @@ phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects i
|
|
|
1018
1343
|
description: z.string().max(2e3).describe(`A description of what your connector does and its key features, shown on the connector's detail page in
|
|
1019
1344
|
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1020
1345
|
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1021
|
-
iconUrl: z.url().optional().describe(`Optional custom icon
|
|
1022
|
-
|
|
1346
|
+
iconUrl: z.url().optional().describe(`Optional custom icon for the directory listing — a square SVG. By default the favicon from your MCP URL is used
|
|
1347
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1023
1348
|
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1024
1349
|
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1025
1350
|
by your publish date.`),
|
|
@@ -1027,6 +1352,8 @@ by your publish date.`),
|
|
|
1027
1352
|
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1028
1353
|
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1029
1354
|
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1355
|
+
screenshots: z.array(screenshotEntrySchema).optional().describe(`Carousel images shown on your connector's directory page (PNG). Each is paired with the user prompt that produced
|
|
1356
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1030
1357
|
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1031
1358
|
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1032
1359
|
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
@@ -1064,7 +1391,23 @@ fully populated account.`),
|
|
|
1064
1391
|
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1065
1392
|
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1066
1393
|
});
|
|
1067
|
-
claudeSubmissionFormDataSchema.
|
|
1394
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1395
|
+
serverUrl: z.string().optional(),
|
|
1396
|
+
name: z.string().optional(),
|
|
1397
|
+
slug: z.string().optional(),
|
|
1398
|
+
oneLiner: z.string().optional(),
|
|
1399
|
+
description: z.string().optional(),
|
|
1400
|
+
iconUrl: z.string().optional(),
|
|
1401
|
+
documentation: z.string().optional(),
|
|
1402
|
+
support: z.string().optional(),
|
|
1403
|
+
privacyPolicy: z.string().optional(),
|
|
1404
|
+
companyWebsite: z.string().optional(),
|
|
1405
|
+
primaryContactEmail: z.string().optional(),
|
|
1406
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1407
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1408
|
+
});
|
|
1409
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1410
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1068
1411
|
serverUrl: true,
|
|
1069
1412
|
name: true,
|
|
1070
1413
|
slug: true,
|
|
@@ -1079,39 +1422,98 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1079
1422
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1080
1423
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1081
1424
|
});
|
|
1082
|
-
/**
|
|
1083
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1084
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1085
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1086
|
-
* colocated with the Claude contract.
|
|
1087
|
-
*/
|
|
1425
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1088
1426
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1089
1427
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1090
1428
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1091
1429
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1092
1430
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1093
1431
|
});
|
|
1094
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1432
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1095
1433
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1096
1434
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1097
1435
|
});
|
|
1436
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1437
|
+
const byField = {};
|
|
1438
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1439
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1440
|
+
return byField;
|
|
1441
|
+
}
|
|
1442
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1443
|
+
/**
|
|
1444
|
+
* Three outcomes, not two: a page we could not read is never reported as a broken one, because
|
|
1445
|
+
* telling someone their working privacy policy is broken is worse than saying nothing.
|
|
1446
|
+
*/
|
|
1447
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1448
|
+
"pass",
|
|
1449
|
+
"fail",
|
|
1450
|
+
"unverified"
|
|
1451
|
+
]);
|
|
1452
|
+
/** Checked against each platform's own form shape, so renaming a field there breaks this instead of silently skipping it. */
|
|
1453
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1454
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1455
|
+
claudeai: ["privacyPolicy"]
|
|
1456
|
+
};
|
|
1457
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1458
|
+
const policyDisclosureSchema = z.enum([
|
|
1459
|
+
"dataCategories",
|
|
1460
|
+
"purposesOfUse",
|
|
1461
|
+
"recipients",
|
|
1462
|
+
"retention"
|
|
1463
|
+
]);
|
|
1464
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1465
|
+
field: verifiableUrlFieldSchema,
|
|
1466
|
+
url: z.string(),
|
|
1467
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1468
|
+
/** Shown to the user as the reason for the outcome, so it names the URL's problem, not ours. */
|
|
1469
|
+
reason: z.string(),
|
|
1470
|
+
/** Non-blocking observations about a page that is otherwise the right kind of document. */
|
|
1471
|
+
concerns: z.array(z.string()).optional(),
|
|
1472
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1473
|
+
});
|
|
1474
|
+
const urlVerificationSchema = z.object({
|
|
1475
|
+
verifiedAt: z.coerce.date(),
|
|
1476
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1477
|
+
});
|
|
1478
|
+
const pageKindSchema = z.enum([
|
|
1479
|
+
"expectedDocument",
|
|
1480
|
+
"errorPage",
|
|
1481
|
+
"loginWall",
|
|
1482
|
+
"parkedDomain",
|
|
1483
|
+
"comingSoon",
|
|
1484
|
+
"marketingPage",
|
|
1485
|
+
"unrelatedDocument"
|
|
1486
|
+
]);
|
|
1487
|
+
z.object({
|
|
1488
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1489
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1490
|
+
missingDisclosures: z.array(policyDisclosureSchema).describe("For a privacy policy only: which of the four required disclosures the text does not cover. Empty for every other page kind.")
|
|
1491
|
+
});
|
|
1098
1492
|
const submissionMetaFieldsSchema = z.object({
|
|
1099
1493
|
id: z.string(),
|
|
1100
1494
|
environmentId: z.string(),
|
|
1101
1495
|
auditId: z.string().nullable(),
|
|
1496
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1102
1497
|
createdAt: z.coerce.date(),
|
|
1103
1498
|
updatedAt: z.coerce.date()
|
|
1104
1499
|
});
|
|
1105
1500
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1106
1501
|
platform: z.literal("claudeai"),
|
|
1107
|
-
formData:
|
|
1502
|
+
formData: claudeSubmissionDraftSchema,
|
|
1503
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1108
1504
|
});
|
|
1109
1505
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1110
1506
|
platform: z.literal("chatgpt"),
|
|
1111
|
-
formData:
|
|
1507
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1508
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1112
1509
|
});
|
|
1113
1510
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1114
|
-
z.union([
|
|
1511
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1512
|
+
z.literal([
|
|
1513
|
+
100,
|
|
1514
|
+
75,
|
|
1515
|
+
50
|
|
1516
|
+
]);
|
|
1115
1517
|
const subscriptionPlanSchema = z.enum([
|
|
1116
1518
|
"pro",
|
|
1117
1519
|
"business",
|
|
@@ -1123,17 +1525,70 @@ const customerCreditsSchema = z.object({
|
|
|
1123
1525
|
expiresAt: z.number().nullable(),
|
|
1124
1526
|
currency: z.string()
|
|
1125
1527
|
});
|
|
1126
|
-
const customerUsageSchema = z.object({
|
|
1127
|
-
amountInCents: z.number(),
|
|
1128
|
-
currency: z.string(),
|
|
1129
|
-
periodEnd: z.number()
|
|
1130
|
-
});
|
|
1131
1528
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1132
1529
|
z.object({
|
|
1133
1530
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1134
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1135
1531
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1136
1532
|
});
|
|
1533
|
+
const metricsQueueEventSchema = z.object({
|
|
1534
|
+
ts: z.number().int(),
|
|
1535
|
+
method: z.string(),
|
|
1536
|
+
tool: z.string().nullable(),
|
|
1537
|
+
client: z.string(),
|
|
1538
|
+
sessionId: z.string().nullable(),
|
|
1539
|
+
durationMs: z.number().int(),
|
|
1540
|
+
outputTokens: z.number().int().nullable(),
|
|
1541
|
+
errorType: z.enum([
|
|
1542
|
+
"mcp_error",
|
|
1543
|
+
"tool_error",
|
|
1544
|
+
"timeout"
|
|
1545
|
+
]).nullable(),
|
|
1546
|
+
errorCode: z.number().int().nullable()
|
|
1547
|
+
});
|
|
1548
|
+
z.object({
|
|
1549
|
+
v: z.literal(1),
|
|
1550
|
+
envId: z.string(),
|
|
1551
|
+
events: z.array(metricsQueueEventSchema)
|
|
1552
|
+
});
|
|
1553
|
+
z.object({ v: z.number() });
|
|
1554
|
+
const telemetrySignalSchema = z.enum([
|
|
1555
|
+
"logs",
|
|
1556
|
+
"metrics",
|
|
1557
|
+
"traces"
|
|
1558
|
+
]);
|
|
1559
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1560
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1561
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1562
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1563
|
+
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");
|
|
1564
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1565
|
+
id: z.string(),
|
|
1566
|
+
name: otlpHeaderNameSchema,
|
|
1567
|
+
value: otlpHeaderValueSchema,
|
|
1568
|
+
isSecret: z.boolean()
|
|
1569
|
+
});
|
|
1570
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1571
|
+
"credentials",
|
|
1572
|
+
"wrong-path",
|
|
1573
|
+
"wrong-protocol",
|
|
1574
|
+
"invalid-payload",
|
|
1575
|
+
"partial-rejection",
|
|
1576
|
+
"blocked-target",
|
|
1577
|
+
"timeout",
|
|
1578
|
+
"unreachable",
|
|
1579
|
+
"receiver-error",
|
|
1580
|
+
"unexpected-status"
|
|
1581
|
+
]);
|
|
1582
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1583
|
+
z.object({
|
|
1584
|
+
id: z.string(),
|
|
1585
|
+
signal: telemetrySignalSchema,
|
|
1586
|
+
endpoint: otlpEndpointSchema,
|
|
1587
|
+
protocol: otlpProtocolSchema,
|
|
1588
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1589
|
+
status: telemetryDestinationStatusSchema,
|
|
1590
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1591
|
+
});
|
|
1137
1592
|
//#endregion
|
|
1138
1593
|
//#region src/auth-scope.ts
|
|
1139
1594
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1176,7 +1631,10 @@ const RESERVED_KEYS = [
|
|
|
1176
1631
|
"BUILD_ARG_START_COMMAND",
|
|
1177
1632
|
"ALPIC_HOST",
|
|
1178
1633
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1179
|
-
"ALPIC_INTENT_META_KEY"
|
|
1634
|
+
"ALPIC_INTENT_META_KEY",
|
|
1635
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1636
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1637
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1180
1638
|
];
|
|
1181
1639
|
const environmentVariableSchema = z.object({
|
|
1182
1640
|
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"),
|
|
@@ -1229,6 +1687,14 @@ const serverFieldsSchema = z.object({
|
|
|
1229
1687
|
});
|
|
1230
1688
|
//#endregion
|
|
1231
1689
|
//#region src/api.contract.ts
|
|
1690
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1691
|
+
try {
|
|
1692
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1693
|
+
return true;
|
|
1694
|
+
} catch {
|
|
1695
|
+
return false;
|
|
1696
|
+
}
|
|
1697
|
+
};
|
|
1232
1698
|
const deploymentStatusSchema = z.enum([
|
|
1233
1699
|
"ongoing",
|
|
1234
1700
|
"deployed",
|
|
@@ -1257,21 +1723,20 @@ const deploymentSchema = z.object({
|
|
|
1257
1723
|
isCurrent: z.boolean(),
|
|
1258
1724
|
deploymentPageUrl: z.url().nullable()
|
|
1259
1725
|
});
|
|
1260
|
-
const
|
|
1726
|
+
const isValidTimeInput = (value) => {
|
|
1261
1727
|
if (ms(value) !== void 0) return true;
|
|
1262
1728
|
return !Number.isNaN(new Date(value).getTime());
|
|
1263
1729
|
};
|
|
1264
|
-
const
|
|
1730
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1731
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1732
|
+
const createEnvironmentContractV1 = base.route({
|
|
1265
1733
|
path: "/v1/environments",
|
|
1266
1734
|
method: "POST",
|
|
1267
1735
|
summary: "Create an environment",
|
|
1268
1736
|
description: "Create an environment for a project",
|
|
1269
1737
|
tags: ["environments"],
|
|
1270
1738
|
successDescription: "The environment has been created successfully"
|
|
1271
|
-
}).errors({
|
|
1272
|
-
NOT_FOUND: {},
|
|
1273
|
-
BAD_REQUEST: {}
|
|
1274
|
-
}).input(z.object({
|
|
1739
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1275
1740
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1276
1741
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1277
1742
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1284,7 +1749,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1284
1749
|
createdAt: z.coerce.date(),
|
|
1285
1750
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1286
1751
|
}));
|
|
1287
|
-
const getEnvironmentContractV1 =
|
|
1752
|
+
const getEnvironmentContractV1 = base.route({
|
|
1288
1753
|
path: "/v1/environments/{environmentId}",
|
|
1289
1754
|
method: "GET",
|
|
1290
1755
|
summary: "Get an environment",
|
|
@@ -1300,8 +1765,16 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1300
1765
|
createdAt: z.coerce.date(),
|
|
1301
1766
|
projectId: z.string()
|
|
1302
1767
|
}));
|
|
1768
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1769
|
+
path: "/v1/environments/{environmentId}",
|
|
1770
|
+
method: "DELETE",
|
|
1771
|
+
summary: "Delete an environment",
|
|
1772
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1773
|
+
tags: ["environments"],
|
|
1774
|
+
successDescription: "The environment has been deleted successfully"
|
|
1775
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1303
1776
|
const domainSchema = z.object({
|
|
1304
|
-
|
|
1777
|
+
domain: z.string(),
|
|
1305
1778
|
status: z.enum([
|
|
1306
1779
|
"ongoing",
|
|
1307
1780
|
"deployed",
|
|
@@ -1341,7 +1814,7 @@ const projectOutputSchema = z.object({
|
|
|
1341
1814
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1342
1815
|
environments: z.array(environmentSchema)
|
|
1343
1816
|
});
|
|
1344
|
-
const getProjectContractV1 =
|
|
1817
|
+
const getProjectContractV1 = base.route({
|
|
1345
1818
|
path: "/v1/projects/{projectId}",
|
|
1346
1819
|
method: "GET",
|
|
1347
1820
|
summary: "Get a project",
|
|
@@ -1349,18 +1822,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1349
1822
|
tags: ["projects"],
|
|
1350
1823
|
successDescription: "The project details"
|
|
1351
1824
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1352
|
-
const listProjectsContractV1 =
|
|
1825
|
+
const listProjectsContractV1 = base.route({
|
|
1353
1826
|
path: "/v1/projects",
|
|
1354
1827
|
method: "GET",
|
|
1355
1828
|
summary: "List projects",
|
|
1356
1829
|
description: "List all projects for a team",
|
|
1357
1830
|
tags: ["projects"],
|
|
1358
1831
|
successDescription: "The list of projects"
|
|
1359
|
-
}).errors({
|
|
1360
|
-
|
|
1361
|
-
BAD_REQUEST: {}
|
|
1362
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1363
|
-
const createProjectContractV1 = oc.route({
|
|
1832
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1833
|
+
const createProjectContractV1 = base.route({
|
|
1364
1834
|
path: "/v1/projects",
|
|
1365
1835
|
method: "POST",
|
|
1366
1836
|
summary: "Create a project",
|
|
@@ -1369,7 +1839,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1369
1839
|
successDescription: "The project has been created successfully"
|
|
1370
1840
|
}).errors({
|
|
1371
1841
|
NOT_FOUND: {},
|
|
1372
|
-
BAD_REQUEST: {},
|
|
1373
1842
|
FORBIDDEN: {}
|
|
1374
1843
|
}).input(z.object({
|
|
1375
1844
|
teamId: z.string().optional(),
|
|
@@ -1410,7 +1879,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1410
1879
|
isSecret: z.boolean(),
|
|
1411
1880
|
createdAt: z.coerce.date()
|
|
1412
1881
|
});
|
|
1413
|
-
const listEnvironmentVariablesContractV1 =
|
|
1882
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1414
1883
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1415
1884
|
method: "GET",
|
|
1416
1885
|
summary: "List environment variables",
|
|
@@ -1418,48 +1887,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1418
1887
|
tags: ["environments"],
|
|
1419
1888
|
successDescription: "The list of environment variables"
|
|
1420
1889
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1421
|
-
const createEnvironmentVariablesContractV1 =
|
|
1890
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1422
1891
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1423
1892
|
method: "POST",
|
|
1424
1893
|
summary: "Add environment variables",
|
|
1425
1894
|
description: "Add one or more environment variables to an environment",
|
|
1426
1895
|
tags: ["environments"],
|
|
1427
1896
|
successDescription: "The environment variables have been added successfully"
|
|
1428
|
-
}).errors({
|
|
1429
|
-
NOT_FOUND: {},
|
|
1430
|
-
BAD_REQUEST: {}
|
|
1431
|
-
}).input(z.object({
|
|
1897
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1432
1898
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1433
1899
|
environmentVariables: environmentVariablesSchema
|
|
1434
1900
|
})).output(z.object({ success: z.literal(true) }));
|
|
1435
|
-
const updateEnvironmentVariableContractV1 =
|
|
1901
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1436
1902
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1437
1903
|
method: "PATCH",
|
|
1438
1904
|
summary: "Update an environment variable",
|
|
1439
1905
|
description: "Update an environment variable by ID",
|
|
1440
1906
|
tags: ["environments"],
|
|
1441
1907
|
successDescription: "The environment variable has been updated successfully"
|
|
1442
|
-
}).errors({
|
|
1443
|
-
NOT_FOUND: {},
|
|
1444
|
-
BAD_REQUEST: {}
|
|
1445
|
-
}).input(z.object({
|
|
1908
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1446
1909
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1447
1910
|
key: environmentVariableSchema.shape.key,
|
|
1448
1911
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1449
1912
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1450
1913
|
})).output(z.object({ success: z.literal(true) }));
|
|
1451
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1914
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1452
1915
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1453
1916
|
method: "DELETE",
|
|
1454
1917
|
summary: "Delete an environment variable",
|
|
1455
1918
|
description: "Delete an environment variable by ID",
|
|
1456
1919
|
tags: ["environments"],
|
|
1457
1920
|
successDescription: "The environment variable has been deleted successfully"
|
|
1458
|
-
}).errors({
|
|
1459
|
-
|
|
1460
|
-
BAD_REQUEST: {}
|
|
1461
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1462
|
-
const deleteProjectContractV1 = oc.route({
|
|
1921
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1922
|
+
const deleteProjectContractV1 = base.route({
|
|
1463
1923
|
path: "/v1/projects/{projectId}",
|
|
1464
1924
|
method: "DELETE",
|
|
1465
1925
|
summary: "Delete a project",
|
|
@@ -1467,7 +1927,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1467
1927
|
tags: ["projects"],
|
|
1468
1928
|
successDescription: "The project has been deleted successfully"
|
|
1469
1929
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1470
|
-
const updateProjectContractV1 =
|
|
1930
|
+
const updateProjectContractV1 = base.route({
|
|
1471
1931
|
path: "/v1/projects/{projectId}",
|
|
1472
1932
|
method: "PATCH",
|
|
1473
1933
|
summary: "Update a project",
|
|
@@ -1476,14 +1936,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1476
1936
|
successDescription: "The project has been updated successfully"
|
|
1477
1937
|
}).errors({
|
|
1478
1938
|
NOT_FOUND: {},
|
|
1479
|
-
BAD_REQUEST: {},
|
|
1480
1939
|
FORBIDDEN: {}
|
|
1481
1940
|
}).input(z.object({
|
|
1482
1941
|
projectId: z.string().describe("The ID of the project"),
|
|
1483
1942
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1484
1943
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1485
1944
|
})).output(projectOutputSchema);
|
|
1486
|
-
const deployEnvironmentContractV1 =
|
|
1945
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1487
1946
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1488
1947
|
method: "POST",
|
|
1489
1948
|
summary: "Deploy an environment",
|
|
@@ -1492,27 +1951,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1492
1951
|
successDescription: "The environment has been deployed successfully"
|
|
1493
1952
|
}).errors({
|
|
1494
1953
|
NOT_FOUND: {},
|
|
1495
|
-
|
|
1954
|
+
CONFLICT: {}
|
|
1496
1955
|
}).input(z.object({
|
|
1497
1956
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1498
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1957
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1958
|
+
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.")
|
|
1499
1959
|
})).output(deploymentSchema);
|
|
1500
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1960
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1501
1961
|
path: "/v1/deployments/upload",
|
|
1502
1962
|
method: "POST",
|
|
1503
1963
|
summary: "Upload deployment artifacts",
|
|
1504
1964
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1505
1965
|
tags: ["deployments"],
|
|
1506
1966
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1507
|
-
}).errors({
|
|
1508
|
-
NOT_FOUND: {},
|
|
1509
|
-
BAD_REQUEST: {}
|
|
1510
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1967
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1511
1968
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1512
1969
|
token: z.string().describe("Token to identify the source archive"),
|
|
1513
1970
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1514
1971
|
}));
|
|
1515
|
-
const listDeploymentsContractV1 =
|
|
1972
|
+
const listDeploymentsContractV1 = base.route({
|
|
1516
1973
|
path: "/v1/projects/{projectId}/deployments",
|
|
1517
1974
|
method: "GET",
|
|
1518
1975
|
summary: "List project deployments",
|
|
@@ -1524,7 +1981,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1524
1981
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1525
1982
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1526
1983
|
})).output(z.array(deploymentSchema));
|
|
1527
|
-
const getDeploymentContractV1 =
|
|
1984
|
+
const getDeploymentContractV1 = base.route({
|
|
1528
1985
|
path: "/v1/deployments/{deploymentId}",
|
|
1529
1986
|
method: "GET",
|
|
1530
1987
|
summary: "Get a deployment",
|
|
@@ -1532,20 +1989,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1532
1989
|
tags: ["deployments"],
|
|
1533
1990
|
successDescription: "The deployment details"
|
|
1534
1991
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1535
|
-
const
|
|
1992
|
+
const logEntrySchema = z.object({
|
|
1993
|
+
timestamp: z.coerce.date(),
|
|
1994
|
+
type: z.enum([
|
|
1995
|
+
"START",
|
|
1996
|
+
"END",
|
|
1997
|
+
"INFO",
|
|
1998
|
+
"ERROR",
|
|
1999
|
+
"WARNING",
|
|
2000
|
+
"DEBUG"
|
|
2001
|
+
]),
|
|
2002
|
+
requestId: z.string(),
|
|
2003
|
+
content: z.string().optional(),
|
|
2004
|
+
method: z.string().optional(),
|
|
2005
|
+
durationInMs: z.number().optional()
|
|
2006
|
+
});
|
|
2007
|
+
const getLogsContractV1 = base.route({
|
|
1536
2008
|
path: "/v1/environments/{environmentId}/logs",
|
|
1537
2009
|
method: "GET",
|
|
1538
2010
|
summary: "Get logs",
|
|
1539
2011
|
description: "Get logs for an environment",
|
|
1540
2012
|
tags: ["environments"],
|
|
1541
2013
|
successDescription: "The logs"
|
|
1542
|
-
}).errors({
|
|
1543
|
-
NOT_FOUND: {},
|
|
1544
|
-
BAD_REQUEST: {}
|
|
1545
|
-
}).input(z.object({
|
|
2014
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1546
2015
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1547
|
-
since:
|
|
1548
|
-
until:
|
|
2016
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2017
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1549
2018
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1550
2019
|
level: z.array(z.enum([
|
|
1551
2020
|
"INFO",
|
|
@@ -1556,34 +2025,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1556
2025
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1557
2026
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1558
2027
|
})).output(z.object({
|
|
1559
|
-
logs: z.array(
|
|
1560
|
-
timestamp: z.coerce.date(),
|
|
1561
|
-
type: z.enum([
|
|
1562
|
-
"START",
|
|
1563
|
-
"END",
|
|
1564
|
-
"INFO",
|
|
1565
|
-
"ERROR",
|
|
1566
|
-
"WARNING",
|
|
1567
|
-
"DEBUG"
|
|
1568
|
-
]),
|
|
1569
|
-
requestId: z.string(),
|
|
1570
|
-
content: z.string().optional(),
|
|
1571
|
-
method: z.string().optional(),
|
|
1572
|
-
durationInMs: z.number().optional()
|
|
1573
|
-
})),
|
|
2028
|
+
logs: z.array(logEntrySchema),
|
|
1574
2029
|
nextToken: z.string().nullable()
|
|
1575
2030
|
}));
|
|
1576
|
-
const getLatestLogsContractV1 =
|
|
2031
|
+
const getLatestLogsContractV1 = base.route({
|
|
1577
2032
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1578
2033
|
method: "GET",
|
|
1579
2034
|
summary: "Get latest logs",
|
|
1580
2035
|
description: "Get the N most recent logs for an environment",
|
|
1581
2036
|
tags: ["environments"],
|
|
1582
2037
|
successDescription: "The latest logs"
|
|
1583
|
-
}).errors({
|
|
1584
|
-
NOT_FOUND: {},
|
|
1585
|
-
BAD_REQUEST: {}
|
|
1586
|
-
}).input(z.object({
|
|
2038
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1587
2039
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1588
2040
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1589
2041
|
level: z.array(z.enum([
|
|
@@ -1593,22 +2045,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1593
2045
|
"DEBUG"
|
|
1594
2046
|
])).optional().describe("Filter by log level"),
|
|
1595
2047
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1596
|
-
})).output(z.object({ logs: z.array(
|
|
1597
|
-
|
|
1598
|
-
type: z.enum([
|
|
1599
|
-
"START",
|
|
1600
|
-
"END",
|
|
1601
|
-
"INFO",
|
|
1602
|
-
"ERROR",
|
|
1603
|
-
"WARNING",
|
|
1604
|
-
"DEBUG"
|
|
1605
|
-
]),
|
|
1606
|
-
requestId: z.string(),
|
|
1607
|
-
content: z.string().optional(),
|
|
1608
|
-
method: z.string().optional(),
|
|
1609
|
-
durationInMs: z.number().optional()
|
|
1610
|
-
})) }));
|
|
1611
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
2048
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
2049
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1612
2050
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1613
2051
|
method: "GET",
|
|
1614
2052
|
summary: "Get deployment logs",
|
|
@@ -1635,22 +2073,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1635
2073
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1636
2074
|
task_count: z.array(analyticsDataPointSchema)
|
|
1637
2075
|
});
|
|
1638
|
-
const getProjectAnalyticsContractV1 =
|
|
2076
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1639
2077
|
path: "/v1/analytics/{projectId}",
|
|
1640
2078
|
method: "GET",
|
|
1641
2079
|
summary: "Get project analytics",
|
|
1642
2080
|
description: "Get analytics data for a project over a time range",
|
|
1643
2081
|
tags: ["analytics"],
|
|
1644
2082
|
successDescription: "The project analytics data"
|
|
1645
|
-
}).errors({
|
|
1646
|
-
NOT_FOUND: {},
|
|
1647
|
-
BAD_REQUEST: {}
|
|
1648
|
-
}).input(z.object({
|
|
2083
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1649
2084
|
projectId: z.string().describe("The ID of the project"),
|
|
1650
2085
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1651
2086
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1652
2087
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1653
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2088
|
+
}).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({
|
|
1654
2089
|
metadata: z.object({
|
|
1655
2090
|
startTimestamp: z.number(),
|
|
1656
2091
|
endTimestamp: z.number(),
|
|
@@ -1660,7 +2095,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1660
2095
|
}),
|
|
1661
2096
|
timeSeries: analyticsTimeSeriesSchema
|
|
1662
2097
|
}));
|
|
1663
|
-
const
|
|
2098
|
+
const paginatedInsightsInputShape = {
|
|
2099
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2100
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2101
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2102
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2103
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2104
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2105
|
+
};
|
|
2106
|
+
const listIntentsContractV1 = base.route({
|
|
2107
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2108
|
+
method: "GET",
|
|
2109
|
+
summary: "List intents",
|
|
2110
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2111
|
+
tags: ["insights"],
|
|
2112
|
+
successDescription: "The grouped user intents"
|
|
2113
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2114
|
+
...paginatedInsightsInputShape,
|
|
2115
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2116
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2117
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2118
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2119
|
+
})).output(z.object({
|
|
2120
|
+
intents: z.array(z.object({
|
|
2121
|
+
id: z.string(),
|
|
2122
|
+
intentIds: z.array(z.string()).min(1),
|
|
2123
|
+
environmentId: z.string(),
|
|
2124
|
+
message: z.string(),
|
|
2125
|
+
toolName: z.string(),
|
|
2126
|
+
createdAt: z.coerce.date(),
|
|
2127
|
+
occurrenceCount: z.number().int().positive(),
|
|
2128
|
+
clientName: z.string().nullable(),
|
|
2129
|
+
clientId: z.string().nullable(),
|
|
2130
|
+
categories: z.array(z.object({
|
|
2131
|
+
id: z.string(),
|
|
2132
|
+
name: z.string(),
|
|
2133
|
+
color: intentCategoryColorSchema
|
|
2134
|
+
}))
|
|
2135
|
+
})),
|
|
2136
|
+
totalCount: z.number().int().nonnegative()
|
|
2137
|
+
}));
|
|
2138
|
+
const listFeedbacksContractV1 = base.route({
|
|
2139
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2140
|
+
method: "GET",
|
|
2141
|
+
summary: "List feedbacks",
|
|
2142
|
+
description: "List user feedback for an environment over a time range",
|
|
2143
|
+
tags: ["insights"],
|
|
2144
|
+
successDescription: "The user feedback"
|
|
2145
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2146
|
+
...paginatedInsightsInputShape,
|
|
2147
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2148
|
+
})).output(z.object({
|
|
2149
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2150
|
+
totalCount: z.number().int().nonnegative()
|
|
2151
|
+
}));
|
|
2152
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2153
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2154
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2155
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2156
|
+
method: "GET",
|
|
2157
|
+
summary: "List intent categories",
|
|
2158
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2159
|
+
tags: ["insights"],
|
|
2160
|
+
successDescription: "The intent categories"
|
|
2161
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2162
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2163
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2164
|
+
method: "POST",
|
|
2165
|
+
summary: "Create an intent category",
|
|
2166
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2167
|
+
tags: ["insights"],
|
|
2168
|
+
successDescription: "The created intent category"
|
|
2169
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2170
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2171
|
+
name: intentCategoryNameSchema,
|
|
2172
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2173
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2174
|
+
})).output(intentCategorySchema);
|
|
2175
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2176
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2177
|
+
method: "PATCH",
|
|
2178
|
+
summary: "Update an intent category",
|
|
2179
|
+
description: "Rename or recolor an intent category",
|
|
2180
|
+
tags: ["insights"],
|
|
2181
|
+
successDescription: "The updated intent category"
|
|
2182
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2183
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2184
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2185
|
+
name: intentCategoryNameSchema.optional(),
|
|
2186
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2187
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2188
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2189
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2190
|
+
method: "DELETE",
|
|
2191
|
+
summary: "Delete an intent category",
|
|
2192
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2193
|
+
tags: ["insights"],
|
|
2194
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2195
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2196
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2197
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2198
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2199
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2200
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2201
|
+
method: "POST",
|
|
2202
|
+
summary: "Link an intent category",
|
|
2203
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2204
|
+
tags: ["insights"],
|
|
2205
|
+
successDescription: "The intents have been linked successfully"
|
|
2206
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2207
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2208
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2209
|
+
intentIds: categorizableIntentIdsSchema
|
|
2210
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2211
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2212
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2213
|
+
method: "POST",
|
|
2214
|
+
summary: "Unlink an intent category",
|
|
2215
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2216
|
+
tags: ["insights"],
|
|
2217
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2218
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2219
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2220
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2221
|
+
intentIds: categorizableIntentIdsSchema
|
|
2222
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2223
|
+
const listTeamsContractV1 = base.route({
|
|
1664
2224
|
path: "/v1/teams",
|
|
1665
2225
|
method: "GET",
|
|
1666
2226
|
summary: "List teams",
|
|
@@ -1673,7 +2233,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1673
2233
|
createdAt: z.coerce.date(),
|
|
1674
2234
|
hasStripeAccount: z.boolean()
|
|
1675
2235
|
})));
|
|
1676
|
-
const
|
|
2236
|
+
const getTeamUsageContractV1 = base.route({
|
|
2237
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2238
|
+
method: "GET",
|
|
2239
|
+
summary: "Get team usage",
|
|
2240
|
+
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.",
|
|
2241
|
+
tags: ["teams"],
|
|
2242
|
+
successDescription: "The current billing window usage"
|
|
2243
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2244
|
+
teamId: z.string(),
|
|
2245
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2246
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2247
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2248
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2249
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2250
|
+
}));
|
|
2251
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1677
2252
|
path: "/v1/tunnels/ticket",
|
|
1678
2253
|
method: "GET",
|
|
1679
2254
|
summary: "Get a tunnel ticket",
|
|
@@ -1685,16 +2260,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1685
2260
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1686
2261
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1687
2262
|
}));
|
|
1688
|
-
const publishServerContractV1 =
|
|
2263
|
+
const publishServerContractV1 = base.route({
|
|
1689
2264
|
path: "/v1/distribution/publish",
|
|
1690
2265
|
method: "POST",
|
|
1691
2266
|
summary: "Publish a server to the MCP registry",
|
|
1692
2267
|
tags: ["distribution"],
|
|
1693
2268
|
successDescription: "The server has been published successfully"
|
|
1694
|
-
}).errors({
|
|
1695
|
-
NOT_FOUND: {},
|
|
1696
|
-
BAD_REQUEST: {}
|
|
1697
|
-
}).input(z.object({
|
|
2269
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1698
2270
|
projectId: z.string(),
|
|
1699
2271
|
domain: z.string(),
|
|
1700
2272
|
title: z.string().min(1).max(100),
|
|
@@ -1703,17 +2275,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1703
2275
|
iconSrc: z.url().max(255).optional(),
|
|
1704
2276
|
dryRun: z.boolean().optional()
|
|
1705
2277
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1706
|
-
const getServerInfoContractV1 =
|
|
2278
|
+
const getServerInfoContractV1 = base.route({
|
|
1707
2279
|
path: "/v1/distribution/get",
|
|
1708
2280
|
method: "GET",
|
|
1709
2281
|
summary: "Get server info",
|
|
1710
2282
|
description: "Get info about a server",
|
|
1711
2283
|
tags: ["distribution"],
|
|
1712
2284
|
successDescription: "The server info"
|
|
1713
|
-
}).errors({
|
|
1714
|
-
NOT_FOUND: {},
|
|
1715
|
-
BAD_REQUEST: {}
|
|
1716
|
-
}).input(z.object({
|
|
2285
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1717
2286
|
projectId: z.string(),
|
|
1718
2287
|
domain: z.string()
|
|
1719
2288
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1732,7 +2301,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1732
2301
|
isPlaygroundEnabled: z.boolean(),
|
|
1733
2302
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1734
2303
|
});
|
|
1735
|
-
const getPlaygroundContractV1 =
|
|
2304
|
+
const getPlaygroundContractV1 = base.route({
|
|
1736
2305
|
path: "/v1/environments/{environmentId}/playground",
|
|
1737
2306
|
method: "GET",
|
|
1738
2307
|
summary: "Get playground configuration",
|
|
@@ -1740,17 +2309,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1740
2309
|
tags: ["environments"],
|
|
1741
2310
|
successDescription: "The playground configuration"
|
|
1742
2311
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1743
|
-
const upsertPlaygroundContractV1 =
|
|
2312
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1744
2313
|
path: "/v1/environments/{environmentId}/playground",
|
|
1745
2314
|
method: "PUT",
|
|
1746
2315
|
summary: "Update playground configuration",
|
|
1747
2316
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1748
2317
|
tags: ["environments"],
|
|
1749
2318
|
successDescription: "The updated playground configuration"
|
|
1750
|
-
}).errors({
|
|
1751
|
-
NOT_FOUND: {},
|
|
1752
|
-
BAD_REQUEST: {}
|
|
1753
|
-
}).input(z.object({
|
|
2319
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1754
2320
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1755
2321
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1756
2322
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1758,7 +2324,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1758
2324
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1759
2325
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1760
2326
|
})).output(playgroundOutputSchema);
|
|
1761
|
-
const createBeaconContractV1 =
|
|
2327
|
+
const createBeaconContractV1 = base.route({
|
|
1762
2328
|
path: "/v1/beacon/audits",
|
|
1763
2329
|
method: "POST",
|
|
1764
2330
|
summary: "Create a beacon audit",
|
|
@@ -1767,7 +2333,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1767
2333
|
successDescription: "The audit has been created"
|
|
1768
2334
|
}).errors({
|
|
1769
2335
|
NOT_FOUND: {},
|
|
1770
|
-
BAD_REQUEST: {},
|
|
1771
2336
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1772
2337
|
}).input(z.object({
|
|
1773
2338
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1775,7 +2340,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1775
2340
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1776
2341
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1777
2342
|
})).output(z.object({ id: z.string() }));
|
|
1778
|
-
const getBeaconContractV1 =
|
|
2343
|
+
const getBeaconContractV1 = base.route({
|
|
1779
2344
|
path: "/v1/beacon/audits/{auditId}",
|
|
1780
2345
|
method: "GET",
|
|
1781
2346
|
summary: "Get a beacon audit",
|
|
@@ -1791,8 +2356,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1791
2356
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1792
2357
|
}));
|
|
1793
2358
|
const contract = {
|
|
1794
|
-
teams: {
|
|
2359
|
+
teams: {
|
|
2360
|
+
list: { v1: listTeamsContractV1 },
|
|
2361
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2362
|
+
},
|
|
1795
2363
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2364
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2365
|
+
intentCategories: {
|
|
2366
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2367
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2368
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2369
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2370
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2371
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2372
|
+
},
|
|
2373
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1796
2374
|
deployments: {
|
|
1797
2375
|
list: { v1: listDeploymentsContractV1 },
|
|
1798
2376
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1802,6 +2380,7 @@ const contract = {
|
|
|
1802
2380
|
environments: {
|
|
1803
2381
|
create: { v1: createEnvironmentContractV1 },
|
|
1804
2382
|
get: { v1: getEnvironmentContractV1 },
|
|
2383
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1805
2384
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1806
2385
|
getLogs: { v1: getLogsContractV1 },
|
|
1807
2386
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1833,5 +2412,10 @@ const contract = {
|
|
|
1833
2412
|
get: { v1: getBeaconContractV1 }
|
|
1834
2413
|
}
|
|
1835
2414
|
};
|
|
2415
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2416
|
+
const contractForDocs = {
|
|
2417
|
+
...contract,
|
|
2418
|
+
deployments: deploymentsForDocs
|
|
2419
|
+
};
|
|
1836
2420
|
//#endregion
|
|
1837
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2421
|
+
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 };
|