@alpic-ai/api 0.0.0-dev.ge3cead0 → 0.0.0-dev.ge3de960

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 +1594 -76
  2. package/dist/index.mjs +1275 -351
  3. package/package.json +26 -10
package/dist/index.mjs CHANGED
@@ -1,11 +1,190 @@
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.5.4/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
+ "cato",
183
+ "cloudflare",
184
+ "fastly"
185
+ ];
186
+ const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
187
+ const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
9
188
  const auditStatusSchema = z.enum([
10
189
  "pending",
11
190
  "partial",
@@ -71,6 +250,32 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
71
250
  chatgpt: widgetScreenshotSchema.optional(),
72
251
  claudeai: widgetScreenshotSchema.optional()
73
252
  }) });
253
+ z.object({
254
+ id: z.string(),
255
+ environmentId: z.string(),
256
+ clientId: z.string(),
257
+ clientSecret: z.string(),
258
+ clientScopes: z.array(z.string())
259
+ });
260
+ const creditEntryReasonSchema = z.enum([
261
+ "free_seed",
262
+ "paid_conversion_floor",
263
+ "top_up",
264
+ "usage",
265
+ "admin_adjustment"
266
+ ]);
267
+ z.enum(["playground"]);
268
+ z.number().int().min(500);
269
+ const creditActivityEntrySchema = z.object({
270
+ reason: creditEntryReasonSchema,
271
+ day: z.number(),
272
+ amountInNanoUSD: z.number(),
273
+ messageCount: z.number().nullable()
274
+ });
275
+ z.object({
276
+ balanceInNanoUSD: z.number(),
277
+ recentActivity: z.array(creditActivityEntrySchema)
278
+ });
74
279
  const deploymentStatusSchema$1 = z.enum([
75
280
  "ongoing",
76
281
  "deployed",
@@ -98,9 +303,91 @@ const deploymentSummarySchema = z.object({
98
303
  createdAt: z.coerce.date(),
99
304
  updatedAt: z.coerce.date()
100
305
  });
101
- const allowedPlatformSchema = platformSchema;
306
+ /** Public environment: answers anonymously and exposes no OAuth metadata. */
307
+ const publicEnvironmentSchema = z.object({
308
+ allowsAnonymous: z.literal(true),
309
+ oAuthMetadata: z.strictObject({})
310
+ });
311
+ /** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
312
+ const externalResourceMetadataEnvironmentSchema = z.object({
313
+ allowsAnonymous: z.boolean(),
314
+ oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
315
+ scope: z.string().optional()
316
+ });
317
+ /** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
318
+ const externalAuthorizationServerEnvironmentSchema = z.object({
319
+ allowsAnonymous: z.boolean(),
320
+ oAuthMetadata: z.object({
321
+ externalAuthorizationServerUrl: z.url(),
322
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
323
+ }),
324
+ scope: z.string().optional()
325
+ });
326
+ /** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
327
+ const standaloneEnvironmentSchema = z.object({
328
+ allowsAnonymous: z.boolean(),
329
+ oAuthMetadata: z.object({
330
+ authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
331
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
332
+ }),
333
+ scope: z.string().optional()
334
+ });
335
+ /** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
336
+ const protectedWithoutDiscoveryEnvironmentSchema = z.object({
337
+ allowsAnonymous: z.literal(false),
338
+ oAuthMetadata: z.strictObject({}),
339
+ scope: z.string().optional()
340
+ });
341
+ const legacyPublicEnvironmentSchema = z.object({
342
+ isPublic: z.literal(true),
343
+ oAuthMetadata: z.undefined().optional()
344
+ });
345
+ const legacyExternalResourceMetadataEnvironmentSchema = z.object({
346
+ isPublic: z.literal(false),
347
+ oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
348
+ scope: z.string().optional()
349
+ });
350
+ const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
351
+ isPublic: z.literal(false),
352
+ oAuthMetadata: z.object({
353
+ externalAuthorizationServerUrl: z.url(),
354
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
355
+ }),
356
+ scope: z.string().optional()
357
+ });
358
+ const legacyStandaloneEnvironmentSchema = z.object({
359
+ isPublic: z.literal(false),
360
+ oAuthMetadata: z.object({
361
+ authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
362
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
363
+ }),
364
+ scope: z.string().optional()
365
+ });
366
+ const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
367
+ isPublic: z.literal(false),
368
+ oAuthMetadata: z.strictObject({}),
369
+ scope: z.string().optional()
370
+ });
371
+ z.union([
372
+ publicEnvironmentSchema,
373
+ externalResourceMetadataEnvironmentSchema,
374
+ externalAuthorizationServerEnvironmentSchema,
375
+ standaloneEnvironmentSchema,
376
+ protectedWithoutDiscoveryEnvironmentSchema,
377
+ legacyPublicEnvironmentSchema,
378
+ legacyExternalResourceMetadataEnvironmentSchema,
379
+ legacyExternalAuthorizationServerEnvironmentSchema,
380
+ legacyStandaloneEnvironmentSchema,
381
+ legacyProtectedWithoutDiscoveryEnvironmentSchema
382
+ ]);
383
+ const playgroundModelSchema = z.enum([
384
+ "global.anthropic.claude-haiku-4-5-20251001-v1:0",
385
+ "global.anthropic.claude-sonnet-4-5-20250929-v1:0",
386
+ "openai.gpt-5.4",
387
+ "openai.gpt-5.5"
388
+ ]);
102
389
  const environmentDomainSchema = z.object({
103
- domain: z.string(),
390
+ name: z.string(),
104
391
  status: z.enum([
105
392
  "ongoing",
106
393
  "deployed",
@@ -118,6 +405,7 @@ const environmentSchema$1 = z.object({
118
405
  latestDeployment: deploymentSummarySchema.optional(),
119
406
  openaiAppsChallenge: z.string().nullable().optional(),
120
407
  isPlaygroundEnabled: z.boolean(),
408
+ playgroundModel: playgroundModelSchema,
121
409
  isIpWhitelistEnabled: z.boolean(),
122
410
  ipAllowlist: z.array(z.string()).nullable(),
123
411
  allowedPlatforms: z.array(allowedPlatformSchema),
@@ -127,11 +415,20 @@ const environmentSchema$1 = z.object({
127
415
  });
128
416
  const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
129
417
  z.object({
418
+ sessionReplayEnabled: z.boolean(),
419
+ collectRequestPayload: z.boolean(),
420
+ collectResponsePayload: z.boolean(),
421
+ collectErrorMessage: z.boolean(),
422
+ collectUserData: z.boolean(),
423
+ identityTraitKey: z.string().min(1).max(200).nullable()
424
+ });
425
+ const feedbackSchema = z.object({
130
426
  id: z.string(),
131
427
  createdAt: z.coerce.date(),
132
428
  environmentId: z.string(),
133
429
  content: z.string(),
134
- source: z.enum(["model", "user"])
430
+ source: z.enum(["model", "user"]),
431
+ clientName: z.string().nullable()
135
432
  });
136
433
  z.object({
137
434
  content: z.string(),
@@ -147,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
147
444
  "pink",
148
445
  "gray"
149
446
  ]);
150
- intentCategoryColorSchema.options;
447
+ const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
151
448
  const intentCategorySchema = z.object({
152
449
  id: z.string(),
153
450
  createdAt: z.coerce.date(),
@@ -155,7 +452,7 @@ const intentCategorySchema = z.object({
155
452
  name: z.string(),
156
453
  color: intentCategoryColorSchema
157
454
  });
158
- z.object({
455
+ const intentCategorySummarySchema = z.object({
159
456
  id: z.string(),
160
457
  name: z.string(),
161
458
  color: intentCategoryColorSchema,
@@ -167,6 +464,7 @@ z.object({
167
464
  environmentId: z.string(),
168
465
  toolName: z.string(),
169
466
  message: z.string(),
467
+ clientName: z.string().nullable(),
170
468
  categories: z.array(intentCategorySchema)
171
469
  });
172
470
  const signalCategorySchema = z.object({
@@ -225,12 +523,262 @@ z.object({
225
523
  createdAt: z.coerce.date(),
226
524
  updatedAt: z.coerce.date()
227
525
  });
526
+ const alpicMcpRequestLogSchema = z.object({
527
+ type: z.literal("mcp_request"),
528
+ method: z.string()
529
+ });
530
+ const alpicMcpErrorLogSchema = z.object({
531
+ type: z.literal("mcp_error"),
532
+ method: z.string(),
533
+ error: z.string()
534
+ });
535
+ z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
228
536
  z.enum([
229
537
  "INFO",
230
538
  "WARNING",
231
539
  "DEBUG",
232
540
  "ERROR"
233
541
  ]);
542
+ /** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
543
+ const MCP_CLIENT_GROUPS = [
544
+ {
545
+ id: "claude_code",
546
+ label: "Claude Code",
547
+ vendor: "anthropic",
548
+ rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
549
+ },
550
+ {
551
+ id: "claude",
552
+ label: "Claude",
553
+ vendor: "anthropic",
554
+ rawNames: [
555
+ "Anthropic/ClaudeAI",
556
+ "claude-ai",
557
+ "claude",
558
+ "Claude",
559
+ "claude-desktop",
560
+ "claude-desktop-3p"
561
+ ]
562
+ },
563
+ {
564
+ id: "claude_mobile",
565
+ label: "Claude mobile",
566
+ vendor: "anthropic",
567
+ rawNames: ["claude-ios", "ClaudeAndroid"]
568
+ },
569
+ {
570
+ id: "claude_cowork",
571
+ label: "Claude Cowork",
572
+ vendor: "anthropic",
573
+ rawNames: ["Anthropic/Cowork"]
574
+ },
575
+ {
576
+ id: "claude_toolbox",
577
+ label: "Claude Toolbox",
578
+ vendor: "anthropic",
579
+ rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
580
+ },
581
+ {
582
+ id: "anthropic_api",
583
+ label: "Anthropic API",
584
+ vendor: "anthropic",
585
+ rawNames: ["Anthropic/API"]
586
+ },
587
+ {
588
+ id: "anthropic_connector_refresh",
589
+ label: "Anthropic (connector refresh)",
590
+ vendor: "anthropic",
591
+ rawNames: ["Anthropic"]
592
+ },
593
+ {
594
+ id: "codex",
595
+ label: "Codex",
596
+ vendor: "openai",
597
+ rawNames: [
598
+ "codex-mcp-client",
599
+ "codex",
600
+ "Codex",
601
+ "codex-cli",
602
+ "openai-mcp (Codex)"
603
+ ]
604
+ },
605
+ {
606
+ id: "chatgpt",
607
+ label: "ChatGPT",
608
+ vendor: "openai",
609
+ rawNames: ["openai-mcp (ChatGPT)"]
610
+ },
611
+ {
612
+ id: "openai_responses_api",
613
+ label: "OpenAI Responses API",
614
+ vendor: "openai",
615
+ rawNames: ["openai-mcp (Responses API)"]
616
+ },
617
+ {
618
+ id: "openai_agent_builder",
619
+ label: "OpenAI Agent Builder",
620
+ vendor: "openai",
621
+ rawNames: ["openai-mcp (Agent Builder)"]
622
+ },
623
+ {
624
+ id: "openai_other",
625
+ label: "OpenAI Other",
626
+ vendor: "openai",
627
+ rawNames: ["openai-mcp"]
628
+ },
629
+ {
630
+ id: "cursor",
631
+ label: "Cursor",
632
+ vendor: "cursor",
633
+ rawNames: [
634
+ "cursor-vscode",
635
+ "Cursor",
636
+ "cursor"
637
+ ]
638
+ },
639
+ {
640
+ id: "cline",
641
+ label: "Cline",
642
+ vendor: "cline",
643
+ rawNames: [
644
+ "Cline",
645
+ "cline",
646
+ "@cline/core"
647
+ ]
648
+ },
649
+ {
650
+ id: "github_copilot",
651
+ label: "GitHub Copilot",
652
+ vendor: "githubCopilot",
653
+ rawNames: [
654
+ "Copilot",
655
+ "github-copilot-developer",
656
+ "Copilot MCP Gateway",
657
+ "Xcode/copilot-xcode"
658
+ ]
659
+ },
660
+ {
661
+ id: "gemini_cli",
662
+ label: "Gemini CLI",
663
+ vendor: "google",
664
+ rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
665
+ },
666
+ {
667
+ id: "antigravity",
668
+ label: "Antigravity",
669
+ vendor: "google",
670
+ rawNames: ["antigravity-client"]
671
+ },
672
+ {
673
+ id: "gemini",
674
+ label: "Gemini",
675
+ vendor: "google",
676
+ rawNames: ["Gemini", "google-ai-edge-gallery"]
677
+ },
678
+ {
679
+ id: "windsurf",
680
+ label: "Windsurf",
681
+ vendor: "windsurf",
682
+ rawNames: ["Windsurf", "windsurf-client"]
683
+ },
684
+ {
685
+ id: "mistral",
686
+ label: "Mistral / Le Chat",
687
+ vendor: "mistral",
688
+ rawNames: ["Mistral"],
689
+ rawNamePrefixes: ["connector:custom-mcp:"]
690
+ },
691
+ {
692
+ id: "n8n",
693
+ label: "n8n",
694
+ vendor: "n8n",
695
+ rawNames: [
696
+ "@n8n/n8n-nodes-langchain.mcpClient",
697
+ "@n8n/n8n-nodes-langchain.mcpClientTool",
698
+ "n8n"
699
+ ]
700
+ },
701
+ {
702
+ id: "alpic_playground",
703
+ label: "Alpic Playground",
704
+ vendor: "alpic",
705
+ rawNames: ["alpic-playground", "playground"]
706
+ },
707
+ {
708
+ id: "opencode",
709
+ label: "opencode",
710
+ vendor: "opencode",
711
+ rawNames: ["opencode"]
712
+ },
713
+ {
714
+ id: "zed",
715
+ label: "Zed",
716
+ vendor: "zed",
717
+ rawNames: ["Zed", "zed"]
718
+ },
719
+ {
720
+ id: "zapier",
721
+ label: "Zapier",
722
+ vendor: "zapier",
723
+ rawNames: ["Zapier", "zapier"]
724
+ },
725
+ {
726
+ id: "make",
727
+ label: "Make",
728
+ vendor: "make",
729
+ rawNames: ["Make", "make"]
730
+ },
731
+ {
732
+ id: "librechat",
733
+ label: "LibreChat",
734
+ vendor: "mcp",
735
+ rawNames: ["LibreChat", "librechat"]
736
+ },
737
+ {
738
+ id: "jan",
739
+ label: "Jan",
740
+ vendor: "mcp",
741
+ rawNames: ["Jan", "jan"]
742
+ },
743
+ {
744
+ id: "goose",
745
+ label: "goose",
746
+ vendor: "mcp",
747
+ rawNames: ["goose", "Goose"]
748
+ },
749
+ {
750
+ id: "mcphost",
751
+ label: "mcphost",
752
+ vendor: "mcp",
753
+ rawNames: ["mcphost"]
754
+ },
755
+ {
756
+ id: "mcporter",
757
+ label: "mcporter",
758
+ vendor: "mcp",
759
+ rawNames: ["mcporter"]
760
+ },
761
+ {
762
+ id: "rmcp",
763
+ label: "rmcp",
764
+ vendor: "mcp",
765
+ rawNames: ["rmcp"]
766
+ },
767
+ {
768
+ id: "unnamed_client",
769
+ label: "Unnamed client",
770
+ vendor: "mcp",
771
+ rawNames: [
772
+ "mcp",
773
+ "unknown",
774
+ ""
775
+ ]
776
+ }
777
+ ];
778
+ /** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
779
+ const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
780
+ new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
781
+ new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
234
782
  const runtimeSchema = z.enum([
235
783
  "python3.13",
236
784
  "python3.14",
@@ -259,15 +807,27 @@ z.object({
259
807
  environments: z.array(environmentWithDomainsSchema),
260
808
  productionEnvironment: environmentWithDomainsSchema.nullable()
261
809
  });
810
+ const domainFailureReasonSchema = z.enum([
811
+ "caa",
812
+ "dns",
813
+ "invalid_domain",
814
+ "other"
815
+ ]);
816
+ const projectDomainMappingSchema = z.object({
817
+ pathPrefix: z.string(),
818
+ environment: environmentSchema$1
819
+ });
262
820
  z.object({
263
- domain: z.string(),
821
+ name: z.string(),
264
822
  createdAt: z.coerce.date(),
265
823
  status: z.enum([
266
824
  "ongoing",
267
825
  "deployed",
268
826
  "failed"
269
827
  ]),
270
- environment: environmentSchema$1
828
+ failureReason: domainFailureReasonSchema.nullable(),
829
+ environment: environmentSchema$1,
830
+ mappings: z.array(projectDomainMappingSchema)
271
831
  });
272
832
  const serverFieldsSchema$1 = z.object({
273
833
  $schema: z.string(),
@@ -296,15 +856,7 @@ z.object({
296
856
  serverFields: serverFieldsSchema$1,
297
857
  source: z.enum(["registry", "defaults"])
298
858
  });
299
- /**
300
- * Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
301
- * rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
302
- *
303
- * NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
304
- * `minLength`, and the description. Any other validators on the source field (`.regex()`,
305
- * `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
306
- * free-text length caps only. A field with `null` `maxLength` is returned unchanged.
307
- */
859
+ /** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
308
860
  const clampStringField = (field) => {
309
861
  const max = field.maxLength;
310
862
  if (max === null) return field;
@@ -324,17 +876,20 @@ const toolDefinitionSchema = z.object({
324
876
  }).optional()
325
877
  });
326
878
  const positiveTestCaseSchema = z.object({
327
- scenario: z.string(),
328
- userPrompt: z.string(),
329
- toolTriggered: z.string().optional(),
330
- expectedOutput: z.string().optional()
879
+ scenario: z.string().describe("Short label for what this case demonstrates."),
880
+ userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
881
+ toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
882
+ expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
331
883
  }).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
332
884
  const screenshotEntrySchema = z.object({
333
885
  prompt: z.string(),
334
- url: z.url().or(z.literal(""))
886
+ url: z.url()
335
887
  }).describe("Each screenshot: the user prompt that produced it + the image URL.");
888
+ const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
336
889
  /** Accepts either a valid email or URL. */
337
890
  const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
891
+ /** A URL field whose error spells out that the scheme is required. */
892
+ const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
338
893
  const chatgptCategorySchema = z.enum([
339
894
  "BUSINESS",
340
895
  "COLLABORATION",
@@ -351,7 +906,227 @@ const chatgptCategorySchema = z.enum([
351
906
  "TRAVEL"
352
907
  ]);
353
908
  const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
354
- const chatgptAllowedCountriesSchema = z.enum(["Allow all", "Restrict to specific countries"]);
909
+ const chatgptCountryCodeSchema = z.enum([
910
+ "AD",
911
+ "AE",
912
+ "AF",
913
+ "AG",
914
+ "AL",
915
+ "AM",
916
+ "AO",
917
+ "AR",
918
+ "AT",
919
+ "AU",
920
+ "AW",
921
+ "AX",
922
+ "AZ",
923
+ "BA",
924
+ "BB",
925
+ "BD",
926
+ "BE",
927
+ "BF",
928
+ "BG",
929
+ "BH",
930
+ "BI",
931
+ "BJ",
932
+ "BL",
933
+ "BM",
934
+ "BN",
935
+ "BO",
936
+ "BR",
937
+ "BS",
938
+ "BT",
939
+ "BW",
940
+ "BZ",
941
+ "CA",
942
+ "CD",
943
+ "CF",
944
+ "CG",
945
+ "CH",
946
+ "CI",
947
+ "CL",
948
+ "CM",
949
+ "CO",
950
+ "CR",
951
+ "CV",
952
+ "CY",
953
+ "CZ",
954
+ "DE",
955
+ "DJ",
956
+ "DK",
957
+ "DM",
958
+ "DO",
959
+ "DZ",
960
+ "EC",
961
+ "EE",
962
+ "EG",
963
+ "ER",
964
+ "ES",
965
+ "ET",
966
+ "FI",
967
+ "FJ",
968
+ "FM",
969
+ "FO",
970
+ "FR",
971
+ "GA",
972
+ "GB",
973
+ "GD",
974
+ "GE",
975
+ "GF",
976
+ "GH",
977
+ "GL",
978
+ "GM",
979
+ "GN",
980
+ "GP",
981
+ "GQ",
982
+ "GR",
983
+ "GT",
984
+ "GW",
985
+ "GY",
986
+ "HN",
987
+ "HR",
988
+ "HT",
989
+ "HU",
990
+ "ID",
991
+ "IE",
992
+ "IL",
993
+ "IN",
994
+ "IQ",
995
+ "IS",
996
+ "IT",
997
+ "JM",
998
+ "JO",
999
+ "JP",
1000
+ "KE",
1001
+ "KG",
1002
+ "KH",
1003
+ "KI",
1004
+ "KM",
1005
+ "KN",
1006
+ "KR",
1007
+ "KW",
1008
+ "KY",
1009
+ "KZ",
1010
+ "LA",
1011
+ "LB",
1012
+ "LC",
1013
+ "LI",
1014
+ "LK",
1015
+ "LR",
1016
+ "LS",
1017
+ "LT",
1018
+ "LU",
1019
+ "LV",
1020
+ "LY",
1021
+ "MA",
1022
+ "MC",
1023
+ "MD",
1024
+ "ME",
1025
+ "MF",
1026
+ "MG",
1027
+ "MH",
1028
+ "MK",
1029
+ "ML",
1030
+ "MM",
1031
+ "MN",
1032
+ "MQ",
1033
+ "MR",
1034
+ "MT",
1035
+ "MU",
1036
+ "MV",
1037
+ "MW",
1038
+ "MX",
1039
+ "MY",
1040
+ "MZ",
1041
+ "NA",
1042
+ "NC",
1043
+ "NE",
1044
+ "NG",
1045
+ "NI",
1046
+ "NL",
1047
+ "NO",
1048
+ "NP",
1049
+ "NR",
1050
+ "NZ",
1051
+ "OM",
1052
+ "PA",
1053
+ "PE",
1054
+ "PF",
1055
+ "PG",
1056
+ "PH",
1057
+ "PK",
1058
+ "PL",
1059
+ "PM",
1060
+ "PS",
1061
+ "PT",
1062
+ "PW",
1063
+ "PY",
1064
+ "QA",
1065
+ "RE",
1066
+ "RO",
1067
+ "RS",
1068
+ "RW",
1069
+ "SA",
1070
+ "SB",
1071
+ "SC",
1072
+ "SD",
1073
+ "SE",
1074
+ "SG",
1075
+ "SH",
1076
+ "SI",
1077
+ "SJ",
1078
+ "SK",
1079
+ "SL",
1080
+ "SM",
1081
+ "SN",
1082
+ "SO",
1083
+ "SR",
1084
+ "SS",
1085
+ "ST",
1086
+ "SV",
1087
+ "SZ",
1088
+ "TD",
1089
+ "TF",
1090
+ "TG",
1091
+ "TH",
1092
+ "TJ",
1093
+ "TL",
1094
+ "TM",
1095
+ "TN",
1096
+ "TO",
1097
+ "TR",
1098
+ "TT",
1099
+ "TV",
1100
+ "TW",
1101
+ "TZ",
1102
+ "UA",
1103
+ "UG",
1104
+ "US",
1105
+ "UY",
1106
+ "UZ",
1107
+ "VA",
1108
+ "VC",
1109
+ "VN",
1110
+ "VU",
1111
+ "WF",
1112
+ "WS",
1113
+ "YE",
1114
+ "YT",
1115
+ "ZA",
1116
+ "ZM",
1117
+ "ZW"
1118
+ ]);
1119
+ const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
1120
+ z.object({ mode: z.literal("all") }),
1121
+ z.object({
1122
+ mode: z.literal("allow"),
1123
+ countries: z.array(chatgptCountryCodeSchema)
1124
+ }),
1125
+ z.object({
1126
+ mode: z.literal("block"),
1127
+ countries: z.array(chatgptCountryCodeSchema)
1128
+ })
1129
+ ]);
355
1130
  const chatgptTranslationLocaleSchema = z.enum([
356
1131
  "am",
357
1132
  "ar",
@@ -423,15 +1198,11 @@ const negativeTestCaseSchema = z.object({
423
1198
  }).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
424
1199
  const chatgptToolJustificationSchema = z.object({
425
1200
  toolName: z.string(),
426
- readOnlyJustification: z.string(),
427
- openWorldJustification: z.string(),
428
- destructiveJustification: z.string()
429
- }).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
430
- /**
431
- * Base copy fields, defined once and reused by both the submission form and per-locale
432
- * translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
433
- * path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
434
- */
1201
+ readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
1202
+ openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
1203
+ destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
1204
+ }).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
1205
+ /** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
435
1206
  const chatgptTaglineSchema = z.string().max(30);
436
1207
  const chatgptDescriptionSchema = z.string();
437
1208
  const chatgptTranslationSchema = z.object({
@@ -440,35 +1211,43 @@ const chatgptTranslationSchema = z.object({
440
1211
  description: chatgptDescriptionSchema
441
1212
  }).describe("Locale-scoped override for tagline + description. English (US) is the default.");
442
1213
  chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
443
- /**
444
- * Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
445
- * When adding/removing/reordering fields, keep this in sync with the sheet.
446
- */
1214
+ /** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
447
1215
  const chatgptSubmissionFormDataSchema = z.object({
448
1216
  logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
449
1217
  logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
450
1218
  appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
451
- tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value. 30 chars max."),
452
- description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
1219
+ tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
1220
+ description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
453
1221
  category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
454
1222
  developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
455
- companyUrl: z.url().describe("Your company's main website URL."),
1223
+ companyUrl: urlField.describe("Your company's main website URL."),
456
1224
  supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
457
- privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
458
- termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
459
- 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."),
1225
+ privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
1226
+ termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
1227
+ demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
460
1228
  appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
461
- serverUrl: z.url().describe("URL of the MCP server."),
1229
+ serverUrl: urlField.describe("URL of the MCP server."),
462
1230
  authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
463
1231
  tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
464
- toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
465
- 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."),
466
- negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
467
- 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."),
1232
+ toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
1233
+ testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
1234
+ negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
1235
+ screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
468
1236
  translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
469
- allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
1237
+ allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
470
1238
  releaseNotes: z.string().describe("Publicly displayed on the app details page.")
471
1239
  });
1240
+ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
1241
+ tagline: z.string().optional(),
1242
+ companyUrl: z.string().optional(),
1243
+ supportChannel: z.string().optional(),
1244
+ privacyPolicyUrl: z.string().optional(),
1245
+ termsOfServiceUrl: z.string().optional(),
1246
+ demoRecordingUrl: z.string().optional(),
1247
+ serverUrl: z.string().optional(),
1248
+ screenshots: z.array(screenshotDraftEntrySchema).optional(),
1249
+ translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
1250
+ });
472
1251
  chatgptSubmissionFormDataSchema.pick({
473
1252
  appName: true,
474
1253
  developerName: true,
@@ -485,7 +1264,7 @@ chatgptSubmissionFormDataSchema.pick({
485
1264
  toolJustifications: true
486
1265
  }).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
487
1266
  const claudeCategorySchema = z.enum([
488
- "Business & Productivity",
1267
+ "Productivity",
489
1268
  "Communication",
490
1269
  "Data & Analytics",
491
1270
  "Development tools",
@@ -493,221 +1272,167 @@ const claudeCategorySchema = z.enum([
493
1272
  "Consumer Health",
494
1273
  "Health & Life Sciences",
495
1274
  "Media & Entertainment",
496
- "Commerce & Shopping"
497
- ]);
498
- const claudeAuthenticationSchema = z.enum([
499
- "No auth needed",
500
- "OAuth 2.0",
501
- "Custom URL"
1275
+ "Commerce & Shopping",
1276
+ "Legal",
1277
+ "Sales and marketing",
1278
+ "Creative",
1279
+ "Nonprofit",
1280
+ "Education",
1281
+ "Other"
502
1282
  ]);
503
- const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
504
- z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
1283
+ const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
505
1284
  const claudeReadWriteCapabilitiesSchema = z.enum([
506
- "Read Only",
507
- "Write Only",
508
- "Read + Write"
1285
+ "read_only",
1286
+ "write_only",
1287
+ "read_write"
509
1288
  ]);
510
- const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
511
- const claudeTestedSurfaceSchema = z.enum([
512
- "Claude.ai (web)",
513
- "Claude Desktop",
514
- "Claude Code",
515
- "Cowork"
516
- ]);
517
- const claudeThirdPartySchema = z.enum([
518
- "Web access: Fetches information from the open web (e.g., web scraping, search engines, or browsing arbitrary URLs, not just connecting to a specific API)",
519
- "Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
520
- "Third-party data retrieval: Connects to external services that themselves retrieve data from other sources (e.g., workflow automation platforms or other services that aggregate or relay data from multiple third-party sources)",
521
- "Third-party data modification: Can connect to external services that themselves create, update, or delete data in other sources (e.g., workflow automation platforms or other services that write to multiple third-party sources)",
522
- "N/A"
1289
+ const claudeAuthenticationSchema = z.enum([
1290
+ "oauth_dcr",
1291
+ "oauth_cimd",
1292
+ "oauth_anthropic_creds",
1293
+ "custom_connection",
1294
+ "none"
523
1295
  ]);
524
- const claudeDataHandlingSchema = z.enum([
525
- "Server only accesses data explicitly requested by user",
526
- "No data is stored beyond session requirements",
527
- "Data transmission is encrypted (HTTPS/TLS)",
528
- "GDPR compliant (if applicable)"
1296
+ const claudeApiOwnershipSchema = z.enum([
1297
+ "first_party",
1298
+ "proxied",
1299
+ "third_party"
529
1300
  ]);
530
- const claudeSponsoredContentSchema = z.enum([
531
- "No, there is no sponsored content or advertisements",
532
- "Yes, there are banner ads or other paid visual elements",
533
- "Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement"
1301
+ const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
1302
+ const claudePolicyAcknowledgementSchema = z.enum([
1303
+ "I have read and understand the MCP Directory developer guidelines.",
1304
+ "My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
1305
+ "My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
1306
+ "My connector does not use AI models to generate images, video, or audio.",
1307
+ "Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
1308
+ "My connector does not collect conversation data beyond what is needed for its function.",
1309
+ "Public documentation for this connector will be live by the publish date."
534
1310
  ]);
535
- /**
536
- * Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
537
- * When adding/removing/reordering fields, keep this in sync with the sheet.
538
- */
1311
+ /** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
539
1312
  const claudeSubmissionFormDataSchema = z.object({
540
- 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."),
541
- 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."),
542
- 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."),
543
- 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."),
544
- 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."),
545
- 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."),
546
- appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
547
-
548
- Rules:
549
- (1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
550
- (2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
551
- (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.`),
552
- mcpUrlType: claudeMcpUrlTypeSchema.describe(`Choose how your server URL works:
553
- • 'Universal URL': one single URL that all users connect to (most common). Example: https://mcp.myapp.com
554
- • 'Custom MCP URLs': each user gets their own unique URL (e.g. based on their workspace or instance).
555
- 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.`),
556
- 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/
557
- 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.`),
558
- 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.
559
- 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...'`),
560
- 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.`),
561
- 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.
562
- Best format: [Use case]: [exact prompt]"
563
- Example for a task manager:
564
- 1. Create a task: 'Create a task called Review Q3 report, due Friday, assigned to Alice'
565
- 2. Search tasks: 'Show me all open bugs in the Mobile project'
566
- 3. Update status: 'Mark the Deploy v2.1 task as done'"`),
567
- connectionRequirements: z.string().describe(`Describe any prerequisites a user must have before they can connect your server. Be exhaustive. Examples of things to mention:
568
- • Account type required (free vs paid plan)
569
- • Admin permissions or specific roles needed
570
- • Geographic restrictions (e.g. 'US only' or 'Not available in EU')
571
- • If users need to provide their own server URL or instance domain
572
- • Any setup steps needed before connecting (e.g. 'Enable API access in your account settings')
573
- If there are genuinely no special requirements, write exactly: 'No special requirements.'`),
574
- readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`Select the option that best describes what your server can do:
575
-
576
- 'Read Only': your tools only fetch/retrieve data (GET operations). Claude cannot modify anything via your server.
577
- 'Write Only': your tools only create/update/delete data (rare).
578
- 'Read + Write': your tools can both retrieve AND modify data (most common for full-featured connectors).
579
-
580
- 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. `),
581
- isMcpApp: z.boolean().describe(`Select 'Yes' if your MCP server renders interactive UI elements (aka widgets or views) inside the Claude conversation.
582
- Select 'No' if your server only returns text/data responses.
583
- 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.`),
584
- thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe(`Multi-select all that apply to your server's behavior:
585
- • 'Web access' — your server fetches arbitrary URLs, scrapes websites, or makes open-ended HTTP requests to the web (not just your own API).
586
- • 'Third-party AI model integration' — your server calls another AI model (e.g. OpenAI, Gemini, Cohere) as part of its processing.
587
- • '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.
588
- • 'Third-party data modification' — your server modifies data via such a platform.
589
- • 'N/A' — your server only calls your own first-party API and does nothing else. Select this only if none of the above apply.`),
590
- 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:
591
- • 'Server only accesses data explicitly requested by user' — your server doesn't silently read unrelated user data.
592
- • 'No data is stored beyond session requirements' — you don't log or retain conversation data after the session.
593
- • 'Data transmission is encrypted (HTTPS/TLS)' — all data in transit is encrypted. This should always apply for remote servers.
594
- • '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.
595
- Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
596
- 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.
597
- Select 'No' for the vast majority of business/productivity/dev tools. When in doubt, select 'No'. This field triggers additional compliance review if 'Yes'.`),
598
- category: claudeCategorySchema.describe(`Select the category that best describes your connector. This determines where it appears in the directory's browse experience. Choose the most specific fit:
599
- • Business & Productivity — project management, CRM, HR, office tools
600
- • Communication — email, chat, messaging, notifications
601
- • Data & Analytics — dashboards, reporting, databases, BI tools
602
- • Development tools — code repositories, CI/CD, issue trackers, monitoring
603
- • Financial Services — accounting, invoicing, fintech (note: financial transaction execution is not permitted)
604
- • Consumer Health — fitness, wellness, personal health tracking
605
- • Health & Life Sciences — clinical, pharma, medical professional tools
606
- • Media & Entertainment — content, publishing, streaming
607
- • Commerce & Shopping — e-commerce, inventory, orders
608
- Anthropic's submission form only accepts a single category.`),
609
- 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:
610
- • '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.
611
- • '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.
612
- • '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.
613
- 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'.`),
614
- authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
615
- transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
616
- • 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
617
- • '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.
618
- If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
619
- 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:
620
- • What the connector does and its key capabilities
621
- • How to connect/set it up (step by step)
622
- • What each tool does (or at least the main ones)
623
- • How to troubleshoot common issues
624
- • A support contact or channel
625
- 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.`),
626
- 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:
627
- • What data you collect (and how)
628
- • How you use the collected data
629
- • Where and how long you store it
630
- • Whether you share data with third parties (and who)
631
- • How users can contact you about data concerns
632
- 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.`),
633
- 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:
634
- • Email address (e.g. support@myapp.com)
635
- • Link to a GitHub Issues page
636
- • Link to a help center or support article
637
- • Link to a Discord/Slack community
638
- • Link to your documentation's troubleshooting section
639
- Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
640
- 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:
641
- • The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
642
- • No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
643
- • 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.
644
- • Credentials must remain valid for at least 30 days from submission.
645
- • If your service requires API keys instead of a password, provide those.
646
- Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
647
- 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.
648
- Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
649
- 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.`),
650
- toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
651
- • 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
652
- • '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).
653
- 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.`),
654
- 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.`),
655
- logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
656
- • Format: SVG only
657
- • Aspect ratio: square (1:1)
658
- • Should work on a light background
659
- • Provide via URL (Google Drive link is fine) or upload directly
660
- Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
661
- 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.`),
662
- 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:
663
- • 3–5 images is ideal
664
- • Minimum 1000px width, PNG format preferred
665
- • Each screenshot is paired with the user prompt that produced it
666
- • Crop to just the relevant part of the Claude interface (the tool response area)
667
- • Show your connector doing something impressive and useful — real data, real results
668
- • If you're an MCP App, include screenshots of your interactive UI elements
669
- These images appear in your directory listing and are a key factor in driving user installs.`)
1313
+ serverUrl: z.url().describe(`The full https:// URL where your MCP server is hosted and reachable. In the claude.ai wizard this is read live
1314
+ from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
1315
+ The server must be publicly accessible without VPN or whitelisting.`),
1316
+ name: z.string().max(100).describe(`The public display name for your connector as it appears in the directory. Use your brand/product name. You must
1317
+ own or have the right to use this name. Max 100 characters.`),
1318
+ slug: z.string().max(50).regex(/^[a-z0-9-]+$/).describe(`URL-safe identifier for your connector's directory page. Lowercase letters, numbers, and hyphens only.
1319
+ PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
1320
+ oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
1321
+ phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
1322
+ description: z.string().max(2e3).describe(`A description of what your connector does and its key features, shown on the connector's detail page in
1323
+ claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
1324
+ categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
1325
+ iconUrl: z.url().optional().describe(`Optional custom icon for the directory listing — a square SVG. By default the favicon from your MCP URL is used
1326
+ (recommended); upload a custom icon only to override it.`),
1327
+ documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
1328
+ accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
1329
+ by your publish date.`),
1330
+ support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
1331
+ used to notify you of security or compliance issues, so make sure it's actively monitored.`),
1332
+ privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
1333
+ what data you collect, how you use and store it, and whether you share it with third parties.`),
1334
+ screenshots: z.array(screenshotEntrySchema).optional().describe(`Carousel images shown on your connector's directory page (PNG). Each is paired with the user prompt that produced
1335
+ it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
1336
+ primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
1337
+ type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
1338
+ connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
1339
+ permissions'). If there are genuinely no special requirements, say so explicitly.`),
1340
+ readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
1341
+ • 'read_only': retrieves data but never modifies it.
1342
+ • 'write_only': creates or modifies data but does not read it.
1343
+ • 'read_write': both retrieves and modifies data (most common).`),
1344
+ companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
1345
+ companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
1346
+ primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
1347
+ primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
1348
+ primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
1349
+ anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
1350
+ authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
1351
+ • 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
1352
+ • 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
1353
+ • 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
1354
+ • 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
1355
+ • 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
1356
+ partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
1357
+ apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
1358
+ • 'first_party': the MCP server calls your own production APIs.
1359
+ • 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
1360
+ • 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
1361
+ personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
1362
+ No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
1363
+ sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
1364
+ No → false, Yes → true, or { other: explanation }.`),
1365
+ testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
1366
+ the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
1367
+ fully populated account.`),
1368
+ selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
1369
+ policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
1370
+ submission. Each is an attestation you are legally agreeing to by submitting.`),
1371
+ additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
1372
+ });
1373
+ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
1374
+ serverUrl: z.string().optional(),
1375
+ name: z.string().optional(),
1376
+ slug: z.string().optional(),
1377
+ oneLiner: z.string().optional(),
1378
+ description: z.string().optional(),
1379
+ iconUrl: z.string().optional(),
1380
+ documentation: z.string().optional(),
1381
+ support: z.string().optional(),
1382
+ privacyPolicy: z.string().optional(),
1383
+ companyWebsite: z.string().optional(),
1384
+ primaryContactEmail: z.string().optional(),
1385
+ categories: z.array(claudeCategorySchema).optional(),
1386
+ screenshots: z.array(screenshotDraftEntrySchema).optional()
670
1387
  });
671
1388
  claudeSubmissionFormDataSchema.pick({
672
- companyName: true,
673
- appName: true,
674
- mcpUrlType: true,
675
1389
  serverUrl: true,
676
- tools: true,
677
- readWriteCapabilities: true,
678
- isMcpApp: true,
679
- transportSupport: true,
1390
+ name: true,
1391
+ slug: true,
1392
+ companyName: true,
680
1393
  primaryContactEmail: true,
681
1394
  primaryContactName: true,
1395
+ readWriteCapabilities: true,
682
1396
  authentication: true,
683
- personalDataHealthAccess: true,
684
- testedSurfaces: true
1397
+ apiOwnership: true,
1398
+ personalHealthData: true
685
1399
  }).extend({
686
1400
  connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
687
- testingCredentials: claudeSubmissionFormDataSchema.shape.testingCredentials.optional()
1401
+ testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
1402
+ });
1403
+ /** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
1404
+ const claudeAiGeneratedFormDataRawSchema = z.object({
1405
+ oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
1406
+ description: claudeSubmissionFormDataSchema.shape.description,
1407
+ categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
1408
+ primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
1409
+ });
1410
+ claudeAiGeneratedFormDataRawSchema.extend({
1411
+ oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
1412
+ categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
688
1413
  });
689
- claudeSubmissionFormDataSchema.pick({
690
- tagline: true,
691
- description: true,
692
- category: true,
693
- testCases: true
694
- }).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
695
1414
  const submissionMetaFieldsSchema = z.object({
696
1415
  id: z.string(),
697
1416
  environmentId: z.string(),
1417
+ auditId: z.string().nullable(),
698
1418
  createdAt: z.coerce.date(),
699
1419
  updatedAt: z.coerce.date()
700
1420
  });
701
1421
  const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
702
1422
  platform: z.literal("claudeai"),
703
- formData: claudeSubmissionFormDataSchema.partial()
1423
+ formData: claudeSubmissionDraftSchema
704
1424
  });
705
1425
  const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
706
1426
  platform: z.literal("chatgpt"),
707
- formData: chatgptSubmissionFormDataSchema.partial()
1427
+ formData: chatgptSubmissionDraftSchema
708
1428
  });
709
1429
  z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
710
- z.union([claudeSubmissionFormDataSchema.partial(), chatgptSubmissionFormDataSchema.partial()]);
1430
+ z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
1431
+ z.literal([
1432
+ 100,
1433
+ 75,
1434
+ 50
1435
+ ]);
711
1436
  const subscriptionPlanSchema = z.enum([
712
1437
  "pro",
713
1438
  "business",
@@ -719,17 +1444,76 @@ const customerCreditsSchema = z.object({
719
1444
  expiresAt: z.number().nullable(),
720
1445
  currency: z.string()
721
1446
  });
722
- const customerUsageSchema = z.object({
723
- amountInCents: z.number(),
724
- currency: z.string(),
725
- periodEnd: z.number()
726
- });
727
1447
  const partnerDiscountSchema = z.object({ endsAt: z.number() });
728
1448
  z.object({
729
1449
  customerCredits: customerCreditsSchema.nullable(),
730
- customerUsage: customerUsageSchema.nullable(),
731
1450
  partnerDiscount: partnerDiscountSchema.nullable()
732
1451
  });
1452
+ const metricsQueueEventSchema = z.object({
1453
+ ts: z.number().int(),
1454
+ method: z.string(),
1455
+ tool: z.string().nullable(),
1456
+ client: z.string(),
1457
+ sessionId: z.string().nullable(),
1458
+ durationMs: z.number().int(),
1459
+ outputTokens: z.number().int().nullable(),
1460
+ errorType: z.enum([
1461
+ "mcp_error",
1462
+ "tool_error",
1463
+ "timeout"
1464
+ ]).nullable(),
1465
+ errorCode: z.number().int().nullable()
1466
+ });
1467
+ z.object({
1468
+ v: z.literal(1),
1469
+ envId: z.string(),
1470
+ events: z.array(metricsQueueEventSchema)
1471
+ });
1472
+ z.object({ v: z.number() });
1473
+ const telemetrySignalSchema = z.enum([
1474
+ "logs",
1475
+ "metrics",
1476
+ "traces"
1477
+ ]);
1478
+ const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
1479
+ const otlpEndpointSchema = z.string().trim().min(1).max(2048);
1480
+ const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
1481
+ const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
1482
+ const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
1483
+ const telemetryDestinationHeaderSchema = z.object({
1484
+ id: z.string(),
1485
+ name: otlpHeaderNameSchema,
1486
+ value: otlpHeaderValueSchema,
1487
+ isSecret: z.boolean()
1488
+ });
1489
+ const otlpPushFailureReasonSchema = z.enum([
1490
+ "credentials",
1491
+ "wrong-path",
1492
+ "wrong-protocol",
1493
+ "invalid-payload",
1494
+ "partial-rejection",
1495
+ "blocked-target",
1496
+ "timeout",
1497
+ "unreachable",
1498
+ "receiver-error",
1499
+ "unexpected-status"
1500
+ ]);
1501
+ const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
1502
+ z.object({
1503
+ id: z.string(),
1504
+ signal: telemetrySignalSchema,
1505
+ endpoint: otlpEndpointSchema,
1506
+ protocol: otlpProtocolSchema,
1507
+ headers: z.array(telemetryDestinationHeaderSchema),
1508
+ status: telemetryDestinationStatusSchema,
1509
+ lastFailureReason: otlpPushFailureReasonSchema.nullable()
1510
+ });
1511
+ //#endregion
1512
+ //#region src/auth-scope.ts
1513
+ /** Accepts an API key or OAuth access token (default for most routes). */
1514
+ const AUTH_SCOPE_ANY = "any";
1515
+ /** Requires a user OAuth access token; API keys are not accepted. */
1516
+ const AUTH_SCOPE_USER = "user";
733
1517
  //#endregion
734
1518
  //#region src/schemas.ts
735
1519
  const RESERVED_KEYS = [
@@ -766,7 +1550,10 @@ const RESERVED_KEYS = [
766
1550
  "BUILD_ARG_START_COMMAND",
767
1551
  "ALPIC_HOST",
768
1552
  "ALPIC_CUSTOM_DOMAINS",
769
- "ALPIC_INTENT_META_KEY"
1553
+ "ALPIC_INTENT_META_KEY",
1554
+ "ALPIC_FEEDBACK_META_KEY",
1555
+ "ALPIC_EVENTS_META_KEY",
1556
+ "ALPIC_IDENTIFY_META_KEY"
770
1557
  ];
771
1558
  const environmentVariableSchema = z.object({
772
1559
  key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
@@ -819,6 +1606,14 @@ const serverFieldsSchema = z.object({
819
1606
  });
820
1607
  //#endregion
821
1608
  //#region src/api.contract.ts
1609
+ const isValidIanaTimeZone = (timeZone) => {
1610
+ try {
1611
+ new Intl.DateTimeFormat("en-US", { timeZone });
1612
+ return true;
1613
+ } catch {
1614
+ return false;
1615
+ }
1616
+ };
822
1617
  const deploymentStatusSchema = z.enum([
823
1618
  "ongoing",
824
1619
  "deployed",
@@ -847,21 +1642,20 @@ const deploymentSchema = z.object({
847
1642
  isCurrent: z.boolean(),
848
1643
  deploymentPageUrl: z.url().nullable()
849
1644
  });
850
- const isValidLogTimeInput = (value) => {
1645
+ const isValidTimeInput = (value) => {
851
1646
  if (ms(value) !== void 0) return true;
852
1647
  return !Number.isNaN(new Date(value).getTime());
853
1648
  };
854
- const createEnvironmentContractV1 = oc.route({
1649
+ const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
1650
+ const base = oc.errors({ BAD_REQUEST: {} });
1651
+ const createEnvironmentContractV1 = base.route({
855
1652
  path: "/v1/environments",
856
1653
  method: "POST",
857
1654
  summary: "Create an environment",
858
1655
  description: "Create an environment for a project",
859
1656
  tags: ["environments"],
860
1657
  successDescription: "The environment has been created successfully"
861
- }).errors({
862
- NOT_FOUND: {},
863
- BAD_REQUEST: {}
864
- }).input(z.object({
1658
+ }).errors({ NOT_FOUND: {} }).input(z.object({
865
1659
  projectId: z.string().describe("The ID of the project to create the environment for"),
866
1660
  name: z.string().min(1).describe("The name of the environment"),
867
1661
  sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
@@ -870,11 +1664,11 @@ const createEnvironmentContractV1 = oc.route({
870
1664
  id: z.string(),
871
1665
  name: z.string(),
872
1666
  sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
873
- urls: z.array(z.string().url()).describe("The URLs of the MCP server"),
1667
+ urls: z.array(z.url()).describe("The URLs of the MCP server"),
874
1668
  createdAt: z.coerce.date(),
875
1669
  projectId: z.string().describe("The ID of the project the environment belongs to")
876
1670
  }));
877
- const getEnvironmentContractV1 = oc.route({
1671
+ const getEnvironmentContractV1 = base.route({
878
1672
  path: "/v1/environments/{environmentId}",
879
1673
  method: "GET",
880
1674
  summary: "Get an environment",
@@ -890,6 +1684,14 @@ const getEnvironmentContractV1 = oc.route({
890
1684
  createdAt: z.coerce.date(),
891
1685
  projectId: z.string()
892
1686
  }));
1687
+ const deleteEnvironmentContractV1 = base.route({
1688
+ path: "/v1/environments/{environmentId}",
1689
+ method: "DELETE",
1690
+ summary: "Delete an environment",
1691
+ description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
1692
+ tags: ["environments"],
1693
+ successDescription: "The environment has been deleted successfully"
1694
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
893
1695
  const domainSchema = z.object({
894
1696
  domain: z.string(),
895
1697
  status: z.enum([
@@ -931,7 +1733,7 @@ const projectOutputSchema = z.object({
931
1733
  productionEnvironment: productionEnvironmentSchema.nullable(),
932
1734
  environments: z.array(environmentSchema)
933
1735
  });
934
- const getProjectContractV1 = oc.route({
1736
+ const getProjectContractV1 = base.route({
935
1737
  path: "/v1/projects/{projectId}",
936
1738
  method: "GET",
937
1739
  summary: "Get a project",
@@ -939,15 +1741,15 @@ const getProjectContractV1 = oc.route({
939
1741
  tags: ["projects"],
940
1742
  successDescription: "The project details"
941
1743
  }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
942
- const listProjectsContractV1 = oc.route({
1744
+ const listProjectsContractV1 = base.route({
943
1745
  path: "/v1/projects",
944
1746
  method: "GET",
945
1747
  summary: "List projects",
946
1748
  description: "List all projects for a team",
947
1749
  tags: ["projects"],
948
1750
  successDescription: "The list of projects"
949
- }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
950
- const createProjectContractV1 = oc.route({
1751
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
1752
+ const createProjectContractV1 = base.route({
951
1753
  path: "/v1/projects",
952
1754
  method: "POST",
953
1755
  summary: "Create a project",
@@ -956,7 +1758,7 @@ const createProjectContractV1 = oc.route({
956
1758
  successDescription: "The project has been created successfully"
957
1759
  }).errors({
958
1760
  NOT_FOUND: {},
959
- BAD_REQUEST: {}
1761
+ FORBIDDEN: {}
960
1762
  }).input(z.object({
961
1763
  teamId: z.string().optional(),
962
1764
  name: z.string().trim().min(1).max(100),
@@ -996,7 +1798,7 @@ const environmentVariableOutputSchema = z.object({
996
1798
  isSecret: z.boolean(),
997
1799
  createdAt: z.coerce.date()
998
1800
  });
999
- const listEnvironmentVariablesContractV1 = oc.route({
1801
+ const listEnvironmentVariablesContractV1 = base.route({
1000
1802
  path: "/v1/environments/{environmentId}/environment-variables",
1001
1803
  method: "GET",
1002
1804
  summary: "List environment variables",
@@ -1004,37 +1806,31 @@ const listEnvironmentVariablesContractV1 = oc.route({
1004
1806
  tags: ["environments"],
1005
1807
  successDescription: "The list of environment variables"
1006
1808
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
1007
- const createEnvironmentVariablesContractV1 = oc.route({
1809
+ const createEnvironmentVariablesContractV1 = base.route({
1008
1810
  path: "/v1/environments/{environmentId}/environment-variables",
1009
1811
  method: "POST",
1010
1812
  summary: "Add environment variables",
1011
1813
  description: "Add one or more environment variables to an environment",
1012
1814
  tags: ["environments"],
1013
1815
  successDescription: "The environment variables have been added successfully"
1014
- }).errors({
1015
- NOT_FOUND: {},
1016
- BAD_REQUEST: {}
1017
- }).input(z.object({
1816
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1018
1817
  environmentId: z.string().describe("The ID of the environment"),
1019
1818
  environmentVariables: environmentVariablesSchema
1020
1819
  })).output(z.object({ success: z.literal(true) }));
1021
- const updateEnvironmentVariableContractV1 = oc.route({
1820
+ const updateEnvironmentVariableContractV1 = base.route({
1022
1821
  path: "/v1/environment-variables/{environmentVariableId}",
1023
1822
  method: "PATCH",
1024
1823
  summary: "Update an environment variable",
1025
1824
  description: "Update an environment variable by ID",
1026
1825
  tags: ["environments"],
1027
1826
  successDescription: "The environment variable has been updated successfully"
1028
- }).errors({
1029
- NOT_FOUND: {},
1030
- BAD_REQUEST: {}
1031
- }).input(z.object({
1827
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1032
1828
  environmentVariableId: z.string().describe("The ID of the environment variable"),
1033
1829
  key: environmentVariableSchema.shape.key,
1034
1830
  value: environmentVariableSchema.shape.value.optional(),
1035
1831
  isSecret: environmentVariableSchema.shape.isSecret.optional()
1036
1832
  })).output(z.object({ success: z.literal(true) }));
1037
- const deleteEnvironmentVariableContractV1 = oc.route({
1833
+ const deleteEnvironmentVariableContractV1 = base.route({
1038
1834
  path: "/v1/environment-variables/{environmentVariableId}",
1039
1835
  method: "DELETE",
1040
1836
  summary: "Delete an environment variable",
@@ -1042,7 +1838,7 @@ const deleteEnvironmentVariableContractV1 = oc.route({
1042
1838
  tags: ["environments"],
1043
1839
  successDescription: "The environment variable has been deleted successfully"
1044
1840
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
1045
- const deleteProjectContractV1 = oc.route({
1841
+ const deleteProjectContractV1 = base.route({
1046
1842
  path: "/v1/projects/{projectId}",
1047
1843
  method: "DELETE",
1048
1844
  summary: "Delete a project",
@@ -1050,7 +1846,7 @@ const deleteProjectContractV1 = oc.route({
1050
1846
  tags: ["projects"],
1051
1847
  successDescription: "The project has been deleted successfully"
1052
1848
  }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
1053
- const updateProjectContractV1 = oc.route({
1849
+ const updateProjectContractV1 = base.route({
1054
1850
  path: "/v1/projects/{projectId}",
1055
1851
  method: "PATCH",
1056
1852
  summary: "Update a project",
@@ -1059,13 +1855,13 @@ const updateProjectContractV1 = oc.route({
1059
1855
  successDescription: "The project has been updated successfully"
1060
1856
  }).errors({
1061
1857
  NOT_FOUND: {},
1062
- BAD_REQUEST: {}
1858
+ FORBIDDEN: {}
1063
1859
  }).input(z.object({
1064
1860
  projectId: z.string().describe("The ID of the project"),
1065
1861
  name: z.string().min(1).max(100).optional().describe("The new name for the project"),
1066
1862
  sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
1067
1863
  })).output(projectOutputSchema);
1068
- const deployEnvironmentContractV1 = oc.route({
1864
+ const deployEnvironmentContractV1 = base.route({
1069
1865
  path: "/v1/environments/{environmentId}/deploy",
1070
1866
  method: "POST",
1071
1867
  summary: "Deploy an environment",
@@ -1074,24 +1870,25 @@ const deployEnvironmentContractV1 = oc.route({
1074
1870
  successDescription: "The environment has been deployed successfully"
1075
1871
  }).errors({
1076
1872
  NOT_FOUND: {},
1077
- BAD_REQUEST: {}
1873
+ CONFLICT: {}
1078
1874
  }).input(z.object({
1079
1875
  environmentId: z.string().describe("The ID of the environment to deploy"),
1080
- token: z.string().describe("The token to identify the source archive").optional()
1876
+ token: z.string().describe("The token to identify the source archive").optional(),
1877
+ settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
1081
1878
  })).output(deploymentSchema);
1082
- const uploadDeploymentArtifactContractV1 = oc.route({
1879
+ const uploadDeploymentArtifactContractV1 = base.route({
1083
1880
  path: "/v1/deployments/upload",
1084
1881
  method: "POST",
1085
1882
  summary: "Upload deployment artifacts",
1086
1883
  description: "Return a presigned S3 URL to upload a deployment artifact",
1087
1884
  tags: ["deployments"],
1088
1885
  successDescription: "The presigned upload URL has been generated successfully"
1089
- }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
1886
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
1090
1887
  uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
1091
1888
  token: z.string().describe("Token to identify the source archive"),
1092
1889
  expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
1093
1890
  }));
1094
- const listDeploymentsContractV1 = oc.route({
1891
+ const listDeploymentsContractV1 = base.route({
1095
1892
  path: "/v1/projects/{projectId}/deployments",
1096
1893
  method: "GET",
1097
1894
  summary: "List project deployments",
@@ -1103,7 +1900,7 @@ const listDeploymentsContractV1 = oc.route({
1103
1900
  status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
1104
1901
  environmentId: z.string().optional().describe("Filter by environment ID")
1105
1902
  })).output(z.array(deploymentSchema));
1106
- const getDeploymentContractV1 = oc.route({
1903
+ const getDeploymentContractV1 = base.route({
1107
1904
  path: "/v1/deployments/{deploymentId}",
1108
1905
  method: "GET",
1109
1906
  summary: "Get a deployment",
@@ -1111,20 +1908,32 @@ const getDeploymentContractV1 = oc.route({
1111
1908
  tags: ["deployments"],
1112
1909
  successDescription: "The deployment details"
1113
1910
  }).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
1114
- const getLogsContractV1 = oc.route({
1911
+ const logEntrySchema = z.object({
1912
+ timestamp: z.coerce.date(),
1913
+ type: z.enum([
1914
+ "START",
1915
+ "END",
1916
+ "INFO",
1917
+ "ERROR",
1918
+ "WARNING",
1919
+ "DEBUG"
1920
+ ]),
1921
+ requestId: z.string(),
1922
+ content: z.string().optional(),
1923
+ method: z.string().optional(),
1924
+ durationInMs: z.number().optional()
1925
+ });
1926
+ const getLogsContractV1 = base.route({
1115
1927
  path: "/v1/environments/{environmentId}/logs",
1116
1928
  method: "GET",
1117
1929
  summary: "Get logs",
1118
1930
  description: "Get logs for an environment",
1119
1931
  tags: ["environments"],
1120
1932
  successDescription: "The logs"
1121
- }).errors({
1122
- NOT_FOUND: {},
1123
- BAD_REQUEST: {}
1124
- }).input(z.object({
1933
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1125
1934
  environmentId: z.string().describe("The ID of the environment"),
1126
- 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)"),
1127
- 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"),
1935
+ since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
1936
+ until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
1128
1937
  limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
1129
1938
  level: z.array(z.enum([
1130
1939
  "INFO",
@@ -1135,34 +1944,17 @@ const getLogsContractV1 = oc.route({
1135
1944
  search: z.string().optional().describe("Filter pattern to search for in log content"),
1136
1945
  nextToken: z.string().optional().describe("Pagination token from a previous response")
1137
1946
  })).output(z.object({
1138
- logs: z.array(z.object({
1139
- timestamp: z.coerce.date(),
1140
- type: z.enum([
1141
- "START",
1142
- "END",
1143
- "INFO",
1144
- "ERROR",
1145
- "WARNING",
1146
- "DEBUG"
1147
- ]),
1148
- requestId: z.string(),
1149
- content: z.string().optional(),
1150
- method: z.string().optional(),
1151
- durationInMs: z.number().optional()
1152
- })),
1947
+ logs: z.array(logEntrySchema),
1153
1948
  nextToken: z.string().nullable()
1154
1949
  }));
1155
- const getLatestLogsContractV1 = oc.route({
1950
+ const getLatestLogsContractV1 = base.route({
1156
1951
  path: "/v1/environments/{environmentId}/latest-logs",
1157
1952
  method: "GET",
1158
1953
  summary: "Get latest logs",
1159
1954
  description: "Get the N most recent logs for an environment",
1160
1955
  tags: ["environments"],
1161
1956
  successDescription: "The latest logs"
1162
- }).errors({
1163
- NOT_FOUND: {},
1164
- BAD_REQUEST: {}
1165
- }).input(z.object({
1957
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1166
1958
  environmentId: z.string().describe("The ID of the environment"),
1167
1959
  limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
1168
1960
  level: z.array(z.enum([
@@ -1172,22 +1964,8 @@ const getLatestLogsContractV1 = oc.route({
1172
1964
  "DEBUG"
1173
1965
  ])).optional().describe("Filter by log level"),
1174
1966
  search: z.string().optional().describe("Filter pattern to search for in log content")
1175
- })).output(z.object({ logs: z.array(z.object({
1176
- timestamp: z.coerce.date(),
1177
- type: z.enum([
1178
- "START",
1179
- "END",
1180
- "INFO",
1181
- "ERROR",
1182
- "WARNING",
1183
- "DEBUG"
1184
- ]),
1185
- requestId: z.string(),
1186
- content: z.string().optional(),
1187
- method: z.string().optional(),
1188
- durationInMs: z.number().optional()
1189
- })) }));
1190
- const getDeploymentLogsContractV1 = oc.route({
1967
+ })).output(z.object({ logs: z.array(logEntrySchema) }));
1968
+ const getDeploymentLogsContractV1 = base.route({
1191
1969
  path: "/v1/deployments/{deploymentId}/logs",
1192
1970
  method: "GET",
1193
1971
  summary: "Get deployment logs",
@@ -1214,22 +1992,19 @@ const analyticsTimeSeriesSchema = z.object({
1214
1992
  output_token_mean: z.array(analyticsDataPointSchema),
1215
1993
  task_count: z.array(analyticsDataPointSchema)
1216
1994
  });
1217
- const getProjectAnalyticsContractV1 = oc.route({
1995
+ const getProjectAnalyticsContractV1 = base.route({
1218
1996
  path: "/v1/analytics/{projectId}",
1219
1997
  method: "GET",
1220
1998
  summary: "Get project analytics",
1221
1999
  description: "Get analytics data for a project over a time range",
1222
2000
  tags: ["analytics"],
1223
2001
  successDescription: "The project analytics data"
1224
- }).errors({
1225
- NOT_FOUND: {},
1226
- BAD_REQUEST: {}
1227
- }).input(z.object({
2002
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1228
2003
  projectId: z.string().describe("The ID of the project"),
1229
2004
  startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
1230
2005
  endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
1231
2006
  timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
1232
- }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 744 * 60 * 60 * 1e3, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => Intl.supportedValuesOf("timeZone").includes(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
2007
+ }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => isValidIanaTimeZone(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
1233
2008
  metadata: z.object({
1234
2009
  startTimestamp: z.number(),
1235
2010
  endTimestamp: z.number(),
@@ -1239,7 +2014,132 @@ const getProjectAnalyticsContractV1 = oc.route({
1239
2014
  }),
1240
2015
  timeSeries: analyticsTimeSeriesSchema
1241
2016
  }));
1242
- const listTeamsContractV1 = oc.route({
2017
+ const paginatedInsightsInputShape = {
2018
+ environmentId: z.string().describe("The ID of the environment"),
2019
+ since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
2020
+ until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
2021
+ limit: z.coerce.number().int().min(1).max(200).default(50),
2022
+ offset: z.coerce.number().int().min(0).default(0),
2023
+ search: z.string().trim().min(1).max(200).optional()
2024
+ };
2025
+ const listIntentsContractV1 = base.route({
2026
+ path: "/v1/environments/{environmentId}/intents",
2027
+ method: "GET",
2028
+ summary: "List intents",
2029
+ description: "List grouped user intents for an environment over a time range",
2030
+ tags: ["insights"],
2031
+ successDescription: "The grouped user intents"
2032
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2033
+ ...paginatedInsightsInputShape,
2034
+ tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
2035
+ clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
2036
+ categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
2037
+ sortDir: z.enum(["asc", "desc"]).default("desc")
2038
+ })).output(z.object({
2039
+ intents: z.array(z.object({
2040
+ id: z.string(),
2041
+ intentIds: z.array(z.string()).min(1),
2042
+ environmentId: z.string(),
2043
+ message: z.string(),
2044
+ toolName: z.string(),
2045
+ createdAt: z.coerce.date(),
2046
+ occurrenceCount: z.number().int().positive(),
2047
+ clientName: z.string().nullable(),
2048
+ clientId: z.string().nullable(),
2049
+ categories: z.array(z.object({
2050
+ id: z.string(),
2051
+ name: z.string(),
2052
+ color: intentCategoryColorSchema
2053
+ }))
2054
+ })),
2055
+ totalCount: z.number().int().nonnegative()
2056
+ }));
2057
+ const listFeedbacksContractV1 = base.route({
2058
+ path: "/v1/environments/{environmentId}/feedbacks",
2059
+ method: "GET",
2060
+ summary: "List feedbacks",
2061
+ description: "List user feedback for an environment over a time range",
2062
+ tags: ["insights"],
2063
+ successDescription: "The user feedback"
2064
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2065
+ ...paginatedInsightsInputShape,
2066
+ clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
2067
+ })).output(z.object({
2068
+ feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
2069
+ totalCount: z.number().int().nonnegative()
2070
+ }));
2071
+ const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
2072
+ const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
2073
+ const listIntentCategoriesContractV1 = base.route({
2074
+ path: "/v1/environments/{environmentId}/intent-categories",
2075
+ method: "GET",
2076
+ summary: "List intent categories",
2077
+ description: "List intent categories for an environment, including how many intents each category is linked to",
2078
+ tags: ["insights"],
2079
+ successDescription: "The intent categories"
2080
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
2081
+ const createIntentCategoryContractV1 = base.route({
2082
+ path: "/v1/environments/{environmentId}/intent-categories",
2083
+ method: "POST",
2084
+ summary: "Create an intent category",
2085
+ description: "Create an intent category, optionally linking it to existing intents",
2086
+ tags: ["insights"],
2087
+ successDescription: "The created intent category"
2088
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2089
+ environmentId: z.string().describe("The ID of the environment"),
2090
+ name: intentCategoryNameSchema,
2091
+ color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
2092
+ intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
2093
+ })).output(intentCategorySchema);
2094
+ const updateIntentCategoryContractV1 = base.route({
2095
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
2096
+ method: "PATCH",
2097
+ summary: "Update an intent category",
2098
+ description: "Rename or recolor an intent category",
2099
+ tags: ["insights"],
2100
+ successDescription: "The updated intent category"
2101
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2102
+ environmentId: z.string().describe("The ID of the environment"),
2103
+ categoryId: z.string().describe("The ID of the category"),
2104
+ name: intentCategoryNameSchema.optional(),
2105
+ color: intentCategoryColorSchema.optional().describe("The category color")
2106
+ }).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
2107
+ const deleteIntentCategoryContractV1 = base.route({
2108
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
2109
+ method: "DELETE",
2110
+ summary: "Delete an intent category",
2111
+ description: "Delete an intent category; its intents are unlinked but not deleted",
2112
+ tags: ["insights"],
2113
+ successDescription: "The intent category has been deleted successfully"
2114
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2115
+ environmentId: z.string().describe("The ID of the environment"),
2116
+ categoryId: z.string().describe("The ID of the category")
2117
+ })).output(z.object({ success: z.literal(true) }));
2118
+ const linkIntentCategoryContractV1 = base.route({
2119
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
2120
+ method: "POST",
2121
+ summary: "Link an intent category",
2122
+ description: "Link an intent category to intents; already linked intents are ignored",
2123
+ tags: ["insights"],
2124
+ successDescription: "The intents have been linked successfully"
2125
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2126
+ environmentId: z.string().describe("The ID of the environment"),
2127
+ categoryId: z.string().describe("The ID of the category"),
2128
+ intentIds: categorizableIntentIdsSchema
2129
+ })).output(z.object({ success: z.literal(true) }));
2130
+ const unlinkIntentCategoryContractV1 = base.route({
2131
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
2132
+ method: "POST",
2133
+ summary: "Unlink an intent category",
2134
+ description: "Unlink an intent category from intents; intents without the category are ignored",
2135
+ tags: ["insights"],
2136
+ successDescription: "The intents have been unlinked successfully"
2137
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2138
+ environmentId: z.string().describe("The ID of the environment"),
2139
+ categoryId: z.string().describe("The ID of the category"),
2140
+ intentIds: categorizableIntentIdsSchema
2141
+ })).output(z.object({ success: z.literal(true) }));
2142
+ const listTeamsContractV1 = base.route({
1243
2143
  path: "/v1/teams",
1244
2144
  method: "GET",
1245
2145
  summary: "List teams",
@@ -1252,28 +2152,40 @@ const listTeamsContractV1 = oc.route({
1252
2152
  createdAt: z.coerce.date(),
1253
2153
  hasStripeAccount: z.boolean()
1254
2154
  })));
1255
- const getTunnelTicketContractV1 = oc.route({
2155
+ const getTeamUsageContractV1 = base.route({
2156
+ path: "/v1/teams/{teamId}/usage",
2157
+ method: "GET",
2158
+ summary: "Get team usage",
2159
+ description: "Get the MCP request usage of a team for its current billing window. A team that has made no request in the window reports zero.",
2160
+ tags: ["teams"],
2161
+ successDescription: "The current billing window usage"
2162
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
2163
+ teamId: z.string(),
2164
+ plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
2165
+ periodStart: z.coerce.date().describe("Start of the current billing window"),
2166
+ periodEnd: z.coerce.date().describe("End of the current billing window"),
2167
+ requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
2168
+ includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
2169
+ }));
2170
+ const getTunnelTicketContractV1 = base.route({
1256
2171
  path: "/v1/tunnels/ticket",
1257
2172
  method: "GET",
1258
2173
  summary: "Get a tunnel ticket",
1259
2174
  description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
1260
2175
  tags: ["tunnels"],
1261
2176
  successDescription: "The tunnel ticket"
1262
- }).output(z.object({
2177
+ }).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
1263
2178
  subdomain: z.string().describe("The subdomain assigned to the user"),
1264
2179
  ticket: z.string().describe("The signed tunnel ticket"),
1265
2180
  tunnelHost: z.string().describe("The tunnel host to connect to")
1266
2181
  }));
1267
- const publishServerContractV1 = oc.route({
2182
+ const publishServerContractV1 = base.route({
1268
2183
  path: "/v1/distribution/publish",
1269
2184
  method: "POST",
1270
2185
  summary: "Publish a server to the MCP registry",
1271
2186
  tags: ["distribution"],
1272
2187
  successDescription: "The server has been published successfully"
1273
- }).errors({
1274
- NOT_FOUND: {},
1275
- BAD_REQUEST: {}
1276
- }).input(z.object({
2188
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1277
2189
  projectId: z.string(),
1278
2190
  domain: z.string(),
1279
2191
  title: z.string().min(1).max(100),
@@ -1282,17 +2194,14 @@ const publishServerContractV1 = oc.route({
1282
2194
  iconSrc: z.url().max(255).optional(),
1283
2195
  dryRun: z.boolean().optional()
1284
2196
  })).output(z.object({ serverFields: serverFieldsSchema }));
1285
- const getServerInfoContractV1 = oc.route({
2197
+ const getServerInfoContractV1 = base.route({
1286
2198
  path: "/v1/distribution/get",
1287
2199
  method: "GET",
1288
2200
  summary: "Get server info",
1289
2201
  description: "Get info about a server",
1290
2202
  tags: ["distribution"],
1291
2203
  successDescription: "The server info"
1292
- }).errors({
1293
- NOT_FOUND: {},
1294
- BAD_REQUEST: {}
1295
- }).input(z.object({
2204
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1296
2205
  projectId: z.string(),
1297
2206
  domain: z.string()
1298
2207
  })).output(z.object({ serverFields: serverFieldsSchema }));
@@ -1311,7 +2220,7 @@ const playgroundOutputSchema = z.object({
1311
2220
  isPlaygroundEnabled: z.boolean(),
1312
2221
  serverMetadata: playgroundServerMetadataOutputSchema.nullable()
1313
2222
  });
1314
- const getPlaygroundContractV1 = oc.route({
2223
+ const getPlaygroundContractV1 = base.route({
1315
2224
  path: "/v1/environments/{environmentId}/playground",
1316
2225
  method: "GET",
1317
2226
  summary: "Get playground configuration",
@@ -1319,25 +2228,22 @@ const getPlaygroundContractV1 = oc.route({
1319
2228
  tags: ["environments"],
1320
2229
  successDescription: "The playground configuration"
1321
2230
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
1322
- const upsertPlaygroundContractV1 = oc.route({
2231
+ const upsertPlaygroundContractV1 = base.route({
1323
2232
  path: "/v1/environments/{environmentId}/playground",
1324
2233
  method: "PUT",
1325
2234
  summary: "Update playground configuration",
1326
2235
  description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
1327
2236
  tags: ["environments"],
1328
2237
  successDescription: "The updated playground configuration"
1329
- }).errors({
1330
- NOT_FOUND: {},
1331
- BAD_REQUEST: {}
1332
- }).input(z.object({
2238
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1333
2239
  environmentId: z.string().describe("The ID of the environment"),
1334
2240
  isPlaygroundEnabled: z.boolean().optional(),
1335
2241
  name: z.string().min(1).max(100).optional(),
1336
2242
  description: z.string().min(1).max(500).optional(),
1337
2243
  headers: z.array(playgroundHeaderSchema).optional(),
1338
- examplePrompts: z.array(playgroundExamplePromptSchema).max(3).optional()
2244
+ examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
1339
2245
  })).output(playgroundOutputSchema);
1340
- const createBeaconContractV1 = oc.route({
2246
+ const createBeaconContractV1 = base.route({
1341
2247
  path: "/v1/beacon/audits",
1342
2248
  method: "POST",
1343
2249
  summary: "Create a beacon audit",
@@ -1346,7 +2252,6 @@ const createBeaconContractV1 = oc.route({
1346
2252
  successDescription: "The audit has been created"
1347
2253
  }).errors({
1348
2254
  NOT_FOUND: {},
1349
- BAD_REQUEST: {},
1350
2255
  DNS_RESOLUTION_FAILED: { status: 400 }
1351
2256
  }).input(z.object({
1352
2257
  targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
@@ -1354,7 +2259,7 @@ const createBeaconContractV1 = oc.route({
1354
2259
  projectId: z.string().optional().describe("The project ID to associate the audit with"),
1355
2260
  excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
1356
2261
  })).output(z.object({ id: z.string() }));
1357
- const getBeaconContractV1 = oc.route({
2262
+ const getBeaconContractV1 = base.route({
1358
2263
  path: "/v1/beacon/audits/{auditId}",
1359
2264
  method: "GET",
1360
2265
  summary: "Get a beacon audit",
@@ -1370,8 +2275,21 @@ const getBeaconContractV1 = oc.route({
1370
2275
  report: auditReportWithScreenshotsSchema.nullable()
1371
2276
  }));
1372
2277
  const contract = {
1373
- teams: { list: { v1: listTeamsContractV1 } },
2278
+ teams: {
2279
+ list: { v1: listTeamsContractV1 },
2280
+ getUsage: { v1: getTeamUsageContractV1 }
2281
+ },
1374
2282
  analytics: { get: { v1: getProjectAnalyticsContractV1 } },
2283
+ intents: { list: { v1: listIntentsContractV1 } },
2284
+ intentCategories: {
2285
+ list: { v1: listIntentCategoriesContractV1 },
2286
+ create: { v1: createIntentCategoryContractV1 },
2287
+ update: { v1: updateIntentCategoryContractV1 },
2288
+ delete: { v1: deleteIntentCategoryContractV1 },
2289
+ link: { v1: linkIntentCategoryContractV1 },
2290
+ unlink: { v1: unlinkIntentCategoryContractV1 }
2291
+ },
2292
+ feedbacks: { list: { v1: listFeedbacksContractV1 } },
1375
2293
  deployments: {
1376
2294
  list: { v1: listDeploymentsContractV1 },
1377
2295
  get: { v1: getDeploymentContractV1 },
@@ -1381,6 +2299,7 @@ const contract = {
1381
2299
  environments: {
1382
2300
  create: { v1: createEnvironmentContractV1 },
1383
2301
  get: { v1: getEnvironmentContractV1 },
2302
+ delete: { v1: deleteEnvironmentContractV1 },
1384
2303
  deploy: { v1: deployEnvironmentContractV1 },
1385
2304
  getLogs: { v1: getLogsContractV1 },
1386
2305
  getLatestLogs: { v1: getLatestLogsContractV1 }
@@ -1412,5 +2331,10 @@ const contract = {
1412
2331
  get: { v1: getBeaconContractV1 }
1413
2332
  }
1414
2333
  };
2334
+ const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
2335
+ const contractForDocs = {
2336
+ ...contract,
2337
+ deployments: deploymentsForDocs
2338
+ };
1415
2339
  //#endregion
1416
- export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
2340
+ export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };