@alpic-ai/api 0.0.0-dev.gf21ae43 → 0.0.0-dev.gf2356ad
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 +6711 -84
- package/dist/index.mjs +1154 -404
- 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),
|
|
@@ -370,11 +426,21 @@ const environmentSchema$1 = z.object({
|
|
|
370
426
|
});
|
|
371
427
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
372
428
|
z.object({
|
|
429
|
+
sessionReplayEnabled: z.boolean(),
|
|
430
|
+
collectRequestPayload: z.boolean(),
|
|
431
|
+
collectResponsePayload: 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()
|
|
436
|
+
});
|
|
437
|
+
const feedbackSchema = z.object({
|
|
373
438
|
id: z.string(),
|
|
374
439
|
createdAt: z.coerce.date(),
|
|
375
440
|
environmentId: z.string(),
|
|
376
441
|
content: z.string(),
|
|
377
|
-
source: z.enum(["model", "user"])
|
|
442
|
+
source: z.enum(["model", "user"]),
|
|
443
|
+
clientName: z.string().nullable()
|
|
378
444
|
});
|
|
379
445
|
z.object({
|
|
380
446
|
content: z.string(),
|
|
@@ -390,7 +456,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
390
456
|
"pink",
|
|
391
457
|
"gray"
|
|
392
458
|
]);
|
|
393
|
-
intentCategoryColorSchema.options;
|
|
459
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
394
460
|
const intentCategorySchema = z.object({
|
|
395
461
|
id: z.string(),
|
|
396
462
|
createdAt: z.coerce.date(),
|
|
@@ -398,7 +464,7 @@ const intentCategorySchema = z.object({
|
|
|
398
464
|
name: z.string(),
|
|
399
465
|
color: intentCategoryColorSchema
|
|
400
466
|
});
|
|
401
|
-
z.object({
|
|
467
|
+
const intentCategorySummarySchema = z.object({
|
|
402
468
|
id: z.string(),
|
|
403
469
|
name: z.string(),
|
|
404
470
|
color: intentCategoryColorSchema,
|
|
@@ -410,6 +476,7 @@ z.object({
|
|
|
410
476
|
environmentId: z.string(),
|
|
411
477
|
toolName: z.string(),
|
|
412
478
|
message: z.string(),
|
|
479
|
+
clientName: z.string().nullable(),
|
|
413
480
|
categories: z.array(intentCategorySchema)
|
|
414
481
|
});
|
|
415
482
|
const signalCategorySchema = z.object({
|
|
@@ -468,12 +535,270 @@ z.object({
|
|
|
468
535
|
createdAt: z.coerce.date(),
|
|
469
536
|
updatedAt: z.coerce.date()
|
|
470
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]);
|
|
471
548
|
z.enum([
|
|
472
549
|
"INFO",
|
|
473
550
|
"WARNING",
|
|
474
551
|
"DEBUG",
|
|
475
552
|
"ERROR"
|
|
476
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]));
|
|
477
802
|
const runtimeSchema = z.enum([
|
|
478
803
|
"python3.13",
|
|
479
804
|
"python3.14",
|
|
@@ -499,18 +824,31 @@ z.object({
|
|
|
499
824
|
buildOutputDir: z.string().nullable(),
|
|
500
825
|
startCommand: z.string().nullable(),
|
|
501
826
|
fixedOutboundIp: z.boolean(),
|
|
827
|
+
excludedUserIds: z.array(z.string().trim().min(1).max(512)).default([]),
|
|
502
828
|
environments: z.array(environmentWithDomainsSchema),
|
|
503
829
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
504
830
|
});
|
|
831
|
+
const domainFailureReasonSchema = z.enum([
|
|
832
|
+
"caa",
|
|
833
|
+
"dns",
|
|
834
|
+
"invalid_domain",
|
|
835
|
+
"other"
|
|
836
|
+
]);
|
|
837
|
+
const projectDomainMappingSchema = z.object({
|
|
838
|
+
pathPrefix: z.string(),
|
|
839
|
+
environment: environmentSchema$1
|
|
840
|
+
});
|
|
505
841
|
z.object({
|
|
506
|
-
|
|
842
|
+
name: z.string(),
|
|
507
843
|
createdAt: z.coerce.date(),
|
|
508
844
|
status: z.enum([
|
|
509
845
|
"ongoing",
|
|
510
846
|
"deployed",
|
|
511
847
|
"failed"
|
|
512
848
|
]),
|
|
513
|
-
|
|
849
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
850
|
+
environment: environmentSchema$1,
|
|
851
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
514
852
|
});
|
|
515
853
|
const serverFieldsSchema$1 = z.object({
|
|
516
854
|
$schema: z.string(),
|
|
@@ -539,15 +877,7 @@ z.object({
|
|
|
539
877
|
serverFields: serverFieldsSchema$1,
|
|
540
878
|
source: z.enum(["registry", "defaults"])
|
|
541
879
|
});
|
|
542
|
-
/**
|
|
543
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
544
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
545
|
-
*
|
|
546
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
547
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
548
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
549
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
550
|
-
*/
|
|
880
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
551
881
|
const clampStringField = (field) => {
|
|
552
882
|
const max = field.maxLength;
|
|
553
883
|
if (max === null) return field;
|
|
@@ -555,6 +885,10 @@ const clampStringField = (field) => {
|
|
|
555
885
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
556
886
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
557
887
|
};
|
|
888
|
+
const unboundedArrayField = (field) => {
|
|
889
|
+
const unbounded = z.array(field.element);
|
|
890
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
891
|
+
};
|
|
558
892
|
const toolDefinitionSchema = z.object({
|
|
559
893
|
name: z.string(),
|
|
560
894
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -567,17 +901,31 @@ const toolDefinitionSchema = z.object({
|
|
|
567
901
|
}).optional()
|
|
568
902
|
});
|
|
569
903
|
const positiveTestCaseSchema = z.object({
|
|
570
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
571
|
-
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
904
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
905
|
+
userPrompt: z.string().min(1).describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
572
906
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
573
907
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
574
|
-
}).
|
|
908
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
909
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
910
|
+
scenario: z.string().optional(),
|
|
911
|
+
userPrompt: z.string().optional()
|
|
912
|
+
});
|
|
913
|
+
const blankPositiveTestCase = () => ({
|
|
914
|
+
scenario: "",
|
|
915
|
+
userPrompt: "",
|
|
916
|
+
toolTriggered: "",
|
|
917
|
+
expectedOutput: ""
|
|
918
|
+
});
|
|
919
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
575
920
|
const screenshotEntrySchema = z.object({
|
|
576
921
|
prompt: z.string(),
|
|
577
|
-
url: z.url()
|
|
922
|
+
url: z.url()
|
|
578
923
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
924
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
579
925
|
/** Accepts either a valid email or URL. */
|
|
580
926
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
927
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
928
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
581
929
|
const chatgptCategorySchema = z.enum([
|
|
582
930
|
"BUSINESS",
|
|
583
931
|
"COLLABORATION",
|
|
@@ -881,20 +1229,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
881
1229
|
"zh-TW"
|
|
882
1230
|
]);
|
|
883
1231
|
const negativeTestCaseSchema = z.object({
|
|
884
|
-
scenario: z.string(),
|
|
885
|
-
userPrompt: z.string()
|
|
886
|
-
}).
|
|
1232
|
+
scenario: z.string().min(1),
|
|
1233
|
+
userPrompt: z.string().min(1)
|
|
1234
|
+
}).describe("Each case: Scenario + User prompt (the plugin should NOT trigger).");
|
|
1235
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1236
|
+
scenario: z.string().optional(),
|
|
1237
|
+
userPrompt: z.string().optional()
|
|
1238
|
+
});
|
|
1239
|
+
const blankNegativeTestCase = () => ({
|
|
1240
|
+
scenario: "",
|
|
1241
|
+
userPrompt: ""
|
|
1242
|
+
});
|
|
1243
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
887
1244
|
const chatgptToolJustificationSchema = z.object({
|
|
888
1245
|
toolName: z.string(),
|
|
889
1246
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
890
1247
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
891
1248
|
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
892
1249
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
893
|
-
/**
|
|
894
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
895
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
896
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
897
|
-
*/
|
|
1250
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
898
1251
|
const chatgptTaglineSchema = z.string().max(30);
|
|
899
1252
|
const chatgptDescriptionSchema = z.string();
|
|
900
1253
|
const chatgptTranslationSchema = z.object({
|
|
@@ -903,52 +1256,73 @@ const chatgptTranslationSchema = z.object({
|
|
|
903
1256
|
description: chatgptDescriptionSchema
|
|
904
1257
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
905
1258
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
906
|
-
/**
|
|
907
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
908
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
909
|
-
*/
|
|
1259
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
910
1260
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
911
1261
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
912
1262
|
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."),
|
|
913
|
-
appName: z.string().describe("The name users will see in ChatGPT and in the
|
|
1263
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Plugin Directory."),
|
|
914
1264
|
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
915
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the
|
|
1265
|
+
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)."),
|
|
916
1266
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
917
|
-
developerName: z.string().describe("Developer name shown publicly on the
|
|
918
|
-
companyUrl:
|
|
1267
|
+
developerName: z.string().describe("Developer name shown publicly on the plugin's directory page."),
|
|
1268
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
919
1269
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
920
|
-
privacyPolicyUrl:
|
|
921
|
-
termsOfServiceUrl:
|
|
922
|
-
demoRecordingUrl:
|
|
923
|
-
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My
|
|
924
|
-
serverUrl:
|
|
1270
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1271
|
+
termsOfServiceUrl: urlField.describe("URL to the plugin's terms of service."),
|
|
1272
|
+
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."),
|
|
1273
|
+
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."),
|
|
1274
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
925
1275
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
926
1276
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
927
1277
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
1278
|
+
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."),
|
|
1279
|
+
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."),
|
|
1280
|
+
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."),
|
|
1281
|
+
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."),
|
|
931
1282
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
932
1283
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
933
|
-
releaseNotes: z.string().describe("Publicly displayed on the
|
|
1284
|
+
releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
|
|
1285
|
+
});
|
|
1286
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1287
|
+
tagline: z.string().optional(),
|
|
1288
|
+
companyUrl: z.string().optional(),
|
|
1289
|
+
supportChannel: z.string().optional(),
|
|
1290
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1291
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1292
|
+
demoRecordingUrl: z.string().optional(),
|
|
1293
|
+
serverUrl: z.string().optional(),
|
|
1294
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1295
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1296
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1297
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
934
1298
|
});
|
|
935
|
-
|
|
1299
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1300
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
936
1301
|
appName: true,
|
|
937
1302
|
developerName: true,
|
|
938
1303
|
serverUrl: true,
|
|
939
1304
|
tools: true,
|
|
1305
|
+
skills: true,
|
|
940
1306
|
authentication: true
|
|
941
1307
|
});
|
|
942
|
-
|
|
1308
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1309
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
943
1310
|
tagline: true,
|
|
944
1311
|
description: true,
|
|
945
1312
|
category: true,
|
|
946
1313
|
testCases: true,
|
|
947
1314
|
negativeTestCases: true,
|
|
948
1315
|
toolJustifications: true
|
|
949
|
-
}).extend({
|
|
1316
|
+
}).extend({
|
|
1317
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1318
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1319
|
+
}).extend({
|
|
1320
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1321
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1322
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1323
|
+
});
|
|
950
1324
|
const claudeCategorySchema = z.enum([
|
|
951
|
-
"
|
|
1325
|
+
"Productivity",
|
|
952
1326
|
"Communication",
|
|
953
1327
|
"Data & Analytics",
|
|
954
1328
|
"Development tools",
|
|
@@ -956,222 +1330,222 @@ const claudeCategorySchema = z.enum([
|
|
|
956
1330
|
"Consumer Health",
|
|
957
1331
|
"Health & Life Sciences",
|
|
958
1332
|
"Media & Entertainment",
|
|
959
|
-
"Commerce & Shopping"
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
"
|
|
963
|
-
"
|
|
964
|
-
"
|
|
1333
|
+
"Commerce & Shopping",
|
|
1334
|
+
"Legal",
|
|
1335
|
+
"Sales and marketing",
|
|
1336
|
+
"Creative",
|
|
1337
|
+
"Nonprofit",
|
|
1338
|
+
"Education",
|
|
1339
|
+
"Other"
|
|
965
1340
|
]);
|
|
966
|
-
const
|
|
967
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1341
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
968
1342
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
969
|
-
"
|
|
970
|
-
"
|
|
971
|
-
"
|
|
1343
|
+
"read_only",
|
|
1344
|
+
"write_only",
|
|
1345
|
+
"read_write"
|
|
972
1346
|
]);
|
|
973
|
-
const
|
|
974
|
-
|
|
975
|
-
"
|
|
976
|
-
"
|
|
977
|
-
"
|
|
978
|
-
"
|
|
979
|
-
]);
|
|
980
|
-
const claudeThirdPartySchema = z.enum([
|
|
981
|
-
"Web access: Fetches information from the open web (e.g., web scraping, search engines, or browsing arbitrary URLs, not just connecting to a specific API)",
|
|
982
|
-
"Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
|
|
983
|
-
"Third-party data retrieval: Connects to external services that themselves retrieve data from other sources (e.g., workflow automation platforms or other services that aggregate or relay data from multiple third-party sources)",
|
|
984
|
-
"Third-party data modification: Can connect to external services that themselves create, update, or delete data in other sources (e.g., workflow automation platforms or other services that write to multiple third-party sources)",
|
|
985
|
-
"N/A"
|
|
1347
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1348
|
+
"oauth_dcr",
|
|
1349
|
+
"oauth_cimd",
|
|
1350
|
+
"oauth_anthropic_creds",
|
|
1351
|
+
"custom_connection",
|
|
1352
|
+
"none"
|
|
986
1353
|
]);
|
|
987
|
-
const
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"GDPR compliant (if applicable)"
|
|
1354
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1355
|
+
"first_party",
|
|
1356
|
+
"proxied",
|
|
1357
|
+
"third_party"
|
|
992
1358
|
]);
|
|
993
|
-
const
|
|
994
|
-
|
|
995
|
-
"
|
|
996
|
-
"
|
|
1359
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1360
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1361
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1362
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1363
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1364
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1365
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1366
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1367
|
+
"Public documentation for this connector will be live by the publish date."
|
|
997
1368
|
]);
|
|
998
|
-
/**
|
|
999
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
1000
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
1001
|
-
*/
|
|
1369
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1002
1370
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
(
|
|
1013
|
-
|
|
1014
|
-
(
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
•
|
|
1032
|
-
•
|
|
1033
|
-
•
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
• '
|
|
1049
|
-
• '
|
|
1050
|
-
• '
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
• 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
|
|
1081
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
1082
|
-
serverDocumentationLink: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. This is displayed in the Directory listing and must be publicly accessible without login. Minimum requirements for the docs page:
|
|
1083
|
-
• What the connector does and its key capabilities
|
|
1084
|
-
• How to connect/set it up (step by step)
|
|
1085
|
-
• What each tool does (or at least the main ones)
|
|
1086
|
-
• How to troubleshoot common issues
|
|
1087
|
-
• A support contact or channel
|
|
1088
|
-
Acceptable formats: a dedicated docs page, a help center article, a README on GitHub, or a blog post — as long as it's comprehensive. Note: Anthropic requires public documentation to be live by your publish date.`),
|
|
1089
|
-
privacyPolicyUrl: z.url().describe(`URL to your privacy policy. This is mandatory and displayed in the directory listing. Missing or incomplete privacy policies result in immediate rejection. Your privacy policy must cover:
|
|
1090
|
-
• What data you collect (and how)
|
|
1091
|
-
• How you use the collected data
|
|
1092
|
-
• Where and how long you store it
|
|
1093
|
-
• Whether you share data with third parties (and who)
|
|
1094
|
-
• How users can contact you about data concerns
|
|
1095
|
-
The policy must be publicly accessible. If you don't have one yet, create one before submitting — there are free generators online, but make sure it accurately reflects your actual practices. If you're GDPR-compliant, your policy should reflect that.`),
|
|
1096
|
-
supportChannel: supportChannelSchema.describe(`A URL or email address where users can get help with your connector. This is displayed in the Directory listing. Acceptable options:
|
|
1097
|
-
• Email address (e.g. support@myapp.com)
|
|
1098
|
-
• Link to a GitHub Issues page
|
|
1099
|
-
• Link to a help center or support article
|
|
1100
|
-
• Link to a Discord/Slack community
|
|
1101
|
-
• Link to your documentation's troubleshooting section
|
|
1102
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1103
|
-
testingCredentials: z.string().describe(`Provide login credentials for a test account that Anthropic reviewers can use to verify your server works end-to-end. Critical requirements:
|
|
1104
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
1105
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
1106
|
-
• If your service uses Google OAuth or another OAuth that requires email verification, use mcp-review@anthropic.com as the account email — Anthropic has access to this inbox.
|
|
1107
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
1108
|
-
• If your service requires API keys instead of a password, provide those.
|
|
1109
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
1110
|
-
tools: z.array(toolDefinitionSchema).describe(`A comma-separated list of all tools your MCP server exposes. Use the format: tool_name (Human-Readable Name). The tool_name is the internal identifier (snake_case, max 64 characters). The Human-Readable Name is what users see.
|
|
1111
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
1112
|
-
Reviewers test every single tool you list here — don't list tools that don't work. Also: do not have a single catch-all tool like api_request(method, endpoint) — Anthropic rejects these. Each action should be its own purpose-built tool.`),
|
|
1113
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
1114
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
1115
|
-
• 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
|
|
1116
|
-
This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
|
|
1117
|
-
testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
|
|
1118
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
1119
|
-
• Format: SVG only
|
|
1120
|
-
• Aspect ratio: square (1:1)
|
|
1121
|
-
• Should work on a light background
|
|
1122
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
1123
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
1124
|
-
logoDark: z.string().optional().describe(`Optional dark-mode variant of the connector logo. Same specs as the light variant (SVG, square 1:1) but designed to read on a dark background. Leave empty if the light logo already works on dark.`),
|
|
1125
|
-
screenshots: z.array(screenshotEntrySchema).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
|
|
1126
|
-
• 3–5 images is ideal
|
|
1127
|
-
• Minimum 1000px width, PNG format preferred
|
|
1128
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
1129
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
1130
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
1131
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
1132
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1133
|
-
});
|
|
1134
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1135
|
-
companyName: true,
|
|
1136
|
-
appName: true,
|
|
1137
|
-
mcpUrlType: true,
|
|
1371
|
+
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
|
|
1372
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1373
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1374
|
+
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
|
|
1375
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1376
|
+
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.
|
|
1377
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1378
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1379
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1380
|
+
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
|
|
1381
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1382
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1383
|
+
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
|
|
1384
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1385
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1386
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1387
|
+
by your publish date.`),
|
|
1388
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1389
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1390
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1391
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1392
|
+
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
|
|
1393
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1394
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1395
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1396
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1397
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1398
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1399
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1400
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1401
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1402
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1403
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1404
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1405
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1406
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1407
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1408
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1409
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1410
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1411
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1412
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1413
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1414
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1415
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1416
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1417
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1418
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1419
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1420
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1421
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1422
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1423
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1424
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1425
|
+
fully populated account.`),
|
|
1426
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1427
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1428
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1429
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1430
|
+
});
|
|
1431
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1432
|
+
serverUrl: z.string().optional(),
|
|
1433
|
+
name: z.string().optional(),
|
|
1434
|
+
slug: z.string().optional(),
|
|
1435
|
+
oneLiner: z.string().optional(),
|
|
1436
|
+
description: z.string().optional(),
|
|
1437
|
+
iconUrl: z.string().optional(),
|
|
1438
|
+
documentation: z.string().optional(),
|
|
1439
|
+
support: z.string().optional(),
|
|
1440
|
+
privacyPolicy: z.string().optional(),
|
|
1441
|
+
companyWebsite: z.string().optional(),
|
|
1442
|
+
primaryContactEmail: z.string().optional(),
|
|
1443
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1444
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1445
|
+
});
|
|
1446
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1447
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1138
1448
|
serverUrl: true,
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
transportSupport: true,
|
|
1449
|
+
name: true,
|
|
1450
|
+
slug: true,
|
|
1451
|
+
companyName: true,
|
|
1143
1452
|
primaryContactEmail: true,
|
|
1144
1453
|
primaryContactName: true,
|
|
1454
|
+
readWriteCapabilities: true,
|
|
1145
1455
|
authentication: true,
|
|
1146
|
-
|
|
1147
|
-
|
|
1456
|
+
apiOwnership: true,
|
|
1457
|
+
personalHealthData: true
|
|
1148
1458
|
}).extend({
|
|
1149
1459
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1150
|
-
|
|
1460
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1461
|
+
});
|
|
1462
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1463
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1464
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1465
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1466
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1467
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1468
|
+
});
|
|
1469
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1470
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1471
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1472
|
+
});
|
|
1473
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1474
|
+
const byField = {};
|
|
1475
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1476
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1477
|
+
return byField;
|
|
1478
|
+
}
|
|
1479
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1480
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1481
|
+
"pass",
|
|
1482
|
+
"fail",
|
|
1483
|
+
"unverified"
|
|
1484
|
+
]);
|
|
1485
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1486
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1487
|
+
claudeai: ["privacyPolicy"]
|
|
1488
|
+
};
|
|
1489
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1490
|
+
const policyDisclosureSchema = z.enum([
|
|
1491
|
+
"dataCategories",
|
|
1492
|
+
"purposesOfUse",
|
|
1493
|
+
"recipients",
|
|
1494
|
+
"retention"
|
|
1495
|
+
]);
|
|
1496
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1497
|
+
field: verifiableUrlFieldSchema,
|
|
1498
|
+
url: z.string(),
|
|
1499
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1500
|
+
reason: z.string(),
|
|
1501
|
+
concerns: z.array(z.string()).optional(),
|
|
1502
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1503
|
+
});
|
|
1504
|
+
const urlVerificationSchema = z.object({
|
|
1505
|
+
verifiedAt: z.coerce.date(),
|
|
1506
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1507
|
+
});
|
|
1508
|
+
const pageKindSchema = z.enum([
|
|
1509
|
+
"expectedDocument",
|
|
1510
|
+
"errorPage",
|
|
1511
|
+
"loginWall",
|
|
1512
|
+
"parkedDomain",
|
|
1513
|
+
"comingSoon",
|
|
1514
|
+
"marketingPage",
|
|
1515
|
+
"unrelatedDocument"
|
|
1516
|
+
]);
|
|
1517
|
+
z.object({
|
|
1518
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1519
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1520
|
+
missingDisclosures: z.array(policyDisclosureSchema).describe("For a privacy policy only: which of the four required disclosures the text does not cover. Empty for every other page kind.")
|
|
1151
1521
|
});
|
|
1152
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1153
|
-
tagline: true,
|
|
1154
|
-
description: true,
|
|
1155
|
-
category: true,
|
|
1156
|
-
testCases: true
|
|
1157
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1158
1522
|
const submissionMetaFieldsSchema = z.object({
|
|
1159
1523
|
id: z.string(),
|
|
1160
1524
|
environmentId: z.string(),
|
|
1161
1525
|
auditId: z.string().nullable(),
|
|
1526
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1162
1527
|
createdAt: z.coerce.date(),
|
|
1163
1528
|
updatedAt: z.coerce.date()
|
|
1164
1529
|
});
|
|
1165
1530
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1166
1531
|
platform: z.literal("claudeai"),
|
|
1167
|
-
formData:
|
|
1532
|
+
formData: claudeSubmissionDraftSchema,
|
|
1533
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1168
1534
|
});
|
|
1169
1535
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1170
1536
|
platform: z.literal("chatgpt"),
|
|
1171
|
-
formData:
|
|
1537
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1538
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1172
1539
|
});
|
|
1173
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1174
|
-
z.union([
|
|
1540
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1541
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1542
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1543
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1544
|
+
z.literal([
|
|
1545
|
+
100,
|
|
1546
|
+
75,
|
|
1547
|
+
50
|
|
1548
|
+
]);
|
|
1175
1549
|
const subscriptionPlanSchema = z.enum([
|
|
1176
1550
|
"pro",
|
|
1177
1551
|
"business",
|
|
@@ -1183,17 +1557,84 @@ const customerCreditsSchema = z.object({
|
|
|
1183
1557
|
expiresAt: z.number().nullable(),
|
|
1184
1558
|
currency: z.string()
|
|
1185
1559
|
});
|
|
1186
|
-
const customerUsageSchema = z.object({
|
|
1187
|
-
amountInCents: z.number(),
|
|
1188
|
-
currency: z.string(),
|
|
1189
|
-
periodEnd: z.number()
|
|
1190
|
-
});
|
|
1191
1560
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1192
1561
|
z.object({
|
|
1193
1562
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1194
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1195
1563
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1196
1564
|
});
|
|
1565
|
+
const metricsQueueEventSchema = z.object({
|
|
1566
|
+
ts: z.number().int(),
|
|
1567
|
+
method: z.string(),
|
|
1568
|
+
tool: z.string().nullable(),
|
|
1569
|
+
client: z.string(),
|
|
1570
|
+
sessionId: z.string().nullable(),
|
|
1571
|
+
conversationId: z.string().nullable().optional(),
|
|
1572
|
+
durationMs: z.number().int(),
|
|
1573
|
+
outputTokens: z.number().int().nullable(),
|
|
1574
|
+
errorType: z.enum([
|
|
1575
|
+
"mcp_error",
|
|
1576
|
+
"tool_error",
|
|
1577
|
+
"timeout"
|
|
1578
|
+
]).nullable(),
|
|
1579
|
+
errorCode: z.number().int().nullable()
|
|
1580
|
+
});
|
|
1581
|
+
z.object({
|
|
1582
|
+
v: z.literal(1),
|
|
1583
|
+
envId: z.string(),
|
|
1584
|
+
events: z.array(metricsQueueEventSchema)
|
|
1585
|
+
});
|
|
1586
|
+
z.object({ v: z.number() });
|
|
1587
|
+
const TELEMETRY_SIGNALS = [
|
|
1588
|
+
"logs",
|
|
1589
|
+
"metrics",
|
|
1590
|
+
"traces"
|
|
1591
|
+
];
|
|
1592
|
+
const telemetrySignalSchema = z.enum(TELEMETRY_SIGNALS);
|
|
1593
|
+
const OTLP_PROTOCOLS = ["http/protobuf", "http/json"];
|
|
1594
|
+
const otlpProtocolSchema = z.enum(OTLP_PROTOCOLS);
|
|
1595
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1596
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1597
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1598
|
+
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");
|
|
1599
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1600
|
+
id: z.string(),
|
|
1601
|
+
name: otlpHeaderNameSchema,
|
|
1602
|
+
value: otlpHeaderValueSchema,
|
|
1603
|
+
isSecret: z.boolean()
|
|
1604
|
+
});
|
|
1605
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1606
|
+
"credentials",
|
|
1607
|
+
"wrong-path",
|
|
1608
|
+
"wrong-protocol",
|
|
1609
|
+
"invalid-payload",
|
|
1610
|
+
"partial-rejection",
|
|
1611
|
+
"blocked-target",
|
|
1612
|
+
"timeout",
|
|
1613
|
+
"unreachable",
|
|
1614
|
+
"receiver-error",
|
|
1615
|
+
"unexpected-status"
|
|
1616
|
+
]);
|
|
1617
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1618
|
+
z.object({
|
|
1619
|
+
id: z.string(),
|
|
1620
|
+
signal: telemetrySignalSchema,
|
|
1621
|
+
endpoint: otlpEndpointSchema,
|
|
1622
|
+
protocol: otlpProtocolSchema,
|
|
1623
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1624
|
+
status: telemetryDestinationStatusSchema,
|
|
1625
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1626
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1627
|
+
});
|
|
1628
|
+
const hasDuplicateHeaderNames = (headers) => {
|
|
1629
|
+
const names = headers.map(({ name }) => name.trim().toLowerCase());
|
|
1630
|
+
return new Set(names).size !== names.length;
|
|
1631
|
+
};
|
|
1632
|
+
//#endregion
|
|
1633
|
+
//#region src/auth-scope.ts
|
|
1634
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1635
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1636
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1637
|
+
const AUTH_SCOPE_USER = "user";
|
|
1197
1638
|
//#endregion
|
|
1198
1639
|
//#region src/schemas.ts
|
|
1199
1640
|
const RESERVED_KEYS = [
|
|
@@ -1230,7 +1671,10 @@ const RESERVED_KEYS = [
|
|
|
1230
1671
|
"BUILD_ARG_START_COMMAND",
|
|
1231
1672
|
"ALPIC_HOST",
|
|
1232
1673
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1233
|
-
"ALPIC_INTENT_META_KEY"
|
|
1674
|
+
"ALPIC_INTENT_META_KEY",
|
|
1675
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1676
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1677
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1234
1678
|
];
|
|
1235
1679
|
const environmentVariableSchema = z.object({
|
|
1236
1680
|
key: z.string().min(2, "Key must be at least 2 characters").regex(/^[a-zA-Z]([a-zA-Z0-9_])+$/, "Key must start with a letter and contain only letters, numbers, and underscores").refine((key) => !RESERVED_KEYS.includes(key), "This key is reserved and cannot be used as an environment variable key"),
|
|
@@ -1283,6 +1727,14 @@ const serverFieldsSchema = z.object({
|
|
|
1283
1727
|
});
|
|
1284
1728
|
//#endregion
|
|
1285
1729
|
//#region src/api.contract.ts
|
|
1730
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1731
|
+
try {
|
|
1732
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1733
|
+
return true;
|
|
1734
|
+
} catch {
|
|
1735
|
+
return false;
|
|
1736
|
+
}
|
|
1737
|
+
};
|
|
1286
1738
|
const deploymentStatusSchema = z.enum([
|
|
1287
1739
|
"ongoing",
|
|
1288
1740
|
"deployed",
|
|
@@ -1311,21 +1763,20 @@ const deploymentSchema = z.object({
|
|
|
1311
1763
|
isCurrent: z.boolean(),
|
|
1312
1764
|
deploymentPageUrl: z.url().nullable()
|
|
1313
1765
|
});
|
|
1314
|
-
const
|
|
1766
|
+
const isValidTimeInput = (value) => {
|
|
1315
1767
|
if (ms(value) !== void 0) return true;
|
|
1316
1768
|
return !Number.isNaN(new Date(value).getTime());
|
|
1317
1769
|
};
|
|
1318
|
-
const
|
|
1770
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1771
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1772
|
+
const createEnvironmentContractV1 = base.route({
|
|
1319
1773
|
path: "/v1/environments",
|
|
1320
1774
|
method: "POST",
|
|
1321
1775
|
summary: "Create an environment",
|
|
1322
1776
|
description: "Create an environment for a project",
|
|
1323
1777
|
tags: ["environments"],
|
|
1324
1778
|
successDescription: "The environment has been created successfully"
|
|
1325
|
-
}).errors({
|
|
1326
|
-
NOT_FOUND: {},
|
|
1327
|
-
BAD_REQUEST: {}
|
|
1328
|
-
}).input(z.object({
|
|
1779
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1329
1780
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1330
1781
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1331
1782
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1338,7 +1789,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1338
1789
|
createdAt: z.coerce.date(),
|
|
1339
1790
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1340
1791
|
}));
|
|
1341
|
-
const getEnvironmentContractV1 =
|
|
1792
|
+
const getEnvironmentContractV1 = base.route({
|
|
1342
1793
|
path: "/v1/environments/{environmentId}",
|
|
1343
1794
|
method: "GET",
|
|
1344
1795
|
summary: "Get an environment",
|
|
@@ -1354,6 +1805,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1354
1805
|
createdAt: z.coerce.date(),
|
|
1355
1806
|
projectId: z.string()
|
|
1356
1807
|
}));
|
|
1808
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1809
|
+
path: "/v1/environments/{environmentId}",
|
|
1810
|
+
method: "DELETE",
|
|
1811
|
+
summary: "Delete an environment",
|
|
1812
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1813
|
+
tags: ["environments"],
|
|
1814
|
+
successDescription: "The environment has been deleted successfully"
|
|
1815
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1357
1816
|
const domainSchema = z.object({
|
|
1358
1817
|
domain: z.string(),
|
|
1359
1818
|
status: z.enum([
|
|
@@ -1395,7 +1854,7 @@ const projectOutputSchema = z.object({
|
|
|
1395
1854
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1396
1855
|
environments: z.array(environmentSchema)
|
|
1397
1856
|
});
|
|
1398
|
-
const getProjectContractV1 =
|
|
1857
|
+
const getProjectContractV1 = base.route({
|
|
1399
1858
|
path: "/v1/projects/{projectId}",
|
|
1400
1859
|
method: "GET",
|
|
1401
1860
|
summary: "Get a project",
|
|
@@ -1403,18 +1862,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1403
1862
|
tags: ["projects"],
|
|
1404
1863
|
successDescription: "The project details"
|
|
1405
1864
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1406
|
-
const listProjectsContractV1 =
|
|
1865
|
+
const listProjectsContractV1 = base.route({
|
|
1407
1866
|
path: "/v1/projects",
|
|
1408
1867
|
method: "GET",
|
|
1409
1868
|
summary: "List projects",
|
|
1410
1869
|
description: "List all projects for a team",
|
|
1411
1870
|
tags: ["projects"],
|
|
1412
1871
|
successDescription: "The list of projects"
|
|
1413
|
-
}).errors({
|
|
1414
|
-
|
|
1415
|
-
BAD_REQUEST: {}
|
|
1416
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1417
|
-
const createProjectContractV1 = oc.route({
|
|
1872
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1873
|
+
const createProjectContractV1 = base.route({
|
|
1418
1874
|
path: "/v1/projects",
|
|
1419
1875
|
method: "POST",
|
|
1420
1876
|
summary: "Create a project",
|
|
@@ -1423,7 +1879,7 @@ const createProjectContractV1 = oc.route({
|
|
|
1423
1879
|
successDescription: "The project has been created successfully"
|
|
1424
1880
|
}).errors({
|
|
1425
1881
|
NOT_FOUND: {},
|
|
1426
|
-
|
|
1882
|
+
FORBIDDEN: {}
|
|
1427
1883
|
}).input(z.object({
|
|
1428
1884
|
teamId: z.string().optional(),
|
|
1429
1885
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1463,7 +1919,101 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1463
1919
|
isSecret: z.boolean(),
|
|
1464
1920
|
createdAt: z.coerce.date()
|
|
1465
1921
|
});
|
|
1466
|
-
const
|
|
1922
|
+
const telemetryDestinationHeaderOutputSchema = z.discriminatedUnion("isSecret", [z.object({
|
|
1923
|
+
id: z.string(),
|
|
1924
|
+
name: otlpHeaderNameSchema,
|
|
1925
|
+
value: z.null(),
|
|
1926
|
+
isSecret: z.literal(true)
|
|
1927
|
+
}), z.object({
|
|
1928
|
+
id: z.string(),
|
|
1929
|
+
name: otlpHeaderNameSchema,
|
|
1930
|
+
value: otlpHeaderValueSchema,
|
|
1931
|
+
isSecret: z.literal(false)
|
|
1932
|
+
})]);
|
|
1933
|
+
const telemetryDestinationOutputSchema = z.object({
|
|
1934
|
+
id: z.string(),
|
|
1935
|
+
signal: telemetrySignalSchema,
|
|
1936
|
+
endpoint: otlpEndpointSchema,
|
|
1937
|
+
protocol: otlpProtocolSchema,
|
|
1938
|
+
headers: z.array(telemetryDestinationHeaderOutputSchema),
|
|
1939
|
+
status: telemetryDestinationStatusSchema,
|
|
1940
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1941
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1942
|
+
});
|
|
1943
|
+
const createTelemetryDestinationHeaderInputSchema = z.object({
|
|
1944
|
+
name: otlpHeaderNameSchema,
|
|
1945
|
+
value: otlpHeaderValueSchema.min(1, "Enter a header value"),
|
|
1946
|
+
isSecret: z.boolean()
|
|
1947
|
+
});
|
|
1948
|
+
const updateTelemetryDestinationHeaderInputSchema = z.object({
|
|
1949
|
+
id: z.string().optional(),
|
|
1950
|
+
name: otlpHeaderNameSchema,
|
|
1951
|
+
value: otlpHeaderValueSchema.optional(),
|
|
1952
|
+
isSecret: z.boolean()
|
|
1953
|
+
});
|
|
1954
|
+
const uniqueTelemetryHeaders = (headers) => !hasDuplicateHeaderNames(headers);
|
|
1955
|
+
const listTelemetryDestinationsContractV1 = base.route({
|
|
1956
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
1957
|
+
method: "GET",
|
|
1958
|
+
summary: "List telemetry destinations",
|
|
1959
|
+
description: "List the OTLP destinations configured for an environment. Secret header values are never returned.",
|
|
1960
|
+
tags: ["telemetry"],
|
|
1961
|
+
successDescription: "The list of telemetry destinations"
|
|
1962
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(telemetryDestinationOutputSchema));
|
|
1963
|
+
const createTelemetryDestinationContractV1 = base.route({
|
|
1964
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
1965
|
+
method: "POST",
|
|
1966
|
+
summary: "Create a telemetry destination",
|
|
1967
|
+
description: "Verify and save an OTLP destination for logs, metrics, or traces.",
|
|
1968
|
+
tags: ["telemetry"],
|
|
1969
|
+
successDescription: "The telemetry destination has been created"
|
|
1970
|
+
}).errors({
|
|
1971
|
+
NOT_FOUND: {},
|
|
1972
|
+
FORBIDDEN: {},
|
|
1973
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 },
|
|
1974
|
+
INTERNAL_SERVER_ERROR: {}
|
|
1975
|
+
}).input(z.object({
|
|
1976
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1977
|
+
signal: telemetrySignalSchema,
|
|
1978
|
+
endpoint: otlpEndpointSchema,
|
|
1979
|
+
protocol: otlpProtocolSchema.default("http/protobuf"),
|
|
1980
|
+
isScopedToIntentionalRequestsOnly: z.boolean().default(false),
|
|
1981
|
+
headers: z.array(createTelemetryDestinationHeaderInputSchema).default([]).refine(uniqueTelemetryHeaders, "Header names must be unique")
|
|
1982
|
+
})).output(telemetryDestinationOutputSchema);
|
|
1983
|
+
const updateTelemetryDestinationContractV1 = base.route({
|
|
1984
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
1985
|
+
method: "PATCH",
|
|
1986
|
+
summary: "Update a telemetry destination",
|
|
1987
|
+
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.",
|
|
1988
|
+
tags: ["telemetry"],
|
|
1989
|
+
successDescription: "The telemetry destination has been updated"
|
|
1990
|
+
}).errors({
|
|
1991
|
+
NOT_FOUND: {},
|
|
1992
|
+
FORBIDDEN: {},
|
|
1993
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 }
|
|
1994
|
+
}).input(z.object({
|
|
1995
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1996
|
+
destinationId: z.string().describe("The ID of the telemetry destination"),
|
|
1997
|
+
endpoint: otlpEndpointSchema.optional(),
|
|
1998
|
+
protocol: otlpProtocolSchema.optional(),
|
|
1999
|
+
isScopedToIntentionalRequestsOnly: z.boolean().optional(),
|
|
2000
|
+
headers: z.array(updateTelemetryDestinationHeaderInputSchema).refine(uniqueTelemetryHeaders, "Header names must be unique").optional()
|
|
2001
|
+
})).output(telemetryDestinationOutputSchema);
|
|
2002
|
+
const deleteTelemetryDestinationContractV1 = base.route({
|
|
2003
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
2004
|
+
method: "DELETE",
|
|
2005
|
+
summary: "Delete a telemetry destination",
|
|
2006
|
+
description: "Delete an OTLP destination from an environment.",
|
|
2007
|
+
tags: ["telemetry"],
|
|
2008
|
+
successDescription: "The telemetry destination has been deleted"
|
|
2009
|
+
}).errors({
|
|
2010
|
+
NOT_FOUND: {},
|
|
2011
|
+
INTERNAL_SERVER_ERROR: {}
|
|
2012
|
+
}).input(z.object({
|
|
2013
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2014
|
+
destinationId: z.string().describe("The ID of the telemetry destination")
|
|
2015
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2016
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1467
2017
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1468
2018
|
method: "GET",
|
|
1469
2019
|
summary: "List environment variables",
|
|
@@ -1471,48 +2021,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1471
2021
|
tags: ["environments"],
|
|
1472
2022
|
successDescription: "The list of environment variables"
|
|
1473
2023
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1474
|
-
const createEnvironmentVariablesContractV1 =
|
|
2024
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1475
2025
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1476
2026
|
method: "POST",
|
|
1477
2027
|
summary: "Add environment variables",
|
|
1478
2028
|
description: "Add one or more environment variables to an environment",
|
|
1479
2029
|
tags: ["environments"],
|
|
1480
2030
|
successDescription: "The environment variables have been added successfully"
|
|
1481
|
-
}).errors({
|
|
1482
|
-
NOT_FOUND: {},
|
|
1483
|
-
BAD_REQUEST: {}
|
|
1484
|
-
}).input(z.object({
|
|
2031
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1485
2032
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1486
2033
|
environmentVariables: environmentVariablesSchema
|
|
1487
2034
|
})).output(z.object({ success: z.literal(true) }));
|
|
1488
|
-
const updateEnvironmentVariableContractV1 =
|
|
2035
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1489
2036
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1490
2037
|
method: "PATCH",
|
|
1491
2038
|
summary: "Update an environment variable",
|
|
1492
2039
|
description: "Update an environment variable by ID",
|
|
1493
2040
|
tags: ["environments"],
|
|
1494
2041
|
successDescription: "The environment variable has been updated successfully"
|
|
1495
|
-
}).errors({
|
|
1496
|
-
NOT_FOUND: {},
|
|
1497
|
-
BAD_REQUEST: {}
|
|
1498
|
-
}).input(z.object({
|
|
2042
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1499
2043
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1500
2044
|
key: environmentVariableSchema.shape.key,
|
|
1501
2045
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1502
2046
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1503
2047
|
})).output(z.object({ success: z.literal(true) }));
|
|
1504
|
-
const deleteEnvironmentVariableContractV1 =
|
|
2048
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1505
2049
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1506
2050
|
method: "DELETE",
|
|
1507
2051
|
summary: "Delete an environment variable",
|
|
1508
2052
|
description: "Delete an environment variable by ID",
|
|
1509
2053
|
tags: ["environments"],
|
|
1510
2054
|
successDescription: "The environment variable has been deleted successfully"
|
|
1511
|
-
}).errors({
|
|
1512
|
-
|
|
1513
|
-
BAD_REQUEST: {}
|
|
1514
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1515
|
-
const deleteProjectContractV1 = oc.route({
|
|
2055
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
2056
|
+
const deleteProjectContractV1 = base.route({
|
|
1516
2057
|
path: "/v1/projects/{projectId}",
|
|
1517
2058
|
method: "DELETE",
|
|
1518
2059
|
summary: "Delete a project",
|
|
@@ -1520,7 +2061,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1520
2061
|
tags: ["projects"],
|
|
1521
2062
|
successDescription: "The project has been deleted successfully"
|
|
1522
2063
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1523
|
-
const updateProjectContractV1 =
|
|
2064
|
+
const updateProjectContractV1 = base.route({
|
|
1524
2065
|
path: "/v1/projects/{projectId}",
|
|
1525
2066
|
method: "PATCH",
|
|
1526
2067
|
summary: "Update a project",
|
|
@@ -1529,13 +2070,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1529
2070
|
successDescription: "The project has been updated successfully"
|
|
1530
2071
|
}).errors({
|
|
1531
2072
|
NOT_FOUND: {},
|
|
1532
|
-
|
|
2073
|
+
FORBIDDEN: {}
|
|
1533
2074
|
}).input(z.object({
|
|
1534
2075
|
projectId: z.string().describe("The ID of the project"),
|
|
1535
2076
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1536
2077
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1537
2078
|
})).output(projectOutputSchema);
|
|
1538
|
-
const deployEnvironmentContractV1 =
|
|
2079
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1539
2080
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1540
2081
|
method: "POST",
|
|
1541
2082
|
summary: "Deploy an environment",
|
|
@@ -1544,27 +2085,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1544
2085
|
successDescription: "The environment has been deployed successfully"
|
|
1545
2086
|
}).errors({
|
|
1546
2087
|
NOT_FOUND: {},
|
|
1547
|
-
|
|
2088
|
+
CONFLICT: {}
|
|
1548
2089
|
}).input(z.object({
|
|
1549
2090
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1550
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
2091
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
2092
|
+
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1551
2093
|
})).output(deploymentSchema);
|
|
1552
|
-
const uploadDeploymentArtifactContractV1 =
|
|
2094
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1553
2095
|
path: "/v1/deployments/upload",
|
|
1554
2096
|
method: "POST",
|
|
1555
2097
|
summary: "Upload deployment artifacts",
|
|
1556
2098
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1557
2099
|
tags: ["deployments"],
|
|
1558
2100
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1559
|
-
}).errors({
|
|
1560
|
-
NOT_FOUND: {},
|
|
1561
|
-
BAD_REQUEST: {}
|
|
1562
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
2101
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1563
2102
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1564
2103
|
token: z.string().describe("Token to identify the source archive"),
|
|
1565
2104
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1566
2105
|
}));
|
|
1567
|
-
const listDeploymentsContractV1 =
|
|
2106
|
+
const listDeploymentsContractV1 = base.route({
|
|
1568
2107
|
path: "/v1/projects/{projectId}/deployments",
|
|
1569
2108
|
method: "GET",
|
|
1570
2109
|
summary: "List project deployments",
|
|
@@ -1576,7 +2115,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1576
2115
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1577
2116
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1578
2117
|
})).output(z.array(deploymentSchema));
|
|
1579
|
-
const getDeploymentContractV1 =
|
|
2118
|
+
const getDeploymentContractV1 = base.route({
|
|
1580
2119
|
path: "/v1/deployments/{deploymentId}",
|
|
1581
2120
|
method: "GET",
|
|
1582
2121
|
summary: "Get a deployment",
|
|
@@ -1584,20 +2123,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1584
2123
|
tags: ["deployments"],
|
|
1585
2124
|
successDescription: "The deployment details"
|
|
1586
2125
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1587
|
-
const
|
|
2126
|
+
const logEntrySchema = z.object({
|
|
2127
|
+
timestamp: z.coerce.date(),
|
|
2128
|
+
type: z.enum([
|
|
2129
|
+
"START",
|
|
2130
|
+
"END",
|
|
2131
|
+
"INFO",
|
|
2132
|
+
"ERROR",
|
|
2133
|
+
"WARNING",
|
|
2134
|
+
"DEBUG"
|
|
2135
|
+
]),
|
|
2136
|
+
requestId: z.string(),
|
|
2137
|
+
content: z.string().optional(),
|
|
2138
|
+
method: z.string().optional(),
|
|
2139
|
+
durationInMs: z.number().optional()
|
|
2140
|
+
});
|
|
2141
|
+
const getLogsContractV1 = base.route({
|
|
1588
2142
|
path: "/v1/environments/{environmentId}/logs",
|
|
1589
2143
|
method: "GET",
|
|
1590
2144
|
summary: "Get logs",
|
|
1591
2145
|
description: "Get logs for an environment",
|
|
1592
2146
|
tags: ["environments"],
|
|
1593
2147
|
successDescription: "The logs"
|
|
1594
|
-
}).errors({
|
|
1595
|
-
NOT_FOUND: {},
|
|
1596
|
-
BAD_REQUEST: {}
|
|
1597
|
-
}).input(z.object({
|
|
2148
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1598
2149
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1599
|
-
since:
|
|
1600
|
-
until:
|
|
2150
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2151
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1601
2152
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1602
2153
|
level: z.array(z.enum([
|
|
1603
2154
|
"INFO",
|
|
@@ -1605,37 +2156,20 @@ const getLogsContractV1 = oc.route({
|
|
|
1605
2156
|
"WARNING",
|
|
1606
2157
|
"DEBUG"
|
|
1607
2158
|
])).optional().describe("Filter by log level"),
|
|
1608
|
-
search:
|
|
2159
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
1609
2160
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1610
2161
|
})).output(z.object({
|
|
1611
|
-
logs: z.array(
|
|
1612
|
-
timestamp: z.coerce.date(),
|
|
1613
|
-
type: z.enum([
|
|
1614
|
-
"START",
|
|
1615
|
-
"END",
|
|
1616
|
-
"INFO",
|
|
1617
|
-
"ERROR",
|
|
1618
|
-
"WARNING",
|
|
1619
|
-
"DEBUG"
|
|
1620
|
-
]),
|
|
1621
|
-
requestId: z.string(),
|
|
1622
|
-
content: z.string().optional(),
|
|
1623
|
-
method: z.string().optional(),
|
|
1624
|
-
durationInMs: z.number().optional()
|
|
1625
|
-
})),
|
|
2162
|
+
logs: z.array(logEntrySchema),
|
|
1626
2163
|
nextToken: z.string().nullable()
|
|
1627
2164
|
}));
|
|
1628
|
-
const getLatestLogsContractV1 =
|
|
2165
|
+
const getLatestLogsContractV1 = base.route({
|
|
1629
2166
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1630
2167
|
method: "GET",
|
|
1631
2168
|
summary: "Get latest logs",
|
|
1632
2169
|
description: "Get the N most recent logs for an environment",
|
|
1633
2170
|
tags: ["environments"],
|
|
1634
2171
|
successDescription: "The latest logs"
|
|
1635
|
-
}).errors({
|
|
1636
|
-
NOT_FOUND: {},
|
|
1637
|
-
BAD_REQUEST: {}
|
|
1638
|
-
}).input(z.object({
|
|
2172
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1639
2173
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1640
2174
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1641
2175
|
level: z.array(z.enum([
|
|
@@ -1644,23 +2178,9 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1644
2178
|
"WARNING",
|
|
1645
2179
|
"DEBUG"
|
|
1646
2180
|
])).optional().describe("Filter by log level"),
|
|
1647
|
-
search:
|
|
1648
|
-
})).output(z.object({ logs: z.array(
|
|
1649
|
-
|
|
1650
|
-
type: z.enum([
|
|
1651
|
-
"START",
|
|
1652
|
-
"END",
|
|
1653
|
-
"INFO",
|
|
1654
|
-
"ERROR",
|
|
1655
|
-
"WARNING",
|
|
1656
|
-
"DEBUG"
|
|
1657
|
-
]),
|
|
1658
|
-
requestId: z.string(),
|
|
1659
|
-
content: z.string().optional(),
|
|
1660
|
-
method: z.string().optional(),
|
|
1661
|
-
durationInMs: z.number().optional()
|
|
1662
|
-
})) }));
|
|
1663
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
2181
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
2182
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
2183
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1664
2184
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1665
2185
|
method: "GET",
|
|
1666
2186
|
summary: "Get deployment logs",
|
|
@@ -1687,22 +2207,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1687
2207
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1688
2208
|
task_count: z.array(analyticsDataPointSchema)
|
|
1689
2209
|
});
|
|
1690
|
-
const getProjectAnalyticsContractV1 =
|
|
2210
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1691
2211
|
path: "/v1/analytics/{projectId}",
|
|
1692
2212
|
method: "GET",
|
|
1693
2213
|
summary: "Get project analytics",
|
|
1694
2214
|
description: "Get analytics data for a project over a time range",
|
|
1695
2215
|
tags: ["analytics"],
|
|
1696
2216
|
successDescription: "The project analytics data"
|
|
1697
|
-
}).errors({
|
|
1698
|
-
NOT_FOUND: {},
|
|
1699
|
-
BAD_REQUEST: {}
|
|
1700
|
-
}).input(z.object({
|
|
2217
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1701
2218
|
projectId: z.string().describe("The ID of the project"),
|
|
1702
2219
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1703
2220
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1704
2221
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1705
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2222
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => isValidIanaTimeZone(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1706
2223
|
metadata: z.object({
|
|
1707
2224
|
startTimestamp: z.number(),
|
|
1708
2225
|
endTimestamp: z.number(),
|
|
@@ -1712,7 +2229,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1712
2229
|
}),
|
|
1713
2230
|
timeSeries: analyticsTimeSeriesSchema
|
|
1714
2231
|
}));
|
|
1715
|
-
const
|
|
2232
|
+
const paginatedInsightsInputShape = {
|
|
2233
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2234
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2235
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2236
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2237
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2238
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2239
|
+
};
|
|
2240
|
+
const listIntentsContractV1 = base.route({
|
|
2241
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2242
|
+
method: "GET",
|
|
2243
|
+
summary: "List intents",
|
|
2244
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2245
|
+
tags: ["insights"],
|
|
2246
|
+
successDescription: "The grouped user intents"
|
|
2247
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2248
|
+
...paginatedInsightsInputShape,
|
|
2249
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2250
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2251
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2252
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2253
|
+
})).output(z.object({
|
|
2254
|
+
intents: z.array(z.object({
|
|
2255
|
+
id: z.string(),
|
|
2256
|
+
intentIds: z.array(z.string()).min(1),
|
|
2257
|
+
environmentId: z.string(),
|
|
2258
|
+
message: z.string(),
|
|
2259
|
+
toolName: z.string(),
|
|
2260
|
+
createdAt: z.coerce.date(),
|
|
2261
|
+
occurrenceCount: z.number().int().positive(),
|
|
2262
|
+
clientName: z.string().nullable(),
|
|
2263
|
+
clientId: z.string().nullable(),
|
|
2264
|
+
categories: z.array(z.object({
|
|
2265
|
+
id: z.string(),
|
|
2266
|
+
name: z.string(),
|
|
2267
|
+
color: intentCategoryColorSchema
|
|
2268
|
+
}))
|
|
2269
|
+
})),
|
|
2270
|
+
totalCount: z.number().int().nonnegative()
|
|
2271
|
+
}));
|
|
2272
|
+
const listFeedbacksContractV1 = base.route({
|
|
2273
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2274
|
+
method: "GET",
|
|
2275
|
+
summary: "List feedbacks",
|
|
2276
|
+
description: "List user feedback for an environment over a time range",
|
|
2277
|
+
tags: ["insights"],
|
|
2278
|
+
successDescription: "The user feedback"
|
|
2279
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2280
|
+
...paginatedInsightsInputShape,
|
|
2281
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2282
|
+
})).output(z.object({
|
|
2283
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2284
|
+
totalCount: z.number().int().nonnegative()
|
|
2285
|
+
}));
|
|
2286
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2287
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2288
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2289
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2290
|
+
method: "GET",
|
|
2291
|
+
summary: "List intent categories",
|
|
2292
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2293
|
+
tags: ["insights"],
|
|
2294
|
+
successDescription: "The intent categories"
|
|
2295
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2296
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2297
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2298
|
+
method: "POST",
|
|
2299
|
+
summary: "Create an intent category",
|
|
2300
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2301
|
+
tags: ["insights"],
|
|
2302
|
+
successDescription: "The created intent category"
|
|
2303
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2304
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2305
|
+
name: intentCategoryNameSchema,
|
|
2306
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2307
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2308
|
+
})).output(intentCategorySchema);
|
|
2309
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2310
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2311
|
+
method: "PATCH",
|
|
2312
|
+
summary: "Update an intent category",
|
|
2313
|
+
description: "Rename or recolor an intent category",
|
|
2314
|
+
tags: ["insights"],
|
|
2315
|
+
successDescription: "The updated intent category"
|
|
2316
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2317
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2318
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2319
|
+
name: intentCategoryNameSchema.optional(),
|
|
2320
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2321
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2322
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2323
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2324
|
+
method: "DELETE",
|
|
2325
|
+
summary: "Delete an intent category",
|
|
2326
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2327
|
+
tags: ["insights"],
|
|
2328
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2329
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2330
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2331
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2332
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2333
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2334
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2335
|
+
method: "POST",
|
|
2336
|
+
summary: "Link an intent category",
|
|
2337
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2338
|
+
tags: ["insights"],
|
|
2339
|
+
successDescription: "The intents have been linked successfully"
|
|
2340
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2341
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2342
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2343
|
+
intentIds: categorizableIntentIdsSchema
|
|
2344
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2345
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2346
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2347
|
+
method: "POST",
|
|
2348
|
+
summary: "Unlink an intent category",
|
|
2349
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2350
|
+
tags: ["insights"],
|
|
2351
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2352
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2353
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2354
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2355
|
+
intentIds: categorizableIntentIdsSchema
|
|
2356
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2357
|
+
const listTeamsContractV1 = base.route({
|
|
1716
2358
|
path: "/v1/teams",
|
|
1717
2359
|
method: "GET",
|
|
1718
2360
|
summary: "List teams",
|
|
@@ -1725,28 +2367,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
1725
2367
|
createdAt: z.coerce.date(),
|
|
1726
2368
|
hasStripeAccount: z.boolean()
|
|
1727
2369
|
})));
|
|
1728
|
-
const
|
|
2370
|
+
const getTeamUsageContractV1 = base.route({
|
|
2371
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2372
|
+
method: "GET",
|
|
2373
|
+
summary: "Get team usage",
|
|
2374
|
+
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.",
|
|
2375
|
+
tags: ["teams"],
|
|
2376
|
+
successDescription: "The current billing window usage"
|
|
2377
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2378
|
+
teamId: z.string(),
|
|
2379
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2380
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2381
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2382
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2383
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2384
|
+
}));
|
|
2385
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1729
2386
|
path: "/v1/tunnels/ticket",
|
|
1730
2387
|
method: "GET",
|
|
1731
2388
|
summary: "Get a tunnel ticket",
|
|
1732
2389
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1733
2390
|
tags: ["tunnels"],
|
|
1734
2391
|
successDescription: "The tunnel ticket"
|
|
1735
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
2392
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1736
2393
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1737
2394
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1738
2395
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1739
2396
|
}));
|
|
1740
|
-
const publishServerContractV1 =
|
|
2397
|
+
const publishServerContractV1 = base.route({
|
|
1741
2398
|
path: "/v1/distribution/publish",
|
|
1742
2399
|
method: "POST",
|
|
1743
2400
|
summary: "Publish a server to the MCP registry",
|
|
1744
2401
|
tags: ["distribution"],
|
|
1745
2402
|
successDescription: "The server has been published successfully"
|
|
1746
|
-
}).errors({
|
|
1747
|
-
NOT_FOUND: {},
|
|
1748
|
-
BAD_REQUEST: {}
|
|
1749
|
-
}).input(z.object({
|
|
2403
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1750
2404
|
projectId: z.string(),
|
|
1751
2405
|
domain: z.string(),
|
|
1752
2406
|
title: z.string().min(1).max(100),
|
|
@@ -1755,17 +2409,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1755
2409
|
iconSrc: z.url().max(255).optional(),
|
|
1756
2410
|
dryRun: z.boolean().optional()
|
|
1757
2411
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1758
|
-
const getServerInfoContractV1 =
|
|
2412
|
+
const getServerInfoContractV1 = base.route({
|
|
1759
2413
|
path: "/v1/distribution/get",
|
|
1760
2414
|
method: "GET",
|
|
1761
2415
|
summary: "Get server info",
|
|
1762
2416
|
description: "Get info about a server",
|
|
1763
2417
|
tags: ["distribution"],
|
|
1764
2418
|
successDescription: "The server info"
|
|
1765
|
-
}).errors({
|
|
1766
|
-
NOT_FOUND: {},
|
|
1767
|
-
BAD_REQUEST: {}
|
|
1768
|
-
}).input(z.object({
|
|
2419
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1769
2420
|
projectId: z.string(),
|
|
1770
2421
|
domain: z.string()
|
|
1771
2422
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1784,7 +2435,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1784
2435
|
isPlaygroundEnabled: z.boolean(),
|
|
1785
2436
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1786
2437
|
});
|
|
1787
|
-
const getPlaygroundContractV1 =
|
|
2438
|
+
const getPlaygroundContractV1 = base.route({
|
|
1788
2439
|
path: "/v1/environments/{environmentId}/playground",
|
|
1789
2440
|
method: "GET",
|
|
1790
2441
|
summary: "Get playground configuration",
|
|
@@ -1792,17 +2443,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1792
2443
|
tags: ["environments"],
|
|
1793
2444
|
successDescription: "The playground configuration"
|
|
1794
2445
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1795
|
-
const upsertPlaygroundContractV1 =
|
|
2446
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1796
2447
|
path: "/v1/environments/{environmentId}/playground",
|
|
1797
2448
|
method: "PUT",
|
|
1798
2449
|
summary: "Update playground configuration",
|
|
1799
2450
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1800
2451
|
tags: ["environments"],
|
|
1801
2452
|
successDescription: "The updated playground configuration"
|
|
1802
|
-
}).errors({
|
|
1803
|
-
NOT_FOUND: {},
|
|
1804
|
-
BAD_REQUEST: {}
|
|
1805
|
-
}).input(z.object({
|
|
2453
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1806
2454
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1807
2455
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1808
2456
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1810,7 +2458,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1810
2458
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1811
2459
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1812
2460
|
})).output(playgroundOutputSchema);
|
|
1813
|
-
const createBeaconContractV1 =
|
|
2461
|
+
const createBeaconContractV1 = base.route({
|
|
1814
2462
|
path: "/v1/beacon/audits",
|
|
1815
2463
|
method: "POST",
|
|
1816
2464
|
summary: "Create a beacon audit",
|
|
@@ -1819,7 +2467,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1819
2467
|
successDescription: "The audit has been created"
|
|
1820
2468
|
}).errors({
|
|
1821
2469
|
NOT_FOUND: {},
|
|
1822
|
-
BAD_REQUEST: {},
|
|
1823
2470
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1824
2471
|
}).input(z.object({
|
|
1825
2472
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1827,7 +2474,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1827
2474
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1828
2475
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1829
2476
|
})).output(z.object({ id: z.string() }));
|
|
1830
|
-
const getBeaconContractV1 =
|
|
2477
|
+
const getBeaconContractV1 = base.route({
|
|
1831
2478
|
path: "/v1/beacon/audits/{auditId}",
|
|
1832
2479
|
method: "GET",
|
|
1833
2480
|
summary: "Get a beacon audit",
|
|
@@ -1842,9 +2489,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1842
2489
|
createdAt: z.coerce.date(),
|
|
1843
2490
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1844
2491
|
}));
|
|
2492
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2493
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2494
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2495
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2496
|
+
const createSubmissionContractV1 = base.route({
|
|
2497
|
+
path: "/v1/submissions",
|
|
2498
|
+
method: "POST",
|
|
2499
|
+
summary: "Create a submission package",
|
|
2500
|
+
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.",
|
|
2501
|
+
tags: ["submissions"],
|
|
2502
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2503
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2504
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2505
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2506
|
+
})).output(submissionSchema);
|
|
2507
|
+
const listSubmissionsContractV1 = base.route({
|
|
2508
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2509
|
+
method: "GET",
|
|
2510
|
+
summary: "List submission packages",
|
|
2511
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2512
|
+
tags: ["submissions"],
|
|
2513
|
+
successDescription: "The list of submission packages"
|
|
2514
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2515
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2516
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2517
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2518
|
+
})).output(z.array(submissionSchema));
|
|
2519
|
+
const getSubmissionContractV1 = base.route({
|
|
2520
|
+
path: "/v1/submissions/{submissionId}",
|
|
2521
|
+
method: "GET",
|
|
2522
|
+
summary: "Get a submission package",
|
|
2523
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2524
|
+
tags: ["submissions"],
|
|
2525
|
+
successDescription: "The submission package"
|
|
2526
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2527
|
+
const updateSubmissionContractV1 = base.route({
|
|
2528
|
+
path: "/v1/submissions/{submissionId}",
|
|
2529
|
+
method: "PUT",
|
|
2530
|
+
summary: "Update a submission package",
|
|
2531
|
+
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.",
|
|
2532
|
+
tags: ["submissions"],
|
|
2533
|
+
successDescription: "The updated submission package"
|
|
2534
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2535
|
+
submissionId: submissionIdSchema,
|
|
2536
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2537
|
+
formData: claudeSubmissionUpdateSchema
|
|
2538
|
+
}), z.object({
|
|
2539
|
+
submissionId: submissionIdSchema,
|
|
2540
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2541
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2542
|
+
})])).output(submissionSchema);
|
|
1845
2543
|
const contract = {
|
|
1846
|
-
teams: {
|
|
2544
|
+
teams: {
|
|
2545
|
+
list: { v1: listTeamsContractV1 },
|
|
2546
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2547
|
+
},
|
|
1847
2548
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2549
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2550
|
+
intentCategories: {
|
|
2551
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2552
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2553
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2554
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2555
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2556
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2557
|
+
},
|
|
2558
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1848
2559
|
deployments: {
|
|
1849
2560
|
list: { v1: listDeploymentsContractV1 },
|
|
1850
2561
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1854,6 +2565,7 @@ const contract = {
|
|
|
1854
2565
|
environments: {
|
|
1855
2566
|
create: { v1: createEnvironmentContractV1 },
|
|
1856
2567
|
get: { v1: getEnvironmentContractV1 },
|
|
2568
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1857
2569
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1858
2570
|
getLogs: { v1: getLogsContractV1 },
|
|
1859
2571
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1864,6 +2576,12 @@ const contract = {
|
|
|
1864
2576
|
update: { v1: updateEnvironmentVariableContractV1 },
|
|
1865
2577
|
delete: { v1: deleteEnvironmentVariableContractV1 }
|
|
1866
2578
|
},
|
|
2579
|
+
telemetryDestinations: {
|
|
2580
|
+
list: { v1: listTelemetryDestinationsContractV1 },
|
|
2581
|
+
create: { v1: createTelemetryDestinationContractV1 },
|
|
2582
|
+
update: { v1: updateTelemetryDestinationContractV1 },
|
|
2583
|
+
delete: { v1: deleteTelemetryDestinationContractV1 }
|
|
2584
|
+
},
|
|
1867
2585
|
projects: {
|
|
1868
2586
|
update: { v1: updateProjectContractV1 },
|
|
1869
2587
|
get: { v1: getProjectContractV1 },
|
|
@@ -1883,7 +2601,39 @@ const contract = {
|
|
|
1883
2601
|
beacon: {
|
|
1884
2602
|
create: { v1: createBeaconContractV1 },
|
|
1885
2603
|
get: { v1: getBeaconContractV1 }
|
|
2604
|
+
},
|
|
2605
|
+
submissions: {
|
|
2606
|
+
create: { v1: createSubmissionContractV1 },
|
|
2607
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2608
|
+
get: { v1: getSubmissionContractV1 },
|
|
2609
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2610
|
+
}
|
|
2611
|
+
};
|
|
2612
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2613
|
+
const contractForDocs = {
|
|
2614
|
+
...contract,
|
|
2615
|
+
deployments: deploymentsForDocs
|
|
2616
|
+
};
|
|
2617
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2618
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2619
|
+
info: {
|
|
2620
|
+
title: "Alpic API",
|
|
2621
|
+
version: "1.0.0"
|
|
2622
|
+
},
|
|
2623
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2624
|
+
security: [{ bearerAuth: [] }],
|
|
2625
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2626
|
+
type: "http",
|
|
2627
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2628
|
+
scheme: "bearer"
|
|
2629
|
+
} } },
|
|
2630
|
+
commonSchemas: {
|
|
2631
|
+
Submission: { schema: submissionSchema },
|
|
2632
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2633
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2634
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2635
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
1886
2636
|
}
|
|
1887
2637
|
};
|
|
1888
2638
|
//#endregion
|
|
1889
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2639
|
+
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 };
|