@alpic-ai/api 0.0.0-dev.gd9d8e80 → 0.0.0-dev.gd9e9ea8
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 +1536 -48
- package/dist/index.mjs +786 -375
- package/package.json +24 -8
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.30.0_supports-color@7.2.0_zod@4.4.3/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -169,11 +169,21 @@ z$1.object({
|
|
|
169
169
|
token: z$1.string(),
|
|
170
170
|
token_type_hint: z$1.string().optional()
|
|
171
171
|
}).strip();
|
|
172
|
-
|
|
172
|
+
//#endregion
|
|
173
|
+
//#region ../domains/dist/index.mjs
|
|
174
|
+
const AI_PLATFORMS = ["chatgpt", "claudeai"];
|
|
175
|
+
const platformSchema = z.enum(AI_PLATFORMS);
|
|
173
176
|
const PLATFORM_LABELS = {
|
|
174
177
|
chatgpt: "ChatGPT",
|
|
175
178
|
claudeai: "Claude.ai"
|
|
176
179
|
};
|
|
180
|
+
const WAF_PLATFORMS = [
|
|
181
|
+
"akamai",
|
|
182
|
+
"cloudflare",
|
|
183
|
+
"fastly"
|
|
184
|
+
];
|
|
185
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
186
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
187
|
const auditStatusSchema = z.enum([
|
|
178
188
|
"pending",
|
|
179
189
|
"partial",
|
|
@@ -246,6 +256,16 @@ z.object({
|
|
|
246
256
|
clientSecret: z.string(),
|
|
247
257
|
clientScopes: z.array(z.string())
|
|
248
258
|
});
|
|
259
|
+
z.enum([
|
|
260
|
+
"opening_balance",
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"refund",
|
|
266
|
+
"admin_adjustment"
|
|
267
|
+
]);
|
|
268
|
+
z.enum(["playground"]);
|
|
249
269
|
const deploymentStatusSchema$1 = z.enum([
|
|
250
270
|
"ongoing",
|
|
251
271
|
"deployed",
|
|
@@ -273,34 +293,51 @@ const deploymentSummarySchema = z.object({
|
|
|
273
293
|
createdAt: z.coerce.date(),
|
|
274
294
|
updatedAt: z.coerce.date()
|
|
275
295
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
296
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
297
|
const publicEnvironmentSchema = z.object({
|
|
298
|
+
allowsAnonymous: z.literal(true),
|
|
299
|
+
oAuthMetadata: z.strictObject({})
|
|
300
|
+
});
|
|
301
|
+
/** 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. */
|
|
302
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
303
|
+
allowsAnonymous: z.boolean(),
|
|
304
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
305
|
+
scope: z.string().optional()
|
|
306
|
+
});
|
|
307
|
+
/** 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. */
|
|
308
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
309
|
+
allowsAnonymous: z.boolean(),
|
|
310
|
+
oAuthMetadata: z.object({
|
|
311
|
+
externalAuthorizationServerUrl: z.url(),
|
|
312
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
313
|
+
}),
|
|
314
|
+
scope: z.string().optional()
|
|
315
|
+
});
|
|
316
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
317
|
+
const standaloneEnvironmentSchema = z.object({
|
|
318
|
+
allowsAnonymous: z.boolean(),
|
|
319
|
+
oAuthMetadata: z.object({
|
|
320
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
321
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
322
|
+
}),
|
|
323
|
+
scope: z.string().optional()
|
|
324
|
+
});
|
|
325
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
326
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
327
|
+
allowsAnonymous: z.literal(false),
|
|
328
|
+
oAuthMetadata: z.strictObject({}),
|
|
329
|
+
scope: z.string().optional()
|
|
330
|
+
});
|
|
331
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
332
|
isPublic: z.literal(true),
|
|
283
333
|
oAuthMetadata: z.undefined().optional()
|
|
284
334
|
});
|
|
285
|
-
|
|
286
|
-
* Protected environment with an external resource metadata URL
|
|
287
|
-
*
|
|
288
|
-
* An external resource metadata URL is returned in the WWW-Authenticate header during the first 401 response.
|
|
289
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
290
|
-
*/
|
|
291
|
-
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
335
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
336
|
isPublic: z.literal(false),
|
|
293
337
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
338
|
scope: z.string().optional()
|
|
295
339
|
});
|
|
296
|
-
|
|
297
|
-
* Protected environment with an external authorization server URL
|
|
298
|
-
*
|
|
299
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
300
|
-
* An external authorization server URL is returned when requesting the endpoint.
|
|
301
|
-
* Everything that follows is handled outside of the MCP server scope.
|
|
302
|
-
*/
|
|
303
|
-
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
340
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
341
|
isPublic: z.literal(false),
|
|
305
342
|
oAuthMetadata: z.object({
|
|
306
343
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +345,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
345
|
}),
|
|
309
346
|
scope: z.string().optional()
|
|
310
347
|
});
|
|
311
|
-
|
|
312
|
-
* Standalone protected environment
|
|
313
|
-
*
|
|
314
|
-
* The server itself exposes the /.well-known/oauth-protected-resource endpoint.
|
|
315
|
-
* The server itself exposes the /.well-known/oauth-authorization-server endpoint.
|
|
316
|
-
*/
|
|
317
|
-
const standaloneEnvironmentSchema = z.object({
|
|
348
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
349
|
isPublic: z.literal(false),
|
|
319
350
|
oAuthMetadata: z.object({
|
|
320
351
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +353,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
353
|
}),
|
|
323
354
|
scope: z.string().optional()
|
|
324
355
|
});
|
|
325
|
-
|
|
326
|
-
* Protected environment without OAuth discovery
|
|
327
|
-
*
|
|
328
|
-
* The server enforces authentication but exposes no OAuth discovery metadata.
|
|
329
|
-
* Neither /.well-known/oauth-protected-resource nor /.well-known/oauth-authorization-server
|
|
330
|
-
* are advertised. Clients must obtain credentials out-of-band.
|
|
331
|
-
*/
|
|
332
|
-
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
356
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
357
|
isPublic: z.literal(false),
|
|
334
358
|
oAuthMetadata: z.strictObject({}),
|
|
335
359
|
scope: z.string().optional()
|
|
@@ -339,11 +363,21 @@ z.union([
|
|
|
339
363
|
externalResourceMetadataEnvironmentSchema,
|
|
340
364
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
365
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
366
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
367
|
+
legacyPublicEnvironmentSchema,
|
|
368
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
369
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
370
|
+
legacyStandaloneEnvironmentSchema,
|
|
371
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
372
|
+
]);
|
|
373
|
+
const playgroundModelSchema = z.enum([
|
|
374
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
375
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
376
|
+
"openai.gpt-5.4",
|
|
377
|
+
"openai.gpt-5.5"
|
|
343
378
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
379
|
const environmentDomainSchema = z.object({
|
|
346
|
-
|
|
380
|
+
name: z.string(),
|
|
347
381
|
status: z.enum([
|
|
348
382
|
"ongoing",
|
|
349
383
|
"deployed",
|
|
@@ -361,6 +395,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
395
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
396
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
397
|
isPlaygroundEnabled: z.boolean(),
|
|
398
|
+
playgroundModel: playgroundModelSchema,
|
|
364
399
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
400
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
401
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -370,11 +405,20 @@ const environmentSchema$1 = z.object({
|
|
|
370
405
|
});
|
|
371
406
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
372
407
|
z.object({
|
|
408
|
+
sessionReplayEnabled: z.boolean(),
|
|
409
|
+
collectRequestPayload: z.boolean(),
|
|
410
|
+
collectResponsePayload: z.boolean(),
|
|
411
|
+
collectErrorMessage: z.boolean(),
|
|
412
|
+
collectUserData: z.boolean(),
|
|
413
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
414
|
+
});
|
|
415
|
+
const feedbackSchema = z.object({
|
|
373
416
|
id: z.string(),
|
|
374
417
|
createdAt: z.coerce.date(),
|
|
375
418
|
environmentId: z.string(),
|
|
376
419
|
content: z.string(),
|
|
377
|
-
source: z.enum(["model", "user"])
|
|
420
|
+
source: z.enum(["model", "user"]),
|
|
421
|
+
clientName: z.string().nullable()
|
|
378
422
|
});
|
|
379
423
|
z.object({
|
|
380
424
|
content: z.string(),
|
|
@@ -390,7 +434,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
390
434
|
"pink",
|
|
391
435
|
"gray"
|
|
392
436
|
]);
|
|
393
|
-
intentCategoryColorSchema.options;
|
|
437
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
394
438
|
const intentCategorySchema = z.object({
|
|
395
439
|
id: z.string(),
|
|
396
440
|
createdAt: z.coerce.date(),
|
|
@@ -398,7 +442,7 @@ const intentCategorySchema = z.object({
|
|
|
398
442
|
name: z.string(),
|
|
399
443
|
color: intentCategoryColorSchema
|
|
400
444
|
});
|
|
401
|
-
z.object({
|
|
445
|
+
const intentCategorySummarySchema = z.object({
|
|
402
446
|
id: z.string(),
|
|
403
447
|
name: z.string(),
|
|
404
448
|
color: intentCategoryColorSchema,
|
|
@@ -410,6 +454,7 @@ z.object({
|
|
|
410
454
|
environmentId: z.string(),
|
|
411
455
|
toolName: z.string(),
|
|
412
456
|
message: z.string(),
|
|
457
|
+
clientName: z.string().nullable(),
|
|
413
458
|
categories: z.array(intentCategorySchema)
|
|
414
459
|
});
|
|
415
460
|
const signalCategorySchema = z.object({
|
|
@@ -468,12 +513,262 @@ z.object({
|
|
|
468
513
|
createdAt: z.coerce.date(),
|
|
469
514
|
updatedAt: z.coerce.date()
|
|
470
515
|
});
|
|
516
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
517
|
+
type: z.literal("mcp_request"),
|
|
518
|
+
method: z.string()
|
|
519
|
+
});
|
|
520
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
521
|
+
type: z.literal("mcp_error"),
|
|
522
|
+
method: z.string(),
|
|
523
|
+
error: z.string()
|
|
524
|
+
});
|
|
525
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
471
526
|
z.enum([
|
|
472
527
|
"INFO",
|
|
473
528
|
"WARNING",
|
|
474
529
|
"DEBUG",
|
|
475
530
|
"ERROR"
|
|
476
531
|
]);
|
|
532
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
533
|
+
const MCP_CLIENT_GROUPS = [
|
|
534
|
+
{
|
|
535
|
+
id: "claude_code",
|
|
536
|
+
label: "Claude Code",
|
|
537
|
+
vendor: "anthropic",
|
|
538
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
539
|
+
},
|
|
540
|
+
{
|
|
541
|
+
id: "claude",
|
|
542
|
+
label: "Claude",
|
|
543
|
+
vendor: "anthropic",
|
|
544
|
+
rawNames: [
|
|
545
|
+
"Anthropic/ClaudeAI",
|
|
546
|
+
"claude-ai",
|
|
547
|
+
"claude",
|
|
548
|
+
"Claude",
|
|
549
|
+
"claude-desktop",
|
|
550
|
+
"claude-desktop-3p"
|
|
551
|
+
]
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
id: "claude_mobile",
|
|
555
|
+
label: "Claude mobile",
|
|
556
|
+
vendor: "anthropic",
|
|
557
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
id: "claude_cowork",
|
|
561
|
+
label: "Claude Cowork",
|
|
562
|
+
vendor: "anthropic",
|
|
563
|
+
rawNames: ["Anthropic/Cowork"]
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
id: "claude_toolbox",
|
|
567
|
+
label: "Claude Toolbox",
|
|
568
|
+
vendor: "anthropic",
|
|
569
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
id: "anthropic_api",
|
|
573
|
+
label: "Anthropic API",
|
|
574
|
+
vendor: "anthropic",
|
|
575
|
+
rawNames: ["Anthropic/API"]
|
|
576
|
+
},
|
|
577
|
+
{
|
|
578
|
+
id: "anthropic_connector_refresh",
|
|
579
|
+
label: "Anthropic (connector refresh)",
|
|
580
|
+
vendor: "anthropic",
|
|
581
|
+
rawNames: ["Anthropic"]
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
id: "codex",
|
|
585
|
+
label: "Codex",
|
|
586
|
+
vendor: "openai",
|
|
587
|
+
rawNames: [
|
|
588
|
+
"codex-mcp-client",
|
|
589
|
+
"codex",
|
|
590
|
+
"Codex",
|
|
591
|
+
"codex-cli",
|
|
592
|
+
"openai-mcp (Codex)"
|
|
593
|
+
]
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
id: "chatgpt",
|
|
597
|
+
label: "ChatGPT",
|
|
598
|
+
vendor: "openai",
|
|
599
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
600
|
+
},
|
|
601
|
+
{
|
|
602
|
+
id: "openai_responses_api",
|
|
603
|
+
label: "OpenAI Responses API",
|
|
604
|
+
vendor: "openai",
|
|
605
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
id: "openai_agent_builder",
|
|
609
|
+
label: "OpenAI Agent Builder",
|
|
610
|
+
vendor: "openai",
|
|
611
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
612
|
+
},
|
|
613
|
+
{
|
|
614
|
+
id: "openai_other",
|
|
615
|
+
label: "OpenAI Other",
|
|
616
|
+
vendor: "openai",
|
|
617
|
+
rawNames: ["openai-mcp"]
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
id: "cursor",
|
|
621
|
+
label: "Cursor",
|
|
622
|
+
vendor: "cursor",
|
|
623
|
+
rawNames: [
|
|
624
|
+
"cursor-vscode",
|
|
625
|
+
"Cursor",
|
|
626
|
+
"cursor"
|
|
627
|
+
]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cline",
|
|
631
|
+
label: "Cline",
|
|
632
|
+
vendor: "cline",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"Cline",
|
|
635
|
+
"cline",
|
|
636
|
+
"@cline/core"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "github_copilot",
|
|
641
|
+
label: "GitHub Copilot",
|
|
642
|
+
vendor: "githubCopilot",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Copilot",
|
|
645
|
+
"github-copilot-developer",
|
|
646
|
+
"Copilot MCP Gateway",
|
|
647
|
+
"Xcode/copilot-xcode"
|
|
648
|
+
]
|
|
649
|
+
},
|
|
650
|
+
{
|
|
651
|
+
id: "gemini_cli",
|
|
652
|
+
label: "Gemini CLI",
|
|
653
|
+
vendor: "google",
|
|
654
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
655
|
+
},
|
|
656
|
+
{
|
|
657
|
+
id: "antigravity",
|
|
658
|
+
label: "Antigravity",
|
|
659
|
+
vendor: "google",
|
|
660
|
+
rawNames: ["antigravity-client"]
|
|
661
|
+
},
|
|
662
|
+
{
|
|
663
|
+
id: "gemini",
|
|
664
|
+
label: "Gemini",
|
|
665
|
+
vendor: "google",
|
|
666
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
id: "windsurf",
|
|
670
|
+
label: "Windsurf",
|
|
671
|
+
vendor: "windsurf",
|
|
672
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
673
|
+
},
|
|
674
|
+
{
|
|
675
|
+
id: "mistral",
|
|
676
|
+
label: "Mistral / Le Chat",
|
|
677
|
+
vendor: "mistral",
|
|
678
|
+
rawNames: ["Mistral"],
|
|
679
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
680
|
+
},
|
|
681
|
+
{
|
|
682
|
+
id: "n8n",
|
|
683
|
+
label: "n8n",
|
|
684
|
+
vendor: "n8n",
|
|
685
|
+
rawNames: [
|
|
686
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
687
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
688
|
+
"n8n"
|
|
689
|
+
]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "alpic_playground",
|
|
693
|
+
label: "Alpic Playground",
|
|
694
|
+
vendor: "alpic",
|
|
695
|
+
rawNames: ["alpic-playground", "playground"]
|
|
696
|
+
},
|
|
697
|
+
{
|
|
698
|
+
id: "opencode",
|
|
699
|
+
label: "opencode",
|
|
700
|
+
vendor: "opencode",
|
|
701
|
+
rawNames: ["opencode"]
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
id: "zed",
|
|
705
|
+
label: "Zed",
|
|
706
|
+
vendor: "zed",
|
|
707
|
+
rawNames: ["Zed", "zed"]
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
id: "zapier",
|
|
711
|
+
label: "Zapier",
|
|
712
|
+
vendor: "zapier",
|
|
713
|
+
rawNames: ["Zapier", "zapier"]
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
id: "make",
|
|
717
|
+
label: "Make",
|
|
718
|
+
vendor: "make",
|
|
719
|
+
rawNames: ["Make", "make"]
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
id: "librechat",
|
|
723
|
+
label: "LibreChat",
|
|
724
|
+
vendor: "mcp",
|
|
725
|
+
rawNames: ["LibreChat", "librechat"]
|
|
726
|
+
},
|
|
727
|
+
{
|
|
728
|
+
id: "jan",
|
|
729
|
+
label: "Jan",
|
|
730
|
+
vendor: "mcp",
|
|
731
|
+
rawNames: ["Jan", "jan"]
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
id: "goose",
|
|
735
|
+
label: "goose",
|
|
736
|
+
vendor: "mcp",
|
|
737
|
+
rawNames: ["goose", "Goose"]
|
|
738
|
+
},
|
|
739
|
+
{
|
|
740
|
+
id: "mcphost",
|
|
741
|
+
label: "mcphost",
|
|
742
|
+
vendor: "mcp",
|
|
743
|
+
rawNames: ["mcphost"]
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
id: "mcporter",
|
|
747
|
+
label: "mcporter",
|
|
748
|
+
vendor: "mcp",
|
|
749
|
+
rawNames: ["mcporter"]
|
|
750
|
+
},
|
|
751
|
+
{
|
|
752
|
+
id: "rmcp",
|
|
753
|
+
label: "rmcp",
|
|
754
|
+
vendor: "mcp",
|
|
755
|
+
rawNames: ["rmcp"]
|
|
756
|
+
},
|
|
757
|
+
{
|
|
758
|
+
id: "unnamed_client",
|
|
759
|
+
label: "Unnamed client",
|
|
760
|
+
vendor: "mcp",
|
|
761
|
+
rawNames: [
|
|
762
|
+
"mcp",
|
|
763
|
+
"unknown",
|
|
764
|
+
""
|
|
765
|
+
]
|
|
766
|
+
}
|
|
767
|
+
];
|
|
768
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
769
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
770
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
771
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
477
772
|
const runtimeSchema = z.enum([
|
|
478
773
|
"python3.13",
|
|
479
774
|
"python3.14",
|
|
@@ -502,15 +797,27 @@ z.object({
|
|
|
502
797
|
environments: z.array(environmentWithDomainsSchema),
|
|
503
798
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
504
799
|
});
|
|
800
|
+
const domainFailureReasonSchema = z.enum([
|
|
801
|
+
"caa",
|
|
802
|
+
"dns",
|
|
803
|
+
"invalid_domain",
|
|
804
|
+
"other"
|
|
805
|
+
]);
|
|
806
|
+
const projectDomainMappingSchema = z.object({
|
|
807
|
+
pathPrefix: z.string(),
|
|
808
|
+
environment: environmentSchema$1
|
|
809
|
+
});
|
|
505
810
|
z.object({
|
|
506
|
-
|
|
811
|
+
name: z.string(),
|
|
507
812
|
createdAt: z.coerce.date(),
|
|
508
813
|
status: z.enum([
|
|
509
814
|
"ongoing",
|
|
510
815
|
"deployed",
|
|
511
816
|
"failed"
|
|
512
817
|
]),
|
|
513
|
-
|
|
818
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
819
|
+
environment: environmentSchema$1,
|
|
820
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
514
821
|
});
|
|
515
822
|
const serverFieldsSchema$1 = z.object({
|
|
516
823
|
$schema: z.string(),
|
|
@@ -539,15 +846,7 @@ z.object({
|
|
|
539
846
|
serverFields: serverFieldsSchema$1,
|
|
540
847
|
source: z.enum(["registry", "defaults"])
|
|
541
848
|
});
|
|
542
|
-
/**
|
|
543
|
-
* Returns a variant of a `maxLength`-constrained string that clamps (truncates) instead of
|
|
544
|
-
* rejecting on overflow — used for AI-generated copy where the model routinely overshoots.
|
|
545
|
-
*
|
|
546
|
-
* NOTE: this rebuilds the schema from scratch, carrying over only `maxLength` (as a clamp),
|
|
547
|
-
* `minLength`, and the description. Any other validators on the source field (`.regex()`,
|
|
548
|
-
* `.email()`, custom refinements) are intentionally dropped — this helper is meant for plain
|
|
549
|
-
* free-text length caps only. A field with `null` `maxLength` is returned unchanged.
|
|
550
|
-
*/
|
|
849
|
+
/** Clamps instead of rejecting on max-length overflow (for AI-generated copy that overshoots); intentionally carries over only maxLength, minLength, and description, dropping any other validators. */
|
|
551
850
|
const clampStringField = (field) => {
|
|
552
851
|
const max = field.maxLength;
|
|
553
852
|
if (max === null) return field;
|
|
@@ -574,10 +873,13 @@ const positiveTestCaseSchema = z.object({
|
|
|
574
873
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
575
874
|
const screenshotEntrySchema = z.object({
|
|
576
875
|
prompt: z.string(),
|
|
577
|
-
url: z.url()
|
|
876
|
+
url: z.url()
|
|
578
877
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
878
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
579
879
|
/** Accepts either a valid email or URL. */
|
|
580
880
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
881
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
882
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
581
883
|
const chatgptCategorySchema = z.enum([
|
|
582
884
|
"BUSINESS",
|
|
583
885
|
"COLLABORATION",
|
|
@@ -890,11 +1192,7 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
890
1192
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
891
1193
|
destructiveJustification: z.string().describe("One sentence on whether the tool changes data. For a read-only tool, state the full triad: \"No data is created, modified, or deleted.\"")
|
|
892
1194
|
}).describe("Per-tool justification of each MCP annotation value (one specific sentence per hint).");
|
|
893
|
-
/**
|
|
894
|
-
* Base copy fields, defined once and reused by both the submission form and per-locale
|
|
895
|
-
* translations so the constraints (tagline ≤ 30 chars) never drift. The translation generation
|
|
896
|
-
* path wraps these in {@link clampStringField} since the LLM tends to overshoot the limit.
|
|
897
|
-
*/
|
|
1195
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
898
1196
|
const chatgptTaglineSchema = z.string().max(30);
|
|
899
1197
|
const chatgptDescriptionSchema = z.string();
|
|
900
1198
|
const chatgptTranslationSchema = z.object({
|
|
@@ -903,10 +1201,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
903
1201
|
description: chatgptDescriptionSchema
|
|
904
1202
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
905
1203
|
chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema) });
|
|
906
|
-
/**
|
|
907
|
-
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
908
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
909
|
-
*/
|
|
1204
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
910
1205
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
911
1206
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
912
1207
|
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."),
|
|
@@ -915,23 +1210,34 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
915
1210
|
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the app does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
916
1211
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
917
1212
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
918
|
-
companyUrl:
|
|
1213
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
919
1214
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
920
|
-
privacyPolicyUrl:
|
|
921
|
-
termsOfServiceUrl:
|
|
922
|
-
demoRecordingUrl:
|
|
1215
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1216
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1217
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
923
1218
|
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My app links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the app does not offer digital goods."),
|
|
924
|
-
serverUrl:
|
|
1219
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
925
1220
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
926
1221
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
927
1222
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
928
1223
|
testCases: z.array(positiveTestCaseSchema).describe("At least 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."),
|
|
929
1224
|
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases: prompts where the app 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 app does not carry, the right brand or domain but an intent the app does not serve, or a boundary with a sibling app."),
|
|
930
|
-
screenshots: z.array(screenshotEntrySchema).max(3).describe("In-app screenshots paired with the user prompt that produced them. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1225
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-app screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
931
1226
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
932
1227
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
933
1228
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
934
1229
|
});
|
|
1230
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1231
|
+
tagline: z.string().optional(),
|
|
1232
|
+
companyUrl: z.string().optional(),
|
|
1233
|
+
supportChannel: z.string().optional(),
|
|
1234
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1235
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1236
|
+
demoRecordingUrl: z.string().optional(),
|
|
1237
|
+
serverUrl: z.string().optional(),
|
|
1238
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1239
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1240
|
+
});
|
|
935
1241
|
chatgptSubmissionFormDataSchema.pick({
|
|
936
1242
|
appName: true,
|
|
937
1243
|
developerName: true,
|
|
@@ -948,7 +1254,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
948
1254
|
toolJustifications: true
|
|
949
1255
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
950
1256
|
const claudeCategorySchema = z.enum([
|
|
951
|
-
"
|
|
1257
|
+
"Productivity",
|
|
952
1258
|
"Communication",
|
|
953
1259
|
"Data & Analytics",
|
|
954
1260
|
"Development tools",
|
|
@@ -956,221 +1262,167 @@ const claudeCategorySchema = z.enum([
|
|
|
956
1262
|
"Consumer Health",
|
|
957
1263
|
"Health & Life Sciences",
|
|
958
1264
|
"Media & Entertainment",
|
|
959
|
-
"Commerce & Shopping"
|
|
1265
|
+
"Commerce & Shopping",
|
|
1266
|
+
"Legal",
|
|
1267
|
+
"Sales and marketing",
|
|
1268
|
+
"Creative",
|
|
1269
|
+
"Nonprofit",
|
|
1270
|
+
"Education",
|
|
1271
|
+
"Other"
|
|
960
1272
|
]);
|
|
961
|
-
const
|
|
962
|
-
"No auth needed",
|
|
963
|
-
"OAuth 2.0",
|
|
964
|
-
"Custom URL"
|
|
965
|
-
]);
|
|
966
|
-
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
967
|
-
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
1273
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
968
1274
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
969
|
-
"
|
|
970
|
-
"
|
|
971
|
-
"
|
|
972
|
-
]);
|
|
973
|
-
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
974
|
-
const claudeTestedSurfaceSchema = z.enum([
|
|
975
|
-
"Claude.ai (web)",
|
|
976
|
-
"Claude Desktop",
|
|
977
|
-
"Claude Code",
|
|
978
|
-
"Cowork"
|
|
1275
|
+
"read_only",
|
|
1276
|
+
"write_only",
|
|
1277
|
+
"read_write"
|
|
979
1278
|
]);
|
|
980
|
-
const
|
|
981
|
-
"
|
|
982
|
-
"
|
|
983
|
-
"
|
|
984
|
-
"
|
|
985
|
-
"
|
|
1279
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1280
|
+
"oauth_dcr",
|
|
1281
|
+
"oauth_cimd",
|
|
1282
|
+
"oauth_anthropic_creds",
|
|
1283
|
+
"custom_connection",
|
|
1284
|
+
"none"
|
|
986
1285
|
]);
|
|
987
|
-
const
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"GDPR compliant (if applicable)"
|
|
1286
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1287
|
+
"first_party",
|
|
1288
|
+
"proxied",
|
|
1289
|
+
"third_party"
|
|
992
1290
|
]);
|
|
993
|
-
const
|
|
994
|
-
|
|
995
|
-
"
|
|
996
|
-
"
|
|
1291
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1292
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1293
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1294
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1295
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1296
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1297
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1298
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1299
|
+
"Public documentation for this connector will be live by the publish date."
|
|
997
1300
|
]);
|
|
998
|
-
/**
|
|
999
|
-
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
1000
|
-
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
1001
|
-
*/
|
|
1301
|
+
/** Field order mirrors the claude.ai directory submission wizard (`claude.ai/admin-settings/directory/submissions/new`), grouped by step; keep it in sync with the wizard. */
|
|
1002
1302
|
const claudeSubmissionFormDataSchema = z.object({
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
(
|
|
1013
|
-
|
|
1014
|
-
(
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
•
|
|
1032
|
-
•
|
|
1033
|
-
•
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
• '
|
|
1049
|
-
• '
|
|
1050
|
-
• '
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
authentication: claudeAuthenticationSchema.describe("How users authenticate with the server. No auth / OAuth 2.0 / Custom URL (not supported)."),
|
|
1078
|
-
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
1079
|
-
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
1080
|
-
• 'SSE (Server-Sent Events)' — the older transport. SSE may be deprecated by Anthropic later in 2025/2026. If you currently only support SSE, you should plan to migrate to Streamable HTTP.
|
|
1081
|
-
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
1082
|
-
serverDocumentationLink: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. This is displayed in the Directory listing and must be publicly accessible without login. Minimum requirements for the docs page:
|
|
1083
|
-
• What the connector does and its key capabilities
|
|
1084
|
-
• How to connect/set it up (step by step)
|
|
1085
|
-
• What each tool does (or at least the main ones)
|
|
1086
|
-
• How to troubleshoot common issues
|
|
1087
|
-
• A support contact or channel
|
|
1088
|
-
Acceptable formats: a dedicated docs page, a help center article, a README on GitHub, or a blog post — as long as it's comprehensive. Note: Anthropic requires public documentation to be live by your publish date.`),
|
|
1089
|
-
privacyPolicyUrl: z.url().describe(`URL to your privacy policy. This is mandatory and displayed in the directory listing. Missing or incomplete privacy policies result in immediate rejection. Your privacy policy must cover:
|
|
1090
|
-
• What data you collect (and how)
|
|
1091
|
-
• How you use the collected data
|
|
1092
|
-
• Where and how long you store it
|
|
1093
|
-
• Whether you share data with third parties (and who)
|
|
1094
|
-
• How users can contact you about data concerns
|
|
1095
|
-
The policy must be publicly accessible. If you don't have one yet, create one before submitting — there are free generators online, but make sure it accurately reflects your actual practices. If you're GDPR-compliant, your policy should reflect that.`),
|
|
1096
|
-
supportChannel: supportChannelSchema.describe(`A URL or email address where users can get help with your connector. This is displayed in the Directory listing. Acceptable options:
|
|
1097
|
-
• Email address (e.g. support@myapp.com)
|
|
1098
|
-
• Link to a GitHub Issues page
|
|
1099
|
-
• Link to a help center or support article
|
|
1100
|
-
• Link to a Discord/Slack community
|
|
1101
|
-
• Link to your documentation's troubleshooting section
|
|
1102
|
-
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1103
|
-
testingCredentials: z.string().describe(`Provide login credentials for a test account that Anthropic reviewers can use to verify your server works end-to-end. Critical requirements:
|
|
1104
|
-
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
1105
|
-
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
1106
|
-
• If your service uses Google OAuth or another OAuth that requires email verification, use mcp-review@anthropic.com as the account email — Anthropic has access to this inbox.
|
|
1107
|
-
• Credentials must remain valid for at least 30 days from submission.
|
|
1108
|
-
• If your service requires API keys instead of a password, provide those.
|
|
1109
|
-
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
1110
|
-
tools: z.array(toolDefinitionSchema).describe(`A comma-separated list of all tools your MCP server exposes. Use the format: tool_name (Human-Readable Name). The tool_name is the internal identifier (snake_case, max 64 characters). The Human-Readable Name is what users see.
|
|
1111
|
-
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
1112
|
-
Reviewers test every single tool you list here — don't list tools that don't work. Also: do not have a single catch-all tool like api_request(method, endpoint) — Anthropic rejects these. Each action should be its own purpose-built tool.`),
|
|
1113
|
-
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
1114
|
-
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
1115
|
-
• 'I've specified accurate tool annotations for all tools' — every tool has the correct annotation: readOnlyHint: true for read operations (search, get, list, fetch), OR destructiveHint: true for write operations (create, update, delete, send).
|
|
1116
|
-
This is the #1 reason submissions get rejected (30% of all rejections). Do not check these boxes without actually having implemented the annotations. See MCP spec for how to add them.`),
|
|
1117
|
-
testedSurfaces: z.array(claudeTestedSurfaceSchema).describe(`Confirm testing is complete and your server works as intended in these surfaces. Select every surface you've verified. Claude.ai (web) and Claude Desktop are the usual targets for remote MCP servers; Claude Code and Cowork compatibility is not required. Anthropic requires at least two surfaces.`),
|
|
1118
|
-
logoLight: z.string().describe(`Your connector's logo for light backgrounds. Requirements:
|
|
1119
|
-
• Format: SVG only
|
|
1120
|
-
• Aspect ratio: square (1:1)
|
|
1121
|
-
• Should work on a light background
|
|
1122
|
-
• Provide via URL (Google Drive link is fine) or upload directly
|
|
1123
|
-
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
1124
|
-
logoDark: z.string().optional().describe(`Optional dark-mode variant of the connector logo. Same specs as the light variant (SVG, square 1:1) but designed to read on a dark background. Leave empty if the light logo already works on dark.`),
|
|
1125
|
-
screenshots: z.array(screenshotEntrySchema).describe(`Screenshots or promotional images of your connector in action within Claude. Strongly recommended for all connectors, and required for MCP Apps (interactive UI). Guidelines:
|
|
1126
|
-
• 3–5 images is ideal
|
|
1127
|
-
• Minimum 1000px width, PNG format preferred
|
|
1128
|
-
• Each screenshot is paired with the user prompt that produced it
|
|
1129
|
-
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
1130
|
-
• Show your connector doing something impressive and useful — real data, real results
|
|
1131
|
-
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
1132
|
-
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
1303
|
+
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
|
|
1304
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1305
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1306
|
+
name: z.string().max(100).describe(`The public display name for your connector as it appears in the directory. Use your brand/product name. You must
|
|
1307
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1308
|
+
slug: z.string().max(50).regex(/^[a-z0-9-]+$/).describe(`URL-safe identifier for your connector's directory page. Lowercase letters, numbers, and hyphens only.
|
|
1309
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1310
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1311
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1312
|
+
description: z.string().max(2e3).describe(`A description of what your connector does and its key features, shown on the connector's detail page in
|
|
1313
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1314
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1315
|
+
iconUrl: z.url().optional().describe(`Optional custom icon for the directory listing — a square SVG. By default the favicon from your MCP URL is used
|
|
1316
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1317
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1318
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1319
|
+
by your publish date.`),
|
|
1320
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1321
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1322
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1323
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1324
|
+
screenshots: z.array(screenshotEntrySchema).optional().describe(`Carousel images shown on your connector's directory page (PNG). Each is paired with the user prompt that produced
|
|
1325
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1326
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1327
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1328
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1329
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1330
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1331
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1332
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1333
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1334
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1335
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1336
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1337
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1338
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1339
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1340
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1341
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1342
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1343
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1344
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1345
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1346
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1347
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1348
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1349
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1350
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1351
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1352
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1353
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1354
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1355
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1356
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1357
|
+
fully populated account.`),
|
|
1358
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1359
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1360
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1361
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1362
|
+
});
|
|
1363
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1364
|
+
serverUrl: z.string().optional(),
|
|
1365
|
+
name: z.string().optional(),
|
|
1366
|
+
slug: z.string().optional(),
|
|
1367
|
+
oneLiner: z.string().optional(),
|
|
1368
|
+
description: z.string().optional(),
|
|
1369
|
+
iconUrl: z.string().optional(),
|
|
1370
|
+
documentation: z.string().optional(),
|
|
1371
|
+
support: z.string().optional(),
|
|
1372
|
+
privacyPolicy: z.string().optional(),
|
|
1373
|
+
companyWebsite: z.string().optional(),
|
|
1374
|
+
primaryContactEmail: z.string().optional(),
|
|
1375
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1376
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1133
1377
|
});
|
|
1134
1378
|
claudeSubmissionFormDataSchema.pick({
|
|
1135
|
-
companyName: true,
|
|
1136
|
-
appName: true,
|
|
1137
|
-
mcpUrlType: true,
|
|
1138
1379
|
serverUrl: true,
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
transportSupport: true,
|
|
1380
|
+
name: true,
|
|
1381
|
+
slug: true,
|
|
1382
|
+
companyName: true,
|
|
1143
1383
|
primaryContactEmail: true,
|
|
1144
1384
|
primaryContactName: true,
|
|
1385
|
+
readWriteCapabilities: true,
|
|
1145
1386
|
authentication: true,
|
|
1146
|
-
|
|
1147
|
-
|
|
1387
|
+
apiOwnership: true,
|
|
1388
|
+
personalHealthData: true
|
|
1148
1389
|
}).extend({
|
|
1149
1390
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1150
|
-
|
|
1391
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1392
|
+
});
|
|
1393
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1394
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1395
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1396
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1397
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1398
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1399
|
+
});
|
|
1400
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1401
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1402
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1151
1403
|
});
|
|
1152
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1153
|
-
tagline: true,
|
|
1154
|
-
description: true,
|
|
1155
|
-
category: true,
|
|
1156
|
-
testCases: true
|
|
1157
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1158
1404
|
const submissionMetaFieldsSchema = z.object({
|
|
1159
1405
|
id: z.string(),
|
|
1160
1406
|
environmentId: z.string(),
|
|
1407
|
+
auditId: z.string().nullable(),
|
|
1161
1408
|
createdAt: z.coerce.date(),
|
|
1162
1409
|
updatedAt: z.coerce.date()
|
|
1163
1410
|
});
|
|
1164
1411
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1165
1412
|
platform: z.literal("claudeai"),
|
|
1166
|
-
formData:
|
|
1413
|
+
formData: claudeSubmissionDraftSchema
|
|
1167
1414
|
});
|
|
1168
1415
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1169
1416
|
platform: z.literal("chatgpt"),
|
|
1170
|
-
formData:
|
|
1417
|
+
formData: chatgptSubmissionDraftSchema
|
|
1171
1418
|
});
|
|
1172
1419
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1173
|
-
z.union([
|
|
1420
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1421
|
+
z.literal([
|
|
1422
|
+
100,
|
|
1423
|
+
75,
|
|
1424
|
+
50
|
|
1425
|
+
]);
|
|
1174
1426
|
const subscriptionPlanSchema = z.enum([
|
|
1175
1427
|
"pro",
|
|
1176
1428
|
"business",
|
|
@@ -1188,11 +1440,56 @@ const customerUsageSchema = z.object({
|
|
|
1188
1440
|
periodEnd: z.number()
|
|
1189
1441
|
});
|
|
1190
1442
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1443
|
+
z.object({ balanceInNanoUSD: z.number() });
|
|
1191
1444
|
z.object({
|
|
1192
1445
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1193
1446
|
customerUsage: customerUsageSchema.nullable(),
|
|
1194
1447
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1195
1448
|
});
|
|
1449
|
+
const telemetrySignalSchema = z.enum([
|
|
1450
|
+
"logs",
|
|
1451
|
+
"metrics",
|
|
1452
|
+
"traces"
|
|
1453
|
+
]);
|
|
1454
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1455
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1456
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1457
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1458
|
+
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");
|
|
1459
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1460
|
+
id: z.string(),
|
|
1461
|
+
name: otlpHeaderNameSchema,
|
|
1462
|
+
value: otlpHeaderValueSchema,
|
|
1463
|
+
isSecret: z.boolean()
|
|
1464
|
+
});
|
|
1465
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1466
|
+
"credentials",
|
|
1467
|
+
"wrong-path",
|
|
1468
|
+
"wrong-protocol",
|
|
1469
|
+
"invalid-payload",
|
|
1470
|
+
"partial-rejection",
|
|
1471
|
+
"blocked-target",
|
|
1472
|
+
"timeout",
|
|
1473
|
+
"unreachable",
|
|
1474
|
+
"receiver-error",
|
|
1475
|
+
"unexpected-status"
|
|
1476
|
+
]);
|
|
1477
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1478
|
+
z.object({
|
|
1479
|
+
id: z.string(),
|
|
1480
|
+
signal: telemetrySignalSchema,
|
|
1481
|
+
endpoint: otlpEndpointSchema,
|
|
1482
|
+
protocol: otlpProtocolSchema,
|
|
1483
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1484
|
+
status: telemetryDestinationStatusSchema,
|
|
1485
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1486
|
+
});
|
|
1487
|
+
//#endregion
|
|
1488
|
+
//#region src/auth-scope.ts
|
|
1489
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1490
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1491
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1492
|
+
const AUTH_SCOPE_USER = "user";
|
|
1196
1493
|
//#endregion
|
|
1197
1494
|
//#region src/schemas.ts
|
|
1198
1495
|
const RESERVED_KEYS = [
|
|
@@ -1229,7 +1526,10 @@ const RESERVED_KEYS = [
|
|
|
1229
1526
|
"BUILD_ARG_START_COMMAND",
|
|
1230
1527
|
"ALPIC_HOST",
|
|
1231
1528
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1232
|
-
"ALPIC_INTENT_META_KEY"
|
|
1529
|
+
"ALPIC_INTENT_META_KEY",
|
|
1530
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1531
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1532
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1233
1533
|
];
|
|
1234
1534
|
const environmentVariableSchema = z.object({
|
|
1235
1535
|
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"),
|
|
@@ -1310,21 +1610,20 @@ const deploymentSchema = z.object({
|
|
|
1310
1610
|
isCurrent: z.boolean(),
|
|
1311
1611
|
deploymentPageUrl: z.url().nullable()
|
|
1312
1612
|
});
|
|
1313
|
-
const
|
|
1613
|
+
const isValidTimeInput = (value) => {
|
|
1314
1614
|
if (ms(value) !== void 0) return true;
|
|
1315
1615
|
return !Number.isNaN(new Date(value).getTime());
|
|
1316
1616
|
};
|
|
1317
|
-
const
|
|
1617
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1618
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1619
|
+
const createEnvironmentContractV1 = base.route({
|
|
1318
1620
|
path: "/v1/environments",
|
|
1319
1621
|
method: "POST",
|
|
1320
1622
|
summary: "Create an environment",
|
|
1321
1623
|
description: "Create an environment for a project",
|
|
1322
1624
|
tags: ["environments"],
|
|
1323
1625
|
successDescription: "The environment has been created successfully"
|
|
1324
|
-
}).errors({
|
|
1325
|
-
NOT_FOUND: {},
|
|
1326
|
-
BAD_REQUEST: {}
|
|
1327
|
-
}).input(z.object({
|
|
1626
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1328
1627
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1329
1628
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1330
1629
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1337,7 +1636,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1337
1636
|
createdAt: z.coerce.date(),
|
|
1338
1637
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1339
1638
|
}));
|
|
1340
|
-
const getEnvironmentContractV1 =
|
|
1639
|
+
const getEnvironmentContractV1 = base.route({
|
|
1341
1640
|
path: "/v1/environments/{environmentId}",
|
|
1342
1641
|
method: "GET",
|
|
1343
1642
|
summary: "Get an environment",
|
|
@@ -1394,7 +1693,7 @@ const projectOutputSchema = z.object({
|
|
|
1394
1693
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1395
1694
|
environments: z.array(environmentSchema)
|
|
1396
1695
|
});
|
|
1397
|
-
const getProjectContractV1 =
|
|
1696
|
+
const getProjectContractV1 = base.route({
|
|
1398
1697
|
path: "/v1/projects/{projectId}",
|
|
1399
1698
|
method: "GET",
|
|
1400
1699
|
summary: "Get a project",
|
|
@@ -1402,18 +1701,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1402
1701
|
tags: ["projects"],
|
|
1403
1702
|
successDescription: "The project details"
|
|
1404
1703
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1405
|
-
const listProjectsContractV1 =
|
|
1704
|
+
const listProjectsContractV1 = base.route({
|
|
1406
1705
|
path: "/v1/projects",
|
|
1407
1706
|
method: "GET",
|
|
1408
1707
|
summary: "List projects",
|
|
1409
1708
|
description: "List all projects for a team",
|
|
1410
1709
|
tags: ["projects"],
|
|
1411
1710
|
successDescription: "The list of projects"
|
|
1412
|
-
}).errors({
|
|
1413
|
-
|
|
1414
|
-
BAD_REQUEST: {}
|
|
1415
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1416
|
-
const createProjectContractV1 = oc.route({
|
|
1711
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1712
|
+
const createProjectContractV1 = base.route({
|
|
1417
1713
|
path: "/v1/projects",
|
|
1418
1714
|
method: "POST",
|
|
1419
1715
|
summary: "Create a project",
|
|
@@ -1422,7 +1718,7 @@ const createProjectContractV1 = oc.route({
|
|
|
1422
1718
|
successDescription: "The project has been created successfully"
|
|
1423
1719
|
}).errors({
|
|
1424
1720
|
NOT_FOUND: {},
|
|
1425
|
-
|
|
1721
|
+
FORBIDDEN: {}
|
|
1426
1722
|
}).input(z.object({
|
|
1427
1723
|
teamId: z.string().optional(),
|
|
1428
1724
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1462,7 +1758,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1462
1758
|
isSecret: z.boolean(),
|
|
1463
1759
|
createdAt: z.coerce.date()
|
|
1464
1760
|
});
|
|
1465
|
-
const listEnvironmentVariablesContractV1 =
|
|
1761
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1466
1762
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1467
1763
|
method: "GET",
|
|
1468
1764
|
summary: "List environment variables",
|
|
@@ -1470,48 +1766,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1470
1766
|
tags: ["environments"],
|
|
1471
1767
|
successDescription: "The list of environment variables"
|
|
1472
1768
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1473
|
-
const createEnvironmentVariablesContractV1 =
|
|
1769
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1474
1770
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1475
1771
|
method: "POST",
|
|
1476
1772
|
summary: "Add environment variables",
|
|
1477
1773
|
description: "Add one or more environment variables to an environment",
|
|
1478
1774
|
tags: ["environments"],
|
|
1479
1775
|
successDescription: "The environment variables have been added successfully"
|
|
1480
|
-
}).errors({
|
|
1481
|
-
NOT_FOUND: {},
|
|
1482
|
-
BAD_REQUEST: {}
|
|
1483
|
-
}).input(z.object({
|
|
1776
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1484
1777
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1485
1778
|
environmentVariables: environmentVariablesSchema
|
|
1486
1779
|
})).output(z.object({ success: z.literal(true) }));
|
|
1487
|
-
const updateEnvironmentVariableContractV1 =
|
|
1780
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1488
1781
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1489
1782
|
method: "PATCH",
|
|
1490
1783
|
summary: "Update an environment variable",
|
|
1491
1784
|
description: "Update an environment variable by ID",
|
|
1492
1785
|
tags: ["environments"],
|
|
1493
1786
|
successDescription: "The environment variable has been updated successfully"
|
|
1494
|
-
}).errors({
|
|
1495
|
-
NOT_FOUND: {},
|
|
1496
|
-
BAD_REQUEST: {}
|
|
1497
|
-
}).input(z.object({
|
|
1787
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1498
1788
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1499
1789
|
key: environmentVariableSchema.shape.key,
|
|
1500
1790
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1501
1791
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1502
1792
|
})).output(z.object({ success: z.literal(true) }));
|
|
1503
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1793
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1504
1794
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1505
1795
|
method: "DELETE",
|
|
1506
1796
|
summary: "Delete an environment variable",
|
|
1507
1797
|
description: "Delete an environment variable by ID",
|
|
1508
1798
|
tags: ["environments"],
|
|
1509
1799
|
successDescription: "The environment variable has been deleted successfully"
|
|
1510
|
-
}).errors({
|
|
1511
|
-
|
|
1512
|
-
BAD_REQUEST: {}
|
|
1513
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1514
|
-
const deleteProjectContractV1 = oc.route({
|
|
1800
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1801
|
+
const deleteProjectContractV1 = base.route({
|
|
1515
1802
|
path: "/v1/projects/{projectId}",
|
|
1516
1803
|
method: "DELETE",
|
|
1517
1804
|
summary: "Delete a project",
|
|
@@ -1519,7 +1806,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1519
1806
|
tags: ["projects"],
|
|
1520
1807
|
successDescription: "The project has been deleted successfully"
|
|
1521
1808
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1522
|
-
const updateProjectContractV1 =
|
|
1809
|
+
const updateProjectContractV1 = base.route({
|
|
1523
1810
|
path: "/v1/projects/{projectId}",
|
|
1524
1811
|
method: "PATCH",
|
|
1525
1812
|
summary: "Update a project",
|
|
@@ -1528,13 +1815,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1528
1815
|
successDescription: "The project has been updated successfully"
|
|
1529
1816
|
}).errors({
|
|
1530
1817
|
NOT_FOUND: {},
|
|
1531
|
-
|
|
1818
|
+
FORBIDDEN: {}
|
|
1532
1819
|
}).input(z.object({
|
|
1533
1820
|
projectId: z.string().describe("The ID of the project"),
|
|
1534
1821
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1535
1822
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1536
1823
|
})).output(projectOutputSchema);
|
|
1537
|
-
const deployEnvironmentContractV1 =
|
|
1824
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1538
1825
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1539
1826
|
method: "POST",
|
|
1540
1827
|
summary: "Deploy an environment",
|
|
@@ -1543,27 +1830,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1543
1830
|
successDescription: "The environment has been deployed successfully"
|
|
1544
1831
|
}).errors({
|
|
1545
1832
|
NOT_FOUND: {},
|
|
1546
|
-
|
|
1833
|
+
CONFLICT: {}
|
|
1547
1834
|
}).input(z.object({
|
|
1548
1835
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1549
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1836
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1837
|
+
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.")
|
|
1550
1838
|
})).output(deploymentSchema);
|
|
1551
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1839
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1552
1840
|
path: "/v1/deployments/upload",
|
|
1553
1841
|
method: "POST",
|
|
1554
1842
|
summary: "Upload deployment artifacts",
|
|
1555
1843
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1556
1844
|
tags: ["deployments"],
|
|
1557
1845
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1558
|
-
}).errors({
|
|
1559
|
-
NOT_FOUND: {},
|
|
1560
|
-
BAD_REQUEST: {}
|
|
1561
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1846
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1562
1847
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1563
1848
|
token: z.string().describe("Token to identify the source archive"),
|
|
1564
1849
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1565
1850
|
}));
|
|
1566
|
-
const listDeploymentsContractV1 =
|
|
1851
|
+
const listDeploymentsContractV1 = base.route({
|
|
1567
1852
|
path: "/v1/projects/{projectId}/deployments",
|
|
1568
1853
|
method: "GET",
|
|
1569
1854
|
summary: "List project deployments",
|
|
@@ -1575,7 +1860,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1575
1860
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1576
1861
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1577
1862
|
})).output(z.array(deploymentSchema));
|
|
1578
|
-
const getDeploymentContractV1 =
|
|
1863
|
+
const getDeploymentContractV1 = base.route({
|
|
1579
1864
|
path: "/v1/deployments/{deploymentId}",
|
|
1580
1865
|
method: "GET",
|
|
1581
1866
|
summary: "Get a deployment",
|
|
@@ -1583,20 +1868,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1583
1868
|
tags: ["deployments"],
|
|
1584
1869
|
successDescription: "The deployment details"
|
|
1585
1870
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1586
|
-
const
|
|
1871
|
+
const logEntrySchema = z.object({
|
|
1872
|
+
timestamp: z.coerce.date(),
|
|
1873
|
+
type: z.enum([
|
|
1874
|
+
"START",
|
|
1875
|
+
"END",
|
|
1876
|
+
"INFO",
|
|
1877
|
+
"ERROR",
|
|
1878
|
+
"WARNING",
|
|
1879
|
+
"DEBUG"
|
|
1880
|
+
]),
|
|
1881
|
+
requestId: z.string(),
|
|
1882
|
+
content: z.string().optional(),
|
|
1883
|
+
method: z.string().optional(),
|
|
1884
|
+
durationInMs: z.number().optional()
|
|
1885
|
+
});
|
|
1886
|
+
const getLogsContractV1 = base.route({
|
|
1587
1887
|
path: "/v1/environments/{environmentId}/logs",
|
|
1588
1888
|
method: "GET",
|
|
1589
1889
|
summary: "Get logs",
|
|
1590
1890
|
description: "Get logs for an environment",
|
|
1591
1891
|
tags: ["environments"],
|
|
1592
1892
|
successDescription: "The logs"
|
|
1593
|
-
}).errors({
|
|
1594
|
-
NOT_FOUND: {},
|
|
1595
|
-
BAD_REQUEST: {}
|
|
1596
|
-
}).input(z.object({
|
|
1893
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1597
1894
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1598
|
-
since:
|
|
1599
|
-
until:
|
|
1895
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1896
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1600
1897
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1601
1898
|
level: z.array(z.enum([
|
|
1602
1899
|
"INFO",
|
|
@@ -1607,34 +1904,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1607
1904
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1608
1905
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1609
1906
|
})).output(z.object({
|
|
1610
|
-
logs: z.array(
|
|
1611
|
-
timestamp: z.coerce.date(),
|
|
1612
|
-
type: z.enum([
|
|
1613
|
-
"START",
|
|
1614
|
-
"END",
|
|
1615
|
-
"INFO",
|
|
1616
|
-
"ERROR",
|
|
1617
|
-
"WARNING",
|
|
1618
|
-
"DEBUG"
|
|
1619
|
-
]),
|
|
1620
|
-
requestId: z.string(),
|
|
1621
|
-
content: z.string().optional(),
|
|
1622
|
-
method: z.string().optional(),
|
|
1623
|
-
durationInMs: z.number().optional()
|
|
1624
|
-
})),
|
|
1907
|
+
logs: z.array(logEntrySchema),
|
|
1625
1908
|
nextToken: z.string().nullable()
|
|
1626
1909
|
}));
|
|
1627
|
-
const getLatestLogsContractV1 =
|
|
1910
|
+
const getLatestLogsContractV1 = base.route({
|
|
1628
1911
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1629
1912
|
method: "GET",
|
|
1630
1913
|
summary: "Get latest logs",
|
|
1631
1914
|
description: "Get the N most recent logs for an environment",
|
|
1632
1915
|
tags: ["environments"],
|
|
1633
1916
|
successDescription: "The latest logs"
|
|
1634
|
-
}).errors({
|
|
1635
|
-
NOT_FOUND: {},
|
|
1636
|
-
BAD_REQUEST: {}
|
|
1637
|
-
}).input(z.object({
|
|
1917
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1638
1918
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1639
1919
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1640
1920
|
level: z.array(z.enum([
|
|
@@ -1644,22 +1924,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1644
1924
|
"DEBUG"
|
|
1645
1925
|
])).optional().describe("Filter by log level"),
|
|
1646
1926
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1647
|
-
})).output(z.object({ logs: z.array(
|
|
1648
|
-
|
|
1649
|
-
type: z.enum([
|
|
1650
|
-
"START",
|
|
1651
|
-
"END",
|
|
1652
|
-
"INFO",
|
|
1653
|
-
"ERROR",
|
|
1654
|
-
"WARNING",
|
|
1655
|
-
"DEBUG"
|
|
1656
|
-
]),
|
|
1657
|
-
requestId: z.string(),
|
|
1658
|
-
content: z.string().optional(),
|
|
1659
|
-
method: z.string().optional(),
|
|
1660
|
-
durationInMs: z.number().optional()
|
|
1661
|
-
})) }));
|
|
1662
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1927
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1928
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1663
1929
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1664
1930
|
method: "GET",
|
|
1665
1931
|
summary: "Get deployment logs",
|
|
@@ -1686,22 +1952,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1686
1952
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1687
1953
|
task_count: z.array(analyticsDataPointSchema)
|
|
1688
1954
|
});
|
|
1689
|
-
const getProjectAnalyticsContractV1 =
|
|
1955
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1690
1956
|
path: "/v1/analytics/{projectId}",
|
|
1691
1957
|
method: "GET",
|
|
1692
1958
|
summary: "Get project analytics",
|
|
1693
1959
|
description: "Get analytics data for a project over a time range",
|
|
1694
1960
|
tags: ["analytics"],
|
|
1695
1961
|
successDescription: "The project analytics data"
|
|
1696
|
-
}).errors({
|
|
1697
|
-
NOT_FOUND: {},
|
|
1698
|
-
BAD_REQUEST: {}
|
|
1699
|
-
}).input(z.object({
|
|
1962
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1700
1963
|
projectId: z.string().describe("The ID of the project"),
|
|
1701
1964
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1702
1965
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1703
1966
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1704
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
1967
|
+
}).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 }) => Intl.supportedValuesOf("timeZone").includes(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1705
1968
|
metadata: z.object({
|
|
1706
1969
|
startTimestamp: z.number(),
|
|
1707
1970
|
endTimestamp: z.number(),
|
|
@@ -1711,7 +1974,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1711
1974
|
}),
|
|
1712
1975
|
timeSeries: analyticsTimeSeriesSchema
|
|
1713
1976
|
}));
|
|
1714
|
-
const
|
|
1977
|
+
const paginatedInsightsInputShape = {
|
|
1978
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1979
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1980
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1981
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1982
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1983
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1984
|
+
};
|
|
1985
|
+
const listIntentsContractV1 = base.route({
|
|
1986
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1987
|
+
method: "GET",
|
|
1988
|
+
summary: "List intents",
|
|
1989
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1990
|
+
tags: ["insights"],
|
|
1991
|
+
successDescription: "The grouped user intents"
|
|
1992
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1993
|
+
...paginatedInsightsInputShape,
|
|
1994
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1995
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
1996
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1997
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
1998
|
+
})).output(z.object({
|
|
1999
|
+
intents: z.array(z.object({
|
|
2000
|
+
id: z.string(),
|
|
2001
|
+
intentIds: z.array(z.string()).min(1),
|
|
2002
|
+
environmentId: z.string(),
|
|
2003
|
+
message: z.string(),
|
|
2004
|
+
toolName: z.string(),
|
|
2005
|
+
createdAt: z.coerce.date(),
|
|
2006
|
+
occurrenceCount: z.number().int().positive(),
|
|
2007
|
+
clientName: z.string().nullable(),
|
|
2008
|
+
clientId: z.string().nullable(),
|
|
2009
|
+
categories: z.array(z.object({
|
|
2010
|
+
id: z.string(),
|
|
2011
|
+
name: z.string(),
|
|
2012
|
+
color: intentCategoryColorSchema
|
|
2013
|
+
}))
|
|
2014
|
+
})),
|
|
2015
|
+
totalCount: z.number().int().nonnegative()
|
|
2016
|
+
}));
|
|
2017
|
+
const listFeedbacksContractV1 = base.route({
|
|
2018
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2019
|
+
method: "GET",
|
|
2020
|
+
summary: "List feedbacks",
|
|
2021
|
+
description: "List user feedback for an environment over a time range",
|
|
2022
|
+
tags: ["insights"],
|
|
2023
|
+
successDescription: "The user feedback"
|
|
2024
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2025
|
+
...paginatedInsightsInputShape,
|
|
2026
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2027
|
+
})).output(z.object({
|
|
2028
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2029
|
+
totalCount: z.number().int().nonnegative()
|
|
2030
|
+
}));
|
|
2031
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2032
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2033
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2034
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2035
|
+
method: "GET",
|
|
2036
|
+
summary: "List intent categories",
|
|
2037
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2038
|
+
tags: ["insights"],
|
|
2039
|
+
successDescription: "The intent categories"
|
|
2040
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2041
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2042
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2043
|
+
method: "POST",
|
|
2044
|
+
summary: "Create an intent category",
|
|
2045
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2046
|
+
tags: ["insights"],
|
|
2047
|
+
successDescription: "The created intent category"
|
|
2048
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2049
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2050
|
+
name: intentCategoryNameSchema,
|
|
2051
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2052
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2053
|
+
})).output(intentCategorySchema);
|
|
2054
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2055
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2056
|
+
method: "PATCH",
|
|
2057
|
+
summary: "Update an intent category",
|
|
2058
|
+
description: "Rename or recolor an intent category",
|
|
2059
|
+
tags: ["insights"],
|
|
2060
|
+
successDescription: "The updated intent category"
|
|
2061
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2062
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2063
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2064
|
+
name: intentCategoryNameSchema.optional(),
|
|
2065
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2066
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2067
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2068
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2069
|
+
method: "DELETE",
|
|
2070
|
+
summary: "Delete an intent category",
|
|
2071
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2072
|
+
tags: ["insights"],
|
|
2073
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2074
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2075
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2076
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2077
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2078
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2079
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2080
|
+
method: "POST",
|
|
2081
|
+
summary: "Link an intent category",
|
|
2082
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2083
|
+
tags: ["insights"],
|
|
2084
|
+
successDescription: "The intents have been linked successfully"
|
|
2085
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2086
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2087
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2088
|
+
intentIds: categorizableIntentIdsSchema
|
|
2089
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2090
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2091
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2092
|
+
method: "POST",
|
|
2093
|
+
summary: "Unlink an intent category",
|
|
2094
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2095
|
+
tags: ["insights"],
|
|
2096
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2097
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2098
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2099
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2100
|
+
intentIds: categorizableIntentIdsSchema
|
|
2101
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2102
|
+
const listTeamsContractV1 = base.route({
|
|
1715
2103
|
path: "/v1/teams",
|
|
1716
2104
|
method: "GET",
|
|
1717
2105
|
summary: "List teams",
|
|
@@ -1724,28 +2112,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
1724
2112
|
createdAt: z.coerce.date(),
|
|
1725
2113
|
hasStripeAccount: z.boolean()
|
|
1726
2114
|
})));
|
|
1727
|
-
const
|
|
2115
|
+
const getTeamUsageContractV1 = base.route({
|
|
2116
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2117
|
+
method: "GET",
|
|
2118
|
+
summary: "Get team usage",
|
|
2119
|
+
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.",
|
|
2120
|
+
tags: ["teams"],
|
|
2121
|
+
successDescription: "The current billing window usage"
|
|
2122
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2123
|
+
teamId: z.string(),
|
|
2124
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2125
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2126
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2127
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2128
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2129
|
+
}));
|
|
2130
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1728
2131
|
path: "/v1/tunnels/ticket",
|
|
1729
2132
|
method: "GET",
|
|
1730
2133
|
summary: "Get a tunnel ticket",
|
|
1731
2134
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1732
2135
|
tags: ["tunnels"],
|
|
1733
2136
|
successDescription: "The tunnel ticket"
|
|
1734
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
2137
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1735
2138
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1736
2139
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1737
2140
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1738
2141
|
}));
|
|
1739
|
-
const publishServerContractV1 =
|
|
2142
|
+
const publishServerContractV1 = base.route({
|
|
1740
2143
|
path: "/v1/distribution/publish",
|
|
1741
2144
|
method: "POST",
|
|
1742
2145
|
summary: "Publish a server to the MCP registry",
|
|
1743
2146
|
tags: ["distribution"],
|
|
1744
2147
|
successDescription: "The server has been published successfully"
|
|
1745
|
-
}).errors({
|
|
1746
|
-
NOT_FOUND: {},
|
|
1747
|
-
BAD_REQUEST: {}
|
|
1748
|
-
}).input(z.object({
|
|
2148
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1749
2149
|
projectId: z.string(),
|
|
1750
2150
|
domain: z.string(),
|
|
1751
2151
|
title: z.string().min(1).max(100),
|
|
@@ -1754,17 +2154,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1754
2154
|
iconSrc: z.url().max(255).optional(),
|
|
1755
2155
|
dryRun: z.boolean().optional()
|
|
1756
2156
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1757
|
-
const getServerInfoContractV1 =
|
|
2157
|
+
const getServerInfoContractV1 = base.route({
|
|
1758
2158
|
path: "/v1/distribution/get",
|
|
1759
2159
|
method: "GET",
|
|
1760
2160
|
summary: "Get server info",
|
|
1761
2161
|
description: "Get info about a server",
|
|
1762
2162
|
tags: ["distribution"],
|
|
1763
2163
|
successDescription: "The server info"
|
|
1764
|
-
}).errors({
|
|
1765
|
-
NOT_FOUND: {},
|
|
1766
|
-
BAD_REQUEST: {}
|
|
1767
|
-
}).input(z.object({
|
|
2164
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1768
2165
|
projectId: z.string(),
|
|
1769
2166
|
domain: z.string()
|
|
1770
2167
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1783,7 +2180,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1783
2180
|
isPlaygroundEnabled: z.boolean(),
|
|
1784
2181
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1785
2182
|
});
|
|
1786
|
-
const getPlaygroundContractV1 =
|
|
2183
|
+
const getPlaygroundContractV1 = base.route({
|
|
1787
2184
|
path: "/v1/environments/{environmentId}/playground",
|
|
1788
2185
|
method: "GET",
|
|
1789
2186
|
summary: "Get playground configuration",
|
|
@@ -1791,17 +2188,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1791
2188
|
tags: ["environments"],
|
|
1792
2189
|
successDescription: "The playground configuration"
|
|
1793
2190
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1794
|
-
const upsertPlaygroundContractV1 =
|
|
2191
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1795
2192
|
path: "/v1/environments/{environmentId}/playground",
|
|
1796
2193
|
method: "PUT",
|
|
1797
2194
|
summary: "Update playground configuration",
|
|
1798
2195
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1799
2196
|
tags: ["environments"],
|
|
1800
2197
|
successDescription: "The updated playground configuration"
|
|
1801
|
-
}).errors({
|
|
1802
|
-
NOT_FOUND: {},
|
|
1803
|
-
BAD_REQUEST: {}
|
|
1804
|
-
}).input(z.object({
|
|
2198
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1805
2199
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1806
2200
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1807
2201
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1809,7 +2203,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1809
2203
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1810
2204
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1811
2205
|
})).output(playgroundOutputSchema);
|
|
1812
|
-
const createBeaconContractV1 =
|
|
2206
|
+
const createBeaconContractV1 = base.route({
|
|
1813
2207
|
path: "/v1/beacon/audits",
|
|
1814
2208
|
method: "POST",
|
|
1815
2209
|
summary: "Create a beacon audit",
|
|
@@ -1818,7 +2212,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1818
2212
|
successDescription: "The audit has been created"
|
|
1819
2213
|
}).errors({
|
|
1820
2214
|
NOT_FOUND: {},
|
|
1821
|
-
BAD_REQUEST: {},
|
|
1822
2215
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1823
2216
|
}).input(z.object({
|
|
1824
2217
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1826,7 +2219,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1826
2219
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1827
2220
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1828
2221
|
})).output(z.object({ id: z.string() }));
|
|
1829
|
-
const getBeaconContractV1 =
|
|
2222
|
+
const getBeaconContractV1 = base.route({
|
|
1830
2223
|
path: "/v1/beacon/audits/{auditId}",
|
|
1831
2224
|
method: "GET",
|
|
1832
2225
|
summary: "Get a beacon audit",
|
|
@@ -1842,8 +2235,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1842
2235
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1843
2236
|
}));
|
|
1844
2237
|
const contract = {
|
|
1845
|
-
teams: {
|
|
2238
|
+
teams: {
|
|
2239
|
+
list: { v1: listTeamsContractV1 },
|
|
2240
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2241
|
+
},
|
|
1846
2242
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2243
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2244
|
+
intentCategories: {
|
|
2245
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2246
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2247
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2248
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2249
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2250
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2251
|
+
},
|
|
2252
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1847
2253
|
deployments: {
|
|
1848
2254
|
list: { v1: listDeploymentsContractV1 },
|
|
1849
2255
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1884,5 +2290,10 @@ const contract = {
|
|
|
1884
2290
|
get: { v1: getBeaconContractV1 }
|
|
1885
2291
|
}
|
|
1886
2292
|
};
|
|
2293
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2294
|
+
const contractForDocs = {
|
|
2295
|
+
...contract,
|
|
2296
|
+
deployments: deploymentsForDocs
|
|
2297
|
+
};
|
|
1887
2298
|
//#endregion
|
|
1888
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2299
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|