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