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