@alpic-ai/api 0.0.0-staging.gfbabe10 → 0.0.0-staging.gfcfbb4c

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -1,6 +1,5 @@
1
1
  import { z } from "zod";
2
2
  import { InferContractRouterInputs, InferContractRouterOutputs } from "@orpc/contract";
3
-
4
3
  //#region src/api.contract.d.ts
5
4
  type ApiContext = {
6
5
  request: Request & {
@@ -225,6 +224,17 @@ declare const contract: {
225
224
  v1: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
226
225
  environmentId: z.ZodString;
227
226
  token: z.ZodOptional<z.ZodString>;
227
+ settings: z.ZodOptional<z.ZodObject<{
228
+ installCommand: z.ZodOptional<z.ZodString>;
229
+ buildCommand: z.ZodOptional<z.ZodString>;
230
+ buildOutputDir: z.ZodOptional<z.ZodString>;
231
+ startCommand: z.ZodOptional<z.ZodString>;
232
+ transport: z.ZodEnum<{
233
+ stdio: "stdio";
234
+ sse: "sse";
235
+ streamablehttp: "streamablehttp";
236
+ }>;
237
+ }, z.core.$strip>>;
228
238
  }, z.core.$strip>, z.ZodObject<{
229
239
  id: z.ZodString;
230
240
  status: z.ZodEnum<{
@@ -247,6 +257,7 @@ declare const contract: {
247
257
  }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
248
258
  NOT_FOUND: {};
249
259
  BAD_REQUEST: {};
260
+ CONFLICT: {};
250
261
  }>, Record<never, never>>;
251
262
  };
252
263
  getLogs: {
@@ -448,6 +459,7 @@ declare const contract: {
448
459
  }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
449
460
  NOT_FOUND: {};
450
461
  BAD_REQUEST: {};
462
+ FORBIDDEN: {};
451
463
  }>, Record<never, never>>;
452
464
  };
453
465
  get: {
@@ -663,6 +675,7 @@ declare const contract: {
663
675
  }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
664
676
  NOT_FOUND: {};
665
677
  BAD_REQUEST: {};
678
+ FORBIDDEN: {};
666
679
  }>, Record<never, never>>;
667
680
  };
