@alpic-ai/api 0.0.0-dev.gf8b5f22 → 0.0.0-dev.gf8c1cc3

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 +6757 -122
  2. package/dist/index.mjs +1660 -357
  3. package/package.json +26 -10
package/dist/index.mjs CHANGED
@@ -1,11 +1,200 @@
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.32.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
+ /**
124
+ * Not part of the wire format: the authorization server this value was obtained from, added by
125
+ * the client's `auth()` before it is stored and compared when it is read back.
126
+ */
127
+ issuer: z$1.string().optional().catch(void 0)
128
+ }).strip();
129
+ z$1.object({
130
+ error: z$1.string(),
131
+ error_description: z$1.string().optional(),
132
+ error_uri: z$1.string().optional()
133
+ });
134
+ /**
135
+ * Optional version of SafeUrlSchema that allows empty string for retrocompatibility on tos_uri and logo_uri
136
+ */
137
+ const OptionalSafeUrlSchema = SafeUrlSchema.optional().or(z$1.literal("").transform(() => void 0));
138
+ /**
139
+ * RFC 7591 OAuth 2.0 Dynamic Client Registration metadata
140
+ */
141
+ const OAuthClientMetadataSchema = z$1.object({
142
+ redirect_uris: z$1.array(SafeUrlSchema),
143
+ token_endpoint_auth_method: z$1.string().optional(),
144
+ grant_types: z$1.array(z$1.string()).optional(),
145
+ response_types: z$1.array(z$1.string()).optional(),
146
+ client_name: z$1.string().optional(),
147
+ client_uri: SafeUrlSchema.optional(),
148
+ logo_uri: OptionalSafeUrlSchema,
149
+ scope: z$1.string().optional(),
150
+ contacts: z$1.array(z$1.string()).optional(),
151
+ tos_uri: OptionalSafeUrlSchema,
152
+ policy_uri: z$1.string().optional(),
153
+ jwks_uri: SafeUrlSchema.optional(),
154
+ jwks: z$1.any().optional(),
155
+ software_id: z$1.string().optional(),
156
+ software_version: z$1.string().optional(),
157
+ software_statement: z$1.string().optional()
158
+ }).strip();
159
+ /**
160
+ * RFC 7591 OAuth 2.0 Dynamic Client Registration client information
161
+ */
162
+ const OAuthClientInformationSchema = z$1.object({
163
+ client_id: z$1.string(),
164
+ client_secret: z$1.string().optional(),
165
+ client_id_issued_at: z$1.number().optional(),
166
+ client_secret_expires_at: z$1.number().optional(),
167
+ /**
168
+ * Not part of the wire format: the authorization server this value was obtained from, added by
169
+ * the client's `auth()` before it is stored and compared when it is read back.
170
+ */
171
+ issuer: z$1.string().optional().catch(void 0)
172
+ }).strip();
173
+ OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
174
+ z$1.object({
175
+ error: z$1.string(),
176
+ error_description: z$1.string().optional()
177
+ }).strip();
178
+ z$1.object({
179
+ token: z$1.string(),
180
+ token_type_hint: z$1.string().optional()
181
+ }).strip();
182
+ //#endregion
183
+ //#region ../domains/dist/index.mjs
184
+ const AI_PLATFORMS = ["chatgpt", "claudeai"];
185
+ const platformSchema = z.enum(AI_PLATFORMS);
5
186
  const PLATFORM_LABELS = {
6
187
  chatgpt: "ChatGPT",
7
188
  claudeai: "Claude.ai"
8
189
  };
190
+ const WAF_PLATFORMS = [
191
+ "akamai",
192
+ "cato",
193
+ "cloudflare",
194
+ "fastly"
195
+ ];
196
+ const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
197
+ const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
9
198
  const auditStatusSchema = z.enum([
10
199
  "pending",
11
200
  "partial",
@@ -71,6 +260,32 @@ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreen
71
260
  chatgpt: widgetScreenshotSchema.optional(),
72
261
  claudeai: widgetScreenshotSchema.optional()
73
262
  }) });
