@alpic-ai/api 0.0.0-dev.gf848dcc → 0.0.0-dev.gf881e70
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 +1558 -48
- package/dist/index.mjs +846 -394
- package/package.json +26 -10
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -169,11 +169,22 @@ z$1.object({
|
|
|
169
169
|
token: z$1.string(),
|
|
170
170
|
token_type_hint: z$1.string().optional()
|
|
171
171
|
}).strip();
|
|
172
|
-
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
173
176
|
const PLATFORM_LABELS = {
|
|
174
177
|
chatgpt: "ChatGPT",
|
|
175
178
|
claudeai: "Claude.ai"
|
|
176
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cato",
|
|
183
|
+
"cloudflare",
|
|
184
|
+
"fastly"
|
|
185
|
+
];
|
|
186
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
187
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
188
|
const auditStatusSchema = z.enum([
|
|
178
189
|
"pending",
|
|
179
190
|
"partial",
|
|
@@ -246,6 +257,25 @@ z.object({
|
|
|
246
257
|
clientSecret: z.string(),
|
|
247
258
|
clientScopes: z.array(z.string())
|
|
248
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
249
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
250
280
|
"ongoing",
|
|
251
281
|
"deployed",
|
|
@@ -273,34 +303,51 @@ const deploymentSummarySchema = z.object({
|
|
|
273
303
|
createdAt: z.coerce.date(),
|
|
274
304
|
updatedAt: z.coerce.date()
|
|
275
305
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
306
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
307
|
const publicEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.literal(true),
|
|
309
|
+
oAuthMetadata: z.strictObject({})
|
|
310
|
+
});
|
|
311
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
312
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
313
|
+
allowsAnonymous: z.boolean(),
|
|
314
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
315
|
+
scope: z.string().optional()
|
|
316
|
+
});
|
|
317
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
318
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
319
|
+
allowsAnonymous: z.boolean(),
|
|
320
|
+
oAuthMetadata: z.object({
|
|
321
|
+
externalAuthorizationServerUrl: z.url(),
|
|
322
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
323
|
+
}),
|
|
324
|
+
scope: z.string().optional()
|
|
325
|
+
});
|
|
326
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
|
+
const standaloneEnvironmentSchema = z.object({
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
329
|
+
oAuthMetadata: z.object({
|
|
330
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
331
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
332
|
+
}),
|
|
333
|
+
scope: z.string().optional()
|
|
334
|
+
});
|
|
335
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
336
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
337
|
+
allowsAnonymous: z.literal(false),
|
|
338
|
+
oAuthMetadata: z.strictObject({}),
|
|
339
|
+
scope: z.string().optional()
|
|
340
|
+
});
|
|
341
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
342
|
isPublic: z.literal(true),
|
|
283
343
|
oAuthMetadata: z.undefined().optional()
|
|
284
344
|
});
|
|
285
|
-
|
|
286
|
-
* Protected environment with an external resource metadata URL
|
|
287
|
-
*
|
|
288
|
-
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
289
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
290
|
-
*/
|
|
291
|
-
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
345
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
346
|
isPublic: z.literal(false),
|
|
293
347
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
348
|
scope: z.string().optional()
|
|
295
349
|
});
|
|
296
|
-
|
|
297
|
-
* Protected environment with an external authorization server URL
|
|
298
|
-
*
|
|
299
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
300
|
-
* An external authorization server URL is returned when requesting the endpoint.
|
|
301
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
302
|
-
*/
|
|
303
|
-
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
350
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
351
|
isPublic: z.literal(false),
|
|
305
352
|
oAuthMetadata: z.object({
|
|
306
353
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +355,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
355
|
}),
|
|
309
356
|
scope: z.string().optional()
|
|
310
357
|
});
|
|
311
|
-
|
|
312
|
-
* Standalone protected environment
|
|
313
|
-
*
|
|
314
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
315
|
-
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
316
|
-
*/
|
|
317
|
-
const standaloneEnvironmentSchema = z.object({
|
|
358
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
359
|
isPublic: z.literal(false),
|
|
319
360
|
oAuthMetadata: z.object({
|
|
320
361
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +363,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
363
|
}),
|
|
323
364
|
scope: z.string().optional()
|
|
324
365
|
});
|
|
325
|
-
|
|
326
|
-
* Protected environment without OAuth discovery
|
|
327
|
-
*
|
|
328
|
-
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
329
|
-
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
330
|
-
* are advertised. Clients must obtain credentials out-of-band.
|
|
331
|
-
*/
|
|
332
|
-
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
366
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
367
|
isPublic: z.literal(false),
|
|
334
368
|
oAuthMetadata: z.strictObject({}),
|
|
335
369
|
scope: z.string().optional()
|
|
@@ -339,11 +373,21 @@ z.union([
|
|
|
339
373
|
externalResourceMetadataEnvironmentSchema,
|
|
340
374
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
375
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
376
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
377
|
+
legacyPublicEnvironmentSchema,
|
|
378
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
379
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
380
|
+
legacyStandaloneEnvironmentSchema,
|
|
381
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
382
|
+
]);
|
|
383
|
+
const playgroundModelSchema = z.enum([
|
|
384
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
385
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
386
|
+
"openai.gpt-5.4",
|
|
387
|
+
"openai.gpt-5.5"
|
|
343
388
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
389
|
const environmentDomainSchema = z.object({
|
|
346
|
-
|
|
390
|
+
name: z.string(),
|
|
347
391
|
status: z.enum([
|
|
348
392
|
"ongoing",
|
|
349
393
|
"deployed",
|
|
@@ -361,6 +405,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
405
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
406
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
407
|
isPlaygroundEnabled: z.boolean(),
|
|
408
|
+
playgroundModel: playgroundModelSchema,
|
|
364
409
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
410
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
411
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -370,11 +415,20 @@ const environmentSchema$1 = z.object({
|
|
|
370
415
|
});
|
|
371
416
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
372
417
|
z.object({
|
|
418
|
+
sessionReplayEnabled: z.boolean(),
|
|
419
|
+
collectRequestPayload: z.boolean(),
|
|
420
|
+
collectResponsePayload: z.boolean(),
|
|
421
|
+
collectErrorMessage: z.boolean(),
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
424
|
+
});
|
|
425
|
+
const feedbackSchema = z.object({
|
|
373
426
|
id: z.string(),
|
|
374
427
|
createdAt: z.coerce.date(),
|
|
375
428
|
environmentId: z.string(),
|
|
376
429
|
content: z.string(),
|
|
377
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
378
432
|
});
|
|
379
433
|
z.object({
|
|
380
434
|
content: z.string(),
|
|
@@ -390,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
390
444
|
"pink",
|
|
391
445
|
"gray"
|
|
392
446
|
]);
|
|
393
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
394
448
|
const intentCategorySchema = z.object({
|
|
395
449
|
id: z.string(),
|
|
396
450
|
createdAt: z.coerce.date(),
|
|
@@ -398,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
398
452
|
name: z.string(),
|
|
399
453
|
color: intentCategoryColorSchema
|
|
400
454
|
});
|
|
401
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
402
456
|
id: z.string(),
|
|
403
457
|
name: z.string(),
|
|
404
458
|
color: intentCategoryColorSchema,
|
|
@@ -410,6 +464,7 @@ z.object({
|
|
|
410
464
|
environmentId: z.string(),
|
|
411
465
|
toolName: z.string(),
|
|
412
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
413
468
|
categories: z.array(intentCategorySchema)
|
|
414
469
|
});
|
|
415
470
|
const signalCategorySchema = z.object({
|
|
@@ -468,12 +523,262 @@ z.object({
|
|
|
468
523
|
createdAt: z.coerce.date(),
|
|
469
524
|
updatedAt: z.coerce.date()
|
|
470
525
|
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
471
536
|
z.enum([
|
|
472
537
|
"INFO",
|
|
473
538
|
"WARNING",
|
|
474
539
|
"DEBUG",
|
|
475
540
|
"ERROR"
|
|
476
541
|
]);
|
|
542
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
|
+
const MCP_CLIENT_GROUPS = [
|
|
544
|
+
{
|
|
545
|
+
id: "claude_code",
|
|
546
|
+
label: "Claude Code",
|
|
547
|
+
vendor: "anthropic",
|
|
548
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
id: "claude",
|
|
552
|
+
label: "Claude",
|
|
553
|
+
vendor: "anthropic",
|
|
554
|
+
rawNames: [
|
|
555
|
+
"Anthropic/ClaudeAI",
|
|
556
|
+
"claude-ai",
|
|
557
|
+
"claude",
|
|
558
|
+
"Claude",
|
|
559
|
+
"claude-desktop",
|
|
560
|
+
"claude-desktop-3p"
|
|
561
|
+
]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "claude_mobile",
|
|
565
|
+
label: "Claude mobile",
|
|
566
|
+
vendor: "anthropic",
|
|
567
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
id: "claude_cowork",
|
|
571
|
+
label: "Claude Cowork",
|
|
572
|
+
vendor: "anthropic",
|
|
573
|
+
rawNames: ["Anthropic/Cowork"]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "claude_toolbox",
|
|
577
|
+
label: "Claude Toolbox",
|
|
578
|
+
vendor: "anthropic",
|
|
579
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "anthropic_api",
|
|
583
|
+
label: "Anthropic API",
|
|
584
|
+
vendor: "anthropic",
|
|
585
|
+
rawNames: ["Anthropic/API"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "anthropic_connector_refresh",
|
|
589
|
+
label: "Anthropic (connector refresh)",
|
|
590
|
+
vendor: "anthropic",
|
|
591
|
+
rawNames: ["Anthropic"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "codex",
|
|
595
|
+
label: "Codex",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: [
|
|
598
|
+
"codex-mcp-client",
|
|
599
|
+
"codex",
|
|
600
|
+
"Codex",
|
|
601
|
+
"codex-cli",
|
|
602
|
+
"openai-mcp (Codex)"
|
|
603
|
+
]
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
id: "chatgpt",
|
|
607
|
+
label: "ChatGPT",
|
|
608
|
+
vendor: "openai",
|
|
609
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
id: "openai_responses_api",
|
|
613
|
+
label: "OpenAI Responses API",
|
|
614
|
+
vendor: "openai",
|
|
615
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
id: "openai_agent_builder",
|
|
619
|
+
label: "OpenAI Agent Builder",
|
|
620
|
+
vendor: "openai",
|
|
621
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
id: "openai_other",
|
|
625
|
+
label: "OpenAI Other",
|
|
626
|
+
vendor: "openai",
|
|
627
|
+
rawNames: ["openai-mcp"]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cursor",
|
|
631
|
+
label: "Cursor",
|
|
632
|
+
vendor: "cursor",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"cursor-vscode",
|
|
635
|
+
"Cursor",
|
|
636
|
+
"cursor"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "cline",
|
|
641
|
+
label: "Cline",
|
|
642
|
+
vendor: "cline",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Cline",
|
|
645
|
+
"cline",
|
|
646
|
+
"@cline/core"
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
id: "github_copilot",
|
|
651
|
+
label: "GitHub Copilot",
|
|
652
|
+
vendor: "githubCopilot",
|
|
653
|
+
rawNames: [
|
|
654
|
+
"Copilot",
|
|
655
|
+
"github-copilot-developer",
|
|
656
|
+
"Copilot MCP Gateway",
|
|
657
|
+
"Xcode/copilot-xcode"
|
|
658
|
+
]
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
id: "gemini_cli",
|
|
662
|
+
label: "Gemini CLI",
|
|
663
|
+
vendor: "google",
|
|
664
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "antigravity",
|
|
668
|
+
label: "Antigravity",
|
|
669
|
+
vendor: "google",
|
|
670
|
+
rawNames: ["antigravity-client"]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "gemini",
|
|
674
|
+
label: "Gemini",
|
|
675
|
+
vendor: "google",
|
|
676
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
id: "windsurf",
|
|
680
|
+
label: "Windsurf",
|
|
681
|
+
vendor: "windsurf",
|
|
682
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
id: "mistral",
|
|
686
|
+
label: "Mistral / Le Chat",
|
|
687
|
+
vendor: "mistral",
|
|
688
|
+
rawNames: ["Mistral"],
|
|
689
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "n8n",
|
|
693
|
+
label: "n8n",
|
|
694
|
+
vendor: "n8n",
|
|
695
|
+
rawNames: [
|
|
696
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
698
|
+
"n8n"
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "alpic_playground",
|
|
703
|
+
label: "Alpic Playground",
|
|
704
|
+
vendor: "alpic",
|
|
705
|
+
rawNames: ["alpic-playground", "playground"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "opencode",
|
|
709
|
+
label: "opencode",
|
|
710
|
+
vendor: "opencode",
|
|
711
|
+
rawNames: ["opencode"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "zed",
|
|
715
|
+
label: "Zed",
|
|
716
|
+
vendor: "zed",
|
|
717
|
+
rawNames: ["Zed", "zed"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "zapier",
|
|
721
|
+
label: "Zapier",
|
|
722
|
+
vendor: "zapier",
|
|
723
|
+
rawNames: ["Zapier", "zapier"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "make",
|
|
727
|
+
label: "Make",
|
|
728
|
+
vendor: "make",
|
|
729
|
+
rawNames: ["Make", "make"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "librechat",
|
|
733
|
+
label: "LibreChat",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["LibreChat", "librechat"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "jan",
|
|
739
|
+
label: "Jan",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: ["Jan", "jan"]
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
id: "goose",
|
|
745
|
+
label: "goose",
|
|
746
|
+
vendor: "mcp",
|
|
747
|
+
rawNames: ["goose", "Goose"]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
id: "mcphost",
|
|
751
|
+
label: "mcphost",
|
|
752
|
+
vendor: "mcp",
|
|
753
|
+
rawNames: ["mcphost"]
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
id: "mcporter",
|
|
757
|
+
label: "mcporter",
|
|
758
|
+
vendor: "mcp",
|
|
759
|
+
rawNames: ["mcporter"]
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
id: "rmcp",
|
|
763
|
+
label: "rmcp",
|
|
764
|
+
vendor: "mcp",
|
|
765
|
+
rawNames: ["rmcp"]
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
id: "unnamed_client",
|
|
769
|
+
label: "Unnamed client",
|
|
770
|
+
vendor: "mcp",
|
|
771
|
+
rawNames: [
|
|
772
|
+
"mcp",
|
|
773
|
+
"unknown",
|
|
774
|
+
""
|
|
775
|
+
]
|
|
776
|
+
}
|
|
777
|
+
];
|
|
778
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
779
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
780
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
781
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
477
782
|
const runtimeSchema = z.enum([
|
|
478
783
|
"python3.13",
|
|
479
784
|
"python3.14",
|
|
@@ -502,15 +807,27 @@ z.object({
|
|
|
502
807
|
environments: z.array(environmentWithDomainsSchema),
|
|
503
808
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
504
809
|
});
|
|
810
|
+
const domainFailureReasonSchema = z.enum([
|
|
811
|
+
"caa",
|
|
812
|
+
"dns",
|
|
813
|
+
"invalid_domain",
|
|
814
|
+
"other"
|
|
815
|
+
]);
|
|
816
|
+
const projectDomainMappingSchema = z.object({
|
|
817
|
+
pathPrefix: z.string(),
|
|
818
|
+
environment: environmentSchema$1
|
|
819
|
+
});
|
|
505
820
|
z.object({
|
|
506
|
-
|
|
821
|
+
name: z.string(),
|
|
507
822
|
createdAt: z.coerce.date(),
|
|
508
823
|
status: z.enum([
|
|
509
824
|
"ongoing",
|
|
510
825
|
"deployed",
|
|
511
826
|
"failed"
|
|
512
827
|
]),
|
|
513
|
-
|
|
828
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
829
|
+
environment: environmentSchema$1,
|
|
830
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
514
831
|
});
|
|
515
832
|
const serverFieldsSchema$1 = z.object({
|
|
516
833
|
$schema: z.string(),
|
|
@@ -539,15 +856,7 @@ z.object({
|
|
|
539
856
|
serverFields: serverFieldsSchema$1,
|
|
540
857
|
source: z.enum(["registry", "defaults"])
|
|
541
858
|
});
|
|
542
|
-
/**
|
|
543
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
544
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
545
|
-
*
|
|
546
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
547
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
548
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
549
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
550
|
-
*/
|
|
859
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
551
860
|
const clampStringField = (field) => {
|
|
552
861
|
const max = field.maxLength;
|
|
553
862
|
if (max === null) return field;
|
|
@@ -567,17 +876,20 @@ const toolDefinitionSchema = z.object({
|
|
|
567
876
|
}).optional()
|
|
568
877
|
});
|
|
569
878
|
const positiveTestCaseSchema = z.object({
|
|
570
|
-
scenario: z.string(),
|
|
571
|
-
userPrompt: z.string(),
|
|
572
|
-
toolTriggered: z.string().optional(),
|
|
573
|
-
expectedOutput: z.string().optional()
|
|
879
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
880
|
+
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."),
|
|
881
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
882
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
574
883
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
575
884
|
const screenshotEntrySchema = z.object({
|
|
576
885
|
prompt: z.string(),
|
|
577
|
-
url: z.url()
|
|
886
|
+
url: z.url()
|
|
578
887
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
888
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
579
889
|
/** Accepts either a valid email or URL. */
|
|
580
890
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
891
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
892
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
581
893
|
const chatgptCategorySchema = z.enum([
|
|
582
894
|
"BUSINESS",
|
|
583
895
|
"COLLABORATION",
|
|
@@ -886,15 +1198,11 @@ const negativeTestCaseSchema = z.object({
|
|
|
886
1198
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
887
1199
|
const chatgptToolJustificationSchema = z.object({
|
|
888
1200
|
toolName: z.string(),
|
|
889
|
-
readOnlyJustification: z.string(),
|
|
890
|
-
openWorldJustification: z.string(),
|
|
891
|
-
destructiveJustification: z.string()
|
|
892
|
-
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
893
|
-
/**
|
|
894
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
895
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
896
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
897
|
-
*/
|
|
1201
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
1202
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
1203
|
+
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.\"")
|
|
1204
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
1205
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
898
1206
|
const chatgptTaglineSchema = z.string().max(30);
|
|
899
1207
|
const chatgptDescriptionSchema = z.string();
|
|
900
1208
|
const chatgptTranslationSchema = z.object({
|
|
@@ -903,35 +1211,43 @@ const chatgptTranslationSchema = z.object({
|
|
|
903
1211
|
description: chatgptDescriptionSchema
|
|
904
1212
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
905
1213
|
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
|
-
*/
|
|
1214
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
910
1215
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
911
1216
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
912
1217
|
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
1218
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
914
|
-
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value
|
|
915
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
|
|
1219
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1220
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
916
1221
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
917
1222
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
918
|
-
companyUrl:
|
|
1223
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
919
1224
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
920
|
-
privacyPolicyUrl:
|
|
921
|
-
termsOfServiceUrl:
|
|
922
|
-
demoRecordingUrl:
|
|
1225
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1226
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1227
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
923
1228
|
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
|
|
924
|
-
serverUrl:
|
|
1229
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
925
1230
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
926
1231
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
927
|
-
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
928
|
-
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output.
|
|
929
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases
|
|
930
|
-
screenshots: z.array(screenshotEntrySchema).describe("In-app screenshots paired with the user prompt that produced them. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max
|
|
1232
|
+
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."),
|
|
1233
|
+
testCases: z.array(positiveTestCaseSchema).describe("At least 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."),
|
|
1234
|
+
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
1235
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
931
1236
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
932
1237
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
933
1238
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
934
1239
|
});
|
|
1240
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1241
|
+
tagline: z.string().optional(),
|
|
1242
|
+
companyUrl: z.string().optional(),
|
|
1243
|
+
supportChannel: z.string().optional(),
|
|
1244
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1245
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1246
|
+
demoRecordingUrl: z.string().optional(),
|
|
1247
|
+
serverUrl: z.string().optional(),
|
|
1248
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1249
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1250
|
+
});
|
|
935
1251
|
chatgptSubmissionFormDataSchema.pick({
|
|
936
1252
|
appName: true,
|
|
937
1253
|
developerName: true,
|
|
@@ -948,7 +1264,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
948
1264
|
toolJustifications: true
|
|
949
1265
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
950
1266
|
const claudeCategorySchema = z.enum([
|
|
951
|
-
"
|
|
1267
|
+
"Productivity",
|
|
952
1268
|
"Communication",
|
|
953
1269
|
"Data & Analytics",
|
|
954
1270
|
"Development tools",
|
|
@@ -956,221 +1272,167 @@ const claudeCategorySchema = z.enum([
|
|
|
956
1272
|
"Consumer Health",
|
|
957
1273
|
"Health & Life Sciences",
|
|
958
1274
|
"Media & Entertainment",
|
|
959
|
-
"Commerce & Shopping"
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
"
|
|
963
|
-
"
|
|
964
|
-
"
|
|
1275
|
+
"Commerce & Shopping",
|
|
1276
|
+
"Legal",
|
|
1277
|
+
"Sales and marketing",
|
|
1278
|
+
"Creative",
|
|
1279
|
+
"Nonprofit",
|
|
1280
|
+
"Education",
|
|
1281
|
+
"Other"
|
|
965
1282
|
]);
|
|
966
|
-
const
|
|
967
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1283
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
968
1284
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
969
|
-
"
|
|
970
|
-
"
|
|
971
|
-
"
|
|
1285
|
+
"read_only",
|
|
1286
|
+
"write_only",
|
|
1287
|
+
"read_write"
|
|
972
1288
|
]);
|
|
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"
|
|
1289
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1290
|
+
"oauth_dcr",
|
|
1291
|
+
"oauth_cimd",
|
|
1292
|
+
"oauth_anthropic_creds",
|
|
1293
|
+
"custom_connection",
|
|
1294
|
+
"none"
|
|
986
1295
|
]);
|
|
987
|
-
const
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"GDPR compliant (if applicable)"
|
|
1296
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1297
|
+
"first_party",
|
|
1298
|
+
"proxied",
|
|
1299
|
+
"third_party"
|
|
992
1300
|
]);
|
|
993
|
-
const
|
|
994
|
-
|
|
995
|
-
"
|
|
996
|
-
"
|
|
1301
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1302
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1303
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1304
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1305
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1306
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1307
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1308
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1309
|
+
"Public documentation for this connector will be live by the publish date."
|
|
997
1310
|
]);
|
|
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
|
-
*/
|
|
1311
|
+
/** 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
1312
|
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
|
-
authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
|
|
1078
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
1079
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
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.`)
|
|
1313
|
+
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
|
|
1314
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1315
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1316
|
+
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
|
|
1317
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1318
|
+
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.
|
|
1319
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1320
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1321
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1322
|
+
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
|
|
1323
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1324
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1325
|
+
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
|
|
1326
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1327
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1328
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1329
|
+
by your publish date.`),
|
|
1330
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1331
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1332
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1333
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1334
|
+
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
|
|
1335
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1336
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1337
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1338
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1339
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1340
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1341
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1342
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1343
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1344
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1345
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1346
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1347
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1348
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1349
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1350
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1351
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1352
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1353
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1354
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1355
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1356
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1357
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1358
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1359
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1360
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1361
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1362
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1363
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1364
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1365
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1366
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1367
|
+
fully populated account.`),
|
|
1368
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1369
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1370
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1371
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1372
|
+
});
|
|
1373
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1374
|
+
serverUrl: z.string().optional(),
|
|
1375
|
+
name: z.string().optional(),
|
|
1376
|
+
slug: z.string().optional(),
|
|
1377
|
+
oneLiner: z.string().optional(),
|
|
1378
|
+
description: z.string().optional(),
|
|
1379
|
+
iconUrl: z.string().optional(),
|
|
1380
|
+
documentation: z.string().optional(),
|
|
1381
|
+
support: z.string().optional(),
|
|
1382
|
+
privacyPolicy: z.string().optional(),
|
|
1383
|
+
companyWebsite: z.string().optional(),
|
|
1384
|
+
primaryContactEmail: z.string().optional(),
|
|
1385
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1386
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1133
1387
|
});
|
|
1134
1388
|
claudeSubmissionFormDataSchema.pick({
|
|
1135
|
-
companyName: true,
|
|
1136
|
-
appName: true,
|
|
1137
|
-
mcpUrlType: true,
|
|
1138
1389
|
serverUrl: true,
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
transportSupport: true,
|
|
1390
|
+
name: true,
|
|
1391
|
+
slug: true,
|
|
1392
|
+
companyName: true,
|
|
1143
1393
|
primaryContactEmail: true,
|
|
1144
1394
|
primaryContactName: true,
|
|
1395
|
+
readWriteCapabilities: true,
|
|
1145
1396
|
authentication: true,
|
|
1146
|
-
|
|
1147
|
-
|
|
1397
|
+
apiOwnership: true,
|
|
1398
|
+
personalHealthData: true
|
|
1148
1399
|
}).extend({
|
|
1149
1400
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1150
|
-
|
|
1401
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1402
|
+
});
|
|
1403
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1404
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1405
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1406
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1407
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1408
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1409
|
+
});
|
|
1410
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1411
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1412
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1151
1413
|
});
|
|
1152
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1153
|
-
tagline: true,
|
|
1154
|
-
description: true,
|
|
1155
|
-
category: true,
|
|
1156
|
-
testCases: true
|
|
1157
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1158
1414
|
const submissionMetaFieldsSchema = z.object({
|
|
1159
1415
|
id: z.string(),
|
|
1160
1416
|
environmentId: z.string(),
|
|
1417
|
+
auditId: z.string().nullable(),
|
|
1161
1418
|
createdAt: z.coerce.date(),
|
|
1162
1419
|
updatedAt: z.coerce.date()
|
|
1163
1420
|
});
|
|
1164
1421
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1165
1422
|
platform: z.literal("claudeai"),
|
|
1166
|
-
formData:
|
|
1423
|
+
formData: claudeSubmissionDraftSchema
|
|
1167
1424
|
});
|
|
1168
1425
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1169
1426
|
platform: z.literal("chatgpt"),
|
|
1170
|
-
formData:
|
|
1427
|
+
formData: chatgptSubmissionDraftSchema
|
|
1171
1428
|
});
|
|
1172
1429
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1173
|
-
z.union([
|
|
1430
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1431
|
+
z.literal([
|
|
1432
|
+
100,
|
|
1433
|
+
75,
|
|
1434
|
+
50
|
|
1435
|
+
]);
|
|
1174
1436
|
const subscriptionPlanSchema = z.enum([
|
|
1175
1437
|
"pro",
|
|
1176
1438
|
"business",
|
|
@@ -1182,17 +1444,76 @@ const customerCreditsSchema = z.object({
|
|
|
1182
1444
|
expiresAt: z.number().nullable(),
|
|
1183
1445
|
currency: z.string()
|
|
1184
1446
|
});
|
|
1185
|
-
const customerUsageSchema = z.object({
|
|
1186
|
-
amountInCents: z.number(),
|
|
1187
|
-
currency: z.string(),
|
|
1188
|
-
periodEnd: z.number()
|
|
1189
|
-
});
|
|
1190
1447
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1191
1448
|
z.object({
|
|
1192
1449
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1193
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1194
1450
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1195
1451
|
});
|
|
1452
|
+
const metricsQueueEventSchema = z.object({
|
|
1453
|
+
ts: z.number().int(),
|
|
1454
|
+
method: z.string(),
|
|
1455
|
+
tool: z.string().nullable(),
|
|
1456
|
+
client: z.string(),
|
|
1457
|
+
sessionId: z.string().nullable(),
|
|
1458
|
+
durationMs: z.number().int(),
|
|
1459
|
+
outputTokens: z.number().int().nullable(),
|
|
1460
|
+
errorType: z.enum([
|
|
1461
|
+
"mcp_error",
|
|
1462
|
+
"tool_error",
|
|
1463
|
+
"timeout"
|
|
1464
|
+
]).nullable(),
|
|
1465
|
+
errorCode: z.number().int().nullable()
|
|
1466
|
+
});
|
|
1467
|
+
z.object({
|
|
1468
|
+
v: z.literal(1),
|
|
1469
|
+
envId: z.string(),
|
|
1470
|
+
events: z.array(metricsQueueEventSchema)
|
|
1471
|
+
});
|
|
1472
|
+
z.object({ v: z.number() });
|
|
1473
|
+
const telemetrySignalSchema = z.enum([
|
|
1474
|
+
"logs",
|
|
1475
|
+
"metrics",
|
|
1476
|
+
"traces"
|
|
1477
|
+
]);
|
|
1478
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1479
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1480
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1481
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1482
|
+
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");
|
|
1483
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1484
|
+
id: z.string(),
|
|
1485
|
+
name: otlpHeaderNameSchema,
|
|
1486
|
+
value: otlpHeaderValueSchema,
|
|
1487
|
+
isSecret: z.boolean()
|
|
1488
|
+
});
|
|
1489
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1490
|
+
"credentials",
|
|
1491
|
+
"wrong-path",
|
|
1492
|
+
"wrong-protocol",
|
|
1493
|
+
"invalid-payload",
|
|
1494
|
+
"partial-rejection",
|
|
1495
|
+
"blocked-target",
|
|
1496
|
+
"timeout",
|
|
1497
|
+
"unreachable",
|
|
1498
|
+
"receiver-error",
|
|
1499
|
+
"unexpected-status"
|
|
1500
|
+
]);
|
|
1501
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1502
|
+
z.object({
|
|
1503
|
+
id: z.string(),
|
|
1504
|
+
signal: telemetrySignalSchema,
|
|
1505
|
+
endpoint: otlpEndpointSchema,
|
|
1506
|
+
protocol: otlpProtocolSchema,
|
|
1507
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1508
|
+
status: telemetryDestinationStatusSchema,
|
|
1509
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1510
|
+
});
|
|
1511
|
+
//#endregion
|
|
1512
|
+
//#region src/auth-scope.ts
|
|
1513
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1514
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1515
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1516
|
+
const AUTH_SCOPE_USER = "user";
|
|
1196
1517
|
//#endregion
|
|
1197
1518
|
//#region src/schemas.ts
|
|
1198
1519
|
const RESERVED_KEYS = [
|
|
@@ -1229,7 +1550,10 @@ const RESERVED_KEYS = [
|
|
|
1229
1550
|
"BUILD_ARG_START_COMMAND",
|
|
1230
1551
|
"ALPIC_HOST",
|
|
1231
1552
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1232
|
-
"ALPIC_INTENT_META_KEY"
|
|
1553
|
+
"ALPIC_INTENT_META_KEY",
|
|
1554
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1555
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1556
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1233
1557
|
];
|
|
1234
1558
|
const environmentVariableSchema = z.object({
|
|
1235
1559
|
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 +1606,14 @@ const serverFieldsSchema = z.object({
|
|
|
1282
1606
|
});
|
|
1283
1607
|
//#endregion
|
|
1284
1608
|
//#region src/api.contract.ts
|
|
1609
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1610
|
+
try {
|
|
1611
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1612
|
+
return true;
|
|
1613
|
+
} catch {
|
|
1614
|
+
return false;
|
|
1615
|
+
}
|
|
1616
|
+
};
|
|
1285
1617
|
const deploymentStatusSchema = z.enum([
|
|
1286
1618
|
"ongoing",
|
|
1287
1619
|
"deployed",
|
|
@@ -1310,21 +1642,20 @@ const deploymentSchema = z.object({
|
|
|
1310
1642
|
isCurrent: z.boolean(),
|
|
1311
1643
|
deploymentPageUrl: z.url().nullable()
|
|
1312
1644
|
});
|
|
1313
|
-
const
|
|
1645
|
+
const isValidTimeInput = (value) => {
|
|
1314
1646
|
if (ms(value) !== void 0) return true;
|
|
1315
1647
|
return !Number.isNaN(new Date(value).getTime());
|
|
1316
1648
|
};
|
|
1317
|
-
const
|
|
1649
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1650
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1651
|
+
const createEnvironmentContractV1 = base.route({
|
|
1318
1652
|
path: "/v1/environments",
|
|
1319
1653
|
method: "POST",
|
|
1320
1654
|
summary: "Create an environment",
|
|
1321
1655
|
description: "Create an environment for a project",
|
|
1322
1656
|
tags: ["environments"],
|
|
1323
1657
|
successDescription: "The environment has been created successfully"
|
|
1324
|
-
}).errors({
|
|
1325
|
-
NOT_FOUND: {},
|
|
1326
|
-
BAD_REQUEST: {}
|
|
1327
|
-
}).input(z.object({
|
|
1658
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1328
1659
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1329
1660
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1330
1661
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1337,7 +1668,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1337
1668
|
createdAt: z.coerce.date(),
|
|
1338
1669
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1339
1670
|
}));
|
|
1340
|
-
const getEnvironmentContractV1 =
|
|
1671
|
+
const getEnvironmentContractV1 = base.route({
|
|
1341
1672
|
path: "/v1/environments/{environmentId}",
|
|
1342
1673
|
method: "GET",
|
|
1343
1674
|
summary: "Get an environment",
|
|
@@ -1353,6 +1684,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1353
1684
|
createdAt: z.coerce.date(),
|
|
1354
1685
|
projectId: z.string()
|
|
1355
1686
|
}));
|
|
1687
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1688
|
+
path: "/v1/environments/{environmentId}",
|
|
1689
|
+
method: "DELETE",
|
|
1690
|
+
summary: "Delete an environment",
|
|
1691
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1692
|
+
tags: ["environments"],
|
|
1693
|
+
successDescription: "The environment has been deleted successfully"
|
|
1694
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1356
1695
|
const domainSchema = z.object({
|
|
1357
1696
|
domain: z.string(),
|
|
1358
1697
|
status: z.enum([
|
|
@@ -1394,7 +1733,7 @@ const projectOutputSchema = z.object({
|
|
|
1394
1733
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1395
1734
|
environments: z.array(environmentSchema)
|
|
1396
1735
|
});
|
|
1397
|
-
const getProjectContractV1 =
|
|
1736
|
+
const getProjectContractV1 = base.route({
|
|
1398
1737
|
path: "/v1/projects/{projectId}",
|
|
1399
1738
|
method: "GET",
|
|
1400
1739
|
summary: "Get a project",
|
|
@@ -1402,18 +1741,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1402
1741
|
tags: ["projects"],
|
|
1403
1742
|
successDescription: "The project details"
|
|
1404
1743
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1405
|
-
const listProjectsContractV1 =
|
|
1744
|
+
const listProjectsContractV1 = base.route({
|
|
1406
1745
|
path: "/v1/projects",
|
|
1407
1746
|
method: "GET",
|
|
1408
1747
|
summary: "List projects",
|
|
1409
1748
|
description: "List all projects for a team",
|
|
1410
1749
|
tags: ["projects"],
|
|
1411
1750
|
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({
|
|
1751
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1752
|
+
const createProjectContractV1 = base.route({
|
|
1417
1753
|
path: "/v1/projects",
|
|
1418
1754
|
method: "POST",
|
|
1419
1755
|
summary: "Create a project",
|
|
@@ -1422,7 +1758,7 @@ const createProjectContractV1 = oc.route({
|
|
|
1422
1758
|
successDescription: "The project has been created successfully"
|
|
1423
1759
|
}).errors({
|
|
1424
1760
|
NOT_FOUND: {},
|
|
1425
|
-
|
|
1761
|
+
FORBIDDEN: {}
|
|
1426
1762
|
}).input(z.object({
|
|
1427
1763
|
teamId: z.string().optional(),
|
|
1428
1764
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1462,7 +1798,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1462
1798
|
isSecret: z.boolean(),
|
|
1463
1799
|
createdAt: z.coerce.date()
|
|
1464
1800
|
});
|
|
1465
|
-
const listEnvironmentVariablesContractV1 =
|
|
1801
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1466
1802
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1467
1803
|
method: "GET",
|
|
1468
1804
|
summary: "List environment variables",
|
|
@@ -1470,48 +1806,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1470
1806
|
tags: ["environments"],
|
|
1471
1807
|
successDescription: "The list of environment variables"
|
|
1472
1808
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1473
|
-
const createEnvironmentVariablesContractV1 =
|
|
1809
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1474
1810
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1475
1811
|
method: "POST",
|
|
1476
1812
|
summary: "Add environment variables",
|
|
1477
1813
|
description: "Add one or more environment variables to an environment",
|
|
1478
1814
|
tags: ["environments"],
|
|
1479
1815
|
successDescription: "The environment variables have been added successfully"
|
|
1480
|
-
}).errors({
|
|
1481
|
-
NOT_FOUND: {},
|
|
1482
|
-
BAD_REQUEST: {}
|
|
1483
|
-
}).input(z.object({
|
|
1816
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1484
1817
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1485
1818
|
environmentVariables: environmentVariablesSchema
|
|
1486
1819
|
})).output(z.object({ success: z.literal(true) }));
|
|
1487
|
-
const updateEnvironmentVariableContractV1 =
|
|
1820
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1488
1821
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1489
1822
|
method: "PATCH",
|
|
1490
1823
|
summary: "Update an environment variable",
|
|
1491
1824
|
description: "Update an environment variable by ID",
|
|
1492
1825
|
tags: ["environments"],
|
|
1493
1826
|
successDescription: "The environment variable has been updated successfully"
|
|
1494
|
-
}).errors({
|
|
1495
|
-
NOT_FOUND: {},
|
|
1496
|
-
BAD_REQUEST: {}
|
|
1497
|
-
}).input(z.object({
|
|
1827
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1498
1828
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1499
1829
|
key: environmentVariableSchema.shape.key,
|
|
1500
1830
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1501
1831
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1502
1832
|
})).output(z.object({ success: z.literal(true) }));
|
|
1503
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1833
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1504
1834
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1505
1835
|
method: "DELETE",
|
|
1506
1836
|
summary: "Delete an environment variable",
|
|
1507
1837
|
description: "Delete an environment variable by ID",
|
|
1508
1838
|
tags: ["environments"],
|
|
1509
1839
|
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({
|
|
1840
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1841
|
+
const deleteProjectContractV1 = base.route({
|
|
1515
1842
|
path: "/v1/projects/{projectId}",
|
|
1516
1843
|
method: "DELETE",
|
|
1517
1844
|
summary: "Delete a project",
|
|
@@ -1519,7 +1846,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1519
1846
|
tags: ["projects"],
|
|
1520
1847
|
successDescription: "The project has been deleted successfully"
|
|
1521
1848
|
}).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 =
|
|
1849
|
+
const updateProjectContractV1 = base.route({
|
|
1523
1850
|
path: "/v1/projects/{projectId}",
|
|
1524
1851
|
method: "PATCH",
|
|
1525
1852
|
summary: "Update a project",
|
|
@@ -1528,13 +1855,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1528
1855
|
successDescription: "The project has been updated successfully"
|
|
1529
1856
|
}).errors({
|
|
1530
1857
|
NOT_FOUND: {},
|
|
1531
|
-
|
|
1858
|
+
FORBIDDEN: {}
|
|
1532
1859
|
}).input(z.object({
|
|
1533
1860
|
projectId: z.string().describe("The ID of the project"),
|
|
1534
1861
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1535
1862
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1536
1863
|
})).output(projectOutputSchema);
|
|
1537
|
-
const deployEnvironmentContractV1 =
|
|
1864
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1538
1865
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1539
1866
|
method: "POST",
|
|
1540
1867
|
summary: "Deploy an environment",
|
|
@@ -1543,27 +1870,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1543
1870
|
successDescription: "The environment has been deployed successfully"
|
|
1544
1871
|
}).errors({
|
|
1545
1872
|
NOT_FOUND: {},
|
|
1546
|
-
|
|
1873
|
+
CONFLICT: {}
|
|
1547
1874
|
}).input(z.object({
|
|
1548
1875
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1549
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1876
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1877
|
+
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
1878
|
})).output(deploymentSchema);
|
|
1551
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1879
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1552
1880
|
path: "/v1/deployments/upload",
|
|
1553
1881
|
method: "POST",
|
|
1554
1882
|
summary: "Upload deployment artifacts",
|
|
1555
1883
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1556
1884
|
tags: ["deployments"],
|
|
1557
1885
|
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({
|
|
1886
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1562
1887
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1563
1888
|
token: z.string().describe("Token to identify the source archive"),
|
|
1564
1889
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1565
1890
|
}));
|
|
1566
|
-
const listDeploymentsContractV1 =
|
|
1891
|
+
const listDeploymentsContractV1 = base.route({
|
|
1567
1892
|
path: "/v1/projects/{projectId}/deployments",
|
|
1568
1893
|
method: "GET",
|
|
1569
1894
|
summary: "List project deployments",
|
|
@@ -1575,7 +1900,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1575
1900
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1576
1901
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1577
1902
|
})).output(z.array(deploymentSchema));
|
|
1578
|
-
const getDeploymentContractV1 =
|
|
1903
|
+
const getDeploymentContractV1 = base.route({
|
|
1579
1904
|
path: "/v1/deployments/{deploymentId}",
|
|
1580
1905
|
method: "GET",
|
|
1581
1906
|
summary: "Get a deployment",
|
|
@@ -1583,20 +1908,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1583
1908
|
tags: ["deployments"],
|
|
1584
1909
|
successDescription: "The deployment details"
|
|
1585
1910
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1586
|
-
const
|
|
1911
|
+
const logEntrySchema = z.object({
|
|
1912
|
+
timestamp: z.coerce.date(),
|
|
1913
|
+
type: z.enum([
|
|
1914
|
+
"START",
|
|
1915
|
+
"END",
|
|
1916
|
+
"INFO",
|
|
1917
|
+
"ERROR",
|
|
1918
|
+
"WARNING",
|
|
1919
|
+
"DEBUG"
|
|
1920
|
+
]),
|
|
1921
|
+
requestId: z.string(),
|
|
1922
|
+
content: z.string().optional(),
|
|
1923
|
+
method: z.string().optional(),
|
|
1924
|
+
durationInMs: z.number().optional()
|
|
1925
|
+
});
|
|
1926
|
+
const getLogsContractV1 = base.route({
|
|
1587
1927
|
path: "/v1/environments/{environmentId}/logs",
|
|
1588
1928
|
method: "GET",
|
|
1589
1929
|
summary: "Get logs",
|
|
1590
1930
|
description: "Get logs for an environment",
|
|
1591
1931
|
tags: ["environments"],
|
|
1592
1932
|
successDescription: "The logs"
|
|
1593
|
-
}).errors({
|
|
1594
|
-
NOT_FOUND: {},
|
|
1595
|
-
BAD_REQUEST: {}
|
|
1596
|
-
}).input(z.object({
|
|
1933
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1597
1934
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1598
|
-
since:
|
|
1599
|
-
until:
|
|
1935
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1936
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1600
1937
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1601
1938
|
level: z.array(z.enum([
|
|
1602
1939
|
"INFO",
|
|
@@ -1607,34 +1944,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1607
1944
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1608
1945
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1609
1946
|
})).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
|
-
})),
|
|
1947
|
+
logs: z.array(logEntrySchema),
|
|
1625
1948
|
nextToken: z.string().nullable()
|
|
1626
1949
|
}));
|
|
1627
|
-
const getLatestLogsContractV1 =
|
|
1950
|
+
const getLatestLogsContractV1 = base.route({
|
|
1628
1951
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1629
1952
|
method: "GET",
|
|
1630
1953
|
summary: "Get latest logs",
|
|
1631
1954
|
description: "Get the N most recent logs for an environment",
|
|
1632
1955
|
tags: ["environments"],
|
|
1633
1956
|
successDescription: "The latest logs"
|
|
1634
|
-
}).errors({
|
|
1635
|
-
NOT_FOUND: {},
|
|
1636
|
-
BAD_REQUEST: {}
|
|
1637
|
-
}).input(z.object({
|
|
1957
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1638
1958
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1639
1959
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1640
1960
|
level: z.array(z.enum([
|
|
@@ -1644,22 +1964,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1644
1964
|
"DEBUG"
|
|
1645
1965
|
])).optional().describe("Filter by log level"),
|
|
1646
1966
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1647
|
-
})).output(z.object({ logs: z.array(
|
|
1648
|
-
|
|
1649
|
-
type: z.enum([
|
|
1650
|
-
"START",
|
|
1651
|
-
"END",
|
|
1652
|
-
"INFO",
|
|
1653
|
-
"ERROR",
|
|
1654
|
-
"WARNING",
|
|
1655
|
-
"DEBUG"
|
|
1656
|
-
]),
|
|
1657
|
-
requestId: z.string(),
|
|
1658
|
-
content: z.string().optional(),
|
|
1659
|
-
method: z.string().optional(),
|
|
1660
|
-
durationInMs: z.number().optional()
|
|
1661
|
-
})) }));
|
|
1662
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1967
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1968
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1663
1969
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1664
1970
|
method: "GET",
|
|
1665
1971
|
summary: "Get deployment logs",
|
|
@@ -1686,22 +1992,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1686
1992
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1687
1993
|
task_count: z.array(analyticsDataPointSchema)
|
|
1688
1994
|
});
|
|
1689
|
-
const getProjectAnalyticsContractV1 =
|
|
1995
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1690
1996
|
path: "/v1/analytics/{projectId}",
|
|
1691
1997
|
method: "GET",
|
|
1692
1998
|
summary: "Get project analytics",
|
|
1693
1999
|
description: "Get analytics data for a project over a time range",
|
|
1694
2000
|
tags: ["analytics"],
|
|
1695
2001
|
successDescription: "The project analytics data"
|
|
1696
|
-
}).errors({
|
|
1697
|
-
NOT_FOUND: {},
|
|
1698
|
-
BAD_REQUEST: {}
|
|
1699
|
-
}).input(z.object({
|
|
2002
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1700
2003
|
projectId: z.string().describe("The ID of the project"),
|
|
1701
2004
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1702
2005
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1703
2006
|
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 <=
|
|
2007
|
+
}).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
2008
|
metadata: z.object({
|
|
1706
2009
|
startTimestamp: z.number(),
|
|
1707
2010
|
endTimestamp: z.number(),
|
|
@@ -1711,7 +2014,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1711
2014
|
}),
|
|
1712
2015
|
timeSeries: analyticsTimeSeriesSchema
|
|
1713
2016
|
}));
|
|
1714
|
-
const
|
|
2017
|
+
const paginatedInsightsInputShape = {
|
|
2018
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2019
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2020
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2021
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2022
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2023
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2024
|
+
};
|
|
2025
|
+
const listIntentsContractV1 = base.route({
|
|
2026
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2027
|
+
method: "GET",
|
|
2028
|
+
summary: "List intents",
|
|
2029
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2030
|
+
tags: ["insights"],
|
|
2031
|
+
successDescription: "The grouped user intents"
|
|
2032
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2033
|
+
...paginatedInsightsInputShape,
|
|
2034
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2035
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2036
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2037
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2038
|
+
})).output(z.object({
|
|
2039
|
+
intents: z.array(z.object({
|
|
2040
|
+
id: z.string(),
|
|
2041
|
+
intentIds: z.array(z.string()).min(1),
|
|
2042
|
+
environmentId: z.string(),
|
|
2043
|
+
message: z.string(),
|
|
2044
|
+
toolName: z.string(),
|
|
2045
|
+
createdAt: z.coerce.date(),
|
|
2046
|
+
occurrenceCount: z.number().int().positive(),
|
|
2047
|
+
clientName: z.string().nullable(),
|
|
2048
|
+
clientId: z.string().nullable(),
|
|
2049
|
+
categories: z.array(z.object({
|
|
2050
|
+
id: z.string(),
|
|
2051
|
+
name: z.string(),
|
|
2052
|
+
color: intentCategoryColorSchema
|
|
2053
|
+
}))
|
|
2054
|
+
})),
|
|
2055
|
+
totalCount: z.number().int().nonnegative()
|
|
2056
|
+
}));
|
|
2057
|
+
const listFeedbacksContractV1 = base.route({
|
|
2058
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2059
|
+
method: "GET",
|
|
2060
|
+
summary: "List feedbacks",
|
|
2061
|
+
description: "List user feedback for an environment over a time range",
|
|
2062
|
+
tags: ["insights"],
|
|
2063
|
+
successDescription: "The user feedback"
|
|
2064
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2065
|
+
...paginatedInsightsInputShape,
|
|
2066
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2067
|
+
})).output(z.object({
|
|
2068
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2069
|
+
totalCount: z.number().int().nonnegative()
|
|
2070
|
+
}));
|
|
2071
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2072
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2073
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2074
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2075
|
+
method: "GET",
|
|
2076
|
+
summary: "List intent categories",
|
|
2077
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2078
|
+
tags: ["insights"],
|
|
2079
|
+
successDescription: "The intent categories"
|
|
2080
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2081
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2082
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2083
|
+
method: "POST",
|
|
2084
|
+
summary: "Create an intent category",
|
|
2085
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2086
|
+
tags: ["insights"],
|
|
2087
|
+
successDescription: "The created intent category"
|
|
2088
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2089
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2090
|
+
name: intentCategoryNameSchema,
|
|
2091
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2092
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2093
|
+
})).output(intentCategorySchema);
|
|
2094
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2095
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2096
|
+
method: "PATCH",
|
|
2097
|
+
summary: "Update an intent category",
|
|
2098
|
+
description: "Rename or recolor an intent category",
|
|
2099
|
+
tags: ["insights"],
|
|
2100
|
+
successDescription: "The updated intent category"
|
|
2101
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2102
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2103
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2104
|
+
name: intentCategoryNameSchema.optional(),
|
|
2105
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2106
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2107
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2108
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2109
|
+
method: "DELETE",
|
|
2110
|
+
summary: "Delete an intent category",
|
|
2111
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2112
|
+
tags: ["insights"],
|
|
2113
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2114
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2115
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2116
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2117
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2118
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2119
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2120
|
+
method: "POST",
|
|
2121
|
+
summary: "Link an intent category",
|
|
2122
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2123
|
+
tags: ["insights"],
|
|
2124
|
+
successDescription: "The intents have been linked successfully"
|
|
2125
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2126
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2127
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2128
|
+
intentIds: categorizableIntentIdsSchema
|
|
2129
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2130
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2131
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2132
|
+
method: "POST",
|
|
2133
|
+
summary: "Unlink an intent category",
|
|
2134
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2135
|
+
tags: ["insights"],
|
|
2136
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2137
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2138
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2139
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2140
|
+
intentIds: categorizableIntentIdsSchema
|
|
2141
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2142
|
+
const listTeamsContractV1 = base.route({
|
|
1715
2143
|
path: "/v1/teams",
|
|
1716
2144
|
method: "GET",
|
|
1717
2145
|
summary: "List teams",
|
|
@@ -1724,28 +2152,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
1724
2152
|
createdAt: z.coerce.date(),
|
|
1725
2153
|
hasStripeAccount: z.boolean()
|
|
1726
2154
|
})));
|
|
1727
|
-
const
|
|
2155
|
+
const getTeamUsageContractV1 = base.route({
|
|
2156
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2157
|
+
method: "GET",
|
|
2158
|
+
summary: "Get team usage",
|
|
2159
|
+
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.",
|
|
2160
|
+
tags: ["teams"],
|
|
2161
|
+
successDescription: "The current billing window usage"
|
|
2162
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2163
|
+
teamId: z.string(),
|
|
2164
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2165
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2166
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2167
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2168
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2169
|
+
}));
|
|
2170
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1728
2171
|
path: "/v1/tunnels/ticket",
|
|
1729
2172
|
method: "GET",
|
|
1730
2173
|
summary: "Get a tunnel ticket",
|
|
1731
2174
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1732
2175
|
tags: ["tunnels"],
|
|
1733
2176
|
successDescription: "The tunnel ticket"
|
|
1734
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
2177
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1735
2178
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1736
2179
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1737
2180
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1738
2181
|
}));
|
|
1739
|
-
const publishServerContractV1 =
|
|
2182
|
+
const publishServerContractV1 = base.route({
|
|
1740
2183
|
path: "/v1/distribution/publish",
|
|
1741
2184
|
method: "POST",
|
|
1742
2185
|
summary: "Publish a server to the MCP registry",
|
|
1743
2186
|
tags: ["distribution"],
|
|
1744
2187
|
successDescription: "The server has been published successfully"
|
|
1745
|
-
}).errors({
|
|
1746
|
-
NOT_FOUND: {},
|
|
1747
|
-
BAD_REQUEST: {}
|
|
1748
|
-
}).input(z.object({
|
|
2188
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1749
2189
|
projectId: z.string(),
|
|
1750
2190
|
domain: z.string(),
|
|
1751
2191
|
title: z.string().min(1).max(100),
|
|
@@ -1754,17 +2194,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1754
2194
|
iconSrc: z.url().max(255).optional(),
|
|
1755
2195
|
dryRun: z.boolean().optional()
|
|
1756
2196
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1757
|
-
const getServerInfoContractV1 =
|
|
2197
|
+
const getServerInfoContractV1 = base.route({
|
|
1758
2198
|
path: "/v1/distribution/get",
|
|
1759
2199
|
method: "GET",
|
|
1760
2200
|
summary: "Get server info",
|
|
1761
2201
|
description: "Get info about a server",
|
|
1762
2202
|
tags: ["distribution"],
|
|
1763
2203
|
successDescription: "The server info"
|
|
1764
|
-
}).errors({
|
|
1765
|
-
NOT_FOUND: {},
|
|
1766
|
-
BAD_REQUEST: {}
|
|
1767
|
-
}).input(z.object({
|
|
2204
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1768
2205
|
projectId: z.string(),
|
|
1769
2206
|
domain: z.string()
|
|
1770
2207
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1783,7 +2220,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1783
2220
|
isPlaygroundEnabled: z.boolean(),
|
|
1784
2221
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1785
2222
|
});
|
|
1786
|
-
const getPlaygroundContractV1 =
|
|
2223
|
+
const getPlaygroundContractV1 = base.route({
|
|
1787
2224
|
path: "/v1/environments/{environmentId}/playground",
|
|
1788
2225
|
method: "GET",
|
|
1789
2226
|
summary: "Get playground configuration",
|
|
@@ -1791,17 +2228,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1791
2228
|
tags: ["environments"],
|
|
1792
2229
|
successDescription: "The playground configuration"
|
|
1793
2230
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1794
|
-
const upsertPlaygroundContractV1 =
|
|
2231
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1795
2232
|
path: "/v1/environments/{environmentId}/playground",
|
|
1796
2233
|
method: "PUT",
|
|
1797
2234
|
summary: "Update playground configuration",
|
|
1798
2235
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1799
2236
|
tags: ["environments"],
|
|
1800
2237
|
successDescription: "The updated playground configuration"
|
|
1801
|
-
}).errors({
|
|
1802
|
-
NOT_FOUND: {},
|
|
1803
|
-
BAD_REQUEST: {}
|
|
1804
|
-
}).input(z.object({
|
|
2238
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1805
2239
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1806
2240
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1807
2241
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1809,7 +2243,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1809
2243
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1810
2244
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1811
2245
|
})).output(playgroundOutputSchema);
|
|
1812
|
-
const createBeaconContractV1 =
|
|
2246
|
+
const createBeaconContractV1 = base.route({
|
|
1813
2247
|
path: "/v1/beacon/audits",
|
|
1814
2248
|
method: "POST",
|
|
1815
2249
|
summary: "Create a beacon audit",
|
|
@@ -1818,7 +2252,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1818
2252
|
successDescription: "The audit has been created"
|
|
1819
2253
|
}).errors({
|
|
1820
2254
|
NOT_FOUND: {},
|
|
1821
|
-
BAD_REQUEST: {},
|
|
1822
2255
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1823
2256
|
}).input(z.object({
|
|
1824
2257
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1826,7 +2259,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1826
2259
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1827
2260
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1828
2261
|
})).output(z.object({ id: z.string() }));
|
|
1829
|
-
const getBeaconContractV1 =
|
|
2262
|
+
const getBeaconContractV1 = base.route({
|
|
1830
2263
|
path: "/v1/beacon/audits/{auditId}",
|
|
1831
2264
|
method: "GET",
|
|
1832
2265
|
summary: "Get a beacon audit",
|
|
@@ -1842,8 +2275,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1842
2275
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1843
2276
|
}));
|
|
1844
2277
|
const contract = {
|
|
1845
|
-
teams: {
|
|
2278
|
+
teams: {
|
|
2279
|
+
list: { v1: listTeamsContractV1 },
|
|
2280
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2281
|
+
},
|
|
1846
2282
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2283
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2284
|
+
intentCategories: {
|
|
2285
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2286
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2287
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2288
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2289
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2290
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2291
|
+
},
|
|
2292
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1847
2293
|
deployments: {
|
|
1848
2294
|
list: { v1: listDeploymentsContractV1 },
|
|
1849
2295
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1853,6 +2299,7 @@ const contract = {
|
|
|
1853
2299
|
environments: {
|
|
1854
2300
|
create: { v1: createEnvironmentContractV1 },
|
|
1855
2301
|
get: { v1: getEnvironmentContractV1 },
|
|
2302
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1856
2303
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1857
2304
|
getLogs: { v1: getLogsContractV1 },
|
|
1858
2305
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1884,5 +2331,10 @@ const contract = {
|
|
|
1884
2331
|
get: { v1: getBeaconContractV1 }
|
|
1885
2332
|
}
|
|
1886
2333
|
};
|
|
2334
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2335
|
+
const contractForDocs = {
|
|
2336
|
+
...contract,
|
|
2337
|
+
deployments: deploymentsForDocs
|
|
2338
|
+
};
|
|
1887
2339
|
//#endregion
|
|
1888
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2340
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|