@alpic-ai/api 0.0.0-dev.gd30fef2 → 0.0.0-dev.gd35ddf5

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.
Files changed (3) hide show
  1. package/dist/index.d.mts +994 -60
  2. package/dist/index.mjs +1055 -250
  3. package/package.json +23 -7
package/dist/index.mjs CHANGED
@@ -1,11 +1,189 @@
1
1
  import { z } from "zod";
2
+ import * as z$1 from "zod/v4";
2
3
  import { oc } from "@orpc/contract";
3
4
  import ms from "ms";
4
- const platformSchema = z.enum(["chatgpt", "claudeai"]);
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
+ /**
7
+ * Reusable URL validation that disallows javascript: scheme
8
+ */
9
+ const SafeUrlSchema = z$1.url().superRefine((val, ctx) => {
10
+ if (!URL.canParse(val)) {
11
+ ctx.addIssue({
12
+ code: z$1.ZodIssueCode.custom,
13
+ message: "URL must be parseable",
14
+ fatal: true
15
+ });
16
+ return z$1.NEVER;
17
+ }
18
+ }).refine((url) => {
19
+ const u = new URL(url);
20
+ return u.protocol !== "javascript:" && u.protocol !== "data:" && u.protocol !== "vbscript:";
21
+ }, { message: "URL cannot use javascript:, data:, or vbscript: scheme" });
22
+ /**
23
+ * RFC 9728 OAuth Protected Resource Metadata
24
+ */
25
+ const OAuthProtectedResourceMetadataSchema = z$1.looseObject({
26
+ resource: z$1.string().url(),
27
+ authorization_servers: z$1.array(SafeUrlSchema).optional(),
28
+ jwks_uri: z$1.string().url().optional(),
29
+ scopes_supported: z$1.array(z$1.string()).optional(),
30
+ bearer_methods_supported: z$1.array(z$1.string()).optional(),
31
+ resource_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
32
+ resource_name: z$1.string().optional(),
33
+ resource_documentation: z$1.string().optional(),
34
+ resource_policy_uri: z$1.string().url().optional(),
35
+ resource_tos_uri: z$1.string().url().optional(),
36
+ tls_client_certificate_bound_access_tokens: z$1.boolean().optional(),
37
+ authorization_details_types_supported: z$1.array(z$1.string()).optional(),
38
+ dpop_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
39
+ dpop_bound_access_tokens_required: z$1.boolean().optional()
40
+ });
41
+ /**
42
+ * RFC 8414 OAuth 2.0 Authorization Server Metadata
43
+ */
44
+ const OAuthMetadataSchema = z$1.looseObject({
45
+ issuer: z$1.string(),
46
+ authorization_endpoint: SafeUrlSchema,
47
+ token_endpoint: SafeUrlSchema,
48
+ registration_endpoint: SafeUrlSchema.optional(),
49
+ scopes_supported: z$1.array(z$1.string()).optional(),
50
+ response_types_supported: z$1.array(z$1.string()),
51
+ response_modes_supported: z$1.array(z$1.string()).optional(),
52
+ grant_types_supported: z$1.array(z$1.string()).optional(),
53
+ token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
54
+ token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
55
+ service_documentation: SafeUrlSchema.optional(),
56
+ revocation_endpoint: SafeUrlSchema.optional(),
57
+ revocation_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
58
+ revocation_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
59
+ introspection_endpoint: z$1.string().optional(),
60
+ introspection_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
61
+ introspection_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
62
+ code_challenge_methods_supported: z$1.array(z$1.string()).optional(),
63
+ client_id_metadata_document_supported: z$1.boolean().optional()
64
+ });
65
+ /**
66
+ * OpenID Connect Discovery 1.0 Provider Metadata
67
+ * see: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
68
+ */
69
+ const OpenIdProviderMetadataSchema = z$1.looseObject({
70
+ issuer: z$1.string(),
71
+ authorization_endpoint: SafeUrlSchema,
72
+ token_endpoint: SafeUrlSchema,
73
+ userinfo_endpoint: SafeUrlSchema.optional(),
74
+ jwks_uri: SafeUrlSchema,
75
+ registration_endpoint: SafeUrlSchema.optional(),
76
+ scopes_supported: z$1.array(z$1.string()).optional(),
77
+ response_types_supported: z$1.array(z$1.string()),
78
+ response_modes_supported: z$1.array(z$1.string()).optional(),
79
+ grant_types_supported: z$1.array(z$1.string()).optional(),
80
+ acr_values_supported: z$1.array(z$1.string()).optional(),
81
+ subject_types_supported: z$1.array(z$1.string()),
82
+ id_token_signing_alg_values_supported: z$1.array(z$1.string()),
83
+ id_token_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
84
+ id_token_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
85
+ userinfo_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
86
+ userinfo_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
87
+ userinfo_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
88
+ request_object_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
89
+ request_object_encryption_alg_values_supported: z$1.array(z$1.string()).optional(),
90
+ request_object_encryption_enc_values_supported: z$1.array(z$1.string()).optional(),
91
+ token_endpoint_auth_methods_supported: z$1.array(z$1.string()).optional(),
92
+ token_endpoint_auth_signing_alg_values_supported: z$1.array(z$1.string()).optional(),
93
+ display_values_supported: z$1.array(z$1.string()).optional(),
94
+ claim_types_supported: z$1.array(z$1.string()).optional(),
95
+ claims_supported: z$1.array(z$1.string()).optional(),
96
+ service_documentation: z$1.string().optional(),
97
+ claims_locales_supported: z$1.array(z$1.string()).optional(),
98
+ ui_locales_supported: z$1.array(z$1.string()).optional(),
99
+ claims_parameter_supported: z$1.boolean().optional(),
100
+ request_parameter_supported: z$1.boolean().optional(),
101
+ request_uri_parameter_supported: z$1.boolean().optional(),
102
+ require_request_uri_registration: z$1.boolean().optional(),
103
+ op_policy_uri: SafeUrlSchema.optional(),
104
+ op_tos_uri: SafeUrlSchema.optional(),
105
+ client_id_metadata_document_supported: z$1.boolean().optional()
106
+ });
107
+ /**
108
+ * OpenID Connect Discovery metadata that may include OAuth 2.0 fields
109
+ * This schema represents the real-world scenario where OIDC providers
110
+ * return a mix of OpenID Connect and OAuth 2.0 metadata fields
111
+ */
112
+ const OpenIdProviderDiscoveryMetadataSchema = z$1.object({
113
+ ...OpenIdProviderMetadataSchema.shape,
114
+ ...OAuthMetadataSchema.pick({ code_challenge_methods_supported: true }).shape
115
+ });
116
+ z$1.object({
117
+ access_token: z$1.string(),
118
+ id_token: z$1.string().optional(),
119
+ token_type: z$1.string(),
120
+ expires_in: z$1.coerce.number().optional(),
121
+ scope: z$1.string().optional(),
122
+ refresh_token: z$1.string().optional()
123
+ }).strip();
124
+ z$1.object({
125
+ error: z$1.string(),
126
+ error_description: z$1.string().optional(),
127
+ error_uri: z$1.string().optional()
128
+ });
129
+ /**
130
+ * Optional version of SafeUrlSchema that allows empty string for retrocompatibility on tos_uri and logo_uri
131
+ */
132
+ const OptionalSafeUrlSchema = SafeUrlSchema.optional().or(z$1.literal("").transform(() => void 0));
133
+ /**
134
+ * RFC 7591 OAuth 2.0 Dynamic Client Registration metadata
135
+ */
136
+ const OAuthClientMetadataSchema = z$1.object({
137
+ redirect_uris: z$1.array(SafeUrlSchema),
138
+ token_endpoint_auth_method: z$1.string().optional(),
139
+ grant_types: z$1.array(z$1.string()).optional(),
140
+ response_types: z$1.array(z$1.string()).optional(),
141
+ client_name: z$1.string().optional(),
142
+ client_uri: SafeUrlSchema.optional(),
143
+ logo_uri: OptionalSafeUrlSchema,
144
+ scope: z$1.string().optional(),
145
+ contacts: z$1.array(z$1.string()).optional(),
146
+ tos_uri: OptionalSafeUrlSchema,
147
+ policy_uri: z$1.string().optional(),
148
+ jwks_uri: SafeUrlSchema.optional(),
149
+ jwks: z$1.any().optional(),
150
+ software_id: z$1.string().optional(),
151
+ software_version: z$1.string().optional(),
152
+ software_statement: z$1.string().optional()
153
+ }).strip();
154
+ /**
155
+ * RFC 7591 OAuth 2.0 Dynamic Client Registration client information
156
+ */
157
+ const OAuthClientInformationSchema = z$1.object({
158
+ client_id: z$1.string(),
159
+ client_secret: z$1.string().optional(),
160
+ client_id_issued_at: z$1.number().optional(),
161
+ client_secret_expires_at: z$1.number().optional()
162
+ }).strip();
163
+ OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
164
+ z$1.object({
165
+ error: z$1.string(),
166
+ error_description: z$1.string().optional()
167
+ }).strip();
168
+ z$1.object({
169
+ token: z$1.string(),
170
+ token_type_hint: z$1.string().optional()
171
+ }).strip();
172
+ //#endregion
173
+ //#region ../domains/dist/index.mjs
174
+ const AI_PLATFORMS = ["chatgpt", "claudeai"];
175
+ const platformSchema = z.enum(AI_PLATFORMS);
5
176
  const PLATFORM_LABELS = {
6
177
  chatgpt: "ChatGPT",
7
178
  claudeai: "Claude.ai"
8
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);
9
187
  const auditStatusSchema = z.enum([
10
188
  "pending",
11
189
  "partial",
@@ -71,6 +249,13 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
71
249
  chatgpt: widgetScreenshotSchema.optional(),
72
250
  claudeai: widgetScreenshotSchema.optional()
73
251
  }) });