668
681
  delete: {
@@ -938,6 +951,17 @@ declare const contract: {
938
951
  type RouterInput = InferContractRouterInputs<typeof contract>;
939
952
  type RouterOutput = InferContractRouterOutputs<typeof contract>;
940
953
  //#endregion
954
+ //#region src/auth-scope.d.ts
955
+ /** Credential scope required by an API route. */
956
+ type AuthScope = "any" | "user";
957
+ /** Accepts an API key or OAuth access token (default for most routes). */
958
+ declare const AUTH_SCOPE_ANY = "any";
959
+ /** Requires a user OAuth access token; API keys are not accepted. */
960
+ declare const AUTH_SCOPE_USER = "user";
961
+ type RouteAuthMeta = {
962
+ authScope?: AuthScope;
963
+ };
964
+ //#endregion
941
965
  //#region ../domains/src/platforms/schemas.d.ts
942
966
  declare const platformSchema: z.ZodEnum<{
943
967
  chatgpt: "chatgpt";
@@ -1017,4 +1041,4 @@ declare const serverFieldsSchema: z.ZodObject<{
1017
1041
  }, z.core.$strip>>>;
1018
1042
  }, z.core.$strip>;
1019
1043
  //#endregion
1020
- export { ApiContext, PLATFORM_LABELS, type Platform, RouterInput, RouterOutput, Runtime, Transport, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
1044
+ export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, ApiContext, AuthScope, PLATFORM_LABELS, type Platform, RouteAuthMeta, RouterInput, RouterOutput, Runtime, Transport, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
package/dist/index.mjs CHANGED
@@ -169,11 +169,21 @@ z$1.object({
169
169
  token: z$1.string(),
170
170
  token_type_hint: z$1.string().optional()
171
171
  }).strip();
172
- const platformSchema = z.enum(["chatgpt", "claudeai"]);
172
+ //#endregion
173
+ //#region ../domains/dist/index.mjs
174
+ const AI_PLATFORMS = ["chatgpt", "claudeai"];
175
+ const platformSchema = z.enum(AI_PLATFORMS);
173
176
  const PLATFORM_LABELS = {
174
177
  chatgpt: "ChatGPT",
175
178
  claudeai: "Claude.ai"
176
179
  };
180
+ const WAF_PLATFORMS = [
181
+ "akamai",
182
+ "cloudflare",
183
+ "fastly"
184
+ ];
185
+ const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
186
+ const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
177
187
  const auditStatusSchema = z.enum([
178
188
  "pending",
179
189
  "partial",
@@ -276,11 +286,11 @@ const deploymentSummarySchema = z.object({
276
286
  /**
277
287
  * Public environment
278
288
  *
279
- * No OAuth metadata exposed.
289
+ * Answers anonymously and exposes no OAuth metadata.
280
290
  */
281
291
  const publicEnvironmentSchema = z.object({
282
- isPublic: z.literal(true),
283
- oAuthMetadata: z.undefined().optional()
292
+ allowsAnonymous: z.literal(true),
293
+ oAuthMetadata: z.strictObject({})
284
294
  });
285
295
  /**
286
296
  * Protected environment with an external resource metadata URL
@@ -289,7 +299,7 @@ const publicEnvironmentSchema = z.object({
289
299
  * Everything that follows is handled outside of the MCP server scope.
290
300
  */
291
301
  const externalResourceMetadataEnvironmentSchema = z.object({
292
- isPublic: z.literal(false),
302
+ allowsAnonymous: z.boolean(),
293
303
  oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
294
304
  scope: z.string().optional()
295
305
  });
@@ -301,7 +311,7 @@ const externalResourceMetadataEnvironmentSchema = z.object({
301
311
  * Everything that follows is handled outside of the MCP server scope.
302
312
  */
303
313
  const externalAuthorizationServerEnvironmentSchema = z.object({
304
- isPublic: z.literal(false),
314
+ allowsAnonymous: z.boolean(),
305
315
  oAuthMetadata: z.object({
306
316
  externalAuthorizationServerUrl: z.url(),
307
317
  resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
@@ -315,7 +325,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
315
325
  * The server itself exposes the /.well-known/oauth-authorization-server endpoint.
316
326
  */
317
327
  const standaloneEnvironmentSchema = z.object({
318
- isPublic: z.literal(false),
328
+ allowsAnonymous: z.boolean(),
319
329
  oAuthMetadata: z.object({
320
330
  authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
321
331
  resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
@@ -330,6 +340,36 @@ const standaloneEnvironmentSchema = z.object({
330
340
  * are advertised. Clients must obtain credentials out-of-band.
331
341
  */
332
342
  const protectedWithoutDiscoveryEnvironmentSchema = z.object({
343
+ allowsAnonymous: z.literal(false),
344
+ oAuthMetadata: z.strictObject({}),
345
+ scope: z.string().optional()
346
+ });
347
+ const legacyPublicEnvironmentSchema = z.object({
348
+ isPublic: z.literal(true),
349
+ oAuthMetadata: z.undefined().optional()
350
+ });
351
+ const legacyExternalResourceMetadataEnvironmentSchema = z.object({
352
+ isPublic: z.literal(false),
353
+ oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
354
+ scope: z.string().optional()
355
+ });
356
+ const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
357
+ isPublic: z.literal(false),
358
+ oAuthMetadata: z.object({
359
+ externalAuthorizationServerUrl: z.url(),
360
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
361
+ }),
362
+ scope: z.string().optional()
363
+ });
364
+ const legacyStandaloneEnvironmentSchema = z.object({
365
+ isPublic: z.literal(false),
366
+ oAuthMetadata: z.object({
367
+ authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
368
+ resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
369
+ }),
370
+ scope: z.string().optional()
371
+ });
372
+ const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
333
373
  isPublic: z.literal(false),
334
374
  oAuthMetadata: z.strictObject({}),
335
375
  scope: z.string().optional()
@@ -339,11 +379,21 @@ z.union([
339
379
  externalResourceMetadataEnvironmentSchema,
340
380
  externalAuthorizationServerEnvironmentSchema,
341
381
  standaloneEnvironmentSchema,
342
- protectedWithoutDiscoveryEnvironmentSchema
382
+ protectedWithoutDiscoveryEnvironmentSchema,
383
+ legacyPublicEnvironmentSchema,
384
+ legacyExternalResourceMetadataEnvironmentSchema,
385
+ legacyExternalAuthorizationServerEnvironmentSchema,
386
+ legacyStandaloneEnvironmentSchema,
387
+ legacyProtectedWithoutDiscoveryEnvironmentSchema
388
+ ]);
389
+ const playgroundModelSchema = z.enum([
390
+ "global.anthropic.claude-haiku-4-5-20251001-v1:0",
391
+ "global.anthropic.claude-sonnet-4-5-20250929-v1:0",
392
+ "openai.gpt-5.4",
393
+ "openai.gpt-5.5"
343
394
  ]);
344
- const allowedPlatformSchema = platformSchema;
345
395
  const environmentDomainSchema = z.object({
346
- domain: z.string(),
396
+ name: z.string(),
347
397
  status: z.enum([
348
398
  "ongoing",
349
399
  "deployed",
@@ -361,6 +411,7 @@ const environmentSchema$1 = z.object({
361
411
  latestDeployment: deploymentSummarySchema.optional(),
362
412
  openaiAppsChallenge: z.string().nullable().optional(),
363
413
  isPlaygroundEnabled: z.boolean(),
414
+ playgroundModel: playgroundModelSchema,
364
415
  isIpWhitelistEnabled: z.boolean(),
365
416
  ipAllowlist: z.array(z.string()).nullable(),
366
417
  allowedPlatforms: z.array(allowedPlatformSchema),
@@ -373,7 +424,9 @@ z.object({
373
424
  sessionReplayEnabled: z.boolean(),
374
425
  collectRequestPayload: z.boolean(),
375
426
  collectResponsePayload: z.boolean(),
376
- collectErrorMessage: z.boolean()
427
+ collectErrorMessage: z.boolean(),
428
+ collectUserData: z.boolean(),
429
+ identityTraitKey: z.string().min(1).max(200).nullable()
377
430
  });
378
431
  z.object({
379
432
  id: z.string(),
@@ -508,15 +561,27 @@ z.object({
508
561
  environments: z.array(environmentWithDomainsSchema),
509
562
  productionEnvironment: environmentWithDomainsSchema.nullable()
510
563
  });
564
+ const domainFailureReasonSchema = z.enum([
565
+ "caa",
566
+ "dns",
567
+ "invalid_domain",
568
+ "other"
569
+ ]);
570
+ const projectDomainMappingSchema = z.object({
571
+ pathPrefix: z.string(),
572
+ environment: environmentSchema$1
573
+ });
511
574
  z.object({
512
- domain: z.string(),
575
+ name: z.string(),
513
576
  createdAt: z.coerce.date(),
514
577
  status: z.enum([
515
578
  "ongoing",
516
579
  "deployed",
517
580
  "failed"
518
581
  ]),
519
- environment: environmentSchema$1
582
+ failureReason: domainFailureReasonSchema.nullable(),
583
+ environment: environmentSchema$1,
584
+ mappings: z.array(projectDomainMappingSchema)
520
585
  });
521
586
  const serverFieldsSchema$1 = z.object({
522
587
  $schema: z.string(),
@@ -580,10 +645,13 @@ const positiveTestCaseSchema = z.object({
580
645
  }).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
581
646
  const screenshotEntrySchema = z.object({
582
647
  prompt: z.string(),
583
- url: z.url().or(z.literal(""))
648
+ url: z.url()
584
649
  }).describe("Each screenshot: the user prompt that produced it + the image URL.");
650
+ const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
585
651
  /** Accepts either a valid email or URL. */
586
652
  const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
653
+ /** A URL field whose error spells out that the scheme is required. */
654
+ const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
587
655
  const chatgptCategorySchema = z.enum([
588
656
  "BUSINESS",
589
657
  "COLLABORATION",
@@ -921,23 +989,34 @@ const chatgptSubmissionFormDataSchema = z.object({
921
989
  description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
922
990
  category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
923
991
  developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
924
- companyUrl: z.url().describe("Your company's main website URL."),
992
+ companyUrl: urlField.describe("Your company's main website URL."),
925
993
  supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
926
- privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
927
- termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
928
- 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."),
994
+ privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
995
+ termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
996
+ demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
929
997
  appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
930
- serverUrl: z.url().describe("URL of the MCP server."),
998
+ serverUrl: urlField.describe("URL of the MCP server."),
931
999
  authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
932
1000
  tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
933
1001
  toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
934
1002
  testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
935
1003
  negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
936
- screenshots: z.array(screenshotEntrySchema).max(3).describe("In-app screenshots paired with the user prompt that produced them. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
1004
+ screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
937
1005
  translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
938
1006
  allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
939
1007
  releaseNotes: z.string().describe("Publicly displayed on the app details page.")
940
1008
  });
1009
+ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
1010
+ tagline: z.string().optional(),
1011
+ companyUrl: z.string().optional(),
1012
+ supportChannel: z.string().optional(),
1013
+ privacyPolicyUrl: z.string().optional(),
1014
+ termsOfServiceUrl: z.string().optional(),
1015
+ demoRecordingUrl: z.string().optional(),
1016
+ serverUrl: z.string().optional(),
1017
+ screenshots: z.array(screenshotDraftEntrySchema).optional(),
1018
+ translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
1019
+ });
941
1020
  chatgptSubmissionFormDataSchema.pick({
942
1021
  appName: true,
943
1022
  developerName: true,
@@ -954,7 +1033,7 @@ chatgptSubmissionFormDataSchema.pick({
954
1033
  toolJustifications: true
955
1034
  }).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
956
1035
  const claudeCategorySchema = z.enum([
957
- "Business & Productivity",
1036
+ "Productivity",
958
1037
  "Communication",
959
1038
  "Data & Analytics",
960
1039
  "Development tools",
@@ -962,205 +1041,154 @@ const claudeCategorySchema = z.enum([
962
1041
  "Consumer Health",
963
1042
  "Health & Life Sciences",
964
1043
  "Media & Entertainment",
965
- "Commerce & Shopping"
966
- ]);
967
- const claudeAuthenticationSchema = z.enum([
968
- "No auth needed",
969
- "OAuth 2.0",
970
- "Custom URL"
1044
+ "Commerce & Shopping",
1045
+ "Legal",
1046
+ "Sales and marketing",
1047
+ "Creative",
1048
+ "Nonprofit",
1049
+ "Education",
1050
+ "Other"
971
1051
  ]);
972
- const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
973
- z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
1052
+ const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
974
1053
  const claudeReadWriteCapabilitiesSchema = z.enum([
975
- "Read Only",
976
- "Write Only",
977
- "Read + Write"
1054
+ "read_only",
1055
+ "write_only",
1056
+ "read_write"
978
1057
  ]);
979
- const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
980
- const claudeTestedSurfaceSchema = z.enum([
981
- "Claude.ai (web)",
982
- "Claude Desktop",
983
- "Claude Code",
984
- "Cowork"
985
- ]);
986
- const claudeThirdPartySchema = z.enum([
987
- "Web access: Fetches information from the open web (e.g., web scraping, search engines, or browsing arbitrary URLs, not just connecting to a specific API)",
988
- "Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
989
- "Third-party data retrieval: Connects to external services that themselves retrieve data from other sources (e.g., workflow automation platforms or other services that aggregate or relay data from multiple third-party sources)",
990
- "Third-party data modification: Can connect to external services that themselves create, update, or delete data in other sources (e.g., workflow automation platforms or other services that write to multiple third-party sources)",
991
- "N/A"
1058
+ const claudeAuthenticationSchema = z.enum([
1059
+ "oauth_dcr",
1060
+ "oauth_cimd",
1061
+ "oauth_anthropic_creds",
1062
+ "custom_connection",
1063
+ "none"
992
1064
  ]);
993
- const claudeDataHandlingSchema = z.enum([
994
- "Server only accesses data explicitly requested by user",
995
- "No data is stored beyond session requirements",
996
- "Data transmission is encrypted (HTTPS/TLS)",
997
- "GDPR compliant (if applicable)"
1065
+ const claudeApiOwnershipSchema = z.enum([
1066
+ "first_party",
1067
+ "proxied",
1068
+ "third_party"
998
1069
  ]);
999
- const claudeSponsoredContentSchema = z.enum([
1000
- "No, there is no sponsored content or advertisements",
1001
- "Yes, there are banner ads or other paid visual elements",
1002
- "Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement"
1070
+ const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
1071
+ const claudePolicyAcknowledgementSchema = z.enum([
1072
+ "I have read and understand the MCP Directory developer guidelines.",
1073
+ "My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
1074
+ "My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
1075
+ "My connector does not use AI models to generate images, video, or audio.",
1076
+ "Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
1077
+ "My connector does not collect conversation data beyond what is needed for its function.",
1078
+ "Public documentation for this connector will be live by the publish date."
1003
1079
  ]);
1004
1080
  /**
1005
- * Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
1006
- * When adding/removing/reordering fields, keep this in sync with the sheet.
1081
+ * Field order mirrors the claude.ai directory submission wizard
1082
+ * (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
1083
+ * When adding/removing/reordering fields, keep this in sync with the wizard.
1007
1084
  */
1008
1085
  const claudeSubmissionFormDataSchema = z.object({
1009
- 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."),
1010
- 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."),
1011
- 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."),
1012
- 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."),
1013
- 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."),
1014
- 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."),
1015
- appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
1016
-
1017
- Rules:
1018
- (1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
1019
- (2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
1020
- (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.`),
1021
- mcpUrlType: claudeMcpUrlTypeSchema.describe(`Choose how your server URL works:
1022
- • 'Universal URL': one single URL that all users connect to (most common). Example: https://mcp.myapp.com
1023
- • 'Custom MCP URLs': each user gets their own unique URL (e.g. based on their workspace or instance).
1024
- 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.`),
1025
- 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/
1026
- 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.`),
1027
- 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.
1028
- 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...'`),
1029
- 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.`),
1030
- 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.
1031
- Best format: [Use case]: [exact prompt]"
1032
- Example for a task manager:
1033
- 1. Create a task: 'Create a task called Review Q3 report, due Friday, assigned to Alice'
1034
- 2. Search tasks: 'Show me all open bugs in the Mobile project'
1035
- 3. Update status: 'Mark the Deploy v2.1 task as done'"`),
1036
- connectionRequirements: z.string().describe(`Describe any prerequisites a user must have before they can connect your server. Be exhaustive. Examples of things to mention:
1037
- • Account type required (free vs paid plan)
1038
- • Admin permissions or specific roles needed
1039
- • Geographic restrictions (e.g. 'US only' or 'Not available in EU')
1040
- • If users need to provide their own server URL or instance domain
1041
- • Any setup steps needed before connecting (e.g. 'Enable API access in your account settings')
1042
- If there are genuinely no special requirements, write exactly: 'No special requirements.'`),
1043
- readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`Select the option that best describes what your server can do:
1044
-
1045
- 'Read Only': your tools only fetch/retrieve data (GET operations). Claude cannot modify anything via your server.
1046
- 'Write Only': your tools only create/update/delete data (rare).
1047
- 'Read + Write': your tools can both retrieve AND modify data (most common for full-featured connectors).
1048
-
1049
- 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. `),
1050
- isMcpApp: z.boolean().describe(`Select 'Yes' if your MCP server renders interactive UI elements (aka widgets or views) inside the Claude conversation.
1051
- Select 'No' if your server only returns text/data responses.
1052
- 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.`),
1053
- thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe(`Multi-select all that apply to your server's behavior:
1054
- • 'Web access' — your server fetches arbitrary URLs, scrapes websites, or makes open-ended HTTP requests to the web (not just your own API).
1055
- • 'Third-party AI model integration' — your server calls another AI model (e.g. OpenAI, Gemini, Cohere) as part of its processing.
1056
- • '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.
1057
- • 'Third-party data modification' — your server modifies data via such a platform.
1058
- • 'N/A' — your server only calls your own first-party API and does nothing else. Select this only if none of the above apply.`),
1059
- 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:
1060
- • 'Server only accesses data explicitly requested by user' — your server doesn't silently read unrelated user data.
1061
- • 'No data is stored beyond session requirements' — you don't log or retain conversation data after the session.
1062
- • 'Data transmission is encrypted (HTTPS/TLS)' — all data in transit is encrypted. This should always apply for remote servers.
1063
- • '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.
1064
- Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
1065
- 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.
1066
- Select 'No' for the vast majority of business/productivity/dev tools. When in doubt, select 'No'. This field triggers additional compliance review if 'Yes'.`),
1067
- 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:
1068
- • Business & Productivity — project management, CRM, HR, office tools
1069
- • Communication — email, chat, messaging, notifications
1070
- • Data & Analytics — dashboards, reporting, databases, BI tools
1071
- • Development tools — code repositories, CI/CD, issue trackers, monitoring
1072
- • Financial Services — accounting, invoicing, fintech (note: financial transaction execution is not permitted)
1073
- • Consumer Health — fitness, wellness, personal health tracking
1074
- • Health & Life Sciences — clinical, pharma, medical professional tools
1075
- • Media & Entertainment — content, publishing, streaming
1076
- • Commerce & Shopping — e-commerce, inventory, orders
1077
- Anthropic's submission form only accepts a single category.`),
1078
- 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:
1079
- • '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.
1080
- • '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.
1081
- • '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.
1082
- 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'.`),
1083
- authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
1084
- transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
1085
- • 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
1086
- • 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
1087
- If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
1088
- serverDocumentationLink: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. This is displayed in the Directory listing and must be publicly accessible without login. Minimum requirements for the docs page:
1089
- • What the connector does and its key capabilities
1090
- • How to connect/set it up (step by step)
1091
- • What each tool does (or at least the main ones)
1092
- • How to troubleshoot common issues
1093
- • A support contact or channel
1094
- Acceptable formats: a dedicated docs page, a help center article, a README on GitHub, or a blog post — as long as it's comprehensive. Note: Anthropic requires public documentation to be live by your publish date.`),
1095
- privacyPolicyUrl: z.url().describe(`URL to your privacy policy. This is mandatory and displayed in the directory listing. Missing or incomplete privacy policies result in immediate rejection. Your privacy policy must cover:
1096
- • What data you collect (and how)
1097
- • How you use the collected data
1098
- • Where and how long you store it
1099
- • Whether you share data with third parties (and who)
1100
- • How users can contact you about data concerns
1101
- The policy must be publicly accessible. If you don't have one yet, create one before submitting — there are free generators online, but make sure it accurately reflects your actual practices. If you're GDPR-compliant, your policy should reflect that.`),
1102
- supportChannel: supportChannelSchema.describe(`A URL or email address where users can get help with your connector. This is displayed in the Directory listing. Acceptable options:
1103
- • Email address (e.g. support@myapp.com)
1104
- • Link to a GitHub Issues page
1105
- • Link to a help center or support article
1106
- • Link to a Discord/Slack community
1107
- • Link to your documentation's troubleshooting section
1108
- Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
1109
- testingCredentials: z.string().describe(`Provide login credentials for a test account that Anthropic reviewers can use to verify your server works end-to-end. Critical requirements:
1110
- • The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
1111
- • No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
1112
- • If your service uses Google OAuth or another OAuth that requires email verification, use mcp-review@anthropic.com as the account email — Anthropic has access to this inbox.
1113
- • Credentials must remain valid for at least 30 days from submission.
1114
- • If your service requires API keys instead of a password, provide those.
1115
- Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
1116
- tools: z.array(toolDefinitionSchema).describe(`A comma-separated list of all tools your MCP server exposes. Use the format: tool_name (Human-Readable Name). The tool_name is the internal identifier (snake_case, max 64 characters). The Human-Readable Name is what users see.
1117
- Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
1118
- Reviewers test every single tool you list here — don't list tools that don't work. Also: do not have a single catch-all tool like api_request(method, endpoint) — Anthropic rejects these. Each action should be its own purpose-built tool.`),
1119
- toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
1120
- • 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
1121
- • 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
1122
- This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
1123
- testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
1124
- logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
1125
- • Format: SVG only
1126
- • Aspect ratio: square (1:1)
1127
- • Should work on a light background
1128
- • Provide via URL (Google Drive link is fine) or upload directly
1129
- Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
1130
- logoDark: z.string().optional().describe(`Optional dark-mode variant of the connector logo. Same specs as the light variant (SVG, square 1:1) but designed to read on a dark background. Leave empty if the light logo already works on dark.`),
1131
- screenshots: z.array(screenshotEntrySchema).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
1132
- • 3–5 images is ideal
1133
- • Minimum 1000px width, PNG format preferred
1134
- • Each screenshot is paired with the user prompt that produced it
1135
- • Crop to just the relevant part of the Claude interface (the tool response area)
1136
- • Show your connector doing something impressive and useful — real data, real results
1137
- • If you're an MCP App, include screenshots of your interactive UI elements
1138
- These images appear in your directory listing and are a key factor in driving user installs.`)
1086
+ 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
1087
+ from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
1088
+ The server must be publicly accessible without VPN or whitelisting.`),
1089
+ 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
1090
+ own or have the right to use this name. Max 100 characters.`),
1091
+ 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.
1092
+ PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
1093
+ oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
1094
+ phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
1095
+ 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
1096
+ claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
1097
+ categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
1098
+ 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
1099
+ (recommended); upload a custom icon only to override it.`),
1100
+ documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
1101
+ accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
1102
+ by your publish date.`),
1103
+ support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
1104
+ used to notify you of security or compliance issues, so make sure it's actively monitored.`),
1105
+ privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
1106
+ what data you collect, how you use and store it, and whether you share it with third parties.`),
1107
+ 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
1108
+ it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
1109
+ primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
1110
+ type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
1111
+ connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
1112
+ permissions'). If there are genuinely no special requirements, say so explicitly.`),
1113
+ readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
1114
+ • 'read_only': retrieves data but never modifies it.
1115
+ • 'write_only': creates or modifies data but does not read it.
1116
+ • 'read_write': both retrieves and modifies data (most common).`),
1117
+ companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
1118
+ companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
1119
+ primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
1120
+ primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
1121
+ primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
1122
+ anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
1123
+ authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
1124
+ • 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
1125
+ • 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
1126
+ • 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
1127
+ • 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
1128
+ • 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
1129
+ partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
1130
+ apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
1131
+ • 'first_party': the MCP server calls your own production APIs.
1132
+ • 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
1133
+ • 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
1134
+ personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
1135
+ No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
1136
+ sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
1137
+ No → false, Yes → true, or { other: explanation }.`),
1138
+ testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
1139
+ the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
1140
+ fully populated account.`),
1141
+ selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
1142
+ policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
1143
+ submission. Each is an attestation you are legally agreeing to by submitting.`),
1144
+ additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
1145
+ });
1146
+ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
1147
+ serverUrl: z.string().optional(),
1148
+ name: z.string().optional(),
1149
+ slug: z.string().optional(),
1150
+ oneLiner: z.string().optional(),
1151
+ description: z.string().optional(),
1152
+ iconUrl: z.string().optional(),
1153
+ documentation: z.string().optional(),
1154
+ support: z.string().optional(),
1155
+ privacyPolicy: z.string().optional(),
1156
+ companyWebsite: z.string().optional(),
1157
+ primaryContactEmail: z.string().optional(),
1158
+ categories: z.array(claudeCategorySchema).optional(),
1159
+ screenshots: z.array(screenshotDraftEntrySchema).optional()
1139
1160
  });
1140
1161
  claudeSubmissionFormDataSchema.pick({
1141
- companyName: true,
1142
- appName: true,
1143
- mcpUrlType: true,
1144
1162
  serverUrl: true,
1145
- tools: true,
1146
- readWriteCapabilities: true,
1147
- isMcpApp: true,
1148
- transportSupport: true,
1163
+ name: true,
1164
+ slug: true,
1165
+ companyName: true,
1149
1166
  primaryContactEmail: true,
1150
1167
  primaryContactName: true,
1168
+ readWriteCapabilities: true,
1151
1169
  authentication: true,
1152
- personalDataHealthAccess: true,
1153
- testedSurfaces: true
1170
+ apiOwnership: true,
1171
+ personalHealthData: true
1154
1172
  }).extend({
1155
1173
  connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
1156
- testingCredentials: claudeSubmissionFormDataSchema.shape.testingCredentials.optional()
1174
+ testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
1175
+ });
1176
+ /**
1177
+ * Narrative fields the LLM-backed generation step produces for Claude submissions.
1178
+ * This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
1179
+ * the strict form shape. Keep transforms here rather than in callers so generation leniency is
1180
+ * colocated with the Claude contract.
1181
+ */
1182
+ const claudeAiGeneratedFormDataRawSchema = z.object({
1183
+ oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
1184
+ description: claudeSubmissionFormDataSchema.shape.description,
1185
+ categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
1186
+ primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
1187
+ });
1188
+ claudeAiGeneratedFormDataRawSchema.extend({
1189
+ oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
1190
+ categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
1157
1191
  });
1158
- claudeSubmissionFormDataSchema.pick({
1159
- tagline: true,
1160
- description: true,
1161
- category: true,
1162
- testCases: true
1163
- }).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
1164
1192
  const submissionMetaFieldsSchema = z.object({
1165
1193
  id: z.string(),
1166
1194
  environmentId: z.string(),
@@ -1170,14 +1198,14 @@ const submissionMetaFieldsSchema = z.object({
1170
1198
  });
1171
1199
  const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
1172
1200
  platform: z.literal("claudeai"),
1173
- formData: claudeSubmissionFormDataSchema.partial()
1201
+ formData: claudeSubmissionDraftSchema
1174
1202
  });
1175
1203
  const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
1176
1204
  platform: z.literal("chatgpt"),
1177
- formData: chatgptSubmissionFormDataSchema.partial()
1205
+ formData: chatgptSubmissionDraftSchema
1178
1206
  });
1179
1207
  z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
1180
- z.union([claudeSubmissionFormDataSchema.partial(), chatgptSubmissionFormDataSchema.partial()]);
1208
+ z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
1181
1209
  const subscriptionPlanSchema = z.enum([
1182
1210
  "pro",
1183
1211
  "business",
@@ -1201,6 +1229,12 @@ z.object({
1201
1229
  partnerDiscount: partnerDiscountSchema.nullable()
1202
1230
  });
1203
1231
  //#endregion
1232
+ //#region src/auth-scope.ts
1233
+ /** Accepts an API key or OAuth access token (default for most routes). */
1234
+ const AUTH_SCOPE_ANY = "any";
1235
+ /** Requires a user OAuth access token; API keys are not accepted. */
1236
+ const AUTH_SCOPE_USER = "user";
1237
+ //#endregion
1204
1238
  //#region src/schemas.ts
1205
1239
  const RESERVED_KEYS = [
1206
1240
  "_HANDLER",
@@ -1236,7 +1270,10 @@ const RESERVED_KEYS = [
1236
1270
  "BUILD_ARG_START_COMMAND",
1237
1271
  "ALPIC_HOST",
1238
1272
  "ALPIC_CUSTOM_DOMAINS",
1239
- "ALPIC_INTENT_META_KEY"
1273
+ "ALPIC_INTENT_META_KEY",
1274
+ "ALPIC_FEEDBACK_META_KEY",
1275
+ "ALPIC_EVENTS_META_KEY",
1276
+ "ALPIC_IDENTIFY_META_KEY"
1240
1277
  ];
1241
1278
  const environmentVariableSchema = z.object({
1242
1279
  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"),
@@ -1429,7 +1466,8 @@ const createProjectContractV1 = oc.route({
1429
1466
  successDescription: "The project has been created successfully"
1430
1467
  }).errors({
1431
1468
  NOT_FOUND: {},
1432
- BAD_REQUEST: {}
1469
+ BAD_REQUEST: {},
1470
+ FORBIDDEN: {}
1433
1471
  }).input(z.object({
1434
1472
  teamId: z.string().optional(),
1435
1473
  name: z.string().trim().min(1).max(100),
@@ -1535,7 +1573,8 @@ const updateProjectContractV1 = oc.route({
1535
1573
  successDescription: "The project has been updated successfully"
1536
1574
  }).errors({
1537
1575
  NOT_FOUND: {},
1538
- BAD_REQUEST: {}
1576
+ BAD_REQUEST: {},
1577
+ FORBIDDEN: {}
1539
1578
  }).input(z.object({
1540
1579
  projectId: z.string().describe("The ID of the project"),
1541
1580
  name: z.string().min(1).max(100).optional().describe("The new name for the project"),
@@ -1550,10 +1589,12 @@ const deployEnvironmentContractV1 = oc.route({
1550
1589
  successDescription: "The environment has been deployed successfully"
1551
1590
  }).errors({
1552
1591
  NOT_FOUND: {},
1553
- BAD_REQUEST: {}
1592
+ BAD_REQUEST: {},
1593
+ CONFLICT: {}
1554
1594
  }).input(z.object({
1555
1595
  environmentId: z.string().describe("The ID of the environment to deploy"),
1556
- token: z.string().describe("The token to identify the source archive").optional()
1596
+ token: z.string().describe("The token to identify the source archive").optional(),
1597
+ settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
1557
1598
  })).output(deploymentSchema);
1558
1599
  const uploadDeploymentArtifactContractV1 = oc.route({
1559
1600
  path: "/v1/deployments/upload",
@@ -1590,6 +1631,21 @@ const getDeploymentContractV1 = oc.route({
1590
1631
  tags: ["deployments"],
1591
1632
  successDescription: "The deployment details"
1592
1633
  }).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
1634
+ const logEntrySchema = z.object({
1635
+ timestamp: z.coerce.date(),
1636
+ type: z.enum([
1637
+ "START",
1638
+ "END",
1639
+ "INFO",
1640
+ "ERROR",
1641
+ "WARNING",
1642
+ "DEBUG"
1643
+ ]),
1644
+ requestId: z.string(),
1645
+ content: z.string().optional(),
1646
+ method: z.string().optional(),
1647
+ durationInMs: z.number().optional()
1648
+ });
1593
1649
  const getLogsContractV1 = oc.route({
1594
1650
  path: "/v1/environments/{environmentId}/logs",
1595
1651
  method: "GET",
@@ -1614,21 +1670,7 @@ const getLogsContractV1 = oc.route({
1614
1670
  search: z.string().optional().describe("Filter pattern to search for in log content"),
1615
1671
  nextToken: z.string().optional().describe("Pagination token from a previous response")
1616
1672
  })).output(z.object({
1617
- logs: z.array(z.object({
1618
- timestamp: z.coerce.date(),
1619
- type: z.enum([
1620
- "START",
1621
- "END",
1622
- "INFO",
1623
- "ERROR",
1624
- "WARNING",
1625
- "DEBUG"
1626
- ]),
1627
- requestId: z.string(),
1628
- content: z.string().optional(),
1629
- method: z.string().optional(),
1630
- durationInMs: z.number().optional()
1631
- })),
1673
+ logs: z.array(logEntrySchema),
1632
1674
  nextToken: z.string().nullable()
1633
1675
  }));
1634
1676
  const getLatestLogsContractV1 = oc.route({
@@ -1651,21 +1693,7 @@ const getLatestLogsContractV1 = oc.route({
1651
1693
  "DEBUG"
1652
1694
  ])).optional().describe("Filter by log level"),
1653
1695
  search: z.string().optional().describe("Filter pattern to search for in log content")
1654
- })).output(z.object({ logs: z.array(z.object({
1655
- timestamp: z.coerce.date(),
1656
- type: z.enum([
1657
- "START",
1658
- "END",
1659
- "INFO",
1660
- "ERROR",
1661
- "WARNING",
1662
- "DEBUG"
1663
- ]),
1664
- requestId: z.string(),
1665
- content: z.string().optional(),
1666
- method: z.string().optional(),
1667
- durationInMs: z.number().optional()
1668
- })) }));
1696
+ })).output(z.object({ logs: z.array(logEntrySchema) }));
1669
1697
  const getDeploymentLogsContractV1 = oc.route({
1670
1698
  path: "/v1/deployments/{deploymentId}/logs",
1671
1699
  method: "GET",
@@ -1738,7 +1766,7 @@ const getTunnelTicketContractV1 = oc.route({
1738
1766
  description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
1739
1767
  tags: ["tunnels"],
1740
1768
  successDescription: "The tunnel ticket"
1741
- }).errors({ FORBIDDEN: {} }).output(z.object({
1769
+ }).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
1742
1770
  subdomain: z.string().describe("The subdomain assigned to the user"),
1743
1771
  ticket: z.string().describe("The signed tunnel ticket"),
1744
1772
  tunnelHost: z.string().describe("The tunnel host to connect to")
@@ -1892,4 +1920,4 @@ const contract = {
1892
1920
  }
1893
1921
  };
1894
1922
  //#endregion
1895
- export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
1923
+ export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alpic-ai/api",
3
- "version": "0.0.0-staging.gfbabe10",
3
+ "version": "0.0.0-staging.gfcfbb4c",
4
4
  "description": "Contract for the Alpic API",
5
5
  "type": "module",
6
6
  "main": "./dist/index.mjs",
@@ -14,22 +14,38 @@
14
14
  "files": [
15
15
  "dist"
16
16
  ],
17
+ "nx": {
18
+ "targets": {
19
+ "build": {
20
+ "cache": true,
21
+ "inputs": [
22
+ "{projectRoot}/src/**/*",
23
+ "{projectRoot}/tsdown.config.ts",
24
+ "{projectRoot}/tsconfig.json",
25
+ "^default"
26
+ ],
27
+ "outputs": [
28
+ "{projectRoot}/dist"
29
+ ]
30
+ }
31
+ }
32
+ },
17
33
  "author": "Alpic",
18
34
  "license": "ISC",
19
35
  "dependencies": {
20
- "@orpc/contract": "^1.14.6",
36
+ "@orpc/contract": "^1.14.8",
21
37
  "ms": "^2.1.3",
22
38
  "zod": "^4.4.3"
23
39
  },
24
40
  "devDependencies": {
25
- "@orpc/openapi": "^1.14.6",
26
- "@orpc/zod": "^1.14.6",
41
+ "@orpc/openapi": "^1.14.8",
42
+ "@orpc/zod": "^1.14.8",
27
43
  "@total-typescript/tsconfig": "^1.0.4",
28
44
  "@types/ms": "^2.1.0",
29
45
  "shx": "^0.4.0",
30
- "tsdown": "^0.22.2",
46
+ "tsdown": "^0.22.9",
31
47
  "typescript": "^6.0.3",
32
- "vitest": "^4.1.8",
48
+ "vitest": "^4.1.10",
33
49
  "@alpic-ai/domains": "0.0.0"
34
50
  },
35
51
  "scripts": {
@@ -38,7 +54,7 @@
38
54
  "test": "pnpm run test:unit && pnpm run test:type && pnpm run test:format",
39
55
  "test:unit": "vitest run",
40
56
  "test:format": "biome check --error-on-warnings .",
41
- "test:type": "tsc --noEmit",
57
+ "test:type": "tsgo --noEmit",
42
58
  "publish:npm": "pnpm publish --tag \"${NPM_TAG}\" --access public --no-git-checks"
43
59
  }
44
60
  }