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