252
+ z.object({
253
+ id: z.string(),
254
+ environmentId: z.string(),
255
+ clientId: z.string(),
256
+ clientSecret: z.string(),
257
+ clientScopes: z.array(z.string())
258
+ });
74
259
  const deploymentStatusSchema$1 = z.enum([
75
260
  "ongoing",
76
261
  "deployed",
@@ -98,9 +283,91 @@ const deploymentSummarySchema = z.object({
98
283
  createdAt: z.coerce.date(),
99
284
  updatedAt: z.coerce.date()
100
285
  });
101
- const allowedPlatformSchema = platformSchema;
286
+ /** Public environment: answers anonymously and exposes no OAuth metadata. */
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({
322
+ isPublic: z.literal(true),
323
+ oAuthMetadata: z.undefined().optional()
324
+ });
325
+ const legacyExternalResourceMetadataEnvironmentSchema = z.object({
326
+ isPublic: z.literal(false),
327
+ oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
328
+ scope: z.string().optional()
329
+ });
330
+ const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
331
+ isPublic: z.literal(false),
332
+ oAuthMetadata: z.object({
333
+ externalAuthorizationServerUrl: z.url(),
334
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
335
+ }),
336
+ scope: z.string().optional()
337
+ });
338
+ const legacyStandaloneEnvironmentSchema = z.object({
339
+ isPublic: z.literal(false),
340
+ oAuthMetadata: z.object({
341
+ authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
342
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
343
+ }),
344
+ scope: z.string().optional()
345
+ });
346
+ const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
347
+ isPublic: z.literal(false),
348
+ oAuthMetadata: z.strictObject({}),
349
+ scope: z.string().optional()
350
+ });
351
+ z.union([
352
+ publicEnvironmentSchema,
353
+ externalResourceMetadataEnvironmentSchema,
354
+ externalAuthorizationServerEnvironmentSchema,
355
+ standaloneEnvironmentSchema,
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"
368
+ ]);
102
369
  const environmentDomainSchema = z.object({
103
- domain: z.string(),
370
+ name: z.string(),
104
371
  status: z.enum([
105
372
  "ongoing",
106
373
  "deployed",
@@ -118,6 +385,7 @@ const environmentSchema$1 = z.object({
118
385
  latestDeployment: deploymentSummarySchema.optional(),
119
386
  openaiAppsChallenge: z.string().nullable().optional(),
120
387
  isPlaygroundEnabled: z.boolean(),
388
+ playgroundModel: playgroundModelSchema,
121
389
  isIpWhitelistEnabled: z.boolean(),
122
390
  ipAllowlist: z.array(z.string()).nullable(),
123
391
  allowedPlatforms: z.array(allowedPlatformSchema),
@@ -126,6 +394,14 @@ const environmentSchema$1 = z.object({
126
394
  updatedAt: z.coerce.date()
127
395
  });
128
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
+ });
129
405
  z.object({
130
406
  id: z.string(),
131
407
  createdAt: z.coerce.date(),
@@ -231,6 +507,246 @@ z.enum([
231
507
  "DEBUG",
232
508
  "ERROR"
233
509
  ]);
510
+ /** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
511
+ const MCP_CLIENT_GROUPS = [
512
+ {
513
+ id: "claude_code",
514
+ label: "Claude Code",
515
+ vendor: "anthropic",
516
+ rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
517
+ },
518
+ {
519
+ id: "claude",
520
+ label: "Claude",
521
+ vendor: "anthropic",
522
+ rawNames: [
523
+ "Anthropic/ClaudeAI",
524
+ "claude-ai",
525
+ "claude",
526
+ "Claude",
527
+ "claude-desktop",
528
+ "claude-desktop-3p"
529
+ ]
530
+ },
531
+ {
532
+ id: "claude_mobile",
533
+ label: "Claude mobile",
534
+ vendor: "anthropic",
535
+ rawNames: ["claude-ios", "ClaudeAndroid"]
536
+ },
537
+ {
538
+ id: "claude_cowork",
539
+ label: "Claude Cowork",
540
+ vendor: "anthropic",
541
+ rawNames: ["Anthropic/Cowork"]
542
+ },
543
+ {
544
+ id: "claude_toolbox",
545
+ label: "Claude Toolbox",
546
+ vendor: "anthropic",
547
+ rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
548
+ },
549
+ {
550
+ id: "anthropic_api",
551
+ label: "Anthropic API",
552
+ vendor: "anthropic",
553
+ rawNames: ["Anthropic/API"]
554
+ },
555
+ {
556
+ id: "anthropic_connector_refresh",
557
+ label: "Anthropic (connector refresh)",
558
+ vendor: "anthropic",
559
+ rawNames: ["Anthropic"]
560
+ },
561
+ {
562
+ id: "codex",
563
+ label: "Codex",
564
+ vendor: "openai",
565
+ rawNames: [
566
+ "codex-mcp-client",
567
+ "codex",
568
+ "Codex",
569
+ "codex-cli",
570
+ "openai-mcp (Codex)"
571
+ ]
572
+ },
573
+ {
574
+ id: "chatgpt",
575
+ label: "ChatGPT",
576
+ vendor: "openai",
577
+ rawNames: ["openai-mcp (ChatGPT)"]
578
+ },
579
+ {
580
+ id: "openai_responses_api",
581
+ label: "OpenAI Responses API",
582
+ vendor: "openai",
583
+ rawNames: ["openai-mcp (Responses API)"]
584
+ },
585
+ {
586
+ id: "openai_agent_builder",
587
+ label: "OpenAI Agent Builder",
588
+ vendor: "openai",
589
+ rawNames: ["openai-mcp (Agent Builder)"]
590
+ },
591
+ {
592
+ id: "openai_other",
593
+ label: "OpenAI Other",
594
+ vendor: "openai",
595
+ rawNames: ["openai-mcp"]
596
+ },
597
+ {
598
+ id: "cursor",
599
+ label: "Cursor",
600
+ vendor: "cursor",
601
+ rawNames: [
602
+ "cursor-vscode",
603
+ "Cursor",
604
+ "cursor"
605
+ ]
606
+ },
607
+ {
608
+ id: "cline",
609
+ label: "Cline",
610
+ vendor: "cline",
611
+ rawNames: [
612
+ "Cline",
613
+ "cline",
614
+ "@cline/core"
615
+ ]
616
+ },
617
+ {
618
+ id: "github_copilot",
619
+ label: "GitHub Copilot",
620
+ vendor: "githubCopilot",
621
+ rawNames: [
622
+ "Copilot",
623
+ "github-copilot-developer",
624
+ "Copilot MCP Gateway",
625
+ "Xcode/copilot-xcode"
626
+ ]
627
+ },
628
+ {
629
+ id: "gemini_cli",
630
+ label: "Gemini CLI",
631
+ vendor: "google",
632
+ rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
633
+ },
634
+ {
635
+ id: "antigravity",
636
+ label: "Antigravity",
637
+ vendor: "google",
638
+ rawNames: ["antigravity-client"]
639
+ },
640
+ {
641
+ id: "gemini",
642
+ label: "Gemini",
643
+ vendor: "google",
644
+ rawNames: ["Gemini", "google-ai-edge-gallery"]
645
+ },
646
+ {
647
+ id: "windsurf",
648
+ label: "Windsurf",
649
+ vendor: "windsurf",
650
+ rawNames: ["Windsurf", "windsurf-client"]
651
+ },
652
+ {
653
+ id: "mistral",
654
+ label: "Mistral / Le Chat",
655
+ vendor: "mistral",
656
+ rawNames: ["Mistral"],
657
+ rawNamePrefixes: ["connector:custom-mcp:"]
658
+ },
659
+ {
660
+ id: "n8n",
661
+ label: "n8n",
662
+ vendor: "n8n",
663
+ rawNames: [
664
+ "@n8n/n8n-nodes-langchain.mcpClient",
665
+ "@n8n/n8n-nodes-langchain.mcpClientTool",
666
+ "n8n"
667
+ ]
668
+ },
669
+ {
670
+ id: "alpic_playground",
671
+ label: "Alpic Playground",
672
+ vendor: "alpic",
673
+ rawNames: ["alpic-playground", "playground"]
674
+ },
675
+ {
676
+ id: "opencode",
677
+ label: "opencode",
678
+ vendor: "opencode",
679
+ rawNames: ["opencode"]
680
+ },
681
+ {
682
+ id: "zed",
683
+ label: "Zed",
684
+ vendor: "zed",
685
+ rawNames: ["Zed", "zed"]
686
+ },
687
+ {
688
+ id: "zapier",
689
+ label: "Zapier",
690
+ vendor: "zapier",
691
+ rawNames: ["Zapier", "zapier"]
692
+ },
693
+ {
694
+ id: "make",
695
+ label: "Make",
696
+ vendor: "make",
697
+ rawNames: ["Make", "make"]
698
+ },
699
+ {
700
+ id: "librechat",
701
+ label: "LibreChat",
702
+ vendor: "mcp",
703
+ rawNames: ["LibreChat", "librechat"]
704
+ },
705
+ {
706
+ id: "jan",
707
+ label: "Jan",
708
+ vendor: "mcp",
709
+ rawNames: ["Jan", "jan"]
710
+ },
711
+ {
712
+ id: "goose",
713
+ label: "goose",
714
+ vendor: "mcp",
715
+ rawNames: ["goose", "Goose"]
716
+ },
717
+ {
718
+ id: "mcphost",
719
+ label: "mcphost",
720
+ vendor: "mcp",
721
+ rawNames: ["mcphost"]
722
+ },
723
+ {
724
+ id: "mcporter",
725
+ label: "mcporter",
726
+ vendor: "mcp",
727
+ rawNames: ["mcporter"]
728
+ },
729
+ {
730
+ id: "rmcp",
731
+ label: "rmcp",
732
+ vendor: "mcp",
733
+ rawNames: ["rmcp"]
734
+ },
735
+ {
736
+ id: "unnamed_client",
737
+ label: "Unnamed client",
738
+ vendor: "mcp",
739
+ rawNames: [
740
+ "mcp",
741
+ "unknown",
742
+ ""
743
+ ]
744
+ }
745
+ ];
746
+ /** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
747
+ const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
748
+ new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
749
+ new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
234
750
  const runtimeSchema = z.enum([
235
751
  "python3.13",
236
752
  "python3.14",
@@ -259,15 +775,27 @@ z.object({
259
775
  environments: z.array(environmentWithDomainsSchema),
260
776
  productionEnvironment: environmentWithDomainsSchema.nullable()
261
777
  });
778
+ const domainFailureReasonSchema = z.enum([
779
+ "caa",
780
+ "dns",
781
+ "invalid_domain",
782
+ "other"
783
+ ]);
784
+ const projectDomainMappingSchema = z.object({
785
+ pathPrefix: z.string(),
786
+ environment: environmentSchema$1
787
+ });
262
788
  z.object({
263
- domain: z.string(),
789
+ name: z.string(),
264
790
  createdAt: z.coerce.date(),
265
791
  status: z.enum([
266
792
  "ongoing",
267
793
  "deployed",
268
794
  "failed"
269
795
  ]),
270
- environment: environmentSchema$1
796
+ failureReason: domainFailureReasonSchema.nullable(),
797
+ environment: environmentSchema$1,
798
+ mappings: z.array(projectDomainMappingSchema)
271
799
  });
272
800
  const serverFieldsSchema$1 = z.object({
273
801
  $schema: z.string(),
@@ -296,6 +824,14 @@ z.object({
296
824
  serverFields: serverFieldsSchema$1,
297
825
  source: z.enum(["registry", "defaults"])
298
826
  });
827
+ /** 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. */
828
+ const clampStringField = (field) => {
829
+ const max = field.maxLength;
830
+ if (max === null) return field;
831
+ const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
832
+ const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
833
+ return field.description ? withMin.describe(field.description) : withMin;
834
+ };
299
835
  const toolDefinitionSchema = z.object({
300
836
  name: z.string(),
301
837
  title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
@@ -308,17 +844,20 @@ const toolDefinitionSchema = z.object({
308
844
  }).optional()
309
845
  });
310
846
  const positiveTestCaseSchema = z.object({
311
- scenario: z.string(),
312
- userPrompt: z.string(),
313
- toolTriggered: z.string().optional(),
314
- expectedOutput: z.string().optional()
847
+ scenario: z.string().describe("Short label for what this case demonstrates."),
848
+ 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."),
849
+ toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
850
+ expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
315
851
  }).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
316
852
  const screenshotEntrySchema = z.object({
317
853
  prompt: z.string(),
318
854
  url: z.url()
319
855
  }).describe("Each screenshot: the user prompt that produced it + the image URL.");
856
+ const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
320
857
  /** Accepts either a valid email or URL. */
321
858
  const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
859
+ /** A URL field whose error spells out that the scheme is required. */
860
+ const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
322
861
  const chatgptCategorySchema = z.enum([
323
862
  "BUSINESS",
324
863
  "COLLABORATION",
@@ -335,51 +874,348 @@ const chatgptCategorySchema = z.enum([
335
874
  "TRAVEL"
336
875
  ]);
337
876
  const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
338
- const chatgptAllowedCountriesSchema = z.enum(["Allow all", "Restrict to specific countries"]);
877
+ const chatgptCountryCodeSchema = z.enum([
878
+ "AD",
879
+ "AE",
880
+ "AF",
881
+ "AG",
882
+ "AL",
883
+ "AM",
884
+ "AO",
885
+ "AR",
886
+ "AT",
887
+ "AU",
888
+ "AW",
889
+ "AX",
890
+ "AZ",
891
+ "BA",
892
+ "BB",
893
+ "BD",
894
+ "BE",
895
+ "BF",
896
+ "BG",
897
+ "BH",
898
+ "BI",
899
+ "BJ",
900
+ "BL",
901
+ "BM",
902
+ "BN",
903
+ "BO",
904
+ "BR",
905
+ "BS",
906
+ "BT",
907
+ "BW",
908
+ "BZ",
909
+ "CA",
910
+ "CD",
911
+ "CF",
912
+ "CG",
913
+ "CH",
914
+ "CI",
915
+ "CL",
916
+ "CM",
917
+ "CO",
918
+ "CR",
919
+ "CV",
920
+ "CY",
921
+ "CZ",
922
+ "DE",
923
+ "DJ",
924
+ "DK",
925
+ "DM",
926
+ "DO",
927
+ "DZ",
928
+ "EC",
929
+ "EE",
930
+ "EG",
931
+ "ER",
932
+ "ES",
933
+ "ET",
934
+ "FI",
935
+ "FJ",
936
+ "FM",
937
+ "FO",
938
+ "FR",
939
+ "GA",
940
+ "GB",
941
+ "GD",
942
+ "GE",
943
+ "GF",
944
+ "GH",
945
+ "GL",
946
+ "GM",
947
+ "GN",
948
+ "GP",
949
+ "GQ",
950
+ "GR",
951
+ "GT",
952
+ "GW",
953
+ "GY",
954
+ "HN",
955
+ "HR",
956
+ "HT",
957
+ "HU",
958
+ "ID",
959
+ "IE",
960
+ "IL",
961
+ "IN",
962
+ "IQ",
963
+ "IS",
964
+ "IT",
965
+ "JM",
966
+ "JO",
967
+ "JP",
968
+ "KE",
969
+ "KG",
970
+ "KH",
971
+ "KI",
972
+ "KM",
973
+ "KN",
974
+ "KR",
975
+ "KW",
976
+ "KY",
977
+ "KZ",
978
+ "LA",
979
+ "LB",
980
+ "LC",
981
+ "LI",
982
+ "LK",
983
+ "LR",
984
+ "LS",
985
+ "LT",
986
+ "LU",
987
+ "LV",
988
+ "LY",
989
+ "MA",
990
+ "MC",
991
+ "MD",
992
+ "ME",
993
+ "MF",
994
+ "MG",
995
+ "MH",
996
+ "MK",
997
+ "ML",
998
+ "MM",
999
+ "MN",
1000
+ "MQ",
1001
+ "MR",
1002
+ "MT",
1003
+ "MU",
1004
+ "MV",
1005
+ "MW",
1006
+ "MX",
1007
+ "MY",
1008
+ "MZ",
1009
+ "NA",
1010
+ "NC",
1011
+ "NE",
1012
+ "NG",
1013
+ "NI",
1014
+ "NL",
1015
+ "NO",
1016
+ "NP",
1017
+ "NR",
1018
+ "NZ",
1019
+ "OM",
1020
+ "PA",
1021
+ "PE",
1022
+ "PF",
1023
+ "PG",
1024
+ "PH",
1025
+ "PK",
1026
+ "PL",
1027
+ "PM",
1028
+ "PS",
1029
+ "PT",
1030
+ "PW",
1031
+ "PY",
1032
+ "QA",
1033
+ "RE",
1034
+ "RO",
1035
+ "RS",
1036
+ "RW",
1037
+ "SA",
1038
+ "SB",
1039
+ "SC",
1040
+ "SD",
1041
+ "SE",
1042
+ "SG",
1043
+ "SH",
1044
+ "SI",
1045
+ "SJ",
1046
+ "SK",
1047
+ "SL",
1048
+ "SM",
1049
+ "SN",
1050
+ "SO",
1051
+ "SR",
1052
+ "SS",
1053
+ "ST",
1054
+ "SV",
1055
+ "SZ",
1056
+ "TD",
1057
+ "TF",
1058
+ "TG",
1059
+ "TH",
1060
+ "TJ",
1061
+ "TL",
1062
+ "TM",
1063
+ "TN",
1064
+ "TO",
1065
+ "TR",
1066
+ "TT",
1067
+ "TV",
1068
+ "TW",
1069
+ "TZ",
1070
+ "UA",
1071
+ "UG",
1072
+ "US",
1073
+ "UY",
1074
+ "UZ",
1075
+ "VA",
1076
+ "VC",
1077
+ "VN",
1078
+ "VU",
1079
+ "WF",
1080
+ "WS",
1081
+ "YE",
1082
+ "YT",
1083
+ "ZA",
1084
+ "ZM",
1085
+ "ZW"
1086
+ ]);
1087
+ const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
1088
+ z.object({ mode: z.literal("all") }),
1089
+ z.object({
1090
+ mode: z.literal("allow"),
1091
+ countries: z.array(chatgptCountryCodeSchema)
1092
+ }),
1093
+ z.object({
1094
+ mode: z.literal("block"),
1095
+ countries: z.array(chatgptCountryCodeSchema)
1096
+ })
1097
+ ]);
1098
+ const chatgptTranslationLocaleSchema = z.enum([
1099
+ "am",
1100
+ "ar",
1101
+ "bg-BG",
1102
+ "bn-BD",
1103
+ "bs-BA",
1104
+ "ca-ES",
1105
+ "cs-CZ",
1106
+ "da-DK",
1107
+ "de-DE",
1108
+ "el-GR",
1109
+ "es-419",
1110
+ "es-ES",
1111
+ "et-EE",
1112
+ "fi-FI",
1113
+ "fr-CA",
1114
+ "fr-FR",
1115
+ "gu-IN",
1116
+ "hi-IN",
1117
+ "hr-HR",
1118
+ "hu-HU",
1119
+ "hy-AM",
1120
+ "id-ID",
1121
+ "is-IS",
1122
+ "it-IT",
1123
+ "ja-JP",
1124
+ "ka-GE",
1125
+ "kk",
1126
+ "kn-IN",
1127
+ "ko-KR",
1128
+ "lt",
1129
+ "lv-LV",
1130
+ "mk-MK",
1131
+ "ml",
1132
+ "mn",
1133
+ "mr-IN",
1134
+ "ms-MY",
1135
+ "my-MM",
1136
+ "nb-NO",
1137
+ "nl-NL",
1138
+ "pa",
1139
+ "pl-PL",
1140
+ "pt-BR",
1141
+ "pt-PT",
1142
+ "ro-RO",
1143
+ "ru-RU",
1144
+ "sk-SK",
1145
+ "sl-SI",
1146
+ "so-SO",
1147
+ "sq-AL",
1148
+ "sr-RS",
1149
+ "sv-SE",
1150
+ "sw-TZ",
1151
+ "ta-IN",
1152
+ "te-IN",
1153
+ "th-TH",
1154
+ "tl",
1155
+ "tr-TR",
1156
+ "uk-UA",
1157
+ "ur",
1158
+ "vi-VN",
1159
+ "zh-CN",
1160
+ "zh-HK",
1161
+ "zh-TW"
1162
+ ]);
339
1163
  const negativeTestCaseSchema = z.object({
340
1164
  scenario: z.string(),
341
1165
  userPrompt: z.string()
342
1166
  }).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
343
1167
  const chatgptToolJustificationSchema = z.object({
344
1168
  toolName: z.string(),
345
- readOnlyJustification: z.string(),
346
- openWorldJustification: z.string(),
347
- destructiveJustification: z.string()
348
- }).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
1169
+ readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
1170
+ openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
1171
+ 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.\"")
1172
+ }).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
1173
+ /** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
1174
+ const chatgptTaglineSchema = z.string().max(30);
1175
+ const chatgptDescriptionSchema = z.string();
349
1176
  const chatgptTranslationSchema = z.object({
350
- locale: z.string(),
351
- tagline: z.string().optional(),
352
- description: z.string().optional()
1177
+ locale: chatgptTranslationLocaleSchema,
1178
+ tagline: chatgptTaglineSchema,
1179
+ description: chatgptDescriptionSchema
353
1180
  }).describe("Locale-scoped override for tagline + description. English (US) is the default.");
354
- /**
355
- * Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
356
- * When adding/removing/reordering fields, keep this in sync with the sheet.
357
- */
1181
+ chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
1182
+ /** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
358
1183
  const chatgptSubmissionFormDataSchema = z.object({
359
1184
  logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
360
1185
  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."),
361
1186
  appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
362
- tagline: z.string().max(30).describe("Plain-language phrase focused on function and user value. 30 chars max."),
363
- description: z.string().describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
1187
+ tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
1188
+ 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)."),
364
1189
  category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
365
1190
  developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
366
- companyUrl: z.url().describe("Your company's main website URL."),
1191
+ companyUrl: urlField.describe("Your company's main website URL."),
367
1192
  supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
368
- privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
369
- termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
370
- demoRecordingUrl: z.url().describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
1193
+ privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
1194
+ termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
1195
+ 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."),
371
1196
  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."),
372
- serverUrl: z.url().describe("URL of the MCP server."),
1197
+ serverUrl: urlField.describe("URL of the MCP server."),
373
1198
  authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
374
1199
  tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
375
- toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
376
- testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Coverage over all major use cases."),
377
- negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
378
- screenshots: z.array(screenshotEntrySchema).describe("In-app screenshots paired with the user prompt that produced them. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 4 entries. First three are public. Images: 706px wide, 400–860px tall, PNG."),
1200
+ 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."),
1201
+ 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."),
1202
+ 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."),
1203
+ 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."),
379
1204
  translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
380
- allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
1205
+ allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
381
1206
  releaseNotes: z.string().describe("Publicly displayed on the app details page.")
382
1207
  });
1208
+ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
1209
+ tagline: z.string().optional(),
1210
+ companyUrl: z.string().optional(),
1211
+ supportChannel: z.string().optional(),
1212
+ privacyPolicyUrl: z.string().optional(),
1213
+ termsOfServiceUrl: z.string().optional(),
1214
+ demoRecordingUrl: z.string().optional(),
1215
+ serverUrl: z.string().optional(),
1216
+ screenshots: z.array(screenshotDraftEntrySchema).optional(),
1217
+ translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
1218
+ });
383
1219
  chatgptSubmissionFormDataSchema.pick({
384
1220
  appName: true,
385
1221
  developerName: true,
@@ -394,9 +1230,9 @@ chatgptSubmissionFormDataSchema.pick({
394
1230
  testCases: true,
395
1231
  negativeTestCases: true,
396
1232
  toolJustifications: true
397
- });
1233
+ }).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
398
1234
  const claudeCategorySchema = z.enum([
399
- "Business & Productivity",
1235
+ "Productivity",
400
1236
  "Communication",
401
1237
  "Data & Analytics",
402
1238
  "Development tools",
@@ -404,207 +1240,162 @@ const claudeCategorySchema = z.enum([
404
1240
  "Consumer Health",
405
1241
  "Health & Life Sciences",
406
1242
  "Media & Entertainment",
407
- "Commerce & Shopping"
1243
+ "Commerce & Shopping",
1244
+ "Legal",
1245
+ "Sales and marketing",
1246
+ "Creative",
1247
+ "Nonprofit",
1248
+ "Education",
1249
+ "Other"
408
1250
  ]);
409
- z.enum([
410
- "No auth needed",
411
- "OAuth 2.0",
412
- "Custom URL"
413
- ]);
414
- const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
415
- z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
1251
+ const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
416
1252
  const claudeReadWriteCapabilitiesSchema = z.enum([
417
- "Read only",
418
- "Write only",
419
- "Read + write"
1253
+ "read_only",
1254
+ "write_only",
1255
+ "read_write"
420
1256
  ]);
421
- const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
422
- const claudeThirdPartySchema = z.enum([
423
- "Web access (open web fetch / scraping / arbitrary URLs)",
424
- "Third-party AI model integration",
425
- "Third-party data retrieval (via workflow / aggregator)",
426
- "Third-party data modification (via workflow / aggregator)",
427
- "N/A"
1257
+ const claudeAuthenticationSchema = z.enum([
1258
+ "oauth_dcr",
1259
+ "oauth_cimd",
1260
+ "oauth_anthropic_creds",
1261
+ "custom_connection",
1262
+ "none"
428
1263
  ]);
429
- const claudeDataHandlingSchema = z.enum([
430
- "Server only accesses data explicitly requested by user",
431
- "No data is stored beyond session requirements",
432
- "Data transmission is encrypted (HTTPS / TLS)",
433
- "GDPR compliant (if applicable)"
1264
+ const claudeApiOwnershipSchema = z.enum([
1265
+ "first_party",
1266
+ "proxied",
1267
+ "third_party"
434
1268
  ]);
435
- const claudeSponsoredContentSchema = z.enum([
436
- "No, there is no sponsored content or advertisements",
437
- "Yes, there are banner ads or other paid visual elements",
438
- "Yes, returned content or ranking is impacted by sponsorship or ad placement"
1269
+ const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
1270
+ const claudePolicyAcknowledgementSchema = z.enum([
1271
+ "I have read and understand the MCP Directory developer guidelines.",
1272
+ "My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
1273
+ "My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
1274
+ "My connector does not use AI models to generate images, video, or audio.",
1275
+ "Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
1276
+ "My connector does not collect conversation data beyond what is needed for its function.",
1277
+ "Public documentation for this connector will be live by the publish date."
439
1278
  ]);
440
- /**
441
- * Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
442
- * When adding/removing/reordering fields, keep this in sync with the sheet.
443
- */
1279
+ /** 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. */
444
1280
  const claudeSubmissionFormDataSchema = z.object({
445
- companyName: z.string().describe("Enter your company's legal name or the name under which your product is publicly known. This is used for internal tracking and may appear in directory listings."),
446
- companyUrl: z.url().describe("Your company's main website URL, e.g. https://mycompany.com. Must be a valid URL with https://. This should be the root domain of the company behind this MCP server."),
447
- primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. This person will receive review feedback, approval notices, and any follow-up questions."),
448
- primaryContactEmail: z.email().describe("Business email for the primary contact. Must be a valid email address. Anthropic uses this to communicate about your submission status, required changes, and post-listing issues. Avoid using personal email addresses."),
449
- primaryContactRole: z.string().optional().describe("The job title or role of the primary contact (e.g. 'CTO', 'Developer Relations Lead', 'Founder'). Optional but helps Anthropic route questions to the right person."),
450
- anthropicPointOfContact: z.string().optional().describe("If you have a direct contact at Anthropic (e.g. from a partnership or sales conversation), enter their name here. This is optional but can greatly help expedite the review process. Leave blank if you don't have one."),
451
- appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
452
-
453
- Rules:
454
- (1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
455
- (2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
456
- (3) You must own or have the right to use this brand name. For example, don't call it 'Google Drive Helper' if you're not Google.`),
457
- mcpUrlType: claudeMcpUrlTypeSchema.describe(`Choose how your server URL works:
458
- • 'Universal URL': one single URL that all users connect to (most common). Example: https://mcp.myapp.com
459
- • 'Custom MCP URLs': each user gets their own unique URL (e.g. based on their workspace or instance).
460
- If you choose this, you'll need to provide both a signup URL and a regex pattern that matches valid server URLs for your service.`),
461
- serverUrl: z.url().describe(`If 'Universal URL': enter the full https:// URL where your MCP server is hosted and reachable. Example: https://mcp.myapp.com/
462
- If 'Custom MCP URLs': provide (1) the signup/onboarding URL where users create an account, and (2) a regex pattern that matches all valid server URLs for your service (e.g. https://[a-z0-9-]+\\.myapp\\.com/mcp). The server must be publicly accessible without VPN or whitelisting required.`),
463
- tagline: z.string().max(55).describe(`A very short, punchy description shown below your server name in the directory listing. Max 55 characters including spaces.
464
- Think of it as a subtitle or elevator pitch fragment. Example: 'Manage tasks and projects in Linear' or 'Search and read your Notion workspace'. Avoid generic phrases like 'The best MCP server for...'`),
465
- description: z.string().describe(`A 50–100 word description of what your MCP server does. This appears in the connector's detail page inside Claude. Write it from a user perspective: what can users do with this connector? What are the key features/tools? Avoid marketing fluff. Be specific. Example: 'Connect Claude to your Linear workspace. Create and update issues, search projects, manage teams, and track engineering cycles, all from within Claude.' Anthropic reviewers check this for accuracy against your actual tools.`),
466
- testCases: z.array(positiveTestCaseSchema).describe(`Provide at least 3 concrete use cases, each with an example prompt a user could type to Claude. These are critical: Anthropic reviewers literally test your server using these prompts. Good examples are specific and demonstrate real value.
467
- Best format: [Use case]: [exact prompt]"
468
- Example for a task manager:
469
- 1. Create a task: 'Create a task called Review Q3 report, due Friday, assigned to Alice'
470
- 2. Search tasks: 'Show me all open bugs in the Mobile project'
471
- 3. Update status: 'Mark the Deploy v2.1 task as done'"`),
472
- connectionRequirements: z.string().describe(`Describe any prerequisites a user must have before they can connect your server. Be exhaustive. Examples of things to mention:
473
- • Account type required (free vs paid plan)
474
- • Admin permissions or specific roles needed
475
- • Geographic restrictions (e.g. 'US only' or 'Not available in EU')
476
- • If users need to provide their own server URL or instance domain
477
- • Any setup steps needed before connecting (e.g. 'Enable API access in your account settings')
478
- If there are genuinely no special requirements, write exactly: 'No special requirements.'`),
479
- readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`Select the option that best describes what your server can do:
480
-
481
- 'Read Only': your tools only fetch/retrieve data (GET operations). Claude cannot modify anything via your server.
482
- 'Write Only': your tools only create/update/delete data (rare).
483
- 'Read + Write': your tools can both retrieve AND modify data (most common for full-featured connectors).
484
-
485
- Note: Anthropic rejects catch-all tools that accept both safe (GET) and unsafe (POST, PUT, DELETE) HTTP methods via a parameter e.g. a single api_request(method, endpoint) tool. Each tool should have a fixed, specific purpose. `),
486
- isMcpApp: z.boolean().describe(`Select 'Yes' if your MCP server renders interactive UI elements (aka widgets or views) inside the Claude conversation.
487
- Select 'No' if your server only returns text/data responses.
488
- If 'Yes', you will also be required to provide screenshots of your UI (see Promotional Images section). MCP Apps are displayed with a special badge in the directory.`),
489
- thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe(`Multi-select all that apply to your server's behavior:
490
- • 'Web access' — your server fetches arbitrary URLs, scrapes websites, or makes open-ended HTTP requests to the web (not just your own API).
491
- • 'Third-party AI model integration' — your server calls another AI model (e.g. OpenAI, Gemini, Cohere) as part of its processing.
492
- • 'Third-party data retrieval' — your server retrieves data via a workflow or aggregator platform (e.g. Zapier, Make, n8n) rather than calling your own API directly.
493
- • 'Third-party data modification' — your server modifies data via such a platform.
494
- • 'N/A' — your server only calls your own first-party API and does nothing else. Select this only if none of the above apply.`),
495
- dataHandling: z.array(claudeDataHandlingSchema).describe(`Multi-select all data handling practices that accurately apply to your server. You must select at least 3. Key points:
496
- • 'Server only accesses data explicitly requested by user' — your server doesn't silently read unrelated user data.
497
- • 'No data is stored beyond session requirements' — you don't log or retain conversation data after the session.
498
- • 'Data transmission is encrypted (HTTPS/TLS)' — all data in transit is encrypted. This should always apply for remote servers.
499
- • 'GDPR compliant' — if you operate in the EU or serve EU users, check this only if you are genuinely compliant. Don't check it without having proper data processing agreements and procedures in place.
500
- Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
501
- personalDataHealthAccess: z.boolean().describe(`Select 'Yes' ONLY if your connector gives users access to their own personal health information — such as medical records, lab results, diagnoses, prescriptions, wearable health metrics (heart rate, sleep data, etc.), or mental health data.
502
- Select 'No' for the vast majority of business/productivity/dev tools. When in doubt, select 'No'. This field triggers additional compliance review if 'Yes'.`),
503
- categories: z.array(claudeCategorySchema).describe(`Select the category or categories that best describe your connector. This determines where it appears in the directory's browse experience. Choose the most specific fit:
504
- • Business & Productivity — project management, CRM, HR, office tools
505
- • Communication — email, chat, messaging, notifications
506
- • Data & Analytics — dashboards, reporting, databases, BI tools
507
- • Development tools — code repositories, CI/CD, issue trackers, monitoring
508
- • Financial Services — accounting, invoicing, fintech (note: financial transaction execution is not permitted)
509
- • Consumer Health — fitness, wellness, personal health tracking
510
- • Health & Life Sciences — clinical, pharma, medical professional tools
511
- • Media & Entertainment — content, publishing, streaming
512
- • Commerce & Shopping — e-commerce, inventory, orders
513
- Multiple categories are allowed if genuinely applicable.`),
514
- sponsoredContentsOrAdvertisement: claudeSponsoredContentSchema.describe(`Be honest here — advertising is not permitted in the Connectors Directory per Anthropic's policy. Select the option that accurately describes your server:
515
- • 'No, there is no sponsored content or advertisements' — the results your server returns are not influenced by paid placement or sponsorship. This is what almost all connectors should select.
516
- • 'Yes, there are banner ads or other paid visual elements' — your UI includes visual ads. NOTE: this will likely lead to rejection, as Anthropic prohibits advertising in Claude.
517
- • 'Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement' — paid results affect what you return. NOTE: this also likely leads to rejection.
518
- If your server returns organic results from a platform that has ads in its own UI (but your API results are not affected by ads), select 'No'.`),
519
- transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
520
- • 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
521
- • '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.
522
- If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
523
- 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:
524
- • What the connector does and its key capabilities
525
- • How to connect/set it up (step by step)
526
- • What each tool does (or at least the main ones)
527
- • How to troubleshoot common issues
528
- • A support contact or channel
529
- 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.`),
530
- 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:
531
- • What data you collect (and how)
532
- • How you use the collected data
533
- • Where and how long you store it
534
- • Whether you share data with third parties (and who)
535
- • How users can contact you about data concerns
536
- 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.`),
537
- 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:
538
- • Email address (e.g. support@myapp.com)
539
- • Link to a GitHub Issues page
540
- • Link to a help center or support article
541
- • Link to a Discord/Slack community
542
- • Link to your documentation's troubleshooting section
543
- Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
544
- 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:
545
- • The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
546
- • No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
547
- • 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.
548
- • Credentials must remain valid for at least 30 days from submission.
549
- • If your service requires API keys instead of a password, provide those.
550
- Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
551
- 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.
552
- Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
553
- 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.`),
554
- toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
555
- • 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
556
- • '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).
557
- 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.`),
558
- logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
559
- • Format: SVG only
560
- • Aspect ratio: square (1:1)
561
- • Should work on a light background
562
- • Provide via URL (Google Drive link is fine) or upload directly
563
- Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
564
- 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.`),
565
- 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:
566
- • 3–5 images is ideal
567
- • Minimum 1000px width, PNG format preferred
568
- • Each screenshot is paired with the user prompt that produced it
569
- • Crop to just the relevant part of the Claude interface (the tool response area)
570
- • Show your connector doing something impressive and useful — real data, real results
571
- • If you're an MCP App, include screenshots of your interactive UI elements
572
- These images appear in your directory listing and are a key factor in driving user installs.`)
1281
+ 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
1282
+ from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
1283
+ The server must be publicly accessible without VPN or whitelisting.`),
1284
+ 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
1285
+ own or have the right to use this name. Max 100 characters.`),
1286
+ 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.
1287
+ PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
1288
+ oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
1289
+ phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
1290
+ 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
1291
+ claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
1292
+ categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
1293
+ 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
1294
+ (recommended); upload a custom icon only to override it.`),
1295
+ documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
1296
+ accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
1297
+ by your publish date.`),
1298
+ support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
1299
+ used to notify you of security or compliance issues, so make sure it's actively monitored.`),
1300
+ privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
1301
+ what data you collect, how you use and store it, and whether you share it with third parties.`),
1302
+ 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
1303
+ it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
1304
+ primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
1305
+ type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
1306
+ connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
1307
+ permissions'). If there are genuinely no special requirements, say so explicitly.`),
1308
+ readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
1309
+ • 'read_only': retrieves data but never modifies it.
1310
+ • 'write_only': creates or modifies data but does not read it.
1311
+ • 'read_write': both retrieves and modifies data (most common).`),
1312
+ companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
1313
+ companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
1314
+ primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
1315
+ primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
1316
+ primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
1317
+ anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
1318
+ authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
1319
+ • 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
1320
+ • 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
1321
+ • 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
1322
+ • 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
1323
+ • 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
1324
+ partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
1325
+ apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
1326
+ • 'first_party': the MCP server calls your own production APIs.
1327
+ • 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
1328
+ • 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
1329
+ personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
1330
+ No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
1331
+ sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
1332
+ No → false, Yes → true, or { other: explanation }.`),
1333
+ testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
1334
+ the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
1335
+ fully populated account.`),
1336
+ selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
1337
+ policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
1338
+ submission. Each is an attestation you are legally agreeing to by submitting.`),
1339
+ additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
1340
+ });
1341
+ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
1342
+ serverUrl: z.string().optional(),
1343
+ name: z.string().optional(),
1344
+ slug: z.string().optional(),
1345
+ oneLiner: z.string().optional(),
1346
+ description: z.string().optional(),
1347
+ iconUrl: z.string().optional(),
1348
+ documentation: z.string().optional(),
1349
+ support: z.string().optional(),
1350
+ privacyPolicy: z.string().optional(),
1351
+ companyWebsite: z.string().optional(),
1352
+ primaryContactEmail: z.string().optional(),
1353
+ categories: z.array(claudeCategorySchema).optional(),
1354
+ screenshots: z.array(screenshotDraftEntrySchema).optional()
573
1355
  });