263
+ z.object({
264
+ id: z.string(),
265
+ environmentId: z.string(),
266
+ clientId: z.string(),
267
+ clientSecret: z.string(),
268
+ clientScopes: z.array(z.string())
269
+ });
270
+ const creditEntryReasonSchema = z.enum([
271
+ "free_seed",
272
+ "paid_conversion_floor",
273
+ "top_up",
274
+ "usage",
275
+ "admin_adjustment"
276
+ ]);
277
+ z.enum(["playground"]);
278
+ z.number().int().min(500);
279
+ const creditActivityEntrySchema = z.object({
280
+ reason: creditEntryReasonSchema,
281
+ day: z.number(),
282
+ amountInNanoUSD: z.number(),
283
+ messageCount: z.number().nullable()
284
+ });
285
+ z.object({
286
+ balanceInNanoUSD: z.number(),
287
+ recentActivity: z.array(creditActivityEntrySchema)
288
+ });
74
289
  const deploymentStatusSchema$1 = z.enum([
75
290
  "ongoing",
76
291
  "deployed",
@@ -98,9 +313,91 @@ const deploymentSummarySchema = z.object({
98
313
  createdAt: z.coerce.date(),
99
314
  updatedAt: z.coerce.date()
100
315
  });
101
- const allowedPlatformSchema = platformSchema;
316
+ /** Public environment: answers anonymously and exposes no OAuth metadata. */
317
+ const publicEnvironmentSchema = z.object({
318
+ allowsAnonymous: z.literal(true),
319
+ oAuthMetadata: z.strictObject({})
320
+ });
321
+ /** 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. */
322
+ const externalResourceMetadataEnvironmentSchema = z.object({
323
+ allowsAnonymous: z.boolean(),
324
+ oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
325
+ scope: z.string().optional()
326
+ });
327
+ /** 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. */
328
+ const externalAuthorizationServerEnvironmentSchema = z.object({
329
+ allowsAnonymous: z.boolean(),
330
+ oAuthMetadata: z.object({
331
+ externalAuthorizationServerUrl: z.url(),
332
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
333
+ }),
334
+ scope: z.string().optional()
335
+ });
336
+ /** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
337
+ const standaloneEnvironmentSchema = z.object({
338
+ allowsAnonymous: z.boolean(),
339
+ oAuthMetadata: z.object({
340
+ authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
341
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
342
+ }),
343
+ scope: z.string().optional()
344
+ });
345
+ /** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
346
+ const protectedWithoutDiscoveryEnvironmentSchema = z.object({
347
+ allowsAnonymous: z.literal(false),
348
+ oAuthMetadata: z.strictObject({}),
349
+ scope: z.string().optional()
350
+ });
351
+ const legacyPublicEnvironmentSchema = z.object({
352
+ isPublic: z.literal(true),
353
+ oAuthMetadata: z.undefined().optional()
354
+ });
355
+ const legacyExternalResourceMetadataEnvironmentSchema = z.object({
356
+ isPublic: z.literal(false),
357
+ oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
358
+ scope: z.string().optional()
359
+ });
360
+ const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
361
+ isPublic: z.literal(false),
362
+ oAuthMetadata: z.object({
363
+ externalAuthorizationServerUrl: z.url(),
364
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
365
+ }),
366
+ scope: z.string().optional()
367
+ });
368
+ const legacyStandaloneEnvironmentSchema = z.object({
369
+ isPublic: z.literal(false),
370
+ oAuthMetadata: z.object({
371
+ authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
372
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
373
+ }),
374
+ scope: z.string().optional()
375
+ });
376
+ const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
377
+ isPublic: z.literal(false),
378
+ oAuthMetadata: z.strictObject({}),
379
+ scope: z.string().optional()
380
+ });
381
+ z.union([
382
+ publicEnvironmentSchema,
383
+ externalResourceMetadataEnvironmentSchema,
384
+ externalAuthorizationServerEnvironmentSchema,
385
+ standaloneEnvironmentSchema,
386
+ protectedWithoutDiscoveryEnvironmentSchema,
387
+ legacyPublicEnvironmentSchema,
388
+ legacyExternalResourceMetadataEnvironmentSchema,
389
+ legacyExternalAuthorizationServerEnvironmentSchema,
390
+ legacyStandaloneEnvironmentSchema,
391
+ legacyProtectedWithoutDiscoveryEnvironmentSchema
392
+ ]);
393
+ const playgroundModelSchema = z.enum([
394
+ "global.anthropic.claude-haiku-4-5-20251001-v1:0",
395
+ "global.anthropic.claude-sonnet-4-5-20250929-v1:0",
396
+ "openai.gpt-5.4",
397
+ "openai.gpt-5.5"
398
+ ]);
102
399
  const environmentDomainSchema = z.object({
103
- domain: z.string(),
400
+ name: z.string(),
104
401
  status: z.enum([
105
402
  "ongoing",
106
403
  "deployed",
@@ -118,6 +415,7 @@ const environmentSchema$1 = z.object({
118
415
  latestDeployment: deploymentSummarySchema.optional(),
119
416
  openaiAppsChallenge: z.string().nullable().optional(),
120
417
  isPlaygroundEnabled: z.boolean(),
418
+ playgroundModel: playgroundModelSchema,
121
419
  isIpWhitelistEnabled: z.boolean(),
122
420
  ipAllowlist: z.array(z.string()).nullable(),
123
421
  allowedPlatforms: z.array(allowedPlatformSchema),
@@ -127,11 +425,21 @@ const environmentSchema$1 = z.object({
127
425
  });
128
426
  const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
129
427
  z.object({
428
+ sessionReplayEnabled: z.boolean(),
429
+ collectRequestPayload: z.boolean(),
430
+ collectResponsePayload: z.boolean(),
431
+ collectErrorMessage: z.boolean(),
432
+ collectUserData: z.boolean(),
433
+ identityTraitKey: z.string().min(1).max(200).nullable(),
434
+ leadEventName: z.string().min(1).max(200).nullable()
435
+ });
436
+ const feedbackSchema = z.object({
130
437
  id: z.string(),
131
438
  createdAt: z.coerce.date(),
132
439
  environmentId: z.string(),
133
440
  content: z.string(),
134
- source: z.enum(["model", "user"])
441
+ source: z.enum(["model", "user"]),
442
+ clientName: z.string().nullable()
135
443
  });
136
444
  z.object({
137
445
  content: z.string(),
@@ -147,7 +455,7 @@ const intentCategoryColorSchema = z.enum([
147
455
  "pink",
148
456
  "gray"
149
457
  ]);
150
- intentCategoryColorSchema.options;
458
+ const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
151
459
  const intentCategorySchema = z.object({
152
460
  id: z.string(),
153
461
  createdAt: z.coerce.date(),
@@ -155,7 +463,7 @@ const intentCategorySchema = z.object({
155
463
  name: z.string(),
156
464
  color: intentCategoryColorSchema
157
465
  });
158
- z.object({
466
+ const intentCategorySummarySchema = z.object({
159
467
  id: z.string(),
160
468
  name: z.string(),
161
469
  color: intentCategoryColorSchema,
@@ -167,6 +475,7 @@ z.object({
167
475
  environmentId: z.string(),
168
476
  toolName: z.string(),
169
477
  message: z.string(),
478
+ clientName: z.string().nullable(),
170
479
  categories: z.array(intentCategorySchema)
171
480
  });
172
481
  const signalCategorySchema = z.object({
@@ -225,12 +534,270 @@ z.object({
225
534
  createdAt: z.coerce.date(),
226
535
  updatedAt: z.coerce.date()
227
536
  });
537
+ const alpicMcpRequestLogSchema = z.object({
538
+ type: z.literal("mcp_request"),
539
+ method: z.string()
540
+ });
541
+ const alpicMcpErrorLogSchema = z.object({
542
+ type: z.literal("mcp_error"),
543
+ method: z.string(),
544
+ error: z.string()
545
+ });
546
+ z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
228
547
  z.enum([
229
548
  "INFO",
230
549
  "WARNING",
231
550
  "DEBUG",
232
551
  "ERROR"
233
552
  ]);
553
+ const LOG_SEARCH_MAX_ESCAPED_LENGTH = 960;
554
+ function escapeLogSearchTerm(search) {
555
+ return [...search].flatMap((character) => [...new TextEncoder().encode(character)]).map((byte) => {
556
+ const character = String.fromCharCode(byte);
557
+ return /^[a-zA-Z0-9]$/.test(character) ? character : `\\x${byte.toString(16).toUpperCase().padStart(2, "0")}`;
558
+ }).join("");
559
+ }
560
+ const logSearchSchema = z.string().max(240, `Search must be 240 characters or fewer`).refine((search) => escapeLogSearchTerm(search).length <= LOG_SEARCH_MAX_ESCAPED_LENGTH, "Search is too complex; shorten it or use fewer special characters");
561
+ /** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
562
+ const MCP_CLIENT_GROUPS = [
563
+ {
564
+ id: "claude_code",
565
+ label: "Claude Code",
566
+ vendor: "anthropic",
567
+ rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
568
+ },
569
+ {
570
+ id: "claude",
571
+ label: "Claude",
572
+ vendor: "anthropic",
573
+ rawNames: [
574
+ "Anthropic/ClaudeAI",
575
+ "claude-ai",
576
+ "claude",
577
+ "Claude",
578
+ "claude-desktop",
579
+ "claude-desktop-3p"
580
+ ]
581
+ },
582
+ {
583
+ id: "claude_mobile",
584
+ label: "Claude mobile",
585
+ vendor: "anthropic",
586
+ rawNames: ["claude-ios", "ClaudeAndroid"]
587
+ },
588
+ {
589
+ id: "claude_cowork",
590
+ label: "Claude Cowork",
591
+ vendor: "anthropic",
592
+ rawNames: ["Anthropic/Cowork"]
593
+ },
594
+ {
595
+ id: "claude_toolbox",
596
+ label: "Claude Toolbox",
597
+ vendor: "anthropic",
598
+ rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
599
+ },
600
+ {
601
+ id: "anthropic_api",
602
+ label: "Anthropic API",
603
+ vendor: "anthropic",
604
+ rawNames: ["Anthropic/API"]
605
+ },
606
+ {
607
+ id: "anthropic_connector_refresh",
608
+ label: "Anthropic (connector refresh)",
609
+ vendor: "anthropic",
610
+ rawNames: ["Anthropic"]
611
+ },
612
+ {
613
+ id: "codex",
614
+ label: "Codex",
615
+ vendor: "openai",
616
+ rawNames: [
617
+ "codex-mcp-client",
618
+ "codex",
619
+ "Codex",
620
+ "codex-cli",
621
+ "openai-mcp (Codex)"
622
+ ]
623
+ },
624
+ {
625
+ id: "chatgpt",
626
+ label: "ChatGPT",
627
+ vendor: "openai",
628
+ rawNames: ["openai-mcp (ChatGPT)"]
629
+ },
630
+ {
631
+ id: "openai_responses_api",
632
+ label: "OpenAI Responses API",
633
+ vendor: "openai",
634
+ rawNames: ["openai-mcp (Responses API)"]
635
+ },
636
+ {
637
+ id: "openai_agent_builder",
638
+ label: "OpenAI Agent Builder",
639
+ vendor: "openai",
640
+ rawNames: ["openai-mcp (Agent Builder)"]
641
+ },
642
+ {
643
+ id: "openai_other",
644
+ label: "OpenAI Other",
645
+ vendor: "openai",
646
+ rawNames: ["openai-mcp"]
647
+ },
648
+ {
649
+ id: "cursor",
650
+ label: "Cursor",
651
+ vendor: "cursor",
652
+ rawNames: [
653
+ "cursor-vscode",
654
+ "Cursor",
655
+ "cursor"
656
+ ]
657
+ },
658
+ {
659
+ id: "cline",
660
+ label: "Cline",
661
+ vendor: "cline",
662
+ rawNames: [
663
+ "Cline",
664
+ "cline",
665
+ "@cline/core"
666
+ ]
667
+ },
668
+ {
669
+ id: "github_copilot",
670
+ label: "GitHub Copilot",
671
+ vendor: "githubCopilot",
672
+ rawNames: [
673
+ "Copilot",
674
+ "github-copilot-developer",
675
+ "Copilot MCP Gateway",
676
+ "Xcode/copilot-xcode"
677
+ ]
678
+ },
679
+ {
680
+ id: "gemini_cli",
681
+ label: "Gemini CLI",
682
+ vendor: "google",
683
+ rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
684
+ },
685
+ {
686
+ id: "antigravity",
687
+ label: "Antigravity",
688
+ vendor: "google",
689
+ rawNames: ["antigravity-client"]
690
+ },
691
+ {
692
+ id: "gemini",
693
+ label: "Gemini",
694
+ vendor: "google",
695
+ rawNames: ["Gemini", "google-ai-edge-gallery"]
696
+ },
697
+ {
698
+ id: "windsurf",
699
+ label: "Windsurf",
700
+ vendor: "windsurf",
701
+ rawNames: ["Windsurf", "windsurf-client"]
702
+ },
703
+ {
704
+ id: "mistral",
705
+ label: "Mistral / Le Chat",
706
+ vendor: "mistral",
707
+ rawNames: ["Mistral"],
708
+ rawNamePrefixes: ["connector:custom-mcp:"]
709
+ },
710
+ {
711
+ id: "n8n",
712
+ label: "n8n",
713
+ vendor: "n8n",
714
+ rawNames: [
715
+ "@n8n/n8n-nodes-langchain.mcpClient",
716
+ "@n8n/n8n-nodes-langchain.mcpClientTool",
717
+ "n8n"
718
+ ]
719
+ },
720
+ {
721
+ id: "alpic_playground",
722
+ label: "Alpic Playground",
723
+ vendor: "alpic",
724
+ rawNames: ["alpic-playground", "playground"]
725
+ },
726
+ {
727
+ id: "opencode",
728
+ label: "opencode",
729
+ vendor: "opencode",
730
+ rawNames: ["opencode"]
731
+ },
732
+ {
733
+ id: "zed",
734
+ label: "Zed",
735
+ vendor: "zed",
736
+ rawNames: ["Zed", "zed"]
737
+ },
738
+ {
739
+ id: "zapier",
740
+ label: "Zapier",
741
+ vendor: "zapier",
742
+ rawNames: ["Zapier", "zapier"]
743
+ },
744
+ {
745
+ id: "make",
746
+ label: "Make",
747
+ vendor: "make",
748
+ rawNames: ["Make", "make"]
749
+ },
750
+ {
751
+ id: "librechat",
752
+ label: "LibreChat",
753
+ vendor: "mcp",
754
+ rawNames: ["LibreChat", "librechat"]
755
+ },
756
+ {
757
+ id: "jan",
758
+ label: "Jan",
759
+ vendor: "mcp",
760
+ rawNames: ["Jan", "jan"]
761
+ },
762
+ {
763
+ id: "goose",
764
+ label: "goose",
765
+ vendor: "mcp",
766
+ rawNames: ["goose", "Goose"]
767
+ },
768
+ {
769
+ id: "mcphost",
770
+ label: "mcphost",
771
+ vendor: "mcp",
772
+ rawNames: ["mcphost"]
773
+ },
774
+ {
775
+ id: "mcporter",
776
+ label: "mcporter",
777
+ vendor: "mcp",
778
+ rawNames: ["mcporter"]
779
+ },
780
+ {
781
+ id: "rmcp",
782
+ label: "rmcp",
783
+ vendor: "mcp",
784
+ rawNames: ["rmcp"]
785
+ },
786
+ {
787
+ id: "unnamed_client",
788
+ label: "Unnamed client",
789
+ vendor: "mcp",
790
+ rawNames: [
791
+ "mcp",
792
+ "unknown",
793
+ ""
794
+ ]
795
+ }
796
+ ];
797
+ /** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
798
+ const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
799
+ new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
800
+ new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
234
801
  const runtimeSchema = z.enum([
235
802
  "python3.13",
236
803
  "python3.14",
@@ -259,15 +826,27 @@ z.object({
259
826
  environments: z.array(environmentWithDomainsSchema),
260
827
  productionEnvironment: environmentWithDomainsSchema.nullable()
261
828
  });
829
+ const domainFailureReasonSchema = z.enum([
830
+ "caa",
831
+ "dns",
832
+ "invalid_domain",
833
+ "other"
834
+ ]);
835
+ const projectDomainMappingSchema = z.object({
836
+ pathPrefix: z.string(),
837
+ environment: environmentSchema$1
838
+ });
262
839
  z.object({
263
- domain: z.string(),
840
+ name: z.string(),
264
841
  createdAt: z.coerce.date(),
265
842
  status: z.enum([
266
843
  "ongoing",
267
844
  "deployed",
268
845
  "failed"
269
846
  ]),
270
- environment: environmentSchema$1
847
+ failureReason: domainFailureReasonSchema.nullable(),
848
+ environment: environmentSchema$1,
849
+ mappings: z.array(projectDomainMappingSchema)
271
850
  });
272
851
  const serverFieldsSchema$1 = z.object({
273
852
  $schema: z.string(),
@@ -296,11 +875,17 @@ z.object({
296
875
  serverFields: serverFieldsSchema$1,
297
876
  source: z.enum(["registry", "defaults"])
298
877
  });
878
+ /** 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. */
299
879
  const clampStringField = (field) => {
300
880
  const max = field.maxLength;
301
881
  if (max === null) return field;
302
882
  const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
303
- return field.description ? clamped.describe(field.description) : clamped;
883
+ const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
884
+ return field.description ? withMin.describe(field.description) : withMin;
885
+ };
886
+ const unboundedArrayField = (field) => {
887
+ const unbounded = z.array(field.element);
888
+ return field.description ? unbounded.describe(field.description) : unbounded;
304
889
  };
305
890
  const toolDefinitionSchema = z.object({
306
891
  name: z.string(),
@@ -314,17 +899,31 @@ const toolDefinitionSchema = z.object({
314
899
  }).optional()
315
900
  });
316
901
  const positiveTestCaseSchema = z.object({
317
- scenario: z.string(),
318
- userPrompt: z.string(),
319
- toolTriggered: z.string().optional(),
320
- expectedOutput: z.string().optional()
321
- }).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
902
+ scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
903
+ userPrompt: z.string().min(1).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."),
904
+ toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
905
+ expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
906
+ }).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
907
+ const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
908
+ scenario: z.string().optional(),
909
+ userPrompt: z.string().optional()
910
+ });
911
+ const blankPositiveTestCase = () => ({
912
+ scenario: "",
913
+ userPrompt: "",
914
+ toolTriggered: "",
915
+ expectedOutput: ""
916
+ });
917
+ const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
322
918
  const screenshotEntrySchema = z.object({
323
919
  prompt: z.string(),
324
- url: z.url().or(z.literal(""))
920
+ url: z.url()
325
921
  }).describe("Each screenshot: the user prompt that produced it + the image URL.");
922
+ const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
326
923
  /** Accepts either a valid email or URL. */
327
924
  const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
