@alpic-ai/api 0.0.0-dev.ge5d5ea3 → 0.0.0-dev.ge60ca52
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 +6298 -84
- package/dist/index.mjs +1045 -395
- package/package.json +26 -10
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.30.0_supports-color@7.2.0_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -169,11 +169,22 @@ z$1.object({
|
|
|
169
169
|
token: z$1.string(),
|
|
170
170
|
token_type_hint: z$1.string().optional()
|
|
171
171
|
}).strip();
|
|
172
|
-
|
|
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
|
+
"cato",
|
|
183
|
+
"cloudflare",
|
|
184
|
+
"fastly"
|
|
185
|
+
];
|
|
186
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
187
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
188
|
const auditStatusSchema = z.enum([
|
|
178
189
|
"pending",
|
|
179
190
|
"partial",
|
|
@@ -246,6 +257,25 @@ z.object({
|
|
|
246
257
|
clientSecret: z.string(),
|
|
247
258
|
clientScopes: z.array(z.string())
|
|
248
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
249
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
250
280
|
"ongoing",
|
|
251
281
|
"deployed",
|
|
@@ -273,34 +303,51 @@ const deploymentSummarySchema = z.object({
|
|
|
273
303
|
createdAt: z.coerce.date(),
|
|
274
304
|
updatedAt: z.coerce.date()
|
|
275
305
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
306
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
307
|
const publicEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.literal(true),
|
|
309
|
+
oAuthMetadata: z.strictObject({})
|
|
310
|
+
});
|
|
311
|
+
/** Protected environment whose external resource metadata URL is returned in the WWW-Authenticate header on the first 401; everything after is handled outside the MCP server scope. */
|
|
312
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
313
|
+
allowsAnonymous: z.boolean(),
|
|
314
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
315
|
+
scope: z.string().optional()
|
|
316
|
+
});
|
|
317
|
+
/** Protected environment whose own /.well-known/oauth-protected-resource endpoint points at an external authorization server; everything after is handled outside the MCP server scope. */
|
|
318
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
319
|
+
allowsAnonymous: z.boolean(),
|
|
320
|
+
oAuthMetadata: z.object({
|
|
321
|
+
externalAuthorizationServerUrl: z.url(),
|
|
322
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
323
|
+
}),
|
|
324
|
+
scope: z.string().optional()
|
|
325
|
+
});
|
|
326
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
|
+
const standaloneEnvironmentSchema = z.object({
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
329
|
+
oAuthMetadata: z.object({
|
|
330
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
331
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
332
|
+
}),
|
|
333
|
+
scope: z.string().optional()
|
|
334
|
+
});
|
|
335
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
336
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
337
|
+
allowsAnonymous: z.literal(false),
|
|
338
|
+
oAuthMetadata: z.strictObject({}),
|
|
339
|
+
scope: z.string().optional()
|
|
340
|
+
});
|
|
341
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
342
|
isPublic: z.literal(true),
|
|
283
343
|
oAuthMetadata: z.undefined().optional()
|
|
284
344
|
});
|
|
285
|
-
|
|
286
|
-
* Protected environment with an external resource metadata URL
|
|
287
|
-
*
|
|
288
|
-
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
289
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
290
|
-
*/
|
|
291
|
-
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
345
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
346
|
isPublic: z.literal(false),
|
|
293
347
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
348
|
scope: z.string().optional()
|
|
295
349
|
});
|
|
296
|
-
|
|
297
|
-
* Protected environment with an external authorization server URL
|
|
298
|
-
*
|
|
299
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
300
|
-
* An external authorization server URL is returned when requesting the endpoint.
|
|
301
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
302
|
-
*/
|
|
303
|
-
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
350
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
351
|
isPublic: z.literal(false),
|
|
305
352
|
oAuthMetadata: z.object({
|
|
306
353
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +355,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
355
|
}),
|
|
309
356
|
scope: z.string().optional()
|
|
310
357
|
});
|
|
311
|
-
|
|
312
|
-
* Standalone protected environment
|
|
313
|
-
*
|
|
314
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
315
|
-
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
316
|
-
*/
|
|
317
|
-
const standaloneEnvironmentSchema = z.object({
|
|
358
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
359
|
isPublic: z.literal(false),
|
|
319
360
|
oAuthMetadata: z.object({
|
|
320
361
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +363,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
363
|
}),
|
|
323
364
|
scope: z.string().optional()
|
|
324
365
|
});
|
|
325
|
-
|
|
326
|
-
* Protected environment without OAuth discovery
|
|
327
|
-
*
|
|
328
|
-
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
329
|
-
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
330
|
-
* are advertised. Clients must obtain credentials out-of-band.
|
|
331
|
-
*/
|
|
332
|
-
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
366
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
367
|
isPublic: z.literal(false),
|
|
334
368
|
oAuthMetadata: z.strictObject({}),
|
|
335
369
|
scope: z.string().optional()
|
|
@@ -339,11 +373,21 @@ z.union([
|
|
|
339
373
|
externalResourceMetadataEnvironmentSchema,
|
|
340
374
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
375
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
376
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
377
|
+
legacyPublicEnvironmentSchema,
|
|
378
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
379
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
380
|
+
legacyStandaloneEnvironmentSchema,
|
|
381
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
382
|
+
]);
|
|
383
|
+
const playgroundModelSchema = z.enum([
|
|
384
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
385
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
386
|
+
"openai.gpt-5.4",
|
|
387
|
+
"openai.gpt-5.5"
|
|
343
388
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
389
|
const environmentDomainSchema = z.object({
|
|
346
|
-
|
|
390
|
+
name: z.string(),
|
|
347
391
|
status: z.enum([
|
|
348
392
|
"ongoing",
|
|
349
393
|
"deployed",
|
|
@@ -361,6 +405,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
405
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
406
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
407
|
isPlaygroundEnabled: z.boolean(),
|
|
408
|
+
playgroundModel: playgroundModelSchema,
|
|
364
409
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
410
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
411
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -370,11 +415,20 @@ const environmentSchema$1 = z.object({
|
|
|
370
415
|
});
|
|
371
416
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
372
417
|
z.object({
|
|
418
|
+
sessionReplayEnabled: z.boolean(),
|
|
419
|
+
collectRequestPayload: z.boolean(),
|
|
420
|
+
collectResponsePayload: z.boolean(),
|
|
421
|
+
collectErrorMessage: z.boolean(),
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
424
|
+
});
|
|
425
|
+
const feedbackSchema = z.object({
|
|
373
426
|
id: z.string(),
|
|
374
427
|
createdAt: z.coerce.date(),
|
|
375
428
|
environmentId: z.string(),
|
|
376
429
|
content: z.string(),
|
|
377
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
378
432
|
});
|
|
379
433
|
z.object({
|
|
380
434
|
content: z.string(),
|
|
@@ -390,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
390
444
|
"pink",
|
|
391
445
|
"gray"
|
|
392
446
|
]);
|
|
393
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
394
448
|
const intentCategorySchema = z.object({
|
|
395
449
|
id: z.string(),
|
|
396
450
|
createdAt: z.coerce.date(),
|
|
@@ -398,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
398
452
|
name: z.string(),
|
|
399
453
|
color: intentCategoryColorSchema
|
|
400
454
|
});
|
|
401
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
402
456
|
id: z.string(),
|
|
403
457
|
name: z.string(),
|
|
404
458
|
color: intentCategoryColorSchema,
|
|
@@ -410,6 +464,7 @@ z.object({
|
|
|
410
464
|
environmentId: z.string(),
|
|
411
465
|
toolName: z.string(),
|
|
412
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
413
468
|
categories: z.array(intentCategorySchema)
|
|
414
469
|
});
|
|
415
470
|
const signalCategorySchema = z.object({
|
|
@@ -468,12 +523,262 @@ z.object({
|
|
|
468
523
|
createdAt: z.coerce.date(),
|
|
469
524
|
updatedAt: z.coerce.date()
|
|
470
525
|
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
471
536
|
z.enum([
|
|
472
537
|
"INFO",
|
|
473
538
|
"WARNING",
|
|
474
539
|
"DEBUG",
|
|
475
540
|
"ERROR"
|
|
476
541
|
]);
|
|
542
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
|
+
const MCP_CLIENT_GROUPS = [
|
|
544
|
+
{
|
|
545
|
+
id: "claude_code",
|
|
546
|
+
label: "Claude Code",
|
|
547
|
+
vendor: "anthropic",
|
|
548
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
id: "claude",
|
|
552
|
+
label: "Claude",
|
|
553
|
+
vendor: "anthropic",
|
|
554
|
+
rawNames: [
|
|
555
|
+
"Anthropic/ClaudeAI",
|
|
556
|
+
"claude-ai",
|
|
557
|
+
"claude",
|
|
558
|
+
"Claude",
|
|
559
|
+
"claude-desktop",
|
|
560
|
+
"claude-desktop-3p"
|
|
561
|
+
]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "claude_mobile",
|
|
565
|
+
label: "Claude mobile",
|
|
566
|
+
vendor: "anthropic",
|
|
567
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
id: "claude_cowork",
|
|
571
|
+
label: "Claude Cowork",
|
|
572
|
+
vendor: "anthropic",
|
|
573
|
+
rawNames: ["Anthropic/Cowork"]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "claude_toolbox",
|
|
577
|
+
label: "Claude Toolbox",
|
|
578
|
+
vendor: "anthropic",
|
|
579
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "anthropic_api",
|
|
583
|
+
label: "Anthropic API",
|
|
584
|
+
vendor: "anthropic",
|
|
585
|
+
rawNames: ["Anthropic/API"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "anthropic_connector_refresh",
|
|
589
|
+
label: "Anthropic (connector refresh)",
|
|
590
|
+
vendor: "anthropic",
|
|
591
|
+
rawNames: ["Anthropic"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "codex",
|
|
595
|
+
label: "Codex",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: [
|
|
598
|
+
"codex-mcp-client",
|
|
599
|
+
"codex",
|
|
600
|
+
"Codex",
|
|
601
|
+
"codex-cli",
|
|
602
|
+
"openai-mcp (Codex)"
|
|
603
|
+
]
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
id: "chatgpt",
|
|
607
|
+
label: "ChatGPT",
|
|
608
|
+
vendor: "openai",
|
|
609
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
id: "openai_responses_api",
|
|
613
|
+
label: "OpenAI Responses API",
|
|
614
|
+
vendor: "openai",
|
|
615
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
id: "openai_agent_builder",
|
|
619
|
+
label: "OpenAI Agent Builder",
|
|
620
|
+
vendor: "openai",
|
|
621
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
id: "openai_other",
|
|
625
|
+
label: "OpenAI Other",
|
|
626
|
+
vendor: "openai",
|
|
627
|
+
rawNames: ["openai-mcp"]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cursor",
|
|
631
|
+
label: "Cursor",
|
|
632
|
+
vendor: "cursor",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"cursor-vscode",
|
|
635
|
+
"Cursor",
|
|
636
|
+
"cursor"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "cline",
|
|
641
|
+
label: "Cline",
|
|
642
|
+
vendor: "cline",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Cline",
|
|
645
|
+
"cline",
|
|
646
|
+
"@cline/core"
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
id: "github_copilot",
|
|
651
|
+
label: "GitHub Copilot",
|
|
652
|
+
vendor: "githubCopilot",
|
|
653
|
+
rawNames: [
|
|
654
|
+
"Copilot",
|
|
655
|
+
"github-copilot-developer",
|
|
656
|
+
"Copilot MCP Gateway",
|
|
657
|
+
"Xcode/copilot-xcode"
|
|
658
|
+
]
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
id: "gemini_cli",
|
|
662
|
+
label: "Gemini CLI",
|
|
663
|
+
vendor: "google",
|
|
664
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "antigravity",
|
|
668
|
+
label: "Antigravity",
|
|
669
|
+
vendor: "google",
|
|
670
|
+
rawNames: ["antigravity-client"]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "gemini",
|
|
674
|
+
label: "Gemini",
|
|
675
|
+
vendor: "google",
|
|
676
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
id: "windsurf",
|
|
680
|
+
label: "Windsurf",
|
|
681
|
+
vendor: "windsurf",
|
|
682
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
id: "mistral",
|
|
686
|
+
label: "Mistral / Le Chat",
|
|
687
|
+
vendor: "mistral",
|
|
688
|
+
rawNames: ["Mistral"],
|
|
689
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "n8n",
|
|
693
|
+
label: "n8n",
|
|
694
|
+
vendor: "n8n",
|
|
695
|
+
rawNames: [
|
|
696
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
698
|
+
"n8n"
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "alpic_playground",
|
|
703
|
+
label: "Alpic Playground",
|
|
704
|
+
vendor: "alpic",
|
|
705
|
+
rawNames: ["alpic-playground", "playground"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "opencode",
|
|
709
|
+
label: "opencode",
|
|
710
|
+
vendor: "opencode",
|
|
711
|
+
rawNames: ["opencode"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "zed",
|
|
715
|
+
label: "Zed",
|
|
716
|
+
vendor: "zed",
|
|
717
|
+
rawNames: ["Zed", "zed"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "zapier",
|
|
721
|
+
label: "Zapier",
|
|
722
|
+
vendor: "zapier",
|
|
723
|
+
rawNames: ["Zapier", "zapier"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "make",
|
|
727
|
+
label: "Make",
|
|
728
|
+
vendor: "make",
|
|
729
|
+
rawNames: ["Make", "make"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "librechat",
|
|
733
|
+
label: "LibreChat",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["LibreChat", "librechat"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "jan",
|
|
739
|
+
label: "Jan",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: ["Jan", "jan"]
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
id: "goose",
|
|
745
|
+
label: "goose",
|
|
746
|
+
vendor: "mcp",
|
|
747
|
+
rawNames: ["goose", "Goose"]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
id: "mcphost",
|
|
751
|
+
label: "mcphost",
|
|
752
|
+
vendor: "mcp",
|
|
753
|
+
rawNames: ["mcphost"]
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
id: "mcporter",
|
|
757
|
+
label: "mcporter",
|
|
758
|
+
vendor: "mcp",
|
|
759
|
+
rawNames: ["mcporter"]
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
id: "rmcp",
|
|
763
|
+
label: "rmcp",
|
|
764
|
+
vendor: "mcp",
|
|
765
|
+
rawNames: ["rmcp"]
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
id: "unnamed_client",
|
|
769
|
+
label: "Unnamed client",
|
|
770
|
+
vendor: "mcp",
|
|
771
|
+
rawNames: [
|
|
772
|
+
"mcp",
|
|
773
|
+
"unknown",
|
|
774
|
+
""
|
|
775
|
+
]
|
|
776
|
+
}
|
|
777
|
+
];
|
|
778
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
779
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
780
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
781
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
477
782
|
const runtimeSchema = z.enum([
|
|
478
783
|
"python3.13",
|
|
479
784
|
"python3.14",
|
|
@@ -502,15 +807,27 @@ z.object({
|
|
|
502
807
|
environments: z.array(environmentWithDomainsSchema),
|
|
503
808
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
504
809
|
});
|
|
810
|
+
const domainFailureReasonSchema = z.enum([
|
|
811
|
+
"caa",
|
|
812
|
+
"dns",
|
|
813
|
+
"invalid_domain",
|
|
814
|
+
"other"
|
|
815
|
+
]);
|
|
816
|
+
const projectDomainMappingSchema = z.object({
|
|
817
|
+
pathPrefix: z.string(),
|
|
818
|
+
environment: environmentSchema$1
|
|
819
|
+
});
|
|
505
820
|
z.object({
|
|
506
|
-
|
|
821
|
+
name: z.string(),
|
|
507
822
|
createdAt: z.coerce.date(),
|
|
508
823
|
status: z.enum([
|
|
509
824
|
"ongoing",
|
|
510
825
|
"deployed",
|
|
511
826
|
"failed"
|
|
512
827
|
]),
|
|
513
|
-
|
|
828
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
829
|
+
environment: environmentSchema$1,
|
|
830
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
514
831
|
});
|
|
515
832
|
const serverFieldsSchema$1 = z.object({
|
|
516
833
|
$schema: z.string(),
|
|
@@ -539,15 +856,7 @@ z.object({
|
|
|
539
856
|
serverFields: serverFieldsSchema$1,
|
|
540
857
|
source: z.enum(["registry", "defaults"])
|
|
541
858
|
});
|
|
542
|
-
/**
|
|
543
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
544
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
545
|
-
*
|
|
546
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
547
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
548
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
549
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
550
|
-
*/
|
|
859
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
551
860
|
const clampStringField = (field) => {
|
|
552
861
|
const max = field.maxLength;
|
|
553
862
|
if (max === null) return field;
|
|
@@ -555,6 +864,10 @@ const clampStringField = (field) => {
|
|
|
555
864
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
556
865
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
557
866
|
};
|
|
867
|
+
const unboundedArrayField = (field) => {
|
|
868
|
+
const unbounded = z.array(field.element);
|
|
869
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
870
|
+
};
|
|
558
871
|
const toolDefinitionSchema = z.object({
|
|
559
872
|
name: z.string(),
|
|
560
873
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -567,17 +880,31 @@ const toolDefinitionSchema = z.object({
|
|
|
567
880
|
}).optional()
|
|
568
881
|
});
|
|
569
882
|
const positiveTestCaseSchema = z.object({
|
|
570
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
571
|
-
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
883
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
884
|
+
userPrompt: z.string().min(1).describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
572
885
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
573
886
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
574
|
-
}).
|
|
887
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
888
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
889
|
+
scenario: z.string().optional(),
|
|
890
|
+
userPrompt: z.string().optional()
|
|
891
|
+
});
|
|
892
|
+
const blankPositiveTestCase = () => ({
|
|
893
|
+
scenario: "",
|
|
894
|
+
userPrompt: "",
|
|
895
|
+
toolTriggered: "",
|
|
896
|
+
expectedOutput: ""
|
|
897
|
+
});
|
|
898
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
575
899
|
const screenshotEntrySchema = z.object({
|
|
576
900
|
prompt: z.string(),
|
|
577
|
-
url: z.url()
|
|
901
|
+
url: z.url()
|
|
578
902
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
903
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
579
904
|
/** Accepts either a valid email or URL. */
|
|
580
905
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
906
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
907
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
581
908
|
const chatgptCategorySchema = z.enum([
|
|
582
909
|
"BUSINESS",
|
|
583
910
|
"COLLABORATION",
|
|
@@ -881,20 +1208,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
881
1208
|
"zh-TW"
|
|
882
1209
|
]);
|
|
883
1210
|
const negativeTestCaseSchema = z.object({
|
|
884
|
-
scenario: z.string(),
|
|
885
|
-
userPrompt: z.string()
|
|
886
|
-
}).
|
|
1211
|
+
scenario: z.string().min(1),
|
|
1212
|
+
userPrompt: z.string().min(1)
|
|
1213
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1214
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1215
|
+
scenario: z.string().optional(),
|
|
1216
|
+
userPrompt: z.string().optional()
|
|
1217
|
+
});
|
|
1218
|
+
const blankNegativeTestCase = () => ({
|
|
1219
|
+
scenario: "",
|
|
1220
|
+
userPrompt: ""
|
|
1221
|
+
});
|
|
1222
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
887
1223
|
const chatgptToolJustificationSchema = z.object({
|
|
888
1224
|
toolName: z.string(),
|
|
889
1225
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
890
1226
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
891
1227
|
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
892
1228
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
893
|
-
/**
|
|
894
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
895
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
896
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
897
|
-
*/
|
|
1229
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
898
1230
|
const chatgptTaglineSchema = z.string().max(30);
|
|
899
1231
|
const chatgptDescriptionSchema = z.string();
|
|
900
1232
|
const chatgptTranslationSchema = z.object({
|
|
@@ -903,10 +1235,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
903
1235
|
description: chatgptDescriptionSchema
|
|
904
1236
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
905
1237
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
906
|
-
/**
|
|
907
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
908
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
909
|
-
*/
|
|
1238
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
910
1239
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
911
1240
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
912
1241
|
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."),
|
|
@@ -915,40 +1244,64 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
915
1244
|
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)."),
|
|
916
1245
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
917
1246
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
918
|
-
companyUrl:
|
|
1247
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
919
1248
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
920
|
-
privacyPolicyUrl:
|
|
921
|
-
termsOfServiceUrl:
|
|
922
|
-
demoRecordingUrl:
|
|
1249
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1250
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1251
|
+
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."),
|
|
923
1252
|
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."),
|
|
924
|
-
serverUrl:
|
|
1253
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
925
1254
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
926
1255
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
927
1256
|
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."),
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
1257
|
+
skills: z.array(chatgptSkillSchema).optional().describe("Skills the server exposes over MCP (auto-populated from the production server's manifest). Left unset when the server does not advertise the skills extension, which is a different state from advertising it and exposing none."),
|
|
1258
|
+
testCases: z.array(positiveTestCaseSchema).length(5).describe("Exactly 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
1259
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 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."),
|
|
1260
|
+
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."),
|
|
931
1261
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
932
1262
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
933
1263
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
934
1264
|
});
|
|
935
|
-
chatgptSubmissionFormDataSchema.
|
|
1265
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1266
|
+
tagline: z.string().optional(),
|
|
1267
|
+
companyUrl: z.string().optional(),
|
|
1268
|
+
supportChannel: z.string().optional(),
|
|
1269
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1270
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1271
|
+
demoRecordingUrl: z.string().optional(),
|
|
1272
|
+
serverUrl: z.string().optional(),
|
|
1273
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1274
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1275
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1276
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1277
|
+
});
|
|
1278
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1279
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
936
1280
|
appName: true,
|
|
937
1281
|
developerName: true,
|
|
938
1282
|
serverUrl: true,
|
|
939
1283
|
tools: true,
|
|
1284
|
+
skills: true,
|
|
940
1285
|
authentication: true
|
|
941
1286
|
});
|
|
942
|
-
|
|
1287
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1288
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
943
1289
|
tagline: true,
|
|
944
1290
|
description: true,
|
|
945
1291
|
category: true,
|
|
946
1292
|
testCases: true,
|
|
947
1293
|
negativeTestCases: true,
|
|
948
1294
|
toolJustifications: true
|
|
949
|
-
}).extend({
|
|
1295
|
+
}).extend({
|
|
1296
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1297
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1298
|
+
}).extend({
|
|
1299
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1300
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1301
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1302
|
+
});
|
|
950
1303
|
const claudeCategorySchema = z.enum([
|
|
951
|
-
"
|
|
1304
|
+
"Productivity",
|
|
952
1305
|
"Communication",
|
|
953
1306
|
"Data & Analytics",
|
|
954
1307
|
"Development tools",
|
|
@@ -956,222 +1309,222 @@ const claudeCategorySchema = z.enum([
|
|
|
956
1309
|
"Consumer Health",
|
|
957
1310
|
"Health & Life Sciences",
|
|
958
1311
|
"Media & Entertainment",
|
|
959
|
-
"Commerce & Shopping"
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
"
|
|
963
|
-
"
|
|
964
|
-
"
|
|
1312
|
+
"Commerce & Shopping",
|
|
1313
|
+
"Legal",
|
|
1314
|
+
"Sales and marketing",
|
|
1315
|
+
"Creative",
|
|
1316
|
+
"Nonprofit",
|
|
1317
|
+
"Education",
|
|
1318
|
+
"Other"
|
|
965
1319
|
]);
|
|
966
|
-
const
|
|
967
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1320
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
968
1321
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
969
|
-
"
|
|
970
|
-
"
|
|
971
|
-
"
|
|
1322
|
+
"read_only",
|
|
1323
|
+
"write_only",
|
|
1324
|
+
"read_write"
|
|
972
1325
|
]);
|
|
973
|
-
const
|
|
974
|
-
|
|
975
|
-
"
|
|
976
|
-
"
|
|
977
|
-
"
|
|
978
|
-
"
|
|
979
|
-
]);
|
|
980
|
-
const claudeThirdPartySchema = z.enum([
|
|
981
|
-
"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)",
|
|
982
|
-
"Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
|
|
983
|
-
"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)",
|
|
984
|
-
"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)",
|
|
985
|
-
"N/A"
|
|
1326
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1327
|
+
"oauth_dcr",
|
|
1328
|
+
"oauth_cimd",
|
|
1329
|
+
"oauth_anthropic_creds",
|
|
1330
|
+
"custom_connection",
|
|
1331
|
+
"none"
|
|
986
1332
|
]);
|
|
987
|
-
const
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"GDPR compliant (if applicable)"
|
|
1333
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1334
|
+
"first_party",
|
|
1335
|
+
"proxied",
|
|
1336
|
+
"third_party"
|
|
992
1337
|
]);
|
|
993
|
-
const
|
|
994
|
-
|
|
995
|
-
"
|
|
996
|
-
"
|
|
1338
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1339
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1340
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1341
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1342
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1343
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1344
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1345
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1346
|
+
"Public documentation for this connector will be live by the publish date."
|
|
997
1347
|
]);
|
|
998
|
-
/**
|
|
999
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
1000
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
1001
|
-
*/
|
|
1348
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1002
1349
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
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
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
• '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.
|
|
1081
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
1082
|
-
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:
|
|
1083
|
-
• What the connector does and its key capabilities
|
|
1084
|
-
• How to connect/set it up (step by step)
|
|
1085
|
-
• What each tool does (or at least the main ones)
|
|
1086
|
-
• How to troubleshoot common issues
|
|
1087
|
-
• A support contact or channel
|
|
1088
|
-
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.`),
|
|
1089
|
-
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:
|
|
1090
|
-
• What data you collect (and how)
|
|
1091
|
-
• How you use the collected data
|
|
1092
|
-
• Where and how long you store it
|
|
1093
|
-
• Whether you share data with third parties (and who)
|
|
1094
|
-
• How users can contact you about data concerns
|
|
1095
|
-
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.`),
|
|
1096
|
-
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:
|
|
1097
|
-
• Email address (e.g. support@myapp.com)
|
|
1098
|
-
• Link to a GitHub Issues page
|
|
1099
|
-
• Link to a help center or support article
|
|
1100
|
-
• Link to a Discord/Slack community
|
|
1101
|
-
• Link to your documentation's troubleshooting section
|
|
1102
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1103
|
-
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:
|
|
1104
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
1105
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
1106
|
-
• 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.
|
|
1107
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
1108
|
-
• If your service requires API keys instead of a password, provide those.
|
|
1109
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
1110
|
-
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.
|
|
1111
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
1112
|
-
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.`),
|
|
1113
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
1114
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
1115
|
-
• '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).
|
|
1116
|
-
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.`),
|
|
1117
|
-
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.`),
|
|
1118
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
1119
|
-
• Format: SVG only
|
|
1120
|
-
• Aspect ratio: square (1:1)
|
|
1121
|
-
• Should work on a light background
|
|
1122
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
1123
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
1124
|
-
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.`),
|
|
1125
|
-
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:
|
|
1126
|
-
• 3–5 images is ideal
|
|
1127
|
-
• Minimum 1000px width, PNG format preferred
|
|
1128
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
1129
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
1130
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
1131
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
1132
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1133
|
-
});
|
|
1134
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1135
|
-
companyName: true,
|
|
1136
|
-
appName: true,
|
|
1137
|
-
mcpUrlType: true,
|
|
1350
|
+
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
|
|
1351
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1352
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1353
|
+
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
|
|
1354
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1355
|
+
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.
|
|
1356
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1357
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1358
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1359
|
+
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
|
|
1360
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1361
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1362
|
+
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
|
|
1363
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1364
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1365
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1366
|
+
by your publish date.`),
|
|
1367
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1368
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1369
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1370
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1371
|
+
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
|
|
1372
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1373
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1374
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1375
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1376
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1377
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1378
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1379
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1380
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1381
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1382
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1383
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1384
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1385
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1386
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1387
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1388
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1389
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1390
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1391
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1392
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1393
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1394
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1395
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1396
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1397
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1398
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1399
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1400
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1401
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1402
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1403
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1404
|
+
fully populated account.`),
|
|
1405
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1406
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1407
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1408
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1409
|
+
});
|
|
1410
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1411
|
+
serverUrl: z.string().optional(),
|
|
1412
|
+
name: z.string().optional(),
|
|
1413
|
+
slug: z.string().optional(),
|
|
1414
|
+
oneLiner: z.string().optional(),
|
|
1415
|
+
description: z.string().optional(),
|
|
1416
|
+
iconUrl: z.string().optional(),
|
|
1417
|
+
documentation: z.string().optional(),
|
|
1418
|
+
support: z.string().optional(),
|
|
1419
|
+
privacyPolicy: z.string().optional(),
|
|
1420
|
+
companyWebsite: z.string().optional(),
|
|
1421
|
+
primaryContactEmail: z.string().optional(),
|
|
1422
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1423
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1424
|
+
});
|
|
1425
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1426
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1138
1427
|
serverUrl: true,
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
transportSupport: true,
|
|
1428
|
+
name: true,
|
|
1429
|
+
slug: true,
|
|
1430
|
+
companyName: true,
|
|
1143
1431
|
primaryContactEmail: true,
|
|
1144
1432
|
primaryContactName: true,
|
|
1433
|
+
readWriteCapabilities: true,
|
|
1145
1434
|
authentication: true,
|
|
1146
|
-
|
|
1147
|
-
|
|
1435
|
+
apiOwnership: true,
|
|
1436
|
+
personalHealthData: true
|
|
1148
1437
|
}).extend({
|
|
1149
1438
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1150
|
-
|
|
1439
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1440
|
+
});
|
|
1441
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1442
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1443
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1444
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1445
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1446
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1447
|
+
});
|
|
1448
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1449
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1450
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1451
|
+
});
|
|
1452
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1453
|
+
const byField = {};
|
|
1454
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1455
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1456
|
+
return byField;
|
|
1457
|
+
}
|
|
1458
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1459
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1460
|
+
"pass",
|
|
1461
|
+
"fail",
|
|
1462
|
+
"unverified"
|
|
1463
|
+
]);
|
|
1464
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1465
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1466
|
+
claudeai: ["privacyPolicy"]
|
|
1467
|
+
};
|
|
1468
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1469
|
+
const policyDisclosureSchema = z.enum([
|
|
1470
|
+
"dataCategories",
|
|
1471
|
+
"purposesOfUse",
|
|
1472
|
+
"recipients",
|
|
1473
|
+
"retention"
|
|
1474
|
+
]);
|
|
1475
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1476
|
+
field: verifiableUrlFieldSchema,
|
|
1477
|
+
url: z.string(),
|
|
1478
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1479
|
+
reason: z.string(),
|
|
1480
|
+
concerns: z.array(z.string()).optional(),
|
|
1481
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1482
|
+
});
|
|
1483
|
+
const urlVerificationSchema = z.object({
|
|
1484
|
+
verifiedAt: z.coerce.date(),
|
|
1485
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1486
|
+
});
|
|
1487
|
+
const pageKindSchema = z.enum([
|
|
1488
|
+
"expectedDocument",
|
|
1489
|
+
"errorPage",
|
|
1490
|
+
"loginWall",
|
|
1491
|
+
"parkedDomain",
|
|
1492
|
+
"comingSoon",
|
|
1493
|
+
"marketingPage",
|
|
1494
|
+
"unrelatedDocument"
|
|
1495
|
+
]);
|
|
1496
|
+
z.object({
|
|
1497
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1498
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1499
|
+
missingDisclosures: z.array(policyDisclosureSchema).describe("For a privacy policy only: which of the four required disclosures the text does not cover. Empty for every other page kind.")
|
|
1151
1500
|
});
|
|
1152
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1153
|
-
tagline: true,
|
|
1154
|
-
description: true,
|
|
1155
|
-
category: true,
|
|
1156
|
-
testCases: true
|
|
1157
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1158
1501
|
const submissionMetaFieldsSchema = z.object({
|
|
1159
1502
|
id: z.string(),
|
|
1160
1503
|
environmentId: z.string(),
|
|
1161
1504
|
auditId: z.string().nullable(),
|
|
1505
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1162
1506
|
createdAt: z.coerce.date(),
|
|
1163
1507
|
updatedAt: z.coerce.date()
|
|
1164
1508
|
});
|
|
1165
1509
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1166
1510
|
platform: z.literal("claudeai"),
|
|
1167
|
-
formData:
|
|
1511
|
+
formData: claudeSubmissionDraftSchema,
|
|
1512
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1168
1513
|
});
|
|
1169
1514
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1170
1515
|
platform: z.literal("chatgpt"),
|
|
1171
|
-
formData:
|
|
1516
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1517
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1172
1518
|
});
|
|
1173
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1174
|
-
z.union([
|
|
1519
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1520
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1521
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1522
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1523
|
+
z.literal([
|
|
1524
|
+
100,
|
|
1525
|
+
75,
|
|
1526
|
+
50
|
|
1527
|
+
]);
|
|
1175
1528
|
const subscriptionPlanSchema = z.enum([
|
|
1176
1529
|
"pro",
|
|
1177
1530
|
"business",
|
|
@@ -1183,17 +1536,105 @@ const customerCreditsSchema = z.object({
|
|
|
1183
1536
|
expiresAt: z.number().nullable(),
|
|
1184
1537
|
currency: z.string()
|
|
1185
1538
|
});
|
|
1186
|
-
const customerUsageSchema = z.object({
|
|
1187
|
-
amountInCents: z.number(),
|
|
1188
|
-
currency: z.string(),
|
|
1189
|
-
periodEnd: z.number()
|
|
1190
|
-
});
|
|
1191
1539
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1192
1540
|
z.object({
|
|
1193
1541
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1194
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1195
1542
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1196
1543
|
});
|
|
1544
|
+
const metricsQueueEventSchema = z.object({
|
|
1545
|
+
ts: z.number().int(),
|
|
1546
|
+
method: z.string(),
|
|
1547
|
+
tool: z.string().nullable(),
|
|
1548
|
+
client: z.string(),
|
|
1549
|
+
sessionId: z.string().nullable(),
|
|
1550
|
+
durationMs: z.number().int(),
|
|
1551
|
+
outputTokens: z.number().int().nullable(),
|
|
1552
|
+
errorType: z.enum([
|
|
1553
|
+
"mcp_error",
|
|
1554
|
+
"tool_error",
|
|
1555
|
+
"timeout"
|
|
1556
|
+
]).nullable(),
|
|
1557
|
+
errorCode: z.number().int().nullable()
|
|
1558
|
+
});
|
|
1559
|
+
z.object({
|
|
1560
|
+
v: z.literal(1),
|
|
1561
|
+
envId: z.string(),
|
|
1562
|
+
events: z.array(metricsQueueEventSchema)
|
|
1563
|
+
});
|
|
1564
|
+
z.object({ v: z.number() });
|
|
1565
|
+
const telemetrySignalSchema = z.enum([
|
|
1566
|
+
"logs",
|
|
1567
|
+
"metrics",
|
|
1568
|
+
"traces"
|
|
1569
|
+
]);
|
|
1570
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1571
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1572
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1573
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1574
|
+
const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
|
|
1575
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1576
|
+
id: z.string(),
|
|
1577
|
+
name: otlpHeaderNameSchema,
|
|
1578
|
+
value: otlpHeaderValueSchema,
|
|
1579
|
+
isSecret: z.boolean()
|
|
1580
|
+
});
|
|
1581
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1582
|
+
"credentials",
|
|
1583
|
+
"wrong-path",
|
|
1584
|
+
"wrong-protocol",
|
|
1585
|
+
"invalid-payload",
|
|
1586
|
+
"partial-rejection",
|
|
1587
|
+
"blocked-target",
|
|
1588
|
+
"timeout",
|
|
1589
|
+
"unreachable",
|
|
1590
|
+
"receiver-error",
|
|
1591
|
+
"unexpected-status"
|
|
1592
|
+
]);
|
|
1593
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1594
|
+
z.object({
|
|
1595
|
+
id: z.string(),
|
|
1596
|
+
signal: telemetrySignalSchema,
|
|
1597
|
+
endpoint: otlpEndpointSchema,
|
|
1598
|
+
protocol: otlpProtocolSchema,
|
|
1599
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1600
|
+
status: telemetryDestinationStatusSchema,
|
|
1601
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1602
|
+
});
|
|
1603
|
+
const webhookEventSchema = z.enum([
|
|
1604
|
+
"deployment.succeeded",
|
|
1605
|
+
"deployment.failed",
|
|
1606
|
+
"deployment.canceled"
|
|
1607
|
+
]);
|
|
1608
|
+
const webhookDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1609
|
+
const webhookDeliveryFailureReasonSchema = z.enum([
|
|
1610
|
+
"credentials",
|
|
1611
|
+
"blocked-target",
|
|
1612
|
+
"timeout",
|
|
1613
|
+
"unreachable",
|
|
1614
|
+
"receiver-error",
|
|
1615
|
+
"unexpected-status"
|
|
1616
|
+
]);
|
|
1617
|
+
const webhookUrlSchema = z.string().trim().min(1, "Enter a webhook URL").max(2048).refine((value) => {
|
|
1618
|
+
try {
|
|
1619
|
+
return new URL(value).protocol === "https:";
|
|
1620
|
+
} catch {
|
|
1621
|
+
return false;
|
|
1622
|
+
}
|
|
1623
|
+
}, "Enter a valid HTTPS URL");
|
|
1624
|
+
const webhookEventsSchema = z.array(webhookEventSchema).min(1, "Select at least one event").refine((events) => new Set(events).size === events.length, "Events must be unique");
|
|
1625
|
+
z.object({
|
|
1626
|
+
id: z.string(),
|
|
1627
|
+
url: webhookUrlSchema,
|
|
1628
|
+
events: webhookEventsSchema,
|
|
1629
|
+
status: webhookDestinationStatusSchema,
|
|
1630
|
+
lastFailureReason: webhookDeliveryFailureReasonSchema.nullable()
|
|
1631
|
+
}).extend({ secret: z.string().min(1) });
|
|
1632
|
+
//#endregion
|
|
1633
|
+
//#region src/auth-scope.ts
|
|
1634
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1635
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1636
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1637
|
+
const AUTH_SCOPE_USER = "user";
|
|
1197
1638
|
//#endregion
|
|
1198
1639
|
//#region src/schemas.ts
|
|
1199
1640
|
const RESERVED_KEYS = [
|
|
@@ -1230,7 +1671,10 @@ const RESERVED_KEYS = [
|
|
|
1230
1671
|
"BUILD_ARG_START_COMMAND",
|
|
1231
1672
|
"ALPIC_HOST",
|
|
1232
1673
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1233
|
-
"ALPIC_INTENT_META_KEY"
|
|
1674
|
+
"ALPIC_INTENT_META_KEY",
|
|
1675
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1676
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1677
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1234
1678
|
];
|
|
1235
1679
|
const environmentVariableSchema = z.object({
|
|
1236
1680
|
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"),
|
|
@@ -1283,6 +1727,14 @@ const serverFieldsSchema = z.object({
|
|
|
1283
1727
|
});
|
|
1284
1728
|
//#endregion
|
|
1285
1729
|
//#region src/api.contract.ts
|
|
1730
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1731
|
+
try {
|
|
1732
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1733
|
+
return true;
|
|
1734
|
+
} catch {
|
|
1735
|
+
return false;
|
|
1736
|
+
}
|
|
1737
|
+
};
|
|
1286
1738
|
const deploymentStatusSchema = z.enum([
|
|
1287
1739
|
"ongoing",
|
|
1288
1740
|
"deployed",
|
|
@@ -1311,21 +1763,20 @@ const deploymentSchema = z.object({
|
|
|
1311
1763
|
isCurrent: z.boolean(),
|
|
1312
1764
|
deploymentPageUrl: z.url().nullable()
|
|
1313
1765
|
});
|
|
1314
|
-
const
|
|
1766
|
+
const isValidTimeInput = (value) => {
|
|
1315
1767
|
if (ms(value) !== void 0) return true;
|
|
1316
1768
|
return !Number.isNaN(new Date(value).getTime());
|
|
1317
1769
|
};
|
|
1318
|
-
const
|
|
1770
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1771
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1772
|
+
const createEnvironmentContractV1 = base.route({
|
|
1319
1773
|
path: "/v1/environments",
|
|
1320
1774
|
method: "POST",
|
|
1321
1775
|
summary: "Create an environment",
|
|
1322
1776
|
description: "Create an environment for a project",
|
|
1323
1777
|
tags: ["environments"],
|
|
1324
1778
|
successDescription: "The environment has been created successfully"
|
|
1325
|
-
}).errors({
|
|
1326
|
-
NOT_FOUND: {},
|
|
1327
|
-
BAD_REQUEST: {}
|
|
1328
|
-
}).input(z.object({
|
|
1779
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1329
1780
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1330
1781
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1331
1782
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1338,7 +1789,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1338
1789
|
createdAt: z.coerce.date(),
|
|
1339
1790
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1340
1791
|
}));
|
|
1341
|
-
const getEnvironmentContractV1 =
|
|
1792
|
+
const getEnvironmentContractV1 = base.route({
|
|
1342
1793
|
path: "/v1/environments/{environmentId}",
|
|
1343
1794
|
method: "GET",
|
|
1344
1795
|
summary: "Get an environment",
|
|
@@ -1354,6 +1805,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1354
1805
|
createdAt: z.coerce.date(),
|
|
1355
1806
|
projectId: z.string()
|
|
1356
1807
|
}));
|
|
1808
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1809
|
+
path: "/v1/environments/{environmentId}",
|
|
1810
|
+
method: "DELETE",
|
|
1811
|
+
summary: "Delete an environment",
|
|
1812
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1813
|
+
tags: ["environments"],
|
|
1814
|
+
successDescription: "The environment has been deleted successfully"
|
|
1815
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1357
1816
|
const domainSchema = z.object({
|
|
1358
1817
|
domain: z.string(),
|
|
1359
1818
|
status: z.enum([
|
|
@@ -1395,7 +1854,7 @@ const projectOutputSchema = z.object({
|
|
|
1395
1854
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1396
1855
|
environments: z.array(environmentSchema)
|
|
1397
1856
|
});
|
|
1398
|
-
const getProjectContractV1 =
|
|
1857
|
+
const getProjectContractV1 = base.route({
|
|
1399
1858
|
path: "/v1/projects/{projectId}",
|
|
1400
1859
|
method: "GET",
|
|
1401
1860
|
summary: "Get a project",
|
|
@@ -1403,18 +1862,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1403
1862
|
tags: ["projects"],
|
|
1404
1863
|
successDescription: "The project details"
|
|
1405
1864
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1406
|
-
const listProjectsContractV1 =
|
|
1865
|
+
const listProjectsContractV1 = base.route({
|
|
1407
1866
|
path: "/v1/projects",
|
|
1408
1867
|
method: "GET",
|
|
1409
1868
|
summary: "List projects",
|
|
1410
1869
|
description: "List all projects for a team",
|
|
1411
1870
|
tags: ["projects"],
|
|
1412
1871
|
successDescription: "The list of projects"
|
|
1413
|
-
}).errors({
|
|
1414
|
-
|
|
1415
|
-
BAD_REQUEST: {}
|
|
1416
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1417
|
-
const createProjectContractV1 = oc.route({
|
|
1872
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1873
|
+
const createProjectContractV1 = base.route({
|
|
1418
1874
|
path: "/v1/projects",
|
|
1419
1875
|
method: "POST",
|
|
1420
1876
|
summary: "Create a project",
|
|
@@ -1423,7 +1879,7 @@ const createProjectContractV1 = oc.route({
|
|
|
1423
1879
|
successDescription: "The project has been created successfully"
|
|
1424
1880
|
}).errors({
|
|
1425
1881
|
NOT_FOUND: {},
|
|
1426
|
-
|
|
1882
|
+
FORBIDDEN: {}
|
|
1427
1883
|
}).input(z.object({
|
|
1428
1884
|
teamId: z.string().optional(),
|
|
1429
1885
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1463,7 +1919,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1463
1919
|
isSecret: z.boolean(),
|
|
1464
1920
|
createdAt: z.coerce.date()
|
|
1465
1921
|
});
|
|
1466
|
-
const listEnvironmentVariablesContractV1 =
|
|
1922
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1467
1923
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1468
1924
|
method: "GET",
|
|
1469
1925
|
summary: "List environment variables",
|
|
@@ -1471,48 +1927,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1471
1927
|
tags: ["environments"],
|
|
1472
1928
|
successDescription: "The list of environment variables"
|
|
1473
1929
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1474
|
-
const createEnvironmentVariablesContractV1 =
|
|
1930
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1475
1931
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1476
1932
|
method: "POST",
|
|
1477
1933
|
summary: "Add environment variables",
|
|
1478
1934
|
description: "Add one or more environment variables to an environment",
|
|
1479
1935
|
tags: ["environments"],
|
|
1480
1936
|
successDescription: "The environment variables have been added successfully"
|
|
1481
|
-
}).errors({
|
|
1482
|
-
NOT_FOUND: {},
|
|
1483
|
-
BAD_REQUEST: {}
|
|
1484
|
-
}).input(z.object({
|
|
1937
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1485
1938
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1486
1939
|
environmentVariables: environmentVariablesSchema
|
|
1487
1940
|
})).output(z.object({ success: z.literal(true) }));
|
|
1488
|
-
const updateEnvironmentVariableContractV1 =
|
|
1941
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1489
1942
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1490
1943
|
method: "PATCH",
|
|
1491
1944
|
summary: "Update an environment variable",
|
|
1492
1945
|
description: "Update an environment variable by ID",
|
|
1493
1946
|
tags: ["environments"],
|
|
1494
1947
|
successDescription: "The environment variable has been updated successfully"
|
|
1495
|
-
}).errors({
|
|
1496
|
-
NOT_FOUND: {},
|
|
1497
|
-
BAD_REQUEST: {}
|
|
1498
|
-
}).input(z.object({
|
|
1948
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1499
1949
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1500
1950
|
key: environmentVariableSchema.shape.key,
|
|
1501
1951
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1502
1952
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1503
1953
|
})).output(z.object({ success: z.literal(true) }));
|
|
1504
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1954
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1505
1955
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1506
1956
|
method: "DELETE",
|
|
1507
1957
|
summary: "Delete an environment variable",
|
|
1508
1958
|
description: "Delete an environment variable by ID",
|
|
1509
1959
|
tags: ["environments"],
|
|
1510
1960
|
successDescription: "The environment variable has been deleted successfully"
|
|
1511
|
-
}).errors({
|
|
1512
|
-
|
|
1513
|
-
BAD_REQUEST: {}
|
|
1514
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1515
|
-
const deleteProjectContractV1 = oc.route({
|
|
1961
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1962
|
+
const deleteProjectContractV1 = base.route({
|
|
1516
1963
|
path: "/v1/projects/{projectId}",
|
|
1517
1964
|
method: "DELETE",
|
|
1518
1965
|
summary: "Delete a project",
|
|
@@ -1520,7 +1967,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1520
1967
|
tags: ["projects"],
|
|
1521
1968
|
successDescription: "The project has been deleted successfully"
|
|
1522
1969
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1523
|
-
const updateProjectContractV1 =
|
|
1970
|
+
const updateProjectContractV1 = base.route({
|
|
1524
1971
|
path: "/v1/projects/{projectId}",
|
|
1525
1972
|
method: "PATCH",
|
|
1526
1973
|
summary: "Update a project",
|
|
@@ -1529,13 +1976,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1529
1976
|
successDescription: "The project has been updated successfully"
|
|
1530
1977
|
}).errors({
|
|
1531
1978
|
NOT_FOUND: {},
|
|
1532
|
-
|
|
1979
|
+
FORBIDDEN: {}
|
|
1533
1980
|
}).input(z.object({
|
|
1534
1981
|
projectId: z.string().describe("The ID of the project"),
|
|
1535
1982
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1536
1983
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1537
1984
|
})).output(projectOutputSchema);
|
|
1538
|
-
const deployEnvironmentContractV1 =
|
|
1985
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1539
1986
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1540
1987
|
method: "POST",
|
|
1541
1988
|
summary: "Deploy an environment",
|
|
@@ -1544,27 +1991,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1544
1991
|
successDescription: "The environment has been deployed successfully"
|
|
1545
1992
|
}).errors({
|
|
1546
1993
|
NOT_FOUND: {},
|
|
1547
|
-
|
|
1994
|
+
CONFLICT: {}
|
|
1548
1995
|
}).input(z.object({
|
|
1549
1996
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1550
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1997
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1998
|
+
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.")
|
|
1551
1999
|
})).output(deploymentSchema);
|
|
1552
|
-
const uploadDeploymentArtifactContractV1 =
|
|
2000
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1553
2001
|
path: "/v1/deployments/upload",
|
|
1554
2002
|
method: "POST",
|
|
1555
2003
|
summary: "Upload deployment artifacts",
|
|
1556
2004
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1557
2005
|
tags: ["deployments"],
|
|
1558
2006
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1559
|
-
}).errors({
|
|
1560
|
-
NOT_FOUND: {},
|
|
1561
|
-
BAD_REQUEST: {}
|
|
1562
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
2007
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1563
2008
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1564
2009
|
token: z.string().describe("Token to identify the source archive"),
|
|
1565
2010
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1566
2011
|
}));
|
|
1567
|
-
const listDeploymentsContractV1 =
|
|
2012
|
+
const listDeploymentsContractV1 = base.route({
|
|
1568
2013
|
path: "/v1/projects/{projectId}/deployments",
|
|
1569
2014
|
method: "GET",
|
|
1570
2015
|
summary: "List project deployments",
|
|
@@ -1576,7 +2021,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1576
2021
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1577
2022
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1578
2023
|
})).output(z.array(deploymentSchema));
|
|
1579
|
-
const getDeploymentContractV1 =
|
|
2024
|
+
const getDeploymentContractV1 = base.route({
|
|
1580
2025
|
path: "/v1/deployments/{deploymentId}",
|
|
1581
2026
|
method: "GET",
|
|
1582
2027
|
summary: "Get a deployment",
|
|
@@ -1584,20 +2029,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1584
2029
|
tags: ["deployments"],
|
|
1585
2030
|
successDescription: "The deployment details"
|
|
1586
2031
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1587
|
-
const
|
|
2032
|
+
const logEntrySchema = z.object({
|
|
2033
|
+
timestamp: z.coerce.date(),
|
|
2034
|
+
type: z.enum([
|
|
2035
|
+
"START",
|
|
2036
|
+
"END",
|
|
2037
|
+
"INFO",
|
|
2038
|
+
"ERROR",
|
|
2039
|
+
"WARNING",
|
|
2040
|
+
"DEBUG"
|
|
2041
|
+
]),
|
|
2042
|
+
requestId: z.string(),
|
|
2043
|
+
content: z.string().optional(),
|
|
2044
|
+
method: z.string().optional(),
|
|
2045
|
+
durationInMs: z.number().optional()
|
|
2046
|
+
});
|
|
2047
|
+
const getLogsContractV1 = base.route({
|
|
1588
2048
|
path: "/v1/environments/{environmentId}/logs",
|
|
1589
2049
|
method: "GET",
|
|
1590
2050
|
summary: "Get logs",
|
|
1591
2051
|
description: "Get logs for an environment",
|
|
1592
2052
|
tags: ["environments"],
|
|
1593
2053
|
successDescription: "The logs"
|
|
1594
|
-
}).errors({
|
|
1595
|
-
NOT_FOUND: {},
|
|
1596
|
-
BAD_REQUEST: {}
|
|
1597
|
-
}).input(z.object({
|
|
2054
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1598
2055
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1599
|
-
since:
|
|
1600
|
-
until:
|
|
2056
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2057
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1601
2058
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1602
2059
|
level: z.array(z.enum([
|
|
1603
2060
|
"INFO",
|
|
@@ -1608,34 +2065,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1608
2065
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1609
2066
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1610
2067
|
})).output(z.object({
|
|
1611
|
-
logs: z.array(
|
|
1612
|
-
timestamp: z.coerce.date(),
|
|
1613
|
-
type: z.enum([
|
|
1614
|
-
"START",
|
|
1615
|
-
"END",
|
|
1616
|
-
"INFO",
|
|
1617
|
-
"ERROR",
|
|
1618
|
-
"WARNING",
|
|
1619
|
-
"DEBUG"
|
|
1620
|
-
]),
|
|
1621
|
-
requestId: z.string(),
|
|
1622
|
-
content: z.string().optional(),
|
|
1623
|
-
method: z.string().optional(),
|
|
1624
|
-
durationInMs: z.number().optional()
|
|
1625
|
-
})),
|
|
2068
|
+
logs: z.array(logEntrySchema),
|
|
1626
2069
|
nextToken: z.string().nullable()
|
|
1627
2070
|
}));
|
|
1628
|
-
const getLatestLogsContractV1 =
|
|
2071
|
+
const getLatestLogsContractV1 = base.route({
|
|
1629
2072
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1630
2073
|
method: "GET",
|
|
1631
2074
|
summary: "Get latest logs",
|
|
1632
2075
|
description: "Get the N most recent logs for an environment",
|
|
1633
2076
|
tags: ["environments"],
|
|
1634
2077
|
successDescription: "The latest logs"
|
|
1635
|
-
}).errors({
|
|
1636
|
-
NOT_FOUND: {},
|
|
1637
|
-
BAD_REQUEST: {}
|
|
1638
|
-
}).input(z.object({
|
|
2078
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1639
2079
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1640
2080
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1641
2081
|
level: z.array(z.enum([
|
|
@@ -1645,22 +2085,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1645
2085
|
"DEBUG"
|
|
1646
2086
|
])).optional().describe("Filter by log level"),
|
|
1647
2087
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1648
|
-
})).output(z.object({ logs: z.array(
|
|
1649
|
-
|
|
1650
|
-
type: z.enum([
|
|
1651
|
-
"START",
|
|
1652
|
-
"END",
|
|
1653
|
-
"INFO",
|
|
1654
|
-
"ERROR",
|
|
1655
|
-
"WARNING",
|
|
1656
|
-
"DEBUG"
|
|
1657
|
-
]),
|
|
1658
|
-
requestId: z.string(),
|
|
1659
|
-
content: z.string().optional(),
|
|
1660
|
-
method: z.string().optional(),
|
|
1661
|
-
durationInMs: z.number().optional()
|
|
1662
|
-
})) }));
|
|
1663
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
2088
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
2089
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1664
2090
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1665
2091
|
method: "GET",
|
|
1666
2092
|
summary: "Get deployment logs",
|
|
@@ -1687,22 +2113,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1687
2113
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1688
2114
|
task_count: z.array(analyticsDataPointSchema)
|
|
1689
2115
|
});
|
|
1690
|
-
const getProjectAnalyticsContractV1 =
|
|
2116
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1691
2117
|
path: "/v1/analytics/{projectId}",
|
|
1692
2118
|
method: "GET",
|
|
1693
2119
|
summary: "Get project analytics",
|
|
1694
2120
|
description: "Get analytics data for a project over a time range",
|
|
1695
2121
|
tags: ["analytics"],
|
|
1696
2122
|
successDescription: "The project analytics data"
|
|
1697
|
-
}).errors({
|
|
1698
|
-
NOT_FOUND: {},
|
|
1699
|
-
BAD_REQUEST: {}
|
|
1700
|
-
}).input(z.object({
|
|
2123
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1701
2124
|
projectId: z.string().describe("The ID of the project"),
|
|
1702
2125
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1703
2126
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1704
2127
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1705
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2128
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => isValidIanaTimeZone(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1706
2129
|
metadata: z.object({
|
|
1707
2130
|
startTimestamp: z.number(),
|
|
1708
2131
|
endTimestamp: z.number(),
|
|
@@ -1712,7 +2135,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1712
2135
|
}),
|
|
1713
2136
|
timeSeries: analyticsTimeSeriesSchema
|
|
1714
2137
|
}));
|
|
1715
|
-
const
|
|
2138
|
+
const paginatedInsightsInputShape = {
|
|
2139
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2140
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2141
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2142
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2143
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2144
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2145
|
+
};
|
|
2146
|
+
const listIntentsContractV1 = base.route({
|
|
2147
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2148
|
+
method: "GET",
|
|
2149
|
+
summary: "List intents",
|
|
2150
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2151
|
+
tags: ["insights"],
|
|
2152
|
+
successDescription: "The grouped user intents"
|
|
2153
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2154
|
+
...paginatedInsightsInputShape,
|
|
2155
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2156
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2157
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2158
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2159
|
+
})).output(z.object({
|
|
2160
|
+
intents: z.array(z.object({
|
|
2161
|
+
id: z.string(),
|
|
2162
|
+
intentIds: z.array(z.string()).min(1),
|
|
2163
|
+
environmentId: z.string(),
|
|
2164
|
+
message: z.string(),
|
|
2165
|
+
toolName: z.string(),
|
|
2166
|
+
createdAt: z.coerce.date(),
|
|
2167
|
+
occurrenceCount: z.number().int().positive(),
|
|
2168
|
+
clientName: z.string().nullable(),
|
|
2169
|
+
clientId: z.string().nullable(),
|
|
2170
|
+
categories: z.array(z.object({
|
|
2171
|
+
id: z.string(),
|
|
2172
|
+
name: z.string(),
|
|
2173
|
+
color: intentCategoryColorSchema
|
|
2174
|
+
}))
|
|
2175
|
+
})),
|
|
2176
|
+
totalCount: z.number().int().nonnegative()
|
|
2177
|
+
}));
|
|
2178
|
+
const listFeedbacksContractV1 = base.route({
|
|
2179
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2180
|
+
method: "GET",
|
|
2181
|
+
summary: "List feedbacks",
|
|
2182
|
+
description: "List user feedback for an environment over a time range",
|
|
2183
|
+
tags: ["insights"],
|
|
2184
|
+
successDescription: "The user feedback"
|
|
2185
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2186
|
+
...paginatedInsightsInputShape,
|
|
2187
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2188
|
+
})).output(z.object({
|
|
2189
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2190
|
+
totalCount: z.number().int().nonnegative()
|
|
2191
|
+
}));
|
|
2192
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2193
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2194
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2195
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2196
|
+
method: "GET",
|
|
2197
|
+
summary: "List intent categories",
|
|
2198
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2199
|
+
tags: ["insights"],
|
|
2200
|
+
successDescription: "The intent categories"
|
|
2201
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2202
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2203
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2204
|
+
method: "POST",
|
|
2205
|
+
summary: "Create an intent category",
|
|
2206
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2207
|
+
tags: ["insights"],
|
|
2208
|
+
successDescription: "The created intent category"
|
|
2209
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2210
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2211
|
+
name: intentCategoryNameSchema,
|
|
2212
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2213
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2214
|
+
})).output(intentCategorySchema);
|
|
2215
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2216
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2217
|
+
method: "PATCH",
|
|
2218
|
+
summary: "Update an intent category",
|
|
2219
|
+
description: "Rename or recolor an intent category",
|
|
2220
|
+
tags: ["insights"],
|
|
2221
|
+
successDescription: "The updated intent category"
|
|
2222
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2223
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2224
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2225
|
+
name: intentCategoryNameSchema.optional(),
|
|
2226
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2227
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2228
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2229
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2230
|
+
method: "DELETE",
|
|
2231
|
+
summary: "Delete an intent category",
|
|
2232
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2233
|
+
tags: ["insights"],
|
|
2234
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2235
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2236
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2237
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2238
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2239
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2240
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2241
|
+
method: "POST",
|
|
2242
|
+
summary: "Link an intent category",
|
|
2243
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2244
|
+
tags: ["insights"],
|
|
2245
|
+
successDescription: "The intents have been linked successfully"
|
|
2246
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2247
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2248
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2249
|
+
intentIds: categorizableIntentIdsSchema
|
|
2250
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2251
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2252
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2253
|
+
method: "POST",
|
|
2254
|
+
summary: "Unlink an intent category",
|
|
2255
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2256
|
+
tags: ["insights"],
|
|
2257
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2258
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2259
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2260
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2261
|
+
intentIds: categorizableIntentIdsSchema
|
|
2262
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2263
|
+
const listTeamsContractV1 = base.route({
|
|
1716
2264
|
path: "/v1/teams",
|
|
1717
2265
|
method: "GET",
|
|
1718
2266
|
summary: "List teams",
|
|
@@ -1725,28 +2273,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
1725
2273
|
createdAt: z.coerce.date(),
|
|
1726
2274
|
hasStripeAccount: z.boolean()
|
|
1727
2275
|
})));
|
|
1728
|
-
const
|
|
2276
|
+
const getTeamUsageContractV1 = base.route({
|
|
2277
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2278
|
+
method: "GET",
|
|
2279
|
+
summary: "Get team usage",
|
|
2280
|
+
description: "Get the MCP request usage of a team for its current billing window. A team that has made no request in the window reports zero.",
|
|
2281
|
+
tags: ["teams"],
|
|
2282
|
+
successDescription: "The current billing window usage"
|
|
2283
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2284
|
+
teamId: z.string(),
|
|
2285
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2286
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2287
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2288
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2289
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2290
|
+
}));
|
|
2291
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1729
2292
|
path: "/v1/tunnels/ticket",
|
|
1730
2293
|
method: "GET",
|
|
1731
2294
|
summary: "Get a tunnel ticket",
|
|
1732
2295
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1733
2296
|
tags: ["tunnels"],
|
|
1734
2297
|
successDescription: "The tunnel ticket"
|
|
1735
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
2298
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1736
2299
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1737
2300
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1738
2301
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1739
2302
|
}));
|
|
1740
|
-
const publishServerContractV1 =
|
|
2303
|
+
const publishServerContractV1 = base.route({
|
|
1741
2304
|
path: "/v1/distribution/publish",
|
|
1742
2305
|
method: "POST",
|
|
1743
2306
|
summary: "Publish a server to the MCP registry",
|
|
1744
2307
|
tags: ["distribution"],
|
|
1745
2308
|
successDescription: "The server has been published successfully"
|
|
1746
|
-
}).errors({
|
|
1747
|
-
NOT_FOUND: {},
|
|
1748
|
-
BAD_REQUEST: {}
|
|
1749
|
-
}).input(z.object({
|
|
2309
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1750
2310
|
projectId: z.string(),
|
|
1751
2311
|
domain: z.string(),
|
|
1752
2312
|
title: z.string().min(1).max(100),
|
|
@@ -1755,17 +2315,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1755
2315
|
iconSrc: z.url().max(255).optional(),
|
|
1756
2316
|
dryRun: z.boolean().optional()
|
|
1757
2317
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1758
|
-
const getServerInfoContractV1 =
|
|
2318
|
+
const getServerInfoContractV1 = base.route({
|
|
1759
2319
|
path: "/v1/distribution/get",
|
|
1760
2320
|
method: "GET",
|
|
1761
2321
|
summary: "Get server info",
|
|
1762
2322
|
description: "Get info about a server",
|
|
1763
2323
|
tags: ["distribution"],
|
|
1764
2324
|
successDescription: "The server info"
|
|
1765
|
-
}).errors({
|
|
1766
|
-
NOT_FOUND: {},
|
|
1767
|
-
BAD_REQUEST: {}
|
|
1768
|
-
}).input(z.object({
|
|
2325
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1769
2326
|
projectId: z.string(),
|
|
1770
2327
|
domain: z.string()
|
|
1771
2328
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1784,7 +2341,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1784
2341
|
isPlaygroundEnabled: z.boolean(),
|
|
1785
2342
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1786
2343
|
});
|
|
1787
|
-
const getPlaygroundContractV1 =
|
|
2344
|
+
const getPlaygroundContractV1 = base.route({
|
|
1788
2345
|
path: "/v1/environments/{environmentId}/playground",
|
|
1789
2346
|
method: "GET",
|
|
1790
2347
|
summary: "Get playground configuration",
|
|
@@ -1792,17 +2349,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1792
2349
|
tags: ["environments"],
|
|
1793
2350
|
successDescription: "The playground configuration"
|
|
1794
2351
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1795
|
-
const upsertPlaygroundContractV1 =
|
|
2352
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1796
2353
|
path: "/v1/environments/{environmentId}/playground",
|
|
1797
2354
|
method: "PUT",
|
|
1798
2355
|
summary: "Update playground configuration",
|
|
1799
2356
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1800
2357
|
tags: ["environments"],
|
|
1801
2358
|
successDescription: "The updated playground configuration"
|
|
1802
|
-
}).errors({
|
|
1803
|
-
NOT_FOUND: {},
|
|
1804
|
-
BAD_REQUEST: {}
|
|
1805
|
-
}).input(z.object({
|
|
2359
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1806
2360
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1807
2361
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1808
2362
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1810,7 +2364,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1810
2364
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1811
2365
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1812
2366
|
})).output(playgroundOutputSchema);
|
|
1813
|
-
const createBeaconContractV1 =
|
|
2367
|
+
const createBeaconContractV1 = base.route({
|
|
1814
2368
|
path: "/v1/beacon/audits",
|
|
1815
2369
|
method: "POST",
|
|
1816
2370
|
summary: "Create a beacon audit",
|
|
@@ -1819,7 +2373,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1819
2373
|
successDescription: "The audit has been created"
|
|
1820
2374
|
}).errors({
|
|
1821
2375
|
NOT_FOUND: {},
|
|
1822
|
-
BAD_REQUEST: {},
|
|
1823
2376
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1824
2377
|
}).input(z.object({
|
|
1825
2378
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1827,7 +2380,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1827
2380
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1828
2381
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1829
2382
|
})).output(z.object({ id: z.string() }));
|
|
1830
|
-
const getBeaconContractV1 =
|
|
2383
|
+
const getBeaconContractV1 = base.route({
|
|
1831
2384
|
path: "/v1/beacon/audits/{auditId}",
|
|
1832
2385
|
method: "GET",
|
|
1833
2386
|
summary: "Get a beacon audit",
|
|
@@ -1842,9 +2395,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1842
2395
|
createdAt: z.coerce.date(),
|
|
1843
2396
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1844
2397
|
}));
|
|
2398
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2399
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2400
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2401
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2402
|
+
const createSubmissionContractV1 = base.route({
|
|
2403
|
+
path: "/v1/submissions",
|
|
2404
|
+
method: "POST",
|
|
2405
|
+
summary: "Create a submission package",
|
|
2406
|
+
description: "Create a submission package for an environment. Alpic reads the environment's live MCP server and prefills every field it can infer, so the response already carries the populated package. The environment must have a successful deployment and must not require authentication.",
|
|
2407
|
+
tags: ["submissions"],
|
|
2408
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2409
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2410
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2411
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2412
|
+
})).output(submissionSchema);
|
|
2413
|
+
const listSubmissionsContractV1 = base.route({
|
|
2414
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2415
|
+
method: "GET",
|
|
2416
|
+
summary: "List submission packages",
|
|
2417
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2418
|
+
tags: ["submissions"],
|
|
2419
|
+
successDescription: "The list of submission packages"
|
|
2420
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2421
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2422
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2423
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2424
|
+
})).output(z.array(submissionSchema));
|
|
2425
|
+
const getSubmissionContractV1 = base.route({
|
|
2426
|
+
path: "/v1/submissions/{submissionId}",
|
|
2427
|
+
method: "GET",
|
|
2428
|
+
summary: "Get a submission package",
|
|
2429
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2430
|
+
tags: ["submissions"],
|
|
2431
|
+
successDescription: "The submission package"
|
|
2432
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2433
|
+
const updateSubmissionContractV1 = base.route({
|
|
2434
|
+
path: "/v1/submissions/{submissionId}",
|
|
2435
|
+
method: "PUT",
|
|
2436
|
+
summary: "Update a submission package",
|
|
2437
|
+
description: "Update the form data of a submission package. Only the fields you send are changed; the rest are left as they are. Unknown field names are rejected rather than ignored, so a typo fails the call. `platform` must match the package's own platform.",
|
|
2438
|
+
tags: ["submissions"],
|
|
2439
|
+
successDescription: "The updated submission package"
|
|
2440
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2441
|
+
submissionId: submissionIdSchema,
|
|
2442
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2443
|
+
formData: claudeSubmissionUpdateSchema
|
|
2444
|
+
}), z.object({
|
|
2445
|
+
submissionId: submissionIdSchema,
|
|
2446
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2447
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2448
|
+
})])).output(submissionSchema);
|
|
1845
2449
|
const contract = {
|
|
1846
|
-
teams: {
|
|
2450
|
+
teams: {
|
|
2451
|
+
list: { v1: listTeamsContractV1 },
|
|
2452
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2453
|
+
},
|
|
1847
2454
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2455
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2456
|
+
intentCategories: {
|
|
2457
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2458
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2459
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2460
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2461
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2462
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2463
|
+
},
|
|
2464
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1848
2465
|
deployments: {
|
|
1849
2466
|
list: { v1: listDeploymentsContractV1 },
|
|
1850
2467
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1854,6 +2471,7 @@ const contract = {
|
|
|
1854
2471
|
environments: {
|
|
1855
2472
|
create: { v1: createEnvironmentContractV1 },
|
|
1856
2473
|
get: { v1: getEnvironmentContractV1 },
|
|
2474
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1857
2475
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1858
2476
|
getLogs: { v1: getLogsContractV1 },
|
|
1859
2477
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1883,7 +2501,39 @@ const contract = {
|
|
|
1883
2501
|
beacon: {
|
|
1884
2502
|
create: { v1: createBeaconContractV1 },
|
|
1885
2503
|
get: { v1: getBeaconContractV1 }
|
|
2504
|
+
},
|
|
2505
|
+
submissions: {
|
|
2506
|
+
create: { v1: createSubmissionContractV1 },
|
|
2507
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2508
|
+
get: { v1: getSubmissionContractV1 },
|
|
2509
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2510
|
+
}
|
|
2511
|
+
};
|
|
2512
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2513
|
+
const contractForDocs = {
|
|
2514
|
+
...contract,
|
|
2515
|
+
deployments: deploymentsForDocs
|
|
2516
|
+
};
|
|
2517
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2518
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2519
|
+
info: {
|
|
2520
|
+
title: "Alpic API",
|
|
2521
|
+
version: "1.0.0"
|
|
2522
|
+
},
|
|
2523
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2524
|
+
security: [{ bearerAuth: [] }],
|
|
2525
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2526
|
+
type: "http",
|
|
2527
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2528
|
+
scheme: "bearer"
|
|
2529
|
+
} } },
|
|
2530
|
+
commonSchemas: {
|
|
2531
|
+
Submission: { schema: submissionSchema },
|
|
2532
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2533
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2534
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2535
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
1886
2536
|
}
|
|
1887
2537
|
};
|
|
1888
2538
|
//#endregion
|
|
1889
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2539
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, PLATFORM_LABELS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|