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