@alpic-ai/api 0.0.0-dev.gf41f6d0 → 0.0.0-dev.gf468a60
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 +6270 -84
- package/dist/index.mjs +999 -397
- package/package.json +26 -10
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -169,11 +169,22 @@ z$1.object({
|
|
|
169
169
|
token: z$1.string(),
|
|
170
170
|
token_type_hint: z$1.string().optional()
|
|
171
171
|
}).strip();
|
|
172
|
-
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
173
176
|
const PLATFORM_LABELS = {
|
|
174
177
|
chatgpt: "ChatGPT",
|
|
175
178
|
claudeai: "Claude.ai"
|
|
176
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cato",
|
|
183
|
+
"cloudflare",
|
|
184
|
+
"fastly"
|
|
185
|
+
];
|
|
186
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
187
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
188
|
const auditStatusSchema = z.enum([
|
|
178
189
|
"pending",
|
|
179
190
|
"partial",
|
|
@@ -246,6 +257,25 @@ z.object({
|
|
|
246
257
|
clientSecret: z.string(),
|
|
247
258
|
clientScopes: z.array(z.string())
|
|
248
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
249
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
250
280
|
"ongoing",
|
|
251
281
|
"deployed",
|
|
@@ -273,34 +303,51 @@ const deploymentSummarySchema = z.object({
|
|
|
273
303
|
createdAt: z.coerce.date(),
|
|
274
304
|
updatedAt: z.coerce.date()
|
|
275
305
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
306
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
307
|
const publicEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.literal(true),
|
|
309
|
+
oAuthMetadata: z.strictObject({})
|
|
310
|
+
});
|
|
311
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
312
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
313
|
+
allowsAnonymous: z.boolean(),
|
|
314
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
315
|
+
scope: z.string().optional()
|
|
316
|
+
});
|
|
317
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
318
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
319
|
+
allowsAnonymous: z.boolean(),
|
|
320
|
+
oAuthMetadata: z.object({
|
|
321
|
+
externalAuthorizationServerUrl: z.url(),
|
|
322
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
323
|
+
}),
|
|
324
|
+
scope: z.string().optional()
|
|
325
|
+
});
|
|
326
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
|
+
const standaloneEnvironmentSchema = z.object({
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
329
|
+
oAuthMetadata: z.object({
|
|
330
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
331
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
332
|
+
}),
|
|
333
|
+
scope: z.string().optional()
|
|
334
|
+
});
|
|
335
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
336
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
337
|
+
allowsAnonymous: z.literal(false),
|
|
338
|
+
oAuthMetadata: z.strictObject({}),
|
|
339
|
+
scope: z.string().optional()
|
|
340
|
+
});
|
|
341
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
342
|
isPublic: z.literal(true),
|
|
283
343
|
oAuthMetadata: z.undefined().optional()
|
|
284
344
|
});
|
|
285
|
-
|
|
286
|
-
* Protected environment with an external resource metadata URL
|
|
287
|
-
*
|
|
288
|
-
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
289
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
290
|
-
*/
|
|
291
|
-
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
345
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
346
|
isPublic: z.literal(false),
|
|
293
347
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
348
|
scope: z.string().optional()
|
|
295
349
|
});
|
|
296
|
-
|
|
297
|
-
* Protected environment with an external authorization server URL
|
|
298
|
-
*
|
|
299
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
300
|
-
* An external authorization server URL is returned when requesting the endpoint.
|
|
301
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
302
|
-
*/
|
|
303
|
-
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
350
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
351
|
isPublic: z.literal(false),
|
|
305
352
|
oAuthMetadata: z.object({
|
|
306
353
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +355,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
355
|
}),
|
|
309
356
|
scope: z.string().optional()
|
|
310
357
|
});
|
|
311
|
-
|
|
312
|
-
* Standalone protected environment
|
|
313
|
-
*
|
|
314
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
315
|
-
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
316
|
-
*/
|
|
317
|
-
const standaloneEnvironmentSchema = z.object({
|
|
358
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
359
|
isPublic: z.literal(false),
|
|
319
360
|
oAuthMetadata: z.object({
|
|
320
361
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +363,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
363
|
}),
|
|
323
364
|
scope: z.string().optional()
|
|
324
365
|
});
|
|
325
|
-
|
|
326
|
-
* Protected environment without OAuth discovery
|
|
327
|
-
*
|
|
328
|
-
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
329
|
-
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
330
|
-
* are advertised. Clients must obtain credentials out-of-band.
|
|
331
|
-
*/
|
|
332
|
-
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
366
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
367
|
isPublic: z.literal(false),
|
|
334
368
|
oAuthMetadata: z.strictObject({}),
|
|
335
369
|
scope: z.string().optional()
|
|
@@ -339,11 +373,21 @@ z.union([
|
|
|
339
373
|
externalResourceMetadataEnvironmentSchema,
|
|
340
374
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
375
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
376
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
377
|
+
legacyPublicEnvironmentSchema,
|
|
378
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
379
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
380
|
+
legacyStandaloneEnvironmentSchema,
|
|
381
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
382
|
+
]);
|
|
383
|
+
const playgroundModelSchema = z.enum([
|
|
384
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
385
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
386
|
+
"openai.gpt-5.4",
|
|
387
|
+
"openai.gpt-5.5"
|
|
343
388
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
389
|
const environmentDomainSchema = z.object({
|
|
346
|
-
|
|
390
|
+
name: z.string(),
|
|
347
391
|
status: z.enum([
|
|
348
392
|
"ongoing",
|
|
349
393
|
"deployed",
|
|
@@ -361,6 +405,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
405
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
406
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
407
|
isPlaygroundEnabled: z.boolean(),
|
|
408
|
+
playgroundModel: playgroundModelSchema,
|
|
364
409
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
410
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
411
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -373,14 +418,17 @@ z.object({
|
|
|
373
418
|
sessionReplayEnabled: z.boolean(),
|
|
374
419
|
collectRequestPayload: z.boolean(),
|
|
375
420
|
collectResponsePayload: z.boolean(),
|
|
376
|
-
collectErrorMessage: z.boolean()
|
|
421
|
+
collectErrorMessage: z.boolean(),
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
377
424
|
});
|
|
378
|
-
z.object({
|
|
425
|
+
const feedbackSchema = z.object({
|
|
379
426
|
id: z.string(),
|
|
380
427
|
createdAt: z.coerce.date(),
|
|
381
428
|
environmentId: z.string(),
|
|
382
429
|
content: z.string(),
|
|
383
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
384
432
|
});
|
|
385
433
|
z.object({
|
|
386
434
|
content: z.string(),
|
|
@@ -396,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
396
444
|
"pink",
|
|
397
445
|
"gray"
|
|
398
446
|
]);
|
|
399
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
400
448
|
const intentCategorySchema = z.object({
|
|
401
449
|
id: z.string(),
|
|
402
450
|
createdAt: z.coerce.date(),
|
|
@@ -404,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
404
452
|
name: z.string(),
|
|
405
453
|
color: intentCategoryColorSchema
|
|
406
454
|
});
|
|
407
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
408
456
|
id: z.string(),
|
|
409
457
|
name: z.string(),
|
|
410
458
|
color: intentCategoryColorSchema,
|
|
@@ -416,6 +464,7 @@ z.object({
|
|
|
416
464
|
environmentId: z.string(),
|
|
417
465
|
toolName: z.string(),
|
|
418
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
419
468
|
categories: z.array(intentCategorySchema)
|
|
420
469
|
});
|
|
421
470
|
const signalCategorySchema = z.object({
|
|
@@ -474,12 +523,262 @@ z.object({
|
|
|
474
523
|
createdAt: z.coerce.date(),
|
|
475
524
|
updatedAt: z.coerce.date()
|
|
476
525
|
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
477
536
|
z.enum([
|
|
478
537
|
"INFO",
|
|
479
538
|
"WARNING",
|
|
480
539
|
"DEBUG",
|
|
481
540
|
"ERROR"
|
|
482
541
|
]);
|
|
542
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
|
+
const MCP_CLIENT_GROUPS = [
|
|
544
|
+
{
|
|
545
|
+
id: "claude_code",
|
|
546
|
+
label: "Claude Code",
|
|
547
|
+
vendor: "anthropic",
|
|
548
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
id: "claude",
|
|
552
|
+
label: "Claude",
|
|
553
|
+
vendor: "anthropic",
|
|
554
|
+
rawNames: [
|
|
555
|
+
"Anthropic/ClaudeAI",
|
|
556
|
+
"claude-ai",
|
|
557
|
+
"claude",
|
|
558
|
+
"Claude",
|
|
559
|
+
"claude-desktop",
|
|
560
|
+
"claude-desktop-3p"
|
|
561
|
+
]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "claude_mobile",
|
|
565
|
+
label: "Claude mobile",
|
|
566
|
+
vendor: "anthropic",
|
|
567
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
id: "claude_cowork",
|
|
571
|
+
label: "Claude Cowork",
|
|
572
|
+
vendor: "anthropic",
|
|
573
|
+
rawNames: ["Anthropic/Cowork"]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "claude_toolbox",
|
|
577
|
+
label: "Claude Toolbox",
|
|
578
|
+
vendor: "anthropic",
|
|
579
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "anthropic_api",
|
|
583
|
+
label: "Anthropic API",
|
|
584
|
+
vendor: "anthropic",
|
|
585
|
+
rawNames: ["Anthropic/API"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "anthropic_connector_refresh",
|
|
589
|
+
label: "Anthropic (connector refresh)",
|
|
590
|
+
vendor: "anthropic",
|
|
591
|
+
rawNames: ["Anthropic"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "codex",
|
|
595
|
+
label: "Codex",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: [
|
|
598
|
+
"codex-mcp-client",
|
|
599
|
+
"codex",
|
|
600
|
+
"Codex",
|
|
601
|
+
"codex-cli",
|
|
602
|
+
"openai-mcp (Codex)"
|
|
603
|
+
]
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
id: "chatgpt",
|
|
607
|
+
label: "ChatGPT",
|
|
608
|
+
vendor: "openai",
|
|
609
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
id: "openai_responses_api",
|
|
613
|
+
label: "OpenAI Responses API",
|
|
614
|
+
vendor: "openai",
|
|
615
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
id: "openai_agent_builder",
|
|
619
|
+
label: "OpenAI Agent Builder",
|
|
620
|
+
vendor: "openai",
|
|
621
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
id: "openai_other",
|
|
625
|
+
label: "OpenAI Other",
|
|
626
|
+
vendor: "openai",
|
|
627
|
+
rawNames: ["openai-mcp"]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cursor",
|
|
631
|
+
label: "Cursor",
|
|
632
|
+
vendor: "cursor",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"cursor-vscode",
|
|
635
|
+
"Cursor",
|
|
636
|
+
"cursor"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "cline",
|
|
641
|
+
label: "Cline",
|
|
642
|
+
vendor: "cline",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Cline",
|
|
645
|
+
"cline",
|
|
646
|
+
"@cline/core"
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
id: "github_copilot",
|
|
651
|
+
label: "GitHub Copilot",
|
|
652
|
+
vendor: "githubCopilot",
|
|
653
|
+
rawNames: [
|
|
654
|
+
"Copilot",
|
|
655
|
+
"github-copilot-developer",
|
|
656
|
+
"Copilot MCP Gateway",
|
|
657
|
+
"Xcode/copilot-xcode"
|
|
658
|
+
]
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
id: "gemini_cli",
|
|
662
|
+
label: "Gemini CLI",
|
|
663
|
+
vendor: "google",
|
|
664
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "antigravity",
|
|
668
|
+
label: "Antigravity",
|
|
669
|
+
vendor: "google",
|
|
670
|
+
rawNames: ["antigravity-client"]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "gemini",
|
|
674
|
+
label: "Gemini",
|
|
675
|
+
vendor: "google",
|
|
676
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
id: "windsurf",
|
|
680
|
+
label: "Windsurf",
|
|
681
|
+
vendor: "windsurf",
|
|
682
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
id: "mistral",
|
|
686
|
+
label: "Mistral / Le Chat",
|
|
687
|
+
vendor: "mistral",
|
|
688
|
+
rawNames: ["Mistral"],
|
|
689
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "n8n",
|
|
693
|
+
label: "n8n",
|
|
694
|
+
vendor: "n8n",
|
|
695
|
+
rawNames: [
|
|
696
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
698
|
+
"n8n"
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "alpic_playground",
|
|
703
|
+
label: "Alpic Playground",
|
|
704
|
+
vendor: "alpic",
|
|
705
|
+
rawNames: ["alpic-playground", "playground"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "opencode",
|
|
709
|
+
label: "opencode",
|
|
710
|
+
vendor: "opencode",
|
|
711
|
+
rawNames: ["opencode"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "zed",
|
|
715
|
+
label: "Zed",
|
|
716
|
+
vendor: "zed",
|
|
717
|
+
rawNames: ["Zed", "zed"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "zapier",
|
|
721
|
+
label: "Zapier",
|
|
722
|
+
vendor: "zapier",
|
|
723
|
+
rawNames: ["Zapier", "zapier"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "make",
|
|
727
|
+
label: "Make",
|
|
728
|
+
vendor: "make",
|
|
729
|
+
rawNames: ["Make", "make"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "librechat",
|
|
733
|
+
label: "LibreChat",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["LibreChat", "librechat"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "jan",
|
|
739
|
+
label: "Jan",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: ["Jan", "jan"]
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
id: "goose",
|
|
745
|
+
label: "goose",
|
|
746
|
+
vendor: "mcp",
|
|
747
|
+
rawNames: ["goose", "Goose"]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
id: "mcphost",
|
|
751
|
+
label: "mcphost",
|
|
752
|
+
vendor: "mcp",
|
|
753
|
+
rawNames: ["mcphost"]
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
id: "mcporter",
|
|
757
|
+
label: "mcporter",
|
|
758
|
+
vendor: "mcp",
|
|
759
|
+
rawNames: ["mcporter"]
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
id: "rmcp",
|
|
763
|
+
label: "rmcp",
|
|
764
|
+
vendor: "mcp",
|
|
765
|
+
rawNames: ["rmcp"]
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
id: "unnamed_client",
|
|
769
|
+
label: "Unnamed client",
|
|
770
|
+
vendor: "mcp",
|
|
771
|
+
rawNames: [
|
|
772
|
+
"mcp",
|
|
773
|
+
"unknown",
|
|
774
|
+
""
|
|
775
|
+
]
|
|
776
|
+
}
|
|
777
|
+
];
|
|
778
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
779
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
780
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
781
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
483
782
|
const runtimeSchema = z.enum([
|
|
484
783
|
"python3.13",
|
|
485
784
|
"python3.14",
|
|
@@ -508,15 +807,27 @@ z.object({
|
|
|
508
807
|
environments: z.array(environmentWithDomainsSchema),
|
|
509
808
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
510
809
|
});
|
|
810
|
+
const domainFailureReasonSchema = z.enum([
|
|
811
|
+
"caa",
|
|
812
|
+
"dns",
|
|
813
|
+
"invalid_domain",
|
|
814
|
+
"other"
|
|
815
|
+
]);
|
|
816
|
+
const projectDomainMappingSchema = z.object({
|
|
817
|
+
pathPrefix: z.string(),
|
|
818
|
+
environment: environmentSchema$1
|
|
819
|
+
});
|
|
511
820
|
z.object({
|
|
512
|
-
|
|
821
|
+
name: z.string(),
|
|
513
822
|
createdAt: z.coerce.date(),
|
|
514
823
|
status: z.enum([
|
|
515
824
|
"ongoing",
|
|
516
825
|
"deployed",
|
|
517
826
|
"failed"
|
|
518
827
|
]),
|
|
519
|
-
|
|
828
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
829
|
+
environment: environmentSchema$1,
|
|
830
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
520
831
|
});
|
|
521
832
|
const serverFieldsSchema$1 = z.object({
|
|
522
833
|
$schema: z.string(),
|
|
@@ -545,15 +856,7 @@ z.object({
|
|
|
545
856
|
serverFields: serverFieldsSchema$1,
|
|
546
857
|
source: z.enum(["registry", "defaults"])
|
|
547
858
|
});
|
|
548
|
-
/**
|
|
549
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
550
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
551
|
-
*
|
|
552
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
553
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
554
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
555
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
556
|
-
*/
|
|
859
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
557
860
|
const clampStringField = (field) => {
|
|
558
861
|
const max = field.maxLength;
|
|
559
862
|
if (max === null) return field;
|
|
@@ -561,6 +864,10 @@ const clampStringField = (field) => {
|
|
|
561
864
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
562
865
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
563
866
|
};
|
|
867
|
+
const unboundedArrayField = (field) => {
|
|
868
|
+
const unbounded = z.array(field.element);
|
|
869
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
870
|
+
};
|
|
564
871
|
const toolDefinitionSchema = z.object({
|
|
565
872
|
name: z.string(),
|
|
566
873
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -573,17 +880,31 @@ const toolDefinitionSchema = z.object({
|
|
|
573
880
|
}).optional()
|
|
574
881
|
});
|
|
575
882
|
const positiveTestCaseSchema = z.object({
|
|
576
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
577
|
-
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
883
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
884
|
+
userPrompt: z.string().min(1).describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
578
885
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
579
886
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
580
|
-
}).
|
|
887
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
888
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
889
|
+
scenario: z.string().optional(),
|
|
890
|
+
userPrompt: z.string().optional()
|
|
891
|
+
});
|
|
892
|
+
const blankPositiveTestCase = () => ({
|
|
893
|
+
scenario: "",
|
|
894
|
+
userPrompt: "",
|
|
895
|
+
toolTriggered: "",
|
|
896
|
+
expectedOutput: ""
|
|
897
|
+
});
|
|
898
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
581
899
|
const screenshotEntrySchema = z.object({
|
|
582
900
|
prompt: z.string(),
|
|
583
|
-
url: z.url()
|
|
901
|
+
url: z.url()
|
|
584
902
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
903
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
585
904
|
/** Accepts either a valid email or URL. */
|
|
586
905
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
906
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
907
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
587
908
|
const chatgptCategorySchema = z.enum([
|
|
588
909
|
"BUSINESS",
|
|
589
910
|
"COLLABORATION",
|
|
@@ -887,20 +1208,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
887
1208
|
"zh-TW"
|
|
888
1209
|
]);
|
|
889
1210
|
const negativeTestCaseSchema = z.object({
|
|
890
|
-
scenario: z.string(),
|
|
891
|
-
userPrompt: z.string()
|
|
892
|
-
}).
|
|
1211
|
+
scenario: z.string().min(1),
|
|
1212
|
+
userPrompt: z.string().min(1)
|
|
1213
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1214
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1215
|
+
scenario: z.string().optional(),
|
|
1216
|
+
userPrompt: z.string().optional()
|
|
1217
|
+
});
|
|
1218
|
+
const blankNegativeTestCase = () => ({
|
|
1219
|
+
scenario: "",
|
|
1220
|
+
userPrompt: ""
|
|
1221
|
+
});
|
|
1222
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
893
1223
|
const chatgptToolJustificationSchema = z.object({
|
|
894
1224
|
toolName: z.string(),
|
|
895
1225
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
896
1226
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
897
1227
|
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
898
1228
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
899
|
-
/**
|
|
900
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
901
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
902
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
903
|
-
*/
|
|
1229
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
904
1230
|
const chatgptTaglineSchema = z.string().max(30);
|
|
905
1231
|
const chatgptDescriptionSchema = z.string();
|
|
906
1232
|
const chatgptTranslationSchema = z.object({
|
|
@@ -909,10 +1235,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
909
1235
|
description: chatgptDescriptionSchema
|
|
910
1236
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
911
1237
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
912
|
-
/**
|
|
913
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
914
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
915
|
-
*/
|
|
1238
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
916
1239
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
917
1240
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
918
1241
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
@@ -921,40 +1244,64 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
921
1244
|
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
922
1245
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
923
1246
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
924
|
-
companyUrl:
|
|
1247
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
925
1248
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
926
|
-
privacyPolicyUrl:
|
|
927
|
-
termsOfServiceUrl:
|
|
928
|
-
demoRecordingUrl:
|
|
1249
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1250
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1251
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
929
1252
|
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
|
|
930
|
-
serverUrl:
|
|
1253
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
931
1254
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
932
1255
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
933
1256
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
1257
|
+
skills: z.array(chatgptSkillSchema).optional().describe("Skills the server exposes over MCP (auto-populated from the production server's manifest). Left unset when the server does not advertise the skills extension, which is a different state from advertising it and exposing none."),
|
|
1258
|
+
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."),
|
|
1259
|
+
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."),
|
|
1260
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
937
1261
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
938
1262
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
939
1263
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
940
1264
|
});
|
|
941
|
-
chatgptSubmissionFormDataSchema.
|
|
1265
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1266
|
+
tagline: z.string().optional(),
|
|
1267
|
+
companyUrl: z.string().optional(),
|
|
1268
|
+
supportChannel: z.string().optional(),
|
|
1269
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1270
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1271
|
+
demoRecordingUrl: z.string().optional(),
|
|
1272
|
+
serverUrl: z.string().optional(),
|
|
1273
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1274
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1275
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1276
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1277
|
+
});
|
|
1278
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1279
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
942
1280
|
appName: true,
|
|
943
1281
|
developerName: true,
|
|
944
1282
|
serverUrl: true,
|
|
945
1283
|
tools: true,
|
|
1284
|
+
skills: true,
|
|
946
1285
|
authentication: true
|
|
947
1286
|
});
|
|
948
|
-
|
|
1287
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1288
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
949
1289
|
tagline: true,
|
|
950
1290
|
description: true,
|
|
951
1291
|
category: true,
|
|
952
1292
|
testCases: true,
|
|
953
1293
|
negativeTestCases: true,
|
|
954
1294
|
toolJustifications: true
|
|
955
|
-
}).extend({
|
|
1295
|
+
}).extend({
|
|
1296
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1297
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1298
|
+
}).extend({
|
|
1299
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1300
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1301
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1302
|
+
});
|
|
956
1303
|
const claudeCategorySchema = z.enum([
|
|
957
|
-
"
|
|
1304
|
+
"Productivity",
|
|
958
1305
|
"Communication",
|
|
959
1306
|
"Data & Analytics",
|
|
960
1307
|
"Development tools",
|
|
@@ -962,222 +1309,222 @@ const claudeCategorySchema = z.enum([
|
|
|
962
1309
|
"Consumer Health",
|
|
963
1310
|
"Health & Life Sciences",
|
|
964
1311
|
"Media & Entertainment",
|
|
965
|
-
"Commerce & Shopping"
|
|
1312
|
+
"Commerce & Shopping",
|
|
1313
|
+
"Legal",
|
|
1314
|
+
"Sales and marketing",
|
|
1315
|
+
"Creative",
|
|
1316
|
+
"Nonprofit",
|
|
1317
|
+
"Education",
|
|
1318
|
+
"Other"
|
|
966
1319
|
]);
|
|
967
|
-
const
|
|
968
|
-
"No auth needed",
|
|
969
|
-
"OAuth 2.0",
|
|
970
|
-
"Custom URL"
|
|
971
|
-
]);
|
|
972
|
-
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
973
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1320
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
974
1321
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
975
|
-
"
|
|
976
|
-
"
|
|
977
|
-
"
|
|
978
|
-
]);
|
|
979
|
-
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
980
|
-
const claudeTestedSurfaceSchema = z.enum([
|
|
981
|
-
"Claude.ai (web)",
|
|
982
|
-
"Claude Desktop",
|
|
983
|
-
"Claude Code",
|
|
984
|
-
"Cowork"
|
|
1322
|
+
"read_only",
|
|
1323
|
+
"write_only",
|
|
1324
|
+
"read_write"
|
|
985
1325
|
]);
|
|
986
|
-
const
|
|
987
|
-
"
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"
|
|
1326
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1327
|
+
"oauth_dcr",
|
|
1328
|
+
"oauth_cimd",
|
|
1329
|
+
"oauth_anthropic_creds",
|
|
1330
|
+
"custom_connection",
|
|
1331
|
+
"none"
|
|
992
1332
|
]);
|
|
993
|
-
const
|
|
994
|
-
"
|
|
995
|
-
"
|
|
996
|
-
"
|
|
997
|
-
"GDPR compliant (if applicable)"
|
|
1333
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1334
|
+
"first_party",
|
|
1335
|
+
"proxied",
|
|
1336
|
+
"third_party"
|
|
998
1337
|
]);
|
|
999
|
-
const
|
|
1000
|
-
|
|
1001
|
-
"
|
|
1002
|
-
"
|
|
1338
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1339
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1340
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1341
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1342
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1343
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1344
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1345
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1346
|
+
"Public documentation for this connector will be live by the publish date."
|
|
1003
1347
|
]);
|
|
1004
|
-
/**
|
|
1005
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
1006
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
1007
|
-
*/
|
|
1348
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1008
1349
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
(
|
|
1019
|
-
|
|
1020
|
-
(
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
•
|
|
1038
|
-
•
|
|
1039
|
-
•
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
• '
|
|
1055
|
-
• '
|
|
1056
|
-
• '
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
• 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
|
|
1087
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
1088
|
-
serverDocumentationLink: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. This is displayed in the Directory listing and must be publicly accessible without login. Minimum requirements for the docs page:
|
|
1089
|
-
• What the connector does and its key capabilities
|
|
1090
|
-
• How to connect/set it up (step by step)
|
|
1091
|
-
• What each tool does (or at least the main ones)
|
|
1092
|
-
• How to troubleshoot common issues
|
|
1093
|
-
• A support contact or channel
|
|
1094
|
-
Acceptable formats: a dedicated docs page, a help center article, a README on GitHub, or a blog post — as long as it's comprehensive. Note: Anthropic requires public documentation to be live by your publish date.`),
|
|
1095
|
-
privacyPolicyUrl: z.url().describe(`URL to your privacy policy. This is mandatory and displayed in the directory listing. Missing or incomplete privacy policies result in immediate rejection. Your privacy policy must cover:
|
|
1096
|
-
• What data you collect (and how)
|
|
1097
|
-
• How you use the collected data
|
|
1098
|
-
• Where and how long you store it
|
|
1099
|
-
• Whether you share data with third parties (and who)
|
|
1100
|
-
• How users can contact you about data concerns
|
|
1101
|
-
The policy must be publicly accessible. If you don't have one yet, create one before submitting — there are free generators online, but make sure it accurately reflects your actual practices. If you're GDPR-compliant, your policy should reflect that.`),
|
|
1102
|
-
supportChannel: supportChannelSchema.describe(`A URL or email address where users can get help with your connector. This is displayed in the Directory listing. Acceptable options:
|
|
1103
|
-
• Email address (e.g. support@myapp.com)
|
|
1104
|
-
• Link to a GitHub Issues page
|
|
1105
|
-
• Link to a help center or support article
|
|
1106
|
-
• Link to a Discord/Slack community
|
|
1107
|
-
• Link to your documentation's troubleshooting section
|
|
1108
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1109
|
-
testingCredentials: z.string().describe(`Provide login credentials for a test account that Anthropic reviewers can use to verify your server works end-to-end. Critical requirements:
|
|
1110
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
1111
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
1112
|
-
• If your service uses Google OAuth or another OAuth that requires email verification, use mcp-review@anthropic.com as the account email — Anthropic has access to this inbox.
|
|
1113
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
1114
|
-
• If your service requires API keys instead of a password, provide those.
|
|
1115
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
1116
|
-
tools: z.array(toolDefinitionSchema).describe(`A comma-separated list of all tools your MCP server exposes. Use the format: tool_name (Human-Readable Name). The tool_name is the internal identifier (snake_case, max 64 characters). The Human-Readable Name is what users see.
|
|
1117
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
1118
|
-
Reviewers test every single tool you list here — don't list tools that don't work. Also: do not have a single catch-all tool like api_request(method, endpoint) — Anthropic rejects these. Each action should be its own purpose-built tool.`),
|
|
1119
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
1120
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
1121
|
-
• 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
|
|
1122
|
-
This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
|
|
1123
|
-
testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
|
|
1124
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
1125
|
-
• Format: SVG only
|
|
1126
|
-
• Aspect ratio: square (1:1)
|
|
1127
|
-
• Should work on a light background
|
|
1128
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
1129
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
1130
|
-
logoDark: z.string().optional().describe(`Optional dark-mode variant of the connector logo. Same specs as the light variant (SVG, square 1:1) but designed to read on a dark background. Leave empty if the light logo already works on dark.`),
|
|
1131
|
-
screenshots: z.array(screenshotEntrySchema).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
|
|
1132
|
-
• 3–5 images is ideal
|
|
1133
|
-
• Minimum 1000px width, PNG format preferred
|
|
1134
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
1135
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
1136
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
1137
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
1138
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1139
|
-
});
|
|
1140
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1141
|
-
companyName: true,
|
|
1142
|
-
appName: true,
|
|
1143
|
-
mcpUrlType: true,
|
|
1350
|
+
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
|
|
1351
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1352
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1353
|
+
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
|
|
1354
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1355
|
+
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.
|
|
1356
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1357
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1358
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1359
|
+
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
|
|
1360
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1361
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1362
|
+
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
|
|
1363
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1364
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1365
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1366
|
+
by your publish date.`),
|
|
1367
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1368
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1369
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1370
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1371
|
+
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
|
|
1372
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1373
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1374
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1375
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1376
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1377
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1378
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1379
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1380
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1381
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1382
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1383
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1384
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1385
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1386
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1387
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1388
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1389
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1390
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1391
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1392
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1393
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1394
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1395
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1396
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1397
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1398
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1399
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1400
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1401
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1402
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1403
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1404
|
+
fully populated account.`),
|
|
1405
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1406
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1407
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1408
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1409
|
+
});
|
|
1410
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1411
|
+
serverUrl: z.string().optional(),
|
|
1412
|
+
name: z.string().optional(),
|
|
1413
|
+
slug: z.string().optional(),
|
|
1414
|
+
oneLiner: z.string().optional(),
|
|
1415
|
+
description: z.string().optional(),
|
|
1416
|
+
iconUrl: z.string().optional(),
|
|
1417
|
+
documentation: z.string().optional(),
|
|
1418
|
+
support: z.string().optional(),
|
|
1419
|
+
privacyPolicy: z.string().optional(),
|
|
1420
|
+
companyWebsite: z.string().optional(),
|
|
1421
|
+
primaryContactEmail: z.string().optional(),
|
|
1422
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1423
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1424
|
+
});
|
|
1425
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1426
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1144
1427
|
serverUrl: true,
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
transportSupport: true,
|
|
1428
|
+
name: true,
|
|
1429
|
+
slug: true,
|
|
1430
|
+
companyName: true,
|
|
1149
1431
|
primaryContactEmail: true,
|
|
1150
1432
|
primaryContactName: true,
|
|
1433
|
+
readWriteCapabilities: true,
|
|
1151
1434
|
authentication: true,
|
|
1152
|
-
|
|
1153
|
-
|
|
1435
|
+
apiOwnership: true,
|
|
1436
|
+
personalHealthData: true
|
|
1154
1437
|
}).extend({
|
|
1155
1438
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1156
|
-
|
|
1439
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1440
|
+
});
|
|
1441
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1442
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1443
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1444
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1445
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1446
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1447
|
+
});
|
|
1448
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1449
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1450
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1451
|
+
});
|
|
1452
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1453
|
+
const byField = {};
|
|
1454
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1455
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1456
|
+
return byField;
|
|
1457
|
+
}
|
|
1458
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1459
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1460
|
+
"pass",
|
|
1461
|
+
"fail",
|
|
1462
|
+
"unverified"
|
|
1463
|
+
]);
|
|
1464
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1465
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1466
|
+
claudeai: ["privacyPolicy"]
|
|
1467
|
+
};
|
|
1468
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1469
|
+
const policyDisclosureSchema = z.enum([
|
|
1470
|
+
"dataCategories",
|
|
1471
|
+
"purposesOfUse",
|
|
1472
|
+
"recipients",
|
|
1473
|
+
"retention"
|
|
1474
|
+
]);
|
|
1475
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1476
|
+
field: verifiableUrlFieldSchema,
|
|
1477
|
+
url: z.string(),
|
|
1478
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1479
|
+
reason: z.string(),
|
|
1480
|
+
concerns: z.array(z.string()).optional(),
|
|
1481
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1482
|
+
});
|
|
1483
|
+
const urlVerificationSchema = z.object({
|
|
1484
|
+
verifiedAt: z.coerce.date(),
|
|
1485
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1486
|
+
});
|
|
1487
|
+
const pageKindSchema = z.enum([
|
|
1488
|
+
"expectedDocument",
|
|
1489
|
+
"errorPage",
|
|
1490
|
+
"loginWall",
|
|
1491
|
+
"parkedDomain",
|
|
1492
|
+
"comingSoon",
|
|
1493
|
+
"marketingPage",
|
|
1494
|
+
"unrelatedDocument"
|
|
1495
|
+
]);
|
|
1496
|
+
z.object({
|
|
1497
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1498
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1499
|
+
missingDisclosures: z.array(policyDisclosureSchema).describe("For a privacy policy only: which of the four required disclosures the text does not cover. Empty for every other page kind.")
|
|
1157
1500
|
});
|
|
1158
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1159
|
-
tagline: true,
|
|
1160
|
-
description: true,
|
|
1161
|
-
category: true,
|
|
1162
|
-
testCases: true
|
|
1163
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1164
1501
|
const submissionMetaFieldsSchema = z.object({
|
|
1165
1502
|
id: z.string(),
|
|
1166
1503
|
environmentId: z.string(),
|
|
1167
1504
|
auditId: z.string().nullable(),
|
|
1505
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1168
1506
|
createdAt: z.coerce.date(),
|
|
1169
1507
|
updatedAt: z.coerce.date()
|
|
1170
1508
|
});
|
|
1171
1509
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1172
1510
|
platform: z.literal("claudeai"),
|
|
1173
|
-
formData:
|
|
1511
|
+
formData: claudeSubmissionDraftSchema,
|
|
1512
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1174
1513
|
});
|
|
1175
1514
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1176
1515
|
platform: z.literal("chatgpt"),
|
|
1177
|
-
formData:
|
|
1516
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1517
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1178
1518
|
});
|
|
1179
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1180
|
-
z.union([
|
|
1519
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1520
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1521
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1522
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1523
|
+
z.literal([
|
|
1524
|
+
100,
|
|
1525
|
+
75,
|
|
1526
|
+
50
|
|
1527
|
+
]);
|
|
1181
1528
|
const subscriptionPlanSchema = z.enum([
|
|
1182
1529
|
"pro",
|
|
1183
1530
|
"business",
|
|
@@ -1189,17 +1536,76 @@ const customerCreditsSchema = z.object({
|
|
|
1189
1536
|
expiresAt: z.number().nullable(),
|
|
1190
1537
|
currency: z.string()
|
|
1191
1538
|
});
|
|
1192
|
-
const customerUsageSchema = z.object({
|
|
1193
|
-
amountInCents: z.number(),
|
|
1194
|
-
currency: z.string(),
|
|
1195
|
-
periodEnd: z.number()
|
|
1196
|
-
});
|
|
1197
1539
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1198
1540
|
z.object({
|
|
1199
1541
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1200
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1201
1542
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1202
1543
|
});
|
|
1544
|
+
const metricsQueueEventSchema = z.object({
|
|
1545
|
+
ts: z.number().int(),
|
|
1546
|
+
method: z.string(),
|
|
1547
|
+
tool: z.string().nullable(),
|
|
1548
|
+
client: z.string(),
|
|
1549
|
+
sessionId: z.string().nullable(),
|
|
1550
|
+
durationMs: z.number().int(),
|
|
1551
|
+
outputTokens: z.number().int().nullable(),
|
|
1552
|
+
errorType: z.enum([
|
|
1553
|
+
"mcp_error",
|
|
1554
|
+
"tool_error",
|
|
1555
|
+
"timeout"
|
|
1556
|
+
]).nullable(),
|
|
1557
|
+
errorCode: z.number().int().nullable()
|
|
1558
|
+
});
|
|
1559
|
+
z.object({
|
|
1560
|
+
v: z.literal(1),
|
|
1561
|
+
envId: z.string(),
|
|
1562
|
+
events: z.array(metricsQueueEventSchema)
|
|
1563
|
+
});
|
|
1564
|
+
z.object({ v: z.number() });
|
|
1565
|
+
const telemetrySignalSchema = z.enum([
|
|
1566
|
+
"logs",
|
|
1567
|
+
"metrics",
|
|
1568
|
+
"traces"
|
|
1569
|
+
]);
|
|
1570
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1571
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1572
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1573
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1574
|
+
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");
|
|
1575
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1576
|
+
id: z.string(),
|
|
1577
|
+
name: otlpHeaderNameSchema,
|
|
1578
|
+
value: otlpHeaderValueSchema,
|
|
1579
|
+
isSecret: z.boolean()
|
|
1580
|
+
});
|
|
1581
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1582
|
+
"credentials",
|
|
1583
|
+
"wrong-path",
|
|
1584
|
+
"wrong-protocol",
|
|
1585
|
+
"invalid-payload",
|
|
1586
|
+
"partial-rejection",
|
|
1587
|
+
"blocked-target",
|
|
1588
|
+
"timeout",
|
|
1589
|
+
"unreachable",
|
|
1590
|
+
"receiver-error",
|
|
1591
|
+
"unexpected-status"
|
|
1592
|
+
]);
|
|
1593
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1594
|
+
z.object({
|
|
1595
|
+
id: z.string(),
|
|
1596
|
+
signal: telemetrySignalSchema,
|
|
1597
|
+
endpoint: otlpEndpointSchema,
|
|
1598
|
+
protocol: otlpProtocolSchema,
|
|
1599
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1600
|
+
status: telemetryDestinationStatusSchema,
|
|
1601
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1602
|
+
});
|
|
1603
|
+
//#endregion
|
|
1604
|
+
//#region src/auth-scope.ts
|
|
1605
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1606
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1607
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1608
|
+
const AUTH_SCOPE_USER = "user";
|
|
1203
1609
|
//#endregion
|
|
1204
1610
|
//#region src/schemas.ts
|
|
1205
1611
|
const RESERVED_KEYS = [
|
|
@@ -1236,7 +1642,10 @@ const RESERVED_KEYS = [
|
|
|
1236
1642
|
"BUILD_ARG_START_COMMAND",
|
|
1237
1643
|
"ALPIC_HOST",
|
|
1238
1644
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1239
|
-
"ALPIC_INTENT_META_KEY"
|
|
1645
|
+
"ALPIC_INTENT_META_KEY",
|
|
1646
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1647
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1648
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1240
1649
|
];
|
|
1241
1650
|
const environmentVariableSchema = z.object({
|
|
1242
1651
|
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"),
|
|
@@ -1289,6 +1698,14 @@ const serverFieldsSchema = z.object({
|
|
|
1289
1698
|
});
|
|
1290
1699
|
//#endregion
|
|
1291
1700
|
//#region src/api.contract.ts
|
|
1701
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1702
|
+
try {
|
|
1703
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1704
|
+
return true;
|
|
1705
|
+
} catch {
|
|
1706
|
+
return false;
|
|
1707
|
+
}
|
|
1708
|
+
};
|
|
1292
1709
|
const deploymentStatusSchema = z.enum([
|
|
1293
1710
|
"ongoing",
|
|
1294
1711
|
"deployed",
|
|
@@ -1317,21 +1734,20 @@ const deploymentSchema = z.object({
|
|
|
1317
1734
|
isCurrent: z.boolean(),
|
|
1318
1735
|
deploymentPageUrl: z.url().nullable()
|
|
1319
1736
|
});
|
|
1320
|
-
const
|
|
1737
|
+
const isValidTimeInput = (value) => {
|
|
1321
1738
|
if (ms(value) !== void 0) return true;
|
|
1322
1739
|
return !Number.isNaN(new Date(value).getTime());
|
|
1323
1740
|
};
|
|
1324
|
-
const
|
|
1741
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1742
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1743
|
+
const createEnvironmentContractV1 = base.route({
|
|
1325
1744
|
path: "/v1/environments",
|
|
1326
1745
|
method: "POST",
|
|
1327
1746
|
summary: "Create an environment",
|
|
1328
1747
|
description: "Create an environment for a project",
|
|
1329
1748
|
tags: ["environments"],
|
|
1330
1749
|
successDescription: "The environment has been created successfully"
|
|
1331
|
-
}).errors({
|
|
1332
|
-
NOT_FOUND: {},
|
|
1333
|
-
BAD_REQUEST: {}
|
|
1334
|
-
}).input(z.object({
|
|
1750
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1335
1751
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1336
1752
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1337
1753
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1344,7 +1760,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1344
1760
|
createdAt: z.coerce.date(),
|
|
1345
1761
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1346
1762
|
}));
|
|
1347
|
-
const getEnvironmentContractV1 =
|
|
1763
|
+
const getEnvironmentContractV1 = base.route({
|
|
1348
1764
|
path: "/v1/environments/{environmentId}",
|
|
1349
1765
|
method: "GET",
|
|
1350
1766
|
summary: "Get an environment",
|
|
@@ -1360,6 +1776,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1360
1776
|
createdAt: z.coerce.date(),
|
|
1361
1777
|
projectId: z.string()
|
|
1362
1778
|
}));
|
|
1779
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1780
|
+
path: "/v1/environments/{environmentId}",
|
|
1781
|
+
method: "DELETE",
|
|
1782
|
+
summary: "Delete an environment",
|
|
1783
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1784
|
+
tags: ["environments"],
|
|
1785
|
+
successDescription: "The environment has been deleted successfully"
|
|
1786
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1363
1787
|
const domainSchema = z.object({
|
|
1364
1788
|
domain: z.string(),
|
|
1365
1789
|
status: z.enum([
|
|
@@ -1401,7 +1825,7 @@ const projectOutputSchema = z.object({
|
|
|
1401
1825
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1402
1826
|
environments: z.array(environmentSchema)
|
|
1403
1827
|
});
|
|
1404
|
-
const getProjectContractV1 =
|
|
1828
|
+
const getProjectContractV1 = base.route({
|
|
1405
1829
|
path: "/v1/projects/{projectId}",
|
|
1406
1830
|
method: "GET",
|
|
1407
1831
|
summary: "Get a project",
|
|
@@ -1409,18 +1833,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1409
1833
|
tags: ["projects"],
|
|
1410
1834
|
successDescription: "The project details"
|
|
1411
1835
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1412
|
-
const listProjectsContractV1 =
|
|
1836
|
+
const listProjectsContractV1 = base.route({
|
|
1413
1837
|
path: "/v1/projects",
|
|
1414
1838
|
method: "GET",
|
|
1415
1839
|
summary: "List projects",
|
|
1416
1840
|
description: "List all projects for a team",
|
|
1417
1841
|
tags: ["projects"],
|
|
1418
1842
|
successDescription: "The list of projects"
|
|
1419
|
-
}).errors({
|
|
1420
|
-
|
|
1421
|
-
BAD_REQUEST: {}
|
|
1422
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1423
|
-
const createProjectContractV1 = oc.route({
|
|
1843
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1844
|
+
const createProjectContractV1 = base.route({
|
|
1424
1845
|
path: "/v1/projects",
|
|
1425
1846
|
method: "POST",
|
|
1426
1847
|
summary: "Create a project",
|
|
@@ -1429,7 +1850,7 @@ const createProjectContractV1 = oc.route({
|
|
|
1429
1850
|
successDescription: "The project has been created successfully"
|
|
1430
1851
|
}).errors({
|
|
1431
1852
|
NOT_FOUND: {},
|
|
1432
|
-
|
|
1853
|
+
FORBIDDEN: {}
|
|
1433
1854
|
}).input(z.object({
|
|
1434
1855
|
teamId: z.string().optional(),
|
|
1435
1856
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1469,7 +1890,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1469
1890
|
isSecret: z.boolean(),
|
|
1470
1891
|
createdAt: z.coerce.date()
|
|
1471
1892
|
});
|
|
1472
|
-
const listEnvironmentVariablesContractV1 =
|
|
1893
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1473
1894
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1474
1895
|
method: "GET",
|
|
1475
1896
|
summary: "List environment variables",
|
|
@@ -1477,48 +1898,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1477
1898
|
tags: ["environments"],
|
|
1478
1899
|
successDescription: "The list of environment variables"
|
|
1479
1900
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1480
|
-
const createEnvironmentVariablesContractV1 =
|
|
1901
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1481
1902
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1482
1903
|
method: "POST",
|
|
1483
1904
|
summary: "Add environment variables",
|
|
1484
1905
|
description: "Add one or more environment variables to an environment",
|
|
1485
1906
|
tags: ["environments"],
|
|
1486
1907
|
successDescription: "The environment variables have been added successfully"
|
|
1487
|
-
}).errors({
|
|
1488
|
-
NOT_FOUND: {},
|
|
1489
|
-
BAD_REQUEST: {}
|
|
1490
|
-
}).input(z.object({
|
|
1908
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1491
1909
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1492
1910
|
environmentVariables: environmentVariablesSchema
|
|
1493
1911
|
})).output(z.object({ success: z.literal(true) }));
|
|
1494
|
-
const updateEnvironmentVariableContractV1 =
|
|
1912
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1495
1913
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1496
1914
|
method: "PATCH",
|
|
1497
1915
|
summary: "Update an environment variable",
|
|
1498
1916
|
description: "Update an environment variable by ID",
|
|
1499
1917
|
tags: ["environments"],
|
|
1500
1918
|
successDescription: "The environment variable has been updated successfully"
|
|
1501
|
-
}).errors({
|
|
1502
|
-
NOT_FOUND: {},
|
|
1503
|
-
BAD_REQUEST: {}
|
|
1504
|
-
}).input(z.object({
|
|
1919
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1505
1920
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1506
1921
|
key: environmentVariableSchema.shape.key,
|
|
1507
1922
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1508
1923
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1509
1924
|
})).output(z.object({ success: z.literal(true) }));
|
|
1510
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1925
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1511
1926
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1512
1927
|
method: "DELETE",
|
|
1513
1928
|
summary: "Delete an environment variable",
|
|
1514
1929
|
description: "Delete an environment variable by ID",
|
|
1515
1930
|
tags: ["environments"],
|
|
1516
1931
|
successDescription: "The environment variable has been deleted successfully"
|
|
1517
|
-
}).errors({
|
|
1518
|
-
|
|
1519
|
-
BAD_REQUEST: {}
|
|
1520
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1521
|
-
const deleteProjectContractV1 = oc.route({
|
|
1932
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1933
|
+
const deleteProjectContractV1 = base.route({
|
|
1522
1934
|
path: "/v1/projects/{projectId}",
|
|
1523
1935
|
method: "DELETE",
|
|
1524
1936
|
summary: "Delete a project",
|
|
@@ -1526,7 +1938,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1526
1938
|
tags: ["projects"],
|
|
1527
1939
|
successDescription: "The project has been deleted successfully"
|
|
1528
1940
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1529
|
-
const updateProjectContractV1 =
|
|
1941
|
+
const updateProjectContractV1 = base.route({
|
|
1530
1942
|
path: "/v1/projects/{projectId}",
|
|
1531
1943
|
method: "PATCH",
|
|
1532
1944
|
summary: "Update a project",
|
|
@@ -1535,13 +1947,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1535
1947
|
successDescription: "The project has been updated successfully"
|
|
1536
1948
|
}).errors({
|
|
1537
1949
|
NOT_FOUND: {},
|
|
1538
|
-
|
|
1950
|
+
FORBIDDEN: {}
|
|
1539
1951
|
}).input(z.object({
|
|
1540
1952
|
projectId: z.string().describe("The ID of the project"),
|
|
1541
1953
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1542
1954
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1543
1955
|
})).output(projectOutputSchema);
|
|
1544
|
-
const deployEnvironmentContractV1 =
|
|
1956
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1545
1957
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1546
1958
|
method: "POST",
|
|
1547
1959
|
summary: "Deploy an environment",
|
|
@@ -1550,27 +1962,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1550
1962
|
successDescription: "The environment has been deployed successfully"
|
|
1551
1963
|
}).errors({
|
|
1552
1964
|
NOT_FOUND: {},
|
|
1553
|
-
|
|
1965
|
+
CONFLICT: {}
|
|
1554
1966
|
}).input(z.object({
|
|
1555
1967
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1556
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1968
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1969
|
+
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.")
|
|
1557
1970
|
})).output(deploymentSchema);
|
|
1558
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1971
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1559
1972
|
path: "/v1/deployments/upload",
|
|
1560
1973
|
method: "POST",
|
|
1561
1974
|
summary: "Upload deployment artifacts",
|
|
1562
1975
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1563
1976
|
tags: ["deployments"],
|
|
1564
1977
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1565
|
-
}).errors({
|
|
1566
|
-
NOT_FOUND: {},
|
|
1567
|
-
BAD_REQUEST: {}
|
|
1568
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1978
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1569
1979
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1570
1980
|
token: z.string().describe("Token to identify the source archive"),
|
|
1571
1981
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1572
1982
|
}));
|
|
1573
|
-
const listDeploymentsContractV1 =
|
|
1983
|
+
const listDeploymentsContractV1 = base.route({
|
|
1574
1984
|
path: "/v1/projects/{projectId}/deployments",
|
|
1575
1985
|
method: "GET",
|
|
1576
1986
|
summary: "List project deployments",
|
|
@@ -1582,7 +1992,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1582
1992
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1583
1993
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1584
1994
|
})).output(z.array(deploymentSchema));
|
|
1585
|
-
const getDeploymentContractV1 =
|
|
1995
|
+
const getDeploymentContractV1 = base.route({
|
|
1586
1996
|
path: "/v1/deployments/{deploymentId}",
|
|
1587
1997
|
method: "GET",
|
|
1588
1998
|
summary: "Get a deployment",
|
|
@@ -1590,20 +2000,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1590
2000
|
tags: ["deployments"],
|
|
1591
2001
|
successDescription: "The deployment details"
|
|
1592
2002
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1593
|
-
const
|
|
2003
|
+
const logEntrySchema = z.object({
|
|
2004
|
+
timestamp: z.coerce.date(),
|
|
2005
|
+
type: z.enum([
|
|
2006
|
+
"START",
|
|
2007
|
+
"END",
|
|
2008
|
+
"INFO",
|
|
2009
|
+
"ERROR",
|
|
2010
|
+
"WARNING",
|
|
2011
|
+
"DEBUG"
|
|
2012
|
+
]),
|
|
2013
|
+
requestId: z.string(),
|
|
2014
|
+
content: z.string().optional(),
|
|
2015
|
+
method: z.string().optional(),
|
|
2016
|
+
durationInMs: z.number().optional()
|
|
2017
|
+
});
|
|
2018
|
+
const getLogsContractV1 = base.route({
|
|
1594
2019
|
path: "/v1/environments/{environmentId}/logs",
|
|
1595
2020
|
method: "GET",
|
|
1596
2021
|
summary: "Get logs",
|
|
1597
2022
|
description: "Get logs for an environment",
|
|
1598
2023
|
tags: ["environments"],
|
|
1599
2024
|
successDescription: "The logs"
|
|
1600
|
-
}).errors({
|
|
1601
|
-
NOT_FOUND: {},
|
|
1602
|
-
BAD_REQUEST: {}
|
|
1603
|
-
}).input(z.object({
|
|
2025
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1604
2026
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1605
|
-
since:
|
|
1606
|
-
until:
|
|
2027
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2028
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1607
2029
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1608
2030
|
level: z.array(z.enum([
|
|
1609
2031
|
"INFO",
|
|
@@ -1614,34 +2036,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1614
2036
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1615
2037
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1616
2038
|
})).output(z.object({
|
|
1617
|
-
logs: z.array(
|
|
1618
|
-
timestamp: z.coerce.date(),
|
|
1619
|
-
type: z.enum([
|
|
1620
|
-
"START",
|
|
1621
|
-
"END",
|
|
1622
|
-
"INFO",
|
|
1623
|
-
"ERROR",
|
|
1624
|
-
"WARNING",
|
|
1625
|
-
"DEBUG"
|
|
1626
|
-
]),
|
|
1627
|
-
requestId: z.string(),
|
|
1628
|
-
content: z.string().optional(),
|
|
1629
|
-
method: z.string().optional(),
|
|
1630
|
-
durationInMs: z.number().optional()
|
|
1631
|
-
})),
|
|
2039
|
+
logs: z.array(logEntrySchema),
|
|
1632
2040
|
nextToken: z.string().nullable()
|
|
1633
2041
|
}));
|
|
1634
|
-
const getLatestLogsContractV1 =
|
|
2042
|
+
const getLatestLogsContractV1 = base.route({
|
|
1635
2043
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1636
2044
|
method: "GET",
|
|
1637
2045
|
summary: "Get latest logs",
|
|
1638
2046
|
description: "Get the N most recent logs for an environment",
|
|
1639
2047
|
tags: ["environments"],
|
|
1640
2048
|
successDescription: "The latest logs"
|
|
1641
|
-
}).errors({
|
|
1642
|
-
NOT_FOUND: {},
|
|
1643
|
-
BAD_REQUEST: {}
|
|
1644
|
-
}).input(z.object({
|
|
2049
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1645
2050
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1646
2051
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1647
2052
|
level: z.array(z.enum([
|
|
@@ -1651,22 +2056,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1651
2056
|
"DEBUG"
|
|
1652
2057
|
])).optional().describe("Filter by log level"),
|
|
1653
2058
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1654
|
-
})).output(z.object({ logs: z.array(
|
|
1655
|
-
|
|
1656
|
-
type: z.enum([
|
|
1657
|
-
"START",
|
|
1658
|
-
"END",
|
|
1659
|
-
"INFO",
|
|
1660
|
-
"ERROR",
|
|
1661
|
-
"WARNING",
|
|
1662
|
-
"DEBUG"
|
|
1663
|
-
]),
|
|
1664
|
-
requestId: z.string(),
|
|
1665
|
-
content: z.string().optional(),
|
|
1666
|
-
method: z.string().optional(),
|
|
1667
|
-
durationInMs: z.number().optional()
|
|
1668
|
-
})) }));
|
|
1669
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
2059
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
2060
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1670
2061
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1671
2062
|
method: "GET",
|
|
1672
2063
|
summary: "Get deployment logs",
|
|
@@ -1693,22 +2084,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1693
2084
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1694
2085
|
task_count: z.array(analyticsDataPointSchema)
|
|
1695
2086
|
});
|
|
1696
|
-
const getProjectAnalyticsContractV1 =
|
|
2087
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1697
2088
|
path: "/v1/analytics/{projectId}",
|
|
1698
2089
|
method: "GET",
|
|
1699
2090
|
summary: "Get project analytics",
|
|
1700
2091
|
description: "Get analytics data for a project over a time range",
|
|
1701
2092
|
tags: ["analytics"],
|
|
1702
2093
|
successDescription: "The project analytics data"
|
|
1703
|
-
}).errors({
|
|
1704
|
-
NOT_FOUND: {},
|
|
1705
|
-
BAD_REQUEST: {}
|
|
1706
|
-
}).input(z.object({
|
|
2094
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1707
2095
|
projectId: z.string().describe("The ID of the project"),
|
|
1708
2096
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1709
2097
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1710
2098
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1711
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2099
|
+
}).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({
|
|
1712
2100
|
metadata: z.object({
|
|
1713
2101
|
startTimestamp: z.number(),
|
|
1714
2102
|
endTimestamp: z.number(),
|
|
@@ -1718,7 +2106,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1718
2106
|
}),
|
|
1719
2107
|
timeSeries: analyticsTimeSeriesSchema
|
|
1720
2108
|
}));
|
|
1721
|
-
const
|
|
2109
|
+
const paginatedInsightsInputShape = {
|
|
2110
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2111
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2112
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2113
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2114
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2115
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2116
|
+
};
|
|
2117
|
+
const listIntentsContractV1 = base.route({
|
|
2118
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2119
|
+
method: "GET",
|
|
2120
|
+
summary: "List intents",
|
|
2121
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2122
|
+
tags: ["insights"],
|
|
2123
|
+
successDescription: "The grouped user intents"
|
|
2124
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2125
|
+
...paginatedInsightsInputShape,
|
|
2126
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2127
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2128
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2129
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2130
|
+
})).output(z.object({
|
|
2131
|
+
intents: z.array(z.object({
|
|
2132
|
+
id: z.string(),
|
|
2133
|
+
intentIds: z.array(z.string()).min(1),
|
|
2134
|
+
environmentId: z.string(),
|
|
2135
|
+
message: z.string(),
|
|
2136
|
+
toolName: z.string(),
|
|
2137
|
+
createdAt: z.coerce.date(),
|
|
2138
|
+
occurrenceCount: z.number().int().positive(),
|
|
2139
|
+
clientName: z.string().nullable(),
|
|
2140
|
+
clientId: z.string().nullable(),
|
|
2141
|
+
categories: z.array(z.object({
|
|
2142
|
+
id: z.string(),
|
|
2143
|
+
name: z.string(),
|
|
2144
|
+
color: intentCategoryColorSchema
|
|
2145
|
+
}))
|
|
2146
|
+
})),
|
|
2147
|
+
totalCount: z.number().int().nonnegative()
|
|
2148
|
+
}));
|
|
2149
|
+
const listFeedbacksContractV1 = base.route({
|
|
2150
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2151
|
+
method: "GET",
|
|
2152
|
+
summary: "List feedbacks",
|
|
2153
|
+
description: "List user feedback for an environment over a time range",
|
|
2154
|
+
tags: ["insights"],
|
|
2155
|
+
successDescription: "The user feedback"
|
|
2156
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2157
|
+
...paginatedInsightsInputShape,
|
|
2158
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2159
|
+
})).output(z.object({
|
|
2160
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2161
|
+
totalCount: z.number().int().nonnegative()
|
|
2162
|
+
}));
|
|
2163
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2164
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2165
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2166
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2167
|
+
method: "GET",
|
|
2168
|
+
summary: "List intent categories",
|
|
2169
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2170
|
+
tags: ["insights"],
|
|
2171
|
+
successDescription: "The intent categories"
|
|
2172
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2173
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2174
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2175
|
+
method: "POST",
|
|
2176
|
+
summary: "Create an intent category",
|
|
2177
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2178
|
+
tags: ["insights"],
|
|
2179
|
+
successDescription: "The created intent category"
|
|
2180
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2181
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2182
|
+
name: intentCategoryNameSchema,
|
|
2183
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2184
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2185
|
+
})).output(intentCategorySchema);
|
|
2186
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2187
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2188
|
+
method: "PATCH",
|
|
2189
|
+
summary: "Update an intent category",
|
|
2190
|
+
description: "Rename or recolor an intent category",
|
|
2191
|
+
tags: ["insights"],
|
|
2192
|
+
successDescription: "The updated intent category"
|
|
2193
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2194
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2195
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2196
|
+
name: intentCategoryNameSchema.optional(),
|
|
2197
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2198
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2199
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2200
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2201
|
+
method: "DELETE",
|
|
2202
|
+
summary: "Delete an intent category",
|
|
2203
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2204
|
+
tags: ["insights"],
|
|
2205
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2206
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2207
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2208
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2209
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2210
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2211
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2212
|
+
method: "POST",
|
|
2213
|
+
summary: "Link an intent category",
|
|
2214
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2215
|
+
tags: ["insights"],
|
|
2216
|
+
successDescription: "The intents have been linked successfully"
|
|
2217
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2218
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2219
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2220
|
+
intentIds: categorizableIntentIdsSchema
|
|
2221
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2222
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2223
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2224
|
+
method: "POST",
|
|
2225
|
+
summary: "Unlink an intent category",
|
|
2226
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2227
|
+
tags: ["insights"],
|
|
2228
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2229
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2230
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2231
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2232
|
+
intentIds: categorizableIntentIdsSchema
|
|
2233
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2234
|
+
const listTeamsContractV1 = base.route({
|
|
1722
2235
|
path: "/v1/teams",
|
|
1723
2236
|
method: "GET",
|
|
1724
2237
|
summary: "List teams",
|
|
@@ -1731,28 +2244,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
1731
2244
|
createdAt: z.coerce.date(),
|
|
1732
2245
|
hasStripeAccount: z.boolean()
|
|
1733
2246
|
})));
|
|
1734
|
-
const
|
|
2247
|
+
const getTeamUsageContractV1 = base.route({
|
|
2248
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2249
|
+
method: "GET",
|
|
2250
|
+
summary: "Get team usage",
|
|
2251
|
+
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.",
|
|
2252
|
+
tags: ["teams"],
|
|
2253
|
+
successDescription: "The current billing window usage"
|
|
2254
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2255
|
+
teamId: z.string(),
|
|
2256
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2257
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2258
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2259
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2260
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2261
|
+
}));
|
|
2262
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1735
2263
|
path: "/v1/tunnels/ticket",
|
|
1736
2264
|
method: "GET",
|
|
1737
2265
|
summary: "Get a tunnel ticket",
|
|
1738
2266
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1739
2267
|
tags: ["tunnels"],
|
|
1740
2268
|
successDescription: "The tunnel ticket"
|
|
1741
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
2269
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1742
2270
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1743
2271
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1744
2272
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1745
2273
|
}));
|
|
1746
|
-
const publishServerContractV1 =
|
|
2274
|
+
const publishServerContractV1 = base.route({
|
|
1747
2275
|
path: "/v1/distribution/publish",
|
|
1748
2276
|
method: "POST",
|
|
1749
2277
|
summary: "Publish a server to the MCP registry",
|
|
1750
2278
|
tags: ["distribution"],
|
|
1751
2279
|
successDescription: "The server has been published successfully"
|
|
1752
|
-
}).errors({
|
|
1753
|
-
NOT_FOUND: {},
|
|
1754
|
-
BAD_REQUEST: {}
|
|
1755
|
-
}).input(z.object({
|
|
2280
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1756
2281
|
projectId: z.string(),
|
|
1757
2282
|
domain: z.string(),
|
|
1758
2283
|
title: z.string().min(1).max(100),
|
|
@@ -1761,17 +2286,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1761
2286
|
iconSrc: z.url().max(255).optional(),
|
|
1762
2287
|
dryRun: z.boolean().optional()
|
|
1763
2288
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1764
|
-
const getServerInfoContractV1 =
|
|
2289
|
+
const getServerInfoContractV1 = base.route({
|
|
1765
2290
|
path: "/v1/distribution/get",
|
|
1766
2291
|
method: "GET",
|
|
1767
2292
|
summary: "Get server info",
|
|
1768
2293
|
description: "Get info about a server",
|
|
1769
2294
|
tags: ["distribution"],
|
|
1770
2295
|
successDescription: "The server info"
|
|
1771
|
-
}).errors({
|
|
1772
|
-
NOT_FOUND: {},
|
|
1773
|
-
BAD_REQUEST: {}
|
|
1774
|
-
}).input(z.object({
|
|
2296
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1775
2297
|
projectId: z.string(),
|
|
1776
2298
|
domain: z.string()
|
|
1777
2299
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1790,7 +2312,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1790
2312
|
isPlaygroundEnabled: z.boolean(),
|
|
1791
2313
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1792
2314
|
});
|
|
1793
|
-
const getPlaygroundContractV1 =
|
|
2315
|
+
const getPlaygroundContractV1 = base.route({
|
|
1794
2316
|
path: "/v1/environments/{environmentId}/playground",
|
|
1795
2317
|
method: "GET",
|
|
1796
2318
|
summary: "Get playground configuration",
|
|
@@ -1798,17 +2320,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1798
2320
|
tags: ["environments"],
|
|
1799
2321
|
successDescription: "The playground configuration"
|
|
1800
2322
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1801
|
-
const upsertPlaygroundContractV1 =
|
|
2323
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1802
2324
|
path: "/v1/environments/{environmentId}/playground",
|
|
1803
2325
|
method: "PUT",
|
|
1804
2326
|
summary: "Update playground configuration",
|
|
1805
2327
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1806
2328
|
tags: ["environments"],
|
|
1807
2329
|
successDescription: "The updated playground configuration"
|
|
1808
|
-
}).errors({
|
|
1809
|
-
NOT_FOUND: {},
|
|
1810
|
-
BAD_REQUEST: {}
|
|
1811
|
-
}).input(z.object({
|
|
2330
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1812
2331
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1813
2332
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1814
2333
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1816,7 +2335,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1816
2335
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1817
2336
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1818
2337
|
})).output(playgroundOutputSchema);
|
|
1819
|
-
const createBeaconContractV1 =
|
|
2338
|
+
const createBeaconContractV1 = base.route({
|
|
1820
2339
|
path: "/v1/beacon/audits",
|
|
1821
2340
|
method: "POST",
|
|
1822
2341
|
summary: "Create a beacon audit",
|
|
@@ -1825,7 +2344,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1825
2344
|
successDescription: "The audit has been created"
|
|
1826
2345
|
}).errors({
|
|
1827
2346
|
NOT_FOUND: {},
|
|
1828
|
-
BAD_REQUEST: {},
|
|
1829
2347
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1830
2348
|
}).input(z.object({
|
|
1831
2349
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1833,7 +2351,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1833
2351
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1834
2352
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1835
2353
|
})).output(z.object({ id: z.string() }));
|
|
1836
|
-
const getBeaconContractV1 =
|
|
2354
|
+
const getBeaconContractV1 = base.route({
|
|
1837
2355
|
path: "/v1/beacon/audits/{auditId}",
|
|
1838
2356
|
method: "GET",
|
|
1839
2357
|
summary: "Get a beacon audit",
|
|
@@ -1848,9 +2366,61 @@ const getBeaconContractV1 = oc.route({
|
|
|
1848
2366
|
createdAt: z.coerce.date(),
|
|
1849
2367
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1850
2368
|
}));
|
|
2369
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2370
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2371
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2372
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2373
|
+
const createSubmissionContractV1 = base.route({
|
|
2374
|
+
path: "/v1/submissions",
|
|
2375
|
+
method: "POST",
|
|
2376
|
+
summary: "Create a submission package",
|
|
2377
|
+
description: "Create a submission package for an environment. Alpic reads the environment's live MCP server and prefills every field it can infer, so the response already carries the populated package. The environment must have a successful deployment and must not require authentication.",
|
|
2378
|
+
tags: ["submissions"],
|
|
2379
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2380
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2381
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2382
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2383
|
+
})).output(submissionSchema);
|
|
2384
|
+
const getSubmissionContractV1 = base.route({
|
|
2385
|
+
path: "/v1/submissions/{submissionId}",
|
|
2386
|
+
method: "GET",
|
|
2387
|
+
summary: "Get a submission package",
|
|
2388
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2389
|
+
tags: ["submissions"],
|
|
2390
|
+
successDescription: "The submission package"
|
|
2391
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2392
|
+
const updateSubmissionContractV1 = base.route({
|
|
2393
|
+
path: "/v1/submissions/{submissionId}",
|
|
2394
|
+
method: "PUT",
|
|
2395
|
+
summary: "Update a submission package",
|
|
2396
|
+
description: "Update the form data of a submission package. Only the fields you send are changed; the rest are left as they are. Unknown field names are rejected rather than ignored, so a typo fails the call. `platform` must match the package's own platform.",
|
|
2397
|
+
tags: ["submissions"],
|
|
2398
|
+
successDescription: "The updated submission package"
|
|
2399
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2400
|
+
submissionId: submissionIdSchema,
|
|
2401
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2402
|
+
formData: claudeSubmissionUpdateSchema
|
|
2403
|
+
}), z.object({
|
|
2404
|
+
submissionId: submissionIdSchema,
|
|
2405
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2406
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2407
|
+
})])).output(submissionSchema);
|
|
1851
2408
|
const contract = {
|
|
1852
|
-
teams: {
|
|
2409
|
+
teams: {
|
|
2410
|
+
list: { v1: listTeamsContractV1 },
|
|
2411
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2412
|
+
},
|
|
1853
2413
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2414
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2415
|
+
intentCategories: {
|
|
2416
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2417
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2418
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2419
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2420
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2421
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2422
|
+
},
|
|
2423
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1854
2424
|
deployments: {
|
|
1855
2425
|
list: { v1: listDeploymentsContractV1 },
|
|
1856
2426
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1860,6 +2430,7 @@ const contract = {
|
|
|
1860
2430
|
environments: {
|
|
1861
2431
|
create: { v1: createEnvironmentContractV1 },
|
|
1862
2432
|
get: { v1: getEnvironmentContractV1 },
|
|
2433
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1863
2434
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1864
2435
|
getLogs: { v1: getLogsContractV1 },
|
|
1865
2436
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1889,7 +2460,38 @@ const contract = {
|
|
|
1889
2460
|
beacon: {
|
|
1890
2461
|
create: { v1: createBeaconContractV1 },
|
|
1891
2462
|
get: { v1: getBeaconContractV1 }
|
|
2463
|
+
},
|
|
2464
|
+
submissions: {
|
|
2465
|
+
create: { v1: createSubmissionContractV1 },
|
|
2466
|
+
get: { v1: getSubmissionContractV1 },
|
|
2467
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2468
|
+
}
|
|
2469
|
+
};
|
|
2470
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2471
|
+
const contractForDocs = {
|
|
2472
|
+
...contract,
|
|
2473
|
+
deployments: deploymentsForDocs
|
|
2474
|
+
};
|
|
2475
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2476
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2477
|
+
info: {
|
|
2478
|
+
title: "Alpic API",
|
|
2479
|
+
version: "1.0.0"
|
|
2480
|
+
},
|
|
2481
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2482
|
+
security: [{ bearerAuth: [] }],
|
|
2483
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2484
|
+
type: "http",
|
|
2485
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2486
|
+
scheme: "bearer"
|
|
2487
|
+
} } },
|
|
2488
|
+
commonSchemas: {
|
|
2489
|
+
Submission: { schema: submissionSchema },
|
|
2490
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2491
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2492
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2493
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
1892
2494
|
}
|
|
1893
2495
|
};
|
|
1894
2496
|
//#endregion
|
|
1895
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2497
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, PLATFORM_LABELS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|