925
+ /** A URL field whose error spells out that the scheme is required. */
926
+ const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
328
927
  const chatgptCategorySchema = z.enum([
329
928
  "BUSINESS",
330
929
  "COLLABORATION",
@@ -341,68 +940,387 @@ const chatgptCategorySchema = z.enum([
341
940
  "TRAVEL"
342
941
  ]);
343
942
  const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
344
- const chatgptAllowedCountriesSchema = z.enum(["Allow all", "Restrict to specific countries"]);
943
+ const chatgptCountryCodeSchema = z.enum([
944
+ "AD",
945
+ "AE",
946
+ "AF",
947
+ "AG",
948
+ "AL",
949
+ "AM",
950
+ "AO",
951
+ "AR",
952
+ "AT",
953
+ "AU",
954
+ "AW",
955
+ "AX",
956
+ "AZ",
957
+ "BA",
958
+ "BB",
959
+ "BD",
960
+ "BE",
961
+ "BF",
962
+ "BG",
963
+ "BH",
964
+ "BI",
965
+ "BJ",
966
+ "BL",
967
+ "BM",
968
+ "BN",
969
+ "BO",
970
+ "BR",
971
+ "BS",
972
+ "BT",
973
+ "BW",
974
+ "BZ",
975
+ "CA",
976
+ "CD",
977
+ "CF",
978
+ "CG",
979
+ "CH",
980
+ "CI",
981
+ "CL",
982
+ "CM",
983
+ "CO",
984
+ "CR",
985
+ "CV",
986
+ "CY",
987
+ "CZ",
988
+ "DE",
989
+ "DJ",
990
+ "DK",
991
+ "DM",
992
+ "DO",
993
+ "DZ",
994
+ "EC",
995
+ "EE",
996
+ "EG",
997
+ "ER",
998
+ "ES",
999
+ "ET",
1000
+ "FI",
1001
+ "FJ",
1002
+ "FM",
1003
+ "FO",
1004
+ "FR",
1005
+ "GA",
1006
+ "GB",
1007
+ "GD",
1008
+ "GE",
1009
+ "GF",
1010
+ "GH",
1011
+ "GL",
1012
+ "GM",
1013
+ "GN",
1014
+ "GP",
1015
+ "GQ",
1016
+ "GR",
1017
+ "GT",
1018
+ "GW",
1019
+ "GY",
1020
+ "HN",
1021
+ "HR",
1022
+ "HT",
1023
+ "HU",
1024
+ "ID",
1025
+ "IE",
1026
+ "IL",
1027
+ "IN",
1028
+ "IQ",
1029
+ "IS",
1030
+ "IT",
1031
+ "JM",
1032
+ "JO",
1033
+ "JP",
1034
+ "KE",
1035
+ "KG",
1036
+ "KH",
1037
+ "KI",
1038
+ "KM",
1039
+ "KN",
1040
+ "KR",
1041
+ "KW",
1042
+ "KY",
1043
+ "KZ",
1044
+ "LA",
1045
+ "LB",
1046
+ "LC",
1047
+ "LI",
1048
+ "LK",
1049
+ "LR",
1050
+ "LS",
1051
+ "LT",
1052
+ "LU",
1053
+ "LV",
1054
+ "LY",
1055
+ "MA",
1056
+ "MC",
1057
+ "MD",
1058
+ "ME",
1059
+ "MF",
1060
+ "MG",
1061
+ "MH",
1062
+ "MK",
1063
+ "ML",
1064
+ "MM",
1065
+ "MN",
1066
+ "MQ",
1067
+ "MR",
1068
+ "MT",
1069
+ "MU",
1070
+ "MV",
1071
+ "MW",
1072
+ "MX",
1073
+ "MY",
1074
+ "MZ",
1075
+ "NA",
1076
+ "NC",
1077
+ "NE",
1078
+ "NG",
1079
+ "NI",
1080
+ "NL",
1081
+ "NO",
1082
+ "NP",
1083
+ "NR",
1084
+ "NZ",
1085
+ "OM",
1086
+ "PA",
1087
+ "PE",
1088
+ "PF",
1089
+ "PG",
1090
+ "PH",
1091
+ "PK",
1092
+ "PL",
1093
+ "PM",
1094
+ "PS",
1095
+ "PT",
1096
+ "PW",
1097
+ "PY",
1098
+ "QA",
1099
+ "RE",
1100
+ "RO",
1101
+ "RS",
1102
+ "RW",
1103
+ "SA",
1104
+ "SB",
1105
+ "SC",
1106
+ "SD",
1107
+ "SE",
1108
+ "SG",
1109
+ "SH",
1110
+ "SI",
1111
+ "SJ",
1112
+ "SK",
1113
+ "SL",
1114
+ "SM",
1115
+ "SN",
1116
+ "SO",
1117
+ "SR",
1118
+ "SS",
1119
+ "ST",
1120
+ "SV",
1121
+ "SZ",
1122
+ "TD",
1123
+ "TF",
1124
+ "TG",
1125
+ "TH",
1126
+ "TJ",
1127
+ "TL",
1128
+ "TM",
1129
+ "TN",
1130
+ "TO",
1131
+ "TR",
1132
+ "TT",
1133
+ "TV",
1134
+ "TW",
1135
+ "TZ",
1136
+ "UA",
1137
+ "UG",
1138
+ "US",
1139
+ "UY",
1140
+ "UZ",
1141
+ "VA",
1142
+ "VC",
1143
+ "VN",
1144
+ "VU",
1145
+ "WF",
1146
+ "WS",
1147
+ "YE",
1148
+ "YT",
1149
+ "ZA",
1150
+ "ZM",
1151
+ "ZW"
1152
+ ]);
1153
+ const chatgptAllowedCountriesSchema = z.discriminatedUnion("mode", [
1154
+ z.object({ mode: z.literal("all") }),
1155
+ z.object({
1156
+ mode: z.literal("allow"),
1157
+ countries: z.array(chatgptCountryCodeSchema)
1158
+ }),
1159
+ z.object({
1160
+ mode: z.literal("block"),
1161
+ countries: z.array(chatgptCountryCodeSchema)
1162
+ })
1163
+ ]);
1164
+ const chatgptTranslationLocaleSchema = z.enum([
1165
+ "am",
1166
+ "ar",
1167
+ "bg-BG",
1168
+ "bn-BD",
1169
+ "bs-BA",
1170
+ "ca-ES",
1171
+ "cs-CZ",
1172
+ "da-DK",
1173
+ "de-DE",
1174
+ "el-GR",
1175
+ "es-419",
1176
+ "es-ES",
1177
+ "et-EE",
1178
+ "fi-FI",
1179
+ "fr-CA",
1180
+ "fr-FR",
1181
+ "gu-IN",
1182
+ "hi-IN",
1183
+ "hr-HR",
1184
+ "hu-HU",
1185
+ "hy-AM",
1186
+ "id-ID",
1187
+ "is-IS",
1188
+ "it-IT",
1189
+ "ja-JP",
1190
+ "ka-GE",
1191
+ "kk",
1192
+ "kn-IN",
1193
+ "ko-KR",
1194
+ "lt",
1195
+ "lv-LV",
1196
+ "mk-MK",
1197
+ "ml",
1198
+ "mn",
1199
+ "mr-IN",
1200
+ "ms-MY",
1201
+ "my-MM",
1202
+ "nb-NO",
1203
+ "nl-NL",
1204
+ "pa",
1205
+ "pl-PL",
1206
+ "pt-BR",
1207
+ "pt-PT",
1208
+ "ro-RO",
1209
+ "ru-RU",
1210
+ "sk-SK",
1211
+ "sl-SI",
1212
+ "so-SO",
1213
+ "sq-AL",
1214
+ "sr-RS",
1215
+ "sv-SE",
1216
+ "sw-TZ",
1217
+ "ta-IN",
1218
+ "te-IN",
1219
+ "th-TH",
1220
+ "tl",
1221
+ "tr-TR",
1222
+ "uk-UA",
1223
+ "ur",
1224
+ "vi-VN",
1225
+ "zh-CN",
1226
+ "zh-HK",
1227
+ "zh-TW"
1228
+ ]);
345
1229
  const negativeTestCaseSchema = z.object({
346
- scenario: z.string(),
347
- userPrompt: z.string()
348
- }).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
1230
+ scenario: z.string().min(1),
1231
+ userPrompt: z.string().min(1)
1232
+ }).describe("Each case: Scenario + User prompt (the plugin should NOT trigger).");
1233
+ const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
1234
+ scenario: z.string().optional(),
1235
+ userPrompt: z.string().optional()
1236
+ });
1237
+ const blankNegativeTestCase = () => ({
1238
+ scenario: "",
1239
+ userPrompt: ""
1240
+ });
1241
+ const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
349
1242
  const chatgptToolJustificationSchema = z.object({
350
1243
  toolName: z.string(),
351
- readOnlyJustification: z.string(),
352
- openWorldJustification: z.string(),
353
- destructiveJustification: z.string()
354
- }).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
1244
+ readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
1245
+ openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
1246
+ 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.\"")
1247
+ }).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
1248
+ /** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
1249
+ const chatgptTaglineSchema = z.string().max(30);
1250
+ const chatgptDescriptionSchema = z.string();
355
1251
  const chatgptTranslationSchema = z.object({
356
- locale: z.string(),
357
- tagline: z.string().optional(),
358
- description: z.string().optional()
1252
+ locale: chatgptTranslationLocaleSchema,
1253
+ tagline: chatgptTaglineSchema,
1254
+ description: chatgptDescriptionSchema
359
1255
  }).describe("Locale-scoped override for tagline + description. English (US) is the default.");
360
- /**
361
- * Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
362
- * When adding/removing/reordering fields, keep this in sync with the sheet.
363
- */
1256
+ chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
1257
+ /** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
364
1258
  const chatgptSubmissionFormDataSchema = z.object({
365
1259
  logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
366
1260
  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."),
367
- appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
368
- tagline: z.string().max(30).describe("Plain-language phrase focused on function and user value. 30 chars max."),
369
- description: z.string().describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
1261
+ appName: z.string().describe("The name users will see in ChatGPT and in the Plugin Directory."),
1262
+ tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
1263
+ description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the plugin does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the plugin 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)."),
370
1264
  category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
371
- developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
372
- companyUrl: z.url().describe("Your company's main website URL."),
1265
+ developerName: z.string().describe("Developer name shown publicly on the plugin's directory page."),
1266
+ companyUrl: urlField.describe("Your company's main website URL."),
373
1267
  supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
374
- privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
375
- termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
376
- 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."),
377
- 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."),
378
- serverUrl: z.url().describe("URL of the MCP server."),
1268
+ privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
1269
+ termsOfServiceUrl: urlField.describe("URL to the plugin's terms of service."),
1270
+ demoRecordingUrl: urlField.describe("URL to a video demonstrating the plugin, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
1271
+ appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My plugin links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the plugin does not offer digital goods."),
1272
+ serverUrl: urlField.describe("URL of the MCP server."),
379
1273
  authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
380
1274
  tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
381
- toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
382
- 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."),
383
- negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
384
- 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."),
1275
+ 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."),
1276
+ skills: z.array(chatgptSkillSchema).optional().describe("Skills the server exposes over MCP (auto-populated from the production server's manifest). Left unset when the server does not advertise the skills extension, which is a different state from advertising it and exposing none."),
1277
+ testCases: z.array(positiveTestCaseSchema).length(5).describe("Exactly 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."),
1278
+ negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the plugin 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 plugin does not carry, the right brand or domain but an intent the plugin does not serve, or a boundary with a sibling plugin."),
1279
+ screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-plugin screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget plugins must show the widget UI; non-widget plugins show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
385
1280
  translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
386
- allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
387
- releaseNotes: z.string().describe("Publicly displayed on the app details page.")
1281
+ allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
1282
+ releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
388
1283
  });
389
- chatgptSubmissionFormDataSchema.pick({
1284
+ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
1285
+ tagline: z.string().optional(),
1286
+ companyUrl: z.string().optional(),
1287
+ supportChannel: z.string().optional(),
1288
+ privacyPolicyUrl: z.string().optional(),
1289
+ termsOfServiceUrl: z.string().optional(),
1290
+ demoRecordingUrl: z.string().optional(),
1291
+ serverUrl: z.string().optional(),
1292
+ screenshots: z.array(screenshotDraftEntrySchema).optional(),
1293
+ testCases: z.array(positiveTestCaseDraftSchema).optional(),
1294
+ negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
1295
+ translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
1296
+ });
1297
+ /** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
1298
+ const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
390
1299
  appName: true,
391
1300
  developerName: true,
392
1301
  serverUrl: true,
393
1302
  tools: true,
1303
+ skills: true,
394
1304
  authentication: true
395
1305
  });
396
- chatgptSubmissionFormDataSchema.pick({
1306
+ /** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
1307
+ const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
397
1308
  tagline: true,
398
1309
  description: true,
399
1310
  category: true,
400
1311
  testCases: true,
401
1312
  negativeTestCases: true,
402
1313
  toolJustifications: true
403
- }).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
1314
+ }).extend({
1315
+ testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
1316
+ negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
1317
+ }).extend({
1318
+ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
1319
+ testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
1320
+ negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
1321
+ });
404
1322
  const claudeCategorySchema = z.enum([
405
- "Business & Productivity",
1323
+ "Productivity",
406
1324
  "Communication",
407
1325
  "Data & Analytics",
408
1326
  "Development tools",
@@ -410,221 +1328,222 @@ const claudeCategorySchema = z.enum([
410
1328
  "Consumer Health",
411
1329
  "Health & Life Sciences",
412
1330
  "Media & Entertainment",
413
- "Commerce & Shopping"
414
- ]);
415
- const claudeAuthenticationSchema = z.enum([
416
- "No auth needed",
417
- "OAuth 2.0",
418
- "Custom URL"
1331
+ "Commerce & Shopping",
1332
+ "Legal",
1333
+ "Sales and marketing",
1334
+ "Creative",
1335
+ "Nonprofit",
1336
+ "Education",
1337
+ "Other"
419
1338
  ]);
420
- const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
421
- z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
1339
+ const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
422
1340
  const claudeReadWriteCapabilitiesSchema = z.enum([
423
- "Read Only",
424
- "Write Only",
425
- "Read + Write"
1341
+ "read_only",
1342
+ "write_only",
1343
+ "read_write"
426
1344
  ]);
427
- const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
428
- const claudeTestedSurfaceSchema = z.enum([
429
- "Claude.ai (web)",
430
- "Claude Desktop",
431
- "Claude Code",
432
- "Cowork"
433
- ]);
434
- const claudeThirdPartySchema = z.enum([
435
- "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)",
436
- "Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
437
- "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)",
438
- "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)",
439
- "N/A"
1345
+ const claudeAuthenticationSchema = z.enum([
1346
+ "oauth_dcr",
1347
+ "oauth_cimd",
1348
+ "oauth_anthropic_creds",
1349
+ "custom_connection",
1350
+ "none"
440
1351
  ]);
441
- const claudeDataHandlingSchema = z.enum([
442
- "Server only accesses data explicitly requested by user",
443
- "No data is stored beyond session requirements",
444
- "Data transmission is encrypted (HTTPS/TLS)",
445
- "GDPR compliant (if applicable)"
1352
+ const claudeApiOwnershipSchema = z.enum([
1353
+ "first_party",
1354
+ "proxied",
1355
+ "third_party"
446
1356
  ]);
447
- const claudeSponsoredContentSchema = z.enum([
448
- "No, there is no sponsored content or advertisements",
449
- "Yes, there are banner ads or other paid visual elements",
450
- "Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement"
1357
+ const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
1358
+ const claudePolicyAcknowledgementSchema = z.enum([
1359
+ "I have read and understand the MCP Directory developer guidelines.",
1360
+ "My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
1361
+ "My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
1362
+ "My connector does not use AI models to generate images, video, or audio.",
1363
+ "Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
1364
+ "My connector does not collect conversation data beyond what is needed for its function.",
1365
+ "Public documentation for this connector will be live by the publish date."
451
1366
  ]);
452
- /**
453
- * Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
454
- * When adding/removing/reordering fields, keep this in sync with the sheet.
455
- */
1367
+ /** 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. */
456
1368
  const claudeSubmissionFormDataSchema = z.object({
457
- 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."),
458
- 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."),
459
- 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."),
460
- 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."),
461
- 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."),
462
- 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."),
463
- appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
464
-
465
- Rules:
466
- (1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
467
- (2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
468
- (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.`),
469
- mcpUrlType: claudeMcpUrlTypeSchema.describe(`Choose how your server URL works:
470
- • 'Universal URL': one single URL that all users connect to (most common). Example: https://mcp.myapp.com
471
- • 'Custom MCP URLs': each user gets their own unique URL (e.g. based on their workspace or instance).
472
- 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.`),
473
- 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/
474
- 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.`),
475
- 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.
476
- 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...'`),
477
- 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.`),
478
- 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.
479
- Best format: [Use case]: [exact prompt]"
480
- Example for a task manager:
481
- 1. Create a task: 'Create a task called Review Q3 report, due Friday, assigned to Alice'
482
- 2. Search tasks: 'Show me all open bugs in the Mobile project'
483
- 3. Update status: 'Mark the Deploy v2.1 task as done'"`),
484
- connectionRequirements: z.string().describe(`Describe any prerequisites a user must have before they can connect your server. Be exhaustive. Examples of things to mention:
485
- • Account type required (free vs paid plan)
486
- • Admin permissions or specific roles needed
487
- • Geographic restrictions (e.g. 'US only' or 'Not available in EU')
488
- • If users need to provide their own server URL or instance domain
489
- • Any setup steps needed before connecting (e.g. 'Enable API access in your account settings')
490
- If there are genuinely no special requirements, write exactly: 'No special requirements.'`),
491
- readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`Select the option that best describes what your server can do:
492
-
493
- 'Read Only': your tools only fetch/retrieve data (GET operations). Claude cannot modify anything via your server.
494
- 'Write Only': your tools only create/update/delete data (rare).
495
- 'Read + Write': your tools can both retrieve AND modify data (most common for full-featured connectors).
496
-
497
- 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. `),
498
- isMcpApp: z.boolean().describe(`Select 'Yes' if your MCP server renders interactive UI elements (aka widgets or views) inside the Claude conversation.
499
- Select 'No' if your server only returns text/data responses.
500
- 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.`),
501
- thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe(`Multi-select all that apply to your server's behavior:
502
- • 'Web access' — your server fetches arbitrary URLs, scrapes websites, or makes open-ended HTTP requests to the web (not just your own API).
503
- • 'Third-party AI model integration' — your server calls another AI model (e.g. OpenAI, Gemini, Cohere) as part of its processing.
504
- • '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.
505
- • 'Third-party data modification' — your server modifies data via such a platform.
506
- • 'N/A' — your server only calls your own first-party API and does nothing else. Select this only if none of the above apply.`),
507
- 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:
508
- • 'Server only accesses data explicitly requested by user' — your server doesn't silently read unrelated user data.
509
- • 'No data is stored beyond session requirements' — you don't log or retain conversation data after the session.
510
- • 'Data transmission is encrypted (HTTPS/TLS)' — all data in transit is encrypted. This should always apply for remote servers.
511
- • '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.
512
- Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
513
- 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.
514
- Select 'No' for the vast majority of business/productivity/dev tools. When in doubt, select 'No'. This field triggers additional compliance review if 'Yes'.`),
515
- 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:
516
- • Business & Productivity — project management, CRM, HR, office tools
517
- • Communication — email, chat, messaging, notifications
518
- • Data & Analytics — dashboards, reporting, databases, BI tools
519
- • Development tools — code repositories, CI/CD, issue trackers, monitoring
520
- • Financial Services — accounting, invoicing, fintech (note: financial transaction execution is not permitted)
521
- • Consumer Health — fitness, wellness, personal health tracking
522
- • Health & Life Sciences — clinical, pharma, medical professional tools
523
- • Media & Entertainment — content, publishing, streaming
524
- • Commerce & Shopping — e-commerce, inventory, orders
525
- Anthropic's submission form only accepts a single category.`),
526
- 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:
527
- • '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.
528
- • '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.
529
- • '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.
530
- 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'.`),
531
- authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
532
- transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
533
- • 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
534
- • '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.
535
- If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
536
- 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:
537
- • What the connector does and its key capabilities
538
- • How to connect/set it up (step by step)
539
- • What each tool does (or at least the main ones)
540
- • How to troubleshoot common issues
541
- • A support contact or channel
542
- 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.`),
543
- 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:
544
- • What data you collect (and how)
545
- • How you use the collected data
546
- • Where and how long you store it
547
- • Whether you share data with third parties (and who)
548
- • How users can contact you about data concerns
549
- 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.`),
550
- 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:
551
- • Email address (e.g. support@myapp.com)
552
- • Link to a GitHub Issues page
553
- • Link to a help center or support article
554
- • Link to a Discord/Slack community
555
- • Link to your documentation's troubleshooting section
556
- Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
557
- 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:
558
- • The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
559
- • No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
560
- • 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.
561
- • Credentials must remain valid for at least 30 days from submission.
562
- • If your service requires API keys instead of a password, provide those.
563
- Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
564
- 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.
565
- Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
566
- 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.`),
567
- toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
568
- • 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
569
- • '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).
570
- 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.`),
571
- 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.`),
572
- logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
573
- • Format: SVG only
574
- • Aspect ratio: square (1:1)
575
- • Should work on a light background
576
- • Provide via URL (Google Drive link is fine) or upload directly
577
- Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
578
- 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.`),
579
- 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:
580
- • 3–5 images is ideal
581
- • Minimum 1000px width, PNG format preferred
582
- • Each screenshot is paired with the user prompt that produced it
583
- • Crop to just the relevant part of the Claude interface (the tool response area)
584
- • Show your connector doing something impressive and useful — real data, real results
585
- • If you're an MCP App, include screenshots of your interactive UI elements
586
- These images appear in your directory listing and are a key factor in driving user installs.`)
587
- });
588
- claudeSubmissionFormDataSchema.pick({
589
- companyName: true,
590
- appName: true,
591
- mcpUrlType: true,
1369
+ 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
1370
+ from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
1371
+ The server must be publicly accessible without VPN or whitelisting.`),
1372
+ 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
1373
+ own or have the right to use this name. Max 100 characters.`),
1374
+ 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.
1375
+ PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
1376
+ oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
1377
+ phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
1378
+ 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
1379
+ claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
1380
+ categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
1381
+ 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
1382
+ (recommended); upload a custom icon only to override it.`),
1383
+ documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
1384
+ accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
1385
+ by your publish date.`),
1386
+ support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
1387
+ used to notify you of security or compliance issues, so make sure it's actively monitored.`),
1388
+ privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
1389
+ what data you collect, how you use and store it, and whether you share it with third parties.`),
1390
+ 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
1391
+ it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
1392
+ primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
1393
+ type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
1394
+ connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
1395
+ permissions'). If there are genuinely no special requirements, say so explicitly.`),
1396
+ readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
1397
+ • 'read_only': retrieves data but never modifies it.
1398
+ • 'write_only': creates or modifies data but does not read it.
1399
+ • 'read_write': both retrieves and modifies data (most common).`),
1400
+ companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
1401
+ companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
1402
+ primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
1403
+ primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
1404
+ primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
1405
+ anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
1406
+ authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
1407
+ • 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
1408
+ • 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
1409
+ • 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
1410
+ • 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
1411
+ • 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
1412
+ partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
1413
+ apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
1414
+ • 'first_party': the MCP server calls your own production APIs.
1415
+ • 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
1416
+ • 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
1417
+ personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
1418
+ No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
1419
+ sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
1420
+ No → false, Yes → true, or { other: explanation }.`),
1421
+ testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
1422
+ the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
1423
+ fully populated account.`),
1424
+ selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
1425
+ policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
1426
+ submission. Each is an attestation you are legally agreeing to by submitting.`),
1427
+ additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
1428
+ });
1429
+ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
1430
+ serverUrl: z.string().optional(),
1431
+ name: z.string().optional(),
1432
+ slug: z.string().optional(),
1433
+ oneLiner: z.string().optional(),
1434
+ description: z.string().optional(),
1435
+ iconUrl: z.string().optional(),
1436
+ documentation: z.string().optional(),
1437
+ support: z.string().optional(),
1438
+ privacyPolicy: z.string().optional(),
1439
+ companyWebsite: z.string().optional(),
1440
+ primaryContactEmail: z.string().optional(),
1441
+ categories: z.array(claudeCategorySchema).optional(),
1442
+ screenshots: z.array(screenshotDraftEntrySchema).optional()
1443
+ });
1444
+ /** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
1445
+ const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
592
1446
  serverUrl: true,
593
- tools: true,
594
- readWriteCapabilities: true,
595
- isMcpApp: true,
596
- transportSupport: true,
1447
+ name: true,
1448
+ slug: true,
1449
+ companyName: true,
597
1450
  primaryContactEmail: true,
598
1451
  primaryContactName: true,
1452
+ readWriteCapabilities: true,
599
1453
  authentication: true,
600
- personalDataHealthAccess: true,
601
- testedSurfaces: true
1454
+ apiOwnership: true,
1455
+ personalHealthData: true
602
1456
  }).extend({
603
1457
  connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
604
- testingCredentials: claudeSubmissionFormDataSchema.shape.testingCredentials.optional()
1458
+ testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
1459
+ });
1460
+ /** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
1461
+ const claudeAiGeneratedFormDataRawSchema = z.object({
1462
+ oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
1463
+ description: claudeSubmissionFormDataSchema.shape.description,
1464
+ categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
1465
+ primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
1466
+ });
1467
+ const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
1468
+ oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
1469
+ categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
1470
+ });
1471
+ function provenanceByField(prefillShape, aiGeneratedShape) {
1472
+ const byField = {};
1473
+ for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
1474
+ for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
1475
+ return byField;
1476
+ }
1477
+ provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
1478
+ const urlVerificationOutcomeSchema = z.enum([
1479
+ "pass",
1480
+ "fail",
1481
+ "unverified"
1482
+ ]);
1483
+ const VERIFIABLE_URL_FIELDS = {
1484
+ chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
1485
+ claudeai: ["privacyPolicy"]
1486
+ };
1487
+ const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
1488
+ const policyDisclosureSchema = z.enum([
1489
+ "dataCategories",
1490
+ "purposesOfUse",
1491
+ "recipients",
1492
+ "retention"
1493
+ ]);
1494
+ const urlVerificationFieldResultSchema = z.object({
1495
+ field: verifiableUrlFieldSchema,
1496
+ url: z.string(),
1497
+ outcome: urlVerificationOutcomeSchema,
1498
+ reason: z.string(),
1499
+ concerns: z.array(z.string()).optional(),
1500
+ scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
1501
+ });
1502
+ const urlVerificationSchema = z.object({
1503
+ verifiedAt: z.coerce.date(),
1504
+ results: z.array(urlVerificationFieldResultSchema)
1505
+ });
1506
+ const pageKindSchema = z.enum([
1507
+ "expectedDocument",
1508
+ "errorPage",
1509
+ "loginWall",
1510
+ "parkedDomain",
1511
+ "comingSoon",
1512
+ "marketingPage",
1513
+ "unrelatedDocument"
1514
+ ]);
1515
+ z.object({
1516
+ pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
1517
+ reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
1518
+ missingDisclosures: z.array(policyDisclosureSchema).describe("For a privacy policy only: which of the four required disclosures the text does not cover. Empty for every other page kind.")
605
1519
  });
606
- claudeSubmissionFormDataSchema.pick({
607
- tagline: true,
608
- description: true,
609
- category: true,
610
- testCases: true
611
- }).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
612
1520
  const submissionMetaFieldsSchema = z.object({
613
1521
  id: z.string(),
614
1522
  environmentId: z.string(),
1523
+ auditId: z.string().nullable(),
1524
+ urlVerification: urlVerificationSchema.nullable().default(null),
615
1525
  createdAt: z.coerce.date(),
616
1526
  updatedAt: z.coerce.date()
617
1527
  });
618
1528
  const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
619
1529
  platform: z.literal("claudeai"),
620
- formData: claudeSubmissionFormDataSchema.partial()
1530
+ formData: claudeSubmissionDraftSchema,
1531
+ prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
621
1532
  });
622
1533
  const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
623
1534
  platform: z.literal("chatgpt"),
624
- formData: chatgptSubmissionFormDataSchema.partial()
1535
+ formData: chatgptSubmissionDraftSchema,
1536
+ prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
625
1537
  });
626
- z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
627
- z.union([claudeSubmissionFormDataSchema.partial(), chatgptSubmissionFormDataSchema.partial()]);
1538
+ const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
1539
+ z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
1540
+ /** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
1541
+ const submissionSchema = submissionSchemaInternal;
1542
+ z.literal([
1543
+ 100,
1544
+ 75,
1545
+ 50
1546
+ ]);
628
1547
  const subscriptionPlanSchema = z.enum([
629
1548
  "pro",
630
1549
  "business",
@@ -636,17 +1555,83 @@ const customerCreditsSchema = z.object({
636
1555
  expiresAt: z.number().nullable(),
637
1556
  currency: z.string()
638
1557
  });
639
- const customerUsageSchema = z.object({
640
- amountInCents: z.number(),
641
- currency: z.string(),
642
- periodEnd: z.number()
643
- });
644
1558
  const partnerDiscountSchema = z.object({ endsAt: z.number() });
645
1559
  z.object({
646
1560
  customerCredits: customerCreditsSchema.nullable(),
647
- customerUsage: customerUsageSchema.nullable(),
648
1561
  partnerDiscount: partnerDiscountSchema.nullable()
649
1562
  });
1563
+ const metricsQueueEventSchema = z.object({
1564
+ ts: z.number().int(),
1565
+ method: z.string(),
1566
+ tool: z.string().nullable(),
1567
+ client: z.string(),
1568
+ sessionId: z.string().nullable(),
1569
+ durationMs: z.number().int(),
1570
+ outputTokens: z.number().int().nullable(),
1571
+ errorType: z.enum([
1572
+ "mcp_error",
1573
+ "tool_error",
1574
+ "timeout"
1575
+ ]).nullable(),
1576
+ errorCode: z.number().int().nullable()
1577
+ });
1578
+ z.object({
1579
+ v: z.literal(1),
1580
+ envId: z.string(),
1581
+ events: z.array(metricsQueueEventSchema)
1582
+ });
1583
+ z.object({ v: z.number() });
1584
+ const TELEMETRY_SIGNALS = [
1585
+ "logs",
1586
+ "metrics",
1587
+ "traces"
1588
+ ];
1589
+ const telemetrySignalSchema = z.enum(TELEMETRY_SIGNALS);
1590
+ const OTLP_PROTOCOLS = ["http/protobuf", "http/json"];
1591
+ const otlpProtocolSchema = z.enum(OTLP_PROTOCOLS);
1592
+ const otlpEndpointSchema = z.string().trim().min(1).max(2048);
1593
+ const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
1594
+ const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
1595
+ 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");
1596
+ const telemetryDestinationHeaderSchema = z.object({
1597
+ id: z.string(),
1598
+ name: otlpHeaderNameSchema,
1599
+ value: otlpHeaderValueSchema,
1600
+ isSecret: z.boolean()
1601
+ });
1602
+ const otlpPushFailureReasonSchema = z.enum([
1603
+ "credentials",
1604
+ "wrong-path",
1605
+ "wrong-protocol",
1606
+ "invalid-payload",
1607
+ "partial-rejection",
1608
+ "blocked-target",
1609
+ "timeout",
1610
+ "unreachable",
1611
+ "receiver-error",
1612
+ "unexpected-status"
1613
+ ]);
1614
+ const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
1615
+ z.object({
1616
+ id: z.string(),
1617
+ signal: telemetrySignalSchema,
1618
+ endpoint: otlpEndpointSchema,
1619
+ protocol: otlpProtocolSchema,
1620
+ headers: z.array(telemetryDestinationHeaderSchema),
1621
+ status: telemetryDestinationStatusSchema,
1622
+ lastFailureReason: otlpPushFailureReasonSchema.nullable(),
1623
+ isScopedToIntentionalRequestsOnly: z.boolean()
1624
+ });
1625
+ const hasDuplicateHeaderNames = (headers) => {
1626
+ const names = headers.map(({ name }) => name.trim().toLowerCase());
1627
+ return new Set(names).size !== names.length;
1628
+ };
1629
+ //#endregion
1630
+ //#region src/auth-scope.ts
1631
+ /** Accepts an API key or OAuth access token (default for most routes). */
1632
+ const AUTH_SCOPE_ANY = "any";
1633
+ /** Requires a user OAuth access token; API keys are not accepted. */
1634
+ const AUTH_SCOPE_USER = "user";
650
1635
  //#endregion
