@alpic-ai/api 0.0.0-staging.g7728bfe → 0.0.0-staging.g77c22eb
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 +1586 -77
- package/dist/index.mjs +886 -403
- 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),
|
|
@@ -370,11 +415,20 @@ const environmentSchema$1 = z.object({
|
|
|
370
415
|
});
|
|
371
416
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
372
417
|
z.object({
|
|
418
|
+
sessionReplayEnabled: z.boolean(),
|
|
419
|
+
collectRequestPayload: z.boolean(),
|
|
420
|
+
collectResponsePayload: z.boolean(),
|
|
421
|
+
collectErrorMessage: z.boolean(),
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
424
|
+
});
|
|
425
|
+
const feedbackSchema = z.object({
|
|
373
426
|
id: z.string(),
|
|
374
427
|
createdAt: z.coerce.date(),
|
|
375
428
|
environmentId: z.string(),
|
|
376
429
|
content: z.string(),
|
|
377
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
378
432
|
});
|
|
379
433
|
z.object({
|
|
380
434
|
content: z.string(),
|
|
@@ -390,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
390
444
|
"pink",
|
|
391
445
|
"gray"
|
|
392
446
|
]);
|
|
393
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
394
448
|
const intentCategorySchema = z.object({
|
|
395
449
|
id: z.string(),
|
|
396
450
|
createdAt: z.coerce.date(),
|
|
@@ -398,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
398
452
|
name: z.string(),
|
|
399
453
|
color: intentCategoryColorSchema
|
|
400
454
|
});
|
|
401
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
402
456
|
id: z.string(),
|
|
403
457
|
name: z.string(),
|
|
404
458
|
color: intentCategoryColorSchema,
|
|
@@ -410,6 +464,7 @@ z.object({
|
|
|
410
464
|
environmentId: z.string(),
|
|
411
465
|
toolName: z.string(),
|
|
412
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
413
468
|
categories: z.array(intentCategorySchema)
|
|
414
469
|
});
|
|
415
470
|
const signalCategorySchema = z.object({
|
|
@@ -468,12 +523,262 @@ z.object({
|
|
|
468
523
|
createdAt: z.coerce.date(),
|
|
469
524
|
updatedAt: z.coerce.date()
|
|
470
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]);
|
|
471
536
|
z.enum([
|
|
472
537
|
"INFO",
|
|
473
538
|
"WARNING",
|
|
474
539
|
"DEBUG",
|
|
475
540
|
"ERROR"
|
|
476
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]));
|
|
477
782
|
const runtimeSchema = z.enum([
|
|
478
783
|
"python3.13",
|
|
479
784
|
"python3.14",
|
|
@@ -502,15 +807,27 @@ z.object({
|
|
|
502
807
|
environments: z.array(environmentWithDomainsSchema),
|
|
503
808
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
504
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
|
+
});
|
|
505
820
|
z.object({
|
|
506
|
-
|
|
821
|
+
name: z.string(),
|
|
507
822
|
createdAt: z.coerce.date(),
|
|
508
823
|
status: z.enum([
|
|
509
824
|
"ongoing",
|
|
510
825
|
"deployed",
|
|
511
826
|
"failed"
|
|
512
827
|
]),
|
|
513
|
-
|
|
828
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
829
|
+
environment: environmentSchema$1,
|
|
830
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
514
831
|
});
|
|
515
832
|
const serverFieldsSchema$1 = z.object({
|
|
516
833
|
$schema: z.string(),
|
|
@@ -539,15 +856,7 @@ z.object({
|
|
|
539
856
|
serverFields: serverFieldsSchema$1,
|
|
540
857
|
source: z.enum(["registry", "defaults"])
|
|
541
858
|
});
|
|
542
|
-
/**
|
|
543
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
544
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
545
|
-
*
|
|
546
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
547
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
548
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
549
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
550
|
-
*/
|
|
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. */
|
|
551
860
|
const clampStringField = (field) => {
|
|
552
861
|
const max = field.maxLength;
|
|
553
862
|
if (max === null) return field;
|
|
@@ -567,17 +876,28 @@ const toolDefinitionSchema = z.object({
|
|
|
567
876
|
}).optional()
|
|
568
877
|
});
|
|
569
878
|
const positiveTestCaseSchema = z.object({
|
|
570
|
-
scenario: z.string(),
|
|
571
|
-
userPrompt: z.string(),
|
|
572
|
-
toolTriggered: z.string().optional(),
|
|
573
|
-
expectedOutput: z.string().optional()
|
|
574
|
-
}).
|
|
879
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
880
|
+
userPrompt: z.string().min(1).describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
881
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
882
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
883
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
884
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial();
|
|
885
|
+
const blankPositiveTestCase = () => ({
|
|
886
|
+
scenario: "",
|
|
887
|
+
userPrompt: "",
|
|
888
|
+
toolTriggered: "",
|
|
889
|
+
expectedOutput: ""
|
|
890
|
+
});
|
|
891
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
575
892
|
const screenshotEntrySchema = z.object({
|
|
576
893
|
prompt: z.string(),
|
|
577
|
-
url: z.url()
|
|
894
|
+
url: z.url()
|
|
578
895
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
896
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
579
897
|
/** Accepts either a valid email or URL. */
|
|
580
898
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
899
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
900
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
581
901
|
const chatgptCategorySchema = z.enum([
|
|
582
902
|
"BUSINESS",
|
|
583
903
|
"COLLABORATION",
|
|
@@ -881,20 +1201,21 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
881
1201
|
"zh-TW"
|
|
882
1202
|
]);
|
|
883
1203
|
const negativeTestCaseSchema = z.object({
|
|
884
|
-
scenario: z.string(),
|
|
885
|
-
userPrompt: z.string()
|
|
886
|
-
}).
|
|
1204
|
+
scenario: z.string().min(1),
|
|
1205
|
+
userPrompt: z.string().min(1)
|
|
1206
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1207
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial();
|
|
1208
|
+
const blankNegativeTestCase = () => ({
|
|
1209
|
+
scenario: "",
|
|
1210
|
+
userPrompt: ""
|
|
1211
|
+
});
|
|
887
1212
|
const chatgptToolJustificationSchema = z.object({
|
|
888
1213
|
toolName: z.string(),
|
|
889
|
-
readOnlyJustification: z.string(),
|
|
890
|
-
openWorldJustification: z.string(),
|
|
891
|
-
destructiveJustification: z.string()
|
|
892
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
893
|
-
/**
|
|
894
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
895
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
896
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
897
|
-
*/
|
|
1214
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
1215
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
1216
|
+
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
1217
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
1218
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
898
1219
|
const chatgptTaglineSchema = z.string().max(30);
|
|
899
1220
|
const chatgptDescriptionSchema = z.string();
|
|
900
1221
|
const chatgptTranslationSchema = z.object({
|
|
@@ -903,52 +1224,68 @@ const chatgptTranslationSchema = z.object({
|
|
|
903
1224
|
description: chatgptDescriptionSchema
|
|
904
1225
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
905
1226
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
906
|
-
/**
|
|
907
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
908
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
909
|
-
*/
|
|
1227
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
910
1228
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
911
1229
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
912
1230
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
913
1231
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
914
|
-
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value
|
|
915
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
|
|
1232
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1233
|
+
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)."),
|
|
916
1234
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
917
1235
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
918
|
-
companyUrl:
|
|
1236
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
919
1237
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
920
|
-
privacyPolicyUrl:
|
|
921
|
-
termsOfServiceUrl:
|
|
922
|
-
demoRecordingUrl:
|
|
1238
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1239
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1240
|
+
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."),
|
|
923
1241
|
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."),
|
|
924
|
-
serverUrl:
|
|
1242
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
925
1243
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
926
1244
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
927
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
928
|
-
testCases: z.array(positiveTestCaseSchema).describe("
|
|
929
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases
|
|
930
|
-
screenshots: z.array(screenshotEntrySchema).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
|
|
1245
|
+
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
1246
|
+
testCases: z.array(positiveTestCaseSchema).length(5).describe("Exactly 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
1247
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
1248
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
931
1249
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
932
1250
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
933
1251
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
934
1252
|
});
|
|
935
|
-
chatgptSubmissionFormDataSchema.
|
|
1253
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1254
|
+
tagline: z.string().optional(),
|
|
1255
|
+
companyUrl: z.string().optional(),
|
|
1256
|
+
supportChannel: z.string().optional(),
|
|
1257
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1258
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1259
|
+
demoRecordingUrl: z.string().optional(),
|
|
1260
|
+
serverUrl: z.string().optional(),
|
|
1261
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1262
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1263
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1264
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1265
|
+
});
|
|
1266
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1267
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
936
1268
|
appName: true,
|
|
937
1269
|
developerName: true,
|
|
938
1270
|
serverUrl: true,
|
|
939
1271
|
tools: true,
|
|
940
1272
|
authentication: true
|
|
941
1273
|
});
|
|
942
|
-
|
|
1274
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1275
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
943
1276
|
tagline: true,
|
|
944
1277
|
description: true,
|
|
945
1278
|
category: true,
|
|
946
1279
|
testCases: true,
|
|
947
1280
|
negativeTestCases: true,
|
|
948
1281
|
toolJustifications: true
|
|
949
|
-
}).extend({
|
|
1282
|
+
}).extend({
|
|
1283
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1284
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1285
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1286
|
+
});
|
|
950
1287
|
const claudeCategorySchema = z.enum([
|
|
951
|
-
"
|
|
1288
|
+
"Productivity",
|
|
952
1289
|
"Communication",
|
|
953
1290
|
"Data & Analytics",
|
|
954
1291
|
"Development tools",
|
|
@@ -956,221 +1293,177 @@ const claudeCategorySchema = z.enum([
|
|
|
956
1293
|
"Consumer Health",
|
|
957
1294
|
"Health & Life Sciences",
|
|
958
1295
|
"Media & Entertainment",
|
|
959
|
-
"Commerce & Shopping"
|
|
1296
|
+
"Commerce & Shopping",
|
|
1297
|
+
"Legal",
|
|
1298
|
+
"Sales and marketing",
|
|
1299
|
+
"Creative",
|
|
1300
|
+
"Nonprofit",
|
|
1301
|
+
"Education",
|
|
1302
|
+
"Other"
|
|
960
1303
|
]);
|
|
961
|
-
const
|
|
962
|
-
"No auth needed",
|
|
963
|
-
"OAuth 2.0",
|
|
964
|
-
"Custom URL"
|
|
965
|
-
]);
|
|
966
|
-
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
967
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1304
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
968
1305
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
969
|
-
"
|
|
970
|
-
"
|
|
971
|
-
"
|
|
1306
|
+
"read_only",
|
|
1307
|
+
"write_only",
|
|
1308
|
+
"read_write"
|
|
972
1309
|
]);
|
|
973
|
-
const
|
|
974
|
-
|
|
975
|
-
"
|
|
976
|
-
"
|
|
977
|
-
"
|
|
978
|
-
"
|
|
979
|
-
]);
|
|
980
|
-
const claudeThirdPartySchema = z.enum([
|
|
981
|
-
"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)",
|
|
982
|
-
"Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
|
|
983
|
-
"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)",
|
|
984
|
-
"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)",
|
|
985
|
-
"N/A"
|
|
1310
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1311
|
+
"oauth_dcr",
|
|
1312
|
+
"oauth_cimd",
|
|
1313
|
+
"oauth_anthropic_creds",
|
|
1314
|
+
"custom_connection",
|
|
1315
|
+
"none"
|
|
986
1316
|
]);
|
|
987
|
-
const
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"GDPR compliant (if applicable)"
|
|
1317
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1318
|
+
"first_party",
|
|
1319
|
+
"proxied",
|
|
1320
|
+
"third_party"
|
|
992
1321
|
]);
|
|
993
|
-
const
|
|
994
|
-
|
|
995
|
-
"
|
|
996
|
-
"
|
|
1322
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1323
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1324
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1325
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1326
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1327
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1328
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1329
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1330
|
+
"Public documentation for this connector will be live by the publish date."
|
|
997
1331
|
]);
|
|
998
|
-
/**
|
|
999
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
1000
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
1001
|
-
*/
|
|
1332
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1002
1333
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
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
|
-
• '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.
|
|
1081
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
1082
|
-
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:
|
|
1083
|
-
• What the connector does and its key capabilities
|
|
1084
|
-
• How to connect/set it up (step by step)
|
|
1085
|
-
• What each tool does (or at least the main ones)
|
|
1086
|
-
• How to troubleshoot common issues
|
|
1087
|
-
• A support contact or channel
|
|
1088
|
-
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.`),
|
|
1089
|
-
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:
|
|
1090
|
-
• What data you collect (and how)
|
|
1091
|
-
• How you use the collected data
|
|
1092
|
-
• Where and how long you store it
|
|
1093
|
-
• Whether you share data with third parties (and who)
|
|
1094
|
-
• How users can contact you about data concerns
|
|
1095
|
-
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.`),
|
|
1096
|
-
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:
|
|
1097
|
-
• Email address (e.g. support@myapp.com)
|
|
1098
|
-
• Link to a GitHub Issues page
|
|
1099
|
-
• Link to a help center or support article
|
|
1100
|
-
• Link to a Discord/Slack community
|
|
1101
|
-
• Link to your documentation's troubleshooting section
|
|
1102
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1103
|
-
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:
|
|
1104
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
1105
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
1106
|
-
• 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.
|
|
1107
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
1108
|
-
• If your service requires API keys instead of a password, provide those.
|
|
1109
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
1110
|
-
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.
|
|
1111
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
1112
|
-
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.`),
|
|
1113
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
1114
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
1115
|
-
• '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).
|
|
1116
|
-
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.`),
|
|
1117
|
-
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.`),
|
|
1118
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
1119
|
-
• Format: SVG only
|
|
1120
|
-
• Aspect ratio: square (1:1)
|
|
1121
|
-
• Should work on a light background
|
|
1122
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
1123
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
1124
|
-
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.`),
|
|
1125
|
-
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:
|
|
1126
|
-
• 3–5 images is ideal
|
|
1127
|
-
• Minimum 1000px width, PNG format preferred
|
|
1128
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
1129
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
1130
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
1131
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
1132
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1133
|
-
});
|
|
1134
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1135
|
-
companyName: true,
|
|
1136
|
-
appName: true,
|
|
1137
|
-
mcpUrlType: true,
|
|
1334
|
+
serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
|
|
1335
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1336
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1337
|
+
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
|
|
1338
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1339
|
+
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.
|
|
1340
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1341
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1342
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1343
|
+
description: z.string().max(2e3).describe(`A description of what your connector does and its key features, shown on the connector's detail page in
|
|
1344
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1345
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1346
|
+
iconUrl: z.url().optional().describe(`Optional custom icon for the directory listing — a square SVG. By default the favicon from your MCP URL is used
|
|
1347
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1348
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1349
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1350
|
+
by your publish date.`),
|
|
1351
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1352
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1353
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1354
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1355
|
+
screenshots: z.array(screenshotEntrySchema).optional().describe(`Carousel images shown on your connector's directory page (PNG). Each is paired with the user prompt that produced
|
|
1356
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1357
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1358
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1359
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1360
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1361
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1362
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1363
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1364
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1365
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1366
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1367
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1368
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1369
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1370
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1371
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1372
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1373
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1374
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1375
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1376
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1377
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1378
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1379
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1380
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1381
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1382
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1383
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1384
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1385
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1386
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1387
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1388
|
+
fully populated account.`),
|
|
1389
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1390
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1391
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1392
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1393
|
+
});
|
|
1394
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1395
|
+
serverUrl: z.string().optional(),
|
|
1396
|
+
name: z.string().optional(),
|
|
1397
|
+
slug: z.string().optional(),
|
|
1398
|
+
oneLiner: z.string().optional(),
|
|
1399
|
+
description: z.string().optional(),
|
|
1400
|
+
iconUrl: z.string().optional(),
|
|
1401
|
+
documentation: z.string().optional(),
|
|
1402
|
+
support: z.string().optional(),
|
|
1403
|
+
privacyPolicy: z.string().optional(),
|
|
1404
|
+
companyWebsite: z.string().optional(),
|
|
1405
|
+
primaryContactEmail: z.string().optional(),
|
|
1406
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1407
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1408
|
+
});
|
|
1409
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1410
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1138
1411
|
serverUrl: true,
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
transportSupport: true,
|
|
1412
|
+
name: true,
|
|
1413
|
+
slug: true,
|
|
1414
|
+
companyName: true,
|
|
1143
1415
|
primaryContactEmail: true,
|
|
1144
1416
|
primaryContactName: true,
|
|
1417
|
+
readWriteCapabilities: true,
|
|
1145
1418
|
authentication: true,
|
|
1146
|
-
|
|
1147
|
-
|
|
1419
|
+
apiOwnership: true,
|
|
1420
|
+
personalHealthData: true
|
|
1148
1421
|
}).extend({
|
|
1149
1422
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1150
|
-
|
|
1423
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1151
1424
|
});
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
1425
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1426
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1427
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1428
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1429
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1430
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1431
|
+
});
|
|
1432
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1433
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1434
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1435
|
+
});
|
|
1436
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1437
|
+
const byField = {};
|
|
1438
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1439
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1440
|
+
return byField;
|
|
1441
|
+
}
|
|
1442
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1158
1443
|
const submissionMetaFieldsSchema = z.object({
|
|
1159
1444
|
id: z.string(),
|
|
1160
1445
|
environmentId: z.string(),
|
|
1446
|
+
auditId: z.string().nullable(),
|
|
1161
1447
|
createdAt: z.coerce.date(),
|
|
1162
1448
|
updatedAt: z.coerce.date()
|
|
1163
1449
|
});
|
|
1164
1450
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1165
1451
|
platform: z.literal("claudeai"),
|
|
1166
|
-
formData:
|
|
1452
|
+
formData: claudeSubmissionDraftSchema,
|
|
1453
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1167
1454
|
});
|
|
1168
1455
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1169
1456
|
platform: z.literal("chatgpt"),
|
|
1170
|
-
formData:
|
|
1457
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1458
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1171
1459
|
});
|
|
1172
1460
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1173
|
-
z.union([
|
|
1461
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1462
|
+
z.literal([
|
|
1463
|
+
100,
|
|
1464
|
+
75,
|
|
1465
|
+
50
|
|
1466
|
+
]);
|
|
1174
1467
|
const subscriptionPlanSchema = z.enum([
|
|
1175
1468
|
"pro",
|
|
1176
1469
|
"business",
|
|
@@ -1182,17 +1475,76 @@ const customerCreditsSchema = z.object({
|
|
|
1182
1475
|
expiresAt: z.number().nullable(),
|
|
1183
1476
|
currency: z.string()
|
|
1184
1477
|
});
|
|
1185
|
-
const customerUsageSchema = z.object({
|
|
1186
|
-
amountInCents: z.number(),
|
|
1187
|
-
currency: z.string(),
|
|
1188
|
-
periodEnd: z.number()
|
|
1189
|
-
});
|
|
1190
1478
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1191
1479
|
z.object({
|
|
1192
1480
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1193
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1194
1481
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1195
1482
|
});
|
|
1483
|
+
const metricsQueueEventSchema = z.object({
|
|
1484
|
+
ts: z.number().int(),
|
|
1485
|
+
method: z.string(),
|
|
1486
|
+
tool: z.string().nullable(),
|
|
1487
|
+
client: z.string(),
|
|
1488
|
+
sessionId: z.string().nullable(),
|
|
1489
|
+
durationMs: z.number().int(),
|
|
1490
|
+
outputTokens: z.number().int().nullable(),
|
|
1491
|
+
errorType: z.enum([
|
|
1492
|
+
"mcp_error",
|
|
1493
|
+
"tool_error",
|
|
1494
|
+
"timeout"
|
|
1495
|
+
]).nullable(),
|
|
1496
|
+
errorCode: z.number().int().nullable()
|
|
1497
|
+
});
|
|
1498
|
+
z.object({
|
|
1499
|
+
v: z.literal(1),
|
|
1500
|
+
envId: z.string(),
|
|
1501
|
+
events: z.array(metricsQueueEventSchema)
|
|
1502
|
+
});
|
|
1503
|
+
z.object({ v: z.number() });
|
|
1504
|
+
const telemetrySignalSchema = z.enum([
|
|
1505
|
+
"logs",
|
|
1506
|
+
"metrics",
|
|
1507
|
+
"traces"
|
|
1508
|
+
]);
|
|
1509
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1510
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1511
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1512
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1513
|
+
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");
|
|
1514
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1515
|
+
id: z.string(),
|
|
1516
|
+
name: otlpHeaderNameSchema,
|
|
1517
|
+
value: otlpHeaderValueSchema,
|
|
1518
|
+
isSecret: z.boolean()
|
|
1519
|
+
});
|
|
1520
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1521
|
+
"credentials",
|
|
1522
|
+
"wrong-path",
|
|
1523
|
+
"wrong-protocol",
|
|
1524
|
+
"invalid-payload",
|
|
1525
|
+
"partial-rejection",
|
|
1526
|
+
"blocked-target",
|
|
1527
|
+
"timeout",
|
|
1528
|
+
"unreachable",
|
|
1529
|
+
"receiver-error",
|
|
1530
|
+
"unexpected-status"
|
|
1531
|
+
]);
|
|
1532
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1533
|
+
z.object({
|
|
1534
|
+
id: z.string(),
|
|
1535
|
+
signal: telemetrySignalSchema,
|
|
1536
|
+
endpoint: otlpEndpointSchema,
|
|
1537
|
+
protocol: otlpProtocolSchema,
|
|
1538
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1539
|
+
status: telemetryDestinationStatusSchema,
|
|
1540
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1541
|
+
});
|
|
1542
|
+
//#endregion
|
|
1543
|
+
//#region src/auth-scope.ts
|
|
1544
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1545
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1546
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1547
|
+
const AUTH_SCOPE_USER = "user";
|
|
1196
1548
|
//#endregion
|
|
1197
1549
|
//#region src/schemas.ts
|
|
1198
1550
|
const RESERVED_KEYS = [
|
|
@@ -1229,7 +1581,10 @@ const RESERVED_KEYS = [
|
|
|
1229
1581
|
"BUILD_ARG_START_COMMAND",
|
|
1230
1582
|
"ALPIC_HOST",
|
|
1231
1583
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1232
|
-
"ALPIC_INTENT_META_KEY"
|
|
1584
|
+
"ALPIC_INTENT_META_KEY",
|
|
1585
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1586
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1587
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1233
1588
|
];
|
|
1234
1589
|
const environmentVariableSchema = z.object({
|
|
1235
1590
|
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"),
|
|
@@ -1282,6 +1637,14 @@ const serverFieldsSchema = z.object({
|
|
|
1282
1637
|
});
|
|
1283
1638
|
//#endregion
|
|
1284
1639
|
//#region src/api.contract.ts
|
|
1640
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1641
|
+
try {
|
|
1642
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1643
|
+
return true;
|
|
1644
|
+
} catch {
|
|
1645
|
+
return false;
|
|
1646
|
+
}
|
|
1647
|
+
};
|
|
1285
1648
|
const deploymentStatusSchema = z.enum([
|
|
1286
1649
|
"ongoing",
|
|
1287
1650
|
"deployed",
|
|
@@ -1310,21 +1673,20 @@ const deploymentSchema = z.object({
|
|
|
1310
1673
|
isCurrent: z.boolean(),
|
|
1311
1674
|
deploymentPageUrl: z.url().nullable()
|
|
1312
1675
|
});
|
|
1313
|
-
const
|
|
1676
|
+
const isValidTimeInput = (value) => {
|
|
1314
1677
|
if (ms(value) !== void 0) return true;
|
|
1315
1678
|
return !Number.isNaN(new Date(value).getTime());
|
|
1316
1679
|
};
|
|
1317
|
-
const
|
|
1680
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1681
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1682
|
+
const createEnvironmentContractV1 = base.route({
|
|
1318
1683
|
path: "/v1/environments",
|
|
1319
1684
|
method: "POST",
|
|
1320
1685
|
summary: "Create an environment",
|
|
1321
1686
|
description: "Create an environment for a project",
|
|
1322
1687
|
tags: ["environments"],
|
|
1323
1688
|
successDescription: "The environment has been created successfully"
|
|
1324
|
-
}).errors({
|
|
1325
|
-
NOT_FOUND: {},
|
|
1326
|
-
BAD_REQUEST: {}
|
|
1327
|
-
}).input(z.object({
|
|
1689
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1328
1690
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1329
1691
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1330
1692
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1337,7 +1699,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1337
1699
|
createdAt: z.coerce.date(),
|
|
1338
1700
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1339
1701
|
}));
|
|
1340
|
-
const getEnvironmentContractV1 =
|
|
1702
|
+
const getEnvironmentContractV1 = base.route({
|
|
1341
1703
|
path: "/v1/environments/{environmentId}",
|
|
1342
1704
|
method: "GET",
|
|
1343
1705
|
summary: "Get an environment",
|
|
@@ -1353,6 +1715,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1353
1715
|
createdAt: z.coerce.date(),
|
|
1354
1716
|
projectId: z.string()
|
|
1355
1717
|
}));
|
|
1718
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1719
|
+
path: "/v1/environments/{environmentId}",
|
|
1720
|
+
method: "DELETE",
|
|
1721
|
+
summary: "Delete an environment",
|
|
1722
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1723
|
+
tags: ["environments"],
|
|
1724
|
+
successDescription: "The environment has been deleted successfully"
|
|
1725
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1356
1726
|
const domainSchema = z.object({
|
|
1357
1727
|
domain: z.string(),
|
|
1358
1728
|
status: z.enum([
|
|
@@ -1394,7 +1764,7 @@ const projectOutputSchema = z.object({
|
|
|
1394
1764
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1395
1765
|
environments: z.array(environmentSchema)
|
|
1396
1766
|
});
|
|
1397
|
-
const getProjectContractV1 =
|
|
1767
|
+
const getProjectContractV1 = base.route({
|
|
1398
1768
|
path: "/v1/projects/{projectId}",
|
|
1399
1769
|
method: "GET",
|
|
1400
1770
|
summary: "Get a project",
|
|
@@ -1402,18 +1772,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1402
1772
|
tags: ["projects"],
|
|
1403
1773
|
successDescription: "The project details"
|
|
1404
1774
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1405
|
-
const listProjectsContractV1 =
|
|
1775
|
+
const listProjectsContractV1 = base.route({
|
|
1406
1776
|
path: "/v1/projects",
|
|
1407
1777
|
method: "GET",
|
|
1408
1778
|
summary: "List projects",
|
|
1409
1779
|
description: "List all projects for a team",
|
|
1410
1780
|
tags: ["projects"],
|
|
1411
1781
|
successDescription: "The list of projects"
|
|
1412
|
-
}).errors({
|
|
1413
|
-
|
|
1414
|
-
BAD_REQUEST: {}
|
|
1415
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1416
|
-
const createProjectContractV1 = oc.route({
|
|
1782
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1783
|
+
const createProjectContractV1 = base.route({
|
|
1417
1784
|
path: "/v1/projects",
|
|
1418
1785
|
method: "POST",
|
|
1419
1786
|
summary: "Create a project",
|
|
@@ -1422,7 +1789,7 @@ const createProjectContractV1 = oc.route({
|
|
|
1422
1789
|
successDescription: "The project has been created successfully"
|
|
1423
1790
|
}).errors({
|
|
1424
1791
|
NOT_FOUND: {},
|
|
1425
|
-
|
|
1792
|
+
FORBIDDEN: {}
|
|
1426
1793
|
}).input(z.object({
|
|
1427
1794
|
teamId: z.string().optional(),
|
|
1428
1795
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1462,7 +1829,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1462
1829
|
isSecret: z.boolean(),
|
|
1463
1830
|
createdAt: z.coerce.date()
|
|
1464
1831
|
});
|
|
1465
|
-
const listEnvironmentVariablesContractV1 =
|
|
1832
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1466
1833
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1467
1834
|
method: "GET",
|
|
1468
1835
|
summary: "List environment variables",
|
|
@@ -1470,48 +1837,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1470
1837
|
tags: ["environments"],
|
|
1471
1838
|
successDescription: "The list of environment variables"
|
|
1472
1839
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1473
|
-
const createEnvironmentVariablesContractV1 =
|
|
1840
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1474
1841
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1475
1842
|
method: "POST",
|
|
1476
1843
|
summary: "Add environment variables",
|
|
1477
1844
|
description: "Add one or more environment variables to an environment",
|
|
1478
1845
|
tags: ["environments"],
|
|
1479
1846
|
successDescription: "The environment variables have been added successfully"
|
|
1480
|
-
}).errors({
|
|
1481
|
-
NOT_FOUND: {},
|
|
1482
|
-
BAD_REQUEST: {}
|
|
1483
|
-
}).input(z.object({
|
|
1847
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1484
1848
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1485
1849
|
environmentVariables: environmentVariablesSchema
|
|
1486
1850
|
})).output(z.object({ success: z.literal(true) }));
|
|
1487
|
-
const updateEnvironmentVariableContractV1 =
|
|
1851
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1488
1852
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1489
1853
|
method: "PATCH",
|
|
1490
1854
|
summary: "Update an environment variable",
|
|
1491
1855
|
description: "Update an environment variable by ID",
|
|
1492
1856
|
tags: ["environments"],
|
|
1493
1857
|
successDescription: "The environment variable has been updated successfully"
|
|
1494
|
-
}).errors({
|
|
1495
|
-
NOT_FOUND: {},
|
|
1496
|
-
BAD_REQUEST: {}
|
|
1497
|
-
}).input(z.object({
|
|
1858
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1498
1859
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1499
1860
|
key: environmentVariableSchema.shape.key,
|
|
1500
1861
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1501
1862
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1502
1863
|
})).output(z.object({ success: z.literal(true) }));
|
|
1503
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1864
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1504
1865
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1505
1866
|
method: "DELETE",
|
|
1506
1867
|
summary: "Delete an environment variable",
|
|
1507
1868
|
description: "Delete an environment variable by ID",
|
|
1508
1869
|
tags: ["environments"],
|
|
1509
1870
|
successDescription: "The environment variable has been deleted successfully"
|
|
1510
|
-
}).errors({
|
|
1511
|
-
|
|
1512
|
-
BAD_REQUEST: {}
|
|
1513
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1514
|
-
const deleteProjectContractV1 = oc.route({
|
|
1871
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1872
|
+
const deleteProjectContractV1 = base.route({
|
|
1515
1873
|
path: "/v1/projects/{projectId}",
|
|
1516
1874
|
method: "DELETE",
|
|
1517
1875
|
summary: "Delete a project",
|
|
@@ -1519,7 +1877,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1519
1877
|
tags: ["projects"],
|
|
1520
1878
|
successDescription: "The project has been deleted successfully"
|
|
1521
1879
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1522
|
-
const updateProjectContractV1 =
|
|
1880
|
+
const updateProjectContractV1 = base.route({
|
|
1523
1881
|
path: "/v1/projects/{projectId}",
|
|
1524
1882
|
method: "PATCH",
|
|
1525
1883
|
summary: "Update a project",
|
|
@@ -1528,13 +1886,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1528
1886
|
successDescription: "The project has been updated successfully"
|
|
1529
1887
|
}).errors({
|
|
1530
1888
|
NOT_FOUND: {},
|
|
1531
|
-
|
|
1889
|
+
FORBIDDEN: {}
|
|
1532
1890
|
}).input(z.object({
|
|
1533
1891
|
projectId: z.string().describe("The ID of the project"),
|
|
1534
1892
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1535
1893
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1536
1894
|
})).output(projectOutputSchema);
|
|
1537
|
-
const deployEnvironmentContractV1 =
|
|
1895
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1538
1896
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1539
1897
|
method: "POST",
|
|
1540
1898
|
summary: "Deploy an environment",
|
|
@@ -1543,27 +1901,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1543
1901
|
successDescription: "The environment has been deployed successfully"
|
|
1544
1902
|
}).errors({
|
|
1545
1903
|
NOT_FOUND: {},
|
|
1546
|
-
|
|
1904
|
+
CONFLICT: {}
|
|
1547
1905
|
}).input(z.object({
|
|
1548
1906
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1549
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1907
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1908
|
+
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.")
|
|
1550
1909
|
})).output(deploymentSchema);
|
|
1551
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1910
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1552
1911
|
path: "/v1/deployments/upload",
|
|
1553
1912
|
method: "POST",
|
|
1554
1913
|
summary: "Upload deployment artifacts",
|
|
1555
1914
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1556
1915
|
tags: ["deployments"],
|
|
1557
1916
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1558
|
-
}).errors({
|
|
1559
|
-
NOT_FOUND: {},
|
|
1560
|
-
BAD_REQUEST: {}
|
|
1561
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1917
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1562
1918
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1563
1919
|
token: z.string().describe("Token to identify the source archive"),
|
|
1564
1920
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1565
1921
|
}));
|
|
1566
|
-
const listDeploymentsContractV1 =
|
|
1922
|
+
const listDeploymentsContractV1 = base.route({
|
|
1567
1923
|
path: "/v1/projects/{projectId}/deployments",
|
|
1568
1924
|
method: "GET",
|
|
1569
1925
|
summary: "List project deployments",
|
|
@@ -1575,7 +1931,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1575
1931
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1576
1932
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1577
1933
|
})).output(z.array(deploymentSchema));
|
|
1578
|
-
const getDeploymentContractV1 =
|
|
1934
|
+
const getDeploymentContractV1 = base.route({
|
|
1579
1935
|
path: "/v1/deployments/{deploymentId}",
|
|
1580
1936
|
method: "GET",
|
|
1581
1937
|
summary: "Get a deployment",
|
|
@@ -1583,20 +1939,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1583
1939
|
tags: ["deployments"],
|
|
1584
1940
|
successDescription: "The deployment details"
|
|
1585
1941
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1586
|
-
const
|
|
1942
|
+
const logEntrySchema = z.object({
|
|
1943
|
+
timestamp: z.coerce.date(),
|
|
1944
|
+
type: z.enum([
|
|
1945
|
+
"START",
|
|
1946
|
+
"END",
|
|
1947
|
+
"INFO",
|
|
1948
|
+
"ERROR",
|
|
1949
|
+
"WARNING",
|
|
1950
|
+
"DEBUG"
|
|
1951
|
+
]),
|
|
1952
|
+
requestId: z.string(),
|
|
1953
|
+
content: z.string().optional(),
|
|
1954
|
+
method: z.string().optional(),
|
|
1955
|
+
durationInMs: z.number().optional()
|
|
1956
|
+
});
|
|
1957
|
+
const getLogsContractV1 = base.route({
|
|
1587
1958
|
path: "/v1/environments/{environmentId}/logs",
|
|
1588
1959
|
method: "GET",
|
|
1589
1960
|
summary: "Get logs",
|
|
1590
1961
|
description: "Get logs for an environment",
|
|
1591
1962
|
tags: ["environments"],
|
|
1592
1963
|
successDescription: "The logs"
|
|
1593
|
-
}).errors({
|
|
1594
|
-
NOT_FOUND: {},
|
|
1595
|
-
BAD_REQUEST: {}
|
|
1596
|
-
}).input(z.object({
|
|
1964
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1597
1965
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1598
|
-
since:
|
|
1599
|
-
until:
|
|
1966
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1967
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1600
1968
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1601
1969
|
level: z.array(z.enum([
|
|
1602
1970
|
"INFO",
|
|
@@ -1607,34 +1975,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1607
1975
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1608
1976
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1609
1977
|
})).output(z.object({
|
|
1610
|
-
logs: z.array(
|
|
1611
|
-
timestamp: z.coerce.date(),
|
|
1612
|
-
type: z.enum([
|
|
1613
|
-
"START",
|
|
1614
|
-
"END",
|
|
1615
|
-
"INFO",
|
|
1616
|
-
"ERROR",
|
|
1617
|
-
"WARNING",
|
|
1618
|
-
"DEBUG"
|
|
1619
|
-
]),
|
|
1620
|
-
requestId: z.string(),
|
|
1621
|
-
content: z.string().optional(),
|
|
1622
|
-
method: z.string().optional(),
|
|
1623
|
-
durationInMs: z.number().optional()
|
|
1624
|
-
})),
|
|
1978
|
+
logs: z.array(logEntrySchema),
|
|
1625
1979
|
nextToken: z.string().nullable()
|
|
1626
1980
|
}));
|
|
1627
|
-
const getLatestLogsContractV1 =
|
|
1981
|
+
const getLatestLogsContractV1 = base.route({
|
|
1628
1982
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1629
1983
|
method: "GET",
|
|
1630
1984
|
summary: "Get latest logs",
|
|
1631
1985
|
description: "Get the N most recent logs for an environment",
|
|
1632
1986
|
tags: ["environments"],
|
|
1633
1987
|
successDescription: "The latest logs"
|
|
1634
|
-
}).errors({
|
|
1635
|
-
NOT_FOUND: {},
|
|
1636
|
-
BAD_REQUEST: {}
|
|
1637
|
-
}).input(z.object({
|
|
1988
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1638
1989
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1639
1990
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1640
1991
|
level: z.array(z.enum([
|
|
@@ -1644,22 +1995,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1644
1995
|
"DEBUG"
|
|
1645
1996
|
])).optional().describe("Filter by log level"),
|
|
1646
1997
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1647
|
-
})).output(z.object({ logs: z.array(
|
|
1648
|
-
|
|
1649
|
-
type: z.enum([
|
|
1650
|
-
"START",
|
|
1651
|
-
"END",
|
|
1652
|
-
"INFO",
|
|
1653
|
-
"ERROR",
|
|
1654
|
-
"WARNING",
|
|
1655
|
-
"DEBUG"
|
|
1656
|
-
]),
|
|
1657
|
-
requestId: z.string(),
|
|
1658
|
-
content: z.string().optional(),
|
|
1659
|
-
method: z.string().optional(),
|
|
1660
|
-
durationInMs: z.number().optional()
|
|
1661
|
-
})) }));
|
|
1662
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1998
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1999
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1663
2000
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1664
2001
|
method: "GET",
|
|
1665
2002
|
summary: "Get deployment logs",
|
|
@@ -1686,22 +2023,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1686
2023
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1687
2024
|
task_count: z.array(analyticsDataPointSchema)
|
|
1688
2025
|
});
|
|
1689
|
-
const getProjectAnalyticsContractV1 =
|
|
2026
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1690
2027
|
path: "/v1/analytics/{projectId}",
|
|
1691
2028
|
method: "GET",
|
|
1692
2029
|
summary: "Get project analytics",
|
|
1693
2030
|
description: "Get analytics data for a project over a time range",
|
|
1694
2031
|
tags: ["analytics"],
|
|
1695
2032
|
successDescription: "The project analytics data"
|
|
1696
|
-
}).errors({
|
|
1697
|
-
NOT_FOUND: {},
|
|
1698
|
-
BAD_REQUEST: {}
|
|
1699
|
-
}).input(z.object({
|
|
2033
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1700
2034
|
projectId: z.string().describe("The ID of the project"),
|
|
1701
2035
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1702
2036
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1703
2037
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1704
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2038
|
+
}).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({
|
|
1705
2039
|
metadata: z.object({
|
|
1706
2040
|
startTimestamp: z.number(),
|
|
1707
2041
|
endTimestamp: z.number(),
|
|
@@ -1711,7 +2045,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1711
2045
|
}),
|
|
1712
2046
|
timeSeries: analyticsTimeSeriesSchema
|
|
1713
2047
|
}));
|
|
1714
|
-
const
|
|
2048
|
+
const paginatedInsightsInputShape = {
|
|
2049
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2050
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2051
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2052
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2053
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2054
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2055
|
+
};
|
|
2056
|
+
const listIntentsContractV1 = base.route({
|
|
2057
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2058
|
+
method: "GET",
|
|
2059
|
+
summary: "List intents",
|
|
2060
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2061
|
+
tags: ["insights"],
|
|
2062
|
+
successDescription: "The grouped user intents"
|
|
2063
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2064
|
+
...paginatedInsightsInputShape,
|
|
2065
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2066
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2067
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2068
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2069
|
+
})).output(z.object({
|
|
2070
|
+
intents: z.array(z.object({
|
|
2071
|
+
id: z.string(),
|
|
2072
|
+
intentIds: z.array(z.string()).min(1),
|
|
2073
|
+
environmentId: z.string(),
|
|
2074
|
+
message: z.string(),
|
|
2075
|
+
toolName: z.string(),
|
|
2076
|
+
createdAt: z.coerce.date(),
|
|
2077
|
+
occurrenceCount: z.number().int().positive(),
|
|
2078
|
+
clientName: z.string().nullable(),
|
|
2079
|
+
clientId: z.string().nullable(),
|
|
2080
|
+
categories: z.array(z.object({
|
|
2081
|
+
id: z.string(),
|
|
2082
|
+
name: z.string(),
|
|
2083
|
+
color: intentCategoryColorSchema
|
|
2084
|
+
}))
|
|
2085
|
+
})),
|
|
2086
|
+
totalCount: z.number().int().nonnegative()
|
|
2087
|
+
}));
|
|
2088
|
+
const listFeedbacksContractV1 = base.route({
|
|
2089
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2090
|
+
method: "GET",
|
|
2091
|
+
summary: "List feedbacks",
|
|
2092
|
+
description: "List user feedback for an environment over a time range",
|
|
2093
|
+
tags: ["insights"],
|
|
2094
|
+
successDescription: "The user feedback"
|
|
2095
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2096
|
+
...paginatedInsightsInputShape,
|
|
2097
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2098
|
+
})).output(z.object({
|
|
2099
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2100
|
+
totalCount: z.number().int().nonnegative()
|
|
2101
|
+
}));
|
|
2102
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2103
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2104
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2105
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2106
|
+
method: "GET",
|
|
2107
|
+
summary: "List intent categories",
|
|
2108
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2109
|
+
tags: ["insights"],
|
|
2110
|
+
successDescription: "The intent categories"
|
|
2111
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2112
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2113
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2114
|
+
method: "POST",
|
|
2115
|
+
summary: "Create an intent category",
|
|
2116
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2117
|
+
tags: ["insights"],
|
|
2118
|
+
successDescription: "The created intent category"
|
|
2119
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2120
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2121
|
+
name: intentCategoryNameSchema,
|
|
2122
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2123
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2124
|
+
})).output(intentCategorySchema);
|
|
2125
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2126
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2127
|
+
method: "PATCH",
|
|
2128
|
+
summary: "Update an intent category",
|
|
2129
|
+
description: "Rename or recolor an intent category",
|
|
2130
|
+
tags: ["insights"],
|
|
2131
|
+
successDescription: "The updated intent category"
|
|
2132
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2133
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2134
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2135
|
+
name: intentCategoryNameSchema.optional(),
|
|
2136
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2137
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2138
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2139
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2140
|
+
method: "DELETE",
|
|
2141
|
+
summary: "Delete an intent category",
|
|
2142
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2143
|
+
tags: ["insights"],
|
|
2144
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2145
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2146
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2147
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2148
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2149
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2150
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2151
|
+
method: "POST",
|
|
2152
|
+
summary: "Link an intent category",
|
|
2153
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2154
|
+
tags: ["insights"],
|
|
2155
|
+
successDescription: "The intents have been linked successfully"
|
|
2156
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2157
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2158
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2159
|
+
intentIds: categorizableIntentIdsSchema
|
|
2160
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2161
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2162
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2163
|
+
method: "POST",
|
|
2164
|
+
summary: "Unlink an intent category",
|
|
2165
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2166
|
+
tags: ["insights"],
|
|
2167
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2168
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2169
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2170
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2171
|
+
intentIds: categorizableIntentIdsSchema
|
|
2172
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2173
|
+
const listTeamsContractV1 = base.route({
|
|
1715
2174
|
path: "/v1/teams",
|
|
1716
2175
|
method: "GET",
|
|
1717
2176
|
summary: "List teams",
|
|
@@ -1724,28 +2183,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
1724
2183
|
createdAt: z.coerce.date(),
|
|
1725
2184
|
hasStripeAccount: z.boolean()
|
|
1726
2185
|
})));
|
|
1727
|
-
const
|
|
2186
|
+
const getTeamUsageContractV1 = base.route({
|
|
2187
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2188
|
+
method: "GET",
|
|
2189
|
+
summary: "Get team usage",
|
|
2190
|
+
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.",
|
|
2191
|
+
tags: ["teams"],
|
|
2192
|
+
successDescription: "The current billing window usage"
|
|
2193
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2194
|
+
teamId: z.string(),
|
|
2195
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2196
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2197
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2198
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2199
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2200
|
+
}));
|
|
2201
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1728
2202
|
path: "/v1/tunnels/ticket",
|
|
1729
2203
|
method: "GET",
|
|
1730
2204
|
summary: "Get a tunnel ticket",
|
|
1731
2205
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1732
2206
|
tags: ["tunnels"],
|
|
1733
2207
|
successDescription: "The tunnel ticket"
|
|
1734
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
2208
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1735
2209
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1736
2210
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1737
2211
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1738
2212
|
}));
|
|
1739
|
-
const publishServerContractV1 =
|
|
2213
|
+
const publishServerContractV1 = base.route({
|
|
1740
2214
|
path: "/v1/distribution/publish",
|
|
1741
2215
|
method: "POST",
|
|
1742
2216
|
summary: "Publish a server to the MCP registry",
|
|
1743
2217
|
tags: ["distribution"],
|
|
1744
2218
|
successDescription: "The server has been published successfully"
|
|
1745
|
-
}).errors({
|
|
1746
|
-
NOT_FOUND: {},
|
|
1747
|
-
BAD_REQUEST: {}
|
|
1748
|
-
}).input(z.object({
|
|
2219
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1749
2220
|
projectId: z.string(),
|
|
1750
2221
|
domain: z.string(),
|
|
1751
2222
|
title: z.string().min(1).max(100),
|
|
@@ -1754,17 +2225,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1754
2225
|
iconSrc: z.url().max(255).optional(),
|
|
1755
2226
|
dryRun: z.boolean().optional()
|
|
1756
2227
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1757
|
-
const getServerInfoContractV1 =
|
|
2228
|
+
const getServerInfoContractV1 = base.route({
|
|
1758
2229
|
path: "/v1/distribution/get",
|
|
1759
2230
|
method: "GET",
|
|
1760
2231
|
summary: "Get server info",
|
|
1761
2232
|
description: "Get info about a server",
|
|
1762
2233
|
tags: ["distribution"],
|
|
1763
2234
|
successDescription: "The server info"
|
|
1764
|
-
}).errors({
|
|
1765
|
-
NOT_FOUND: {},
|
|
1766
|
-
BAD_REQUEST: {}
|
|
1767
|
-
}).input(z.object({
|
|
2235
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1768
2236
|
projectId: z.string(),
|
|
1769
2237
|
domain: z.string()
|
|
1770
2238
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1783,7 +2251,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1783
2251
|
isPlaygroundEnabled: z.boolean(),
|
|
1784
2252
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1785
2253
|
});
|
|
1786
|
-
const getPlaygroundContractV1 =
|
|
2254
|
+
const getPlaygroundContractV1 = base.route({
|
|
1787
2255
|
path: "/v1/environments/{environmentId}/playground",
|
|
1788
2256
|
method: "GET",
|
|
1789
2257
|
summary: "Get playground configuration",
|
|
@@ -1791,17 +2259,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1791
2259
|
tags: ["environments"],
|
|
1792
2260
|
successDescription: "The playground configuration"
|
|
1793
2261
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1794
|
-
const upsertPlaygroundContractV1 =
|
|
2262
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1795
2263
|
path: "/v1/environments/{environmentId}/playground",
|
|
1796
2264
|
method: "PUT",
|
|
1797
2265
|
summary: "Update playground configuration",
|
|
1798
2266
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1799
2267
|
tags: ["environments"],
|
|
1800
2268
|
successDescription: "The updated playground configuration"
|
|
1801
|
-
}).errors({
|
|
1802
|
-
NOT_FOUND: {},
|
|
1803
|
-
BAD_REQUEST: {}
|
|
1804
|
-
}).input(z.object({
|
|
2269
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1805
2270
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1806
2271
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1807
2272
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1809,7 +2274,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1809
2274
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1810
2275
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1811
2276
|
})).output(playgroundOutputSchema);
|
|
1812
|
-
const createBeaconContractV1 =
|
|
2277
|
+
const createBeaconContractV1 = base.route({
|
|
1813
2278
|
path: "/v1/beacon/audits",
|
|
1814
2279
|
method: "POST",
|
|
1815
2280
|
summary: "Create a beacon audit",
|
|
@@ -1818,7 +2283,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1818
2283
|
successDescription: "The audit has been created"
|
|
1819
2284
|
}).errors({
|
|
1820
2285
|
NOT_FOUND: {},
|
|
1821
|
-
BAD_REQUEST: {},
|
|
1822
2286
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1823
2287
|
}).input(z.object({
|
|
1824
2288
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1826,7 +2290,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1826
2290
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1827
2291
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1828
2292
|
})).output(z.object({ id: z.string() }));
|
|
1829
|
-
const getBeaconContractV1 =
|
|
2293
|
+
const getBeaconContractV1 = base.route({
|
|
1830
2294
|
path: "/v1/beacon/audits/{auditId}",
|
|
1831
2295
|
method: "GET",
|
|
1832
2296
|
summary: "Get a beacon audit",
|
|
@@ -1842,8 +2306,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1842
2306
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1843
2307
|
}));
|
|
1844
2308
|
const contract = {
|
|
1845
|
-
teams: {
|
|
2309
|
+
teams: {
|
|
2310
|
+
list: { v1: listTeamsContractV1 },
|
|
2311
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2312
|
+
},
|
|
1846
2313
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2314
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2315
|
+
intentCategories: {
|
|
2316
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2317
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2318
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2319
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2320
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2321
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2322
|
+
},
|
|
2323
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1847
2324
|
deployments: {
|
|
1848
2325
|
list: { v1: listDeploymentsContractV1 },
|
|
1849
2326
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1853,6 +2330,7 @@ const contract = {
|
|
|
1853
2330
|
environments: {
|
|
1854
2331
|
create: { v1: createEnvironmentContractV1 },
|
|
1855
2332
|
get: { v1: getEnvironmentContractV1 },
|
|
2333
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1856
2334
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1857
2335
|
getLogs: { v1: getLogsContractV1 },
|
|
1858
2336
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1884,5 +2362,10 @@ const contract = {
|
|
|
1884
2362
|
get: { v1: getBeaconContractV1 }
|
|
1885
2363
|
}
|
|
1886
2364
|
};
|
|
2365
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2366
|
+
const contractForDocs = {
|
|
2367
|
+
...contract,
|
|
2368
|
+
deployments: deploymentsForDocs
|
|
2369
|
+
};
|
|
1887
2370
|
//#endregion
|
|
1888
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2371
|
+
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 };
|