@alpic-ai/api 0.0.0-dev.gf7a51de → 0.0.0-dev.gf7f9752
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 +1051 -49
- package/dist/index.mjs +574 -381
- 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),
|
|
@@ -369,12 +394,21 @@ const environmentSchema$1 = z.object({
|
|
|
369
394
|
updatedAt: z.coerce.date()
|
|
370
395
|
});
|
|
371
396
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
397
|
+
z.object({
|
|
398
|
+
sessionReplayEnabled: z.boolean(),
|
|
399
|
+
collectRequestPayload: z.boolean(),
|
|
400
|
+
collectResponsePayload: z.boolean(),
|
|
401
|
+
collectErrorMessage: z.boolean(),
|
|
402
|
+
collectUserData: z.boolean(),
|
|
403
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
404
|
+
});
|
|
372
405
|
z.object({
|
|
373
406
|
id: z.string(),
|
|
374
407
|
createdAt: z.coerce.date(),
|
|
375
408
|
environmentId: z.string(),
|
|
376
409
|
content: z.string(),
|
|
377
|
-
source: z.enum(["model", "user"])
|
|
410
|
+
source: z.enum(["model", "user"]),
|
|
411
|
+
clientName: z.string().nullable()
|
|
378
412
|
});
|
|
379
413
|
z.object({
|
|
380
414
|
content: z.string(),
|
|
@@ -410,6 +444,7 @@ z.object({
|
|
|
410
444
|
environmentId: z.string(),
|
|
411
445
|
toolName: z.string(),
|
|
412
446
|
message: z.string(),
|
|
447
|
+
clientName: z.string().nullable(),
|
|
413
448
|
categories: z.array(intentCategorySchema)
|
|
414
449
|
});
|
|
415
450
|
const signalCategorySchema = z.object({
|
|
@@ -474,6 +509,246 @@ z.enum([
|
|
|
474
509
|
"DEBUG",
|
|
475
510
|
"ERROR"
|
|
476
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]));
|
|
477
752
|
const runtimeSchema = z.enum([
|
|
478
753
|
"python3.13",
|
|
479
754
|
"python3.14",
|
|
@@ -502,15 +777,27 @@ z.object({
|
|
|
502
777
|
environments: z.array(environmentWithDomainsSchema),
|
|
503
778
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
504
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
|
+
});
|
|
505
790
|
z.object({
|
|
506
|
-
|
|
791
|
+
name: z.string(),
|
|
507
792
|
createdAt: z.coerce.date(),
|
|
508
793
|
status: z.enum([
|
|
509
794
|
"ongoing",
|
|
510
795
|
"deployed",
|
|
511
796
|
"failed"
|
|
512
797
|
]),
|
|
513
|
-
|
|
798
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
799
|
+
environment: environmentSchema$1,
|
|
800
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
514
801
|
});
|
|
515
802
|
const serverFieldsSchema$1 = z.object({
|
|
516
803
|
$schema: z.string(),
|
|
@@ -539,15 +826,7 @@ z.object({
|
|
|
539
826
|
serverFields: serverFieldsSchema$1,
|
|
540
827
|
source: z.enum(["registry", "defaults"])
|
|
541
828
|
});
|
|
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
|
-
*/
|
|
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. */
|
|
551
830
|
const clampStringField = (field) => {
|
|
552
831
|
const max = field.maxLength;
|
|
553
832
|
if (max === null) return field;
|
|
@@ -567,17 +846,20 @@ const toolDefinitionSchema = z.object({
|
|
|
567
846
|
}).optional()
|
|
568
847
|
});
|
|
569
848
|
const positiveTestCaseSchema = z.object({
|
|
570
|
-
scenario: z.string(),
|
|
571
|
-
userPrompt: z.string(),
|
|
572
|
-
toolTriggered: z.string().optional(),
|
|
573
|
-
expectedOutput: z.string().optional()
|
|
849
|
+
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
850
|
+
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."),
|
|
851
|
+
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
852
|
+
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
574
853
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
575
854
|
const screenshotEntrySchema = z.object({
|
|
576
855
|
prompt: z.string(),
|
|
577
|
-
url: z.url()
|
|
856
|
+
url: z.url()
|
|
578
857
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
858
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
579
859
|
/** Accepts either a valid email or URL. */
|
|
580
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)" });
|
|
581
863
|
const chatgptCategorySchema = z.enum([
|
|
582
864
|
"BUSINESS",
|
|
583
865
|
"COLLABORATION",
|
|
@@ -886,15 +1168,11 @@ const negativeTestCaseSchema = z.object({
|
|
|
886
1168
|
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
887
1169
|
const chatgptToolJustificationSchema = z.object({
|
|
888
1170
|
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
|
-
*/
|
|
1171
|
+
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
1172
|
+
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
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.\"")
|
|
1174
|
+
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
1175
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
898
1176
|
const chatgptTaglineSchema = z.string().max(30);
|
|
899
1177
|
const chatgptDescriptionSchema = z.string();
|
|
900
1178
|
const chatgptTranslationSchema = z.object({
|
|
@@ -903,35 +1181,43 @@ const chatgptTranslationSchema = z.object({
|
|
|
903
1181
|
description: chatgptDescriptionSchema
|
|
904
1182
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
905
1183
|
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
|
-
*/
|
|
1184
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
910
1185
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
911
1186
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
912
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."),
|
|
913
1188
|
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."),
|
|
1189
|
+
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
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)."),
|
|
916
1191
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
917
1192
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
918
|
-
companyUrl:
|
|
1193
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
919
1194
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
920
|
-
privacyPolicyUrl:
|
|
921
|
-
termsOfServiceUrl:
|
|
922
|
-
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."),
|
|
923
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."),
|
|
924
|
-
serverUrl:
|
|
1199
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
925
1200
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
926
1201
|
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).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."),
|
|
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."),
|
|
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."),
|
|
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."),
|
|
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."),
|
|
931
1206
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
932
1207
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
933
1208
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
934
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
|
+
});
|
|
935
1221
|
chatgptSubmissionFormDataSchema.pick({
|
|
936
1222
|
appName: true,
|
|
937
1223
|
developerName: true,
|
|
@@ -948,7 +1234,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
948
1234
|
toolJustifications: true
|
|
949
1235
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
950
1236
|
const claudeCategorySchema = z.enum([
|
|
951
|
-
"
|
|
1237
|
+
"Productivity",
|
|
952
1238
|
"Communication",
|
|
953
1239
|
"Data & Analytics",
|
|
954
1240
|
"Development tools",
|
|
@@ -956,221 +1242,162 @@ const claudeCategorySchema = z.enum([
|
|
|
956
1242
|
"Consumer Health",
|
|
957
1243
|
"Health & Life Sciences",
|
|
958
1244
|
"Media & Entertainment",
|
|
959
|
-
"Commerce & Shopping"
|
|
1245
|
+
"Commerce & Shopping",
|
|
1246
|
+
"Legal",
|
|
1247
|
+
"Sales and marketing",
|
|
1248
|
+
"Creative",
|
|
1249
|
+
"Nonprofit",
|
|
1250
|
+
"Education",
|
|
1251
|
+
"Other"
|
|
960
1252
|
]);
|
|
961
|
-
const
|
|
962
|
-
"No auth needed",
|
|
963
|
-
"OAuth 2.0",
|
|
964
|
-
"Custom URL"
|
|
965
|
-
]);
|
|
966
|
-
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
967
|
-
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.`;
|
|
968
1254
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
969
|
-
"
|
|
970
|
-
"
|
|
971
|
-
"
|
|
972
|
-
]);
|
|
973
|
-
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
974
|
-
const claudeTestedSurfaceSchema = z.enum([
|
|
975
|
-
"Claude.ai (web)",
|
|
976
|
-
"Claude Desktop",
|
|
977
|
-
"Claude Code",
|
|
978
|
-
"Cowork"
|
|
1255
|
+
"read_only",
|
|
1256
|
+
"write_only",
|
|
1257
|
+
"read_write"
|
|
979
1258
|
]);
|
|
980
|
-
const
|
|
981
|
-
"
|
|
982
|
-
"
|
|
983
|
-
"
|
|
984
|
-
"
|
|
985
|
-
"
|
|
1259
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1260
|
+
"oauth_dcr",
|
|
1261
|
+
"oauth_cimd",
|
|
1262
|
+
"oauth_anthropic_creds",
|
|
1263
|
+
"custom_connection",
|
|
1264
|
+
"none"
|
|
986
1265
|
]);
|
|
987
|
-
const
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"GDPR compliant (if applicable)"
|
|
1266
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1267
|
+
"first_party",
|
|
1268
|
+
"proxied",
|
|
1269
|
+
"third_party"
|
|
992
1270
|
]);
|
|
993
|
-
const
|
|
994
|
-
|
|
995
|
-
"
|
|
996
|
-
"
|
|
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."
|
|
997
1280
|
]);
|
|
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
|
-
*/
|
|
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. */
|
|
1002
1282
|
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.`)
|
|
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()
|
|
1133
1357
|
});
|
|
1134
1358
|
claudeSubmissionFormDataSchema.pick({
|
|
1135
|
-
companyName: true,
|
|
1136
|
-
appName: true,
|
|
1137
|
-
mcpUrlType: true,
|
|
1138
1359
|
serverUrl: true,
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
transportSupport: true,
|
|
1360
|
+
name: true,
|
|
1361
|
+
slug: true,
|
|
1362
|
+
companyName: true,
|
|
1143
1363
|
primaryContactEmail: true,
|
|
1144
1364
|
primaryContactName: true,
|
|
1365
|
+
readWriteCapabilities: true,
|
|
1145
1366
|
authentication: true,
|
|
1146
|
-
|
|
1147
|
-
|
|
1367
|
+
apiOwnership: true,
|
|
1368
|
+
personalHealthData: true
|
|
1148
1369
|
}).extend({
|
|
1149
1370
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1150
|
-
|
|
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))
|
|
1151
1383
|
});
|
|
1152
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1153
|
-
tagline: true,
|
|
1154
|
-
description: true,
|
|
1155
|
-
category: true,
|
|
1156
|
-
testCases: true
|
|
1157
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1158
1384
|
const submissionMetaFieldsSchema = z.object({
|
|
1159
1385
|
id: z.string(),
|
|
1160
1386
|
environmentId: z.string(),
|
|
1387
|
+
auditId: z.string().nullable(),
|
|
1161
1388
|
createdAt: z.coerce.date(),
|
|
1162
1389
|
updatedAt: z.coerce.date()
|
|
1163
1390
|
});
|
|
1164
1391
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1165
1392
|
platform: z.literal("claudeai"),
|
|
1166
|
-
formData:
|
|
1393
|
+
formData: claudeSubmissionDraftSchema
|
|
1167
1394
|
});
|
|
1168
1395
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1169
1396
|
platform: z.literal("chatgpt"),
|
|
1170
|
-
formData:
|
|
1397
|
+
formData: chatgptSubmissionDraftSchema
|
|
1171
1398
|
});
|
|
1172
1399
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1173
|
-
z.union([
|
|
1400
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1174
1401
|
const subscriptionPlanSchema = z.enum([
|
|
1175
1402
|
"pro",
|
|
1176
1403
|
"business",
|
|
@@ -1194,6 +1421,12 @@ z.object({
|
|
|
1194
1421
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1195
1422
|
});
|
|
1196
1423
|
//#endregion
|
|
1424
|
+
//#region src/auth-scope.ts
|
|
1425
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1426
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1427
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1428
|
+
const AUTH_SCOPE_USER = "user";
|
|
1429
|
+
//#endregion
|
|
1197
1430
|
//#region src/schemas.ts
|
|
1198
1431
|
const RESERVED_KEYS = [
|
|
1199
1432
|
"_HANDLER",
|
|
@@ -1229,7 +1462,10 @@ const RESERVED_KEYS = [
|
|
|
1229
1462
|
"BUILD_ARG_START_COMMAND",
|
|
1230
1463
|
"ALPIC_HOST",
|
|
1231
1464
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1232
|
-
"ALPIC_INTENT_META_KEY"
|
|
1465
|
+
"ALPIC_INTENT_META_KEY",
|
|
1466
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1467
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1468
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1233
1469
|
];
|
|
1234
1470
|
const environmentVariableSchema = z.object({
|
|
1235
1471
|
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"),
|
|
@@ -1314,17 +1550,15 @@ const isValidLogTimeInput = (value) => {
|
|
|
1314
1550
|
if (ms(value) !== void 0) return true;
|
|
1315
1551
|
return !Number.isNaN(new Date(value).getTime());
|
|
1316
1552
|
};
|
|
1317
|
-
const
|
|
1553
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1554
|
+
const createEnvironmentContractV1 = base.route({
|
|
1318
1555
|
path: "/v1/environments",
|
|
1319
1556
|
method: "POST",
|
|
1320
1557
|
summary: "Create an environment",
|
|
1321
1558
|
description: "Create an environment for a project",
|
|
1322
1559
|
tags: ["environments"],
|
|
1323
1560
|
successDescription: "The environment has been created successfully"
|
|
1324
|
-
}).errors({
|
|
1325
|
-
NOT_FOUND: {},
|
|
1326
|
-
BAD_REQUEST: {}
|
|
1327
|
-
}).input(z.object({
|
|
1561
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1328
1562
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1329
1563
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1330
1564
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1337,7 +1571,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1337
1571
|
createdAt: z.coerce.date(),
|
|
1338
1572
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1339
1573
|
}));
|
|
1340
|
-
const getEnvironmentContractV1 =
|
|
1574
|
+
const getEnvironmentContractV1 = base.route({
|
|
1341
1575
|
path: "/v1/environments/{environmentId}",
|
|
1342
1576
|
method: "GET",
|
|
1343
1577
|
summary: "Get an environment",
|
|
@@ -1394,7 +1628,7 @@ const projectOutputSchema = z.object({
|
|
|
1394
1628
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1395
1629
|
environments: z.array(environmentSchema)
|
|
1396
1630
|
});
|
|
1397
|
-
const getProjectContractV1 =
|
|
1631
|
+
const getProjectContractV1 = base.route({
|
|
1398
1632
|
path: "/v1/projects/{projectId}",
|
|
1399
1633
|
method: "GET",
|
|
1400
1634
|
summary: "Get a project",
|
|
@@ -1402,18 +1636,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1402
1636
|
tags: ["projects"],
|
|
1403
1637
|
successDescription: "The project details"
|
|
1404
1638
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1405
|
-
const listProjectsContractV1 =
|
|
1639
|
+
const listProjectsContractV1 = base.route({
|
|
1406
1640
|
path: "/v1/projects",
|
|
1407
1641
|
method: "GET",
|
|
1408
1642
|
summary: "List projects",
|
|
1409
1643
|
description: "List all projects for a team",
|
|
1410
1644
|
tags: ["projects"],
|
|
1411
1645
|
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({
|
|
1646
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1647
|
+
const createProjectContractV1 = base.route({
|
|
1417
1648
|
path: "/v1/projects",
|
|
1418
1649
|
method: "POST",
|
|
1419
1650
|
summary: "Create a project",
|
|
@@ -1422,7 +1653,7 @@ const createProjectContractV1 = oc.route({
|
|
|
1422
1653
|
successDescription: "The project has been created successfully"
|
|
1423
1654
|
}).errors({
|
|
1424
1655
|
NOT_FOUND: {},
|
|
1425
|
-
|
|
1656
|
+
FORBIDDEN: {}
|
|
1426
1657
|
}).input(z.object({
|
|
1427
1658
|
teamId: z.string().optional(),
|
|
1428
1659
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1462,7 +1693,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1462
1693
|
isSecret: z.boolean(),
|
|
1463
1694
|
createdAt: z.coerce.date()
|
|
1464
1695
|
});
|
|
1465
|
-
const listEnvironmentVariablesContractV1 =
|
|
1696
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1466
1697
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1467
1698
|
method: "GET",
|
|
1468
1699
|
summary: "List environment variables",
|
|
@@ -1470,48 +1701,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1470
1701
|
tags: ["environments"],
|
|
1471
1702
|
successDescription: "The list of environment variables"
|
|
1472
1703
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1473
|
-
const createEnvironmentVariablesContractV1 =
|
|
1704
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1474
1705
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1475
1706
|
method: "POST",
|
|
1476
1707
|
summary: "Add environment variables",
|
|
1477
1708
|
description: "Add one or more environment variables to an environment",
|
|
1478
1709
|
tags: ["environments"],
|
|
1479
1710
|
successDescription: "The environment variables have been added successfully"
|
|
1480
|
-
}).errors({
|
|
1481
|
-
NOT_FOUND: {},
|
|
1482
|
-
BAD_REQUEST: {}
|
|
1483
|
-
}).input(z.object({
|
|
1711
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1484
1712
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1485
1713
|
environmentVariables: environmentVariablesSchema
|
|
1486
1714
|
})).output(z.object({ success: z.literal(true) }));
|
|
1487
|
-
const updateEnvironmentVariableContractV1 =
|
|
1715
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1488
1716
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1489
1717
|
method: "PATCH",
|
|
1490
1718
|
summary: "Update an environment variable",
|
|
1491
1719
|
description: "Update an environment variable by ID",
|
|
1492
1720
|
tags: ["environments"],
|
|
1493
1721
|
successDescription: "The environment variable has been updated successfully"
|
|
1494
|
-
}).errors({
|
|
1495
|
-
NOT_FOUND: {},
|
|
1496
|
-
BAD_REQUEST: {}
|
|
1497
|
-
}).input(z.object({
|
|
1722
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1498
1723
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1499
1724
|
key: environmentVariableSchema.shape.key,
|
|
1500
1725
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1501
1726
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1502
1727
|
})).output(z.object({ success: z.literal(true) }));
|
|
1503
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1728
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1504
1729
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1505
1730
|
method: "DELETE",
|
|
1506
1731
|
summary: "Delete an environment variable",
|
|
1507
1732
|
description: "Delete an environment variable by ID",
|
|
1508
1733
|
tags: ["environments"],
|
|
1509
1734
|
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({
|
|
1735
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1736
|
+
const deleteProjectContractV1 = base.route({
|
|
1515
1737
|
path: "/v1/projects/{projectId}",
|
|
1516
1738
|
method: "DELETE",
|
|
1517
1739
|
summary: "Delete a project",
|
|
@@ -1519,7 +1741,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1519
1741
|
tags: ["projects"],
|
|
1520
1742
|
successDescription: "The project has been deleted successfully"
|
|
1521
1743
|
}).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 =
|
|
1744
|
+
const updateProjectContractV1 = base.route({
|
|
1523
1745
|
path: "/v1/projects/{projectId}",
|
|
1524
1746
|
method: "PATCH",
|
|
1525
1747
|
summary: "Update a project",
|
|
@@ -1528,13 +1750,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1528
1750
|
successDescription: "The project has been updated successfully"
|
|
1529
1751
|
}).errors({
|
|
1530
1752
|
NOT_FOUND: {},
|
|
1531
|
-
|
|
1753
|
+
FORBIDDEN: {}
|
|
1532
1754
|
}).input(z.object({
|
|
1533
1755
|
projectId: z.string().describe("The ID of the project"),
|
|
1534
1756
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1535
1757
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1536
1758
|
})).output(projectOutputSchema);
|
|
1537
|
-
const deployEnvironmentContractV1 =
|
|
1759
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1538
1760
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1539
1761
|
method: "POST",
|
|
1540
1762
|
summary: "Deploy an environment",
|
|
@@ -1543,27 +1765,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1543
1765
|
successDescription: "The environment has been deployed successfully"
|
|
1544
1766
|
}).errors({
|
|
1545
1767
|
NOT_FOUND: {},
|
|
1546
|
-
|
|
1768
|
+
CONFLICT: {}
|
|
1547
1769
|
}).input(z.object({
|
|
1548
1770
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1549
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1771
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1772
|
+
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
1773
|
})).output(deploymentSchema);
|
|
1551
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1774
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1552
1775
|
path: "/v1/deployments/upload",
|
|
1553
1776
|
method: "POST",
|
|
1554
1777
|
summary: "Upload deployment artifacts",
|
|
1555
1778
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1556
1779
|
tags: ["deployments"],
|
|
1557
1780
|
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({
|
|
1781
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1562
1782
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1563
1783
|
token: z.string().describe("Token to identify the source archive"),
|
|
1564
1784
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1565
1785
|
}));
|
|
1566
|
-
const listDeploymentsContractV1 =
|
|
1786
|
+
const listDeploymentsContractV1 = base.route({
|
|
1567
1787
|
path: "/v1/projects/{projectId}/deployments",
|
|
1568
1788
|
method: "GET",
|
|
1569
1789
|
summary: "List project deployments",
|
|
@@ -1575,7 +1795,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1575
1795
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1576
1796
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1577
1797
|
})).output(z.array(deploymentSchema));
|
|
1578
|
-
const getDeploymentContractV1 =
|
|
1798
|
+
const getDeploymentContractV1 = base.route({
|
|
1579
1799
|
path: "/v1/deployments/{deploymentId}",
|
|
1580
1800
|
method: "GET",
|
|
1581
1801
|
summary: "Get a deployment",
|
|
@@ -1583,17 +1803,29 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1583
1803
|
tags: ["deployments"],
|
|
1584
1804
|
successDescription: "The deployment details"
|
|
1585
1805
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1586
|
-
const
|
|
1806
|
+
const logEntrySchema = z.object({
|
|
1807
|
+
timestamp: z.coerce.date(),
|
|
1808
|
+
type: z.enum([
|
|
1809
|
+
"START",
|
|
1810
|
+
"END",
|
|
1811
|
+
"INFO",
|
|
1812
|
+
"ERROR",
|
|
1813
|
+
"WARNING",
|
|
1814
|
+
"DEBUG"
|
|
1815
|
+
]),
|
|
1816
|
+
requestId: z.string(),
|
|
1817
|
+
content: z.string().optional(),
|
|
1818
|
+
method: z.string().optional(),
|
|
1819
|
+
durationInMs: z.number().optional()
|
|
1820
|
+
});
|
|
1821
|
+
const getLogsContractV1 = base.route({
|
|
1587
1822
|
path: "/v1/environments/{environmentId}/logs",
|
|
1588
1823
|
method: "GET",
|
|
1589
1824
|
summary: "Get logs",
|
|
1590
1825
|
description: "Get logs for an environment",
|
|
1591
1826
|
tags: ["environments"],
|
|
1592
1827
|
successDescription: "The logs"
|
|
1593
|
-
}).errors({
|
|
1594
|
-
NOT_FOUND: {},
|
|
1595
|
-
BAD_REQUEST: {}
|
|
1596
|
-
}).input(z.object({
|
|
1828
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1597
1829
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1598
1830
|
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)"),
|
|
1599
1831
|
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"),
|
|
@@ -1607,34 +1839,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1607
1839
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1608
1840
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1609
1841
|
})).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
|
-
})),
|
|
1842
|
+
logs: z.array(logEntrySchema),
|
|
1625
1843
|
nextToken: z.string().nullable()
|
|
1626
1844
|
}));
|
|
1627
|
-
const getLatestLogsContractV1 =
|
|
1845
|
+
const getLatestLogsContractV1 = base.route({
|
|
1628
1846
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1629
1847
|
method: "GET",
|
|
1630
1848
|
summary: "Get latest logs",
|
|
1631
1849
|
description: "Get the N most recent logs for an environment",
|
|
1632
1850
|
tags: ["environments"],
|
|
1633
1851
|
successDescription: "The latest logs"
|
|
1634
|
-
}).errors({
|
|
1635
|
-
NOT_FOUND: {},
|
|
1636
|
-
BAD_REQUEST: {}
|
|
1637
|
-
}).input(z.object({
|
|
1852
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1638
1853
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1639
1854
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1640
1855
|
level: z.array(z.enum([
|
|
@@ -1644,22 +1859,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1644
1859
|
"DEBUG"
|
|
1645
1860
|
])).optional().describe("Filter by log level"),
|
|
1646
1861
|
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({
|
|
1862
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1863
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1663
1864
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1664
1865
|
method: "GET",
|
|
1665
1866
|
summary: "Get deployment logs",
|
|
@@ -1686,17 +1887,14 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1686
1887
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1687
1888
|
task_count: z.array(analyticsDataPointSchema)
|
|
1688
1889
|
});
|
|
1689
|
-
const getProjectAnalyticsContractV1 =
|
|
1890
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1690
1891
|
path: "/v1/analytics/{projectId}",
|
|
1691
1892
|
method: "GET",
|
|
1692
1893
|
summary: "Get project analytics",
|
|
1693
1894
|
description: "Get analytics data for a project over a time range",
|
|
1694
1895
|
tags: ["analytics"],
|
|
1695
1896
|
successDescription: "The project analytics data"
|
|
1696
|
-
}).errors({
|
|
1697
|
-
NOT_FOUND: {},
|
|
1698
|
-
BAD_REQUEST: {}
|
|
1699
|
-
}).input(z.object({
|
|
1897
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1700
1898
|
projectId: z.string().describe("The ID of the project"),
|
|
1701
1899
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1702
1900
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
@@ -1711,7 +1909,7 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1711
1909
|
}),
|
|
1712
1910
|
timeSeries: analyticsTimeSeriesSchema
|
|
1713
1911
|
}));
|
|
1714
|
-
const listTeamsContractV1 =
|
|
1912
|
+
const listTeamsContractV1 = base.route({
|
|
1715
1913
|
path: "/v1/teams",
|
|
1716
1914
|
method: "GET",
|
|
1717
1915
|
summary: "List teams",
|
|
@@ -1724,28 +1922,25 @@ const listTeamsContractV1 = oc.route({
|
|
|
1724
1922
|
createdAt: z.coerce.date(),
|
|
1725
1923
|
hasStripeAccount: z.boolean()
|
|
1726
1924
|
})));
|
|
1727
|
-
const getTunnelTicketContractV1 =
|
|
1925
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1728
1926
|
path: "/v1/tunnels/ticket",
|
|
1729
1927
|
method: "GET",
|
|
1730
1928
|
summary: "Get a tunnel ticket",
|
|
1731
1929
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1732
1930
|
tags: ["tunnels"],
|
|
1733
1931
|
successDescription: "The tunnel ticket"
|
|
1734
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1932
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1735
1933
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1736
1934
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1737
1935
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1738
1936
|
}));
|
|
1739
|
-
const publishServerContractV1 =
|
|
1937
|
+
const publishServerContractV1 = base.route({
|
|
1740
1938
|
path: "/v1/distribution/publish",
|
|
1741
1939
|
method: "POST",
|
|
1742
1940
|
summary: "Publish a server to the MCP registry",
|
|
1743
1941
|
tags: ["distribution"],
|
|
1744
1942
|
successDescription: "The server has been published successfully"
|
|
1745
|
-
}).errors({
|
|
1746
|
-
NOT_FOUND: {},
|
|
1747
|
-
BAD_REQUEST: {}
|
|
1748
|
-
}).input(z.object({
|
|
1943
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1749
1944
|
projectId: z.string(),
|
|
1750
1945
|
domain: z.string(),
|
|
1751
1946
|
title: z.string().min(1).max(100),
|
|
@@ -1754,17 +1949,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1754
1949
|
iconSrc: z.url().max(255).optional(),
|
|
1755
1950
|
dryRun: z.boolean().optional()
|
|
1756
1951
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1757
|
-
const getServerInfoContractV1 =
|
|
1952
|
+
const getServerInfoContractV1 = base.route({
|
|
1758
1953
|
path: "/v1/distribution/get",
|
|
1759
1954
|
method: "GET",
|
|
1760
1955
|
summary: "Get server info",
|
|
1761
1956
|
description: "Get info about a server",
|
|
1762
1957
|
tags: ["distribution"],
|
|
1763
1958
|
successDescription: "The server info"
|
|
1764
|
-
}).errors({
|
|
1765
|
-
NOT_FOUND: {},
|
|
1766
|
-
BAD_REQUEST: {}
|
|
1767
|
-
}).input(z.object({
|
|
1959
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1768
1960
|
projectId: z.string(),
|
|
1769
1961
|
domain: z.string()
|
|
1770
1962
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1783,7 +1975,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1783
1975
|
isPlaygroundEnabled: z.boolean(),
|
|
1784
1976
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1785
1977
|
});
|
|
1786
|
-
const getPlaygroundContractV1 =
|
|
1978
|
+
const getPlaygroundContractV1 = base.route({
|
|
1787
1979
|
path: "/v1/environments/{environmentId}/playground",
|
|
1788
1980
|
method: "GET",
|
|
1789
1981
|
summary: "Get playground configuration",
|
|
@@ -1791,17 +1983,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1791
1983
|
tags: ["environments"],
|
|
1792
1984
|
successDescription: "The playground configuration"
|
|
1793
1985
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1794
|
-
const upsertPlaygroundContractV1 =
|
|
1986
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1795
1987
|
path: "/v1/environments/{environmentId}/playground",
|
|
1796
1988
|
method: "PUT",
|
|
1797
1989
|
summary: "Update playground configuration",
|
|
1798
1990
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1799
1991
|
tags: ["environments"],
|
|
1800
1992
|
successDescription: "The updated playground configuration"
|
|
1801
|
-
}).errors({
|
|
1802
|
-
NOT_FOUND: {},
|
|
1803
|
-
BAD_REQUEST: {}
|
|
1804
|
-
}).input(z.object({
|
|
1993
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1805
1994
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1806
1995
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1807
1996
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1809,7 +1998,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1809
1998
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1810
1999
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1811
2000
|
})).output(playgroundOutputSchema);
|
|
1812
|
-
const createBeaconContractV1 =
|
|
2001
|
+
const createBeaconContractV1 = base.route({
|
|
1813
2002
|
path: "/v1/beacon/audits",
|
|
1814
2003
|
method: "POST",
|
|
1815
2004
|
summary: "Create a beacon audit",
|
|
@@ -1818,7 +2007,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1818
2007
|
successDescription: "The audit has been created"
|
|
1819
2008
|
}).errors({
|
|
1820
2009
|
NOT_FOUND: {},
|
|
1821
|
-
BAD_REQUEST: {},
|
|
1822
2010
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1823
2011
|
}).input(z.object({
|
|
1824
2012
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1826,7 +2014,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1826
2014
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1827
2015
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1828
2016
|
})).output(z.object({ id: z.string() }));
|
|
1829
|
-
const getBeaconContractV1 =
|
|
2017
|
+
const getBeaconContractV1 = base.route({
|
|
1830
2018
|
path: "/v1/beacon/audits/{auditId}",
|
|
1831
2019
|
method: "GET",
|
|
1832
2020
|
summary: "Get a beacon audit",
|
|
@@ -1884,5 +2072,10 @@ const contract = {
|
|
|
1884
2072
|
get: { v1: getBeaconContractV1 }
|
|
1885
2073
|
}
|
|
1886
2074
|
};
|
|
2075
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2076
|
+
const contractForDocs = {
|
|
2077
|
+
...contract,
|
|
2078
|
+
deployments: deploymentsForDocs
|
|
2079
|
+
};
|
|
1887
2080
|
//#endregion
|
|
1888
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2081
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|