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