@alpic-ai/api 0.0.0-dev.gf6f4f78 → 0.0.0-dev.gf8b5f22
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.mjs +47 -22
- package/package.json +1 -1
package/dist/index.mjs
CHANGED
|
@@ -296,6 +296,12 @@ z.object({
|
|
|
296
296
|
serverFields: serverFieldsSchema$1,
|
|
297
297
|
source: z.enum(["registry", "defaults"])
|
|
298
298
|
});
|
|
299
|
+
const clampStringField = (field) => {
|
|
300
|
+
const max = field.maxLength;
|
|
301
|
+
if (max === null) return field;
|
|
302
|
+
const clamped = z.string().overwrite((value) => value.slice(0, max)).max(max);
|
|
303
|
+
return field.description ? clamped.describe(field.description) : clamped;
|
|
304
|
+
};
|
|
299
305
|
const toolDefinitionSchema = z.object({
|
|
300
306
|
name: z.string(),
|
|
301
307
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -313,6 +319,10 @@ const positiveTestCaseSchema = z.object({
|
|
|
313
319
|
toolTriggered: z.string().optional(),
|
|
314
320
|
expectedOutput: z.string().optional()
|
|
315
321
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
322
|
+
const screenshotEntrySchema = z.object({
|
|
323
|
+
prompt: z.string(),
|
|
324
|
+
url: z.url().or(z.literal(""))
|
|
325
|
+
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
316
326
|
/** Accepts either a valid email or URL. */
|
|
317
327
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
318
328
|
const chatgptCategorySchema = z.enum([
|
|
@@ -353,7 +363,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
353
363
|
*/
|
|
354
364
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
355
365
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
356
|
-
logoDark: z.string().describe("
|
|
366
|
+
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."),
|
|
357
367
|
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
358
368
|
tagline: z.string().max(30).describe("Plain-language phrase focused on function and user value. 30 chars max."),
|
|
359
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."),
|
|
@@ -371,7 +381,7 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
371
381
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
372
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."),
|
|
373
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."),
|
|
374
|
-
screenshots: z.array(
|
|
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."),
|
|
375
385
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
376
386
|
allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
|
|
377
387
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
@@ -390,7 +400,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
390
400
|
testCases: true,
|
|
391
401
|
negativeTestCases: true,
|
|
392
402
|
toolJustifications: true
|
|
393
|
-
});
|
|
403
|
+
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
394
404
|
const claudeCategorySchema = z.enum([
|
|
395
405
|
"Business & Productivity",
|
|
396
406
|
"Communication",
|
|
@@ -402,7 +412,7 @@ const claudeCategorySchema = z.enum([
|
|
|
402
412
|
"Media & Entertainment",
|
|
403
413
|
"Commerce & Shopping"
|
|
404
414
|
]);
|
|
405
|
-
z.enum([
|
|
415
|
+
const claudeAuthenticationSchema = z.enum([
|
|
406
416
|
"No auth needed",
|
|
407
417
|
"OAuth 2.0",
|
|
408
418
|
"Custom URL"
|
|
@@ -410,28 +420,34 @@ z.enum([
|
|
|
410
420
|
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
411
421
|
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
412
422
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
413
|
-
"Read
|
|
414
|
-
"Write
|
|
415
|
-
"Read +
|
|
423
|
+
"Read Only",
|
|
424
|
+
"Write Only",
|
|
425
|
+
"Read + Write"
|
|
416
426
|
]);
|
|
417
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
|
+
]);
|
|
418
434
|
const claudeThirdPartySchema = z.enum([
|
|
419
|
-
"Web access
|
|
420
|
-
"Third-party AI model integration",
|
|
421
|
-
"Third-party data retrieval (
|
|
422
|
-
"Third-party data modification (
|
|
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)",
|
|
423
439
|
"N/A"
|
|
424
440
|
]);
|
|
425
441
|
const claudeDataHandlingSchema = z.enum([
|
|
426
442
|
"Server only accesses data explicitly requested by user",
|
|
427
443
|
"No data is stored beyond session requirements",
|
|
428
|
-
"Data transmission is encrypted (HTTPS
|
|
444
|
+
"Data transmission is encrypted (HTTPS/TLS)",
|
|
429
445
|
"GDPR compliant (if applicable)"
|
|
430
446
|
]);
|
|
431
447
|
const claudeSponsoredContentSchema = z.enum([
|
|
432
448
|
"No, there is no sponsored content or advertisements",
|
|
433
449
|
"Yes, there are banner ads or other paid visual elements",
|
|
434
|
-
"Yes, returned content or ranking is impacted by sponsorship or ad placement"
|
|
450
|
+
"Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement"
|
|
435
451
|
]);
|
|
436
452
|
/**
|
|
437
453
|
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
@@ -496,7 +512,7 @@ If 'Yes', you will also be required to provide screenshots of your UI (see Promo
|
|
|
496
512
|
Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
|
|
497
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.
|
|
498
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'.`),
|
|
499
|
-
|
|
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:
|
|
500
516
|
• Business & Productivity — project management, CRM, HR, office tools
|
|
501
517
|
• Communication — email, chat, messaging, notifications
|
|
502
518
|
• Data & Analytics — dashboards, reporting, databases, BI tools
|
|
@@ -506,12 +522,13 @@ Select 'No' for the vast majority of business/productivity/dev tools. When in do
|
|
|
506
522
|
• Health & Life Sciences — clinical, pharma, medical professional tools
|
|
507
523
|
• Media & Entertainment — content, publishing, streaming
|
|
508
524
|
• Commerce & Shopping — e-commerce, inventory, orders
|
|
509
|
-
|
|
525
|
+
Anthropic's submission form only accepts a single category.`),
|
|
510
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:
|
|
511
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.
|
|
512
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.
|
|
513
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.
|
|
514
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)."),
|
|
515
532
|
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
516
533
|
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
517
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.
|
|
@@ -551,19 +568,21 @@ Reviewers test every single tool you list here — don't list tools that don't w
|
|
|
551
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).
|
|
552
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).
|
|
553
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.`),
|
|
554
|
-
|
|
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:
|
|
555
573
|
• Format: SVG only
|
|
556
574
|
• Aspect ratio: square (1:1)
|
|
557
|
-
• Should work on
|
|
575
|
+
• Should work on a light background
|
|
558
576
|
• Provide via URL (Google Drive link is fine) or upload directly
|
|
559
577
|
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
560
|
-
|
|
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:
|
|
561
580
|
• 3–5 images is ideal
|
|
562
581
|
• Minimum 1000px width, PNG format preferred
|
|
582
|
+
• Each screenshot is paired with the user prompt that produced it
|
|
563
583
|
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
564
584
|
• Show your connector doing something impressive and useful — real data, real results
|
|
565
585
|
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
566
|
-
• Videos are also welcome
|
|
567
586
|
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
568
587
|
});
|
|
569
588
|
claudeSubmissionFormDataSchema.pick({
|
|
@@ -576,14 +595,20 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
576
595
|
isMcpApp: true,
|
|
577
596
|
transportSupport: true,
|
|
578
597
|
primaryContactEmail: true,
|
|
579
|
-
primaryContactName: true
|
|
598
|
+
primaryContactName: true,
|
|
599
|
+
authentication: true,
|
|
600
|
+
personalDataHealthAccess: true,
|
|
601
|
+
testedSurfaces: true
|
|
602
|
+
}).extend({
|
|
603
|
+
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
604
|
+
testingCredentials: claudeSubmissionFormDataSchema.shape.testingCredentials.optional()
|
|
580
605
|
});
|
|
581
606
|
claudeSubmissionFormDataSchema.pick({
|
|
582
607
|
tagline: true,
|
|
583
608
|
description: true,
|
|
584
|
-
|
|
609
|
+
category: true,
|
|
585
610
|
testCases: true
|
|
586
|
-
});
|
|
611
|
+
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
587
612
|
const submissionMetaFieldsSchema = z.object({
|
|
588
613
|
id: z.string(),
|
|
589
614
|
environmentId: z.string(),
|