@alpic-ai/api 0.0.0-staging.fb9e558 → 0.0.0-staging.fc7750c

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 CHANGED
@@ -1,6 +1,278 @@
1
- import { oc } from "@orpc/contract";
2
1
  import { z } from "zod";
2
+ import { oc } from "@orpc/contract";
3
+ import ms from "ms";
4
+ const platformSchema = z.enum(["chatgpt", "claudeai"]);
5
+ const PLATFORM_LABELS = {
6
+ chatgpt: "ChatGPT",
7
+ claudeai: "Claude.ai"
8
+ };
9
+ const auditStatusSchema = z.enum([
10
+ "pending",
11
+ "partial",
12
+ "completed",
13
+ "failed"
14
+ ]);
15
+ const checkSeveritySchema = z.enum([
16
+ "error",
17
+ "warning",
18
+ "info"
19
+ ]);
20
+ const checkCategorySchema = z.enum([
21
+ "connectivity",
22
+ "tool-metadata",
23
+ "resource-metadata",
24
+ "performance",
25
+ "e2e"
26
+ ]);
27
+ const checkScopeSchema = z.enum(["server", "view"]);
28
+ const checkDetailSchema = z.object({
29
+ label: z.string(),
30
+ value: z.string().optional()
31
+ });
32
+ const checkResultSchema = z.object({
33
+ checkId: z.string(),
34
+ checkName: z.string(),
35
+ description: z.string(),
36
+ status: z.enum([
37
+ "pass",
38
+ "fail",
39
+ "skip",
40
+ "pending"
41
+ ]),
42
+ message: z.string(),
43
+ skipReason: z.string().optional(),
44
+ severity: checkSeveritySchema,
45
+ category: checkCategorySchema,
46
+ scope: checkScopeSchema,
47
+ platforms: z.array(platformSchema).readonly().optional(),
48
+ durationMs: z.number(),
49
+ details: z.array(checkDetailSchema).optional(),
50
+ hint: z.object({ text: z.string() }).optional()
51
+ });
52
+ const auditReportSchema = z.object({
53
+ schemaVersion: z.string(),
54
+ auditId: z.string(),
55
+ targetUrl: z.string(),
56
+ startedAt: z.string(),
57
+ completedAt: z.string(),
58
+ durationMs: z.number(),
59
+ results: z.array(checkResultSchema),
60
+ requiresAuth: z.boolean(),
61
+ hasViewSupport: z.boolean(),
62
+ viewPlatforms: z.array(platformSchema).readonly().optional(),
63
+ isReadyForPlatform: z.record(platformSchema, z.boolean()),
64
+ widgetScreenshotKeys: z.object({
65
+ chatgpt: z.string().optional(),
66
+ claudeai: z.string().optional()
67
+ })
68
+ });
69
+ const widgetScreenshotSchema = z.object({ url: z.string() });
70
+ const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreenshots: z.object({
71
+ chatgpt: widgetScreenshotSchema.optional(),
72
+ claudeai: widgetScreenshotSchema.optional()
73
+ }) });
74
+ z.object({
75
+ id: z.string(),
76
+ createdAt: z.coerce.date(),
77
+ environmentId: z.string(),
78
+ content: z.string(),
79
+ source: z.enum(["model", "user"])
80
+ });
81
+ z.object({
82
+ content: z.string(),
83
+ source: z.enum(["model", "user"])
84
+ });
85
+ const toolDefinitionSchema = z.object({
86
+ name: z.string(),
87
+ title: z.string().optional(),
88
+ description: z.string().optional(),
89
+ annotations: z.object({
90
+ readOnlyHint: z.boolean().optional(),
91
+ destructiveHint: z.boolean().optional(),
92
+ openWorldHint: z.boolean().optional(),
93
+ idempotentHint: z.boolean().optional()
94
+ }).optional()
95
+ });
96
+ const positiveTestCaseSchema = z.object({
97
+ scenario: z.string(),
98
+ userPrompt: z.string(),
99
+ toolTriggered: z.string().optional(),
100
+ expectedOutput: z.string().optional()
101
+ }).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
102
+ /** Accepts either a valid email or URL. */
103
+ const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
104
+ const chatgptCategorySchema = z.enum([
105
+ "BUSINESS",
106
+ "COLLABORATION",
107
+ "DESIGN",
108
+ "DEVELOPER_TOOLS",
109
+ "EDUCATION",
110
+ "ENTERTAINMENT",
111
+ "FINANCE",
112
+ "FOOD",
113
+ "LIFESTYLE",
114
+ "NEWS",
115
+ "PRODUCTIVITY",
116
+ "SHOPPING",
117
+ "TRAVEL"
118
+ ]);
119
+ const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
120
+ const chatgptAllowedCountriesSchema = z.enum(["Allow all", "Restrict to specific countries"]);
121
+ const negativeTestCaseSchema = z.object({
122
+ scenario: z.string(),
123
+ userPrompt: z.string()
124
+ }).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
125
+ const chatgptToolJustificationSchema = z.object({
126
+ toolName: z.string(),
127
+ readOnlyJustification: z.string(),
128
+ openWorldJustification: z.string(),
129
+ destructiveJustification: z.string()
130
+ }).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
131
+ const chatgptTranslationSchema = z.object({
132
+ locale: z.string(),
133
+ tagline: z.string().optional(),
134
+ description: z.string().optional()
135
+ }).describe("Locale-scoped override for tagline + description. English (US) is the default.");
136
+ /**
137
+ * Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
138
+ * When adding/removing/reordering fields, keep this in sync with the sheet.
139
+ */
140
+ const chatgptSubmissionFormDataSchema = z.object({
141
+ logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
142
+ logoDark: z.string().describe("Logo icon for dark mode. Square PNG. Same specs as the light icon."),
143
+ appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
144
+ tagline: z.string().max(30).describe("Plain-language phrase focused on function and user value. 30 chars max."),
145
+ description: z.string().describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
146
+ category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
147
+ developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
148
+ companyUrl: z.url().describe("Your company's main website URL."),
149
+ supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
150
+ privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
151
+ termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
152
+ 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."),
153
+ 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."),
154
+ serverUrl: z.url().describe("URL of the MCP server."),
155
+ authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
156
+ tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
157
+ toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
158
+ 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."),
159
+ negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
160
+ screenshots: z.array(z.url()).describe("URLs of in-app screenshots. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 4. First three are public."),
161
+ translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
162
+ allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
163
+ releaseNotes: z.string().describe("Publicly displayed on the app details page.")
164
+ });
165
+ const claudeCategorySchema = z.enum([
166
+ "Business & Productivity",
167
+ "Communication",
168
+ "Data & Analytics",
169
+ "Development tools",
170
+ "Financial Services",
171
+ "Consumer Health",
172
+ "Health & Life Sciences",
173
+ "Media & Entertainment",
174
+ "Commerce & Shopping"
175
+ ]);
176
+ z.enum([
177
+ "No auth needed",
178
+ "OAuth 2.0",
179
+ "Custom URL"
180
+ ]);
181
+ const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
182
+ z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
183
+ const claudeReadWriteCapabilitiesSchema = z.enum([
184
+ "Read only",
185
+ "Write only",
186
+ "Read + write"
187
+ ]);
188
+ const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
189
+ const claudeThirdPartySchema = z.enum([
190
+ "Web access (open web fetch / scraping / arbitrary URLs)",
191
+ "Third-party AI model integration",
192
+ "Third-party data retrieval (via workflow / aggregator)",
193
+ "Third-party data modification (via workflow / aggregator)",
194
+ "N/A"
195
+ ]);
196
+ const claudeDataHandlingSchema = z.enum([
197
+ "Server only accesses data explicitly requested by user",
198
+ "No data is stored beyond session requirements",
199
+ "Data transmission is encrypted (HTTPS / TLS)",
200
+ "GDPR compliant (if applicable)"
201
+ ]);
202
+ const claudeSponsoredContentSchema = z.enum([
203
+ "No, there is no sponsored content or advertisements",
204
+ "Yes, there are banner ads or other paid visual elements",
205
+ "Yes, returned content or ranking is impacted by sponsorship or ad placement"
206
+ ]);
207
+ /**
208
+ * Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
209
+ * When adding/removing/reordering fields, keep this in sync with the sheet.
210
+ */
211
+ const claudeSubmissionFormDataSchema = z.object({
212
+ 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."),
213
+ 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."),
214
+ 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."),
215
+ 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."),
216
+ 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."),
217
+ 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."),
218
+ appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
219
+
220
+ Rules:
221
+ (1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
222
+ (2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
223
+ (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.`),
224
+ mcpUrlType: claudeMcpUrlTypeSchema.describe("Universal URL = one URL serves all users. Custom MCP URLs = signup URL + regex matching per-user URLs."),
225
+ serverUrl: z.url().describe("Production MCP server URL (https). Derived from the project's production environment by default."),
226
+ tagline: z.string().max(55).describe("Short blurb shown below the server name. 55 chars max."),
227
+ description: z.string().describe("50–100 words describing what the server does and its key capabilities. Lives on the directory listing."),
228
+ testCases: z.array(positiveTestCaseSchema).describe("At least 3 use cases with example prompts showing the value of the connector."),
229
+ connectionRequirements: z.string().describe(`Prerequisites before connecting:
230
+ • Free/premium account
231
+ • Admin seat
232
+ • Geographic availability
233
+ • Custom instance URL
3
234
 
235
+ State 'No special requirements.' if none.`),
236
+ readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe("Inferred from the `readOnlyHint` annotations on the MCP tools."),
237
+ isMcpApp: z.boolean().describe("True if the server exposes interactive UI elements (widgets). Inferred from the MCP connection."),
238
+ thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe("Multi-select of what the server reaches out to (web, third-party AI, data aggregators)."),
239
+ dataHandling: z.array(claudeDataHandlingSchema).describe("Multi-select of data-handling practices that accurately describe the server. Cannot be inferred — user must self-declare."),
240
+ personalDataHealthAccess: z.boolean().describe("True only if the connector gives users access to their own personal health data (medical records, lab results, health metrics)."),
241
+ categories: z.array(claudeCategorySchema).describe("Multi-select of categories that best describe the server in the directory."),
242
+ sponsoredContentsOrAdvertisement: claudeSponsoredContentSchema.describe("Disclose paid promotion or sponsored content. Cannot be filled by Alpic — user must self-declare."),
243
+ transportSupport: z.array(claudeTransportSchema).describe("Multi-select of transport protocols the server supports. Anthropic recommends Streamable HTTP (SSE may be deprecated later this year)."),
244
+ serverDocumentationLink: z.url().describe("Public docs URL covering what the MCP does, setup, debugging, and self-serve support. The Alpic playground may be used."),
245
+ privacyPolicyUrl: z.url().describe("URL to your privacy policy. Mandatory and displayed alongside the directory listing."),
246
+ supportChannel: supportChannelSchema.describe("Link or email for user support (help center, GitHub issues, docs, support@…). Displayed alongside the directory listing."),
247
+ testingCredentials: z.string().describe("Credentials for reviewers to verify functionality. Required if the server uses OAuth. No 2FA. Use mcp-review@anthropic.com if an accessible email is needed."),
248
+ tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
249
+ toolTitlesAnnotationsConfirmed: z.boolean().describe("Confirmation that all tools have user-friendly titles and accurate annotations (readOnlyHint, destructiveHint, …)."),
250
+ logoLight: z.string().describe("Server/app logo for light mode. Square 1:1 aspect ratio. SVG preferred for Claude."),
251
+ screenshots: z.array(z.url()).describe("URLs of screenshots of the connector on Claude.ai or promo material. 3–5 ideal. ≥1000px width preferred, PNG, cropped to the app response. Videos welcome.")
252
+ });
253
+ const submissionMetaFieldsSchema = z.object({
254
+ id: z.string(),
255
+ environmentId: z.string(),
256
+ createdAt: z.coerce.date(),
257
+ updatedAt: z.coerce.date()
258
+ });
259
+ const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
260
+ platform: z.literal("claudeai"),
261
+ formData: claudeSubmissionFormDataSchema.partial()
262
+ });
263
+ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
264
+ platform: z.literal("chatgpt"),
265
+ formData: chatgptSubmissionFormDataSchema.partial()
266
+ });
267
+ z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
268
+ z.union([claudeSubmissionFormDataSchema.partial(), chatgptSubmissionFormDataSchema.partial()]);
269
+ const subscriptionPlanSchema = z.enum([
270
+ "pro",
271
+ "business",
272
+ "enterprise"
273
+ ]);
274
+ z.object({ plan: subscriptionPlanSchema.nullable() });
275
+ //#endregion
4
276
  //#region src/schemas.ts
5
277
  const RESERVED_KEYS = [
6
278
  "_HANDLER",
@@ -13,7 +285,11 @@ const RESERVED_KEYS = [
13
285
  "AWS_LAMBDA_FUNCTION_VERSION",
14
286
  "AWS_LAMBDA_INITIALIZATION_TYPE",
15
287
  "AWS_LAMBDA_LOG_GROUP_NAME",
288
+ "AWS_LAMBDA_LOG_STREAM_NAME",
16
289
  "AWS_ACCESS_KEY",
290
+ "AWS_ACCESS_KEY_ID",
291
+ "AWS_SECRET_ACCESS_KEY",
292
+ "AWS_SESSION_TOKEN",
17
293
  "AWS_LAMBDA_RUNTIME_API",
18
294
  "LAMBDA_TASK_ROOT",
19
295
  "LAMBDA_RUNTIME_DIR",
@@ -30,7 +306,9 @@ const RESERVED_KEYS = [
30
306
  "BUILD_ARG_BUILD_COMMAND",
31
307
  "BUILD_ARG_BUILD_OUTPUT_DIR",
32
308
  "BUILD_ARG_START_COMMAND",
33
- "ALPIC_HOST"
309
+ "ALPIC_HOST",
310
+ "ALPIC_CUSTOM_DOMAINS",
311
+ "ALPIC_INTENT_META_KEY"
34
312
  ];
35
313
  const environmentVariableSchema = z.object({
36
314
  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"),
@@ -38,6 +316,10 @@ const environmentVariableSchema = z.object({
38
316
  isSecret: z.boolean().default(false)
39
317
  });
40
318
  const environmentVariablesSchema = z.array(environmentVariableSchema);
319
+ const updateEnvironmentVariableSchema = environmentVariableSchema.partial({
320
+ value: true,
321
+ isSecret: true
322
+ });
41
323
  const buildSettingsSchema = z.object({
42
324
  installCommand: z.string().optional(),
43
325
  buildCommand: z.string().optional(),
@@ -55,7 +337,39 @@ const transportSchema = z.enum([
55
337
  "sse",
56
338
  "streamablehttp"
57
339
  ]);
58
-
340
+ const playgroundHeaderSchema = z.object({
341
+ name: z.string().min(1).max(100),
342
+ description: z.string().max(200),
343
+ isRequired: z.boolean().default(false),
344
+ isSecret: z.boolean().default(false)
345
+ });
346
+ const playgroundExamplePromptSchema = z.object({
347
+ title: z.string().min(1).max(100),
348
+ prompt: z.string().min(1).max(500)
349
+ });
350
+ const serverFieldsSchema = z.object({
351
+ $schema: z.string(),
352
+ name: z.string(),
353
+ description: z.string(),
354
+ version: z.string().optional(),
355
+ title: z.string().optional(),
356
+ websiteUrl: z.url().optional(),
357
+ icons: z.array(z.object({
358
+ src: z.url(),
359
+ mimeType: z.string().optional(),
360
+ sizes: z.array(z.string()).optional()
361
+ })).optional(),
362
+ remotes: z.array(z.object({
363
+ type: z.string(),
364
+ url: z.url().optional(),
365
+ headers: z.array(z.object({
366
+ name: z.string(),
367
+ description: z.string(),
368
+ isRequired: z.boolean().optional(),
369
+ isSecret: z.boolean().optional()
370
+ })).optional()
371
+ })).optional()
372
+ });
59
373
  //#endregion
60
374
  //#region src/api.contract.ts
61
375
  const deploymentStatusSchema = z.enum([
@@ -80,9 +394,16 @@ const deploymentSchema = z.object({
80
394
  authorUsername: z.string().nullable(),
81
395
  authorAvatarUrl: z.string().nullable(),
82
396
  startedAt: z.coerce.date().nullable(),
83
- completedAt: z.coerce.date().nullable()
397
+ completedAt: z.coerce.date().nullable(),
398
+ environmentId: z.string(),
399
+ environmentName: z.string(),
400
+ isCurrent: z.boolean(),
401
+ deploymentPageUrl: z.url().nullable()
84
402
  });
85
- const deploymentWithPageUrlSchema = deploymentSchema.extend({ deploymentPageUrl: z.url().nullable() });
403
+ const isValidLogTimeInput = (value) => {
404
+ if (ms(value) !== void 0) return true;
405
+ return !Number.isNaN(new Date(value).getTime());
406
+ };
86
407
  const createEnvironmentContractV1 = oc.route({
87
408
  path: "/v1/environments",
88
409
  method: "POST",
@@ -122,10 +443,20 @@ const getEnvironmentContractV1 = oc.route({
122
443
  createdAt: z.coerce.date(),
123
444
  projectId: z.string()
124
445
  }));
446
+ const domainSchema = z.object({
447
+ domain: z.string(),
448
+ status: z.enum([
449
+ "ongoing",
450
+ "deployed",
451
+ "failed"
452
+ ]),
453
+ createdAt: z.coerce.date()
454
+ });
125
455
  const productionEnvironmentSchema = z.object({
126
456
  id: z.string(),
127
457
  name: z.string(),
128
458
  mcpServerUrl: z.string(),
459
+ domains: z.array(domainSchema),
129
460
  latestDeployment: latestDeploymentSchema.nullable()
130
461
  });
131
462
  const environmentSchema = z.object({
@@ -168,7 +499,7 @@ const listProjectsContractV1 = oc.route({
168
499
  description: "List all projects for a team",
169
500
  tags: ["projects"],
170
501
  successDescription: "The list of projects"
171
- }).output(z.array(projectOutputSchema));
502
+ }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
172
503
  const createProjectContractV1 = oc.route({
173
504
  path: "/v1/projects",
174
505
  method: "POST",
@@ -181,7 +512,7 @@ const createProjectContractV1 = oc.route({
181
512
  BAD_REQUEST: {}
182
513
  }).input(z.object({
183
514
  teamId: z.string().optional(),
184
- name: z.string().min(1).max(100),
515
+ name: z.string().trim().min(1).max(100),
185
516
  sourceRepository: z.string().optional(),
186
517
  branchName: z.string().min(1).optional(),
187
518
  runtime: runtimeSchema,
@@ -211,8 +542,61 @@ const createProjectContractV1 = oc.route({
211
542
  startCommand: z.string().nullable(),
212
543
  createdAt: z.coerce.date()
213
544
  }));
545
+ const environmentVariableOutputSchema = z.object({
546
+ id: z.string(),
547
+ key: z.string(),
548
+ value: z.string(),
549
+ isSecret: z.boolean(),
550
+ createdAt: z.coerce.date()
551
+ });
552
+ const listEnvironmentVariablesContractV1 = oc.route({
553
+ path: "/v1/environments/{environmentId}/environment-variables",
554
+ method: "GET",
555
+ summary: "List environment variables",
556
+ description: "List all environment variables for an environment",
557
+ tags: ["environments"],
558
+ successDescription: "The list of environment variables"
559
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
560
+ const createEnvironmentVariablesContractV1 = oc.route({
561
+ path: "/v1/environments/{environmentId}/environment-variables",
562
+ method: "POST",
563
+ summary: "Add environment variables",
564
+ description: "Add one or more environment variables to an environment",
565
+ tags: ["environments"],
566
+ successDescription: "The environment variables have been added successfully"
567
+ }).errors({
568
+ NOT_FOUND: {},
569
+ BAD_REQUEST: {}
570
+ }).input(z.object({
571
+ environmentId: z.string().describe("The ID of the environment"),
572
+ environmentVariables: environmentVariablesSchema
573
+ })).output(z.object({ success: z.literal(true) }));
574
+ const updateEnvironmentVariableContractV1 = oc.route({
575
+ path: "/v1/environment-variables/{environmentVariableId}",
576
+ method: "PATCH",
577
+ summary: "Update an environment variable",
578
+ description: "Update an environment variable by ID",
579
+ tags: ["environments"],
580
+ successDescription: "The environment variable has been updated successfully"
581
+ }).errors({
582
+ NOT_FOUND: {},
583
+ BAD_REQUEST: {}
584
+ }).input(z.object({
585
+ environmentVariableId: z.string().describe("The ID of the environment variable"),
586
+ key: environmentVariableSchema.shape.key,
587
+ value: environmentVariableSchema.shape.value.optional(),
588
+ isSecret: environmentVariableSchema.shape.isSecret.optional()
589
+ })).output(z.object({ success: z.literal(true) }));
590
+ const deleteEnvironmentVariableContractV1 = oc.route({
591
+ path: "/v1/environment-variables/{environmentVariableId}",
592
+ method: "DELETE",
593
+ summary: "Delete an environment variable",
594
+ description: "Delete an environment variable by ID",
595
+ tags: ["environments"],
596
+ successDescription: "The environment variable has been deleted successfully"
597
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
214
598
  const deleteProjectContractV1 = oc.route({
215
- path: "/v1/projects/:projectId",
599
+ path: "/v1/projects/{projectId}",
216
600
  method: "DELETE",
217
601
  summary: "Delete a project",
218
602
  description: "Delete a project and all its environments",
@@ -247,7 +631,7 @@ const deployEnvironmentContractV1 = oc.route({
247
631
  }).input(z.object({
248
632
  environmentId: z.string().describe("The ID of the environment to deploy"),
249
633
  token: z.string().describe("The token to identify the source archive").optional()
250
- })).output(deploymentWithPageUrlSchema);
634
+ })).output(deploymentSchema);
251
635
  const uploadDeploymentArtifactContractV1 = oc.route({
252
636
  path: "/v1/deployments/upload",
253
637
  method: "POST",
@@ -256,21 +640,22 @@ const uploadDeploymentArtifactContractV1 = oc.route({
256
640
  tags: ["deployments"],
257
641
  successDescription: "The presigned upload URL has been generated successfully"
258
642
  }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
259
- uploadUrl: z.string().url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
643
+ uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
260
644
  token: z.string().describe("Token to identify the source archive"),
261
645
  expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
262
646
  }));
263
- const listProjectDeploymentsContractV1 = oc.route({
647
+ const listDeploymentsContractV1 = oc.route({
264
648
  path: "/v1/projects/{projectId}/deployments",
265
649
  method: "GET",
266
650
  summary: "List project deployments",
267
651
  description: "List all deployments for a project",
268
652
  tags: ["deployments"],
269
653
  successDescription: "The list of deployments"
270
- }).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.array(deploymentSchema.extend({
271
- isCurrent: z.boolean(),
272
- environmentId: z.string()
273
- })));
654
+ }).errors({ NOT_FOUND: {} }).input(z.object({
655
+ projectId: z.string().describe("The ID of the project"),
656
+ status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
657
+ environmentId: z.string().optional().describe("Filter by environment ID")
658
+ })).output(z.array(deploymentSchema));
274
659
  const getDeploymentContractV1 = oc.route({
275
660
  path: "/v1/deployments/{deploymentId}",
276
661
  method: "GET",
@@ -278,7 +663,83 @@ const getDeploymentContractV1 = oc.route({
278
663
  description: "Get a deployment by ID",
279
664
  tags: ["deployments"],
280
665
  successDescription: "The deployment details"
281
- }).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentWithPageUrlSchema);
666
+ }).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
667
+ const getLogsContractV1 = oc.route({
668
+ path: "/v1/environments/{environmentId}/logs",
669
+ method: "GET",
670
+ summary: "Get logs",
671
+ description: "Get logs for an environment",
672
+ tags: ["environments"],
673
+ successDescription: "The logs"
674
+ }).errors({
675
+ NOT_FOUND: {},
676
+ BAD_REQUEST: {}
677
+ }).input(z.object({
678
+ environmentId: z.string().describe("The ID of the environment"),
679
+ since: z.string().refine(isValidLogTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." }).optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
680
+ until: z.string().refine(isValidLogTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." }).optional().describe("End time — ISO 8601 or relative"),
681
+ limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
682
+ level: z.array(z.enum([
683
+ "INFO",
684
+ "ERROR",
685
+ "WARNING",
686
+ "DEBUG"
687
+ ])).optional().describe("Filter by log level"),
688
+ search: z.string().optional().describe("Filter pattern to search for in log content"),
689
+ nextToken: z.string().optional().describe("Pagination token from a previous response")
690
+ })).output(z.object({
691
+ logs: z.array(z.object({
692
+ timestamp: z.coerce.date(),
693
+ type: z.enum([
694
+ "START",
695
+ "END",
696
+ "INFO",
697
+ "ERROR",
698
+ "WARNING",
699
+ "DEBUG"
700
+ ]),
701
+ requestId: z.string(),
702
+ content: z.string().optional(),
703
+ method: z.string().optional(),
704
+ durationInMs: z.number().optional()
705
+ })),
706
+ nextToken: z.string().nullable()
707
+ }));
708
+ const getLatestLogsContractV1 = oc.route({
709
+ path: "/v1/environments/{environmentId}/latest-logs",
710
+ method: "GET",
711
+ summary: "Get latest logs",
712
+ description: "Get the N most recent logs for an environment",
713
+ tags: ["environments"],
714
+ successDescription: "The latest logs"
715
+ }).errors({
716
+ NOT_FOUND: {},
717
+ BAD_REQUEST: {}
718
+ }).input(z.object({
719
+ environmentId: z.string().describe("The ID of the environment"),
720
+ limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
721
+ level: z.array(z.enum([
722
+ "INFO",
723
+ "ERROR",
724
+ "WARNING",
725
+ "DEBUG"
726
+ ])).optional().describe("Filter by log level"),
727
+ search: z.string().optional().describe("Filter pattern to search for in log content")
728
+ })).output(z.object({ logs: z.array(z.object({
729
+ timestamp: z.coerce.date(),
730
+ type: z.enum([
731
+ "START",
732
+ "END",
733
+ "INFO",
734
+ "ERROR",
735
+ "WARNING",
736
+ "DEBUG"
737
+ ]),
738
+ requestId: z.string(),
739
+ content: z.string().optional(),
740
+ method: z.string().optional(),
741
+ durationInMs: z.number().optional()
742
+ })) }));
282
743
  const getDeploymentLogsContractV1 = oc.route({
283
744
  path: "/v1/deployments/{deploymentId}/logs",
284
745
  method: "GET",
@@ -342,14 +803,129 @@ const listTeamsContractV1 = oc.route({
342
803
  id: z.string(),
343
804
  name: z.string(),
344
805
  createdAt: z.coerce.date(),
345
- hasStripeAccount: z.boolean(),
346
- hasActiveSubscription: z.boolean()
806
+ hasStripeAccount: z.boolean()
347
807
  })));
808
+ const getTunnelTicketContractV1 = oc.route({
809
+ path: "/v1/tunnels/ticket",
810
+ method: "GET",
811
+ summary: "Get a tunnel ticket",
812
+ description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
813
+ tags: ["tunnels"],
814
+ successDescription: "The tunnel ticket"
815
+ }).output(z.object({
816
+ subdomain: z.string().describe("The subdomain assigned to the user"),
817
+ ticket: z.string().describe("The signed tunnel ticket"),
818
+ tunnelHost: z.string().describe("The tunnel host to connect to")
819
+ }));
820
+ const publishServerContractV1 = oc.route({
821
+ path: "/v1/distribution/publish",
822
+ method: "POST",
823
+ summary: "Publish a server to the MCP registry",
824
+ tags: ["distribution"],
825
+ successDescription: "The server has been published successfully"
826
+ }).errors({
827
+ NOT_FOUND: {},
828
+ BAD_REQUEST: {}
829
+ }).input(z.object({
830
+ projectId: z.string(),
831
+ domain: z.string(),
832
+ title: z.string().min(1).max(100),
833
+ description: z.string().min(1).max(100),
834
+ websiteUrl: z.url().max(255).optional(),
835
+ iconSrc: z.url().max(255).optional(),
836
+ dryRun: z.boolean().optional()
837
+ })).output(z.object({ serverFields: serverFieldsSchema }));
838
+ const getServerInfoContractV1 = oc.route({
839
+ path: "/v1/distribution/get",
840
+ method: "GET",
841
+ summary: "Get server info",
842
+ description: "Get info about a server",
843
+ tags: ["distribution"],
844
+ successDescription: "The server info"
845
+ }).errors({
846
+ NOT_FOUND: {},
847
+ BAD_REQUEST: {}
848
+ }).input(z.object({
849
+ projectId: z.string(),
850
+ domain: z.string()
851
+ })).output(z.object({ serverFields: serverFieldsSchema }));
852
+ const playgroundServerMetadataOutputSchema = z.object({
853
+ name: z.string(),
854
+ description: z.string(),
855
+ headers: z.array(z.object({
856
+ name: z.string(),
857
+ description: z.string(),
858
+ isRequired: z.boolean(),
859
+ isSecret: z.boolean()
860
+ })),
861
+ examplePrompts: z.array(playgroundExamplePromptSchema)
862
+ });
863
+ const playgroundOutputSchema = z.object({
864
+ isPlaygroundEnabled: z.boolean(),
865
+ serverMetadata: playgroundServerMetadataOutputSchema.nullable()
866
+ });
867
+ const getPlaygroundContractV1 = oc.route({
868
+ path: "/v1/environments/{environmentId}/playground",
869
+ method: "GET",
870
+ summary: "Get playground configuration",
871
+ description: "Get the playground configuration for an environment",
872
+ tags: ["environments"],
873
+ successDescription: "The playground configuration"
874
+ }).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
875
+ const upsertPlaygroundContractV1 = oc.route({
876
+ path: "/v1/environments/{environmentId}/playground",
877
+ method: "PUT",
878
+ summary: "Update playground configuration",
879
+ description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
880
+ tags: ["environments"],
881
+ successDescription: "The updated playground configuration"
882
+ }).errors({
883
+ NOT_FOUND: {},
884
+ BAD_REQUEST: {}
885
+ }).input(z.object({
886
+ environmentId: z.string().describe("The ID of the environment"),
887
+ isPlaygroundEnabled: z.boolean().optional(),
888
+ name: z.string().min(1).max(100).optional(),
889
+ description: z.string().min(1).max(500).optional(),
890
+ headers: z.array(playgroundHeaderSchema).optional(),
891
+ examplePrompts: z.array(playgroundExamplePromptSchema).max(3).optional()
892
+ })).output(playgroundOutputSchema);
893
+ const createBeaconContractV1 = oc.route({
894
+ path: "/v1/beacon/audits",
895
+ method: "POST",
896
+ summary: "Create a beacon audit",
897
+ description: "Audit an MCP server for spec compliance and AI client compatibility",
898
+ tags: ["beacon"],
899
+ successDescription: "The audit has been created"
900
+ }).errors({
901
+ NOT_FOUND: {},
902
+ BAD_REQUEST: {}
903
+ }).input(z.object({
904
+ targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
905
+ teamId: z.string().optional().describe("The team ID to associate the audit with"),
906
+ projectId: z.string().optional().describe("The project ID to associate the audit with"),
907
+ excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
908
+ })).output(z.object({ id: z.string() }));
909
+ const getBeaconContractV1 = oc.route({
910
+ path: "/v1/beacon/audits/{auditId}",
911
+ method: "GET",
912
+ summary: "Get a beacon audit",
913
+ description: "Get a beacon audit by ID, including the report if completed",
914
+ tags: ["beacon"],
915
+ successDescription: "The audit details"
916
+ }).errors({ NOT_FOUND: {} }).input(z.object({ auditId: z.string().describe("The ID of the audit") })).output(z.object({
917
+ id: z.string(),
918
+ targetUrl: z.string(),
919
+ status: auditStatusSchema,
920
+ durationMs: z.number().nullable(),
921
+ createdAt: z.coerce.date(),
922
+ report: auditReportWithScreenshotsSchema.nullable()
923
+ }));
348
924
  const contract = {
349
925
  teams: { list: { v1: listTeamsContractV1 } },
350
926
  analytics: { get: { v1: getProjectAnalyticsContractV1 } },
351
927
  deployments: {
352
- list: { v1: listProjectDeploymentsContractV1 },
928
+ list: { v1: listDeploymentsContractV1 },
353
929
  get: { v1: getDeploymentContractV1 },
354
930
  uploadArtifact: { v1: uploadDeploymentArtifactContractV1 },
355
931
  getLogs: { v1: getDeploymentLogsContractV1 }
@@ -357,7 +933,15 @@ const contract = {
357
933
  environments: {
358
934
  create: { v1: createEnvironmentContractV1 },
359
935
  get: { v1: getEnvironmentContractV1 },
360
- deploy: { v1: deployEnvironmentContractV1 }
936
+ deploy: { v1: deployEnvironmentContractV1 },
937
+ getLogs: { v1: getLogsContractV1 },
938
+ getLatestLogs: { v1: getLatestLogsContractV1 }
939
+ },
940
+ environmentVariables: {
941
+ list: { v1: listEnvironmentVariablesContractV1 },
942
+ create: { v1: createEnvironmentVariablesContractV1 },
943
+ update: { v1: updateEnvironmentVariableContractV1 },
944
+ delete: { v1: deleteEnvironmentVariableContractV1 }
361
945
  },
362
946
  projects: {
363
947
  update: { v1: updateProjectContractV1 },
@@ -365,8 +949,20 @@ const contract = {
365
949
  list: { v1: listProjectsContractV1 },
366
950
  create: { v1: createProjectContractV1 },
367
951
  delete: { v1: deleteProjectContractV1 }
952
+ },
953
+ playground: {
954
+ get: { v1: getPlaygroundContractV1 },
955
+ upsert: { v1: upsertPlaygroundContractV1 }
956
+ },
957
+ tunnels: { getTicket: { v1: getTunnelTicketContractV1 } },
958
+ distribution: {
959
+ publish: { v1: publishServerContractV1 },
960
+ get: { v1: getServerInfoContractV1 }
961
+ },
962
+ beacon: {
963
+ create: { v1: createBeaconContractV1 },
964
+ get: { v1: getBeaconContractV1 }
368
965
  }
369
966
  };
370
-
371
967
  //#endregion
372
- export { buildSettingsSchema, contract, createEnvironmentContractV1, environmentVariableSchema, environmentVariablesSchema, runtimeSchema, transportSchema };
968
+ export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };