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