@alpic-ai/api 0.0.0-staging.gee456e9 → 0.0.0-staging.geea3297
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 +6700 -97
- package/dist/index.mjs +911 -189
- package/package.json +9 -9
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({
|
|
@@ -179,6 +189,7 @@ const PLATFORM_LABELS = {
|
|
|
179
189
|
};
|
|
180
190
|
const WAF_PLATFORMS = [
|
|
181
191
|
"akamai",
|
|
192
|
+
"cato",
|
|
182
193
|
"cloudflare",
|
|
183
194
|
"fastly"
|
|
184
195
|
];
|
|
@@ -256,6 +267,25 @@ z.object({
|
|
|
256
267
|
clientSecret: z.string(),
|
|
257
268
|
clientScopes: z.array(z.string())
|
|
258
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
|
+
});
|
|
259
289
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
290
|
"ongoing",
|
|
261
291
|
"deployed",
|
|
@@ -283,33 +313,18 @@ const deploymentSummarySchema = z.object({
|
|
|
283
313
|
createdAt: z.coerce.date(),
|
|
284
314
|
updatedAt: z.coerce.date()
|
|
285
315
|
});
|
|
286
|
-
/**
|
|
287
|
-
* Public environment
|
|
288
|
-
*
|
|
289
|
-
* Answers anonymously and exposes no OAuth metadata.
|
|
290
|
-
*/
|
|
316
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
291
317
|
const publicEnvironmentSchema = z.object({
|
|
292
318
|
allowsAnonymous: z.literal(true),
|
|
293
319
|
oAuthMetadata: z.strictObject({})
|
|
294
320
|
});
|
|
295
|
-
/**
|
|
296
|
-
* Protected environment with an external resource metadata URL
|
|
297
|
-
*
|
|
298
|
-
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
299
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
300
|
-
*/
|
|
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. */
|
|
301
322
|
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
302
323
|
allowsAnonymous: z.boolean(),
|
|
303
324
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
304
325
|
scope: z.string().optional()
|
|
305
326
|
});
|
|
306
|
-
/**
|
|
307
|
-
* Protected environment with an external authorization server URL
|
|
308
|
-
*
|
|
309
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
310
|
-
* An external authorization server URL is returned when requesting the endpoint.
|
|
311
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
312
|
-
*/
|
|
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. */
|
|
313
328
|
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
314
329
|
allowsAnonymous: z.boolean(),
|
|
315
330
|
oAuthMetadata: z.object({
|
|
@@ -318,12 +333,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
318
333
|
}),
|
|
319
334
|
scope: z.string().optional()
|
|
320
335
|
});
|
|
321
|
-
/**
|
|
322
|
-
* Standalone protected environment
|
|
323
|
-
*
|
|
324
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
325
|
-
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
326
|
-
*/
|
|
336
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
337
|
const standaloneEnvironmentSchema = z.object({
|
|
328
338
|
allowsAnonymous: z.boolean(),
|
|
329
339
|
oAuthMetadata: z.object({
|
|
@@ -332,17 +342,12 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
332
342
|
}),
|
|
333
343
|
scope: z.string().optional()
|
|
334
344
|
});
|
|
335
|
-
/**
|
|
336
|
-
* Protected environment without OAuth discovery
|
|
337
|
-
*
|
|
338
|
-
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
339
|
-
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
340
|
-
* are advertised. Clients must obtain credentials out-of-band.
|
|
341
|
-
*/
|
|
345
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
342
346
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
343
347
|
allowsAnonymous: z.literal(false),
|
|
344
348
|
oAuthMetadata: z.strictObject({}),
|
|
345
|
-
scope: z.string().optional()
|
|
349
|
+
scope: z.string().optional(),
|
|
350
|
+
wwwAuthenticate: z.string().optional()
|
|
346
351
|
});
|
|
347
352
|
const legacyPublicEnvironmentSchema = z.object({
|
|
348
353
|
isPublic: z.literal(true),
|
|
@@ -387,10 +392,13 @@ z.union([
|
|
|
387
392
|
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
388
393
|
]);
|
|
389
394
|
const playgroundModelSchema = z.enum([
|
|
395
|
+
"global.anthropic.claude-haiku-5-5",
|
|
390
396
|
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
391
|
-
"global.anthropic.claude-sonnet-
|
|
397
|
+
"global.anthropic.claude-sonnet-5-5",
|
|
392
398
|
"openai.gpt-5.4",
|
|
393
|
-
"openai.gpt-5.5"
|
|
399
|
+
"openai.gpt-5.5",
|
|
400
|
+
"openai.gpt-6-luna",
|
|
401
|
+
"openai.gpt-6.1-sol"
|
|
394
402
|
]);
|
|
395
403
|
const environmentDomainSchema = z.object({
|
|
396
404
|
name: z.string(),
|
|
@@ -425,14 +433,17 @@ z.object({
|
|
|
425
433
|
collectRequestPayload: z.boolean(),
|
|
426
434
|
collectResponsePayload: z.boolean(),
|
|
427
435
|
collectErrorMessage: z.boolean(),
|
|
428
|
-
collectUserData: z.boolean()
|
|
436
|
+
collectUserData: z.boolean(),
|
|
437
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
438
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
429
439
|
});
|
|
430
|
-
z.object({
|
|
440
|
+
const feedbackSchema = z.object({
|
|
431
441
|
id: z.string(),
|
|
432
442
|
createdAt: z.coerce.date(),
|
|
433
443
|
environmentId: z.string(),
|
|
434
444
|
content: z.string(),
|
|
435
|
-
source: z.enum(["model", "user"])
|
|
445
|
+
source: z.enum(["model", "user"]),
|
|
446
|
+
clientName: z.string().nullable()
|
|
436
447
|
});
|
|
437
448
|
z.object({
|
|
438
449
|
content: z.string(),
|
|
@@ -448,7 +459,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
448
459
|
"pink",
|
|
449
460
|
"gray"
|
|
450
461
|
]);
|
|
451
|
-
intentCategoryColorSchema.options;
|
|
462
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
452
463
|
const intentCategorySchema = z.object({
|
|
453
464
|
id: z.string(),
|
|
454
465
|
createdAt: z.coerce.date(),
|
|
@@ -456,7 +467,7 @@ const intentCategorySchema = z.object({
|
|
|
456
467
|
name: z.string(),
|
|
457
468
|
color: intentCategoryColorSchema
|
|
458
469
|
});
|
|
459
|
-
z.object({
|
|
470
|
+
const intentCategorySummarySchema = z.object({
|
|
460
471
|
id: z.string(),
|
|
461
472
|
name: z.string(),
|
|
462
473
|
color: intentCategoryColorSchema,
|
|
@@ -468,6 +479,7 @@ z.object({
|
|
|
468
479
|
environmentId: z.string(),
|
|
469
480
|
toolName: z.string(),
|
|
470
481
|
message: z.string(),
|
|
482
|
+
clientName: z.string().nullable(),
|
|
471
483
|
categories: z.array(intentCategorySchema)
|
|
472
484
|
});
|
|
473
485
|
const signalCategorySchema = z.object({
|
|
@@ -526,12 +538,270 @@ z.object({
|
|
|
526
538
|
createdAt: z.coerce.date(),
|
|
527
539
|
updatedAt: z.coerce.date()
|
|
528
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]);
|
|
529
551
|
z.enum([
|
|
530
552
|
"INFO",
|
|
531
553
|
"WARNING",
|
|
532
554
|
"DEBUG",
|
|
533
555
|
"ERROR"
|
|
534
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]));
|
|
535
805
|
const runtimeSchema = z.enum([
|
|
536
806
|
"python3.13",
|
|
537
807
|
"python3.14",
|
|
@@ -609,15 +879,7 @@ z.object({
|
|
|
609
879
|
serverFields: serverFieldsSchema$1,
|
|
610
880
|
source: z.enum(["registry", "defaults"])
|
|
611
881
|
});
|
|
612
|
-
/**
|
|
613
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
614
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
615
|
-
*
|
|
616
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
617
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
618
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
619
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
620
|
-
*/
|
|
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. */
|
|
621
883
|
const clampStringField = (field) => {
|
|
622
884
|
const max = field.maxLength;
|
|
623
885
|
if (max === null) return field;
|
|
@@ -625,6 +887,10 @@ const clampStringField = (field) => {
|
|
|
625
887
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
626
888
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
627
889
|
};
|
|
890
|
+
const unboundedArrayField = (field) => {
|
|
891
|
+
const unbounded = z.array(field.element);
|
|
892
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
893
|
+
};
|
|
628
894
|
const toolDefinitionSchema = z.object({
|
|
629
895
|
name: z.string(),
|
|
630
896
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -637,11 +903,22 @@ const toolDefinitionSchema = z.object({
|
|
|
637
903
|
}).optional()
|
|
638
904
|
});
|
|
639
905
|
const positiveTestCaseSchema = z.object({
|
|
640
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
641
|
-
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."),
|
|
642
908
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
643
909
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
644
|
-
}).
|
|
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());
|
|
645
922
|
const screenshotEntrySchema = z.object({
|
|
646
923
|
prompt: z.string(),
|
|
647
924
|
url: z.url()
|
|
@@ -954,20 +1231,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
954
1231
|
"zh-TW"
|
|
955
1232
|
]);
|
|
956
1233
|
const negativeTestCaseSchema = z.object({
|
|
957
|
-
scenario: z.string(),
|
|
958
|
-
userPrompt: z.string()
|
|
959
|
-
}).
|
|
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.");
|
|
960
1246
|
const chatgptToolJustificationSchema = z.object({
|
|
961
1247
|
toolName: z.string(),
|
|
962
1248
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
963
1249
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
964
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.\"")
|
|
965
1251
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
966
|
-
/**
|
|
967
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
968
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
969
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
970
|
-
*/
|
|
1252
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
971
1253
|
const chatgptTaglineSchema = z.string().max(30);
|
|
972
1254
|
const chatgptDescriptionSchema = z.string();
|
|
973
1255
|
const chatgptTranslationSchema = z.object({
|
|
@@ -976,34 +1258,32 @@ const chatgptTranslationSchema = z.object({
|
|
|
976
1258
|
description: chatgptDescriptionSchema
|
|
977
1259
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
978
1260
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
979
|
-
/**
|
|
980
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
981
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
982
|
-
*/
|
|
1261
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
983
1262
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
984
1263
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
985
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."),
|
|
986
|
-
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."),
|
|
987
1266
|
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
988
|
-
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)."),
|
|
989
1268
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
990
|
-
developerName: z.string().describe("Developer name shown publicly on the
|
|
1269
|
+
developerName: z.string().describe("Developer name shown publicly on the plugin's directory page."),
|
|
991
1270
|
companyUrl: urlField.describe("Your company's main website URL."),
|
|
992
1271
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
993
1272
|
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
994
|
-
termsOfServiceUrl: urlField.describe("URL to the
|
|
995
|
-
demoRecordingUrl: urlField.describe("URL to a video demonstrating the
|
|
996
|
-
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My
|
|
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."),
|
|
997
1276
|
serverUrl: urlField.describe("URL of the MCP server."),
|
|
998
1277
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
999
1278
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1000
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."),
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
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."),
|
|
1004
1284
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1005
1285
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
1006
|
-
releaseNotes: z.string().describe("Publicly displayed on the
|
|
1286
|
+
releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
|
|
1007
1287
|
});
|
|
1008
1288
|
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1009
1289
|
tagline: z.string().optional(),
|
|
@@ -1014,23 +1294,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1014
1294
|
demoRecordingUrl: z.string().optional(),
|
|
1015
1295
|
serverUrl: z.string().optional(),
|
|
1016
1296
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1297
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1298
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1017
1299
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1018
1300
|
});
|
|
1019
|
-
|
|
1301
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1302
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1020
1303
|
appName: true,
|
|
1021
1304
|
developerName: true,
|
|
1022
1305
|
serverUrl: true,
|
|
1023
1306
|
tools: true,
|
|
1307
|
+
skills: true,
|
|
1024
1308
|
authentication: true
|
|
1025
1309
|
});
|
|
1026
|
-
|
|
1310
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1311
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1027
1312
|
tagline: true,
|
|
1028
1313
|
description: true,
|
|
1029
1314
|
category: true,
|
|
1030
1315
|
testCases: true,
|
|
1031
1316
|
negativeTestCases: true,
|
|
1032
1317
|
toolJustifications: true
|
|
1033
|
-
}).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
|
+
});
|
|
1034
1326
|
const claudeCategorySchema = z.enum([
|
|
1035
1327
|
"Productivity",
|
|
1036
1328
|
"Communication",
|
|
@@ -1076,11 +1368,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1076
1368
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1077
1369
|
"Public documentation for this connector will be live by the publish date."
|
|
1078
1370
|
]);
|
|
1079
|
-
/**
|
|
1080
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1081
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1082
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1083
|
-
*/
|
|
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. */
|
|
1084
1372
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1085
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
|
|
1086
1374
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1157,7 +1445,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1157
1445
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1158
1446
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1159
1447
|
});
|
|
1160
|
-
|
|
1448
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1449
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1161
1450
|
serverUrl: true,
|
|
1162
1451
|
name: true,
|
|
1163
1452
|
slug: true,
|
|
@@ -1172,39 +1461,93 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1172
1461
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1173
1462
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1174
1463
|
});
|
|
1175
|
-
/**
|
|
1176
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1177
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1178
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1179
|
-
* colocated with the Claude contract.
|
|
1180
|
-
*/
|
|
1464
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1181
1465
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1182
1466
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1183
1467
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1184
1468
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1185
1469
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1186
1470
|
});
|
|
1187
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1471
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1188
1472
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1189
1473
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1190
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.")
|
|
1523
|
+
});
|
|
1191
1524
|
const submissionMetaFieldsSchema = z.object({
|
|
1192
1525
|
id: z.string(),
|
|
1193
1526
|
environmentId: z.string(),
|
|
1194
1527
|
auditId: z.string().nullable(),
|
|
1528
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1195
1529
|
createdAt: z.coerce.date(),
|
|
1196
1530
|
updatedAt: z.coerce.date()
|
|
1197
1531
|
});
|
|
1198
1532
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1199
1533
|
platform: z.literal("claudeai"),
|
|
1200
|
-
formData: claudeSubmissionDraftSchema
|
|
1534
|
+
formData: claudeSubmissionDraftSchema,
|
|
1535
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1201
1536
|
});
|
|
1202
1537
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1203
1538
|
platform: z.literal("chatgpt"),
|
|
1204
|
-
formData: chatgptSubmissionDraftSchema
|
|
1539
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1540
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1205
1541
|
});
|
|
1206
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1542
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1207
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
|
+
]);
|
|
1208
1551
|
const subscriptionPlanSchema = z.enum([
|
|
1209
1552
|
"pro",
|
|
1210
1553
|
"business",
|
|
@@ -1216,17 +1559,78 @@ const customerCreditsSchema = z.object({
|
|
|
1216
1559
|
expiresAt: z.number().nullable(),
|
|
1217
1560
|
currency: z.string()
|
|
1218
1561
|
});
|
|
1219
|
-
const customerUsageSchema = z.object({
|
|
1220
|
-
amountInCents: z.number(),
|
|
1221
|
-
currency: z.string(),
|
|
1222
|
-
periodEnd: z.number()
|
|
1223
|
-
});
|
|
1224
1562
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1225
1563
|
z.object({
|
|
1226
1564
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1227
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1228
1565
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1229
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
|
+
};
|
|
1230
1634
|
//#endregion
|
|
1231
1635
|
//#region src/auth-scope.ts
|
|
1232
1636
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1269,7 +1673,10 @@ const RESERVED_KEYS = [
|
|
|
1269
1673
|
"BUILD_ARG_START_COMMAND",
|
|
1270
1674
|
"ALPIC_HOST",
|
|
1271
1675
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1272
|
-
"ALPIC_INTENT_META_KEY"
|
|
1676
|
+
"ALPIC_INTENT_META_KEY",
|
|
1677
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1678
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1679
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1273
1680
|
];
|
|
1274
1681
|
const environmentVariableSchema = z.object({
|
|
1275
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"),
|
|
@@ -1322,6 +1729,14 @@ const serverFieldsSchema = z.object({
|
|
|
1322
1729
|
});
|
|
1323
1730
|
//#endregion
|
|
1324
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
|
+
};
|
|
1325
1740
|
const deploymentStatusSchema = z.enum([
|
|
1326
1741
|
"ongoing",
|
|
1327
1742
|
"deployed",
|
|
@@ -1350,21 +1765,20 @@ const deploymentSchema = z.object({
|
|
|
1350
1765
|
isCurrent: z.boolean(),
|
|
1351
1766
|
deploymentPageUrl: z.url().nullable()
|
|
1352
1767
|
});
|
|
1353
|
-
const
|
|
1768
|
+
const isValidTimeInput = (value) => {
|
|
1354
1769
|
if (ms(value) !== void 0) return true;
|
|
1355
1770
|
return !Number.isNaN(new Date(value).getTime());
|
|
1356
1771
|
};
|
|
1357
|
-
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({
|
|
1358
1775
|
path: "/v1/environments",
|
|
1359
1776
|
method: "POST",
|
|
1360
1777
|
summary: "Create an environment",
|
|
1361
1778
|
description: "Create an environment for a project",
|
|
1362
1779
|
tags: ["environments"],
|
|
1363
1780
|
successDescription: "The environment has been created successfully"
|
|
1364
|
-
}).errors({
|
|
1365
|
-
NOT_FOUND: {},
|
|
1366
|
-
BAD_REQUEST: {}
|
|
1367
|
-
}).input(z.object({
|
|
1781
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1368
1782
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1369
1783
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1370
1784
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1377,7 +1791,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1377
1791
|
createdAt: z.coerce.date(),
|
|
1378
1792
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1379
1793
|
}));
|
|
1380
|
-
const getEnvironmentContractV1 =
|
|
1794
|
+
const getEnvironmentContractV1 = base.route({
|
|
1381
1795
|
path: "/v1/environments/{environmentId}",
|
|
1382
1796
|
method: "GET",
|
|
1383
1797
|
summary: "Get an environment",
|
|
@@ -1393,6 +1807,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1393
1807
|
createdAt: z.coerce.date(),
|
|
1394
1808
|
projectId: z.string()
|
|
1395
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) }));
|
|
1396
1818
|
const domainSchema = z.object({
|
|
1397
1819
|
domain: z.string(),
|
|
1398
1820
|
status: z.enum([
|
|
@@ -1434,7 +1856,7 @@ const projectOutputSchema = z.object({
|
|
|
1434
1856
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1435
1857
|
environments: z.array(environmentSchema)
|
|
1436
1858
|
});
|
|
1437
|
-
const getProjectContractV1 =
|
|
1859
|
+
const getProjectContractV1 = base.route({
|
|
1438
1860
|
path: "/v1/projects/{projectId}",
|
|
1439
1861
|
method: "GET",
|
|
1440
1862
|
summary: "Get a project",
|
|
@@ -1442,18 +1864,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1442
1864
|
tags: ["projects"],
|
|
1443
1865
|
successDescription: "The project details"
|
|
1444
1866
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1445
|
-
const listProjectsContractV1 =
|
|
1867
|
+
const listProjectsContractV1 = base.route({
|
|
1446
1868
|
path: "/v1/projects",
|
|
1447
1869
|
method: "GET",
|
|
1448
1870
|
summary: "List projects",
|
|
1449
1871
|
description: "List all projects for a team",
|
|
1450
1872
|
tags: ["projects"],
|
|
1451
1873
|
successDescription: "The list of projects"
|
|
1452
|
-
}).errors({
|
|
1453
|
-
|
|
1454
|
-
BAD_REQUEST: {}
|
|
1455
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1456
|
-
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({
|
|
1457
1876
|
path: "/v1/projects",
|
|
1458
1877
|
method: "POST",
|
|
1459
1878
|
summary: "Create a project",
|
|
@@ -1462,7 +1881,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1462
1881
|
successDescription: "The project has been created successfully"
|
|
1463
1882
|
}).errors({
|
|
1464
1883
|
NOT_FOUND: {},
|
|
1465
|
-
BAD_REQUEST: {},
|
|
1466
1884
|
FORBIDDEN: {}
|
|
1467
1885
|
}).input(z.object({
|
|
1468
1886
|
teamId: z.string().optional(),
|
|
@@ -1503,7 +1921,101 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1503
1921
|
isSecret: z.boolean(),
|
|
1504
1922
|
createdAt: z.coerce.date()
|
|
1505
1923
|
});
|
|
1506
|
-
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({
|
|
1507
2019
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1508
2020
|
method: "GET",
|
|
1509
2021
|
summary: "List environment variables",
|
|
@@ -1511,48 +2023,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1511
2023
|
tags: ["environments"],
|
|
1512
2024
|
successDescription: "The list of environment variables"
|
|
1513
2025
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1514
|
-
const createEnvironmentVariablesContractV1 =
|
|
2026
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1515
2027
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1516
2028
|
method: "POST",
|
|
1517
2029
|
summary: "Add environment variables",
|
|
1518
2030
|
description: "Add one or more environment variables to an environment",
|
|
1519
2031
|
tags: ["environments"],
|
|
1520
2032
|
successDescription: "The environment variables have been added successfully"
|
|
1521
|
-
}).errors({
|
|
1522
|
-
NOT_FOUND: {},
|
|
1523
|
-
BAD_REQUEST: {}
|
|
1524
|
-
}).input(z.object({
|
|
2033
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1525
2034
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1526
2035
|
environmentVariables: environmentVariablesSchema
|
|
1527
2036
|
})).output(z.object({ success: z.literal(true) }));
|
|
1528
|
-
const updateEnvironmentVariableContractV1 =
|
|
2037
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1529
2038
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1530
2039
|
method: "PATCH",
|
|
1531
2040
|
summary: "Update an environment variable",
|
|
1532
2041
|
description: "Update an environment variable by ID",
|
|
1533
2042
|
tags: ["environments"],
|
|
1534
2043
|
successDescription: "The environment variable has been updated successfully"
|
|
1535
|
-
}).errors({
|
|
1536
|
-
NOT_FOUND: {},
|
|
1537
|
-
BAD_REQUEST: {}
|
|
1538
|
-
}).input(z.object({
|
|
2044
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1539
2045
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1540
2046
|
key: environmentVariableSchema.shape.key,
|
|
1541
2047
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1542
2048
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1543
2049
|
})).output(z.object({ success: z.literal(true) }));
|
|
1544
|
-
const deleteEnvironmentVariableContractV1 =
|
|
2050
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1545
2051
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1546
2052
|
method: "DELETE",
|
|
1547
2053
|
summary: "Delete an environment variable",
|
|
1548
2054
|
description: "Delete an environment variable by ID",
|
|
1549
2055
|
tags: ["environments"],
|
|
1550
2056
|
successDescription: "The environment variable has been deleted successfully"
|
|
1551
|
-
}).errors({
|
|
1552
|
-
|
|
1553
|
-
BAD_REQUEST: {}
|
|
1554
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1555
|
-
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({
|
|
1556
2059
|
path: "/v1/projects/{projectId}",
|
|
1557
2060
|
method: "DELETE",
|
|
1558
2061
|
summary: "Delete a project",
|
|
@@ -1560,7 +2063,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1560
2063
|
tags: ["projects"],
|
|
1561
2064
|
successDescription: "The project has been deleted successfully"
|
|
1562
2065
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1563
|
-
const updateProjectContractV1 =
|
|
2066
|
+
const updateProjectContractV1 = base.route({
|
|
1564
2067
|
path: "/v1/projects/{projectId}",
|
|
1565
2068
|
method: "PATCH",
|
|
1566
2069
|
summary: "Update a project",
|
|
@@ -1569,14 +2072,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1569
2072
|
successDescription: "The project has been updated successfully"
|
|
1570
2073
|
}).errors({
|
|
1571
2074
|
NOT_FOUND: {},
|
|
1572
|
-
BAD_REQUEST: {},
|
|
1573
2075
|
FORBIDDEN: {}
|
|
1574
2076
|
}).input(z.object({
|
|
1575
2077
|
projectId: z.string().describe("The ID of the project"),
|
|
1576
2078
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1577
2079
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1578
2080
|
})).output(projectOutputSchema);
|
|
1579
|
-
const deployEnvironmentContractV1 =
|
|
2081
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1580
2082
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1581
2083
|
method: "POST",
|
|
1582
2084
|
summary: "Deploy an environment",
|
|
@@ -1585,29 +2087,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1585
2087
|
successDescription: "The environment has been deployed successfully"
|
|
1586
2088
|
}).errors({
|
|
1587
2089
|
NOT_FOUND: {},
|
|
1588
|
-
BAD_REQUEST: {},
|
|
1589
2090
|
CONFLICT: {}
|
|
1590
2091
|
}).input(z.object({
|
|
1591
2092
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1592
2093
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1593
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.")
|
|
1594
2095
|
})).output(deploymentSchema);
|
|
1595
|
-
const uploadDeploymentArtifactContractV1 =
|
|
2096
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1596
2097
|
path: "/v1/deployments/upload",
|
|
1597
2098
|
method: "POST",
|
|
1598
2099
|
summary: "Upload deployment artifacts",
|
|
1599
2100
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1600
2101
|
tags: ["deployments"],
|
|
1601
2102
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1602
|
-
}).errors({
|
|
1603
|
-
NOT_FOUND: {},
|
|
1604
|
-
BAD_REQUEST: {}
|
|
1605
|
-
}).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({
|
|
1606
2104
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1607
2105
|
token: z.string().describe("Token to identify the source archive"),
|
|
1608
2106
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1609
2107
|
}));
|
|
1610
|
-
const listDeploymentsContractV1 =
|
|
2108
|
+
const listDeploymentsContractV1 = base.route({
|
|
1611
2109
|
path: "/v1/projects/{projectId}/deployments",
|
|
1612
2110
|
method: "GET",
|
|
1613
2111
|
summary: "List project deployments",
|
|
@@ -1619,7 +2117,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1619
2117
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1620
2118
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1621
2119
|
})).output(z.array(deploymentSchema));
|
|
1622
|
-
const getDeploymentContractV1 =
|
|
2120
|
+
const getDeploymentContractV1 = base.route({
|
|
1623
2121
|
path: "/v1/deployments/{deploymentId}",
|
|
1624
2122
|
method: "GET",
|
|
1625
2123
|
summary: "Get a deployment",
|
|
@@ -1642,20 +2140,17 @@ const logEntrySchema = z.object({
|
|
|
1642
2140
|
method: z.string().optional(),
|
|
1643
2141
|
durationInMs: z.number().optional()
|
|
1644
2142
|
});
|
|
1645
|
-
const getLogsContractV1 =
|
|
2143
|
+
const getLogsContractV1 = base.route({
|
|
1646
2144
|
path: "/v1/environments/{environmentId}/logs",
|
|
1647
2145
|
method: "GET",
|
|
1648
2146
|
summary: "Get logs",
|
|
1649
2147
|
description: "Get logs for an environment",
|
|
1650
2148
|
tags: ["environments"],
|
|
1651
2149
|
successDescription: "The logs"
|
|
1652
|
-
}).errors({
|
|
1653
|
-
NOT_FOUND: {},
|
|
1654
|
-
BAD_REQUEST: {}
|
|
1655
|
-
}).input(z.object({
|
|
2150
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1656
2151
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1657
|
-
since:
|
|
1658
|
-
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"),
|
|
1659
2154
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1660
2155
|
level: z.array(z.enum([
|
|
1661
2156
|
"INFO",
|
|
@@ -1663,23 +2158,20 @@ const getLogsContractV1 = oc.route({
|
|
|
1663
2158
|
"WARNING",
|
|
1664
2159
|
"DEBUG"
|
|
1665
2160
|
])).optional().describe("Filter by log level"),
|
|
1666
|
-
search:
|
|
2161
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
1667
2162
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1668
2163
|
})).output(z.object({
|
|
1669
2164
|
logs: z.array(logEntrySchema),
|
|
1670
2165
|
nextToken: z.string().nullable()
|
|
1671
2166
|
}));
|
|
1672
|
-
const getLatestLogsContractV1 =
|
|
2167
|
+
const getLatestLogsContractV1 = base.route({
|
|
1673
2168
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1674
2169
|
method: "GET",
|
|
1675
2170
|
summary: "Get latest logs",
|
|
1676
2171
|
description: "Get the N most recent logs for an environment",
|
|
1677
2172
|
tags: ["environments"],
|
|
1678
2173
|
successDescription: "The latest logs"
|
|
1679
|
-
}).errors({
|
|
1680
|
-
NOT_FOUND: {},
|
|
1681
|
-
BAD_REQUEST: {}
|
|
1682
|
-
}).input(z.object({
|
|
2174
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1683
2175
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1684
2176
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1685
2177
|
level: z.array(z.enum([
|
|
@@ -1688,9 +2180,9 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1688
2180
|
"WARNING",
|
|
1689
2181
|
"DEBUG"
|
|
1690
2182
|
])).optional().describe("Filter by log level"),
|
|
1691
|
-
search:
|
|
2183
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
1692
2184
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1693
|
-
const getDeploymentLogsContractV1 =
|
|
2185
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1694
2186
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1695
2187
|
method: "GET",
|
|
1696
2188
|
summary: "Get deployment logs",
|
|
@@ -1717,22 +2209,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1717
2209
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1718
2210
|
task_count: z.array(analyticsDataPointSchema)
|
|
1719
2211
|
});
|
|
1720
|
-
const getProjectAnalyticsContractV1 =
|
|
2212
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1721
2213
|
path: "/v1/analytics/{projectId}",
|
|
1722
2214
|
method: "GET",
|
|
1723
2215
|
summary: "Get project analytics",
|
|
1724
2216
|
description: "Get analytics data for a project over a time range",
|
|
1725
2217
|
tags: ["analytics"],
|
|
1726
2218
|
successDescription: "The project analytics data"
|
|
1727
|
-
}).errors({
|
|
1728
|
-
NOT_FOUND: {},
|
|
1729
|
-
BAD_REQUEST: {}
|
|
1730
|
-
}).input(z.object({
|
|
2219
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1731
2220
|
projectId: z.string().describe("The ID of the project"),
|
|
1732
2221
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1733
2222
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1734
2223
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1735
|
-
}).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({
|
|
1736
2225
|
metadata: z.object({
|
|
1737
2226
|
startTimestamp: z.number(),
|
|
1738
2227
|
endTimestamp: z.number(),
|
|
@@ -1742,7 +2231,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1742
2231
|
}),
|
|
1743
2232
|
timeSeries: analyticsTimeSeriesSchema
|
|
1744
2233
|
}));
|
|
1745
|
-
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({
|
|
1746
2360
|
path: "/v1/teams",
|
|
1747
2361
|
method: "GET",
|
|
1748
2362
|
summary: "List teams",
|
|
@@ -1755,7 +2369,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1755
2369
|
createdAt: z.coerce.date(),
|
|
1756
2370
|
hasStripeAccount: z.boolean()
|
|
1757
2371
|
})));
|
|
1758
|
-
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({
|
|
1759
2388
|
path: "/v1/tunnels/ticket",
|
|
1760
2389
|
method: "GET",
|
|
1761
2390
|
summary: "Get a tunnel ticket",
|
|
@@ -1767,16 +2396,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1767
2396
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1768
2397
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1769
2398
|
}));
|
|
1770
|
-
const publishServerContractV1 =
|
|
2399
|
+
const publishServerContractV1 = base.route({
|
|
1771
2400
|
path: "/v1/distribution/publish",
|
|
1772
2401
|
method: "POST",
|
|
1773
2402
|
summary: "Publish a server to the MCP registry",
|
|
1774
2403
|
tags: ["distribution"],
|
|
1775
2404
|
successDescription: "The server has been published successfully"
|
|
1776
|
-
}).errors({
|
|
1777
|
-
NOT_FOUND: {},
|
|
1778
|
-
BAD_REQUEST: {}
|
|
1779
|
-
}).input(z.object({
|
|
2405
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1780
2406
|
projectId: z.string(),
|
|
1781
2407
|
domain: z.string(),
|
|
1782
2408
|
title: z.string().min(1).max(100),
|
|
@@ -1785,17 +2411,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1785
2411
|
iconSrc: z.url().max(255).optional(),
|
|
1786
2412
|
dryRun: z.boolean().optional()
|
|
1787
2413
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1788
|
-
const getServerInfoContractV1 =
|
|
2414
|
+
const getServerInfoContractV1 = base.route({
|
|
1789
2415
|
path: "/v1/distribution/get",
|
|
1790
2416
|
method: "GET",
|
|
1791
2417
|
summary: "Get server info",
|
|
1792
2418
|
description: "Get info about a server",
|
|
1793
2419
|
tags: ["distribution"],
|
|
1794
2420
|
successDescription: "The server info"
|
|
1795
|
-
}).errors({
|
|
1796
|
-
NOT_FOUND: {},
|
|
1797
|
-
BAD_REQUEST: {}
|
|
1798
|
-
}).input(z.object({
|
|
2421
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1799
2422
|
projectId: z.string(),
|
|
1800
2423
|
domain: z.string()
|
|
1801
2424
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1814,7 +2437,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1814
2437
|
isPlaygroundEnabled: z.boolean(),
|
|
1815
2438
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1816
2439
|
});
|
|
1817
|
-
const getPlaygroundContractV1 =
|
|
2440
|
+
const getPlaygroundContractV1 = base.route({
|
|
1818
2441
|
path: "/v1/environments/{environmentId}/playground",
|
|
1819
2442
|
method: "GET",
|
|
1820
2443
|
summary: "Get playground configuration",
|
|
@@ -1822,17 +2445,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1822
2445
|
tags: ["environments"],
|
|
1823
2446
|
successDescription: "The playground configuration"
|
|
1824
2447
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1825
|
-
const upsertPlaygroundContractV1 =
|
|
2448
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1826
2449
|
path: "/v1/environments/{environmentId}/playground",
|
|
1827
2450
|
method: "PUT",
|
|
1828
2451
|
summary: "Update playground configuration",
|
|
1829
2452
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1830
2453
|
tags: ["environments"],
|
|
1831
2454
|
successDescription: "The updated playground configuration"
|
|
1832
|
-
}).errors({
|
|
1833
|
-
NOT_FOUND: {},
|
|
1834
|
-
BAD_REQUEST: {}
|
|
1835
|
-
}).input(z.object({
|
|
2455
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1836
2456
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1837
2457
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1838
2458
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1840,7 +2460,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1840
2460
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1841
2461
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1842
2462
|
})).output(playgroundOutputSchema);
|
|
1843
|
-
const createBeaconContractV1 =
|
|
2463
|
+
const createBeaconContractV1 = base.route({
|
|
1844
2464
|
path: "/v1/beacon/audits",
|
|
1845
2465
|
method: "POST",
|
|
1846
2466
|
summary: "Create a beacon audit",
|
|
@@ -1849,7 +2469,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1849
2469
|
successDescription: "The audit has been created"
|
|
1850
2470
|
}).errors({
|
|
1851
2471
|
NOT_FOUND: {},
|
|
1852
|
-
BAD_REQUEST: {},
|
|
1853
2472
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1854
2473
|
}).input(z.object({
|
|
1855
2474
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1857,7 +2476,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1857
2476
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1858
2477
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1859
2478
|
})).output(z.object({ id: z.string() }));
|
|
1860
|
-
const getBeaconContractV1 =
|
|
2479
|
+
const getBeaconContractV1 = base.route({
|
|
1861
2480
|
path: "/v1/beacon/audits/{auditId}",
|
|
1862
2481
|
method: "GET",
|
|
1863
2482
|
summary: "Get a beacon audit",
|
|
@@ -1872,9 +2491,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1872
2491
|
createdAt: z.coerce.date(),
|
|
1873
2492
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1874
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);
|
|
1875
2545
|
const contract = {
|
|
1876
|
-
teams: {
|
|
2546
|
+
teams: {
|
|
2547
|
+
list: { v1: listTeamsContractV1 },
|
|
2548
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2549
|
+
},
|
|
1877
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 } },
|
|
1878
2561
|
deployments: {
|
|
1879
2562
|
list: { v1: listDeploymentsContractV1 },
|
|
1880
2563
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1884,6 +2567,7 @@ const contract = {
|
|
|
1884
2567
|
environments: {
|
|
1885
2568
|
create: { v1: createEnvironmentContractV1 },
|
|
1886
2569
|
get: { v1: getEnvironmentContractV1 },
|
|
2570
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1887
2571
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1888
2572
|
getLogs: { v1: getLogsContractV1 },
|
|
1889
2573
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1894,6 +2578,12 @@ const contract = {
|
|
|
1894
2578
|
update: { v1: updateEnvironmentVariableContractV1 },
|
|
1895
2579
|
delete: { v1: deleteEnvironmentVariableContractV1 }
|
|
1896
2580
|
},
|
|
2581
|
+
telemetryDestinations: {
|
|
2582
|
+
list: { v1: listTelemetryDestinationsContractV1 },
|
|
2583
|
+
create: { v1: createTelemetryDestinationContractV1 },
|
|
2584
|
+
update: { v1: updateTelemetryDestinationContractV1 },
|
|
2585
|
+
delete: { v1: deleteTelemetryDestinationContractV1 }
|
|
2586
|
+
},
|
|
1897
2587
|
projects: {
|
|
1898
2588
|
update: { v1: updateProjectContractV1 },
|
|
1899
2589
|
get: { v1: getProjectContractV1 },
|
|
@@ -1913,7 +2603,39 @@ const contract = {
|
|
|
1913
2603
|
beacon: {
|
|
1914
2604
|
create: { v1: createBeaconContractV1 },
|
|
1915
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 }
|
|
1916
2638
|
}
|
|
1917
2639
|
};
|
|
1918
2640
|
//#endregion
|
|
1919
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, 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 };
|