574
1356
  claudeSubmissionFormDataSchema.pick({
575
- companyName: true,
576
- appName: true,
577
- mcpUrlType: true,
578
1357
  serverUrl: true,
579
- tools: true,
580
- readWriteCapabilities: true,
581
- isMcpApp: true,
582
- transportSupport: true,
1358
+ name: true,
1359
+ slug: true,
1360
+ companyName: true,
583
1361
  primaryContactEmail: true,
584
- primaryContactName: true
1362
+ primaryContactName: true,
1363
+ readWriteCapabilities: true,
1364
+ authentication: true,
1365
+ apiOwnership: true,
1366
+ personalHealthData: true
1367
+ }).extend({
1368
+ connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
1369
+ testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
585
1370
  });
586
- claudeSubmissionFormDataSchema.pick({
587
- tagline: true,
588
- description: true,
589
- categories: true,
590
- testCases: true
1371
+ /** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
1372
+ const claudeAiGeneratedFormDataRawSchema = z.object({
1373
+ oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
1374
+ description: claudeSubmissionFormDataSchema.shape.description,
1375
+ categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
1376
+ primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
1377
+ });
1378
+ claudeAiGeneratedFormDataRawSchema.extend({
1379
+ oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
1380
+ categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
591
1381
  });
592
1382
  const submissionMetaFieldsSchema = z.object({
593
1383
  id: z.string(),
594
1384
  environmentId: z.string(),
1385
+ auditId: z.string().nullable(),
595
1386
  createdAt: z.coerce.date(),
596
1387
  updatedAt: z.coerce.date()
597
1388
  });
598
1389
  const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
599
1390
  platform: z.literal("claudeai"),
600
- formData: claudeSubmissionFormDataSchema.partial()
1391
+ formData: claudeSubmissionDraftSchema
601
1392
  });
602
1393
  const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
603
1394
  platform: z.literal("chatgpt"),
604
- formData: chatgptSubmissionFormDataSchema.partial()
1395
+ formData: chatgptSubmissionDraftSchema
605
1396
  });
606
1397
  z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
607
- z.union([claudeSubmissionFormDataSchema.partial(), chatgptSubmissionFormDataSchema.partial()]);
1398
+ z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
608
1399
  const subscriptionPlanSchema = z.enum([
609
1400
  "pro",
610
1401
  "business",
@@ -628,6 +1419,12 @@ z.object({
628
1419
  partnerDiscount: partnerDiscountSchema.nullable()
629
1420
  });
630
1421
  //#endregion
1422
+ //#region src/auth-scope.ts
1423
+ /** Accepts an API key or OAuth access token (default for most routes). */
1424
+ const AUTH_SCOPE_ANY = "any";
1425
+ /** Requires a user OAuth access token; API keys are not accepted. */
1426
+ const AUTH_SCOPE_USER = "user";
1427
+ //#endregion
631
1428
  //#region src/schemas.ts
632
1429
  const RESERVED_KEYS = [
633
1430
  "_HANDLER",
@@ -663,7 +1460,10 @@ const RESERVED_KEYS = [
663
1460
  "BUILD_ARG_START_COMMAND",
664
1461
  "ALPIC_HOST",
665
1462
  "ALPIC_CUSTOM_DOMAINS",
666
- "ALPIC_INTENT_META_KEY"
1463
+ "ALPIC_INTENT_META_KEY",
1464
+ "ALPIC_FEEDBACK_META_KEY",
1465
+ "ALPIC_EVENTS_META_KEY",
1466
+ "ALPIC_IDENTIFY_META_KEY"
667
1467
  ];
668
1468
  const environmentVariableSchema = z.object({
669
1469
  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"),
@@ -767,7 +1567,7 @@ const createEnvironmentContractV1 = oc.route({
767
1567
  id: z.string(),
768
1568
  name: z.string(),
769
1569
  sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
770
- urls: z.array(z.string().url()).describe("The URLs of the MCP server"),
1570
+ urls: z.array(z.url()).describe("The URLs of the MCP server"),
771
1571
  createdAt: z.coerce.date(),
772
1572
  projectId: z.string().describe("The ID of the project the environment belongs to")
773
1573
  }));
@@ -843,6 +1643,9 @@ const listProjectsContractV1 = oc.route({
843
1643
  description: "List all projects for a team",
844
1644
  tags: ["projects"],
845
1645
  successDescription: "The list of projects"
1646
+ }).errors({
1647
+ NOT_FOUND: {},
1648
+ BAD_REQUEST: {}
846
1649
  }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
847
1650
  const createProjectContractV1 = oc.route({
848
1651
  path: "/v1/projects",
@@ -853,7 +1656,8 @@ const createProjectContractV1 = oc.route({
853
1656
  successDescription: "The project has been created successfully"
854
1657
  }).errors({
855
1658
  NOT_FOUND: {},
856
- BAD_REQUEST: {}
1659
+ BAD_REQUEST: {},
1660
+ FORBIDDEN: {}
857
1661
  }).input(z.object({
858
1662
  teamId: z.string().optional(),
859
1663
  name: z.string().trim().min(1).max(100),
@@ -938,7 +1742,10 @@ const deleteEnvironmentVariableContractV1 = oc.route({
938
1742
  description: "Delete an environment variable by ID",
939
1743
  tags: ["environments"],
940
1744
  successDescription: "The environment variable has been deleted successfully"
941
- }).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
1745
+ }).errors({
1746
+ NOT_FOUND: {},
1747
+ BAD_REQUEST: {}
1748
+ }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
942
1749
  const deleteProjectContractV1 = oc.route({
943
1750
  path: "/v1/projects/{projectId}",
944
1751
  method: "DELETE",
@@ -956,7 +1763,8 @@ const updateProjectContractV1 = oc.route({
956
1763
  successDescription: "The project has been updated successfully"
957
1764
  }).errors({
958
1765
  NOT_FOUND: {},
959
- BAD_REQUEST: {}
1766
+ BAD_REQUEST: {},
1767
+ FORBIDDEN: {}
960
1768
  }).input(z.object({
961
1769
  projectId: z.string().describe("The ID of the project"),
962
1770
  name: z.string().min(1).max(100).optional().describe("The new name for the project"),
@@ -971,10 +1779,12 @@ const deployEnvironmentContractV1 = oc.route({
971
1779
  successDescription: "The environment has been deployed successfully"
972
1780
  }).errors({
973
1781
  NOT_FOUND: {},
974
- BAD_REQUEST: {}
1782
+ BAD_REQUEST: {},
1783
+ CONFLICT: {}
975
1784
  }).input(z.object({
976
1785
  environmentId: z.string().describe("The ID of the environment to deploy"),
977
- token: z.string().describe("The token to identify the source archive").optional()
1786
+ token: z.string().describe("The token to identify the source archive").optional(),
1787
+ 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.")
978
1788
  })).output(deploymentSchema);
979
1789
  const uploadDeploymentArtifactContractV1 = oc.route({
980
1790
  path: "/v1/deployments/upload",
@@ -983,6 +1793,9 @@ const uploadDeploymentArtifactContractV1 = oc.route({
983
1793
  description: "Return a presigned S3 URL to upload a deployment artifact",
984
1794
  tags: ["deployments"],
985
1795
  successDescription: "The presigned upload URL has been generated successfully"
1796
+ }).errors({
1797
+ NOT_FOUND: {},
1798
+ BAD_REQUEST: {}
986
1799
  }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
987
1800
  uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
988
1801
  token: z.string().describe("Token to identify the source archive"),
@@ -1008,6 +1821,21 @@ const getDeploymentContractV1 = oc.route({
1008
1821
  tags: ["deployments"],
1009
1822
  successDescription: "The deployment details"
1010
1823
  }).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
1824
+ const logEntrySchema = z.object({
1825
+ timestamp: z.coerce.date(),
1826
+ type: z.enum([
1827
+ "START",
1828
+ "END",
1829
+ "INFO",
1830
+ "ERROR",
1831
+ "WARNING",
1832
+ "DEBUG"
1833
+ ]),
1834
+ requestId: z.string(),
1835
+ content: z.string().optional(),
1836
+ method: z.string().optional(),
1837
+ durationInMs: z.number().optional()
1838
+ });
1011
1839
  const getLogsContractV1 = oc.route({
1012
1840
  path: "/v1/environments/{environmentId}/logs",
1013
1841
  method: "GET",
@@ -1032,21 +1860,7 @@ const getLogsContractV1 = oc.route({
1032
1860
  search: z.string().optional().describe("Filter pattern to search for in log content"),
1033
1861
  nextToken: z.string().optional().describe("Pagination token from a previous response")
1034
1862
  })).output(z.object({
1035
- logs: z.array(z.object({
1036
- timestamp: z.coerce.date(),
1037
- type: z.enum([
1038
- "START",
1039
- "END",
1040
- "INFO",
1041
- "ERROR",
1042
- "WARNING",
1043
- "DEBUG"
1044
- ]),
1045
- requestId: z.string(),
1046
- content: z.string().optional(),
1047
- method: z.string().optional(),
1048
- durationInMs: z.number().optional()
1049
- })),
1863
+ logs: z.array(logEntrySchema),
1050
1864
  nextToken: z.string().nullable()
1051
1865
  }));
1052
1866
  const getLatestLogsContractV1 = oc.route({
@@ -1069,21 +1883,7 @@ const getLatestLogsContractV1 = oc.route({
1069
1883
  "DEBUG"
1070
1884
  ])).optional().describe("Filter by log level"),
1071
1885
  search: z.string().optional().describe("Filter pattern to search for in log content")
1072
- })).output(z.object({ logs: z.array(z.object({
1073
- timestamp: z.coerce.date(),
1074
- type: z.enum([
1075
- "START",
1076
- "END",
1077
- "INFO",
1078
- "ERROR",
1079
- "WARNING",
1080
- "DEBUG"
1081
- ]),
1082
- requestId: z.string(),
1083
- content: z.string().optional(),
1084
- method: z.string().optional(),
1085
- durationInMs: z.number().optional()
1086
- })) }));
1886
+ })).output(z.object({ logs: z.array(logEntrySchema) }));
1087
1887
  const getDeploymentLogsContractV1 = oc.route({
1088
1888
  path: "/v1/deployments/{deploymentId}/logs",
1089
1889
  method: "GET",
@@ -1156,7 +1956,7 @@ const getTunnelTicketContractV1 = oc.route({
1156
1956
  description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
1157
1957
  tags: ["tunnels"],
1158
1958
  successDescription: "The tunnel ticket"
1159
- }).output(z.object({
1959
+ }).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
1160
1960
  subdomain: z.string().describe("The subdomain assigned to the user"),
1161
1961
  ticket: z.string().describe("The signed tunnel ticket"),
1162
1962
  tunnelHost: z.string().describe("The tunnel host to connect to")
@@ -1232,7 +2032,7 @@ const upsertPlaygroundContractV1 = oc.route({
1232
2032
  name: z.string().min(1).max(100).optional(),
1233
2033
  description: z.string().min(1).max(500).optional(),
1234
2034
  headers: z.array(playgroundHeaderSchema).optional(),
1235
- examplePrompts: z.array(playgroundExamplePromptSchema).max(3).optional()
2035
+ examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
1236
2036
  })).output(playgroundOutputSchema);
1237
2037
  const createBeaconContractV1 = oc.route({
1238
2038
  path: "/v1/beacon/audits",
@@ -1309,5 +2109,10 @@ const contract = {
1309
2109
  get: { v1: getBeaconContractV1 }
1310
2110
  }
1311
2111
  };
2112
+ const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
2113
+ const contractForDocs = {
2114
+ ...contract,
2115
+ deployments: deploymentsForDocs
2116
+ };
1312
2117
  //#endregion
1313
- export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
2118
+ export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };