@alpic-ai/api 0.0.0-dev.gf21ae43 → 0.0.0-dev.gf22191e
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 +6255 -84
- package/dist/index.mjs +994 -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,28 @@ 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();
|
|
889
|
+
const blankPositiveTestCase = () => ({
|
|
890
|
+
scenario: "",
|
|
891
|
+
userPrompt: "",
|
|
892
|
+
toolTriggered: "",
|
|
893
|
+
expectedOutput: ""
|
|
894
|
+
});
|
|
895
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
575
896
|
const screenshotEntrySchema = z.object({
|
|
576
897
|
prompt: z.string(),
|
|
577
|
-
url: z.url()
|
|
898
|
+
url: z.url()
|
|
578
899
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
900
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
579
901
|
/** Accepts either a valid email or URL. */
|
|
580
902
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
903
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
904
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
581
905
|
const chatgptCategorySchema = z.enum([
|
|
582
906
|
"BUSINESS",
|
|
583
907
|
"COLLABORATION",
|
|
@@ -881,20 +1205,21 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
881
1205
|
"zh-TW"
|
|
882
1206
|
]);
|
|
883
1207
|
const negativeTestCaseSchema = z.object({
|
|
884
|
-
scenario: z.string(),
|
|
885
|
-
userPrompt: z.string()
|
|
886
|
-
}).
|
|
1208
|
+
scenario: z.string().min(1),
|
|
1209
|
+
userPrompt: z.string().min(1)
|
|
1210
|
+
}).describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
1211
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial();
|
|
1212
|
+
const blankNegativeTestCase = () => ({
|
|
1213
|
+
scenario: "",
|
|
1214
|
+
userPrompt: ""
|
|
1215
|
+
});
|
|
887
1216
|
const chatgptToolJustificationSchema = z.object({
|
|
888
1217
|
toolName: z.string(),
|
|
889
1218
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
890
1219
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
891
1220
|
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
1221
|
}).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
|
-
*/
|
|
1222
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
898
1223
|
const chatgptTaglineSchema = z.string().max(30);
|
|
899
1224
|
const chatgptDescriptionSchema = z.string();
|
|
900
1225
|
const chatgptTranslationSchema = z.object({
|
|
@@ -903,10 +1228,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
903
1228
|
description: chatgptDescriptionSchema
|
|
904
1229
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
905
1230
|
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
|
-
*/
|
|
1231
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
910
1232
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
911
1233
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
912
1234
|
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 +1237,62 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
915
1237
|
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
1238
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
917
1239
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
918
|
-
companyUrl:
|
|
1240
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
919
1241
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
920
|
-
privacyPolicyUrl:
|
|
921
|
-
termsOfServiceUrl:
|
|
922
|
-
demoRecordingUrl:
|
|
1242
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1243
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1244
|
+
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
1245
|
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:
|
|
1246
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
925
1247
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
926
1248
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
927
1249
|
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
|
-
testCases: z.array(positiveTestCaseSchema).describe("
|
|
929
|
-
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases: prompts where the app should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
930
|
-
screenshots: z.array(screenshotEntrySchema).max(3).describe("In-app screenshots paired with the user prompt that produced them. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1250
|
+
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."),
|
|
1251
|
+
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."),
|
|
1252
|
+
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
1253
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
932
1254
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
933
1255
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
934
1256
|
});
|
|
935
|
-
chatgptSubmissionFormDataSchema.
|
|
1257
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1258
|
+
tagline: z.string().optional(),
|
|
1259
|
+
companyUrl: z.string().optional(),
|
|
1260
|
+
supportChannel: z.string().optional(),
|
|
1261
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1262
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1263
|
+
demoRecordingUrl: z.string().optional(),
|
|
1264
|
+
serverUrl: z.string().optional(),
|
|
1265
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1266
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1267
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1268
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1269
|
+
});
|
|
1270
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1271
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
936
1272
|
appName: true,
|
|
937
1273
|
developerName: true,
|
|
938
1274
|
serverUrl: true,
|
|
939
1275
|
tools: true,
|
|
940
1276
|
authentication: true
|
|
941
1277
|
});
|
|
942
|
-
|
|
1278
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1279
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
943
1280
|
tagline: true,
|
|
944
1281
|
description: true,
|
|
945
1282
|
category: true,
|
|
946
1283
|
testCases: true,
|
|
947
1284
|
negativeTestCases: true,
|
|
948
1285
|
toolJustifications: true
|
|
949
|
-
}).extend({
|
|
1286
|
+
}).extend({
|
|
1287
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1288
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1289
|
+
}).extend({
|
|
1290
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1291
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1292
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1293
|
+
});
|
|
950
1294
|
const claudeCategorySchema = z.enum([
|
|
951
|
-
"
|
|
1295
|
+
"Productivity",
|
|
952
1296
|
"Communication",
|
|
953
1297
|
"Data & Analytics",
|
|
954
1298
|
"Development tools",
|
|
@@ -956,222 +1300,222 @@ const claudeCategorySchema = z.enum([
|
|
|
956
1300
|
"Consumer Health",
|
|
957
1301
|
"Health & Life Sciences",
|
|
958
1302
|
"Media & Entertainment",
|
|
959
|
-
"Commerce & Shopping"
|
|
1303
|
+
"Commerce & Shopping",
|
|
1304
|
+
"Legal",
|
|
1305
|
+
"Sales and marketing",
|
|
1306
|
+
"Creative",
|
|
1307
|
+
"Nonprofit",
|
|
1308
|
+
"Education",
|
|
1309
|
+
"Other"
|
|
960
1310
|
]);
|
|
961
|
-
const
|
|
962
|
-
"No auth needed",
|
|
963
|
-
"OAuth 2.0",
|
|
964
|
-
"Custom URL"
|
|
965
|
-
]);
|
|
966
|
-
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
967
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1311
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
968
1312
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
969
|
-
"
|
|
970
|
-
"
|
|
971
|
-
"
|
|
972
|
-
]);
|
|
973
|
-
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
974
|
-
const claudeTestedSurfaceSchema = z.enum([
|
|
975
|
-
"Claude.ai (web)",
|
|
976
|
-
"Claude Desktop",
|
|
977
|
-
"Claude Code",
|
|
978
|
-
"Cowork"
|
|
1313
|
+
"read_only",
|
|
1314
|
+
"write_only",
|
|
1315
|
+
"read_write"
|
|
979
1316
|
]);
|
|
980
|
-
const
|
|
981
|
-
"
|
|
982
|
-
"
|
|
983
|
-
"
|
|
984
|
-
"
|
|
985
|
-
"
|
|
1317
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1318
|
+
"oauth_dcr",
|
|
1319
|
+
"oauth_cimd",
|
|
1320
|
+
"oauth_anthropic_creds",
|
|
1321
|
+
"custom_connection",
|
|
1322
|
+
"none"
|
|
986
1323
|
]);
|
|
987
|
-
const
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"GDPR compliant (if applicable)"
|
|
1324
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1325
|
+
"first_party",
|
|
1326
|
+
"proxied",
|
|
1327
|
+
"third_party"
|
|
992
1328
|
]);
|
|
993
|
-
const
|
|
994
|
-
|
|
995
|
-
"
|
|
996
|
-
"
|
|
1329
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1330
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1331
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1332
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1333
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1334
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1335
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1336
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1337
|
+
"Public documentation for this connector will be live by the publish date."
|
|
997
1338
|
]);
|
|
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
|
-
*/
|
|
1339
|
+
/** 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
1340
|
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,
|
|
1341
|
+
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
|
|
1342
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1343
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1344
|
+
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
|
|
1345
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1346
|
+
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.
|
|
1347
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1348
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1349
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1350
|
+
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
|
|
1351
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1352
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1353
|
+
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
|
|
1354
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1355
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1356
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1357
|
+
by your publish date.`),
|
|
1358
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1359
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1360
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1361
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1362
|
+
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
|
|
1363
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1364
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1365
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1366
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1367
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1368
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1369
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1370
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1371
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1372
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1373
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1374
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1375
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1376
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1377
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1378
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1379
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1380
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1381
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1382
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1383
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1384
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1385
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1386
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1387
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1388
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1389
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1390
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1391
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1392
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1393
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1394
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1395
|
+
fully populated account.`),
|
|
1396
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1397
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1398
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1399
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1400
|
+
});
|
|
1401
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1402
|
+
serverUrl: z.string().optional(),
|
|
1403
|
+
name: z.string().optional(),
|
|
1404
|
+
slug: z.string().optional(),
|
|
1405
|
+
oneLiner: z.string().optional(),
|
|
1406
|
+
description: z.string().optional(),
|
|
1407
|
+
iconUrl: z.string().optional(),
|
|
1408
|
+
documentation: z.string().optional(),
|
|
1409
|
+
support: z.string().optional(),
|
|
1410
|
+
privacyPolicy: z.string().optional(),
|
|
1411
|
+
companyWebsite: z.string().optional(),
|
|
1412
|
+
primaryContactEmail: z.string().optional(),
|
|
1413
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1414
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1415
|
+
});
|
|
1416
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1417
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1138
1418
|
serverUrl: true,
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
transportSupport: true,
|
|
1419
|
+
name: true,
|
|
1420
|
+
slug: true,
|
|
1421
|
+
companyName: true,
|
|
1143
1422
|
primaryContactEmail: true,
|
|
1144
1423
|
primaryContactName: true,
|
|
1424
|
+
readWriteCapabilities: true,
|
|
1145
1425
|
authentication: true,
|
|
1146
|
-
|
|
1147
|
-
|
|
1426
|
+
apiOwnership: true,
|
|
1427
|
+
personalHealthData: true
|
|
1148
1428
|
}).extend({
|
|
1149
1429
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1150
|
-
|
|
1430
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1431
|
+
});
|
|
1432
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1433
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1434
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1435
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1436
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1437
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1438
|
+
});
|
|
1439
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1440
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1441
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1442
|
+
});
|
|
1443
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1444
|
+
const byField = {};
|
|
1445
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1446
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1447
|
+
return byField;
|
|
1448
|
+
}
|
|
1449
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1450
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1451
|
+
"pass",
|
|
1452
|
+
"fail",
|
|
1453
|
+
"unverified"
|
|
1454
|
+
]);
|
|
1455
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1456
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1457
|
+
claudeai: ["privacyPolicy"]
|
|
1458
|
+
};
|
|
1459
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1460
|
+
const policyDisclosureSchema = z.enum([
|
|
1461
|
+
"dataCategories",
|
|
1462
|
+
"purposesOfUse",
|
|
1463
|
+
"recipients",
|
|
1464
|
+
"retention"
|
|
1465
|
+
]);
|
|
1466
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1467
|
+
field: verifiableUrlFieldSchema,
|
|
1468
|
+
url: z.string(),
|
|
1469
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1470
|
+
reason: z.string(),
|
|
1471
|
+
concerns: z.array(z.string()).optional(),
|
|
1472
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1473
|
+
});
|
|
1474
|
+
const urlVerificationSchema = z.object({
|
|
1475
|
+
verifiedAt: z.coerce.date(),
|
|
1476
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1477
|
+
});
|
|
1478
|
+
const pageKindSchema = z.enum([
|
|
1479
|
+
"expectedDocument",
|
|
1480
|
+
"errorPage",
|
|
1481
|
+
"loginWall",
|
|
1482
|
+
"parkedDomain",
|
|
1483
|
+
"comingSoon",
|
|
1484
|
+
"marketingPage",
|
|
1485
|
+
"unrelatedDocument"
|
|
1486
|
+
]);
|
|
1487
|
+
z.object({
|
|
1488
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1489
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1490
|
+
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
1491
|
});
|
|
1152
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1153
|
-
tagline: true,
|
|
1154
|
-
description: true,
|
|
1155
|
-
category: true,
|
|
1156
|
-
testCases: true
|
|
1157
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1158
1492
|
const submissionMetaFieldsSchema = z.object({
|
|
1159
1493
|
id: z.string(),
|
|
1160
1494
|
environmentId: z.string(),
|
|
1161
1495
|
auditId: z.string().nullable(),
|
|
1496
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1162
1497
|
createdAt: z.coerce.date(),
|
|
1163
1498
|
updatedAt: z.coerce.date()
|
|
1164
1499
|
});
|
|
1165
1500
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1166
1501
|
platform: z.literal("claudeai"),
|
|
1167
|
-
formData:
|
|
1502
|
+
formData: claudeSubmissionDraftSchema,
|
|
1503
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1168
1504
|
});
|
|
1169
1505
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1170
1506
|
platform: z.literal("chatgpt"),
|
|
1171
|
-
formData:
|
|
1507
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1508
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1172
1509
|
});
|
|
1173
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1174
|
-
z.union([
|
|
1510
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1511
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1512
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1513
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1514
|
+
z.literal([
|
|
1515
|
+
100,
|
|
1516
|
+
75,
|
|
1517
|
+
50
|
|
1518
|
+
]);
|
|
1175
1519
|
const subscriptionPlanSchema = z.enum([
|
|
1176
1520
|
"pro",
|
|
1177
1521
|
"business",
|
|
@@ -1183,17 +1527,76 @@ const customerCreditsSchema = z.object({
|
|
|
1183
1527
|
expiresAt: z.number().nullable(),
|
|
1184
1528
|
currency: z.string()
|
|
1185
1529
|
});
|
|
1186
|
-
const customerUsageSchema = z.object({
|
|
1187
|
-
amountInCents: z.number(),
|
|
1188
|
-
currency: z.string(),
|
|
1189
|
-
periodEnd: z.number()
|
|
1190
|
-
});
|
|
1191
1530
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1192
1531
|
z.object({
|
|
1193
1532
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1194
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1195
1533
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1196
1534
|
});
|
|
1535
|
+
const metricsQueueEventSchema = z.object({
|
|
1536
|
+
ts: z.number().int(),
|
|
1537
|
+
method: z.string(),
|
|
1538
|
+
tool: z.string().nullable(),
|
|
1539
|
+
client: z.string(),
|
|
1540
|
+
sessionId: z.string().nullable(),
|
|
1541
|
+
durationMs: z.number().int(),
|
|
1542
|
+
outputTokens: z.number().int().nullable(),
|
|
1543
|
+
errorType: z.enum([
|
|
1544
|
+
"mcp_error",
|
|
1545
|
+
"tool_error",
|
|
1546
|
+
"timeout"
|
|
1547
|
+
]).nullable(),
|
|
1548
|
+
errorCode: z.number().int().nullable()
|
|
1549
|
+
});
|
|
1550
|
+
z.object({
|
|
1551
|
+
v: z.literal(1),
|
|
1552
|
+
envId: z.string(),
|
|
1553
|
+
events: z.array(metricsQueueEventSchema)
|
|
1554
|
+
});
|
|
1555
|
+
z.object({ v: z.number() });
|
|
1556
|
+
const telemetrySignalSchema = z.enum([
|
|
1557
|
+
"logs",
|
|
1558
|
+
"metrics",
|
|
1559
|
+
"traces"
|
|
1560
|
+
]);
|
|
1561
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1562
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1563
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1564
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1565
|
+
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");
|
|
1566
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1567
|
+
id: z.string(),
|
|
1568
|
+
name: otlpHeaderNameSchema,
|
|
1569
|
+
value: otlpHeaderValueSchema,
|
|
1570
|
+
isSecret: z.boolean()
|
|
1571
|
+
});
|
|
1572
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1573
|
+
"credentials",
|
|
1574
|
+
"wrong-path",
|
|
1575
|
+
"wrong-protocol",
|
|
1576
|
+
"invalid-payload",
|
|
1577
|
+
"partial-rejection",
|
|
1578
|
+
"blocked-target",
|
|
1579
|
+
"timeout",
|
|
1580
|
+
"unreachable",
|
|
1581
|
+
"receiver-error",
|
|
1582
|
+
"unexpected-status"
|
|
1583
|
+
]);
|
|
1584
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1585
|
+
z.object({
|
|
1586
|
+
id: z.string(),
|
|
1587
|
+
signal: telemetrySignalSchema,
|
|
1588
|
+
endpoint: otlpEndpointSchema,
|
|
1589
|
+
protocol: otlpProtocolSchema,
|
|
1590
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1591
|
+
status: telemetryDestinationStatusSchema,
|
|
1592
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1593
|
+
});
|
|
1594
|
+
//#endregion
|
|
1595
|
+
//#region src/auth-scope.ts
|
|
1596
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1597
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1598
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1599
|
+
const AUTH_SCOPE_USER = "user";
|
|
1197
1600
|
//#endregion
|
|
1198
1601
|
//#region src/schemas.ts
|
|
1199
1602
|
const RESERVED_KEYS = [
|
|
@@ -1230,7 +1633,10 @@ const RESERVED_KEYS = [
|
|
|
1230
1633
|
"BUILD_ARG_START_COMMAND",
|
|
1231
1634
|
"ALPIC_HOST",
|
|
1232
1635
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1233
|
-
"ALPIC_INTENT_META_KEY"
|
|
1636
|
+
"ALPIC_INTENT_META_KEY",
|
|
1637
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1638
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1639
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1234
1640
|
];
|
|
1235
1641
|
const environmentVariableSchema = z.object({
|
|
1236
1642
|
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 +1689,14 @@ const serverFieldsSchema = z.object({
|
|
|
1283
1689
|
});
|
|
1284
1690
|
//#endregion
|
|
1285
1691
|
//#region src/api.contract.ts
|
|
1692
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1693
|
+
try {
|
|
1694
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1695
|
+
return true;
|
|
1696
|
+
} catch {
|
|
1697
|
+
return false;
|
|
1698
|
+
}
|
|
1699
|
+
};
|
|
1286
1700
|
const deploymentStatusSchema = z.enum([
|
|
1287
1701
|
"ongoing",
|
|
1288
1702
|
"deployed",
|
|
@@ -1311,21 +1725,20 @@ const deploymentSchema = z.object({
|
|
|
1311
1725
|
isCurrent: z.boolean(),
|
|
1312
1726
|
deploymentPageUrl: z.url().nullable()
|
|
1313
1727
|
});
|
|
1314
|
-
const
|
|
1728
|
+
const isValidTimeInput = (value) => {
|
|
1315
1729
|
if (ms(value) !== void 0) return true;
|
|
1316
1730
|
return !Number.isNaN(new Date(value).getTime());
|
|
1317
1731
|
};
|
|
1318
|
-
const
|
|
1732
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1733
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1734
|
+
const createEnvironmentContractV1 = base.route({
|
|
1319
1735
|
path: "/v1/environments",
|
|
1320
1736
|
method: "POST",
|
|
1321
1737
|
summary: "Create an environment",
|
|
1322
1738
|
description: "Create an environment for a project",
|
|
1323
1739
|
tags: ["environments"],
|
|
1324
1740
|
successDescription: "The environment has been created successfully"
|
|
1325
|
-
}).errors({
|
|
1326
|
-
NOT_FOUND: {},
|
|
1327
|
-
BAD_REQUEST: {}
|
|
1328
|
-
}).input(z.object({
|
|
1741
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1329
1742
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1330
1743
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1331
1744
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1338,7 +1751,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1338
1751
|
createdAt: z.coerce.date(),
|
|
1339
1752
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1340
1753
|
}));
|
|
1341
|
-
const getEnvironmentContractV1 =
|
|
1754
|
+
const getEnvironmentContractV1 = base.route({
|
|
1342
1755
|
path: "/v1/environments/{environmentId}",
|
|
1343
1756
|
method: "GET",
|
|
1344
1757
|
summary: "Get an environment",
|
|
@@ -1354,6 +1767,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1354
1767
|
createdAt: z.coerce.date(),
|
|
1355
1768
|
projectId: z.string()
|
|
1356
1769
|
}));
|
|
1770
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1771
|
+
path: "/v1/environments/{environmentId}",
|
|
1772
|
+
method: "DELETE",
|
|
1773
|
+
summary: "Delete an environment",
|
|
1774
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1775
|
+
tags: ["environments"],
|
|
1776
|
+
successDescription: "The environment has been deleted successfully"
|
|
1777
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1357
1778
|
const domainSchema = z.object({
|
|
1358
1779
|
domain: z.string(),
|
|
1359
1780
|
status: z.enum([
|
|
@@ -1395,7 +1816,7 @@ const projectOutputSchema = z.object({
|
|
|
1395
1816
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1396
1817
|
environments: z.array(environmentSchema)
|
|
1397
1818
|
});
|
|
1398
|
-
const getProjectContractV1 =
|
|
1819
|
+
const getProjectContractV1 = base.route({
|
|
1399
1820
|
path: "/v1/projects/{projectId}",
|
|
1400
1821
|
method: "GET",
|
|
1401
1822
|
summary: "Get a project",
|
|
@@ -1403,18 +1824,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1403
1824
|
tags: ["projects"],
|
|
1404
1825
|
successDescription: "The project details"
|
|
1405
1826
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1406
|
-
const listProjectsContractV1 =
|
|
1827
|
+
const listProjectsContractV1 = base.route({
|
|
1407
1828
|
path: "/v1/projects",
|
|
1408
1829
|
method: "GET",
|
|
1409
1830
|
summary: "List projects",
|
|
1410
1831
|
description: "List all projects for a team",
|
|
1411
1832
|
tags: ["projects"],
|
|
1412
1833
|
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({
|
|
1834
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1835
|
+
const createProjectContractV1 = base.route({
|
|
1418
1836
|
path: "/v1/projects",
|
|
1419
1837
|
method: "POST",
|
|
1420
1838
|
summary: "Create a project",
|
|
@@ -1423,7 +1841,7 @@ const createProjectContractV1 = oc.route({
|
|
|
1423
1841
|
successDescription: "The project has been created successfully"
|
|
1424
1842
|
}).errors({
|
|
1425
1843
|
NOT_FOUND: {},
|
|
1426
|
-
|
|
1844
|
+
FORBIDDEN: {}
|
|
1427
1845
|
}).input(z.object({
|
|
1428
1846
|
teamId: z.string().optional(),
|
|
1429
1847
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1463,7 +1881,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1463
1881
|
isSecret: z.boolean(),
|
|
1464
1882
|
createdAt: z.coerce.date()
|
|
1465
1883
|
});
|
|
1466
|
-
const listEnvironmentVariablesContractV1 =
|
|
1884
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1467
1885
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1468
1886
|
method: "GET",
|
|
1469
1887
|
summary: "List environment variables",
|
|
@@ -1471,48 +1889,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1471
1889
|
tags: ["environments"],
|
|
1472
1890
|
successDescription: "The list of environment variables"
|
|
1473
1891
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1474
|
-
const createEnvironmentVariablesContractV1 =
|
|
1892
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1475
1893
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1476
1894
|
method: "POST",
|
|
1477
1895
|
summary: "Add environment variables",
|
|
1478
1896
|
description: "Add one or more environment variables to an environment",
|
|
1479
1897
|
tags: ["environments"],
|
|
1480
1898
|
successDescription: "The environment variables have been added successfully"
|
|
1481
|
-
}).errors({
|
|
1482
|
-
NOT_FOUND: {},
|
|
1483
|
-
BAD_REQUEST: {}
|
|
1484
|
-
}).input(z.object({
|
|
1899
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1485
1900
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1486
1901
|
environmentVariables: environmentVariablesSchema
|
|
1487
1902
|
})).output(z.object({ success: z.literal(true) }));
|
|
1488
|
-
const updateEnvironmentVariableContractV1 =
|
|
1903
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1489
1904
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1490
1905
|
method: "PATCH",
|
|
1491
1906
|
summary: "Update an environment variable",
|
|
1492
1907
|
description: "Update an environment variable by ID",
|
|
1493
1908
|
tags: ["environments"],
|
|
1494
1909
|
successDescription: "The environment variable has been updated successfully"
|
|
1495
|
-
}).errors({
|
|
1496
|
-
NOT_FOUND: {},
|
|
1497
|
-
BAD_REQUEST: {}
|
|
1498
|
-
}).input(z.object({
|
|
1910
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1499
1911
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1500
1912
|
key: environmentVariableSchema.shape.key,
|
|
1501
1913
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1502
1914
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1503
1915
|
})).output(z.object({ success: z.literal(true) }));
|
|
1504
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1916
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1505
1917
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1506
1918
|
method: "DELETE",
|
|
1507
1919
|
summary: "Delete an environment variable",
|
|
1508
1920
|
description: "Delete an environment variable by ID",
|
|
1509
1921
|
tags: ["environments"],
|
|
1510
1922
|
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({
|
|
1923
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1924
|
+
const deleteProjectContractV1 = base.route({
|
|
1516
1925
|
path: "/v1/projects/{projectId}",
|
|
1517
1926
|
method: "DELETE",
|
|
1518
1927
|
summary: "Delete a project",
|
|
@@ -1520,7 +1929,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1520
1929
|
tags: ["projects"],
|
|
1521
1930
|
successDescription: "The project has been deleted successfully"
|
|
1522
1931
|
}).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 =
|
|
1932
|
+
const updateProjectContractV1 = base.route({
|
|
1524
1933
|
path: "/v1/projects/{projectId}",
|
|
1525
1934
|
method: "PATCH",
|
|
1526
1935
|
summary: "Update a project",
|
|
@@ -1529,13 +1938,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1529
1938
|
successDescription: "The project has been updated successfully"
|
|
1530
1939
|
}).errors({
|
|
1531
1940
|
NOT_FOUND: {},
|
|
1532
|
-
|
|
1941
|
+
FORBIDDEN: {}
|
|
1533
1942
|
}).input(z.object({
|
|
1534
1943
|
projectId: z.string().describe("The ID of the project"),
|
|
1535
1944
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1536
1945
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1537
1946
|
})).output(projectOutputSchema);
|
|
1538
|
-
const deployEnvironmentContractV1 =
|
|
1947
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1539
1948
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1540
1949
|
method: "POST",
|
|
1541
1950
|
summary: "Deploy an environment",
|
|
@@ -1544,27 +1953,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1544
1953
|
successDescription: "The environment has been deployed successfully"
|
|
1545
1954
|
}).errors({
|
|
1546
1955
|
NOT_FOUND: {},
|
|
1547
|
-
|
|
1956
|
+
CONFLICT: {}
|
|
1548
1957
|
}).input(z.object({
|
|
1549
1958
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1550
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1959
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1960
|
+
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
1961
|
})).output(deploymentSchema);
|
|
1552
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1962
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1553
1963
|
path: "/v1/deployments/upload",
|
|
1554
1964
|
method: "POST",
|
|
1555
1965
|
summary: "Upload deployment artifacts",
|
|
1556
1966
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1557
1967
|
tags: ["deployments"],
|
|
1558
1968
|
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({
|
|
1969
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1563
1970
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1564
1971
|
token: z.string().describe("Token to identify the source archive"),
|
|
1565
1972
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1566
1973
|
}));
|
|
1567
|
-
const listDeploymentsContractV1 =
|
|
1974
|
+
const listDeploymentsContractV1 = base.route({
|
|
1568
1975
|
path: "/v1/projects/{projectId}/deployments",
|
|
1569
1976
|
method: "GET",
|
|
1570
1977
|
summary: "List project deployments",
|
|
@@ -1576,7 +1983,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1576
1983
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1577
1984
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1578
1985
|
})).output(z.array(deploymentSchema));
|
|
1579
|
-
const getDeploymentContractV1 =
|
|
1986
|
+
const getDeploymentContractV1 = base.route({
|
|
1580
1987
|
path: "/v1/deployments/{deploymentId}",
|
|
1581
1988
|
method: "GET",
|
|
1582
1989
|
summary: "Get a deployment",
|
|
@@ -1584,20 +1991,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1584
1991
|
tags: ["deployments"],
|
|
1585
1992
|
successDescription: "The deployment details"
|
|
1586
1993
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1587
|
-
const
|
|
1994
|
+
const logEntrySchema = z.object({
|
|
1995
|
+
timestamp: z.coerce.date(),
|
|
1996
|
+
type: z.enum([
|
|
1997
|
+
"START",
|
|
1998
|
+
"END",
|
|
1999
|
+
"INFO",
|
|
2000
|
+
"ERROR",
|
|
2001
|
+
"WARNING",
|
|
2002
|
+
"DEBUG"
|
|
2003
|
+
]),
|
|
2004
|
+
requestId: z.string(),
|
|
2005
|
+
content: z.string().optional(),
|
|
2006
|
+
method: z.string().optional(),
|
|
2007
|
+
durationInMs: z.number().optional()
|
|
2008
|
+
});
|
|
2009
|
+
const getLogsContractV1 = base.route({
|
|
1588
2010
|
path: "/v1/environments/{environmentId}/logs",
|
|
1589
2011
|
method: "GET",
|
|
1590
2012
|
summary: "Get logs",
|
|
1591
2013
|
description: "Get logs for an environment",
|
|
1592
2014
|
tags: ["environments"],
|
|
1593
2015
|
successDescription: "The logs"
|
|
1594
|
-
}).errors({
|
|
1595
|
-
NOT_FOUND: {},
|
|
1596
|
-
BAD_REQUEST: {}
|
|
1597
|
-
}).input(z.object({
|
|
2016
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1598
2017
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1599
|
-
since:
|
|
1600
|
-
until:
|
|
2018
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2019
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1601
2020
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1602
2021
|
level: z.array(z.enum([
|
|
1603
2022
|
"INFO",
|
|
@@ -1608,34 +2027,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1608
2027
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1609
2028
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1610
2029
|
})).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
|
-
})),
|
|
2030
|
+
logs: z.array(logEntrySchema),
|
|
1626
2031
|
nextToken: z.string().nullable()
|
|
1627
2032
|
}));
|
|
1628
|
-
const getLatestLogsContractV1 =
|
|
2033
|
+
const getLatestLogsContractV1 = base.route({
|
|
1629
2034
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1630
2035
|
method: "GET",
|
|
1631
2036
|
summary: "Get latest logs",
|
|
1632
2037
|
description: "Get the N most recent logs for an environment",
|
|
1633
2038
|
tags: ["environments"],
|
|
1634
2039
|
successDescription: "The latest logs"
|
|
1635
|
-
}).errors({
|
|
1636
|
-
NOT_FOUND: {},
|
|
1637
|
-
BAD_REQUEST: {}
|
|
1638
|
-
}).input(z.object({
|
|
2040
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1639
2041
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1640
2042
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1641
2043
|
level: z.array(z.enum([
|
|
@@ -1645,22 +2047,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1645
2047
|
"DEBUG"
|
|
1646
2048
|
])).optional().describe("Filter by log level"),
|
|
1647
2049
|
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({
|
|
2050
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
2051
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1664
2052
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1665
2053
|
method: "GET",
|
|
1666
2054
|
summary: "Get deployment logs",
|
|
@@ -1687,22 +2075,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1687
2075
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1688
2076
|
task_count: z.array(analyticsDataPointSchema)
|
|
1689
2077
|
});
|
|
1690
|
-
const getProjectAnalyticsContractV1 =
|
|
2078
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1691
2079
|
path: "/v1/analytics/{projectId}",
|
|
1692
2080
|
method: "GET",
|
|
1693
2081
|
summary: "Get project analytics",
|
|
1694
2082
|
description: "Get analytics data for a project over a time range",
|
|
1695
2083
|
tags: ["analytics"],
|
|
1696
2084
|
successDescription: "The project analytics data"
|
|
1697
|
-
}).errors({
|
|
1698
|
-
NOT_FOUND: {},
|
|
1699
|
-
BAD_REQUEST: {}
|
|
1700
|
-
}).input(z.object({
|
|
2085
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1701
2086
|
projectId: z.string().describe("The ID of the project"),
|
|
1702
2087
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1703
2088
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1704
2089
|
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 <=
|
|
2090
|
+
}).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
2091
|
metadata: z.object({
|
|
1707
2092
|
startTimestamp: z.number(),
|
|
1708
2093
|
endTimestamp: z.number(),
|
|
@@ -1712,7 +2097,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1712
2097
|
}),
|
|
1713
2098
|
timeSeries: analyticsTimeSeriesSchema
|
|
1714
2099
|
}));
|
|
1715
|
-
const
|
|
2100
|
+
const paginatedInsightsInputShape = {
|
|
2101
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2102
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2103
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2104
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2105
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2106
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2107
|
+
};
|
|
2108
|
+
const listIntentsContractV1 = base.route({
|
|
2109
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2110
|
+
method: "GET",
|
|
2111
|
+
summary: "List intents",
|
|
2112
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2113
|
+
tags: ["insights"],
|
|
2114
|
+
successDescription: "The grouped user intents"
|
|
2115
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2116
|
+
...paginatedInsightsInputShape,
|
|
2117
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2118
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2119
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2120
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2121
|
+
})).output(z.object({
|
|
2122
|
+
intents: z.array(z.object({
|
|
2123
|
+
id: z.string(),
|
|
2124
|
+
intentIds: z.array(z.string()).min(1),
|
|
2125
|
+
environmentId: z.string(),
|
|
2126
|
+
message: z.string(),
|
|
2127
|
+
toolName: z.string(),
|
|
2128
|
+
createdAt: z.coerce.date(),
|
|
2129
|
+
occurrenceCount: z.number().int().positive(),
|
|
2130
|
+
clientName: z.string().nullable(),
|
|
2131
|
+
clientId: z.string().nullable(),
|
|
2132
|
+
categories: z.array(z.object({
|
|
2133
|
+
id: z.string(),
|
|
2134
|
+
name: z.string(),
|
|
2135
|
+
color: intentCategoryColorSchema
|
|
2136
|
+
}))
|
|
2137
|
+
})),
|
|
2138
|
+
totalCount: z.number().int().nonnegative()
|
|
2139
|
+
}));
|
|
2140
|
+
const listFeedbacksContractV1 = base.route({
|
|
2141
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2142
|
+
method: "GET",
|
|
2143
|
+
summary: "List feedbacks",
|
|
2144
|
+
description: "List user feedback for an environment over a time range",
|
|
2145
|
+
tags: ["insights"],
|
|
2146
|
+
successDescription: "The user feedback"
|
|
2147
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2148
|
+
...paginatedInsightsInputShape,
|
|
2149
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2150
|
+
})).output(z.object({
|
|
2151
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2152
|
+
totalCount: z.number().int().nonnegative()
|
|
2153
|
+
}));
|
|
2154
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2155
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2156
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2157
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2158
|
+
method: "GET",
|
|
2159
|
+
summary: "List intent categories",
|
|
2160
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2161
|
+
tags: ["insights"],
|
|
2162
|
+
successDescription: "The intent categories"
|
|
2163
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2164
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2165
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2166
|
+
method: "POST",
|
|
2167
|
+
summary: "Create an intent category",
|
|
2168
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2169
|
+
tags: ["insights"],
|
|
2170
|
+
successDescription: "The created intent category"
|
|
2171
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2172
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2173
|
+
name: intentCategoryNameSchema,
|
|
2174
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2175
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2176
|
+
})).output(intentCategorySchema);
|
|
2177
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2178
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2179
|
+
method: "PATCH",
|
|
2180
|
+
summary: "Update an intent category",
|
|
2181
|
+
description: "Rename or recolor an intent category",
|
|
2182
|
+
tags: ["insights"],
|
|
2183
|
+
successDescription: "The updated intent category"
|
|
2184
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2185
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2186
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2187
|
+
name: intentCategoryNameSchema.optional(),
|
|
2188
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2189
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2190
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2191
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2192
|
+
method: "DELETE",
|
|
2193
|
+
summary: "Delete an intent category",
|
|
2194
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2195
|
+
tags: ["insights"],
|
|
2196
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2197
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2198
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2199
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2200
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2201
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2202
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2203
|
+
method: "POST",
|
|
2204
|
+
summary: "Link an intent category",
|
|
2205
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2206
|
+
tags: ["insights"],
|
|
2207
|
+
successDescription: "The intents have been linked successfully"
|
|
2208
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2209
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2210
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2211
|
+
intentIds: categorizableIntentIdsSchema
|
|
2212
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2213
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2214
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2215
|
+
method: "POST",
|
|
2216
|
+
summary: "Unlink an intent category",
|
|
2217
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2218
|
+
tags: ["insights"],
|
|
2219
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2220
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2221
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2222
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2223
|
+
intentIds: categorizableIntentIdsSchema
|
|
2224
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2225
|
+
const listTeamsContractV1 = base.route({
|
|
1716
2226
|
path: "/v1/teams",
|
|
1717
2227
|
method: "GET",
|
|
1718
2228
|
summary: "List teams",
|
|
@@ -1725,28 +2235,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
1725
2235
|
createdAt: z.coerce.date(),
|
|
1726
2236
|
hasStripeAccount: z.boolean()
|
|
1727
2237
|
})));
|
|
1728
|
-
const
|
|
2238
|
+
const getTeamUsageContractV1 = base.route({
|
|
2239
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2240
|
+
method: "GET",
|
|
2241
|
+
summary: "Get team usage",
|
|
2242
|
+
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.",
|
|
2243
|
+
tags: ["teams"],
|
|
2244
|
+
successDescription: "The current billing window usage"
|
|
2245
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2246
|
+
teamId: z.string(),
|
|
2247
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2248
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2249
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2250
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2251
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2252
|
+
}));
|
|
2253
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1729
2254
|
path: "/v1/tunnels/ticket",
|
|
1730
2255
|
method: "GET",
|
|
1731
2256
|
summary: "Get a tunnel ticket",
|
|
1732
2257
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1733
2258
|
tags: ["tunnels"],
|
|
1734
2259
|
successDescription: "The tunnel ticket"
|
|
1735
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
2260
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1736
2261
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1737
2262
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1738
2263
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1739
2264
|
}));
|
|
1740
|
-
const publishServerContractV1 =
|
|
2265
|
+
const publishServerContractV1 = base.route({
|
|
1741
2266
|
path: "/v1/distribution/publish",
|
|
1742
2267
|
method: "POST",
|
|
1743
2268
|
summary: "Publish a server to the MCP registry",
|
|
1744
2269
|
tags: ["distribution"],
|
|
1745
2270
|
successDescription: "The server has been published successfully"
|
|
1746
|
-
}).errors({
|
|
1747
|
-
NOT_FOUND: {},
|
|
1748
|
-
BAD_REQUEST: {}
|
|
1749
|
-
}).input(z.object({
|
|
2271
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1750
2272
|
projectId: z.string(),
|
|
1751
2273
|
domain: z.string(),
|
|
1752
2274
|
title: z.string().min(1).max(100),
|
|
@@ -1755,17 +2277,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1755
2277
|
iconSrc: z.url().max(255).optional(),
|
|
1756
2278
|
dryRun: z.boolean().optional()
|
|
1757
2279
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1758
|
-
const getServerInfoContractV1 =
|
|
2280
|
+
const getServerInfoContractV1 = base.route({
|
|
1759
2281
|
path: "/v1/distribution/get",
|
|
1760
2282
|
method: "GET",
|
|
1761
2283
|
summary: "Get server info",
|
|
1762
2284
|
description: "Get info about a server",
|
|
1763
2285
|
tags: ["distribution"],
|
|
1764
2286
|
successDescription: "The server info"
|
|
1765
|
-
}).errors({
|
|
1766
|
-
NOT_FOUND: {},
|
|
1767
|
-
BAD_REQUEST: {}
|
|
1768
|
-
}).input(z.object({
|
|
2287
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1769
2288
|
projectId: z.string(),
|
|
1770
2289
|
domain: z.string()
|
|
1771
2290
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1784,7 +2303,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1784
2303
|
isPlaygroundEnabled: z.boolean(),
|
|
1785
2304
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1786
2305
|
});
|
|
1787
|
-
const getPlaygroundContractV1 =
|
|
2306
|
+
const getPlaygroundContractV1 = base.route({
|
|
1788
2307
|
path: "/v1/environments/{environmentId}/playground",
|
|
1789
2308
|
method: "GET",
|
|
1790
2309
|
summary: "Get playground configuration",
|
|
@@ -1792,17 +2311,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1792
2311
|
tags: ["environments"],
|
|
1793
2312
|
successDescription: "The playground configuration"
|
|
1794
2313
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1795
|
-
const upsertPlaygroundContractV1 =
|
|
2314
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1796
2315
|
path: "/v1/environments/{environmentId}/playground",
|
|
1797
2316
|
method: "PUT",
|
|
1798
2317
|
summary: "Update playground configuration",
|
|
1799
2318
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1800
2319
|
tags: ["environments"],
|
|
1801
2320
|
successDescription: "The updated playground configuration"
|
|
1802
|
-
}).errors({
|
|
1803
|
-
NOT_FOUND: {},
|
|
1804
|
-
BAD_REQUEST: {}
|
|
1805
|
-
}).input(z.object({
|
|
2321
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1806
2322
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1807
2323
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1808
2324
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1810,7 +2326,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1810
2326
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1811
2327
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1812
2328
|
})).output(playgroundOutputSchema);
|
|
1813
|
-
const createBeaconContractV1 =
|
|
2329
|
+
const createBeaconContractV1 = base.route({
|
|
1814
2330
|
path: "/v1/beacon/audits",
|
|
1815
2331
|
method: "POST",
|
|
1816
2332
|
summary: "Create a beacon audit",
|
|
@@ -1819,7 +2335,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1819
2335
|
successDescription: "The audit has been created"
|
|
1820
2336
|
}).errors({
|
|
1821
2337
|
NOT_FOUND: {},
|
|
1822
|
-
BAD_REQUEST: {},
|
|
1823
2338
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1824
2339
|
}).input(z.object({
|
|
1825
2340
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1827,7 +2342,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1827
2342
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1828
2343
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1829
2344
|
})).output(z.object({ id: z.string() }));
|
|
1830
|
-
const getBeaconContractV1 =
|
|
2345
|
+
const getBeaconContractV1 = base.route({
|
|
1831
2346
|
path: "/v1/beacon/audits/{auditId}",
|
|
1832
2347
|
method: "GET",
|
|
1833
2348
|
summary: "Get a beacon audit",
|
|
@@ -1842,9 +2357,61 @@ const getBeaconContractV1 = oc.route({
|
|
|
1842
2357
|
createdAt: z.coerce.date(),
|
|
1843
2358
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1844
2359
|
}));
|
|
2360
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2361
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2362
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2363
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2364
|
+
const createSubmissionContractV1 = base.route({
|
|
2365
|
+
path: "/v1/submissions",
|
|
2366
|
+
method: "POST",
|
|
2367
|
+
summary: "Create a submission package",
|
|
2368
|
+
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.",
|
|
2369
|
+
tags: ["submissions"],
|
|
2370
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2371
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2372
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2373
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2374
|
+
})).output(submissionSchema);
|
|
2375
|
+
const getSubmissionContractV1 = base.route({
|
|
2376
|
+
path: "/v1/submissions/{submissionId}",
|
|
2377
|
+
method: "GET",
|
|
2378
|
+
summary: "Get a submission package",
|
|
2379
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2380
|
+
tags: ["submissions"],
|
|
2381
|
+
successDescription: "The submission package"
|
|
2382
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2383
|
+
const updateSubmissionContractV1 = base.route({
|
|
2384
|
+
path: "/v1/submissions/{submissionId}",
|
|
2385
|
+
method: "PUT",
|
|
2386
|
+
summary: "Update a submission package",
|
|
2387
|
+
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.",
|
|
2388
|
+
tags: ["submissions"],
|
|
2389
|
+
successDescription: "The updated submission package"
|
|
2390
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2391
|
+
submissionId: submissionIdSchema,
|
|
2392
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2393
|
+
formData: claudeSubmissionUpdateSchema
|
|
2394
|
+
}), z.object({
|
|
2395
|
+
submissionId: submissionIdSchema,
|
|
2396
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2397
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2398
|
+
})])).output(submissionSchema);
|
|
1845
2399
|
const contract = {
|
|
1846
|
-
teams: {
|
|
2400
|
+
teams: {
|
|
2401
|
+
list: { v1: listTeamsContractV1 },
|
|
2402
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2403
|
+
},
|
|
1847
2404
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2405
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2406
|
+
intentCategories: {
|
|
2407
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2408
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2409
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2410
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2411
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2412
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2413
|
+
},
|
|
2414
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1848
2415
|
deployments: {
|
|
1849
2416
|
list: { v1: listDeploymentsContractV1 },
|
|
1850
2417
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1854,6 +2421,7 @@ const contract = {
|
|
|
1854
2421
|
environments: {
|
|
1855
2422
|
create: { v1: createEnvironmentContractV1 },
|
|
1856
2423
|
get: { v1: getEnvironmentContractV1 },
|
|
2424
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1857
2425
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1858
2426
|
getLogs: { v1: getLogsContractV1 },
|
|
1859
2427
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1883,7 +2451,38 @@ const contract = {
|
|
|
1883
2451
|
beacon: {
|
|
1884
2452
|
create: { v1: createBeaconContractV1 },
|
|
1885
2453
|
get: { v1: getBeaconContractV1 }
|
|
2454
|
+
},
|
|
2455
|
+
submissions: {
|
|
2456
|
+
create: { v1: createSubmissionContractV1 },
|
|
2457
|
+
get: { v1: getSubmissionContractV1 },
|
|
2458
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2459
|
+
}
|
|
2460
|
+
};
|
|
2461
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2462
|
+
const contractForDocs = {
|
|
2463
|
+
...contract,
|
|
2464
|
+
deployments: deploymentsForDocs
|
|
2465
|
+
};
|
|
2466
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2467
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2468
|
+
info: {
|
|
2469
|
+
title: "Alpic API",
|
|
2470
|
+
version: "1.0.0"
|
|
2471
|
+
},
|
|
2472
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2473
|
+
security: [{ bearerAuth: [] }],
|
|
2474
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2475
|
+
type: "http",
|
|
2476
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2477
|
+
scheme: "bearer"
|
|
2478
|
+
} } },
|
|
2479
|
+
commonSchemas: {
|
|
2480
|
+
Submission: { schema: submissionSchema },
|
|
2481
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2482
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2483
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2484
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
1886
2485
|
}
|
|
1887
2486
|
};
|
|
1888
2487
|
//#endregion
|
|
1889
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2488
|
+
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 };
|