@alpic-ai/api 0.0.0-staging.gfcfbb4c → 0.0.0-staging.gfd3cfa9
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 +900 -188
- 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(),
|
|
@@ -426,14 +434,16 @@ z.object({
|
|
|
426
434
|
collectResponsePayload: z.boolean(),
|
|
427
435
|
collectErrorMessage: z.boolean(),
|
|
428
436
|
collectUserData: z.boolean(),
|
|
429
|
-
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
437
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
438
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
430
439
|
});
|
|
431
|
-
z.object({
|
|
440
|
+
const feedbackSchema = z.object({
|
|
432
441
|
id: z.string(),
|
|
433
442
|
createdAt: z.coerce.date(),
|
|
434
443
|
environmentId: z.string(),
|
|
435
444
|
content: z.string(),
|
|
436
|
-
source: z.enum(["model", "user"])
|
|
445
|
+
source: z.enum(["model", "user"]),
|
|
446
|
+
clientName: z.string().nullable()
|
|
437
447
|
});
|
|
438
448
|
z.object({
|
|
439
449
|
content: z.string(),
|
|
@@ -449,7 +459,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
449
459
|
"pink",
|
|
450
460
|
"gray"
|
|
451
461
|
]);
|
|
452
|
-
intentCategoryColorSchema.options;
|
|
462
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
453
463
|
const intentCategorySchema = z.object({
|
|
454
464
|
id: z.string(),
|
|
455
465
|
createdAt: z.coerce.date(),
|
|
@@ -457,7 +467,7 @@ const intentCategorySchema = z.object({
|
|
|
457
467
|
name: z.string(),
|
|
458
468
|
color: intentCategoryColorSchema
|
|
459
469
|
});
|
|
460
|
-
z.object({
|
|
470
|
+
const intentCategorySummarySchema = z.object({
|
|
461
471
|
id: z.string(),
|
|
462
472
|
name: z.string(),
|
|
463
473
|
color: intentCategoryColorSchema,
|
|
@@ -469,6 +479,7 @@ z.object({
|
|
|
469
479
|
environmentId: z.string(),
|
|
470
480
|
toolName: z.string(),
|
|
471
481
|
message: z.string(),
|
|
482
|
+
clientName: z.string().nullable(),
|
|
472
483
|
categories: z.array(intentCategorySchema)
|
|
473
484
|
});
|
|
474
485
|
const signalCategorySchema = z.object({
|
|
@@ -527,12 +538,264 @@ z.object({
|
|
|
527
538
|
createdAt: z.coerce.date(),
|
|
528
539
|
updatedAt: z.coerce.date()
|
|
529
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]);
|
|
530
551
|
z.enum([
|
|
531
552
|
"INFO",
|
|
532
553
|
"WARNING",
|
|
533
554
|
"DEBUG",
|
|
534
555
|
"ERROR"
|
|
535
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_toolbox",
|
|
600
|
+
label: "Claude Toolbox",
|
|
601
|
+
vendor: "anthropic",
|
|
602
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
603
|
+
},
|
|
604
|
+
{
|
|
605
|
+
id: "anthropic_api",
|
|
606
|
+
label: "Anthropic API",
|
|
607
|
+
vendor: "anthropic",
|
|
608
|
+
rawNames: ["Anthropic/API"]
|
|
609
|
+
},
|
|
610
|
+
{
|
|
611
|
+
id: "anthropic_connector_refresh",
|
|
612
|
+
label: "Anthropic (connector refresh)",
|
|
613
|
+
vendor: "anthropic",
|
|
614
|
+
rawNames: ["Anthropic"]
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
id: "codex",
|
|
618
|
+
label: "Codex",
|
|
619
|
+
vendor: "openai",
|
|
620
|
+
rawNames: [
|
|
621
|
+
"codex-mcp-client",
|
|
622
|
+
"codex",
|
|
623
|
+
"Codex",
|
|
624
|
+
"codex-cli",
|
|
625
|
+
"openai-mcp (Codex)"
|
|
626
|
+
]
|
|
627
|
+
},
|
|
628
|
+
{
|
|
629
|
+
id: "chatgpt",
|
|
630
|
+
label: "ChatGPT",
|
|
631
|
+
vendor: "openai",
|
|
632
|
+
rawNames: ["openai-mcp", "openai-mcp (ChatGPT)"]
|
|
633
|
+
},
|
|
634
|
+
{
|
|
635
|
+
id: "openai_responses_api",
|
|
636
|
+
label: "OpenAI Responses API",
|
|
637
|
+
vendor: "openai",
|
|
638
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
id: "openai_agent_builder",
|
|
642
|
+
label: "OpenAI Agent Builder",
|
|
643
|
+
vendor: "openai",
|
|
644
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
645
|
+
},
|
|
646
|
+
{
|
|
647
|
+
id: "cursor",
|
|
648
|
+
label: "Cursor",
|
|
649
|
+
vendor: "cursor",
|
|
650
|
+
rawNames: [
|
|
651
|
+
"cursor-vscode",
|
|
652
|
+
"Cursor",
|
|
653
|
+
"cursor"
|
|
654
|
+
]
|
|
655
|
+
},
|
|
656
|
+
{
|
|
657
|
+
id: "cline",
|
|
658
|
+
label: "Cline",
|
|
659
|
+
vendor: "cline",
|
|
660
|
+
rawNames: [
|
|
661
|
+
"Cline",
|
|
662
|
+
"cline",
|
|
663
|
+
"@cline/core"
|
|
664
|
+
]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "github_copilot",
|
|
668
|
+
label: "GitHub Copilot",
|
|
669
|
+
vendor: "githubCopilot",
|
|
670
|
+
rawNames: [
|
|
671
|
+
"Copilot",
|
|
672
|
+
"github-copilot-developer",
|
|
673
|
+
"Copilot MCP Gateway",
|
|
674
|
+
"Xcode/copilot-xcode"
|
|
675
|
+
]
|
|
676
|
+
},
|
|
677
|
+
{
|
|
678
|
+
id: "gemini_cli",
|
|
679
|
+
label: "Gemini CLI",
|
|
680
|
+
vendor: "google",
|
|
681
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
id: "antigravity",
|
|
685
|
+
label: "Antigravity",
|
|
686
|
+
vendor: "google",
|
|
687
|
+
rawNames: ["antigravity-client"]
|
|
688
|
+
},
|
|
689
|
+
{
|
|
690
|
+
id: "gemini",
|
|
691
|
+
label: "Gemini",
|
|
692
|
+
vendor: "google",
|
|
693
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
694
|
+
},
|
|
695
|
+
{
|
|
696
|
+
id: "windsurf",
|
|
697
|
+
label: "Windsurf",
|
|
698
|
+
vendor: "windsurf",
|
|
699
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "mistral",
|
|
703
|
+
label: "Mistral / Le Chat",
|
|
704
|
+
vendor: "mistral",
|
|
705
|
+
rawNames: ["Mistral"],
|
|
706
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
707
|
+
},
|
|
708
|
+
{
|
|
709
|
+
id: "n8n",
|
|
710
|
+
label: "n8n",
|
|
711
|
+
vendor: "n8n",
|
|
712
|
+
rawNames: [
|
|
713
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
714
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
715
|
+
"n8n"
|
|
716
|
+
]
|
|
717
|
+
},
|
|
718
|
+
{
|
|
719
|
+
id: "alpic_playground",
|
|
720
|
+
label: "Alpic Playground",
|
|
721
|
+
vendor: "alpic",
|
|
722
|
+
rawNames: ["alpic-playground", "playground"]
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
id: "opencode",
|
|
726
|
+
label: "opencode",
|
|
727
|
+
vendor: "opencode",
|
|
728
|
+
rawNames: ["opencode"]
|
|
729
|
+
},
|
|
730
|
+
{
|
|
731
|
+
id: "zed",
|
|
732
|
+
label: "Zed",
|
|
733
|
+
vendor: "zed",
|
|
734
|
+
rawNames: ["Zed", "zed"]
|
|
735
|
+
},
|
|
736
|
+
{
|
|
737
|
+
id: "zapier",
|
|
738
|
+
label: "Zapier",
|
|
739
|
+
vendor: "zapier",
|
|
740
|
+
rawNames: ["Zapier", "zapier"]
|
|
741
|
+
},
|
|
742
|
+
{
|
|
743
|
+
id: "make",
|
|
744
|
+
label: "Make",
|
|
745
|
+
vendor: "make",
|
|
746
|
+
rawNames: ["Make", "make"]
|
|
747
|
+
},
|
|
748
|
+
{
|
|
749
|
+
id: "librechat",
|
|
750
|
+
label: "LibreChat",
|
|
751
|
+
vendor: "mcp",
|
|
752
|
+
rawNames: ["LibreChat", "librechat"]
|
|
753
|
+
},
|
|
754
|
+
{
|
|
755
|
+
id: "jan",
|
|
756
|
+
label: "Jan",
|
|
757
|
+
vendor: "mcp",
|
|
758
|
+
rawNames: ["Jan", "jan"]
|
|
759
|
+
},
|
|
760
|
+
{
|
|
761
|
+
id: "goose",
|
|
762
|
+
label: "goose",
|
|
763
|
+
vendor: "mcp",
|
|
764
|
+
rawNames: ["goose", "Goose"]
|
|
765
|
+
},
|
|
766
|
+
{
|
|
767
|
+
id: "mcphost",
|
|
768
|
+
label: "mcphost",
|
|
769
|
+
vendor: "mcp",
|
|
770
|
+
rawNames: ["mcphost"]
|
|
771
|
+
},
|
|
772
|
+
{
|
|
773
|
+
id: "mcporter",
|
|
774
|
+
label: "mcporter",
|
|
775
|
+
vendor: "mcp",
|
|
776
|
+
rawNames: ["mcporter"]
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
id: "rmcp",
|
|
780
|
+
label: "rmcp",
|
|
781
|
+
vendor: "mcp",
|
|
782
|
+
rawNames: ["rmcp"]
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
id: "unnamed_client",
|
|
786
|
+
label: "Unnamed client",
|
|
787
|
+
vendor: "mcp",
|
|
788
|
+
rawNames: [
|
|
789
|
+
"mcp",
|
|
790
|
+
"unknown",
|
|
791
|
+
""
|
|
792
|
+
]
|
|
793
|
+
}
|
|
794
|
+
];
|
|
795
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
796
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
797
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
798
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
536
799
|
const runtimeSchema = z.enum([
|
|
537
800
|
"python3.13",
|
|
538
801
|
"python3.14",
|
|
@@ -610,15 +873,7 @@ z.object({
|
|
|
610
873
|
serverFields: serverFieldsSchema$1,
|
|
611
874
|
source: z.enum(["registry", "defaults"])
|
|
612
875
|
});
|
|
613
|
-
/**
|
|
614
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
615
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
616
|
-
*
|
|
617
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
618
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
619
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
620
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
621
|
-
*/
|
|
876
|
+
/** 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. */
|
|
622
877
|
const clampStringField = (field) => {
|
|
623
878
|
const max = field.maxLength;
|
|
624
879
|
if (max === null) return field;
|
|
@@ -626,6 +881,10 @@ const clampStringField = (field) => {
|
|
|
626
881
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
627
882
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
628
883
|
};
|
|
884
|
+
const unboundedArrayField = (field) => {
|
|
885
|
+
const unbounded = z.array(field.element);
|
|
886
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
887
|
+
};
|
|
629
888
|
const toolDefinitionSchema = z.object({
|
|
630
889
|
name: z.string(),
|
|
631
890
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -638,11 +897,22 @@ const toolDefinitionSchema = z.object({
|
|
|
638
897
|
}).optional()
|
|
639
898
|
});
|
|
640
899
|
const positiveTestCaseSchema = z.object({
|
|
641
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
642
|
-
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."),
|
|
900
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
901
|
+
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."),
|
|
643
902
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
644
903
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
645
|
-
}).
|
|
904
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
905
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
906
|
+
scenario: z.string().optional(),
|
|
907
|
+
userPrompt: z.string().optional()
|
|
908
|
+
});
|
|
909
|
+
const blankPositiveTestCase = () => ({
|
|
910
|
+
scenario: "",
|
|
911
|
+
userPrompt: "",
|
|
912
|
+
toolTriggered: "",
|
|
913
|
+
expectedOutput: ""
|
|
914
|
+
});
|
|
915
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
646
916
|
const screenshotEntrySchema = z.object({
|
|
647
917
|
prompt: z.string(),
|
|
648
918
|
url: z.url()
|
|
@@ -955,20 +1225,25 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
955
1225
|
"zh-TW"
|
|
956
1226
|
]);
|
|
957
1227
|
const negativeTestCaseSchema = z.object({
|
|
958
|
-
scenario: z.string(),
|
|
959
|
-
userPrompt: z.string()
|
|
960
|
-
}).
|
|
1228
|
+
scenario: z.string().min(1),
|
|
1229
|
+
userPrompt: z.string().min(1)
|
|
1230
|
+
}).describe("Each case: Scenario + User prompt (the plugin should NOT trigger).");
|
|
1231
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1232
|
+
scenario: z.string().optional(),
|
|
1233
|
+
userPrompt: z.string().optional()
|
|
1234
|
+
});
|
|
1235
|
+
const blankNegativeTestCase = () => ({
|
|
1236
|
+
scenario: "",
|
|
1237
|
+
userPrompt: ""
|
|
1238
|
+
});
|
|
1239
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
961
1240
|
const chatgptToolJustificationSchema = z.object({
|
|
962
1241
|
toolName: z.string(),
|
|
963
1242
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
964
1243
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
965
1244
|
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.\"")
|
|
966
1245
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
967
|
-
/**
|
|
968
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
969
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
970
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
971
|
-
*/
|
|
1246
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
972
1247
|
const chatgptTaglineSchema = z.string().max(30);
|
|
973
1248
|
const chatgptDescriptionSchema = z.string();
|
|
974
1249
|
const chatgptTranslationSchema = z.object({
|
|
@@ -977,34 +1252,32 @@ const chatgptTranslationSchema = z.object({
|
|
|
977
1252
|
description: chatgptDescriptionSchema
|
|
978
1253
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
979
1254
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
980
|
-
/**
|
|
981
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
982
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
983
|
-
*/
|
|
1255
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
984
1256
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
985
1257
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
986
1258
|
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."),
|
|
987
|
-
appName: z.string().describe("The name users will see in ChatGPT and in the
|
|
1259
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Plugin Directory."),
|
|
988
1260
|
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
989
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the
|
|
1261
|
+
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)."),
|
|
990
1262
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
991
|
-
developerName: z.string().describe("Developer name shown publicly on the
|
|
1263
|
+
developerName: z.string().describe("Developer name shown publicly on the plugin's directory page."),
|
|
992
1264
|
companyUrl: urlField.describe("Your company's main website URL."),
|
|
993
1265
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
994
1266
|
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
995
|
-
termsOfServiceUrl: urlField.describe("URL to the
|
|
996
|
-
demoRecordingUrl: urlField.describe("URL to a video demonstrating the
|
|
997
|
-
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My
|
|
1267
|
+
termsOfServiceUrl: urlField.describe("URL to the plugin's terms of service."),
|
|
1268
|
+
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."),
|
|
1269
|
+
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."),
|
|
998
1270
|
serverUrl: urlField.describe("URL of the MCP server."),
|
|
999
1271
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1000
1272
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1001
1273
|
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."),
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1274
|
+
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."),
|
|
1275
|
+
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."),
|
|
1276
|
+
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."),
|
|
1277
|
+
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."),
|
|
1005
1278
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1006
1279
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
1007
|
-
releaseNotes: z.string().describe("Publicly displayed on the
|
|
1280
|
+
releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
|
|
1008
1281
|
});
|
|
1009
1282
|
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1010
1283
|
tagline: z.string().optional(),
|
|
@@ -1015,23 +1288,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1015
1288
|
demoRecordingUrl: z.string().optional(),
|
|
1016
1289
|
serverUrl: z.string().optional(),
|
|
1017
1290
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1291
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1292
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1018
1293
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1019
1294
|
});
|
|
1020
|
-
|
|
1295
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1296
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1021
1297
|
appName: true,
|
|
1022
1298
|
developerName: true,
|
|
1023
1299
|
serverUrl: true,
|
|
1024
1300
|
tools: true,
|
|
1301
|
+
skills: true,
|
|
1025
1302
|
authentication: true
|
|
1026
1303
|
});
|
|
1027
|
-
|
|
1304
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1305
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1028
1306
|
tagline: true,
|
|
1029
1307
|
description: true,
|
|
1030
1308
|
category: true,
|
|
1031
1309
|
testCases: true,
|
|
1032
1310
|
negativeTestCases: true,
|
|
1033
1311
|
toolJustifications: true
|
|
1034
|
-
}).extend({
|
|
1312
|
+
}).extend({
|
|
1313
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1314
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1315
|
+
}).extend({
|
|
1316
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1317
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1318
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1319
|
+
});
|
|
1035
1320
|
const claudeCategorySchema = z.enum([
|
|
1036
1321
|
"Productivity",
|
|
1037
1322
|
"Communication",
|
|
@@ -1077,11 +1362,7 @@ const claudePolicyAcknowledgementSchema = z.enum([
|
|
|
1077
1362
|
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1078
1363
|
"Public documentation for this connector will be live by the publish date."
|
|
1079
1364
|
]);
|
|
1080
|
-
/**
|
|
1081
|
-
* Field order mirrors the claude.ai directory submission wizard
|
|
1082
|
-
* (`claude.ai/admin-settings/directory/submissions/new`), grouped by step.
|
|
1083
|
-
* When adding/removing/reordering fields, keep this in sync with the wizard.
|
|
1084
|
-
*/
|
|
1365
|
+
/** 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. */
|
|
1085
1366
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1086
1367
|
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
|
|
1087
1368
|
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
@@ -1158,7 +1439,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1158
1439
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1159
1440
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1160
1441
|
});
|
|
1161
|
-
|
|
1442
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1443
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1162
1444
|
serverUrl: true,
|
|
1163
1445
|
name: true,
|
|
1164
1446
|
slug: true,
|
|
@@ -1173,39 +1455,93 @@ claudeSubmissionFormDataSchema.pick({
|
|
|
1173
1455
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1174
1456
|
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1175
1457
|
});
|
|
1176
|
-
/**
|
|
1177
|
-
* Narrative fields the LLM-backed generation step produces for Claude submissions.
|
|
1178
|
-
* This schema accepts the slightly loose shape returned by AI generation, then normalizes it into
|
|
1179
|
-
* the strict form shape. Keep transforms here rather than in callers so generation leniency is
|
|
1180
|
-
* colocated with the Claude contract.
|
|
1181
|
-
*/
|
|
1458
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1182
1459
|
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1183
1460
|
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1184
1461
|
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1185
1462
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1186
1463
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1187
1464
|
});
|
|
1188
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1465
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1189
1466
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1190
1467
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1191
1468
|
});
|
|
1469
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1470
|
+
const byField = {};
|
|
1471
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1472
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1473
|
+
return byField;
|
|
1474
|
+
}
|
|
1475
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1476
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1477
|
+
"pass",
|
|
1478
|
+
"fail",
|
|
1479
|
+
"unverified"
|
|
1480
|
+
]);
|
|
1481
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1482
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1483
|
+
claudeai: ["privacyPolicy"]
|
|
1484
|
+
};
|
|
1485
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1486
|
+
const policyDisclosureSchema = z.enum([
|
|
1487
|
+
"dataCategories",
|
|
1488
|
+
"purposesOfUse",
|
|
1489
|
+
"recipients",
|
|
1490
|
+
"retention"
|
|
1491
|
+
]);
|
|
1492
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1493
|
+
field: verifiableUrlFieldSchema,
|
|
1494
|
+
url: z.string(),
|
|
1495
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1496
|
+
reason: z.string(),
|
|
1497
|
+
concerns: z.array(z.string()).optional(),
|
|
1498
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1499
|
+
});
|
|
1500
|
+
const urlVerificationSchema = z.object({
|
|
1501
|
+
verifiedAt: z.coerce.date(),
|
|
1502
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1503
|
+
});
|
|
1504
|
+
const pageKindSchema = z.enum([
|
|
1505
|
+
"expectedDocument",
|
|
1506
|
+
"errorPage",
|
|
1507
|
+
"loginWall",
|
|
1508
|
+
"parkedDomain",
|
|
1509
|
+
"comingSoon",
|
|
1510
|
+
"marketingPage",
|
|
1511
|
+
"unrelatedDocument"
|
|
1512
|
+
]);
|
|
1513
|
+
z.object({
|
|
1514
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1515
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1516
|
+
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.")
|
|
1517
|
+
});
|
|
1192
1518
|
const submissionMetaFieldsSchema = z.object({
|
|
1193
1519
|
id: z.string(),
|
|
1194
1520
|
environmentId: z.string(),
|
|
1195
1521
|
auditId: z.string().nullable(),
|
|
1522
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1196
1523
|
createdAt: z.coerce.date(),
|
|
1197
1524
|
updatedAt: z.coerce.date()
|
|
1198
1525
|
});
|
|
1199
1526
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1200
1527
|
platform: z.literal("claudeai"),
|
|
1201
|
-
formData: claudeSubmissionDraftSchema
|
|
1528
|
+
formData: claudeSubmissionDraftSchema,
|
|
1529
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1202
1530
|
});
|
|
1203
1531
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1204
1532
|
platform: z.literal("chatgpt"),
|
|
1205
|
-
formData: chatgptSubmissionDraftSchema
|
|
1533
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1534
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1206
1535
|
});
|
|
1207
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1536
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1208
1537
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1538
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1539
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1540
|
+
z.literal([
|
|
1541
|
+
100,
|
|
1542
|
+
75,
|
|
1543
|
+
50
|
|
1544
|
+
]);
|
|
1209
1545
|
const subscriptionPlanSchema = z.enum([
|
|
1210
1546
|
"pro",
|
|
1211
1547
|
"business",
|
|
@@ -1217,17 +1553,78 @@ const customerCreditsSchema = z.object({
|
|
|
1217
1553
|
expiresAt: z.number().nullable(),
|
|
1218
1554
|
currency: z.string()
|
|
1219
1555
|
});
|
|
1220
|
-
const customerUsageSchema = z.object({
|
|
1221
|
-
amountInCents: z.number(),
|
|
1222
|
-
currency: z.string(),
|
|
1223
|
-
periodEnd: z.number()
|
|
1224
|
-
});
|
|
1225
1556
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1226
1557
|
z.object({
|
|
1227
1558
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1228
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1229
1559
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1230
1560
|
});
|
|
1561
|
+
const metricsQueueEventSchema = z.object({
|
|
1562
|
+
ts: z.number().int(),
|
|
1563
|
+
method: z.string(),
|
|
1564
|
+
tool: z.string().nullable(),
|
|
1565
|
+
client: z.string(),
|
|
1566
|
+
sessionId: z.string().nullable(),
|
|
1567
|
+
conversationId: z.string().nullable().optional(),
|
|
1568
|
+
durationMs: z.number().int(),
|
|
1569
|
+
outputTokens: z.number().int().nullable(),
|
|
1570
|
+
errorType: z.enum([
|
|
1571
|
+
"mcp_error",
|
|
1572
|
+
"tool_error",
|
|
1573
|
+
"timeout"
|
|
1574
|
+
]).nullable(),
|
|
1575
|
+
errorCode: z.number().int().nullable()
|
|
1576
|
+
});
|
|
1577
|
+
z.object({
|
|
1578
|
+
v: z.literal(1),
|
|
1579
|
+
envId: z.string(),
|
|
1580
|
+
events: z.array(metricsQueueEventSchema)
|
|
1581
|
+
});
|
|
1582
|
+
z.object({ v: z.number() });
|
|
1583
|
+
const TELEMETRY_SIGNALS = [
|
|
1584
|
+
"logs",
|
|
1585
|
+
"metrics",
|
|
1586
|
+
"traces"
|
|
1587
|
+
];
|
|
1588
|
+
const telemetrySignalSchema = z.enum(TELEMETRY_SIGNALS);
|
|
1589
|
+
const OTLP_PROTOCOLS = ["http/protobuf", "http/json"];
|
|
1590
|
+
const otlpProtocolSchema = z.enum(OTLP_PROTOCOLS);
|
|
1591
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1592
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1593
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1594
|
+
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");
|
|
1595
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1596
|
+
id: z.string(),
|
|
1597
|
+
name: otlpHeaderNameSchema,
|
|
1598
|
+
value: otlpHeaderValueSchema,
|
|
1599
|
+
isSecret: z.boolean()
|
|
1600
|
+
});
|
|
1601
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1602
|
+
"credentials",
|
|
1603
|
+
"wrong-path",
|
|
1604
|
+
"wrong-protocol",
|
|
1605
|
+
"invalid-payload",
|
|
1606
|
+
"partial-rejection",
|
|
1607
|
+
"blocked-target",
|
|
1608
|
+
"timeout",
|
|
1609
|
+
"unreachable",
|
|
1610
|
+
"receiver-error",
|
|
1611
|
+
"unexpected-status"
|
|
1612
|
+
]);
|
|
1613
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1614
|
+
z.object({
|
|
1615
|
+
id: z.string(),
|
|
1616
|
+
signal: telemetrySignalSchema,
|
|
1617
|
+
endpoint: otlpEndpointSchema,
|
|
1618
|
+
protocol: otlpProtocolSchema,
|
|
1619
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1620
|
+
status: telemetryDestinationStatusSchema,
|
|
1621
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1622
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1623
|
+
});
|
|
1624
|
+
const hasDuplicateHeaderNames = (headers) => {
|
|
1625
|
+
const names = headers.map(({ name }) => name.trim().toLowerCase());
|
|
1626
|
+
return new Set(names).size !== names.length;
|
|
1627
|
+
};
|
|
1231
1628
|
//#endregion
|
|
1232
1629
|
//#region src/auth-scope.ts
|
|
1233
1630
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1326,6 +1723,14 @@ const serverFieldsSchema = z.object({
|
|
|
1326
1723
|
});
|
|
1327
1724
|
//#endregion
|
|
1328
1725
|
//#region src/api.contract.ts
|
|
1726
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1727
|
+
try {
|
|
1728
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1729
|
+
return true;
|
|
1730
|
+
} catch {
|
|
1731
|
+
return false;
|
|
1732
|
+
}
|
|
1733
|
+
};
|
|
1329
1734
|
const deploymentStatusSchema = z.enum([
|
|
1330
1735
|
"ongoing",
|
|
1331
1736
|
"deployed",
|
|
@@ -1354,21 +1759,20 @@ const deploymentSchema = z.object({
|
|
|
1354
1759
|
isCurrent: z.boolean(),
|
|
1355
1760
|
deploymentPageUrl: z.url().nullable()
|
|
1356
1761
|
});
|
|
1357
|
-
const
|
|
1762
|
+
const isValidTimeInput = (value) => {
|
|
1358
1763
|
if (ms(value) !== void 0) return true;
|
|
1359
1764
|
return !Number.isNaN(new Date(value).getTime());
|
|
1360
1765
|
};
|
|
1361
|
-
const
|
|
1766
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1767
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1768
|
+
const createEnvironmentContractV1 = base.route({
|
|
1362
1769
|
path: "/v1/environments",
|
|
1363
1770
|
method: "POST",
|
|
1364
1771
|
summary: "Create an environment",
|
|
1365
1772
|
description: "Create an environment for a project",
|
|
1366
1773
|
tags: ["environments"],
|
|
1367
1774
|
successDescription: "The environment has been created successfully"
|
|
1368
|
-
}).errors({
|
|
1369
|
-
NOT_FOUND: {},
|
|
1370
|
-
BAD_REQUEST: {}
|
|
1371
|
-
}).input(z.object({
|
|
1775
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1372
1776
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1373
1777
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1374
1778
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1381,7 +1785,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1381
1785
|
createdAt: z.coerce.date(),
|
|
1382
1786
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1383
1787
|
}));
|
|
1384
|
-
const getEnvironmentContractV1 =
|
|
1788
|
+
const getEnvironmentContractV1 = base.route({
|
|
1385
1789
|
path: "/v1/environments/{environmentId}",
|
|
1386
1790
|
method: "GET",
|
|
1387
1791
|
summary: "Get an environment",
|
|
@@ -1397,6 +1801,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1397
1801
|
createdAt: z.coerce.date(),
|
|
1398
1802
|
projectId: z.string()
|
|
1399
1803
|
}));
|
|
1804
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1805
|
+
path: "/v1/environments/{environmentId}",
|
|
1806
|
+
method: "DELETE",
|
|
1807
|
+
summary: "Delete an environment",
|
|
1808
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1809
|
+
tags: ["environments"],
|
|
1810
|
+
successDescription: "The environment has been deleted successfully"
|
|
1811
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1400
1812
|
const domainSchema = z.object({
|
|
1401
1813
|
domain: z.string(),
|
|
1402
1814
|
status: z.enum([
|
|
@@ -1438,7 +1850,7 @@ const projectOutputSchema = z.object({
|
|
|
1438
1850
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1439
1851
|
environments: z.array(environmentSchema)
|
|
1440
1852
|
});
|
|
1441
|
-
const getProjectContractV1 =
|
|
1853
|
+
const getProjectContractV1 = base.route({
|
|
1442
1854
|
path: "/v1/projects/{projectId}",
|
|
1443
1855
|
method: "GET",
|
|
1444
1856
|
summary: "Get a project",
|
|
@@ -1446,18 +1858,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1446
1858
|
tags: ["projects"],
|
|
1447
1859
|
successDescription: "The project details"
|
|
1448
1860
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1449
|
-
const listProjectsContractV1 =
|
|
1861
|
+
const listProjectsContractV1 = base.route({
|
|
1450
1862
|
path: "/v1/projects",
|
|
1451
1863
|
method: "GET",
|
|
1452
1864
|
summary: "List projects",
|
|
1453
1865
|
description: "List all projects for a team",
|
|
1454
1866
|
tags: ["projects"],
|
|
1455
1867
|
successDescription: "The list of projects"
|
|
1456
|
-
}).errors({
|
|
1457
|
-
|
|
1458
|
-
BAD_REQUEST: {}
|
|
1459
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1460
|
-
const createProjectContractV1 = oc.route({
|
|
1868
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1869
|
+
const createProjectContractV1 = base.route({
|
|
1461
1870
|
path: "/v1/projects",
|
|
1462
1871
|
method: "POST",
|
|
1463
1872
|
summary: "Create a project",
|
|
@@ -1466,7 +1875,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1466
1875
|
successDescription: "The project has been created successfully"
|
|
1467
1876
|
}).errors({
|
|
1468
1877
|
NOT_FOUND: {},
|
|
1469
|
-
BAD_REQUEST: {},
|
|
1470
1878
|
FORBIDDEN: {}
|
|
1471
1879
|
}).input(z.object({
|
|
1472
1880
|
teamId: z.string().optional(),
|
|
@@ -1507,7 +1915,101 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1507
1915
|
isSecret: z.boolean(),
|
|
1508
1916
|
createdAt: z.coerce.date()
|
|
1509
1917
|
});
|
|
1510
|
-
const
|
|
1918
|
+
const telemetryDestinationHeaderOutputSchema = z.discriminatedUnion("isSecret", [z.object({
|
|
1919
|
+
id: z.string(),
|
|
1920
|
+
name: otlpHeaderNameSchema,
|
|
1921
|
+
value: z.null(),
|
|
1922
|
+
isSecret: z.literal(true)
|
|
1923
|
+
}), z.object({
|
|
1924
|
+
id: z.string(),
|
|
1925
|
+
name: otlpHeaderNameSchema,
|
|
1926
|
+
value: otlpHeaderValueSchema,
|
|
1927
|
+
isSecret: z.literal(false)
|
|
1928
|
+
})]);
|
|
1929
|
+
const telemetryDestinationOutputSchema = z.object({
|
|
1930
|
+
id: z.string(),
|
|
1931
|
+
signal: telemetrySignalSchema,
|
|
1932
|
+
endpoint: otlpEndpointSchema,
|
|
1933
|
+
protocol: otlpProtocolSchema,
|
|
1934
|
+
headers: z.array(telemetryDestinationHeaderOutputSchema),
|
|
1935
|
+
status: telemetryDestinationStatusSchema,
|
|
1936
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1937
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1938
|
+
});
|
|
1939
|
+
const createTelemetryDestinationHeaderInputSchema = z.object({
|
|
1940
|
+
name: otlpHeaderNameSchema,
|
|
1941
|
+
value: otlpHeaderValueSchema.min(1, "Enter a header value"),
|
|
1942
|
+
isSecret: z.boolean()
|
|
1943
|
+
});
|
|
1944
|
+
const updateTelemetryDestinationHeaderInputSchema = z.object({
|
|
1945
|
+
id: z.string().optional(),
|
|
1946
|
+
name: otlpHeaderNameSchema,
|
|
1947
|
+
value: otlpHeaderValueSchema.optional(),
|
|
1948
|
+
isSecret: z.boolean()
|
|
1949
|
+
});
|
|
1950
|
+
const uniqueTelemetryHeaders = (headers) => !hasDuplicateHeaderNames(headers);
|
|
1951
|
+
const listTelemetryDestinationsContractV1 = base.route({
|
|
1952
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
1953
|
+
method: "GET",
|
|
1954
|
+
summary: "List telemetry destinations",
|
|
1955
|
+
description: "List the OTLP destinations configured for an environment. Secret header values are never returned.",
|
|
1956
|
+
tags: ["telemetry"],
|
|
1957
|
+
successDescription: "The list of telemetry destinations"
|
|
1958
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(telemetryDestinationOutputSchema));
|
|
1959
|
+
const createTelemetryDestinationContractV1 = base.route({
|
|
1960
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
1961
|
+
method: "POST",
|
|
1962
|
+
summary: "Create a telemetry destination",
|
|
1963
|
+
description: "Verify and save an OTLP destination for logs, metrics, or traces.",
|
|
1964
|
+
tags: ["telemetry"],
|
|
1965
|
+
successDescription: "The telemetry destination has been created"
|
|
1966
|
+
}).errors({
|
|
1967
|
+
NOT_FOUND: {},
|
|
1968
|
+
FORBIDDEN: {},
|
|
1969
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 },
|
|
1970
|
+
INTERNAL_SERVER_ERROR: {}
|
|
1971
|
+
}).input(z.object({
|
|
1972
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1973
|
+
signal: telemetrySignalSchema,
|
|
1974
|
+
endpoint: otlpEndpointSchema,
|
|
1975
|
+
protocol: otlpProtocolSchema.default("http/protobuf"),
|
|
1976
|
+
isScopedToIntentionalRequestsOnly: z.boolean().default(false),
|
|
1977
|
+
headers: z.array(createTelemetryDestinationHeaderInputSchema).default([]).refine(uniqueTelemetryHeaders, "Header names must be unique")
|
|
1978
|
+
})).output(telemetryDestinationOutputSchema);
|
|
1979
|
+
const updateTelemetryDestinationContractV1 = base.route({
|
|
1980
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
1981
|
+
method: "PATCH",
|
|
1982
|
+
summary: "Update a telemetry destination",
|
|
1983
|
+
description: "Verify and save changes to an OTLP destination. Omit headers to keep them unchanged; omit the value of an existing header to preserve it. A secret header value must be re-entered when the endpoint changes.",
|
|
1984
|
+
tags: ["telemetry"],
|
|
1985
|
+
successDescription: "The telemetry destination has been updated"
|
|
1986
|
+
}).errors({
|
|
1987
|
+
NOT_FOUND: {},
|
|
1988
|
+
FORBIDDEN: {},
|
|
1989
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 }
|
|
1990
|
+
}).input(z.object({
|
|
1991
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1992
|
+
destinationId: z.string().describe("The ID of the telemetry destination"),
|
|
1993
|
+
endpoint: otlpEndpointSchema.optional(),
|
|
1994
|
+
protocol: otlpProtocolSchema.optional(),
|
|
1995
|
+
isScopedToIntentionalRequestsOnly: z.boolean().optional(),
|
|
1996
|
+
headers: z.array(updateTelemetryDestinationHeaderInputSchema).refine(uniqueTelemetryHeaders, "Header names must be unique").optional()
|
|
1997
|
+
})).output(telemetryDestinationOutputSchema);
|
|
1998
|
+
const deleteTelemetryDestinationContractV1 = base.route({
|
|
1999
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
2000
|
+
method: "DELETE",
|
|
2001
|
+
summary: "Delete a telemetry destination",
|
|
2002
|
+
description: "Delete an OTLP destination from an environment.",
|
|
2003
|
+
tags: ["telemetry"],
|
|
2004
|
+
successDescription: "The telemetry destination has been deleted"
|
|
2005
|
+
}).errors({
|
|
2006
|
+
NOT_FOUND: {},
|
|
2007
|
+
INTERNAL_SERVER_ERROR: {}
|
|
2008
|
+
}).input(z.object({
|
|
2009
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2010
|
+
destinationId: z.string().describe("The ID of the telemetry destination")
|
|
2011
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2012
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1511
2013
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1512
2014
|
method: "GET",
|
|
1513
2015
|
summary: "List environment variables",
|
|
@@ -1515,48 +2017,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1515
2017
|
tags: ["environments"],
|
|
1516
2018
|
successDescription: "The list of environment variables"
|
|
1517
2019
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1518
|
-
const createEnvironmentVariablesContractV1 =
|
|
2020
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1519
2021
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1520
2022
|
method: "POST",
|
|
1521
2023
|
summary: "Add environment variables",
|
|
1522
2024
|
description: "Add one or more environment variables to an environment",
|
|
1523
2025
|
tags: ["environments"],
|
|
1524
2026
|
successDescription: "The environment variables have been added successfully"
|
|
1525
|
-
}).errors({
|
|
1526
|
-
NOT_FOUND: {},
|
|
1527
|
-
BAD_REQUEST: {}
|
|
1528
|
-
}).input(z.object({
|
|
2027
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1529
2028
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1530
2029
|
environmentVariables: environmentVariablesSchema
|
|
1531
2030
|
})).output(z.object({ success: z.literal(true) }));
|
|
1532
|
-
const updateEnvironmentVariableContractV1 =
|
|
2031
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1533
2032
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1534
2033
|
method: "PATCH",
|
|
1535
2034
|
summary: "Update an environment variable",
|
|
1536
2035
|
description: "Update an environment variable by ID",
|
|
1537
2036
|
tags: ["environments"],
|
|
1538
2037
|
successDescription: "The environment variable has been updated successfully"
|
|
1539
|
-
}).errors({
|
|
1540
|
-
NOT_FOUND: {},
|
|
1541
|
-
BAD_REQUEST: {}
|
|
1542
|
-
}).input(z.object({
|
|
2038
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1543
2039
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1544
2040
|
key: environmentVariableSchema.shape.key,
|
|
1545
2041
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1546
2042
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1547
2043
|
})).output(z.object({ success: z.literal(true) }));
|
|
1548
|
-
const deleteEnvironmentVariableContractV1 =
|
|
2044
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1549
2045
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1550
2046
|
method: "DELETE",
|
|
1551
2047
|
summary: "Delete an environment variable",
|
|
1552
2048
|
description: "Delete an environment variable by ID",
|
|
1553
2049
|
tags: ["environments"],
|
|
1554
2050
|
successDescription: "The environment variable has been deleted successfully"
|
|
1555
|
-
}).errors({
|
|
1556
|
-
|
|
1557
|
-
BAD_REQUEST: {}
|
|
1558
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1559
|
-
const deleteProjectContractV1 = oc.route({
|
|
2051
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
2052
|
+
const deleteProjectContractV1 = base.route({
|
|
1560
2053
|
path: "/v1/projects/{projectId}",
|
|
1561
2054
|
method: "DELETE",
|
|
1562
2055
|
summary: "Delete a project",
|
|
@@ -1564,7 +2057,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1564
2057
|
tags: ["projects"],
|
|
1565
2058
|
successDescription: "The project has been deleted successfully"
|
|
1566
2059
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1567
|
-
const updateProjectContractV1 =
|
|
2060
|
+
const updateProjectContractV1 = base.route({
|
|
1568
2061
|
path: "/v1/projects/{projectId}",
|
|
1569
2062
|
method: "PATCH",
|
|
1570
2063
|
summary: "Update a project",
|
|
@@ -1573,14 +2066,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1573
2066
|
successDescription: "The project has been updated successfully"
|
|
1574
2067
|
}).errors({
|
|
1575
2068
|
NOT_FOUND: {},
|
|
1576
|
-
BAD_REQUEST: {},
|
|
1577
2069
|
FORBIDDEN: {}
|
|
1578
2070
|
}).input(z.object({
|
|
1579
2071
|
projectId: z.string().describe("The ID of the project"),
|
|
1580
2072
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1581
2073
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1582
2074
|
})).output(projectOutputSchema);
|
|
1583
|
-
const deployEnvironmentContractV1 =
|
|
2075
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1584
2076
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1585
2077
|
method: "POST",
|
|
1586
2078
|
summary: "Deploy an environment",
|
|
@@ -1589,29 +2081,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1589
2081
|
successDescription: "The environment has been deployed successfully"
|
|
1590
2082
|
}).errors({
|
|
1591
2083
|
NOT_FOUND: {},
|
|
1592
|
-
BAD_REQUEST: {},
|
|
1593
2084
|
CONFLICT: {}
|
|
1594
2085
|
}).input(z.object({
|
|
1595
2086
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1596
2087
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1597
2088
|
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.")
|
|
1598
2089
|
})).output(deploymentSchema);
|
|
1599
|
-
const uploadDeploymentArtifactContractV1 =
|
|
2090
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1600
2091
|
path: "/v1/deployments/upload",
|
|
1601
2092
|
method: "POST",
|
|
1602
2093
|
summary: "Upload deployment artifacts",
|
|
1603
2094
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1604
2095
|
tags: ["deployments"],
|
|
1605
2096
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1606
|
-
}).errors({
|
|
1607
|
-
NOT_FOUND: {},
|
|
1608
|
-
BAD_REQUEST: {}
|
|
1609
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
2097
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1610
2098
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1611
2099
|
token: z.string().describe("Token to identify the source archive"),
|
|
1612
2100
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1613
2101
|
}));
|
|
1614
|
-
const listDeploymentsContractV1 =
|
|
2102
|
+
const listDeploymentsContractV1 = base.route({
|
|
1615
2103
|
path: "/v1/projects/{projectId}/deployments",
|
|
1616
2104
|
method: "GET",
|
|
1617
2105
|
summary: "List project deployments",
|
|
@@ -1623,7 +2111,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1623
2111
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1624
2112
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1625
2113
|
})).output(z.array(deploymentSchema));
|
|
1626
|
-
const getDeploymentContractV1 =
|
|
2114
|
+
const getDeploymentContractV1 = base.route({
|
|
1627
2115
|
path: "/v1/deployments/{deploymentId}",
|
|
1628
2116
|
method: "GET",
|
|
1629
2117
|
summary: "Get a deployment",
|
|
@@ -1646,20 +2134,17 @@ const logEntrySchema = z.object({
|
|
|
1646
2134
|
method: z.string().optional(),
|
|
1647
2135
|
durationInMs: z.number().optional()
|
|
1648
2136
|
});
|
|
1649
|
-
const getLogsContractV1 =
|
|
2137
|
+
const getLogsContractV1 = base.route({
|
|
1650
2138
|
path: "/v1/environments/{environmentId}/logs",
|
|
1651
2139
|
method: "GET",
|
|
1652
2140
|
summary: "Get logs",
|
|
1653
2141
|
description: "Get logs for an environment",
|
|
1654
2142
|
tags: ["environments"],
|
|
1655
2143
|
successDescription: "The logs"
|
|
1656
|
-
}).errors({
|
|
1657
|
-
NOT_FOUND: {},
|
|
1658
|
-
BAD_REQUEST: {}
|
|
1659
|
-
}).input(z.object({
|
|
2144
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1660
2145
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1661
|
-
since:
|
|
1662
|
-
until:
|
|
2146
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2147
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1663
2148
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1664
2149
|
level: z.array(z.enum([
|
|
1665
2150
|
"INFO",
|
|
@@ -1667,23 +2152,20 @@ const getLogsContractV1 = oc.route({
|
|
|
1667
2152
|
"WARNING",
|
|
1668
2153
|
"DEBUG"
|
|
1669
2154
|
])).optional().describe("Filter by log level"),
|
|
1670
|
-
search:
|
|
2155
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
1671
2156
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1672
2157
|
})).output(z.object({
|
|
1673
2158
|
logs: z.array(logEntrySchema),
|
|
1674
2159
|
nextToken: z.string().nullable()
|
|
1675
2160
|
}));
|
|
1676
|
-
const getLatestLogsContractV1 =
|
|
2161
|
+
const getLatestLogsContractV1 = base.route({
|
|
1677
2162
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1678
2163
|
method: "GET",
|
|
1679
2164
|
summary: "Get latest logs",
|
|
1680
2165
|
description: "Get the N most recent logs for an environment",
|
|
1681
2166
|
tags: ["environments"],
|
|
1682
2167
|
successDescription: "The latest logs"
|
|
1683
|
-
}).errors({
|
|
1684
|
-
NOT_FOUND: {},
|
|
1685
|
-
BAD_REQUEST: {}
|
|
1686
|
-
}).input(z.object({
|
|
2168
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1687
2169
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1688
2170
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1689
2171
|
level: z.array(z.enum([
|
|
@@ -1692,9 +2174,9 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1692
2174
|
"WARNING",
|
|
1693
2175
|
"DEBUG"
|
|
1694
2176
|
])).optional().describe("Filter by log level"),
|
|
1695
|
-
search:
|
|
2177
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
1696
2178
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1697
|
-
const getDeploymentLogsContractV1 =
|
|
2179
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1698
2180
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1699
2181
|
method: "GET",
|
|
1700
2182
|
summary: "Get deployment logs",
|
|
@@ -1721,22 +2203,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1721
2203
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1722
2204
|
task_count: z.array(analyticsDataPointSchema)
|
|
1723
2205
|
});
|
|
1724
|
-
const getProjectAnalyticsContractV1 =
|
|
2206
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1725
2207
|
path: "/v1/analytics/{projectId}",
|
|
1726
2208
|
method: "GET",
|
|
1727
2209
|
summary: "Get project analytics",
|
|
1728
2210
|
description: "Get analytics data for a project over a time range",
|
|
1729
2211
|
tags: ["analytics"],
|
|
1730
2212
|
successDescription: "The project analytics data"
|
|
1731
|
-
}).errors({
|
|
1732
|
-
NOT_FOUND: {},
|
|
1733
|
-
BAD_REQUEST: {}
|
|
1734
|
-
}).input(z.object({
|
|
2213
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1735
2214
|
projectId: z.string().describe("The ID of the project"),
|
|
1736
2215
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1737
2216
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1738
2217
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1739
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2218
|
+
}).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({
|
|
1740
2219
|
metadata: z.object({
|
|
1741
2220
|
startTimestamp: z.number(),
|
|
1742
2221
|
endTimestamp: z.number(),
|
|
@@ -1746,7 +2225,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1746
2225
|
}),
|
|
1747
2226
|
timeSeries: analyticsTimeSeriesSchema
|
|
1748
2227
|
}));
|
|
1749
|
-
const
|
|
2228
|
+
const paginatedInsightsInputShape = {
|
|
2229
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2230
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2231
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2232
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2233
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2234
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2235
|
+
};
|
|
2236
|
+
const listIntentsContractV1 = base.route({
|
|
2237
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2238
|
+
method: "GET",
|
|
2239
|
+
summary: "List intents",
|
|
2240
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2241
|
+
tags: ["insights"],
|
|
2242
|
+
successDescription: "The grouped user intents"
|
|
2243
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2244
|
+
...paginatedInsightsInputShape,
|
|
2245
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2246
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2247
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2248
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2249
|
+
})).output(z.object({
|
|
2250
|
+
intents: z.array(z.object({
|
|
2251
|
+
id: z.string(),
|
|
2252
|
+
intentIds: z.array(z.string()).min(1),
|
|
2253
|
+
environmentId: z.string(),
|
|
2254
|
+
message: z.string(),
|
|
2255
|
+
toolName: z.string(),
|
|
2256
|
+
createdAt: z.coerce.date(),
|
|
2257
|
+
occurrenceCount: z.number().int().positive(),
|
|
2258
|
+
clientName: z.string().nullable(),
|
|
2259
|
+
clientId: z.string().nullable(),
|
|
2260
|
+
categories: z.array(z.object({
|
|
2261
|
+
id: z.string(),
|
|
2262
|
+
name: z.string(),
|
|
2263
|
+
color: intentCategoryColorSchema
|
|
2264
|
+
}))
|
|
2265
|
+
})),
|
|
2266
|
+
totalCount: z.number().int().nonnegative()
|
|
2267
|
+
}));
|
|
2268
|
+
const listFeedbacksContractV1 = base.route({
|
|
2269
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2270
|
+
method: "GET",
|
|
2271
|
+
summary: "List feedbacks",
|
|
2272
|
+
description: "List user feedback for an environment over a time range",
|
|
2273
|
+
tags: ["insights"],
|
|
2274
|
+
successDescription: "The user feedback"
|
|
2275
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2276
|
+
...paginatedInsightsInputShape,
|
|
2277
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2278
|
+
})).output(z.object({
|
|
2279
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2280
|
+
totalCount: z.number().int().nonnegative()
|
|
2281
|
+
}));
|
|
2282
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2283
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2284
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2285
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2286
|
+
method: "GET",
|
|
2287
|
+
summary: "List intent categories",
|
|
2288
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2289
|
+
tags: ["insights"],
|
|
2290
|
+
successDescription: "The intent categories"
|
|
2291
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2292
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2293
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2294
|
+
method: "POST",
|
|
2295
|
+
summary: "Create an intent category",
|
|
2296
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2297
|
+
tags: ["insights"],
|
|
2298
|
+
successDescription: "The created intent category"
|
|
2299
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2300
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2301
|
+
name: intentCategoryNameSchema,
|
|
2302
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2303
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2304
|
+
})).output(intentCategorySchema);
|
|
2305
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2306
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2307
|
+
method: "PATCH",
|
|
2308
|
+
summary: "Update an intent category",
|
|
2309
|
+
description: "Rename or recolor an intent category",
|
|
2310
|
+
tags: ["insights"],
|
|
2311
|
+
successDescription: "The updated intent category"
|
|
2312
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2313
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2314
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2315
|
+
name: intentCategoryNameSchema.optional(),
|
|
2316
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2317
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2318
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2319
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2320
|
+
method: "DELETE",
|
|
2321
|
+
summary: "Delete an intent category",
|
|
2322
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2323
|
+
tags: ["insights"],
|
|
2324
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2325
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2326
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2327
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2328
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2329
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2330
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2331
|
+
method: "POST",
|
|
2332
|
+
summary: "Link an intent category",
|
|
2333
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2334
|
+
tags: ["insights"],
|
|
2335
|
+
successDescription: "The intents have been linked successfully"
|
|
2336
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2337
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2338
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2339
|
+
intentIds: categorizableIntentIdsSchema
|
|
2340
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2341
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2342
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2343
|
+
method: "POST",
|
|
2344
|
+
summary: "Unlink an intent category",
|
|
2345
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2346
|
+
tags: ["insights"],
|
|
2347
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2348
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2349
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2350
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2351
|
+
intentIds: categorizableIntentIdsSchema
|
|
2352
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2353
|
+
const listTeamsContractV1 = base.route({
|
|
1750
2354
|
path: "/v1/teams",
|
|
1751
2355
|
method: "GET",
|
|
1752
2356
|
summary: "List teams",
|
|
@@ -1759,7 +2363,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1759
2363
|
createdAt: z.coerce.date(),
|
|
1760
2364
|
hasStripeAccount: z.boolean()
|
|
1761
2365
|
})));
|
|
1762
|
-
const
|
|
2366
|
+
const getTeamUsageContractV1 = base.route({
|
|
2367
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2368
|
+
method: "GET",
|
|
2369
|
+
summary: "Get team usage",
|
|
2370
|
+
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.",
|
|
2371
|
+
tags: ["teams"],
|
|
2372
|
+
successDescription: "The current billing window usage"
|
|
2373
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2374
|
+
teamId: z.string(),
|
|
2375
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2376
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2377
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2378
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2379
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2380
|
+
}));
|
|
2381
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1763
2382
|
path: "/v1/tunnels/ticket",
|
|
1764
2383
|
method: "GET",
|
|
1765
2384
|
summary: "Get a tunnel ticket",
|
|
@@ -1771,16 +2390,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1771
2390
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1772
2391
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1773
2392
|
}));
|
|
1774
|
-
const publishServerContractV1 =
|
|
2393
|
+
const publishServerContractV1 = base.route({
|
|
1775
2394
|
path: "/v1/distribution/publish",
|
|
1776
2395
|
method: "POST",
|
|
1777
2396
|
summary: "Publish a server to the MCP registry",
|
|
1778
2397
|
tags: ["distribution"],
|
|
1779
2398
|
successDescription: "The server has been published successfully"
|
|
1780
|
-
}).errors({
|
|
1781
|
-
NOT_FOUND: {},
|
|
1782
|
-
BAD_REQUEST: {}
|
|
1783
|
-
}).input(z.object({
|
|
2399
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1784
2400
|
projectId: z.string(),
|
|
1785
2401
|
domain: z.string(),
|
|
1786
2402
|
title: z.string().min(1).max(100),
|
|
@@ -1789,17 +2405,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1789
2405
|
iconSrc: z.url().max(255).optional(),
|
|
1790
2406
|
dryRun: z.boolean().optional()
|
|
1791
2407
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1792
|
-
const getServerInfoContractV1 =
|
|
2408
|
+
const getServerInfoContractV1 = base.route({
|
|
1793
2409
|
path: "/v1/distribution/get",
|
|
1794
2410
|
method: "GET",
|
|
1795
2411
|
summary: "Get server info",
|
|
1796
2412
|
description: "Get info about a server",
|
|
1797
2413
|
tags: ["distribution"],
|
|
1798
2414
|
successDescription: "The server info"
|
|
1799
|
-
}).errors({
|
|
1800
|
-
NOT_FOUND: {},
|
|
1801
|
-
BAD_REQUEST: {}
|
|
1802
|
-
}).input(z.object({
|
|
2415
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1803
2416
|
projectId: z.string(),
|
|
1804
2417
|
domain: z.string()
|
|
1805
2418
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1818,7 +2431,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1818
2431
|
isPlaygroundEnabled: z.boolean(),
|
|
1819
2432
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1820
2433
|
});
|
|
1821
|
-
const getPlaygroundContractV1 =
|
|
2434
|
+
const getPlaygroundContractV1 = base.route({
|
|
1822
2435
|
path: "/v1/environments/{environmentId}/playground",
|
|
1823
2436
|
method: "GET",
|
|
1824
2437
|
summary: "Get playground configuration",
|
|
@@ -1826,17 +2439,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1826
2439
|
tags: ["environments"],
|
|
1827
2440
|
successDescription: "The playground configuration"
|
|
1828
2441
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1829
|
-
const upsertPlaygroundContractV1 =
|
|
2442
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1830
2443
|
path: "/v1/environments/{environmentId}/playground",
|
|
1831
2444
|
method: "PUT",
|
|
1832
2445
|
summary: "Update playground configuration",
|
|
1833
2446
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1834
2447
|
tags: ["environments"],
|
|
1835
2448
|
successDescription: "The updated playground configuration"
|
|
1836
|
-
}).errors({
|
|
1837
|
-
NOT_FOUND: {},
|
|
1838
|
-
BAD_REQUEST: {}
|
|
1839
|
-
}).input(z.object({
|
|
2449
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1840
2450
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1841
2451
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1842
2452
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1844,7 +2454,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1844
2454
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1845
2455
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1846
2456
|
})).output(playgroundOutputSchema);
|
|
1847
|
-
const createBeaconContractV1 =
|
|
2457
|
+
const createBeaconContractV1 = base.route({
|
|
1848
2458
|
path: "/v1/beacon/audits",
|
|
1849
2459
|
method: "POST",
|
|
1850
2460
|
summary: "Create a beacon audit",
|
|
@@ -1853,7 +2463,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1853
2463
|
successDescription: "The audit has been created"
|
|
1854
2464
|
}).errors({
|
|
1855
2465
|
NOT_FOUND: {},
|
|
1856
|
-
BAD_REQUEST: {},
|
|
1857
2466
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1858
2467
|
}).input(z.object({
|
|
1859
2468
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1861,7 +2470,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1861
2470
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1862
2471
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1863
2472
|
})).output(z.object({ id: z.string() }));
|
|
1864
|
-
const getBeaconContractV1 =
|
|
2473
|
+
const getBeaconContractV1 = base.route({
|
|
1865
2474
|
path: "/v1/beacon/audits/{auditId}",
|
|
1866
2475
|
method: "GET",
|
|
1867
2476
|
summary: "Get a beacon audit",
|
|
@@ -1876,9 +2485,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
1876
2485
|
createdAt: z.coerce.date(),
|
|
1877
2486
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1878
2487
|
}));
|
|
2488
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2489
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2490
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2491
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2492
|
+
const createSubmissionContractV1 = base.route({
|
|
2493
|
+
path: "/v1/submissions",
|
|
2494
|
+
method: "POST",
|
|
2495
|
+
summary: "Create a submission package",
|
|
2496
|
+
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.",
|
|
2497
|
+
tags: ["submissions"],
|
|
2498
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2499
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2500
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2501
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2502
|
+
})).output(submissionSchema);
|
|
2503
|
+
const listSubmissionsContractV1 = base.route({
|
|
2504
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2505
|
+
method: "GET",
|
|
2506
|
+
summary: "List submission packages",
|
|
2507
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2508
|
+
tags: ["submissions"],
|
|
2509
|
+
successDescription: "The list of submission packages"
|
|
2510
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2511
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2512
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2513
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2514
|
+
})).output(z.array(submissionSchema));
|
|
2515
|
+
const getSubmissionContractV1 = base.route({
|
|
2516
|
+
path: "/v1/submissions/{submissionId}",
|
|
2517
|
+
method: "GET",
|
|
2518
|
+
summary: "Get a submission package",
|
|
2519
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2520
|
+
tags: ["submissions"],
|
|
2521
|
+
successDescription: "The submission package"
|
|
2522
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2523
|
+
const updateSubmissionContractV1 = base.route({
|
|
2524
|
+
path: "/v1/submissions/{submissionId}",
|
|
2525
|
+
method: "PUT",
|
|
2526
|
+
summary: "Update a submission package",
|
|
2527
|
+
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.",
|
|
2528
|
+
tags: ["submissions"],
|
|
2529
|
+
successDescription: "The updated submission package"
|
|
2530
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2531
|
+
submissionId: submissionIdSchema,
|
|
2532
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2533
|
+
formData: claudeSubmissionUpdateSchema
|
|
2534
|
+
}), z.object({
|
|
2535
|
+
submissionId: submissionIdSchema,
|
|
2536
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2537
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2538
|
+
})])).output(submissionSchema);
|
|
1879
2539
|
const contract = {
|
|
1880
|
-
teams: {
|
|
2540
|
+
teams: {
|
|
2541
|
+
list: { v1: listTeamsContractV1 },
|
|
2542
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2543
|
+
},
|
|
1881
2544
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2545
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2546
|
+
intentCategories: {
|
|
2547
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2548
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2549
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2550
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2551
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2552
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2553
|
+
},
|
|
2554
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1882
2555
|
deployments: {
|
|
1883
2556
|
list: { v1: listDeploymentsContractV1 },
|
|
1884
2557
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1888,6 +2561,7 @@ const contract = {
|
|
|
1888
2561
|
environments: {
|
|
1889
2562
|
create: { v1: createEnvironmentContractV1 },
|
|
1890
2563
|
get: { v1: getEnvironmentContractV1 },
|
|
2564
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
1891
2565
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
1892
2566
|
getLogs: { v1: getLogsContractV1 },
|
|
1893
2567
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -1898,6 +2572,12 @@ const contract = {
|
|
|
1898
2572
|
update: { v1: updateEnvironmentVariableContractV1 },
|
|
1899
2573
|
delete: { v1: deleteEnvironmentVariableContractV1 }
|
|
1900
2574
|
},
|
|
2575
|
+
telemetryDestinations: {
|
|
2576
|
+
list: { v1: listTelemetryDestinationsContractV1 },
|
|
2577
|
+
create: { v1: createTelemetryDestinationContractV1 },
|
|
2578
|
+
update: { v1: updateTelemetryDestinationContractV1 },
|
|
2579
|
+
delete: { v1: deleteTelemetryDestinationContractV1 }
|
|
2580
|
+
},
|
|
1901
2581
|
projects: {
|
|
1902
2582
|
update: { v1: updateProjectContractV1 },
|
|
1903
2583
|
get: { v1: getProjectContractV1 },
|
|
@@ -1917,7 +2597,39 @@ const contract = {
|
|
|
1917
2597
|
beacon: {
|
|
1918
2598
|
create: { v1: createBeaconContractV1 },
|
|
1919
2599
|
get: { v1: getBeaconContractV1 }
|
|
2600
|
+
},
|
|
2601
|
+
submissions: {
|
|
2602
|
+
create: { v1: createSubmissionContractV1 },
|
|
2603
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2604
|
+
get: { v1: getSubmissionContractV1 },
|
|
2605
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2606
|
+
}
|
|
2607
|
+
};
|
|
2608
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2609
|
+
const contractForDocs = {
|
|
2610
|
+
...contract,
|
|
2611
|
+
deployments: deploymentsForDocs
|
|
2612
|
+
};
|
|
2613
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2614
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2615
|
+
info: {
|
|
2616
|
+
title: "Alpic API",
|
|
2617
|
+
version: "1.0.0"
|
|
2618
|
+
},
|
|
2619
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2620
|
+
security: [{ bearerAuth: [] }],
|
|
2621
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2622
|
+
type: "http",
|
|
2623
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2624
|
+
scheme: "bearer"
|
|
2625
|
+
} } },
|
|
2626
|
+
commonSchemas: {
|
|
2627
|
+
Submission: { schema: submissionSchema },
|
|
2628
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2629
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2630
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2631
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
1920
2632
|
}
|
|
1921
2633
|
};
|
|
1922
2634
|
//#endregion
|
|
1923
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2635
|
+
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 };
|