@alpic-ai/api 0.0.0-staging.gdee4b0b → 0.0.0-staging.gdf7414d
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 +1091 -49
- package/dist/index.mjs +581 -370
- package/package.json +23 -7
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.4.3/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,21 @@ 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
|
+
"cloudflare",
|
|
183
|
+
"fastly"
|
|
184
|
+
];
|
|
185
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
186
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
187
|
const auditStatusSchema = z.enum([
|
|
178
188
|
"pending",
|
|
179
189
|
"partial",
|
|
@@ -273,34 +283,51 @@ const deploymentSummarySchema = z.object({
|
|
|
273
283
|
createdAt: z.coerce.date(),
|
|
274
284
|
updatedAt: z.coerce.date()
|
|
275
285
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
286
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
287
|
const publicEnvironmentSchema = z.object({
|
|
288
|
+
allowsAnonymous: z.literal(true),
|
|
289
|
+
oAuthMetadata: z.strictObject({})
|
|
290
|
+
});
|
|
291
|
+
/** 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. */
|
|
292
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
293
|
+
allowsAnonymous: z.boolean(),
|
|
294
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
295
|
+
scope: z.string().optional()
|
|
296
|
+
});
|
|
297
|
+
/** 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. */
|
|
298
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
299
|
+
allowsAnonymous: z.boolean(),
|
|
300
|
+
oAuthMetadata: z.object({
|
|
301
|
+
externalAuthorizationServerUrl: z.url(),
|
|
302
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
303
|
+
}),
|
|
304
|
+
scope: z.string().optional()
|
|
305
|
+
});
|
|
306
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
307
|
+
const standaloneEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.boolean(),
|
|
309
|
+
oAuthMetadata: z.object({
|
|
310
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
311
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
312
|
+
}),
|
|
313
|
+
scope: z.string().optional()
|
|
314
|
+
});
|
|
315
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
316
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
317
|
+
allowsAnonymous: z.literal(false),
|
|
318
|
+
oAuthMetadata: z.strictObject({}),
|
|
319
|
+
scope: z.string().optional()
|
|
320
|
+
});
|
|
321
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
322
|
isPublic: z.literal(true),
|
|
283
323
|
oAuthMetadata: z.undefined().optional()
|
|
284
324
|
});
|
|
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({
|
|
325
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
326
|
isPublic: z.literal(false),
|
|
293
327
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
328
|
scope: z.string().optional()
|
|
295
329
|
});
|
|
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({
|
|
330
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
331
|
isPublic: z.literal(false),
|
|
305
332
|
oAuthMetadata: z.object({
|
|
306
333
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +335,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
335
|
}),
|
|
309
336
|
scope: z.string().optional()
|
|
310
337
|
});
|
|
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({
|
|
338
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
339
|
isPublic: z.literal(false),
|
|
319
340
|
oAuthMetadata: z.object({
|
|
320
341
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +343,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
343
|
}),
|
|
323
344
|
scope: z.string().optional()
|
|
324
345
|
});
|
|
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({
|
|
346
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
347
|
isPublic: z.literal(false),
|
|
334
348
|
oAuthMetadata: z.strictObject({}),
|
|
335
349
|
scope: z.string().optional()
|
|
@@ -339,11 +353,21 @@ z.union([
|
|
|
339
353
|
externalResourceMetadataEnvironmentSchema,
|
|
340
354
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
355
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
356
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
357
|
+
legacyPublicEnvironmentSchema,
|
|
358
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
359
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
360
|
+
legacyStandaloneEnvironmentSchema,
|
|
361
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
362
|
+
]);
|
|
363
|
+
const playgroundModelSchema = z.enum([
|
|
364
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
365
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
366
|
+
"openai.gpt-5.4",
|
|
367
|
+
"openai.gpt-5.5"
|
|
343
368
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
369
|
const environmentDomainSchema = z.object({
|
|
346
|
-
|
|
370
|
+
name: z.string(),
|
|
347
371
|
status: z.enum([
|
|
348
372
|
"ongoing",
|
|
349
373
|
"deployed",
|
|
@@ -361,6 +385,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
385
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
386
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
387
|
isPlaygroundEnabled: z.boolean(),
|
|
388
|
+
playgroundModel: playgroundModelSchema,
|
|
364
389
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
390
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
391
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -373,14 +398,17 @@ z.object({
|
|
|
373
398
|
sessionReplayEnabled: z.boolean(),
|
|
374
399
|
collectRequestPayload: z.boolean(),
|
|
375
400
|
collectResponsePayload: z.boolean(),
|
|
376
|
-
collectErrorMessage: z.boolean()
|
|
401
|
+
collectErrorMessage: z.boolean(),
|
|
402
|
+
collectUserData: z.boolean(),
|
|
403
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
377
404
|
});
|
|
378
405
|
z.object({
|
|
379
406
|
id: z.string(),
|
|
380
407
|
createdAt: z.coerce.date(),
|
|
381
408
|
environmentId: z.string(),
|
|
382
409
|
content: z.string(),
|
|
383
|
-
source: z.enum(["model", "user"])
|
|
410
|
+
source: z.enum(["model", "user"]),
|
|
411
|
+
clientName: z.string().nullable()
|
|
384
412
|
});
|
|
385
413
|
z.object({
|
|
386
414
|
content: z.string(),
|
|
@@ -416,6 +444,7 @@ z.object({
|
|
|
416
444
|
environmentId: z.string(),
|
|
417
445
|
toolName: z.string(),
|
|
418
446
|
message: z.string(),
|
|
447
|
+
clientName: z.string().nullable(),
|
|
419
448
|
categories: z.array(intentCategorySchema)
|
|
420
449
|
});
|
|
421
450
|
const signalCategorySchema = z.object({
|
|
@@ -480,6 +509,246 @@ z.enum([
|
|
|
480
509
|
"DEBUG",
|
|
481
510
|
"ERROR"
|
|
482
511
|
]);
|
|
512
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
513
|
+
const MCP_CLIENT_GROUPS = [
|
|
514
|
+
{
|
|
515
|
+
id: "claude_code",
|
|
516
|
+
label: "Claude Code",
|
|
517
|
+
vendor: "anthropic",
|
|
518
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
519
|
+
},
|
|
520
|
+
{
|
|
521
|
+
id: "claude",
|
|
522
|
+
label: "Claude",
|
|
523
|
+
vendor: "anthropic",
|
|
524
|
+
rawNames: [
|
|
525
|
+
"Anthropic/ClaudeAI",
|
|
526
|
+
"claude-ai",
|
|
527
|
+
"claude",
|
|
528
|
+
"Claude",
|
|
529
|
+
"claude-desktop",
|
|
530
|
+
"claude-desktop-3p"
|
|
531
|
+
]
|
|
532
|
+
},
|
|
533
|
+
{
|
|
534
|
+
id: "claude_mobile",
|
|
535
|
+
label: "Claude mobile",
|
|
536
|
+
vendor: "anthropic",
|
|
537
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
538
|
+
},
|
|
539
|
+
{
|
|
540
|
+
id: "claude_cowork",
|
|
541
|
+
label: "Claude Cowork",
|
|
542
|
+
vendor: "anthropic",
|
|
543
|
+
rawNames: ["Anthropic/Cowork"]
|
|
544
|
+
},
|
|
545
|
+
{
|
|
546
|
+
id: "claude_toolbox",
|
|
547
|
+
label: "Claude Toolbox",
|
|
548
|
+
vendor: "anthropic",
|
|
549
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
id: "anthropic_api",
|
|
553
|
+
label: "Anthropic API",
|
|
554
|
+
vendor: "anthropic",
|
|
555
|
+
rawNames: ["Anthropic/API"]
|
|
556
|
+
},
|
|
557
|
+
{
|
|
558
|
+
id: "anthropic_connector_refresh",
|
|
559
|
+
label: "Anthropic (connector refresh)",
|
|
560
|
+
vendor: "anthropic",
|
|
561
|
+
rawNames: ["Anthropic"]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "codex",
|
|
565
|
+
label: "Codex",
|
|
566
|
+
vendor: "openai",
|
|
567
|
+
rawNames: [
|
|
568
|
+
"codex-mcp-client",
|
|
569
|
+
"codex",
|
|
570
|
+
"Codex",
|
|
571
|
+
"codex-cli",
|
|
572
|
+
"openai-mcp (Codex)"
|
|
573
|
+
]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "chatgpt",
|
|
577
|
+
label: "ChatGPT",
|
|
578
|
+
vendor: "openai",
|
|
579
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "openai_responses_api",
|
|
583
|
+
label: "OpenAI Responses API",
|
|
584
|
+
vendor: "openai",
|
|
585
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "openai_agent_builder",
|
|
589
|
+
label: "OpenAI Agent Builder",
|
|
590
|
+
vendor: "openai",
|
|
591
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "openai_other",
|
|
595
|
+
label: "OpenAI Other",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: ["openai-mcp"]
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
id: "cursor",
|
|
601
|
+
label: "Cursor",
|
|
602
|
+
vendor: "cursor",
|
|
603
|
+
rawNames: [
|
|
604
|
+
"cursor-vscode",
|
|
605
|
+
"Cursor",
|
|
606
|
+
"cursor"
|
|
607
|
+
]
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
id: "cline",
|
|
611
|
+
label: "Cline",
|
|
612
|
+
vendor: "cline",
|
|
613
|
+
rawNames: [
|
|
614
|
+
"Cline",
|
|
615
|
+
"cline",
|
|
616
|
+
"@cline/core"
|
|
617
|
+
]
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
id: "github_copilot",
|
|
621
|
+
label: "GitHub Copilot",
|
|
622
|
+
vendor: "githubCopilot",
|
|
623
|
+
rawNames: [
|
|
624
|
+
"Copilot",
|
|
625
|
+
"github-copilot-developer",
|
|
626
|
+
"Copilot MCP Gateway",
|
|
627
|
+
"Xcode/copilot-xcode"
|
|
628
|
+
]
|
|
629
|
+
},
|
|
630
|
+
{
|
|
631
|
+
id: "gemini_cli",
|
|
632
|
+
label: "Gemini CLI",
|
|
633
|
+
vendor: "google",
|
|
634
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
635
|
+
},
|
|
636
|
+
{
|
|
637
|
+
id: "antigravity",
|
|
638
|
+
label: "Antigravity",
|
|
639
|
+
vendor: "google",
|
|
640
|
+
rawNames: ["antigravity-client"]
|
|
641
|
+
},
|
|
642
|
+
{
|
|
643
|
+
id: "gemini",
|
|
644
|
+
label: "Gemini",
|
|
645
|
+
vendor: "google",
|
|
646
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
id: "windsurf",
|
|
650
|
+
label: "Windsurf",
|
|
651
|
+
vendor: "windsurf",
|
|
652
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
653
|
+
},
|
|
654
|
+
{
|
|
655
|
+
id: "mistral",
|
|
656
|
+
label: "Mistral / Le Chat",
|
|
657
|
+
vendor: "mistral",
|
|
658
|
+
rawNames: ["Mistral"],
|
|
659
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
id: "n8n",
|
|
663
|
+
label: "n8n",
|
|
664
|
+
vendor: "n8n",
|
|
665
|
+
rawNames: [
|
|
666
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
667
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
668
|
+
"n8n"
|
|
669
|
+
]
|
|
670
|
+
},
|
|
671
|
+
{
|
|
672
|
+
id: "alpic_playground",
|
|
673
|
+
label: "Alpic Playground",
|
|
674
|
+
vendor: "alpic",
|
|
675
|
+
rawNames: ["alpic-playground", "playground"]
|
|
676
|
+
},
|
|
677
|
+
{
|
|
678
|
+
id: "opencode",
|
|
679
|
+
label: "opencode",
|
|
680
|
+
vendor: "opencode",
|
|
681
|
+
rawNames: ["opencode"]
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
id: "zed",
|
|
685
|
+
label: "Zed",
|
|
686
|
+
vendor: "zed",
|
|
687
|
+
rawNames: ["Zed", "zed"]
|
|
688
|
+
},
|
|
689
|
+
{
|
|
690
|
+
id: "zapier",
|
|
691
|
+
label: "Zapier",
|
|
692
|
+
vendor: "zapier",
|
|
693
|
+
rawNames: ["Zapier", "zapier"]
|
|
694
|
+
},
|
|
695
|
+
{
|
|
696
|
+
id: "make",
|
|
697
|
+
label: "Make",
|
|
698
|
+
vendor: "make",
|
|
699
|
+
rawNames: ["Make", "make"]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "librechat",
|
|
703
|
+
label: "LibreChat",
|
|
704
|
+
vendor: "mcp",
|
|
705
|
+
rawNames: ["LibreChat", "librechat"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "jan",
|
|
709
|
+
label: "Jan",
|
|
710
|
+
vendor: "mcp",
|
|
711
|
+
rawNames: ["Jan", "jan"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "goose",
|
|
715
|
+
label: "goose",
|
|
716
|
+
vendor: "mcp",
|
|
717
|
+
rawNames: ["goose", "Goose"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "mcphost",
|
|
721
|
+
label: "mcphost",
|
|
722
|
+
vendor: "mcp",
|
|
723
|
+
rawNames: ["mcphost"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "mcporter",
|
|
727
|
+
label: "mcporter",
|
|
728
|
+
vendor: "mcp",
|
|
729
|
+
rawNames: ["mcporter"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "rmcp",
|
|
733
|
+
label: "rmcp",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["rmcp"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "unnamed_client",
|
|
739
|
+
label: "Unnamed client",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: [
|
|
742
|
+
"mcp",
|
|
743
|
+
"unknown",
|
|
744
|
+
""
|
|
745
|
+
]
|
|
746
|
+
}
|
|
747
|
+
];
|
|
748
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
749
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
750
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
751
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
483
752
|
const runtimeSchema = z.enum([
|
|
484
753
|
"python3.13",
|
|
485
754
|
"python3.14",
|
|
@@ -508,15 +777,27 @@ z.object({
|
|
|
508
777
|
environments: z.array(environmentWithDomainsSchema),
|
|
509
778
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
510
779
|
});
|
|
780
|
+
const domainFailureReasonSchema = z.enum([
|
|
781
|
+
"caa",
|
|
782
|
+
"dns",
|
|
783
|
+
"invalid_domain",
|
|
784
|
+
"other"
|
|
785
|
+
]);
|
|
786
|
+
const projectDomainMappingSchema = z.object({
|
|
787
|
+
pathPrefix: z.string(),
|
|
788
|
+
environment: environmentSchema$1
|
|
789
|
+
});
|
|
511
790
|
z.object({
|
|
512
|
-
|
|
791
|
+
name: z.string(),
|
|
513
792
|
createdAt: z.coerce.date(),
|
|
514
793
|
status: z.enum([
|
|
515
794
|
"ongoing",
|
|
516
795
|
"deployed",
|
|
517
796
|
"failed"
|
|
518
797
|
]),
|
|
519
|
-
|
|
798
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
799
|
+
environment: environmentSchema$1,
|
|
800
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
520
801
|
});
|
|
521
802
|
const serverFieldsSchema$1 = z.object({
|
|
522
803
|
$schema: z.string(),
|
|
@@ -545,15 +826,7 @@ z.object({
|
|
|
545
826
|
serverFields: serverFieldsSchema$1,
|
|
546
827
|
source: z.enum(["registry", "defaults"])
|
|
547
828
|
});
|
|
548
|
-
/**
|
|
549
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
550
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
551
|
-
*
|
|
552
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
553
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
554
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
555
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
556
|
-
*/
|
|
829
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
557
830
|
const clampStringField = (field) => {
|
|
558
831
|
const max = field.maxLength;
|
|
559
832
|
if (max === null) return field;
|
|
@@ -580,10 +853,13 @@ const positiveTestCaseSchema = z.object({
|
|
|
580
853
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
581
854
|
const screenshotEntrySchema = z.object({
|
|
582
855
|
prompt: z.string(),
|
|
583
|
-
url: z.url()
|
|
856
|
+
url: z.url()
|
|
584
857
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
858
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
585
859
|
/** Accepts either a valid email or URL. */
|
|
586
860
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
861
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
862
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
587
863
|
const chatgptCategorySchema = z.enum([
|
|
588
864
|
"BUSINESS",
|
|
589
865
|
"COLLABORATION",
|
|
@@ -896,11 +1172,7 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
896
1172
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
897
1173
|
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
898
1174
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
899
|
-
/**
|
|
900
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
901
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
902
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
903
|
-
*/
|
|
1175
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
904
1176
|
const chatgptTaglineSchema = z.string().max(30);
|
|
905
1177
|
const chatgptDescriptionSchema = z.string();
|
|
906
1178
|
const chatgptTranslationSchema = z.object({
|
|
@@ -909,10 +1181,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
909
1181
|
description: chatgptDescriptionSchema
|
|
910
1182
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
911
1183
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
912
|
-
/**
|
|
913
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
914
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
915
|
-
*/
|
|
1184
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
916
1185
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
917
1186
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
918
1187
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
@@ -921,23 +1190,34 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
921
1190
|
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
922
1191
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
923
1192
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
924
|
-
companyUrl:
|
|
1193
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
925
1194
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
926
|
-
privacyPolicyUrl:
|
|
927
|
-
termsOfServiceUrl:
|
|
928
|
-
demoRecordingUrl:
|
|
1195
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1196
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1197
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
929
1198
|
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
|
|
930
|
-
serverUrl:
|
|
1199
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
931
1200
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
932
1201
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
933
1202
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
934
1203
|
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."),
|
|
935
1204
|
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."),
|
|
936
|
-
screenshots: z.array(screenshotEntrySchema).max(3).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 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1205
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
937
1206
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
938
1207
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
939
1208
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
940
1209
|
});
|
|
1210
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1211
|
+
tagline: z.string().optional(),
|
|
1212
|
+
companyUrl: z.string().optional(),
|
|
1213
|
+
supportChannel: z.string().optional(),
|
|
1214
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1215
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1216
|
+
demoRecordingUrl: z.string().optional(),
|
|
1217
|
+
serverUrl: z.string().optional(),
|
|
1218
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1219
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1220
|
+
});
|
|
941
1221
|
chatgptSubmissionFormDataSchema.pick({
|
|
942
1222
|
appName: true,
|
|
943
1223
|
developerName: true,
|
|
@@ -954,7 +1234,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
954
1234
|
toolJustifications: true
|
|
955
1235
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
956
1236
|
const claudeCategorySchema = z.enum([
|
|
957
|
-
"
|
|
1237
|
+
"Productivity",
|
|
958
1238
|
"Communication",
|
|
959
1239
|
"Data & Analytics",
|
|
960
1240
|
"Development tools",
|
|
@@ -962,205 +1242,145 @@ const claudeCategorySchema = z.enum([
|
|
|
962
1242
|
"Consumer Health",
|
|
963
1243
|
"Health & Life Sciences",
|
|
964
1244
|
"Media & Entertainment",
|
|
965
|
-
"Commerce & Shopping"
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
"
|
|
969
|
-
"
|
|
970
|
-
"
|
|
1245
|
+
"Commerce & Shopping",
|
|
1246
|
+
"Legal",
|
|
1247
|
+
"Sales and marketing",
|
|
1248
|
+
"Creative",
|
|
1249
|
+
"Nonprofit",
|
|
1250
|
+
"Education",
|
|
1251
|
+
"Other"
|
|
971
1252
|
]);
|
|
972
|
-
const
|
|
973
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1253
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
974
1254
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
975
|
-
"
|
|
976
|
-
"
|
|
977
|
-
"
|
|
1255
|
+
"read_only",
|
|
1256
|
+
"write_only",
|
|
1257
|
+
"read_write"
|
|
978
1258
|
]);
|
|
979
|
-
const
|
|
980
|
-
|
|
981
|
-
"
|
|
982
|
-
"
|
|
983
|
-
"
|
|
984
|
-
"
|
|
985
|
-
]);
|
|
986
|
-
const claudeThirdPartySchema = z.enum([
|
|
987
|
-
"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)",
|
|
988
|
-
"Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
|
|
989
|
-
"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)",
|
|
990
|
-
"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)",
|
|
991
|
-
"N/A"
|
|
1259
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1260
|
+
"oauth_dcr",
|
|
1261
|
+
"oauth_cimd",
|
|
1262
|
+
"oauth_anthropic_creds",
|
|
1263
|
+
"custom_connection",
|
|
1264
|
+
"none"
|
|
992
1265
|
]);
|
|
993
|
-
const
|
|
994
|
-
"
|
|
995
|
-
"
|
|
996
|
-
"
|
|
997
|
-
"GDPR compliant (if applicable)"
|
|
1266
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1267
|
+
"first_party",
|
|
1268
|
+
"proxied",
|
|
1269
|
+
"third_party"
|
|
998
1270
|
]);
|
|
999
|
-
const
|
|
1000
|
-
|
|
1001
|
-
"
|
|
1002
|
-
"
|
|
1271
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1272
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1273
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1274
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1275
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1276
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1277
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1278
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1279
|
+
"Public documentation for this connector will be live by the publish date."
|
|
1003
1280
|
]);
|
|
1004
|
-
/**
|
|
1005
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
1006
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
1007
|
-
*/
|
|
1281
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1008
1282
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
(
|
|
1019
|
-
|
|
1020
|
-
(
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
•
|
|
1038
|
-
•
|
|
1039
|
-
•
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
• '
|
|
1055
|
-
• '
|
|
1056
|
-
• '
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
|
|
1084
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
1085
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
1086
|
-
• 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
|
|
1087
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
1088
|
-
serverDocumentationLink: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. This is displayed in the Directory listing and must be publicly accessible without login. Minimum requirements for the docs page:
|
|
1089
|
-
• What the connector does and its key capabilities
|
|
1090
|
-
• How to connect/set it up (step by step)
|
|
1091
|
-
• What each tool does (or at least the main ones)
|
|
1092
|
-
• How to troubleshoot common issues
|
|
1093
|
-
• A support contact or channel
|
|
1094
|
-
Acceptable formats: a dedicated docs page, a help center article, a README on GitHub, or a blog post — as long as it's comprehensive. Note: Anthropic requires public documentation to be live by your publish date.`),
|
|
1095
|
-
privacyPolicyUrl: z.url().describe(`URL to your privacy policy. This is mandatory and displayed in the directory listing. Missing or incomplete privacy policies result in immediate rejection. Your privacy policy must cover:
|
|
1096
|
-
• What data you collect (and how)
|
|
1097
|
-
• How you use the collected data
|
|
1098
|
-
• Where and how long you store it
|
|
1099
|
-
• Whether you share data with third parties (and who)
|
|
1100
|
-
• How users can contact you about data concerns
|
|
1101
|
-
The policy must be publicly accessible. If you don't have one yet, create one before submitting — there are free generators online, but make sure it accurately reflects your actual practices. If you're GDPR-compliant, your policy should reflect that.`),
|
|
1102
|
-
supportChannel: supportChannelSchema.describe(`A URL or email address where users can get help with your connector. This is displayed in the Directory listing. Acceptable options:
|
|
1103
|
-
• Email address (e.g. support@myapp.com)
|
|
1104
|
-
• Link to a GitHub Issues page
|
|
1105
|
-
• Link to a help center or support article
|
|
1106
|
-
• Link to a Discord/Slack community
|
|
1107
|
-
• Link to your documentation's troubleshooting section
|
|
1108
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1109
|
-
testingCredentials: z.string().describe(`Provide login credentials for a test account that Anthropic reviewers can use to verify your server works end-to-end. Critical requirements:
|
|
1110
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
1111
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
1112
|
-
• If your service uses Google OAuth or another OAuth that requires email verification, use mcp-review@anthropic.com as the account email — Anthropic has access to this inbox.
|
|
1113
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
1114
|
-
• If your service requires API keys instead of a password, provide those.
|
|
1115
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
1116
|
-
tools: z.array(toolDefinitionSchema).describe(`A comma-separated list of all tools your MCP server exposes. Use the format: tool_name (Human-Readable Name). The tool_name is the internal identifier (snake_case, max 64 characters). The Human-Readable Name is what users see.
|
|
1117
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
1118
|
-
Reviewers test every single tool you list here — don't list tools that don't work. Also: do not have a single catch-all tool like api_request(method, endpoint) — Anthropic rejects these. Each action should be its own purpose-built tool.`),
|
|
1119
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
1120
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
1121
|
-
• 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
|
|
1122
|
-
This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
|
|
1123
|
-
testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
|
|
1124
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
1125
|
-
• Format: SVG only
|
|
1126
|
-
• Aspect ratio: square (1:1)
|
|
1127
|
-
• Should work on a light background
|
|
1128
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
1129
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
1130
|
-
logoDark: z.string().optional().describe(`Optional dark-mode variant of the connector logo. Same specs as the light variant (SVG, square 1:1) but designed to read on a dark background. Leave empty if the light logo already works on dark.`),
|
|
1131
|
-
screenshots: z.array(screenshotEntrySchema).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
|
|
1132
|
-
• 3–5 images is ideal
|
|
1133
|
-
• Minimum 1000px width, PNG format preferred
|
|
1134
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
1135
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
1136
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
1137
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
1138
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1283
|
+
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
|
|
1284
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1285
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1286
|
+
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
|
|
1287
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1288
|
+
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.
|
|
1289
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1290
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1291
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1292
|
+
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
|
|
1293
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1294
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1295
|
+
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
|
|
1296
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1297
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1298
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1299
|
+
by your publish date.`),
|
|
1300
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1301
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1302
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1303
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1304
|
+
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
|
|
1305
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1306
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1307
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1308
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1309
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1310
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1311
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1312
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1313
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1314
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1315
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1316
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1317
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1318
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1319
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1320
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1321
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1322
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1323
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1324
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1325
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1326
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1327
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1328
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1329
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1330
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1331
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1332
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1333
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1334
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1335
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1336
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1337
|
+
fully populated account.`),
|
|
1338
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1339
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1340
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1341
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1342
|
+
});
|
|
1343
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1344
|
+
serverUrl: z.string().optional(),
|
|
1345
|
+
name: z.string().optional(),
|
|
1346
|
+
slug: z.string().optional(),
|
|
1347
|
+
oneLiner: z.string().optional(),
|
|
1348
|
+
description: z.string().optional(),
|
|
1349
|
+
iconUrl: z.string().optional(),
|
|
1350
|
+
documentation: z.string().optional(),
|
|
1351
|
+
support: z.string().optional(),
|
|
1352
|
+
privacyPolicy: z.string().optional(),
|
|
1353
|
+
companyWebsite: z.string().optional(),
|
|
1354
|
+
primaryContactEmail: z.string().optional(),
|
|
1355
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1356
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1139
1357
|
});
|
|
1140
1358
|
claudeSubmissionFormDataSchema.pick({
|
|
1141
|
-
companyName: true,
|
|
1142
|
-
appName: true,
|
|
1143
|
-
mcpUrlType: true,
|
|
1144
1359
|
serverUrl: true,
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
transportSupport: true,
|
|
1360
|
+
name: true,
|
|
1361
|
+
slug: true,
|
|
1362
|
+
companyName: true,
|
|
1149
1363
|
primaryContactEmail: true,
|
|
1150
1364
|
primaryContactName: true,
|
|
1365
|
+
readWriteCapabilities: true,
|
|
1151
1366
|
authentication: true,
|
|
1152
|
-
|
|
1153
|
-
|
|
1367
|
+
apiOwnership: true,
|
|
1368
|
+
personalHealthData: true
|
|
1154
1369
|
}).extend({
|
|
1155
1370
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1156
|
-
|
|
1371
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1372
|
+
});
|
|
1373
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1374
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1375
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1376
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1377
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1378
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1379
|
+
});
|
|
1380
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1381
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1382
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1157
1383
|
});
|
|
1158
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1159
|
-
tagline: true,
|
|
1160
|
-
description: true,
|
|
1161
|
-
category: true,
|
|
1162
|
-
testCases: true
|
|
1163
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1164
1384
|
const submissionMetaFieldsSchema = z.object({
|
|
1165
1385
|
id: z.string(),
|
|
1166
1386
|
environmentId: z.string(),
|
|
@@ -1170,14 +1390,20 @@ const submissionMetaFieldsSchema = z.object({
|
|
|
1170
1390
|
});
|
|
1171
1391
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1172
1392
|
platform: z.literal("claudeai"),
|
|
1173
|
-
formData:
|
|
1393
|
+
formData: claudeSubmissionDraftSchema
|
|
1174
1394
|
});
|
|
1175
1395
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1176
1396
|
platform: z.literal("chatgpt"),
|
|
1177
|
-
formData:
|
|
1397
|
+
formData: chatgptSubmissionDraftSchema
|
|
1178
1398
|
});
|
|
1179
1399
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1180
|
-
z.union([
|
|
1400
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1401
|
+
({
|
|
1402
|
+
free: 1e4,
|
|
1403
|
+
pro: 2e5,
|
|
1404
|
+
business: 2e6,
|
|
1405
|
+
enterprise: null
|
|
1406
|
+
}).free;
|
|
1181
1407
|
const subscriptionPlanSchema = z.enum([
|
|
1182
1408
|
"pro",
|
|
1183
1409
|
"business",
|
|
@@ -1195,12 +1421,19 @@ const customerUsageSchema = z.object({
|
|
|
1195
1421
|
periodEnd: z.number()
|
|
1196
1422
|
});
|
|
1197
1423
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1424
|
+
z.object({ balanceInNanoUSD: z.number() });
|
|
1198
1425
|
z.object({
|
|
1199
1426
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1200
1427
|
customerUsage: customerUsageSchema.nullable(),
|
|
1201
1428
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1202
1429
|
});
|
|
1203
1430
|
//#endregion
|
|
1431
|
+
//#region src/auth-scope.ts
|
|
1432
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1433
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1434
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1435
|
+
const AUTH_SCOPE_USER = "user";
|
|
1436
|
+
//#endregion
|
|
1204
1437
|
//#region src/schemas.ts
|
|
1205
1438
|
const RESERVED_KEYS = [
|
|
1206
1439
|
"_HANDLER",
|
|
@@ -1236,7 +1469,10 @@ const RESERVED_KEYS = [
|
|
|
1236
1469
|
"BUILD_ARG_START_COMMAND",
|
|
1237
1470
|
"ALPIC_HOST",
|
|
1238
1471
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1239
|
-
"ALPIC_INTENT_META_KEY"
|
|
1472
|
+
"ALPIC_INTENT_META_KEY",
|
|
1473
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1474
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1475
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1240
1476
|
];
|
|
1241
1477
|
const environmentVariableSchema = z.object({
|
|
1242
1478
|
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"),
|
|
@@ -1321,17 +1557,15 @@ const isValidLogTimeInput = (value) => {
|
|
|
1321
1557
|
if (ms(value) !== void 0) return true;
|
|
1322
1558
|
return !Number.isNaN(new Date(value).getTime());
|
|
1323
1559
|
};
|
|
1324
|
-
const
|
|
1560
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1561
|
+
const createEnvironmentContractV1 = base.route({
|
|
1325
1562
|
path: "/v1/environments",
|
|
1326
1563
|
method: "POST",
|
|
1327
1564
|
summary: "Create an environment",
|
|
1328
1565
|
description: "Create an environment for a project",
|
|
1329
1566
|
tags: ["environments"],
|
|
1330
1567
|
successDescription: "The environment has been created successfully"
|
|
1331
|
-
}).errors({
|
|
1332
|
-
NOT_FOUND: {},
|
|
1333
|
-
BAD_REQUEST: {}
|
|
1334
|
-
}).input(z.object({
|
|
1568
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1335
1569
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1336
1570
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1337
1571
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1344,7 +1578,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1344
1578
|
createdAt: z.coerce.date(),
|
|
1345
1579
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1346
1580
|
}));
|
|
1347
|
-
const getEnvironmentContractV1 =
|
|
1581
|
+
const getEnvironmentContractV1 = base.route({
|
|
1348
1582
|
path: "/v1/environments/{environmentId}",
|
|
1349
1583
|
method: "GET",
|
|
1350
1584
|
summary: "Get an environment",
|
|
@@ -1401,7 +1635,7 @@ const projectOutputSchema = z.object({
|
|
|
1401
1635
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1402
1636
|
environments: z.array(environmentSchema)
|
|
1403
1637
|
});
|
|
1404
|
-
const getProjectContractV1 =
|
|
1638
|
+
const getProjectContractV1 = base.route({
|
|
1405
1639
|
path: "/v1/projects/{projectId}",
|
|
1406
1640
|
method: "GET",
|
|
1407
1641
|
summary: "Get a project",
|
|
@@ -1409,18 +1643,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1409
1643
|
tags: ["projects"],
|
|
1410
1644
|
successDescription: "The project details"
|
|
1411
1645
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1412
|
-
const listProjectsContractV1 =
|
|
1646
|
+
const listProjectsContractV1 = base.route({
|
|
1413
1647
|
path: "/v1/projects",
|
|
1414
1648
|
method: "GET",
|
|
1415
1649
|
summary: "List projects",
|
|
1416
1650
|
description: "List all projects for a team",
|
|
1417
1651
|
tags: ["projects"],
|
|
1418
1652
|
successDescription: "The list of projects"
|
|
1419
|
-
}).errors({
|
|
1420
|
-
|
|
1421
|
-
BAD_REQUEST: {}
|
|
1422
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1423
|
-
const createProjectContractV1 = oc.route({
|
|
1653
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1654
|
+
const createProjectContractV1 = base.route({
|
|
1424
1655
|
path: "/v1/projects",
|
|
1425
1656
|
method: "POST",
|
|
1426
1657
|
summary: "Create a project",
|
|
@@ -1429,7 +1660,7 @@ const createProjectContractV1 = oc.route({
|
|
|
1429
1660
|
successDescription: "The project has been created successfully"
|
|
1430
1661
|
}).errors({
|
|
1431
1662
|
NOT_FOUND: {},
|
|
1432
|
-
|
|
1663
|
+
FORBIDDEN: {}
|
|
1433
1664
|
}).input(z.object({
|
|
1434
1665
|
teamId: z.string().optional(),
|
|
1435
1666
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1469,7 +1700,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1469
1700
|
isSecret: z.boolean(),
|
|
1470
1701
|
createdAt: z.coerce.date()
|
|
1471
1702
|
});
|
|
1472
|
-
const listEnvironmentVariablesContractV1 =
|
|
1703
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1473
1704
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1474
1705
|
method: "GET",
|
|
1475
1706
|
summary: "List environment variables",
|
|
@@ -1477,48 +1708,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1477
1708
|
tags: ["environments"],
|
|
1478
1709
|
successDescription: "The list of environment variables"
|
|
1479
1710
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1480
|
-
const createEnvironmentVariablesContractV1 =
|
|
1711
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1481
1712
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1482
1713
|
method: "POST",
|
|
1483
1714
|
summary: "Add environment variables",
|
|
1484
1715
|
description: "Add one or more environment variables to an environment",
|
|
1485
1716
|
tags: ["environments"],
|
|
1486
1717
|
successDescription: "The environment variables have been added successfully"
|
|
1487
|
-
}).errors({
|
|
1488
|
-
NOT_FOUND: {},
|
|
1489
|
-
BAD_REQUEST: {}
|
|
1490
|
-
}).input(z.object({
|
|
1718
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1491
1719
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1492
1720
|
environmentVariables: environmentVariablesSchema
|
|
1493
1721
|
})).output(z.object({ success: z.literal(true) }));
|
|
1494
|
-
const updateEnvironmentVariableContractV1 =
|
|
1722
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1495
1723
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1496
1724
|
method: "PATCH",
|
|
1497
1725
|
summary: "Update an environment variable",
|
|
1498
1726
|
description: "Update an environment variable by ID",
|
|
1499
1727
|
tags: ["environments"],
|
|
1500
1728
|
successDescription: "The environment variable has been updated successfully"
|
|
1501
|
-
}).errors({
|
|
1502
|
-
NOT_FOUND: {},
|
|
1503
|
-
BAD_REQUEST: {}
|
|
1504
|
-
}).input(z.object({
|
|
1729
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1505
1730
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1506
1731
|
key: environmentVariableSchema.shape.key,
|
|
1507
1732
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1508
1733
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1509
1734
|
})).output(z.object({ success: z.literal(true) }));
|
|
1510
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1735
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1511
1736
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1512
1737
|
method: "DELETE",
|
|
1513
1738
|
summary: "Delete an environment variable",
|
|
1514
1739
|
description: "Delete an environment variable by ID",
|
|
1515
1740
|
tags: ["environments"],
|
|
1516
1741
|
successDescription: "The environment variable has been deleted successfully"
|
|
1517
|
-
}).errors({
|
|
1518
|
-
|
|
1519
|
-
BAD_REQUEST: {}
|
|
1520
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1521
|
-
const deleteProjectContractV1 = oc.route({
|
|
1742
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1743
|
+
const deleteProjectContractV1 = base.route({
|
|
1522
1744
|
path: "/v1/projects/{projectId}",
|
|
1523
1745
|
method: "DELETE",
|
|
1524
1746
|
summary: "Delete a project",
|
|
@@ -1526,7 +1748,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1526
1748
|
tags: ["projects"],
|
|
1527
1749
|
successDescription: "The project has been deleted successfully"
|
|
1528
1750
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1529
|
-
const updateProjectContractV1 =
|
|
1751
|
+
const updateProjectContractV1 = base.route({
|
|
1530
1752
|
path: "/v1/projects/{projectId}",
|
|
1531
1753
|
method: "PATCH",
|
|
1532
1754
|
summary: "Update a project",
|
|
@@ -1535,13 +1757,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1535
1757
|
successDescription: "The project has been updated successfully"
|
|
1536
1758
|
}).errors({
|
|
1537
1759
|
NOT_FOUND: {},
|
|
1538
|
-
|
|
1760
|
+
FORBIDDEN: {}
|
|
1539
1761
|
}).input(z.object({
|
|
1540
1762
|
projectId: z.string().describe("The ID of the project"),
|
|
1541
1763
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1542
1764
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1543
1765
|
})).output(projectOutputSchema);
|
|
1544
|
-
const deployEnvironmentContractV1 =
|
|
1766
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1545
1767
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1546
1768
|
method: "POST",
|
|
1547
1769
|
summary: "Deploy an environment",
|
|
@@ -1550,27 +1772,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1550
1772
|
successDescription: "The environment has been deployed successfully"
|
|
1551
1773
|
}).errors({
|
|
1552
1774
|
NOT_FOUND: {},
|
|
1553
|
-
|
|
1775
|
+
CONFLICT: {}
|
|
1554
1776
|
}).input(z.object({
|
|
1555
1777
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1556
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1778
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1779
|
+
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1557
1780
|
})).output(deploymentSchema);
|
|
1558
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1781
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1559
1782
|
path: "/v1/deployments/upload",
|
|
1560
1783
|
method: "POST",
|
|
1561
1784
|
summary: "Upload deployment artifacts",
|
|
1562
1785
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1563
1786
|
tags: ["deployments"],
|
|
1564
1787
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1565
|
-
}).errors({
|
|
1566
|
-
NOT_FOUND: {},
|
|
1567
|
-
BAD_REQUEST: {}
|
|
1568
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1788
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1569
1789
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1570
1790
|
token: z.string().describe("Token to identify the source archive"),
|
|
1571
1791
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1572
1792
|
}));
|
|
1573
|
-
const listDeploymentsContractV1 =
|
|
1793
|
+
const listDeploymentsContractV1 = base.route({
|
|
1574
1794
|
path: "/v1/projects/{projectId}/deployments",
|
|
1575
1795
|
method: "GET",
|
|
1576
1796
|
summary: "List project deployments",
|
|
@@ -1582,7 +1802,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1582
1802
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1583
1803
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1584
1804
|
})).output(z.array(deploymentSchema));
|
|
1585
|
-
const getDeploymentContractV1 =
|
|
1805
|
+
const getDeploymentContractV1 = base.route({
|
|
1586
1806
|
path: "/v1/deployments/{deploymentId}",
|
|
1587
1807
|
method: "GET",
|
|
1588
1808
|
summary: "Get a deployment",
|
|
@@ -1590,17 +1810,29 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1590
1810
|
tags: ["deployments"],
|
|
1591
1811
|
successDescription: "The deployment details"
|
|
1592
1812
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1593
|
-
const
|
|
1813
|
+
const logEntrySchema = z.object({
|
|
1814
|
+
timestamp: z.coerce.date(),
|
|
1815
|
+
type: z.enum([
|
|
1816
|
+
"START",
|
|
1817
|
+
"END",
|
|
1818
|
+
"INFO",
|
|
1819
|
+
"ERROR",
|
|
1820
|
+
"WARNING",
|
|
1821
|
+
"DEBUG"
|
|
1822
|
+
]),
|
|
1823
|
+
requestId: z.string(),
|
|
1824
|
+
content: z.string().optional(),
|
|
1825
|
+
method: z.string().optional(),
|
|
1826
|
+
durationInMs: z.number().optional()
|
|
1827
|
+
});
|
|
1828
|
+
const getLogsContractV1 = base.route({
|
|
1594
1829
|
path: "/v1/environments/{environmentId}/logs",
|
|
1595
1830
|
method: "GET",
|
|
1596
1831
|
summary: "Get logs",
|
|
1597
1832
|
description: "Get logs for an environment",
|
|
1598
1833
|
tags: ["environments"],
|
|
1599
1834
|
successDescription: "The logs"
|
|
1600
|
-
}).errors({
|
|
1601
|
-
NOT_FOUND: {},
|
|
1602
|
-
BAD_REQUEST: {}
|
|
1603
|
-
}).input(z.object({
|
|
1835
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1604
1836
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1605
1837
|
since: z.string().refine(isValidLogTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." }).optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1606
1838
|
until: z.string().refine(isValidLogTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." }).optional().describe("End time — ISO 8601 or relative"),
|
|
@@ -1614,34 +1846,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1614
1846
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1615
1847
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1616
1848
|
})).output(z.object({
|
|
1617
|
-
logs: z.array(
|
|
1618
|
-
timestamp: z.coerce.date(),
|
|
1619
|
-
type: z.enum([
|
|
1620
|
-
"START",
|
|
1621
|
-
"END",
|
|
1622
|
-
"INFO",
|
|
1623
|
-
"ERROR",
|
|
1624
|
-
"WARNING",
|
|
1625
|
-
"DEBUG"
|
|
1626
|
-
]),
|
|
1627
|
-
requestId: z.string(),
|
|
1628
|
-
content: z.string().optional(),
|
|
1629
|
-
method: z.string().optional(),
|
|
1630
|
-
durationInMs: z.number().optional()
|
|
1631
|
-
})),
|
|
1849
|
+
logs: z.array(logEntrySchema),
|
|
1632
1850
|
nextToken: z.string().nullable()
|
|
1633
1851
|
}));
|
|
1634
|
-
const getLatestLogsContractV1 =
|
|
1852
|
+
const getLatestLogsContractV1 = base.route({
|
|
1635
1853
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1636
1854
|
method: "GET",
|
|
1637
1855
|
summary: "Get latest logs",
|
|
1638
1856
|
description: "Get the N most recent logs for an environment",
|
|
1639
1857
|
tags: ["environments"],
|
|
1640
1858
|
successDescription: "The latest logs"
|
|
1641
|
-
}).errors({
|
|
1642
|
-
NOT_FOUND: {},
|
|
1643
|
-
BAD_REQUEST: {}
|
|
1644
|
-
}).input(z.object({
|
|
1859
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1645
1860
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1646
1861
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1647
1862
|
level: z.array(z.enum([
|
|
@@ -1651,22 +1866,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1651
1866
|
"DEBUG"
|
|
1652
1867
|
])).optional().describe("Filter by log level"),
|
|
1653
1868
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1654
|
-
})).output(z.object({ logs: z.array(
|
|
1655
|
-
|
|
1656
|
-
type: z.enum([
|
|
1657
|
-
"START",
|
|
1658
|
-
"END",
|
|
1659
|
-
"INFO",
|
|
1660
|
-
"ERROR",
|
|
1661
|
-
"WARNING",
|
|
1662
|
-
"DEBUG"
|
|
1663
|
-
]),
|
|
1664
|
-
requestId: z.string(),
|
|
1665
|
-
content: z.string().optional(),
|
|
1666
|
-
method: z.string().optional(),
|
|
1667
|
-
durationInMs: z.number().optional()
|
|
1668
|
-
})) }));
|
|
1669
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1869
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1870
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1670
1871
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1671
1872
|
method: "GET",
|
|
1672
1873
|
summary: "Get deployment logs",
|
|
@@ -1693,17 +1894,14 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1693
1894
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1694
1895
|
task_count: z.array(analyticsDataPointSchema)
|
|
1695
1896
|
});
|
|
1696
|
-
const getProjectAnalyticsContractV1 =
|
|
1897
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1697
1898
|
path: "/v1/analytics/{projectId}",
|
|
1698
1899
|
method: "GET",
|
|
1699
1900
|
summary: "Get project analytics",
|
|
1700
1901
|
description: "Get analytics data for a project over a time range",
|
|
1701
1902
|
tags: ["analytics"],
|
|
1702
1903
|
successDescription: "The project analytics data"
|
|
1703
|
-
}).errors({
|
|
1704
|
-
NOT_FOUND: {},
|
|
1705
|
-
BAD_REQUEST: {}
|
|
1706
|
-
}).input(z.object({
|
|
1904
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1707
1905
|
projectId: z.string().describe("The ID of the project"),
|
|
1708
1906
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1709
1907
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
@@ -1718,7 +1916,7 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1718
1916
|
}),
|
|
1719
1917
|
timeSeries: analyticsTimeSeriesSchema
|
|
1720
1918
|
}));
|
|
1721
|
-
const listTeamsContractV1 =
|
|
1919
|
+
const listTeamsContractV1 = base.route({
|
|
1722
1920
|
path: "/v1/teams",
|
|
1723
1921
|
method: "GET",
|
|
1724
1922
|
summary: "List teams",
|
|
@@ -1731,28 +1929,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
1731
1929
|
createdAt: z.coerce.date(),
|
|
1732
1930
|
hasStripeAccount: z.boolean()
|
|
1733
1931
|
})));
|
|
1734
|
-
const
|
|
1932
|
+
const getTeamUsageContractV1 = base.route({
|
|
1933
|
+
path: "/v1/teams/{teamId}/usage",
|
|
1934
|
+
method: "GET",
|
|
1935
|
+
summary: "Get team usage",
|
|
1936
|
+
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.",
|
|
1937
|
+
tags: ["teams"],
|
|
1938
|
+
successDescription: "The current billing window usage"
|
|
1939
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
1940
|
+
teamId: z.string(),
|
|
1941
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
1942
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
1943
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
1944
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
1945
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
1946
|
+
}));
|
|
1947
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1735
1948
|
path: "/v1/tunnels/ticket",
|
|
1736
1949
|
method: "GET",
|
|
1737
1950
|
summary: "Get a tunnel ticket",
|
|
1738
1951
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1739
1952
|
tags: ["tunnels"],
|
|
1740
1953
|
successDescription: "The tunnel ticket"
|
|
1741
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1954
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1742
1955
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1743
1956
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1744
1957
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1745
1958
|
}));
|
|
1746
|
-
const publishServerContractV1 =
|
|
1959
|
+
const publishServerContractV1 = base.route({
|
|
1747
1960
|
path: "/v1/distribution/publish",
|
|
1748
1961
|
method: "POST",
|
|
1749
1962
|
summary: "Publish a server to the MCP registry",
|
|
1750
1963
|
tags: ["distribution"],
|
|
1751
1964
|
successDescription: "The server has been published successfully"
|
|
1752
|
-
}).errors({
|
|
1753
|
-
NOT_FOUND: {},
|
|
1754
|
-
BAD_REQUEST: {}
|
|
1755
|
-
}).input(z.object({
|
|
1965
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1756
1966
|
projectId: z.string(),
|
|
1757
1967
|
domain: z.string(),
|
|
1758
1968
|
title: z.string().min(1).max(100),
|
|
@@ -1761,17 +1971,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1761
1971
|
iconSrc: z.url().max(255).optional(),
|
|
1762
1972
|
dryRun: z.boolean().optional()
|
|
1763
1973
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1764
|
-
const getServerInfoContractV1 =
|
|
1974
|
+
const getServerInfoContractV1 = base.route({
|
|
1765
1975
|
path: "/v1/distribution/get",
|
|
1766
1976
|
method: "GET",
|
|
1767
1977
|
summary: "Get server info",
|
|
1768
1978
|
description: "Get info about a server",
|
|
1769
1979
|
tags: ["distribution"],
|
|
1770
1980
|
successDescription: "The server info"
|
|
1771
|
-
}).errors({
|
|
1772
|
-
NOT_FOUND: {},
|
|
1773
|
-
BAD_REQUEST: {}
|
|
1774
|
-
}).input(z.object({
|
|
1981
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1775
1982
|
projectId: z.string(),
|
|
1776
1983
|
domain: z.string()
|
|
1777
1984
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1790,7 +1997,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1790
1997
|
isPlaygroundEnabled: z.boolean(),
|
|
1791
1998
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1792
1999
|
});
|
|
1793
|
-
const getPlaygroundContractV1 =
|
|
2000
|
+
const getPlaygroundContractV1 = base.route({
|
|
1794
2001
|
path: "/v1/environments/{environmentId}/playground",
|
|
1795
2002
|
method: "GET",
|
|
1796
2003
|
summary: "Get playground configuration",
|
|
@@ -1798,17 +2005,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1798
2005
|
tags: ["environments"],
|
|
1799
2006
|
successDescription: "The playground configuration"
|
|
1800
2007
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1801
|
-
const upsertPlaygroundContractV1 =
|
|
2008
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1802
2009
|
path: "/v1/environments/{environmentId}/playground",
|
|
1803
2010
|
method: "PUT",
|
|
1804
2011
|
summary: "Update playground configuration",
|
|
1805
2012
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1806
2013
|
tags: ["environments"],
|
|
1807
2014
|
successDescription: "The updated playground configuration"
|
|
1808
|
-
}).errors({
|
|
1809
|
-
NOT_FOUND: {},
|
|
1810
|
-
BAD_REQUEST: {}
|
|
1811
|
-
}).input(z.object({
|
|
2015
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1812
2016
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1813
2017
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1814
2018
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1816,7 +2020,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1816
2020
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1817
2021
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1818
2022
|
})).output(playgroundOutputSchema);
|
|
1819
|
-
const createBeaconContractV1 =
|
|
2023
|
+
const createBeaconContractV1 = base.route({
|
|
1820
2024
|
path: "/v1/beacon/audits",
|
|
1821
2025
|
method: "POST",
|
|
1822
2026
|
summary: "Create a beacon audit",
|
|
@@ -1825,7 +2029,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1825
2029
|
successDescription: "The audit has been created"
|
|
1826
2030
|
}).errors({
|
|
1827
2031
|
NOT_FOUND: {},
|
|
1828
|
-
BAD_REQUEST: {},
|
|
1829
2032
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1830
2033
|
}).input(z.object({
|
|
1831
2034
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1833,7 +2036,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1833
2036
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1834
2037
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1835
2038
|
})).output(z.object({ id: z.string() }));
|
|
1836
|
-
const getBeaconContractV1 =
|
|
2039
|
+
const getBeaconContractV1 = base.route({
|
|
1837
2040
|
path: "/v1/beacon/audits/{auditId}",
|
|
1838
2041
|
method: "GET",
|
|
1839
2042
|
summary: "Get a beacon audit",
|
|
@@ -1849,7 +2052,10 @@ const getBeaconContractV1 = oc.route({
|
|
|
1849
2052
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1850
2053
|
}));
|
|
1851
2054
|
const contract = {
|
|
1852
|
-
teams: {
|
|
2055
|
+
teams: {
|
|
2056
|
+
list: { v1: listTeamsContractV1 },
|
|
2057
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2058
|
+
},
|
|
1853
2059
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
1854
2060
|
deployments: {
|
|
1855
2061
|
list: { v1: listDeploymentsContractV1 },
|
|
@@ -1891,5 +2097,10 @@ const contract = {
|
|
|
1891
2097
|
get: { v1: getBeaconContractV1 }
|
|
1892
2098
|
}
|
|
1893
2099
|
};
|
|
2100
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2101
|
+
const contractForDocs = {
|
|
2102
|
+
...contract,
|
|
2103
|
+
deployments: deploymentsForDocs
|
|
2104
|
+
};
|
|
1894
2105
|
//#endregion
|
|
1895
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2106
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|