@alpic-ai/api 0.0.0-dev.ge6b6982 → 0.0.0-dev.ge70585b
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 +1574 -75
- package/dist/index.mjs +915 -395
- 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,11 +373,21 @@ 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([
|
|
348
392
|
"ongoing",
|
|
349
393
|
"deployed",
|
|
@@ -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,15 +807,27 @@ 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(),
|
|
514
823
|
status: z.enum([
|
|
515
824
|
"ongoing",
|
|
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;
|
|
@@ -561,6 +864,10 @@ const clampStringField = (field) => {
|
|
|
561
864
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
562
865
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
563
866
|
};
|
|
867
|
+
const unboundedArrayField = (field) => {
|
|
868
|
+
const unbounded = z.array(field.element);
|
|
869
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
870
|
+
};
|
|
564
871
|
const toolDefinitionSchema = z.object({
|
|
565
872
|
name: z.string(),
|
|
566
873
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -573,17 +880,28 @@ const toolDefinitionSchema = z.object({
|
|
|
573
880
|
}).optional()
|
|
574
881
|
});
|
|
575
882
|
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."),
|
|
883
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
884
|
+
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
885
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
579
886
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
580
|
-
}).
|
|
887
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
888
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial();
|
|
889
|
+
const blankPositiveTestCase = () => ({
|
|
890
|
+
scenario: "",
|
|
891
|
+
userPrompt: "",
|
|
892
|
+
toolTriggered: "",
|
|
893
|
+
expectedOutput: ""
|
|
894
|
+
});
|
|
895
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
581
896
|
const screenshotEntrySchema = z.object({
|
|
582
897
|
prompt: z.string(),
|
|
583
|
-
url: z.url()
|
|
898
|
+
url: z.url()
|
|
584
899
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
900
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
585
901
|
/** Accepts either a valid email or URL. */
|
|
586
902
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
903
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
904
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
587
905
|
const chatgptCategorySchema = z.enum([
|
|
588
906
|
"BUSINESS",
|
|
589
907
|
"COLLABORATION",
|
|
@@ -887,20 +1205,21 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
887
1205
|
"zh-TW"
|
|
888
1206
|
]);
|
|
889
1207
|
const negativeTestCaseSchema = z.object({
|
|
890
|
-
scenario: z.string(),
|
|
891
|
-
userPrompt: z.string()
|
|
892
|
-
}).
|
|
1208
|
+
scenario: z.string().min(1),
|
|
1209
|
+
userPrompt: z.string().min(1)
|
|
1210
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1211
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial();
|
|
1212
|
+
const blankNegativeTestCase = () => ({
|
|
1213
|
+
scenario: "",
|
|
1214
|
+
userPrompt: ""
|
|
1215
|
+
});
|
|
893
1216
|
const chatgptToolJustificationSchema = z.object({
|
|
894
1217
|
toolName: z.string(),
|
|
895
1218
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
896
1219
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
897
1220
|
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.\"")
|
|
898
1221
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
899
|
-
/**
|
|
900
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
901
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
902
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
903
|
-
*/
|
|
1222
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
904
1223
|
const chatgptTaglineSchema = z.string().max(30);
|
|
905
1224
|
const chatgptDescriptionSchema = z.string();
|
|
906
1225
|
const chatgptTranslationSchema = z.object({
|
|
@@ -909,10 +1228,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
909
1228
|
description: chatgptDescriptionSchema
|
|
910
1229
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
911
1230
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
912
|
-
/**
|
|
913
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
914
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
915
|
-
*/
|
|
1231
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
916
1232
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
917
1233
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
918
1234
|
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."),
|
|
@@ -921,40 +1237,62 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
921
1237
|
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
922
1238
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
923
1239
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
924
|
-
companyUrl:
|
|
1240
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
925
1241
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
926
|
-
privacyPolicyUrl:
|
|
927
|
-
termsOfServiceUrl:
|
|
928
|
-
demoRecordingUrl:
|
|
1242
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1243
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1244
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
929
1245
|
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
|
|
930
|
-
serverUrl:
|
|
1246
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
931
1247
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
932
1248
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
933
1249
|
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."),
|
|
934
|
-
testCases: z.array(positiveTestCaseSchema).describe("
|
|
935
|
-
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."),
|
|
936
|
-
screenshots: z.array(screenshotEntrySchema).max(3).describe("In-app screenshots paired with the user prompt that produced them. 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."),
|
|
1250
|
+
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."),
|
|
1251
|
+
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."),
|
|
1252
|
+
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."),
|
|
937
1253
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
938
1254
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
939
1255
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
940
1256
|
});
|
|
941
|
-
chatgptSubmissionFormDataSchema.
|
|
1257
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1258
|
+
tagline: z.string().optional(),
|
|
1259
|
+
companyUrl: z.string().optional(),
|
|
1260
|
+
supportChannel: z.string().optional(),
|
|
1261
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1262
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1263
|
+
demoRecordingUrl: z.string().optional(),
|
|
1264
|
+
serverUrl: z.string().optional(),
|
|
1265
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1266
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1267
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1268
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1269
|
+
});
|
|
1270
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1271
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
942
1272
|
appName: true,
|
|
943
1273
|
developerName: true,
|
|
944
1274
|
serverUrl: true,
|
|
945
1275
|
tools: true,
|
|
946
1276
|
authentication: true
|
|
947
1277
|
});
|
|
948
|
-
|
|
1278
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1279
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
949
1280
|
tagline: true,
|
|
950
1281
|
description: true,
|
|
951
1282
|
category: true,
|
|
952
1283
|
testCases: true,
|
|
953
1284
|
negativeTestCases: true,
|
|
954
1285
|
toolJustifications: true
|
|
955
|
-
}).extend({
|
|
1286
|
+
}).extend({
|
|
1287
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1288
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1289
|
+
}).extend({
|
|
1290
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1291
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1292
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1293
|
+
});
|
|
956
1294
|
const claudeCategorySchema = z.enum([
|
|
957
|
-
"
|
|
1295
|
+
"Productivity",
|
|
958
1296
|
"Communication",
|
|
959
1297
|
"Data & Analytics",
|
|
960
1298
|
"Development tools",
|
|
@@ -962,222 +1300,220 @@ const claudeCategorySchema = z.enum([
|
|
|
962
1300
|
"Consumer Health",
|
|
963
1301
|
"Health & Life Sciences",
|
|
964
1302
|
"Media & Entertainment",
|
|
965
|
-
"Commerce & Shopping"
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
"
|
|
969
|
-
"
|
|
970
|
-
"
|
|
1303
|
+
"Commerce & Shopping",
|
|
1304
|
+
"Legal",
|
|
1305
|
+
"Sales and marketing",
|
|
1306
|
+
"Creative",
|
|
1307
|
+
"Nonprofit",
|
|
1308
|
+
"Education",
|
|
1309
|
+
"Other"
|
|
971
1310
|
]);
|
|
972
|
-
const
|
|
973
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1311
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
974
1312
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
975
|
-
"
|
|
976
|
-
"
|
|
977
|
-
"
|
|
1313
|
+
"read_only",
|
|
1314
|
+
"write_only",
|
|
1315
|
+
"read_write"
|
|
978
1316
|
]);
|
|
979
|
-
const
|
|
980
|
-
|
|
981
|
-
"
|
|
982
|
-
"
|
|
983
|
-
"
|
|
984
|
-
"
|
|
985
|
-
]);
|
|
986
|
-
const claudeThirdPartySchema = z.enum([
|
|
987
|
-
"Web access: Fetches information from the open web (e.g., web scraping, search engines, or browsing arbitrary URLs, not just connecting to a specific API)",
|
|
988
|
-
"Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
|
|
989
|
-
"Third-party data retrieval: Connects to external services that themselves retrieve data from other sources (e.g., workflow automation platforms or other services that aggregate or relay data from multiple third-party sources)",
|
|
990
|
-
"Third-party data modification: Can connect to external services that themselves create, update, or delete data in other sources (e.g., workflow automation platforms or other services that write to multiple third-party sources)",
|
|
991
|
-
"N/A"
|
|
1317
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1318
|
+
"oauth_dcr",
|
|
1319
|
+
"oauth_cimd",
|
|
1320
|
+
"oauth_anthropic_creds",
|
|
1321
|
+
"custom_connection",
|
|
1322
|
+
"none"
|
|
992
1323
|
]);
|
|
993
|
-
const
|
|
994
|
-
"
|
|
995
|
-
"
|
|
996
|
-
"
|
|
997
|
-
"GDPR compliant (if applicable)"
|
|
1324
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1325
|
+
"first_party",
|
|
1326
|
+
"proxied",
|
|
1327
|
+
"third_party"
|
|
998
1328
|
]);
|
|
999
|
-
const
|
|
1000
|
-
|
|
1001
|
-
"
|
|
1002
|
-
"
|
|
1329
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1330
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1331
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1332
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1333
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1334
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1335
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1336
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1337
|
+
"Public documentation for this connector will be live by the publish date."
|
|
1003
1338
|
]);
|
|
1004
|
-
/**
|
|
1005
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
1006
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
1007
|
-
*/
|
|
1339
|
+
/** 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
1340
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
(
|
|
1019
|
-
|
|
1020
|
-
(
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
•
|
|
1038
|
-
•
|
|
1039
|
-
•
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
• '
|
|
1055
|
-
• '
|
|
1056
|
-
• '
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
• 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
|
|
1087
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
1088
|
-
serverDocumentationLink: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. This is displayed in the Directory listing and must be publicly accessible without login. Minimum requirements for the docs page:
|
|
1089
|
-
• What the connector does and its key capabilities
|
|
1090
|
-
• How to connect/set it up (step by step)
|
|
1091
|
-
• What each tool does (or at least the main ones)
|
|
1092
|
-
• How to troubleshoot common issues
|
|
1093
|
-
• A support contact or channel
|
|
1094
|
-
Acceptable formats: a dedicated docs page, a help center article, a README on GitHub, or a blog post — as long as it's comprehensive. Note: Anthropic requires public documentation to be live by your publish date.`),
|
|
1095
|
-
privacyPolicyUrl: z.url().describe(`URL to your privacy policy. This is mandatory and displayed in the directory listing. Missing or incomplete privacy policies result in immediate rejection. Your privacy policy must cover:
|
|
1096
|
-
• What data you collect (and how)
|
|
1097
|
-
• How you use the collected data
|
|
1098
|
-
• Where and how long you store it
|
|
1099
|
-
• Whether you share data with third parties (and who)
|
|
1100
|
-
• How users can contact you about data concerns
|
|
1101
|
-
The policy must be publicly accessible. If you don't have one yet, create one before submitting — there are free generators online, but make sure it accurately reflects your actual practices. If you're GDPR-compliant, your policy should reflect that.`),
|
|
1102
|
-
supportChannel: supportChannelSchema.describe(`A URL or email address where users can get help with your connector. This is displayed in the Directory listing. Acceptable options:
|
|
1103
|
-
• Email address (e.g. support@myapp.com)
|
|
1104
|
-
• Link to a GitHub Issues page
|
|
1105
|
-
• Link to a help center or support article
|
|
1106
|
-
• Link to a Discord/Slack community
|
|
1107
|
-
• Link to your documentation's troubleshooting section
|
|
1108
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1109
|
-
testingCredentials: z.string().describe(`Provide login credentials for a test account that Anthropic reviewers can use to verify your server works end-to-end. Critical requirements:
|
|
1110
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
1111
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
1112
|
-
• If your service uses Google OAuth or another OAuth that requires email verification, use mcp-review@anthropic.com as the account email — Anthropic has access to this inbox.
|
|
1113
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
1114
|
-
• If your service requires API keys instead of a password, provide those.
|
|
1115
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
1116
|
-
tools: z.array(toolDefinitionSchema).describe(`A comma-separated list of all tools your MCP server exposes. Use the format: tool_name (Human-Readable Name). The tool_name is the internal identifier (snake_case, max 64 characters). The Human-Readable Name is what users see.
|
|
1117
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
1118
|
-
Reviewers test every single tool you list here — don't list tools that don't work. Also: do not have a single catch-all tool like api_request(method, endpoint) — Anthropic rejects these. Each action should be its own purpose-built tool.`),
|
|
1119
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
1120
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
1121
|
-
• 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
|
|
1122
|
-
This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
|
|
1123
|
-
testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
|
|
1124
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
1125
|
-
• Format: SVG only
|
|
1126
|
-
• Aspect ratio: square (1:1)
|
|
1127
|
-
• Should work on a light background
|
|
1128
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
1129
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
1130
|
-
logoDark: z.string().optional().describe(`Optional dark-mode variant of the connector logo. Same specs as the light variant (SVG, square 1:1) but designed to read on a dark background. Leave empty if the light logo already works on dark.`),
|
|
1131
|
-
screenshots: z.array(screenshotEntrySchema).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
|
|
1132
|
-
• 3–5 images is ideal
|
|
1133
|
-
• Minimum 1000px width, PNG format preferred
|
|
1134
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
1135
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
1136
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
1137
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
1138
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1139
|
-
});
|
|
1140
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1141
|
-
companyName: true,
|
|
1142
|
-
appName: true,
|
|
1143
|
-
mcpUrlType: true,
|
|
1341
|
+
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
|
|
1342
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1343
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1344
|
+
name: z.string().max(100).describe(`The public display name for your connector as it appears in the directory. Use your brand/product name. You must
|
|
1345
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1346
|
+
slug: z.string().max(50).regex(/^[a-z0-9-]+$/).describe(`URL-safe identifier for your connector's directory page. Lowercase letters, numbers, and hyphens only.
|
|
1347
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1348
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1349
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1350
|
+
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
|
|
1351
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1352
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1353
|
+
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
|
|
1354
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1355
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1356
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1357
|
+
by your publish date.`),
|
|
1358
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1359
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1360
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1361
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1362
|
+
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
|
|
1363
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1364
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1365
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1366
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1367
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1368
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1369
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1370
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1371
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1372
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1373
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1374
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1375
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1376
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1377
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1378
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1379
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1380
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1381
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1382
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1383
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1384
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1385
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1386
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1387
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1388
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1389
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1390
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1391
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1392
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1393
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1394
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1395
|
+
fully populated account.`),
|
|
1396
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1397
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1398
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1399
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1400
|
+
});
|
|
1401
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1402
|
+
serverUrl: z.string().optional(),
|
|
1403
|
+
name: z.string().optional(),
|
|
1404
|
+
slug: z.string().optional(),
|
|
1405
|
+
oneLiner: z.string().optional(),
|
|
1406
|
+
description: z.string().optional(),
|
|
1407
|
+
iconUrl: z.string().optional(),
|
|
1408
|
+
documentation: z.string().optional(),
|
|
1409
|
+
support: z.string().optional(),
|
|
1410
|
+
privacyPolicy: z.string().optional(),
|
|
1411
|
+
companyWebsite: z.string().optional(),
|
|
1412
|
+
primaryContactEmail: z.string().optional(),
|
|
1413
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1414
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1415
|
+
});
|
|
1416
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1417
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1144
1418
|
serverUrl: true,
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
transportSupport: true,
|
|
1419
|
+
name: true,
|
|
1420
|
+
slug: true,
|
|
1421
|
+
companyName: true,
|
|
1149
1422
|
primaryContactEmail: true,
|
|
1150
1423
|
primaryContactName: true,
|
|
1424
|
+
readWriteCapabilities: true,
|
|
1151
1425
|
authentication: true,
|
|
1152
|
-
|
|
1153
|
-
|
|
1426
|
+
apiOwnership: true,
|
|
1427
|
+
personalHealthData: true
|
|
1154
1428
|
}).extend({
|
|
1155
1429
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1156
|
-
|
|
1430
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1431
|
+
});
|
|
1432
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1433
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1434
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1435
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1436
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1437
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1438
|
+
});
|
|
1439
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1440
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1441
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1442
|
+
});
|
|
1443
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1444
|
+
const byField = {};
|
|
1445
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1446
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1447
|
+
return byField;
|
|
1448
|
+
}
|
|
1449
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1450
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1451
|
+
"pass",
|
|
1452
|
+
"fail",
|
|
1453
|
+
"unverified"
|
|
1454
|
+
]);
|
|
1455
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1456
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1457
|
+
claudeai: ["privacyPolicy"]
|
|
1458
|
+
};
|
|
1459
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1460
|
+
const policyDisclosureSchema = z.enum([
|
|
1461
|
+
"dataCategories",
|
|
1462
|
+
"purposesOfUse",
|
|
1463
|
+
"recipients",
|
|
1464
|
+
"retention"
|
|
1465
|
+
]);
|
|
1466
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1467
|
+
field: verifiableUrlFieldSchema,
|
|
1468
|
+
url: z.string(),
|
|
1469
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1470
|
+
reason: z.string(),
|
|
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.")
|
|
1157
1491
|
});
|
|
1158
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1159
|
-
tagline: true,
|
|
1160
|
-
description: true,
|
|
1161
|
-
category: true,
|
|
1162
|
-
testCases: true
|
|
1163
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1164
1492
|
const submissionMetaFieldsSchema = z.object({
|
|
1165
1493
|
id: z.string(),
|
|
1166
1494
|
environmentId: z.string(),
|
|
1167
1495
|
auditId: z.string().nullable(),
|
|
1496
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1168
1497
|
createdAt: z.coerce.date(),
|
|
1169
1498
|
updatedAt: z.coerce.date()
|
|
1170
1499
|
});
|
|
1171
1500
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1172
1501
|
platform: z.literal("claudeai"),
|
|
1173
|
-
formData:
|
|
1502
|
+
formData: claudeSubmissionDraftSchema,
|
|
1503
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1174
1504
|
});
|
|
1175
1505
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1176
1506
|
platform: z.literal("chatgpt"),
|
|
1177
|
-
formData:
|
|
1507
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1508
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1178
1509
|
});
|
|
1179
1510
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1180
|
-
z.union([
|
|
1511
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1512
|
+
z.literal([
|
|
1513
|
+
100,
|
|
1514
|
+
75,
|
|
1515
|
+
50
|
|
1516
|
+
]);
|
|
1181
1517
|
const subscriptionPlanSchema = z.enum([
|
|
1182
1518
|
"pro",
|
|
1183
1519
|
"business",
|
|
@@ -1189,17 +1525,70 @@ const customerCreditsSchema = z.object({
|
|
|
1189
1525
|
expiresAt: z.number().nullable(),
|
|
1190
1526
|
currency: z.string()
|
|
1191
1527
|
});
|
|
1192
|
-
const customerUsageSchema = z.object({
|
|
1193
|
-
amountInCents: z.number(),
|
|
1194
|
-
currency: z.string(),
|
|
1195
|
-
periodEnd: z.number()
|
|
1196
|
-
});
|
|
1197
1528
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1198
1529
|
z.object({
|
|
1199
1530
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1200
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1201
1531
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1202
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
|
+
});
|
|
1203
1592
|
//#endregion
|
|
1204
1593
|
//#region src/auth-scope.ts
|
|
1205
1594
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1242,7 +1631,10 @@ const RESERVED_KEYS = [
|
|
|
1242
1631
|
"BUILD_ARG_START_COMMAND",
|
|
1243
1632
|
"ALPIC_HOST",
|
|
1244
1633
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1245
|
-
"ALPIC_INTENT_META_KEY"
|
|
1634
|
+
"ALPIC_INTENT_META_KEY",
|
|
1635
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1636
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1637
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1246
1638
|
];
|
|
1247
1639
|
const environmentVariableSchema = z.object({
|
|
1248
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"),
|
|
@@ -1295,6 +1687,14 @@ const serverFieldsSchema = z.object({
|
|
|
1295
1687
|
});
|
|
1296
1688
|
//#endregion
|
|
1297
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
|
+
};
|
|
1298
1698
|
const deploymentStatusSchema = z.enum([
|
|
1299
1699
|
"ongoing",
|
|
1300
1700
|
"deployed",
|
|
@@ -1323,21 +1723,20 @@ const deploymentSchema = z.object({
|
|
|
1323
1723
|
isCurrent: z.boolean(),
|
|
1324
1724
|
deploymentPageUrl: z.url().nullable()
|
|
1325
1725
|
});
|
|
1326
|
-
const
|
|
1726
|
+
const isValidTimeInput = (value) => {
|
|
1327
1727
|
if (ms(value) !== void 0) return true;
|
|
1328
1728
|
return !Number.isNaN(new Date(value).getTime());
|
|
1329
1729
|
};
|
|
1330
|
-
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({
|
|
1331
1733
|
path: "/v1/environments",
|
|
1332
1734
|
method: "POST",
|
|
1333
1735
|
summary: "Create an environment",
|
|
1334
1736
|
description: "Create an environment for a project",
|
|
1335
1737
|
tags: ["environments"],
|
|
1336
1738
|
successDescription: "The environment has been created successfully"
|
|
1337
|
-
}).errors({
|
|
1338
|
-
NOT_FOUND: {},
|
|
1339
|
-
BAD_REQUEST: {}
|
|
1340
|
-
}).input(z.object({
|
|
1739
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1341
1740
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1342
1741
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1343
1742
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1350,7 +1749,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1350
1749
|
createdAt: z.coerce.date(),
|
|
1351
1750
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1352
1751
|
}));
|
|
1353
|
-
const getEnvironmentContractV1 =
|
|
1752
|
+
const getEnvironmentContractV1 = base.route({
|
|
1354
1753
|
path: "/v1/environments/{environmentId}",
|
|
1355
1754
|
method: "GET",
|
|
1356
1755
|
summary: "Get an environment",
|
|
@@ -1366,6 +1765,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1366
1765
|
createdAt: z.coerce.date(),
|
|
1367
1766
|
projectId: z.string()
|
|
1368
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) }));
|
|
1369
1776
|
const domainSchema = z.object({
|
|
1370
1777
|
domain: z.string(),
|
|
1371
1778
|
status: z.enum([
|
|
@@ -1407,7 +1814,7 @@ const projectOutputSchema = z.object({
|
|
|
1407
1814
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1408
1815
|
environments: z.array(environmentSchema)
|
|
1409
1816
|
});
|
|
1410
|
-
const getProjectContractV1 =
|
|
1817
|
+
const getProjectContractV1 = base.route({
|
|
1411
1818
|
path: "/v1/projects/{projectId}",
|
|
1412
1819
|
method: "GET",
|
|
1413
1820
|
summary: "Get a project",
|
|
@@ -1415,18 +1822,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1415
1822
|
tags: ["projects"],
|
|
1416
1823
|
successDescription: "The project details"
|
|
1417
1824
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1418
|
-
const listProjectsContractV1 =
|
|
1825
|
+
const listProjectsContractV1 = base.route({
|
|
1419
1826
|
path: "/v1/projects",
|
|
1420
1827
|
method: "GET",
|
|
1421
1828
|
summary: "List projects",
|
|
1422
1829
|
description: "List all projects for a team",
|
|
1423
1830
|
tags: ["projects"],
|
|
1424
1831
|
successDescription: "The list of projects"
|
|
1425
|
-
}).errors({
|
|
1426
|
-
|
|
1427
|
-
BAD_REQUEST: {}
|
|
1428
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1429
|
-
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({
|
|
1430
1834
|
path: "/v1/projects",
|
|
1431
1835
|
method: "POST",
|
|
1432
1836
|
summary: "Create a project",
|
|
@@ -1435,7 +1839,7 @@ const createProjectContractV1 = oc.route({
|
|
|
1435
1839
|
successDescription: "The project has been created successfully"
|
|
1436
1840
|
}).errors({
|
|
1437
1841
|
NOT_FOUND: {},
|
|
1438
|
-
|
|
1842
|
+
FORBIDDEN: {}
|
|
1439
1843
|
}).input(z.object({
|
|
1440
1844
|
teamId: z.string().optional(),
|
|
1441
1845
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1475,7 +1879,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1475
1879
|
isSecret: z.boolean(),
|
|
1476
1880
|
createdAt: z.coerce.date()
|
|
1477
1881
|
});
|
|
1478
|
-
const listEnvironmentVariablesContractV1 =
|
|
1882
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1479
1883
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1480
1884
|
method: "GET",
|
|
1481
1885
|
summary: "List environment variables",
|
|
@@ -1483,48 +1887,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1483
1887
|
tags: ["environments"],
|
|
1484
1888
|
successDescription: "The list of environment variables"
|
|
1485
1889
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1486
|
-
const createEnvironmentVariablesContractV1 =
|
|
1890
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1487
1891
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1488
1892
|
method: "POST",
|
|
1489
1893
|
summary: "Add environment variables",
|
|
1490
1894
|
description: "Add one or more environment variables to an environment",
|
|
1491
1895
|
tags: ["environments"],
|
|
1492
1896
|
successDescription: "The environment variables have been added successfully"
|
|
1493
|
-
}).errors({
|
|
1494
|
-
NOT_FOUND: {},
|
|
1495
|
-
BAD_REQUEST: {}
|
|
1496
|
-
}).input(z.object({
|
|
1897
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1497
1898
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1498
1899
|
environmentVariables: environmentVariablesSchema
|
|
1499
1900
|
})).output(z.object({ success: z.literal(true) }));
|
|
1500
|
-
const updateEnvironmentVariableContractV1 =
|
|
1901
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1501
1902
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1502
1903
|
method: "PATCH",
|
|
1503
1904
|
summary: "Update an environment variable",
|
|
1504
1905
|
description: "Update an environment variable by ID",
|
|
1505
1906
|
tags: ["environments"],
|
|
1506
1907
|
successDescription: "The environment variable has been updated successfully"
|
|
1507
|
-
}).errors({
|
|
1508
|
-
NOT_FOUND: {},
|
|
1509
|
-
BAD_REQUEST: {}
|
|
1510
|
-
}).input(z.object({
|
|
1908
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1511
1909
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1512
1910
|
key: environmentVariableSchema.shape.key,
|
|
1513
1911
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1514
1912
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1515
1913
|
})).output(z.object({ success: z.literal(true) }));
|
|
1516
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1914
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1517
1915
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1518
1916
|
method: "DELETE",
|
|
1519
1917
|
summary: "Delete an environment variable",
|
|
1520
1918
|
description: "Delete an environment variable by ID",
|
|
1521
1919
|
tags: ["environments"],
|
|
1522
1920
|
successDescription: "The environment variable has been deleted successfully"
|
|
1523
|
-
}).errors({
|
|
1524
|
-
|
|
1525
|
-
BAD_REQUEST: {}
|
|
1526
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1527
|
-
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({
|
|
1528
1923
|
path: "/v1/projects/{projectId}",
|
|
1529
1924
|
method: "DELETE",
|
|
1530
1925
|
summary: "Delete a project",
|
|
@@ -1532,7 +1927,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1532
1927
|
tags: ["projects"],
|
|
1533
1928
|
successDescription: "The project has been deleted successfully"
|
|
1534
1929
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1535
|
-
const updateProjectContractV1 =
|
|
1930
|
+
const updateProjectContractV1 = base.route({
|
|
1536
1931
|
path: "/v1/projects/{projectId}",
|
|
1537
1932
|
method: "PATCH",
|
|
1538
1933
|
summary: "Update a project",
|
|
@@ -1541,13 +1936,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1541
1936
|
successDescription: "The project has been updated successfully"
|
|
1542
1937
|
}).errors({
|
|
1543
1938
|
NOT_FOUND: {},
|
|
1544
|
-
|
|
1939
|
+
FORBIDDEN: {}
|
|
1545
1940
|
}).input(z.object({
|
|
1546
1941
|
projectId: z.string().describe("The ID of the project"),
|
|
1547
1942
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1548
1943
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1549
1944
|
})).output(projectOutputSchema);
|
|
1550
|
-
const deployEnvironmentContractV1 =
|
|
1945
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1551
1946
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1552
1947
|
method: "POST",
|
|
1553
1948
|
summary: "Deploy an environment",
|
|
@@ -1556,27 +1951,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1556
1951
|
successDescription: "The environment has been deployed successfully"
|
|
1557
1952
|
}).errors({
|
|
1558
1953
|
NOT_FOUND: {},
|
|
1559
|
-
|
|
1954
|
+
CONFLICT: {}
|
|
1560
1955
|
}).input(z.object({
|
|
1561
1956
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1562
|
-
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.")
|
|
1563
1959
|
})).output(deploymentSchema);
|
|
1564
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1960
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1565
1961
|
path: "/v1/deployments/upload",
|
|
1566
1962
|
method: "POST",
|
|
1567
1963
|
summary: "Upload deployment artifacts",
|
|
1568
1964
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1569
1965
|
tags: ["deployments"],
|
|
1570
1966
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1571
|
-
}).errors({
|
|
1572
|
-
NOT_FOUND: {},
|
|
1573
|
-
BAD_REQUEST: {}
|
|
1574
|
-
}).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({
|
|
1575
1968
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1576
1969
|
token: z.string().describe("Token to identify the source archive"),
|
|
1577
1970
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1578
1971
|
}));
|
|
1579
|
-
const listDeploymentsContractV1 =
|
|
1972
|
+
const listDeploymentsContractV1 = base.route({
|
|
1580
1973
|
path: "/v1/projects/{projectId}/deployments",
|
|
1581
1974
|
method: "GET",
|
|
1582
1975
|
summary: "List project deployments",
|
|
@@ -1588,7 +1981,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1588
1981
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1589
1982
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1590
1983
|
})).output(z.array(deploymentSchema));
|
|
1591
|
-
const getDeploymentContractV1 =
|
|
1984
|
+
const getDeploymentContractV1 = base.route({
|
|
1592
1985
|
path: "/v1/deployments/{deploymentId}",
|
|
1593
1986
|
method: "GET",
|
|
1594
1987
|
summary: "Get a deployment",
|
|
@@ -1596,20 +1989,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1596
1989
|
tags: ["deployments"],
|
|
1597
1990
|
successDescription: "The deployment details"
|
|
1598
1991
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1599
|
-
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({
|
|
1600
2008
|
path: "/v1/environments/{environmentId}/logs",
|
|
1601
2009
|
method: "GET",
|
|
1602
2010
|
summary: "Get logs",
|
|
1603
2011
|
description: "Get logs for an environment",
|
|
1604
2012
|
tags: ["environments"],
|
|
1605
2013
|
successDescription: "The logs"
|
|
1606
|
-
}).errors({
|
|
1607
|
-
NOT_FOUND: {},
|
|
1608
|
-
BAD_REQUEST: {}
|
|
1609
|
-
}).input(z.object({
|
|
2014
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1610
2015
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1611
|
-
since:
|
|
1612
|
-
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"),
|
|
1613
2018
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1614
2019
|
level: z.array(z.enum([
|
|
1615
2020
|
"INFO",
|
|
@@ -1620,34 +2025,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1620
2025
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1621
2026
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1622
2027
|
})).output(z.object({
|
|
1623
|
-
logs: z.array(
|
|
1624
|
-
timestamp: z.coerce.date(),
|
|
1625
|
-
type: z.enum([
|
|
1626
|
-
"START",
|
|
1627
|
-
"END",
|
|
1628
|
-
"INFO",
|
|
1629
|
-
"ERROR",
|
|
1630
|
-
"WARNING",
|
|
1631
|
-
"DEBUG"
|
|
1632
|
-
]),
|
|
1633
|
-
requestId: z.string(),
|
|
1634
|
-
content: z.string().optional(),
|
|
1635
|
-
method: z.string().optional(),
|
|
1636
|
-
durationInMs: z.number().optional()
|
|
1637
|
-
})),
|
|
2028
|
+
logs: z.array(logEntrySchema),
|
|
1638
2029
|
nextToken: z.string().nullable()
|
|
1639
2030
|
}));
|
|
1640
|
-
const getLatestLogsContractV1 =
|
|
2031
|
+
const getLatestLogsContractV1 = base.route({
|
|
1641
2032
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1642
2033
|
method: "GET",
|
|
1643
2034
|
summary: "Get latest logs",
|
|
1644
2035
|
description: "Get the N most recent logs for an environment",
|
|
1645
2036
|
tags: ["environments"],
|
|
1646
2037
|
successDescription: "The latest logs"
|
|
1647
|
-
}).errors({
|
|
1648
|
-
NOT_FOUND: {},
|
|
1649
|
-
BAD_REQUEST: {}
|
|
1650
|
-
}).input(z.object({
|
|
2038
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1651
2039
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1652
2040
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1653
2041
|
level: z.array(z.enum([
|
|
@@ -1657,22 +2045,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1657
2045
|
"DEBUG"
|
|
1658
2046
|
])).optional().describe("Filter by log level"),
|
|
1659
2047
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1660
|
-
})).output(z.object({ logs: z.array(
|
|
1661
|
-
|
|
1662
|
-
type: z.enum([
|
|
1663
|
-
"START",
|
|
1664
|
-
"END",
|
|
1665
|
-
"INFO",
|
|
1666
|
-
"ERROR",
|
|
1667
|
-
"WARNING",
|
|
1668
|
-
"DEBUG"
|
|
1669
|
-
]),
|
|
1670
|
-
requestId: z.string(),
|
|
1671
|
-
content: z.string().optional(),
|
|
1672
|
-
method: z.string().optional(),
|
|
1673
|
-
durationInMs: z.number().optional()
|
|
1674
|
-
})) }));
|
|
1675
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
2048
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
2049
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1676
2050
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1677
2051
|
method: "GET",
|
|
1678
2052
|
summary: "Get deployment logs",
|
|
@@ -1699,22 +2073,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1699
2073
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1700
2074
|
task_count: z.array(analyticsDataPointSchema)
|
|
1701
2075
|
});
|
|
1702
|
-
const getProjectAnalyticsContractV1 =
|
|
2076
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1703
2077
|
path: "/v1/analytics/{projectId}",
|
|
1704
2078
|
method: "GET",
|
|
1705
2079
|
summary: "Get project analytics",
|
|
1706
2080
|
description: "Get analytics data for a project over a time range",
|
|
1707
2081
|
tags: ["analytics"],
|
|
1708
2082
|
successDescription: "The project analytics data"
|
|
1709
|
-
}).errors({
|
|
1710
|
-
NOT_FOUND: {},
|
|
1711
|
-
BAD_REQUEST: {}
|
|
1712
|
-
}).input(z.object({
|
|
2083
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1713
2084
|
projectId: z.string().describe("The ID of the project"),
|
|
1714
2085
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1715
2086
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1716
2087
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1717
|
-
}).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({
|
|
1718
2089
|
metadata: z.object({
|
|
1719
2090
|
startTimestamp: z.number(),
|
|
1720
2091
|
endTimestamp: z.number(),
|
|
@@ -1724,7 +2095,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1724
2095
|
}),
|
|
1725
2096
|
timeSeries: analyticsTimeSeriesSchema
|
|
1726
2097
|
}));
|
|
1727
|
-
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({
|
|
1728
2224
|
path: "/v1/teams",
|
|
1729
2225
|
method: "GET",
|
|
1730
2226
|
summary: "List teams",
|
|
@@ -1737,7 +2233,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1737
2233
|
createdAt: z.coerce.date(),
|
|
1738
2234
|
hasStripeAccount: z.boolean()
|
|
1739
2235
|
})));
|
|
1740
|
-
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({
|
|
1741
2252
|
path: "/v1/tunnels/ticket",
|
|
1742
2253
|
method: "GET",
|
|
1743
2254
|
summary: "Get a tunnel ticket",
|
|
@@ -1749,16 +2260,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1749
2260
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1750
2261
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1751
2262
|
}));
|
|
1752
|
-
const publishServerContractV1 =
|
|
2263
|
+
const publishServerContractV1 = base.route({
|
|
1753
2264
|
path: "/v1/distribution/publish",
|
|
1754
2265
|
method: "POST",
|
|
1755
2266
|
summary: "Publish a server to the MCP registry",
|
|
1756
2267
|
tags: ["distribution"],
|
|
1757
2268
|
successDescription: "The server has been published successfully"
|
|
1758
|
-
}).errors({
|
|
1759
|
-
NOT_FOUND: {},
|
|
1760
|
-
BAD_REQUEST: {}
|
|
1761
|
-
}).input(z.object({
|
|
2269
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1762
2270
|
projectId: z.string(),
|
|
1763
2271
|
domain: z.string(),
|
|
1764
2272
|
title: z.string().min(1).max(100),
|
|
@@ -1767,17 +2275,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1767
2275
|
iconSrc: z.url().max(255).optional(),
|
|
1768
2276
|
dryRun: z.boolean().optional()
|
|
1769
2277
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1770
|
-
const getServerInfoContractV1 =
|
|
2278
|
+
const getServerInfoContractV1 = base.route({
|
|
1771
2279
|
path: "/v1/distribution/get",
|
|
1772
2280
|
method: "GET",
|
|
1773
2281
|
summary: "Get server info",
|
|
1774
2282
|
description: "Get info about a server",
|
|
1775
2283
|
tags: ["distribution"],
|
|
1776
2284
|
successDescription: "The server info"
|
|
1777
|
-
}).errors({
|
|
1778
|
-
NOT_FOUND: {},
|
|
1779
|
-
BAD_REQUEST: {}
|
|
1780
|
-
}).input(z.object({
|
|
2285
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1781
2286
|
projectId: z.string(),
|
|
1782
2287
|
domain: z.string()
|
|
1783
2288
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1796,7 +2301,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1796
2301
|
isPlaygroundEnabled: z.boolean(),
|
|
1797
2302
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1798
2303
|
});
|
|
1799
|
-
const getPlaygroundContractV1 =
|
|
2304
|
+
const getPlaygroundContractV1 = base.route({
|
|
1800
2305
|
path: "/v1/environments/{environmentId}/playground",
|
|
1801
2306
|
method: "GET",
|
|
1802
2307
|
summary: "Get playground configuration",
|
|
@@ -1804,17 +2309,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1804
2309
|
tags: ["environments"],
|
|
1805
2310
|
successDescription: "The playground configuration"
|
|
1806
2311
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1807
|
-
const upsertPlaygroundContractV1 =
|
|
2312
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1808
2313
|
path: "/v1/environments/{environmentId}/playground",
|
|
1809
2314
|
method: "PUT",
|
|
1810
2315
|
summary: "Update playground configuration",
|
|
1811
2316
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1812
2317
|
tags: ["environments"],
|
|
1813
2318
|
successDescription: "The updated playground configuration"
|
|
1814
|
-
}).errors({
|
|
1815
|
-
NOT_FOUND: {},
|
|
1816
|
-
BAD_REQUEST: {}
|
|
1817
|
-
}).input(z.object({
|
|
2319
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1818
2320
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1819
2321
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1820
2322
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1822,7 +2324,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1822
2324
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1823
2325
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1824
2326
|
})).output(playgroundOutputSchema);
|
|
1825
|
-
const createBeaconContractV1 =
|
|
2327
|
+
const createBeaconContractV1 = base.route({
|
|
1826
2328
|
path: "/v1/beacon/audits",
|
|
1827
2329
|
method: "POST",
|
|
1828
2330
|
summary: "Create a beacon audit",
|
|
@@ -1831,7 +2333,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1831
2333
|
successDescription: "The audit has been created"
|
|
1832
2334
|
}).errors({
|
|
1833
2335
|
NOT_FOUND: {},
|
|
1834
|
-
BAD_REQUEST: {},
|
|
1835
2336
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1836
2337
|
}).input(z.object({
|
|
1837
2338
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1839,7 +2340,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1839
2340
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1840
2341
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1841
2342
|
})).output(z.object({ id: z.string() }));
|
|
1842
|
-
const getBeaconContractV1 =
|
|
2343
|
+
const getBeaconContractV1 = base.route({
|
|
1843
2344
|
path: "/v1/beacon/audits/{auditId}",
|
|
1844
2345
|
method: "GET",
|
|
1845
2346
|
summary: "Get a beacon audit",
|
|
@@ -1855,8 +2356,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1855
2356
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1856
2357
|
}));
|
|
1857
2358
|
const contract = {
|
|
1858
|
-
teams: {
|
|
2359
|
+
teams: {
|
|
2360
|
+
list: { v1: listTeamsContractV1 },
|
|
2361
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2362
|
+
},
|
|
1859
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 } },
|
|
1860
2374
|
deployments: {
|
|
1861
2375
|
list: { v1: listDeploymentsContractV1 },
|
|
1862
2376
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1866,6 +2380,7 @@ const contract = {
|
|
|
1866
2380
|
environments: {
|
|
1867
2381
|
create: { v1: createEnvironmentContractV1 },
|
|
1868
2382
|
get: { v1: getEnvironmentContractV1 },
|
|
2383
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1869
2384
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1870
2385
|
getLogs: { v1: getLogsContractV1 },
|
|
1871
2386
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1897,5 +2412,10 @@ const contract = {
|
|
|
1897
2412
|
get: { v1: getBeaconContractV1 }
|
|
1898
2413
|
}
|
|
1899
2414
|
};
|
|
2415
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2416
|
+
const contractForDocs = {
|
|
2417
|
+
...contract,
|
|
2418
|
+
deployments: deploymentsForDocs
|
|
2419
|
+
};
|
|
1900
2420
|
//#endregion
|
|
1901
|
-
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 };
|