651
1636
  //#region src/schemas.ts
652
1637
  const RESERVED_KEYS = [
@@ -683,7 +1668,10 @@ const RESERVED_KEYS = [
683
1668
  "BUILD_ARG_START_COMMAND",
684
1669
  "ALPIC_HOST",
685
1670
  "ALPIC_CUSTOM_DOMAINS",
686
- "ALPIC_INTENT_META_KEY"
1671
+ "ALPIC_INTENT_META_KEY",
1672
+ "ALPIC_FEEDBACK_META_KEY",
1673
+ "ALPIC_EVENTS_META_KEY",
1674
+ "ALPIC_IDENTIFY_META_KEY"
687
1675
  ];
688
1676
  const environmentVariableSchema = z.object({
689
1677
  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"),
@@ -736,6 +1724,14 @@ const serverFieldsSchema = z.object({
736
1724
  });
737
1725
  //#endregion
738
1726
  //#region src/api.contract.ts
1727
+ const isValidIanaTimeZone = (timeZone) => {
1728
+ try {
1729
+ new Intl.DateTimeFormat("en-US", { timeZone });
1730
+ return true;
1731
+ } catch {
1732
+ return false;
1733
+ }
1734
+ };
739
1735
  const deploymentStatusSchema = z.enum([
740
1736
  "ongoing",
741
1737
  "deployed",
@@ -764,21 +1760,20 @@ const deploymentSchema = z.object({
764
1760
  isCurrent: z.boolean(),
765
1761
  deploymentPageUrl: z.url().nullable()
766
1762
  });
767
- const isValidLogTimeInput = (value) => {
1763
+ const isValidTimeInput = (value) => {
768
1764
  if (ms(value) !== void 0) return true;
769
1765
  return !Number.isNaN(new Date(value).getTime());
770
1766
  };
771
- const createEnvironmentContractV1 = oc.route({
1767
+ const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
1768
+ const base = oc.errors({ BAD_REQUEST: {} });
1769
+ const createEnvironmentContractV1 = base.route({
772
1770
  path: "/v1/environments",
773
1771
  method: "POST",
774
1772
  summary: "Create an environment",
775
1773
  description: "Create an environment for a project",
776
1774
  tags: ["environments"],
777
1775
  successDescription: "The environment has been created successfully"
778
- }).errors({
779
- NOT_FOUND: {},
780
- BAD_REQUEST: {}
781
- }).input(z.object({
1776
+ }).errors({ NOT_FOUND: {} }).input(z.object({
782
1777
  projectId: z.string().describe("The ID of the project to create the environment for"),
783
1778
  name: z.string().min(1).describe("The name of the environment"),
784
1779
  sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
@@ -787,11 +1782,11 @@ const createEnvironmentContractV1 = oc.route({
787
1782
  id: z.string(),
788
1783
  name: z.string(),
789
1784
  sourceBranch: z.string().nullable().describe("The branch used to build the environment"),
790
- urls: z.array(z.string().url()).describe("The URLs of the MCP server"),
1785
+ urls: z.array(z.url()).describe("The URLs of the MCP server"),
791
1786
  createdAt: z.coerce.date(),
792
1787
  projectId: z.string().describe("The ID of the project the environment belongs to")
793
1788
  }));
794
- const getEnvironmentContractV1 = oc.route({
1789
+ const getEnvironmentContractV1 = base.route({
795
1790
  path: "/v1/environments/{environmentId}",
796
1791
  method: "GET",
797
1792
  summary: "Get an environment",
@@ -807,6 +1802,14 @@ const getEnvironmentContractV1 = oc.route({
807
1802
  createdAt: z.coerce.date(),
808
1803
  projectId: z.string()
809
1804
  }));
1805
+ const deleteEnvironmentContractV1 = base.route({
1806
+ path: "/v1/environments/{environmentId}",
1807
+ method: "DELETE",
1808
+ summary: "Delete an environment",
1809
+ description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
1810
+ tags: ["environments"],
1811
+ successDescription: "The environment has been deleted successfully"
1812
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
810
1813
  const domainSchema = z.object({
811
1814
  domain: z.string(),
812
1815
  status: z.enum([
@@ -848,7 +1851,7 @@ const projectOutputSchema = z.object({
848
1851
  productionEnvironment: productionEnvironmentSchema.nullable(),
849
1852
  environments: z.array(environmentSchema)
850
1853
  });
851
- const getProjectContractV1 = oc.route({
1854
+ const getProjectContractV1 = base.route({
852
1855
  path: "/v1/projects/{projectId}",
853
1856
  method: "GET",
854
1857
  summary: "Get a project",
@@ -856,15 +1859,15 @@ const getProjectContractV1 = oc.route({
856
1859
  tags: ["projects"],
857
1860
  successDescription: "The project details"
858
1861
  }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
859
- const listProjectsContractV1 = oc.route({
1862
+ const listProjectsContractV1 = base.route({
860
1863
  path: "/v1/projects",
861
1864
  method: "GET",
862
1865
  summary: "List projects",
863
1866
  description: "List all projects for a team",
864
1867
  tags: ["projects"],
865
1868
  successDescription: "The list of projects"
866
- }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
867
- const createProjectContractV1 = oc.route({
1869
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
1870
+ const createProjectContractV1 = base.route({
868
1871
  path: "/v1/projects",
869
1872
  method: "POST",
870
1873
  summary: "Create a project",
@@ -873,7 +1876,7 @@ const createProjectContractV1 = oc.route({
873
1876
  successDescription: "The project has been created successfully"
874
1877
  }).errors({
875
1878
  NOT_FOUND: {},
876
- BAD_REQUEST: {}
1879
+ FORBIDDEN: {}
877
1880
  }).input(z.object({
878
1881
  teamId: z.string().optional(),
879
1882
  name: z.string().trim().min(1).max(100),
@@ -913,7 +1916,101 @@ const environmentVariableOutputSchema = z.object({
913
1916
  isSecret: z.boolean(),
914
1917
  createdAt: z.coerce.date()
915
1918
  });
916
- const listEnvironmentVariablesContractV1 = oc.route({
1919
+ const telemetryDestinationHeaderOutputSchema = z.discriminatedUnion("isSecret", [z.object({
1920
+ id: z.string(),
1921
+ name: otlpHeaderNameSchema,
1922
+ value: z.null(),
1923
+ isSecret: z.literal(true)
1924
+ }), z.object({
1925
+ id: z.string(),
1926
+ name: otlpHeaderNameSchema,
1927
+ value: otlpHeaderValueSchema,
1928
+ isSecret: z.literal(false)
1929
+ })]);
1930
+ const telemetryDestinationOutputSchema = z.object({
1931
+ id: z.string(),
1932
+ signal: telemetrySignalSchema,
1933
+ endpoint: otlpEndpointSchema,
1934
+ protocol: otlpProtocolSchema,
1935
+ headers: z.array(telemetryDestinationHeaderOutputSchema),
1936
+ status: telemetryDestinationStatusSchema,
1937
+ lastFailureReason: otlpPushFailureReasonSchema.nullable(),
1938
+ isScopedToIntentionalRequestsOnly: z.boolean()
1939
+ });
1940
+ const createTelemetryDestinationHeaderInputSchema = z.object({
1941
+ name: otlpHeaderNameSchema,
1942
+ value: otlpHeaderValueSchema.min(1, "Enter a header value"),
1943
+ isSecret: z.boolean()
1944
+ });
1945
+ const updateTelemetryDestinationHeaderInputSchema = z.object({
1946
+ id: z.string().optional(),
1947
+ name: otlpHeaderNameSchema,
1948
+ value: otlpHeaderValueSchema.optional(),
1949
+ isSecret: z.boolean()
1950
+ });
1951
+ const uniqueTelemetryHeaders = (headers) => !hasDuplicateHeaderNames(headers);
1952
+ const listTelemetryDestinationsContractV1 = base.route({
1953
+ path: "/v1/environments/{environmentId}/telemetry-destinations",
1954
+ method: "GET",
1955
+ summary: "List telemetry destinations",
1956
+ description: "List the OTLP destinations configured for an environment. Secret header values are never returned.",
1957
+ tags: ["telemetry"],
1958
+ successDescription: "The list of telemetry destinations"
1959
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(telemetryDestinationOutputSchema));
1960
+ const createTelemetryDestinationContractV1 = base.route({
1961
+ path: "/v1/environments/{environmentId}/telemetry-destinations",
1962
+ method: "POST",
1963
+ summary: "Create a telemetry destination",
1964
+ description: "Verify and save an OTLP destination for logs, metrics, or traces.",
1965
+ tags: ["telemetry"],
1966
+ successDescription: "The telemetry destination has been created"
1967
+ }).errors({
1968
+ NOT_FOUND: {},
1969
+ FORBIDDEN: {},
1970
+ OTLP_DESTINATION_UNVERIFIED: { status: 400 },
1971
+ INTERNAL_SERVER_ERROR: {}
1972
+ }).input(z.object({
1973
+ environmentId: z.string().describe("The ID of the environment"),
1974
+ signal: telemetrySignalSchema,
1975
+ endpoint: otlpEndpointSchema,
1976
+ protocol: otlpProtocolSchema.default("http/protobuf"),
1977
+ isScopedToIntentionalRequestsOnly: z.boolean().default(false),
1978
+ headers: z.array(createTelemetryDestinationHeaderInputSchema).default([]).refine(uniqueTelemetryHeaders, "Header names must be unique")
1979
+ })).output(telemetryDestinationOutputSchema);
1980
+ const updateTelemetryDestinationContractV1 = base.route({
1981
+ path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
1982
+ method: "PATCH",
1983
+ summary: "Update a telemetry destination",
1984
+ description: "Verify and save changes to an OTLP destination. Omit headers to keep them unchanged; omit the value of an existing header to preserve it. A secret header value must be re-entered when the endpoint changes.",
1985
+ tags: ["telemetry"],
1986
+ successDescription: "The telemetry destination has been updated"
1987
+ }).errors({
1988
+ NOT_FOUND: {},
1989
+ FORBIDDEN: {},
1990
+ OTLP_DESTINATION_UNVERIFIED: { status: 400 }
1991
+ }).input(z.object({
1992
+ environmentId: z.string().describe("The ID of the environment"),
1993
+ destinationId: z.string().describe("The ID of the telemetry destination"),
1994
+ endpoint: otlpEndpointSchema.optional(),
1995
+ protocol: otlpProtocolSchema.optional(),
1996
+ isScopedToIntentionalRequestsOnly: z.boolean().optional(),
1997
+ headers: z.array(updateTelemetryDestinationHeaderInputSchema).refine(uniqueTelemetryHeaders, "Header names must be unique").optional()
1998
+ })).output(telemetryDestinationOutputSchema);
1999
+ const deleteTelemetryDestinationContractV1 = base.route({
2000
+ path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
2001
+ method: "DELETE",
2002
+ summary: "Delete a telemetry destination",
2003
+ description: "Delete an OTLP destination from an environment.",
2004
+ tags: ["telemetry"],
2005
+ successDescription: "The telemetry destination has been deleted"
2006
+ }).errors({
2007
+ NOT_FOUND: {},
2008
+ INTERNAL_SERVER_ERROR: {}
2009
+ }).input(z.object({
2010
+ environmentId: z.string().describe("The ID of the environment"),
2011
+ destinationId: z.string().describe("The ID of the telemetry destination")
2012
+ })).output(z.object({ success: z.literal(true) }));
2013
+ const listEnvironmentVariablesContractV1 = base.route({
917
2014
  path: "/v1/environments/{environmentId}/environment-variables",
918
2015
  method: "GET",
919
2016
  summary: "List environment variables",
@@ -921,37 +2018,31 @@ const listEnvironmentVariablesContractV1 = oc.route({
921
2018
  tags: ["environments"],
922
2019
  successDescription: "The list of environment variables"
923
2020
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
924
- const createEnvironmentVariablesContractV1 = oc.route({
2021
+ const createEnvironmentVariablesContractV1 = base.route({
925
2022
  path: "/v1/environments/{environmentId}/environment-variables",
926
2023
  method: "POST",
927
2024
  summary: "Add environment variables",
928
2025
  description: "Add one or more environment variables to an environment",
929
2026
  tags: ["environments"],
930
2027
  successDescription: "The environment variables have been added successfully"
931
- }).errors({
932
- NOT_FOUND: {},
933
- BAD_REQUEST: {}
934
- }).input(z.object({
2028
+ }).errors({ NOT_FOUND: {} }).input(z.object({
935
2029
  environmentId: z.string().describe("The ID of the environment"),
936
2030
  environmentVariables: environmentVariablesSchema
937
2031
  })).output(z.object({ success: z.literal(true) }));
938
- const updateEnvironmentVariableContractV1 = oc.route({
2032
+ const updateEnvironmentVariableContractV1 = base.route({
939
2033
  path: "/v1/environment-variables/{environmentVariableId}",
940
2034
  method: "PATCH",
941
2035
  summary: "Update an environment variable",
942
2036
  description: "Update an environment variable by ID",
943
2037
  tags: ["environments"],
944
2038
  successDescription: "The environment variable has been updated successfully"
945
- }).errors({
946
- NOT_FOUND: {},
947
- BAD_REQUEST: {}
948
- }).input(z.object({
2039
+ }).errors({ NOT_FOUND: {} }).input(z.object({
949
2040
  environmentVariableId: z.string().describe("The ID of the environment variable"),
950
2041
  key: environmentVariableSchema.shape.key,
951
2042
  value: environmentVariableSchema.shape.value.optional(),
952
2043
  isSecret: environmentVariableSchema.shape.isSecret.optional()
953
2044
  })).output(z.object({ success: z.literal(true) }));
954
- const deleteEnvironmentVariableContractV1 = oc.route({
2045
+ const deleteEnvironmentVariableContractV1 = base.route({
955
2046
  path: "/v1/environment-variables/{environmentVariableId}",
956
2047
  method: "DELETE",
957
2048
  summary: "Delete an environment variable",
@@ -959,7 +2050,7 @@ const deleteEnvironmentVariableContractV1 = oc.route({
959
2050
  tags: ["environments"],
960
2051
  successDescription: "The environment variable has been deleted successfully"
961
2052
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
962
- const deleteProjectContractV1 = oc.route({
2053
+ const deleteProjectContractV1 = base.route({
963
2054
  path: "/v1/projects/{projectId}",
964
2055
  method: "DELETE",
965
2056
  summary: "Delete a project",
@@ -967,7 +2058,7 @@ const deleteProjectContractV1 = oc.route({
967
2058
  tags: ["projects"],
968
2059
  successDescription: "The project has been deleted successfully"
969
2060
  }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
970
- const updateProjectContractV1 = oc.route({
2061
+ const updateProjectContractV1 = base.route({
971
2062
  path: "/v1/projects/{projectId}",
972
2063
  method: "PATCH",
973
2064
  summary: "Update a project",
@@ -976,13 +2067,13 @@ const updateProjectContractV1 = oc.route({
976
2067
  successDescription: "The project has been updated successfully"
977
2068
  }).errors({
978
2069
  NOT_FOUND: {},
979
- BAD_REQUEST: {}
2070
+ FORBIDDEN: {}
980
2071
  }).input(z.object({
981
2072
  projectId: z.string().describe("The ID of the project"),
982
2073
  name: z.string().min(1).max(100).optional().describe("The new name for the project"),
983
2074
  sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
984
2075
  })).output(projectOutputSchema);
985
- const deployEnvironmentContractV1 = oc.route({
2076
+ const deployEnvironmentContractV1 = base.route({
986
2077
  path: "/v1/environments/{environmentId}/deploy",
987
2078
  method: "POST",
988
2079
  summary: "Deploy an environment",
@@ -991,24 +2082,25 @@ const deployEnvironmentContractV1 = oc.route({
991
2082
  successDescription: "The environment has been deployed successfully"
992
2083
  }).errors({
993
2084
  NOT_FOUND: {},
994
- BAD_REQUEST: {}
2085
+ CONFLICT: {}
995
2086
  }).input(z.object({
996
2087
  environmentId: z.string().describe("The ID of the environment to deploy"),
997
- token: z.string().describe("The token to identify the source archive").optional()
2088
+ token: z.string().describe("The token to identify the source archive").optional(),
2089
+ 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.")
998
2090
  })).output(deploymentSchema);
999
- const uploadDeploymentArtifactContractV1 = oc.route({
2091
+ const uploadDeploymentArtifactContractV1 = base.route({
1000
2092
  path: "/v1/deployments/upload",
1001
2093
  method: "POST",
1002
2094
  summary: "Upload deployment artifacts",
1003
2095
  description: "Return a presigned S3 URL to upload a deployment artifact",
1004
2096
  tags: ["deployments"],
1005
2097
  successDescription: "The presigned upload URL has been generated successfully"
1006
- }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
2098
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
1007
2099
  uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
1008
2100
  token: z.string().describe("Token to identify the source archive"),
1009
2101
  expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
1010
2102
  }));
1011
- const listDeploymentsContractV1 = oc.route({
2103
+ const listDeploymentsContractV1 = base.route({
1012
2104
  path: "/v1/projects/{projectId}/deployments",
1013
2105
  method: "GET",
1014
2106
  summary: "List project deployments",
@@ -1020,7 +2112,7 @@ const listDeploymentsContractV1 = oc.route({
1020
2112
  status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
1021
2113
  environmentId: z.string().optional().describe("Filter by environment ID")
1022
2114
  })).output(z.array(deploymentSchema));
1023
- const getDeploymentContractV1 = oc.route({
2115
+ const getDeploymentContractV1 = base.route({
1024
2116
  path: "/v1/deployments/{deploymentId}",
1025
2117
  method: "GET",
1026
2118
  summary: "Get a deployment",
@@ -1028,20 +2120,32 @@ const getDeploymentContractV1 = oc.route({
1028
2120
  tags: ["deployments"],
1029
2121
  successDescription: "The deployment details"
1030
2122
  }).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
1031
- const getLogsContractV1 = oc.route({
2123
+ const logEntrySchema = z.object({
2124
+ timestamp: z.coerce.date(),
2125
+ type: z.enum([
2126
+ "START",
2127
+ "END",
2128
+ "INFO",
2129
+ "ERROR",
2130
+ "WARNING",
2131
+ "DEBUG"
2132
+ ]),
2133
+ requestId: z.string(),
2134
+ content: z.string().optional(),
2135
+ method: z.string().optional(),
2136
+ durationInMs: z.number().optional()
2137
+ });
2138
+ const getLogsContractV1 = base.route({
1032
2139
  path: "/v1/environments/{environmentId}/logs",
1033
2140
  method: "GET",
1034
2141
  summary: "Get logs",
1035
2142
  description: "Get logs for an environment",
1036
2143
  tags: ["environments"],
1037
2144
  successDescription: "The logs"
1038
- }).errors({
1039
- NOT_FOUND: {},
1040
- BAD_REQUEST: {}
1041
- }).input(z.object({
2145
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1042
2146
  environmentId: z.string().describe("The ID of the environment"),
1043
- 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)"),
1044
- 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"),
2147
+ since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
2148
+ until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
1045
2149
  limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
1046
2150
  level: z.array(z.enum([
1047
2151
  "INFO",
@@ -1049,37 +2153,20 @@ const getLogsContractV1 = oc.route({
1049
2153
  "WARNING",
1050
2154
  "DEBUG"
1051
2155
  ])).optional().describe("Filter by log level"),
1052
- search: z.string().optional().describe("Filter pattern to search for in log content"),
2156
+ search: logSearchSchema.optional().describe("Term to search for in log content"),
1053
2157
  nextToken: z.string().optional().describe("Pagination token from a previous response")
1054
2158
  })).output(z.object({
1055
- logs: z.array(z.object({
1056
- timestamp: z.coerce.date(),
1057
- type: z.enum([
1058
- "START",
1059
- "END",
1060
- "INFO",
1061
- "ERROR",
1062
- "WARNING",
1063
- "DEBUG"
1064
- ]),
1065
- requestId: z.string(),
1066
- content: z.string().optional(),
1067
- method: z.string().optional(),
1068
- durationInMs: z.number().optional()
1069
- })),
2159
+ logs: z.array(logEntrySchema),
1070
2160
  nextToken: z.string().nullable()
1071
2161
  }));
1072
- const getLatestLogsContractV1 = oc.route({
2162
+ const getLatestLogsContractV1 = base.route({
1073
2163
  path: "/v1/environments/{environmentId}/latest-logs",
1074
2164
  method: "GET",
1075
2165
  summary: "Get latest logs",
1076
2166
  description: "Get the N most recent logs for an environment",
1077
2167
  tags: ["environments"],
1078
2168
  successDescription: "The latest logs"
1079
- }).errors({
1080
- NOT_FOUND: {},
1081
- BAD_REQUEST: {}
1082
- }).input(z.object({
2169
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1083
2170
  environmentId: z.string().describe("The ID of the environment"),
1084
2171
  limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
1085
2172
  level: z.array(z.enum([
@@ -1088,23 +2175,9 @@ const getLatestLogsContractV1 = oc.route({
1088
2175
  "WARNING",
1089
2176
  "DEBUG"
1090
2177
  ])).optional().describe("Filter by log level"),
1091
- search: z.string().optional().describe("Filter pattern to search for in log content")
1092
- })).output(z.object({ logs: z.array(z.object({
1093
- timestamp: z.coerce.date(),
1094
- type: z.enum([
1095
- "START",
1096
- "END",
1097
- "INFO",
1098
- "ERROR",
1099
- "WARNING",
1100
- "DEBUG"
1101
- ]),
1102
- requestId: z.string(),
1103
- content: z.string().optional(),
1104
- method: z.string().optional(),
1105
- durationInMs: z.number().optional()
1106
- })) }));
1107
- const getDeploymentLogsContractV1 = oc.route({
2178
+ search: logSearchSchema.optional().describe("Term to search for in log content")
2179
+ })).output(z.object({ logs: z.array(logEntrySchema) }));
2180
+ const getDeploymentLogsContractV1 = base.route({
1108
2181
  path: "/v1/deployments/{deploymentId}/logs",
1109
2182
  method: "GET",
1110
2183
  summary: "Get deployment logs",
@@ -1131,22 +2204,19 @@ const analyticsTimeSeriesSchema = z.object({
1131
2204
  output_token_mean: z.array(analyticsDataPointSchema),
1132
2205
  task_count: z.array(analyticsDataPointSchema)
1133
2206
  });
1134
- const getProjectAnalyticsContractV1 = oc.route({
2207
+ const getProjectAnalyticsContractV1 = base.route({
1135
2208
  path: "/v1/analytics/{projectId}",
1136
2209
  method: "GET",
1137
2210
  summary: "Get project analytics",
1138
2211
  description: "Get analytics data for a project over a time range",
1139
2212
  tags: ["analytics"],
1140
2213
  successDescription: "The project analytics data"
1141
- }).errors({
1142
- NOT_FOUND: {},
1143
- BAD_REQUEST: {}
1144
- }).input(z.object({
2214
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1145
2215
  projectId: z.string().describe("The ID of the project"),
1146
2216
  startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
1147
2217
  endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
1148
2218
  timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
1149
- }).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({
2219
+ }).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({
1150
2220
  metadata: z.object({
1151
2221
  startTimestamp: z.number(),
1152
2222
  endTimestamp: z.number(),
@@ -1156,7 +2226,132 @@ const getProjectAnalyticsContractV1 = oc.route({
1156
2226
  }),
1157
2227
  timeSeries: analyticsTimeSeriesSchema
1158
2228
  }));
1159
- const listTeamsContractV1 = oc.route({
2229
+ const paginatedInsightsInputShape = {
2230
+ environmentId: z.string().describe("The ID of the environment"),
2231
+ since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
2232
+ until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
2233
+ limit: z.coerce.number().int().min(1).max(200).default(50),
2234
+ offset: z.coerce.number().int().min(0).default(0),
2235
+ search: z.string().trim().min(1).max(200).optional()
2236
+ };
2237
+ const listIntentsContractV1 = base.route({
2238
+ path: "/v1/environments/{environmentId}/intents",
2239
+ method: "GET",
2240
+ summary: "List intents",
2241
+ description: "List grouped user intents for an environment over a time range",
2242
+ tags: ["insights"],
2243
+ successDescription: "The grouped user intents"
2244
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2245
+ ...paginatedInsightsInputShape,
2246
+ tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
2247
+ clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
2248
+ categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
2249
+ sortDir: z.enum(["asc", "desc"]).default("desc")
2250
+ })).output(z.object({
2251
+ intents: z.array(z.object({
2252
+ id: z.string(),
2253
+ intentIds: z.array(z.string()).min(1),
2254
+ environmentId: z.string(),
2255
+ message: z.string(),
2256
+ toolName: z.string(),
2257
+ createdAt: z.coerce.date(),
2258
+ occurrenceCount: z.number().int().positive(),
2259
+ clientName: z.string().nullable(),
2260
+ clientId: z.string().nullable(),
2261
+ categories: z.array(z.object({
2262
+ id: z.string(),
2263
+ name: z.string(),
2264
+ color: intentCategoryColorSchema
2265
+ }))
2266
+ })),
2267
+ totalCount: z.number().int().nonnegative()
2268
+ }));
2269
+ const listFeedbacksContractV1 = base.route({
2270
+ path: "/v1/environments/{environmentId}/feedbacks",
2271
+ method: "GET",
2272
+ summary: "List feedbacks",
2273
+ description: "List user feedback for an environment over a time range",
2274
+ tags: ["insights"],
2275
+ successDescription: "The user feedback"
2276
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2277
+ ...paginatedInsightsInputShape,
2278
+ clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
2279
+ })).output(z.object({
2280
+ feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
2281
+ totalCount: z.number().int().nonnegative()
2282
+ }));
2283
+ const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
2284
+ const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
2285
+ const listIntentCategoriesContractV1 = base.route({
2286
+ path: "/v1/environments/{environmentId}/intent-categories",
2287
+ method: "GET",
2288
+ summary: "List intent categories",
2289
+ description: "List intent categories for an environment, including how many intents each category is linked to",
2290
+ tags: ["insights"],
2291
+ successDescription: "The intent categories"
2292
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
2293
+ const createIntentCategoryContractV1 = base.route({
2294
+ path: "/v1/environments/{environmentId}/intent-categories",
2295
+ method: "POST",
2296
+ summary: "Create an intent category",
2297
+ description: "Create an intent category, optionally linking it to existing intents",
2298
+ tags: ["insights"],
2299
+ successDescription: "The created intent category"
2300
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2301
+ environmentId: z.string().describe("The ID of the environment"),
2302
+ name: intentCategoryNameSchema,
2303
+ color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
2304
+ intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
2305
+ })).output(intentCategorySchema);
2306
+ const updateIntentCategoryContractV1 = base.route({
2307
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
2308
+ method: "PATCH",
2309
+ summary: "Update an intent category",
2310
+ description: "Rename or recolor an intent category",
2311
+ tags: ["insights"],
2312
+ successDescription: "The updated intent category"
2313
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2314
+ environmentId: z.string().describe("The ID of the environment"),
2315
+ categoryId: z.string().describe("The ID of the category"),
2316
+ name: intentCategoryNameSchema.optional(),
2317
+ color: intentCategoryColorSchema.optional().describe("The category color")
2318
+ }).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
2319
+ const deleteIntentCategoryContractV1 = base.route({
2320
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
2321
+ method: "DELETE",
2322
+ summary: "Delete an intent category",
2323
+ description: "Delete an intent category; its intents are unlinked but not deleted",
2324
+ tags: ["insights"],
2325
+ successDescription: "The intent category has been deleted successfully"
2326
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2327
+ environmentId: z.string().describe("The ID of the environment"),
2328
+ categoryId: z.string().describe("The ID of the category")
2329
+ })).output(z.object({ success: z.literal(true) }));
2330
+ const linkIntentCategoryContractV1 = base.route({
2331
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
2332
+ method: "POST",
2333
+ summary: "Link an intent category",
2334
+ description: "Link an intent category to intents; already linked intents are ignored",
2335
+ tags: ["insights"],
2336
+ successDescription: "The intents have been linked successfully"
2337
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2338
+ environmentId: z.string().describe("The ID of the environment"),
2339
+ categoryId: z.string().describe("The ID of the category"),
2340
+ intentIds: categorizableIntentIdsSchema
2341
+ })).output(z.object({ success: z.literal(true) }));
2342
+ const unlinkIntentCategoryContractV1 = base.route({
2343
+ path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
2344
+ method: "POST",
2345
+ summary: "Unlink an intent category",
2346
+ description: "Unlink an intent category from intents; intents without the category are ignored",
2347
+ tags: ["insights"],
2348
+ successDescription: "The intents have been unlinked successfully"
2349
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2350
+ environmentId: z.string().describe("The ID of the environment"),
2351
+ categoryId: z.string().describe("The ID of the category"),
2352
+ intentIds: categorizableIntentIdsSchema
2353
+ })).output(z.object({ success: z.literal(true) }));
2354
+ const listTeamsContractV1 = base.route({
1160
2355
  path: "/v1/teams",
1161
2356
  method: "GET",
1162
2357
  summary: "List teams",
@@ -1169,28 +2364,40 @@ const listTeamsContractV1 = oc.route({
1169
2364
  createdAt: z.coerce.date(),
1170
2365
  hasStripeAccount: z.boolean()
1171
2366
  })));
1172
- const getTunnelTicketContractV1 = oc.route({
2367
+ const getTeamUsageContractV1 = base.route({
2368
+ path: "/v1/teams/{teamId}/usage",
2369
+ method: "GET",
2370
+ summary: "Get team usage",
2371
+ 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.",
2372
+ tags: ["teams"],
2373
+ successDescription: "The current billing window usage"
2374
+ }).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
2375
+ teamId: z.string(),
2376
+ plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
2377
+ periodStart: z.coerce.date().describe("Start of the current billing window"),
2378
+ periodEnd: z.coerce.date().describe("End of the current billing window"),
2379
+ requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
2380
+ includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
2381
+ }));
2382
+ const getTunnelTicketContractV1 = base.route({
1173
2383
  path: "/v1/tunnels/ticket",
1174
2384
  method: "GET",
1175
2385
  summary: "Get a tunnel ticket",
1176
2386
  description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
1177
2387
  tags: ["tunnels"],
1178
2388
  successDescription: "The tunnel ticket"
1179
- }).output(z.object({
2389
+ }).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
1180
2390
  subdomain: z.string().describe("The subdomain assigned to the user"),
1181
2391
  ticket: z.string().describe("The signed tunnel ticket"),
1182
2392
  tunnelHost: z.string().describe("The tunnel host to connect to")
1183
2393
  }));
1184
- const publishServerContractV1 = oc.route({
2394
+ const publishServerContractV1 = base.route({
1185
2395
  path: "/v1/distribution/publish",
1186
2396
  method: "POST",
1187
2397
  summary: "Publish a server to the MCP registry",
1188
2398
  tags: ["distribution"],
1189
2399
  successDescription: "The server has been published successfully"
1190
- }).errors({
1191
- NOT_FOUND: {},
1192
- BAD_REQUEST: {}
1193
- }).input(z.object({
2400
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1194
2401
  projectId: z.string(),
1195
2402
  domain: z.string(),
1196
2403
  title: z.string().min(1).max(100),
@@ -1199,17 +2406,14 @@ const publishServerContractV1 = oc.route({
1199
2406
  iconSrc: z.url().max(255).optional(),
1200
2407
  dryRun: z.boolean().optional()
1201
2408
  })).output(z.object({ serverFields: serverFieldsSchema }));
1202
- const getServerInfoContractV1 = oc.route({
2409
+ const getServerInfoContractV1 = base.route({
1203
2410
  path: "/v1/distribution/get",
1204
2411
  method: "GET",
1205
2412
  summary: "Get server info",
1206
2413
  description: "Get info about a server",
1207
2414
  tags: ["distribution"],
1208
2415
  successDescription: "The server info"
1209
- }).errors({
1210
- NOT_FOUND: {},
1211
- BAD_REQUEST: {}
1212
- }).input(z.object({
2416
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1213
2417
  projectId: z.string(),
1214
2418
  domain: z.string()
1215
2419
  })).output(z.object({ serverFields: serverFieldsSchema }));
@@ -1228,7 +2432,7 @@ const playgroundOutputSchema = z.object({
1228
2432
  isPlaygroundEnabled: z.boolean(),
1229
2433
  serverMetadata: playgroundServerMetadataOutputSchema.nullable()
1230
2434
  });
1231
- const getPlaygroundContractV1 = oc.route({
2435
+ const getPlaygroundContractV1 = base.route({
1232
2436
  path: "/v1/environments/{environmentId}/playground",
1233
2437
  method: "GET",
1234
2438
  summary: "Get playground configuration",
@@ -1236,25 +2440,22 @@ const getPlaygroundContractV1 = oc.route({
1236
2440
  tags: ["environments"],
1237
2441
  successDescription: "The playground configuration"
1238
2442
  }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
1239
- const upsertPlaygroundContractV1 = oc.route({
2443
+ const upsertPlaygroundContractV1 = base.route({
1240
2444
  path: "/v1/environments/{environmentId}/playground",
1241
2445
  method: "PUT",
1242
2446
  summary: "Update playground configuration",
1243
2447
  description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
1244
2448
  tags: ["environments"],
1245
2449
  successDescription: "The updated playground configuration"
1246
- }).errors({
1247
- NOT_FOUND: {},
1248
- BAD_REQUEST: {}
1249
- }).input(z.object({
2450
+ }).errors({ NOT_FOUND: {} }).input(z.object({
1250
2451
  environmentId: z.string().describe("The ID of the environment"),
1251
2452
  isPlaygroundEnabled: z.boolean().optional(),
1252
2453
  name: z.string().min(1).max(100).optional(),
1253
2454
  description: z.string().min(1).max(500).optional(),
1254
2455
  headers: z.array(playgroundHeaderSchema).optional(),
1255
- examplePrompts: z.array(playgroundExamplePromptSchema).max(3).optional()
2456
+ examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
1256
2457
  })).output(playgroundOutputSchema);
1257
- const createBeaconContractV1 = oc.route({
2458
+ const createBeaconContractV1 = base.route({
1258
2459
  path: "/v1/beacon/audits",
1259
2460
  method: "POST",
1260
2461
  summary: "Create a beacon audit",
@@ -1263,7 +2464,6 @@ const createBeaconContractV1 = oc.route({
1263
2464
  successDescription: "The audit has been created"
1264
2465
  }).errors({
1265
2466
  NOT_FOUND: {},
1266
- BAD_REQUEST: {},
1267
2467
  DNS_RESOLUTION_FAILED: { status: 400 }
1268
2468
  }).input(z.object({
1269
2469
  targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
@@ -1271,7 +2471,7 @@ const createBeaconContractV1 = oc.route({
1271
2471
  projectId: z.string().optional().describe("The project ID to associate the audit with"),
1272
2472
  excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
1273
2473
  })).output(z.object({ id: z.string() }));
1274
- const getBeaconContractV1 = oc.route({
2474
+ const getBeaconContractV1 = base.route({
1275
2475
  path: "/v1/beacon/audits/{auditId}",
1276
2476
  method: "GET",
1277
2477
  summary: "Get a beacon audit",
@@ -1286,9 +2486,73 @@ const getBeaconContractV1 = oc.route({
1286
2486
  createdAt: z.coerce.date(),
1287
2487
  report: auditReportWithScreenshotsSchema.nullable()
1288
2488
  }));
2489
+ const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
2490
+ const submissionIdSchema = z.string().describe("The ID of the submission package");
2491
+ const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
2492
+ const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
2493
+ const createSubmissionContractV1 = base.route({
2494
+ path: "/v1/submissions",
2495
+ method: "POST",
2496
+ summary: "Create a submission package",
2497
+ description: "Create a submission package for an environment. Alpic reads the environment's live MCP server and prefills every field it can infer, so the response already carries the populated package. The environment must have a successful deployment and must not require authentication.",
2498
+ tags: ["submissions"],
2499
+ successDescription: "The created submission package, with its prefilled fields"
2500
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2501
+ environmentId: z.string().describe("The ID of the environment to build the package from"),
2502
+ platform: platformSchema.describe(PLATFORM_DESCRIPTION)
2503
+ })).output(submissionSchema);
2504
+ const listSubmissionsContractV1 = base.route({
2505
+ path: "/v1/projects/{projectId}/submissions",
2506
+ method: "GET",
2507
+ summary: "List submission packages",
2508
+ description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
2509
+ tags: ["submissions"],
2510
+ successDescription: "The list of submission packages"
2511
+ }).errors({ NOT_FOUND: {} }).input(z.object({
2512
+ projectId: z.string().describe("The ID of the project"),
2513
+ environmentId: z.string().optional().describe("Filter by environment ID"),
2514
+ platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
2515
+ })).output(z.array(submissionSchema));
2516
+ const getSubmissionContractV1 = base.route({
2517
+ path: "/v1/submissions/{submissionId}",
2518
+ method: "GET",
2519
+ summary: "Get a submission package",
2520
+ description: "Get a submission package by ID, including its form data and the prefill it started from",
2521
+ tags: ["submissions"],
2522
+ successDescription: "The submission package"
2523
+ }).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
2524
+ const updateSubmissionContractV1 = base.route({
2525
+ path: "/v1/submissions/{submissionId}",
2526
+ method: "PUT",
2527
+ summary: "Update a submission package",
2528
+ description: "Update the form data of a submission package. Only the fields you send are changed; the rest are left as they are. Unknown field names are rejected rather than ignored, so a typo fails the call. `platform` must match the package's own platform.",
2529
+ tags: ["submissions"],
2530
+ successDescription: "The updated submission package"
2531
+ }).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
2532
+ submissionId: submissionIdSchema,
2533
+ platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
2534
+ formData: claudeSubmissionUpdateSchema
2535
+ }), z.object({
2536
+ submissionId: submissionIdSchema,
2537
+ platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
2538
+ formData: chatgptSubmissionUpdateSchema
2539
+ })])).output(submissionSchema);
1289
2540
  const contract = {
1290
- teams: { list: { v1: listTeamsContractV1 } },
2541
+ teams: {
2542
+ list: { v1: listTeamsContractV1 },
2543
+ getUsage: { v1: getTeamUsageContractV1 }
2544
+ },
1291
2545
  analytics: { get: { v1: getProjectAnalyticsContractV1 } },
2546
+ intents: { list: { v1: listIntentsContractV1 } },
2547
+ intentCategories: {
2548
+ list: { v1: listIntentCategoriesContractV1 },
2549
+ create: { v1: createIntentCategoryContractV1 },
2550
+ update: { v1: updateIntentCategoryContractV1 },
2551
+ delete: { v1: deleteIntentCategoryContractV1 },
2552
+ link: { v1: linkIntentCategoryContractV1 },
2553
+ unlink: { v1: unlinkIntentCategoryContractV1 }
2554
+ },
2555
+ feedbacks: { list: { v1: listFeedbacksContractV1 } },
1292
2556
  deployments: {
1293
2557
  list: { v1: listDeploymentsContractV1 },
1294
2558
  get: { v1: getDeploymentContractV1 },
@@ -1298,6 +2562,7 @@ const contract = {
1298
2562
  environments: {
1299
2563
  create: { v1: createEnvironmentContractV1 },
1300
2564
  get: { v1: getEnvironmentContractV1 },
2565
+ delete: { v1: deleteEnvironmentContractV1 },
1301
2566
  deploy: { v1: deployEnvironmentContractV1 },
1302
2567
  getLogs: { v1: getLogsContractV1 },
1303
2568
  getLatestLogs: { v1: getLatestLogsContractV1 }
@@ -1308,6 +2573,12 @@ const contract = {
1308
2573
  update: { v1: updateEnvironmentVariableContractV1 },
1309
2574
  delete: { v1: deleteEnvironmentVariableContractV1 }
1310
2575
  },
2576
+ telemetryDestinations: {
2577
+ list: { v1: listTelemetryDestinationsContractV1 },
2578
+ create: { v1: createTelemetryDestinationContractV1 },
2579
+ update: { v1: updateTelemetryDestinationContractV1 },
2580
+ delete: { v1: deleteTelemetryDestinationContractV1 }
2581
+ },
1311
2582
  projects: {
1312
2583
  update: { v1: updateProjectContractV1 },
1313
2584
  get: { v1: getProjectContractV1 },
@@ -1327,7 +2598,39 @@ const contract = {
1327
2598
  beacon: {
1328
2599
  create: { v1: createBeaconContractV1 },
1329
2600
  get: { v1: getBeaconContractV1 }
2601
+ },
2602
+ submissions: {
2603
+ create: { v1: createSubmissionContractV1 },
2604
+ list: { v1: listSubmissionsContractV1 },
2605
+ get: { v1: getSubmissionContractV1 },
2606
+ update: { v1: updateSubmissionContractV1 }
2607
+ }
2608
+ };
2609
+ const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
2610
+ const contractForDocs = {
2611
+ ...contract,
2612
+ deployments: deploymentsForDocs
2613
+ };
2614
+ /** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
2615
+ const OPENAPI_DOC_OPTIONS = {
2616
+ info: {
2617
+ title: "Alpic API",
2618
+ version: "1.0.0"
2619
+ },
2620
+ servers: [{ url: "https://api.alpic.ai" }],
2621
+ security: [{ bearerAuth: [] }],
2622
+ components: { securitySchemes: { bearerAuth: {
2623
+ type: "http",
2624
+ description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
2625
+ scheme: "bearer"
2626
+ } } },
2627
+ commonSchemas: {
2628
+ Submission: { schema: submissionSchema },
2629
+ ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
2630
+ ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
2631
+ ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
2632
+ ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
1330
2633
  }
1331
2634
  };
1332
2635
  //#endregion
1333
- export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
2636
+ export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, OTLP_PROTOCOLS, PLATFORM_LABELS, TELEMETRY_SIGNALS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, otlpProtocolSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, telemetrySignalSchema, transportSchema, updateEnvironmentVariableSchema };