@alpic-ai/api 1.142.1 → 1.142.2
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 +14 -1
- package/dist/index.mjs +134 -192
- package/package.json +3 -3
package/dist/index.d.mts
CHANGED
|
@@ -448,6 +448,7 @@ declare const contract: {
|
|
|
448
448
|
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
449
449
|
NOT_FOUND: {};
|
|
450
450
|
BAD_REQUEST: {};
|
|
451
|
+
FORBIDDEN: {};
|
|
451
452
|
}>, Record<never, never>>;
|
|
452
453
|
};
|
|
453
454
|
get: {
|
|
@@ -663,6 +664,7 @@ declare const contract: {
|
|
|
663
664
|
}, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
|
|
664
665
|
NOT_FOUND: {};
|
|
665
666
|
BAD_REQUEST: {};
|
|
667
|
+
FORBIDDEN: {};
|
|
666
668
|
}>, Record<never, never>>;
|
|
667
669
|
};
|
|
668
670
|
delete: {
|
|
@@ -938,6 +940,17 @@ declare const contract: {
|
|
|
938
940
|
type RouterInput = InferContractRouterInputs<typeof contract>;
|
|
939
941
|
type RouterOutput = InferContractRouterOutputs<typeof contract>;
|
|
940
942
|
//#endregion
|
|
943
|
+
//#region src/auth-scope.d.ts
|
|
944
|
+
/** Credential scope required by an API route. */
|
|
945
|
+
type AuthScope = "any" | "user";
|
|
946
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
947
|
+
declare const AUTH_SCOPE_ANY = "any";
|
|
948
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
949
|
+
declare const AUTH_SCOPE_USER = "user";
|
|
950
|
+
type RouteAuthMeta = {
|
|
951
|
+
authScope?: AuthScope;
|
|
952
|
+
};
|
|
953
|
+
//#endregion
|
|
941
954
|
//#region ../domains/src/platforms/schemas.d.ts
|
|
942
955
|
declare const platformSchema: z.ZodEnum<{
|
|
943
956
|
chatgpt: "chatgpt";
|
|
@@ -1017,4 +1030,4 @@ declare const serverFieldsSchema: z.ZodObject<{
|
|
|
1017
1030
|
}, z.core.$strip>>>;
|
|
1018
1031
|
}, z.core.$strip>;
|
|
1019
1032
|
//#endregion
|
|
1020
|
-
export { ApiContext, PLATFORM_LABELS, type Platform, RouterInput, RouterOutput, Runtime, Transport, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1033
|
+
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
|
@@ -584,6 +584,8 @@ const screenshotEntrySchema = z.object({
|
|
|
584
584
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
585
585
|
/** Accepts either a valid email or URL. */
|
|
586
586
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
587
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
588
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
587
589
|
const chatgptCategorySchema = z.enum([
|
|
588
590
|
"BUSINESS",
|
|
589
591
|
"COLLABORATION",
|
|
@@ -921,19 +923,19 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
921
923
|
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
924
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
923
925
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
924
|
-
companyUrl:
|
|
926
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
925
927
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
926
|
-
privacyPolicyUrl:
|
|
927
|
-
termsOfServiceUrl:
|
|
928
|
-
demoRecordingUrl:
|
|
928
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
929
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
930
|
+
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
931
|
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:
|
|
932
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
931
933
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
932
934
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
933
935
|
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
936
|
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
937
|
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."),
|
|
938
|
+
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
939
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
938
940
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
939
941
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
@@ -954,7 +956,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
954
956
|
toolJustifications: true
|
|
955
957
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
956
958
|
const claudeCategorySchema = z.enum([
|
|
957
|
-
"
|
|
959
|
+
"Productivity",
|
|
958
960
|
"Communication",
|
|
959
961
|
"Data & Analytics",
|
|
960
962
|
"Development tools",
|
|
@@ -962,205 +964,137 @@ const claudeCategorySchema = z.enum([
|
|
|
962
964
|
"Consumer Health",
|
|
963
965
|
"Health & Life Sciences",
|
|
964
966
|
"Media & Entertainment",
|
|
965
|
-
"Commerce & Shopping"
|
|
967
|
+
"Commerce & Shopping",
|
|
968
|
+
"Legal",
|
|
969
|
+
"Sales and marketing",
|
|
970
|
+
"Creative",
|
|
971
|
+
"Nonprofit",
|
|
972
|
+
"Education",
|
|
973
|
+
"Other"
|
|
966
974
|
]);
|
|
967
|
-
const
|
|
968
|
-
"No auth needed",
|
|
969
|
-
"OAuth 2.0",
|
|
970
|
-
"Custom URL"
|
|
971
|
-
]);
|
|
972
|
-
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
973
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
975
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
974
976
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
975
|
-
"
|
|
976
|
-
"
|
|
977
|
-
"
|
|
978
|
-
]);
|
|
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"
|
|
977
|
+
"read_only",
|
|
978
|
+
"write_only",
|
|
979
|
+
"read_write"
|
|
985
980
|
]);
|
|
986
|
-
const
|
|
987
|
-
"
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"
|
|
981
|
+
const claudeAuthenticationSchema = z.enum([
|
|
982
|
+
"oauth_dcr",
|
|
983
|
+
"oauth_cimd",
|
|
984
|
+
"oauth_anthropic_creds",
|
|
985
|
+
"custom_connection",
|
|
986
|
+
"none"
|
|
992
987
|
]);
|
|
993
|
-
const
|
|
994
|
-
"
|
|
995
|
-
"
|
|
996
|
-
"
|
|
997
|
-
"GDPR compliant (if applicable)"
|
|
988
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
989
|
+
"first_party",
|
|
990
|
+
"proxied",
|
|
991
|
+
"third_party"
|
|
998
992
|
]);
|
|
999
|
-
const
|
|
1000
|
-
|
|
1001
|
-
"
|
|
1002
|
-
"
|
|
993
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
994
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
995
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
996
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
997
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
998
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
999
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1000
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1001
|
+
"Public documentation for this connector will be live by the publish date."
|
|
1003
1002
|
]);
|
|
1004
1003
|
/**
|
|
1005
|
-
* Field order mirrors the
|
|
1006
|
-
*
|
|
1004
|
+
* Field order mirrors the claude.ai directory submission wizard
|
|
1005
|
+
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1006
|
+
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1007
1007
|
*/
|
|
1008
1008
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
(
|
|
1019
|
-
|
|
1020
|
-
(
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
•
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
• '
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
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.`)
|
|
1009
|
+
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
|
|
1010
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1011
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1012
|
+
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
|
|
1013
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1014
|
+
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.
|
|
1015
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1016
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1017
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1018
|
+
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
|
|
1019
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1020
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1021
|
+
iconUrl: z.url().optional().describe(`Optional custom icon URL for the directory listing. By default the favicon from your MCP URL is used (recommended).
|
|
1022
|
+
Set this only if you want to override the favicon.`),
|
|
1023
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1024
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1025
|
+
by your publish date.`),
|
|
1026
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1027
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1028
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1029
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1030
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1031
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1032
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1033
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1034
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1035
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1036
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1037
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1038
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1039
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1040
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1041
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1042
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1043
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1044
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1045
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1046
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1047
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1048
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1049
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1050
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1051
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1052
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1053
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1054
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1055
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1056
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1057
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1058
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1059
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1060
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1061
|
+
fully populated account.`),
|
|
1062
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1063
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1064
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1065
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1139
1066
|
});
|
|
1140
1067
|
claudeSubmissionFormDataSchema.pick({
|
|
1141
|
-
companyName: true,
|
|
1142
|
-
appName: true,
|
|
1143
|
-
mcpUrlType: true,
|
|
1144
1068
|
serverUrl: true,
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
transportSupport: true,
|
|
1069
|
+
name: true,
|
|
1070
|
+
slug: true,
|
|
1071
|
+
companyName: true,
|
|
1149
1072
|
primaryContactEmail: true,
|
|
1150
1073
|
primaryContactName: true,
|
|
1074
|
+
readWriteCapabilities: true,
|
|
1151
1075
|
authentication: true,
|
|
1152
|
-
|
|
1153
|
-
|
|
1076
|
+
apiOwnership: true,
|
|
1077
|
+
personalHealthData: true
|
|
1154
1078
|
}).extend({
|
|
1155
1079
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1156
|
-
|
|
1080
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1081
|
+
});
|
|
1082
|
+
/**
|
|
1083
|
+
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1084
|
+
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1085
|
+
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1086
|
+
* colocated with the Claude contract.
|
|
1087
|
+
*/
|
|
1088
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1089
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1090
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1091
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1092
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1093
|
+
});
|
|
1094
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1095
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1096
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1157
1097
|
});
|
|
1158
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1159
|
-
tagline: true,
|
|
1160
|
-
description: true,
|
|
1161
|
-
category: true,
|
|
1162
|
-
testCases: true
|
|
1163
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1164
1098
|
const submissionMetaFieldsSchema = z.object({
|
|
1165
1099
|
id: z.string(),
|
|
1166
1100
|
environmentId: z.string(),
|
|
@@ -1201,6 +1135,12 @@ z.object({
|
|
|
1201
1135
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1202
1136
|
});
|
|
1203
1137
|
//#endregion
|
|
1138
|
+
//#region src/auth-scope.ts
|
|
1139
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1140
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1141
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1142
|
+
const AUTH_SCOPE_USER = "user";
|
|
1143
|
+
//#endregion
|
|
1204
1144
|
//#region src/schemas.ts
|
|
1205
1145
|
const RESERVED_KEYS = [
|
|
1206
1146
|
"_HANDLER",
|
|
@@ -1429,7 +1369,8 @@ const createProjectContractV1 = oc.route({
|
|
|
1429
1369
|
successDescription: "The project has been created successfully"
|
|
1430
1370
|
}).errors({
|
|
1431
1371
|
NOT_FOUND: {},
|
|
1432
|
-
BAD_REQUEST: {}
|
|
1372
|
+
BAD_REQUEST: {},
|
|
1373
|
+
FORBIDDEN: {}
|
|
1433
1374
|
}).input(z.object({
|
|
1434
1375
|
teamId: z.string().optional(),
|
|
1435
1376
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1535,7 +1476,8 @@ const updateProjectContractV1 = oc.route({
|
|
|
1535
1476
|
successDescription: "The project has been updated successfully"
|
|
1536
1477
|
}).errors({
|
|
1537
1478
|
NOT_FOUND: {},
|
|
1538
|
-
BAD_REQUEST: {}
|
|
1479
|
+
BAD_REQUEST: {},
|
|
1480
|
+
FORBIDDEN: {}
|
|
1539
1481
|
}).input(z.object({
|
|
1540
1482
|
projectId: z.string().describe("The ID of the project"),
|
|
1541
1483
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
@@ -1738,7 +1680,7 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1738
1680
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1739
1681
|
tags: ["tunnels"],
|
|
1740
1682
|
successDescription: "The tunnel ticket"
|
|
1741
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1683
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1742
1684
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1743
1685
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1744
1686
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
@@ -1892,4 +1834,4 @@ const contract = {
|
|
|
1892
1834
|
}
|
|
1893
1835
|
};
|
|
1894
1836
|
//#endregion
|
|
1895
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
1837
|
+
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": "1.142.
|
|
3
|
+
"version": "1.142.2",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -27,9 +27,9 @@
|
|
|
27
27
|
"@total-typescript/tsconfig": "^1.0.4",
|
|
28
28
|
"@types/ms": "^2.1.0",
|
|
29
29
|
"shx": "^0.4.0",
|
|
30
|
-
"tsdown": "^0.22.
|
|
30
|
+
"tsdown": "^0.22.3",
|
|
31
31
|
"typescript": "^6.0.3",
|
|
32
|
-
"vitest": "^4.1.
|
|
32
|
+
"vitest": "^4.1.9",
|
|
33
33
|
"@alpic-ai/domains": "0.0.0"
|
|
34
34
|
},
|
|
35
35
|
"scripts": {
|