@alpic-ai/api 0.0.0-dev.ge0a2ff4 → 0.0.0-dev.ge0b4971
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 +794 -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,22 @@ 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
|
+
"cato",
|
|
183
|
+
"cloudflare",
|
|
184
|
+
"fastly"
|
|
185
|
+
];
|
|
186
|
+
const ALLOWED_PLATFORMS = [...AI_PLATFORMS, ...WAF_PLATFORMS];
|
|
187
|
+
const allowedPlatformSchema = z.enum(ALLOWED_PLATFORMS);
|
|
177
188
|
const auditStatusSchema = z.enum([
|
|
178
189
|
"pending",
|
|
179
190
|
"partial",
|
|
@@ -246,6 +257,25 @@ z.object({
|
|
|
246
257
|
clientSecret: z.string(),
|
|
247
258
|
clientScopes: z.array(z.string())
|
|
248
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
249
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
250
280
|
"ongoing",
|
|
251
281
|
"deployed",
|
|
@@ -273,34 +303,51 @@ const deploymentSummarySchema = z.object({
|
|
|
273
303
|
createdAt: z.coerce.date(),
|
|
274
304
|
updatedAt: z.coerce.date()
|
|
275
305
|
});
|
|
276
|
-
/**
|
|
277
|
-
* Public environment
|
|
278
|
-
*
|
|
279
|
-
* No OAuth metadata exposed.
|
|
280
|
-
*/
|
|
306
|
+
/** Public environment: answers anonymously and exposes no OAuth metadata. */
|
|
281
307
|
const publicEnvironmentSchema = z.object({
|
|
308
|
+
allowsAnonymous: z.literal(true),
|
|
309
|
+
oAuthMetadata: z.strictObject({})
|
|
310
|
+
});
|
|
311
|
+
/** 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. */
|
|
312
|
+
const externalResourceMetadataEnvironmentSchema = z.object({
|
|
313
|
+
allowsAnonymous: z.boolean(),
|
|
314
|
+
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
315
|
+
scope: z.string().optional()
|
|
316
|
+
});
|
|
317
|
+
/** 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. */
|
|
318
|
+
const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
319
|
+
allowsAnonymous: z.boolean(),
|
|
320
|
+
oAuthMetadata: z.object({
|
|
321
|
+
externalAuthorizationServerUrl: z.url(),
|
|
322
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
323
|
+
}),
|
|
324
|
+
scope: z.string().optional()
|
|
325
|
+
});
|
|
326
|
+
/** Standalone protected environment: the server itself exposes both the /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server endpoints. */
|
|
327
|
+
const standaloneEnvironmentSchema = z.object({
|
|
328
|
+
allowsAnonymous: z.boolean(),
|
|
329
|
+
oAuthMetadata: z.object({
|
|
330
|
+
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
331
|
+
resourceMetadata: OAuthProtectedResourceMetadataSchema.optional()
|
|
332
|
+
}),
|
|
333
|
+
scope: z.string().optional()
|
|
334
|
+
});
|
|
335
|
+
/** Protected environment that enforces authentication but advertises no OAuth discovery metadata; clients must obtain credentials out-of-band. */
|
|
336
|
+
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
337
|
+
allowsAnonymous: z.literal(false),
|
|
338
|
+
oAuthMetadata: z.strictObject({}),
|
|
339
|
+
scope: z.string().optional()
|
|
340
|
+
});
|
|
341
|
+
const legacyPublicEnvironmentSchema = z.object({
|
|
282
342
|
isPublic: z.literal(true),
|
|
283
343
|
oAuthMetadata: z.undefined().optional()
|
|
284
344
|
});
|
|
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({
|
|
345
|
+
const legacyExternalResourceMetadataEnvironmentSchema = z.object({
|
|
292
346
|
isPublic: z.literal(false),
|
|
293
347
|
oAuthMetadata: z.object({ externalResourceMetadataUrl: z.url() }),
|
|
294
348
|
scope: z.string().optional()
|
|
295
349
|
});
|
|
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({
|
|
350
|
+
const legacyExternalAuthorizationServerEnvironmentSchema = z.object({
|
|
304
351
|
isPublic: z.literal(false),
|
|
305
352
|
oAuthMetadata: z.object({
|
|
306
353
|
externalAuthorizationServerUrl: z.url(),
|
|
@@ -308,13 +355,7 @@ const externalAuthorizationServerEnvironmentSchema = z.object({
|
|
|
308
355
|
}),
|
|
309
356
|
scope: z.string().optional()
|
|
310
357
|
});
|
|
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({
|
|
358
|
+
const legacyStandaloneEnvironmentSchema = z.object({
|
|
318
359
|
isPublic: z.literal(false),
|
|
319
360
|
oAuthMetadata: z.object({
|
|
320
361
|
authorizationServerMetadata: z.union([OAuthMetadataSchema, OpenIdProviderDiscoveryMetadataSchema]),
|
|
@@ -322,14 +363,7 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
322
363
|
}),
|
|
323
364
|
scope: z.string().optional()
|
|
324
365
|
});
|
|
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({
|
|
366
|
+
const legacyProtectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
333
367
|
isPublic: z.literal(false),
|
|
334
368
|
oAuthMetadata: z.strictObject({}),
|
|
335
369
|
scope: z.string().optional()
|
|
@@ -339,11 +373,21 @@ z.union([
|
|
|
339
373
|
externalResourceMetadataEnvironmentSchema,
|
|
340
374
|
externalAuthorizationServerEnvironmentSchema,
|
|
341
375
|
standaloneEnvironmentSchema,
|
|
342
|
-
protectedWithoutDiscoveryEnvironmentSchema
|
|
376
|
+
protectedWithoutDiscoveryEnvironmentSchema,
|
|
377
|
+
legacyPublicEnvironmentSchema,
|
|
378
|
+
legacyExternalResourceMetadataEnvironmentSchema,
|
|
379
|
+
legacyExternalAuthorizationServerEnvironmentSchema,
|
|
380
|
+
legacyStandaloneEnvironmentSchema,
|
|
381
|
+
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
382
|
+
]);
|
|
383
|
+
const playgroundModelSchema = z.enum([
|
|
384
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
385
|
+
"global.anthropic.claude-sonnet-4-5-20250929-v1:0",
|
|
386
|
+
"openai.gpt-5.4",
|
|
387
|
+
"openai.gpt-5.5"
|
|
343
388
|
]);
|
|
344
|
-
const allowedPlatformSchema = platformSchema;
|
|
345
389
|
const environmentDomainSchema = z.object({
|
|
346
|
-
|
|
390
|
+
name: z.string(),
|
|
347
391
|
status: z.enum([
|
|
348
392
|
"ongoing",
|
|
349
393
|
"deployed",
|
|
@@ -361,6 +405,7 @@ const environmentSchema$1 = z.object({
|
|
|
361
405
|
latestDeployment: deploymentSummarySchema.optional(),
|
|
362
406
|
openaiAppsChallenge: z.string().nullable().optional(),
|
|
363
407
|
isPlaygroundEnabled: z.boolean(),
|
|
408
|
+
playgroundModel: playgroundModelSchema,
|
|
364
409
|
isIpWhitelistEnabled: z.boolean(),
|
|
365
410
|
ipAllowlist: z.array(z.string()).nullable(),
|
|
366
411
|
allowedPlatforms: z.array(allowedPlatformSchema),
|
|
@@ -370,11 +415,20 @@ const environmentSchema$1 = z.object({
|
|
|
370
415
|
});
|
|
371
416
|
const environmentWithDomainsSchema = environmentSchema$1.extend({ domains: z.array(environmentDomainSchema) });
|
|
372
417
|
z.object({
|
|
418
|
+
sessionReplayEnabled: z.boolean(),
|
|
419
|
+
collectRequestPayload: z.boolean(),
|
|
420
|
+
collectResponsePayload: z.boolean(),
|
|
421
|
+
collectErrorMessage: z.boolean(),
|
|
422
|
+
collectUserData: z.boolean(),
|
|
423
|
+
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
424
|
+
});
|
|
425
|
+
const feedbackSchema = z.object({
|
|
373
426
|
id: z.string(),
|
|
374
427
|
createdAt: z.coerce.date(),
|
|
375
428
|
environmentId: z.string(),
|
|
376
429
|
content: z.string(),
|
|
377
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
378
432
|
});
|
|
379
433
|
z.object({
|
|
380
434
|
content: z.string(),
|
|
@@ -390,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
390
444
|
"pink",
|
|
391
445
|
"gray"
|
|
392
446
|
]);
|
|
393
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
394
448
|
const intentCategorySchema = z.object({
|
|
395
449
|
id: z.string(),
|
|
396
450
|
createdAt: z.coerce.date(),
|
|
@@ -398,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
398
452
|
name: z.string(),
|
|
399
453
|
color: intentCategoryColorSchema
|
|
400
454
|
});
|
|
401
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
402
456
|
id: z.string(),
|
|
403
457
|
name: z.string(),
|
|
404
458
|
color: intentCategoryColorSchema,
|
|
@@ -410,6 +464,7 @@ z.object({
|
|
|
410
464
|
environmentId: z.string(),
|
|
411
465
|
toolName: z.string(),
|
|
412
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
413
468
|
categories: z.array(intentCategorySchema)
|
|
414
469
|
});
|
|
415
470
|
const signalCategorySchema = z.object({
|
|
@@ -468,12 +523,262 @@ z.object({
|
|
|
468
523
|
createdAt: z.coerce.date(),
|
|
469
524
|
updatedAt: z.coerce.date()
|
|
470
525
|
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
471
536
|
z.enum([
|
|
472
537
|
"INFO",
|
|
473
538
|
"WARNING",
|
|
474
539
|
"DEBUG",
|
|
475
540
|
"ERROR"
|
|
476
541
|
]);
|
|
542
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
|
+
const MCP_CLIENT_GROUPS = [
|
|
544
|
+
{
|
|
545
|
+
id: "claude_code",
|
|
546
|
+
label: "Claude Code",
|
|
547
|
+
vendor: "anthropic",
|
|
548
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
id: "claude",
|
|
552
|
+
label: "Claude",
|
|
553
|
+
vendor: "anthropic",
|
|
554
|
+
rawNames: [
|
|
555
|
+
"Anthropic/ClaudeAI",
|
|
556
|
+
"claude-ai",
|
|
557
|
+
"claude",
|
|
558
|
+
"Claude",
|
|
559
|
+
"claude-desktop",
|
|
560
|
+
"claude-desktop-3p"
|
|
561
|
+
]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "claude_mobile",
|
|
565
|
+
label: "Claude mobile",
|
|
566
|
+
vendor: "anthropic",
|
|
567
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
id: "claude_cowork",
|
|
571
|
+
label: "Claude Cowork",
|
|
572
|
+
vendor: "anthropic",
|
|
573
|
+
rawNames: ["Anthropic/Cowork"]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "claude_toolbox",
|
|
577
|
+
label: "Claude Toolbox",
|
|
578
|
+
vendor: "anthropic",
|
|
579
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "anthropic_api",
|
|
583
|
+
label: "Anthropic API",
|
|
584
|
+
vendor: "anthropic",
|
|
585
|
+
rawNames: ["Anthropic/API"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "anthropic_connector_refresh",
|
|
589
|
+
label: "Anthropic (connector refresh)",
|
|
590
|
+
vendor: "anthropic",
|
|
591
|
+
rawNames: ["Anthropic"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "codex",
|
|
595
|
+
label: "Codex",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: [
|
|
598
|
+
"codex-mcp-client",
|
|
599
|
+
"codex",
|
|
600
|
+
"Codex",
|
|
601
|
+
"codex-cli",
|
|
602
|
+
"openai-mcp (Codex)"
|
|
603
|
+
]
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
id: "chatgpt",
|
|
607
|
+
label: "ChatGPT",
|
|
608
|
+
vendor: "openai",
|
|
609
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
id: "openai_responses_api",
|
|
613
|
+
label: "OpenAI Responses API",
|
|
614
|
+
vendor: "openai",
|
|
615
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
id: "openai_agent_builder",
|
|
619
|
+
label: "OpenAI Agent Builder",
|
|
620
|
+
vendor: "openai",
|
|
621
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
id: "openai_other",
|
|
625
|
+
label: "OpenAI Other",
|
|
626
|
+
vendor: "openai",
|
|
627
|
+
rawNames: ["openai-mcp"]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cursor",
|
|
631
|
+
label: "Cursor",
|
|
632
|
+
vendor: "cursor",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"cursor-vscode",
|
|
635
|
+
"Cursor",
|
|
636
|
+
"cursor"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "cline",
|
|
641
|
+
label: "Cline",
|
|
642
|
+
vendor: "cline",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Cline",
|
|
645
|
+
"cline",
|
|
646
|
+
"@cline/core"
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
id: "github_copilot",
|
|
651
|
+
label: "GitHub Copilot",
|
|
652
|
+
vendor: "githubCopilot",
|
|
653
|
+
rawNames: [
|
|
654
|
+
"Copilot",
|
|
655
|
+
"github-copilot-developer",
|
|
656
|
+
"Copilot MCP Gateway",
|
|
657
|
+
"Xcode/copilot-xcode"
|
|
658
|
+
]
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
id: "gemini_cli",
|
|
662
|
+
label: "Gemini CLI",
|
|
663
|
+
vendor: "google",
|
|
664
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "antigravity",
|
|
668
|
+
label: "Antigravity",
|
|
669
|
+
vendor: "google",
|
|
670
|
+
rawNames: ["antigravity-client"]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "gemini",
|
|
674
|
+
label: "Gemini",
|
|
675
|
+
vendor: "google",
|
|
676
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
id: "windsurf",
|
|
680
|
+
label: "Windsurf",
|
|
681
|
+
vendor: "windsurf",
|
|
682
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
id: "mistral",
|
|
686
|
+
label: "Mistral / Le Chat",
|
|
687
|
+
vendor: "mistral",
|
|
688
|
+
rawNames: ["Mistral"],
|
|
689
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "n8n",
|
|
693
|
+
label: "n8n",
|
|
694
|
+
vendor: "n8n",
|
|
695
|
+
rawNames: [
|
|
696
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
698
|
+
"n8n"
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "alpic_playground",
|
|
703
|
+
label: "Alpic Playground",
|
|
704
|
+
vendor: "alpic",
|
|
705
|
+
rawNames: ["alpic-playground", "playground"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "opencode",
|
|
709
|
+
label: "opencode",
|
|
710
|
+
vendor: "opencode",
|
|
711
|
+
rawNames: ["opencode"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "zed",
|
|
715
|
+
label: "Zed",
|
|
716
|
+
vendor: "zed",
|
|
717
|
+
rawNames: ["Zed", "zed"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "zapier",
|
|
721
|
+
label: "Zapier",
|
|
722
|
+
vendor: "zapier",
|
|
723
|
+
rawNames: ["Zapier", "zapier"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "make",
|
|
727
|
+
label: "Make",
|
|
728
|
+
vendor: "make",
|
|
729
|
+
rawNames: ["Make", "make"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "librechat",
|
|
733
|
+
label: "LibreChat",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["LibreChat", "librechat"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "jan",
|
|
739
|
+
label: "Jan",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: ["Jan", "jan"]
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
id: "goose",
|
|
745
|
+
label: "goose",
|
|
746
|
+
vendor: "mcp",
|
|
747
|
+
rawNames: ["goose", "Goose"]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
id: "mcphost",
|
|
751
|
+
label: "mcphost",
|
|
752
|
+
vendor: "mcp",
|
|
753
|
+
rawNames: ["mcphost"]
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
id: "mcporter",
|
|
757
|
+
label: "mcporter",
|
|
758
|
+
vendor: "mcp",
|
|
759
|
+
rawNames: ["mcporter"]
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
id: "rmcp",
|
|
763
|
+
label: "rmcp",
|
|
764
|
+
vendor: "mcp",
|
|
765
|
+
rawNames: ["rmcp"]
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
id: "unnamed_client",
|
|
769
|
+
label: "Unnamed client",
|
|
770
|
+
vendor: "mcp",
|
|
771
|
+
rawNames: [
|
|
772
|
+
"mcp",
|
|
773
|
+
"unknown",
|
|
774
|
+
""
|
|
775
|
+
]
|
|
776
|
+
}
|
|
777
|
+
];
|
|
778
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
779
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
780
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
781
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
477
782
|
const runtimeSchema = z.enum([
|
|
478
783
|
"python3.13",
|
|
479
784
|
"python3.14",
|
|
@@ -502,15 +807,27 @@ z.object({
|
|
|
502
807
|
environments: z.array(environmentWithDomainsSchema),
|
|
503
808
|
productionEnvironment: environmentWithDomainsSchema.nullable()
|
|
504
809
|
});
|
|
810
|
+
const domainFailureReasonSchema = z.enum([
|
|
811
|
+
"caa",
|
|
812
|
+
"dns",
|
|
813
|
+
"invalid_domain",
|
|
814
|
+
"other"
|
|
815
|
+
]);
|
|
816
|
+
const projectDomainMappingSchema = z.object({
|
|
817
|
+
pathPrefix: z.string(),
|
|
818
|
+
environment: environmentSchema$1
|
|
819
|
+
});
|
|
505
820
|
z.object({
|
|
506
|
-
|
|
821
|
+
name: z.string(),
|
|
507
822
|
createdAt: z.coerce.date(),
|
|
508
823
|
status: z.enum([
|
|
509
824
|
"ongoing",
|
|
510
825
|
"deployed",
|
|
511
826
|
"failed"
|
|
512
827
|
]),
|
|
513
|
-
|
|
828
|
+
failureReason: domainFailureReasonSchema.nullable(),
|
|
829
|
+
environment: environmentSchema$1,
|
|
830
|
+
mappings: z.array(projectDomainMappingSchema)
|
|
514
831
|
});
|
|
515
832
|
const serverFieldsSchema$1 = z.object({
|
|
516
833
|
$schema: z.string(),
|
|
@@ -539,15 +856,7 @@ z.object({
|
|
|
539
856
|
serverFields: serverFieldsSchema$1,
|
|
540
857
|
source: z.enum(["registry", "defaults"])
|
|
541
858
|
});
|
|
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
|
-
*/
|
|
859
|
+
/** 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
860
|
const clampStringField = (field) => {
|
|
552
861
|
const max = field.maxLength;
|
|
553
862
|
if (max === null) return field;
|
|
@@ -574,10 +883,13 @@ const positiveTestCaseSchema = z.object({
|
|
|
574
883
|
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
575
884
|
const screenshotEntrySchema = z.object({
|
|
576
885
|
prompt: z.string(),
|
|
577
|
-
url: z.url()
|
|
886
|
+
url: z.url()
|
|
578
887
|
}).describe("Each screenshot: the user prompt that produced it + the image URL.");
|
|
888
|
+
const screenshotDraftEntrySchema = screenshotEntrySchema.extend({ url: z.string() });
|
|
579
889
|
/** Accepts either a valid email or URL. */
|
|
580
890
|
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
891
|
+
/** A URL field whose error spells out that the scheme is required. */
|
|
892
|
+
const urlField = z.url({ error: "Enter a full URL including https:// (e.g. https://example.com)" });
|
|
581
893
|
const chatgptCategorySchema = z.enum([
|
|
582
894
|
"BUSINESS",
|
|
583
895
|
"COLLABORATION",
|
|
@@ -890,11 +1202,7 @@ const chatgptToolJustificationSchema = z.object({
|
|
|
890
1202
|
openWorldJustification: z.string().describe("One sentence on whether the tool reaches external systems beyond your own service."),
|
|
891
1203
|
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
1204
|
}).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
|
-
*/
|
|
1205
|
+
/** Defined once and reused by both the submission form and per-locale translations so the tagline ≤ 30 chars constraint never drifts. */
|
|
898
1206
|
const chatgptTaglineSchema = z.string().max(30);
|
|
899
1207
|
const chatgptDescriptionSchema = z.string();
|
|
900
1208
|
const chatgptTranslationSchema = z.object({
|
|
@@ -903,10 +1211,7 @@ const chatgptTranslationSchema = z.object({
|
|
|
903
1211
|
description: chatgptDescriptionSchema
|
|
904
1212
|
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
905
1213
|
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
|
-
*/
|
|
1214
|
+
/** Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section; keep it in sync with the sheet. */
|
|
910
1215
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
911
1216
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
912
1217
|
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 +1220,34 @@ const chatgptSubmissionFormDataSchema = z.object({
|
|
|
915
1220
|
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
1221
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
917
1222
|
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
918
|
-
companyUrl:
|
|
1223
|
+
companyUrl: urlField.describe("Your company's main website URL."),
|
|
919
1224
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
920
|
-
privacyPolicyUrl:
|
|
921
|
-
termsOfServiceUrl:
|
|
922
|
-
demoRecordingUrl:
|
|
1225
|
+
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1226
|
+
termsOfServiceUrl: urlField.describe("URL to the app's terms of service."),
|
|
1227
|
+
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
1228
|
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:
|
|
1229
|
+
serverUrl: urlField.describe("URL of the MCP server."),
|
|
925
1230
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
926
1231
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
927
1232
|
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
1233
|
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
1234
|
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."),
|
|
1235
|
+
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
1236
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
932
1237
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
933
1238
|
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
934
1239
|
});
|
|
1240
|
+
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1241
|
+
tagline: z.string().optional(),
|
|
1242
|
+
companyUrl: z.string().optional(),
|
|
1243
|
+
supportChannel: z.string().optional(),
|
|
1244
|
+
privacyPolicyUrl: z.string().optional(),
|
|
1245
|
+
termsOfServiceUrl: z.string().optional(),
|
|
1246
|
+
demoRecordingUrl: z.string().optional(),
|
|
1247
|
+
serverUrl: z.string().optional(),
|
|
1248
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1249
|
+
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1250
|
+
});
|
|
935
1251
|
chatgptSubmissionFormDataSchema.pick({
|
|
936
1252
|
appName: true,
|
|
937
1253
|
developerName: true,
|
|
@@ -948,7 +1264,7 @@ chatgptSubmissionFormDataSchema.pick({
|
|
|
948
1264
|
toolJustifications: true
|
|
949
1265
|
}).extend({ tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline) });
|
|
950
1266
|
const claudeCategorySchema = z.enum([
|
|
951
|
-
"
|
|
1267
|
+
"Productivity",
|
|
952
1268
|
"Communication",
|
|
953
1269
|
"Data & Analytics",
|
|
954
1270
|
"Development tools",
|
|
@@ -956,205 +1272,145 @@ const claudeCategorySchema = z.enum([
|
|
|
956
1272
|
"Consumer Health",
|
|
957
1273
|
"Health & Life Sciences",
|
|
958
1274
|
"Media & Entertainment",
|
|
959
|
-
"Commerce & Shopping"
|
|
1275
|
+
"Commerce & Shopping",
|
|
1276
|
+
"Legal",
|
|
1277
|
+
"Sales and marketing",
|
|
1278
|
+
"Creative",
|
|
1279
|
+
"Nonprofit",
|
|
1280
|
+
"Education",
|
|
1281
|
+
"Other"
|
|
960
1282
|
]);
|
|
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)"]);
|
|
1283
|
+
const claudeCategoryDescription = `The categories used to filter connectors in the directory UI. Select up to 5 that best describe your connector.`;
|
|
968
1284
|
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
969
|
-
"
|
|
970
|
-
"
|
|
971
|
-
"
|
|
1285
|
+
"read_only",
|
|
1286
|
+
"write_only",
|
|
1287
|
+
"read_write"
|
|
972
1288
|
]);
|
|
973
|
-
const
|
|
974
|
-
|
|
975
|
-
"
|
|
976
|
-
"
|
|
977
|
-
"
|
|
978
|
-
"
|
|
979
|
-
]);
|
|
980
|
-
const claudeThirdPartySchema = z.enum([
|
|
981
|
-
"Web access: Fetches information from the open web (e.g., web scraping, search engines, or browsing arbitrary URLs, not just connecting to a specific API)",
|
|
982
|
-
"Third-party AI model integration: Sends data to or receives data from a generative AI model other than Claude",
|
|
983
|
-
"Third-party data retrieval: Connects to external services that themselves retrieve data from other sources (e.g., workflow automation platforms or other services that aggregate or relay data from multiple third-party sources)",
|
|
984
|
-
"Third-party data modification: Can connect to external services that themselves create, update, or delete data in other sources (e.g., workflow automation platforms or other services that write to multiple third-party sources)",
|
|
985
|
-
"N/A"
|
|
1289
|
+
const claudeAuthenticationSchema = z.enum([
|
|
1290
|
+
"oauth_dcr",
|
|
1291
|
+
"oauth_cimd",
|
|
1292
|
+
"oauth_anthropic_creds",
|
|
1293
|
+
"custom_connection",
|
|
1294
|
+
"none"
|
|
986
1295
|
]);
|
|
987
|
-
const
|
|
988
|
-
"
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"GDPR compliant (if applicable)"
|
|
1296
|
+
const claudeApiOwnershipSchema = z.enum([
|
|
1297
|
+
"first_party",
|
|
1298
|
+
"proxied",
|
|
1299
|
+
"third_party"
|
|
992
1300
|
]);
|
|
993
|
-
const
|
|
994
|
-
|
|
995
|
-
"
|
|
996
|
-
"
|
|
1301
|
+
const claudeYesNoOtherSchema = z.union([z.boolean(), z.object({ other: z.string() })]);
|
|
1302
|
+
const claudePolicyAcknowledgementSchema = z.enum([
|
|
1303
|
+
"I have read and understand the MCP Directory developer guidelines.",
|
|
1304
|
+
"My server calls our own first-party APIs (or APIs we legitimately proxy with permission).",
|
|
1305
|
+
"My connector does not transfer money, cryptocurrency, or other financial assets on a user's behalf.",
|
|
1306
|
+
"My connector does not use AI models to generate images, video, or audio.",
|
|
1307
|
+
"Tool descriptions contain no instructions about model behavior, other tools, or external instruction sources, and no hidden or encoded text.",
|
|
1308
|
+
"My connector does not collect conversation data beyond what is needed for its function.",
|
|
1309
|
+
"Public documentation for this connector will be live by the publish date."
|
|
997
1310
|
]);
|
|
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
|
-
*/
|
|
1311
|
+
/** 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
1312
|
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.`)
|
|
1313
|
+
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
|
|
1314
|
+
from the custom connector you select — the connection is used to verify the URL and the tool list at submission time.
|
|
1315
|
+
The server must be publicly accessible without VPN or whitelisting.`),
|
|
1316
|
+
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
|
|
1317
|
+
own or have the right to use this name. Max 100 characters.`),
|
|
1318
|
+
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.
|
|
1319
|
+
PERMANENT after submission — it cannot be changed. Pre-filled from the name. Max 50 characters.`),
|
|
1320
|
+
oneLiner: z.string().max(200).describe(`A short tagline shown below your connector name in the directory listing. Max 200 characters. Avoid generic
|
|
1321
|
+
phrases like 'The best MCP server for...'. Example: 'Manage tasks and projects in Linear'.`),
|
|
1322
|
+
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
|
|
1323
|
+
claude.ai. Write it from a user perspective and be specific. Max 2000 characters.`),
|
|
1324
|
+
categories: z.array(claudeCategorySchema).max(5).describe(claudeCategoryDescription),
|
|
1325
|
+
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
|
|
1326
|
+
(recommended); upload a custom icon only to override it.`),
|
|
1327
|
+
documentation: z.url().describe(`A public URL pointing to documentation that helps users understand and use your connector. Must be publicly
|
|
1328
|
+
accessible without login. IT admins often review these when deciding whether to approve a server. Required to be live
|
|
1329
|
+
by your publish date.`),
|
|
1330
|
+
support: supportChannelSchema.describe(`A support URL or email address where users can get help with your connector. Displayed in the directory listing and
|
|
1331
|
+
used to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
1332
|
+
privacyPolicy: z.url().describe(`URL to your privacy policy. Mandatory and displayed in the directory listing. Must be publicly accessible and cover
|
|
1333
|
+
what data you collect, how you use and store it, and whether you share it with third parties.`),
|
|
1334
|
+
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
|
|
1335
|
+
it. This is editable on the directory page only after the connector is submitted — optional here so you can prepare it.`),
|
|
1336
|
+
primaryUseCases: z.string().describe(`Describe the main tasks users will accomplish with this connector, and include a few example prompts a user might
|
|
1337
|
+
type. These may be shown publicly but are primarily used for internal review — reviewers test your server using them.`),
|
|
1338
|
+
connectionRequirements: z.string().describe(`What accounts, permissions, or setup a user needs before connecting (e.g. 'Requires a paid Acme account with admin
|
|
1339
|
+
permissions'). If there are genuinely no special requirements, say so explicitly.`),
|
|
1340
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`What your server can do:
|
|
1341
|
+
• 'read_only': retrieves data but never modifies it.
|
|
1342
|
+
• 'write_only': creates or modifies data but does not read it.
|
|
1343
|
+
• 'read_write': both retrieves and modifies data (most common).`),
|
|
1344
|
+
companyName: z.string().describe("The company or organization behind this connector — its legal name or publicly known product name."),
|
|
1345
|
+
companyWebsite: z.url().describe("The company's main website URL, e.g. https://example.com."),
|
|
1346
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. Receives review feedback and follow-up questions."),
|
|
1347
|
+
primaryContactEmail: z.email().describe("Email for the primary contact (pre-filled from the Claude account). Anthropic uses this to communicate about your submission."),
|
|
1348
|
+
primaryContactRole: z.string().optional().describe("The primary contact's role at the company (e.g. 'Engineer', 'Product Manager'). Optional."),
|
|
1349
|
+
anthropicPointOfContact: z.string().optional().describe("If you've been working with someone at Anthropic, their name or email. Optional, can expedite review."),
|
|
1350
|
+
authentication: claudeAuthenticationSchema.describe(`How users authenticate with your server:
|
|
1351
|
+
• 'oauth_dcr': OAuth 2.0 + Dynamic Client Registration (RFC 7591) — clients register themselves.
|
|
1352
|
+
• 'oauth_cimd': OAuth 2.0 + Client ID Metadata Document — a published client_id metadata document.
|
|
1353
|
+
• 'oauth_anthropic_creds': OAuth 2.0 with Anthropic-held client credentials (a static client_id, and secret if needed).
|
|
1354
|
+
• 'custom_connection': users supply their own URL or client details at connection time (e.g. Snowflake).
|
|
1355
|
+
• 'none': no authentication (authless) — anyone can connect and call tools without credentials.`),
|
|
1356
|
+
partialAuth: z.boolean().optional().describe("Whether some tools return 401 and prompt for auth on demand while the server otherwise starts authless (partial auth)."),
|
|
1357
|
+
apiOwnership: claudeApiOwnershipSchema.describe(`How your connector relates to the API it calls:
|
|
1358
|
+
• 'first_party': the MCP server calls your own production APIs.
|
|
1359
|
+
• 'proxied': calls go to a third-party API you're authorized to integrate (e.g. a Zapier-style integration).
|
|
1360
|
+
• 'third_party': calls a third-party API you don't control — typically blocks listing; explain in 'additionalNotes'.`),
|
|
1361
|
+
personalHealthData: claudeYesNoOtherSchema.describe(`Whether this connector accesses, processes, or stores personal health information.
|
|
1362
|
+
No → false, Yes → true, or { other: explanation } when it depends on configuration.`),
|
|
1363
|
+
sponsoredContent: claudeYesNoOtherSchema.describe(`Whether this connector surfaces sponsored, promoted, or advertising content (prohibited in directory connectors).
|
|
1364
|
+
No → false, Yes → true, or { other: explanation }.`),
|
|
1365
|
+
testInstructions: z.string().optional().describe(`Clear test-account setup and access instructions for reviewers: every link, credential, and step needed to access
|
|
1366
|
+
the MCP server autonomously. For accounts that need to be populated, provide test credentials granting access to a
|
|
1367
|
+
fully populated account.`),
|
|
1368
|
+
selfTested: z.boolean().optional().describe("Confirmation that you have run every tool via MCP Inspector or as a custom connector in Claude."),
|
|
1369
|
+
policyAcknowledgements: z.array(claudePolicyAcknowledgementSchema).describe(`Anthropic directory policy acknowledgements. All items must be acknowledged before the claude.ai wizard allows
|
|
1370
|
+
submission. Each is an attestation you are legally agreeing to by submitting.`),
|
|
1371
|
+
additionalNotes: z.string().optional().describe("Anything else the review team should know about your connector. Optional.")
|
|
1372
|
+
});
|
|
1373
|
+
const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().extend({
|
|
1374
|
+
serverUrl: z.string().optional(),
|
|
1375
|
+
name: z.string().optional(),
|
|
1376
|
+
slug: z.string().optional(),
|
|
1377
|
+
oneLiner: z.string().optional(),
|
|
1378
|
+
description: z.string().optional(),
|
|
1379
|
+
iconUrl: z.string().optional(),
|
|
1380
|
+
documentation: z.string().optional(),
|
|
1381
|
+
support: z.string().optional(),
|
|
1382
|
+
privacyPolicy: z.string().optional(),
|
|
1383
|
+
companyWebsite: z.string().optional(),
|
|
1384
|
+
primaryContactEmail: z.string().optional(),
|
|
1385
|
+
categories: z.array(claudeCategorySchema).optional(),
|
|
1386
|
+
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1133
1387
|
});
|
|
1134
1388
|
claudeSubmissionFormDataSchema.pick({
|
|
1135
|
-
companyName: true,
|
|
1136
|
-
appName: true,
|
|
1137
|
-
mcpUrlType: true,
|
|
1138
1389
|
serverUrl: true,
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
transportSupport: true,
|
|
1390
|
+
name: true,
|
|
1391
|
+
slug: true,
|
|
1392
|
+
companyName: true,
|
|
1143
1393
|
primaryContactEmail: true,
|
|
1144
1394
|
primaryContactName: true,
|
|
1395
|
+
readWriteCapabilities: true,
|
|
1145
1396
|
authentication: true,
|
|
1146
|
-
|
|
1147
|
-
|
|
1397
|
+
apiOwnership: true,
|
|
1398
|
+
personalHealthData: true
|
|
1148
1399
|
}).extend({
|
|
1149
1400
|
connectionRequirements: claudeSubmissionFormDataSchema.shape.connectionRequirements.optional(),
|
|
1150
|
-
|
|
1401
|
+
testInstructions: claudeSubmissionFormDataSchema.shape.testInstructions.optional()
|
|
1402
|
+
});
|
|
1403
|
+
/** Loose shape returned by AI generation for Claude narrative fields; transforms live here so generation leniency stays colocated with the Claude contract. */
|
|
1404
|
+
const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
1405
|
+
oneLiner: claudeSubmissionFormDataSchema.shape.oneLiner,
|
|
1406
|
+
description: claudeSubmissionFormDataSchema.shape.description,
|
|
1407
|
+
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1408
|
+
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1409
|
+
});
|
|
1410
|
+
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1411
|
+
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1412
|
+
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1151
1413
|
});
|
|
1152
|
-
claudeSubmissionFormDataSchema.pick({
|
|
1153
|
-
tagline: true,
|
|
1154
|
-
description: true,
|
|
1155
|
-
category: true,
|
|
1156
|
-
testCases: true
|
|
1157
|
-
}).extend({ tagline: clampStringField(claudeSubmissionFormDataSchema.shape.tagline) });
|
|
1158
1414
|
const submissionMetaFieldsSchema = z.object({
|
|
1159
1415
|
id: z.string(),
|
|
1160
1416
|
environmentId: z.string(),
|
|
@@ -1164,14 +1420,19 @@ const submissionMetaFieldsSchema = z.object({
|
|
|
1164
1420
|
});
|
|
1165
1421
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1166
1422
|
platform: z.literal("claudeai"),
|
|
1167
|
-
formData:
|
|
1423
|
+
formData: claudeSubmissionDraftSchema
|
|
1168
1424
|
});
|
|
1169
1425
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1170
1426
|
platform: z.literal("chatgpt"),
|
|
1171
|
-
formData:
|
|
1427
|
+
formData: chatgptSubmissionDraftSchema
|
|
1172
1428
|
});
|
|
1173
1429
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1174
|
-
z.union([
|
|
1430
|
+
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1431
|
+
z.literal([
|
|
1432
|
+
100,
|
|
1433
|
+
75,
|
|
1434
|
+
50
|
|
1435
|
+
]);
|
|
1175
1436
|
const subscriptionPlanSchema = z.enum([
|
|
1176
1437
|
"pro",
|
|
1177
1438
|
"business",
|
|
@@ -1194,6 +1455,50 @@ z.object({
|
|
|
1194
1455
|
customerUsage: customerUsageSchema.nullable(),
|
|
1195
1456
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1196
1457
|
});
|
|
1458
|
+
const telemetrySignalSchema = z.enum([
|
|
1459
|
+
"logs",
|
|
1460
|
+
"metrics",
|
|
1461
|
+
"traces"
|
|
1462
|
+
]);
|
|
1463
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1464
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1465
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1466
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1467
|
+
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");
|
|
1468
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1469
|
+
id: z.string(),
|
|
1470
|
+
name: otlpHeaderNameSchema,
|
|
1471
|
+
value: otlpHeaderValueSchema,
|
|
1472
|
+
isSecret: z.boolean()
|
|
1473
|
+
});
|
|
1474
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1475
|
+
"credentials",
|
|
1476
|
+
"wrong-path",
|
|
1477
|
+
"wrong-protocol",
|
|
1478
|
+
"invalid-payload",
|
|
1479
|
+
"partial-rejection",
|
|
1480
|
+
"blocked-target",
|
|
1481
|
+
"timeout",
|
|
1482
|
+
"unreachable",
|
|
1483
|
+
"receiver-error",
|
|
1484
|
+
"unexpected-status"
|
|
1485
|
+
]);
|
|
1486
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1487
|
+
z.object({
|
|
1488
|
+
id: z.string(),
|
|
1489
|
+
signal: telemetrySignalSchema,
|
|
1490
|
+
endpoint: otlpEndpointSchema,
|
|
1491
|
+
protocol: otlpProtocolSchema,
|
|
1492
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1493
|
+
status: telemetryDestinationStatusSchema,
|
|
1494
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1495
|
+
});
|
|
1496
|
+
//#endregion
|
|
1497
|
+
//#region src/auth-scope.ts
|
|
1498
|
+
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
1499
|
+
const AUTH_SCOPE_ANY = "any";
|
|
1500
|
+
/** Requires a user OAuth access token; API keys are not accepted. */
|
|
1501
|
+
const AUTH_SCOPE_USER = "user";
|
|
1197
1502
|
//#endregion
|
|
1198
1503
|
//#region src/schemas.ts
|
|
1199
1504
|
const RESERVED_KEYS = [
|
|
@@ -1230,7 +1535,10 @@ const RESERVED_KEYS = [
|
|
|
1230
1535
|
"BUILD_ARG_START_COMMAND",
|
|
1231
1536
|
"ALPIC_HOST",
|
|
1232
1537
|
"ALPIC_CUSTOM_DOMAINS",
|
|
1233
|
-
"ALPIC_INTENT_META_KEY"
|
|
1538
|
+
"ALPIC_INTENT_META_KEY",
|
|
1539
|
+
"ALPIC_FEEDBACK_META_KEY",
|
|
1540
|
+
"ALPIC_EVENTS_META_KEY",
|
|
1541
|
+
"ALPIC_IDENTIFY_META_KEY"
|
|
1234
1542
|
];
|
|
1235
1543
|
const environmentVariableSchema = z.object({
|
|
1236
1544
|
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"),
|
|
@@ -1311,21 +1619,20 @@ const deploymentSchema = z.object({
|
|
|
1311
1619
|
isCurrent: z.boolean(),
|
|
1312
1620
|
deploymentPageUrl: z.url().nullable()
|
|
1313
1621
|
});
|
|
1314
|
-
const
|
|
1622
|
+
const isValidTimeInput = (value) => {
|
|
1315
1623
|
if (ms(value) !== void 0) return true;
|
|
1316
1624
|
return !Number.isNaN(new Date(value).getTime());
|
|
1317
1625
|
};
|
|
1318
|
-
const
|
|
1626
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1627
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1628
|
+
const createEnvironmentContractV1 = base.route({
|
|
1319
1629
|
path: "/v1/environments",
|
|
1320
1630
|
method: "POST",
|
|
1321
1631
|
summary: "Create an environment",
|
|
1322
1632
|
description: "Create an environment for a project",
|
|
1323
1633
|
tags: ["environments"],
|
|
1324
1634
|
successDescription: "The environment has been created successfully"
|
|
1325
|
-
}).errors({
|
|
1326
|
-
NOT_FOUND: {},
|
|
1327
|
-
BAD_REQUEST: {}
|
|
1328
|
-
}).input(z.object({
|
|
1635
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1329
1636
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1330
1637
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1331
1638
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1338,7 +1645,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1338
1645
|
createdAt: z.coerce.date(),
|
|
1339
1646
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1340
1647
|
}));
|
|
1341
|
-
const getEnvironmentContractV1 =
|
|
1648
|
+
const getEnvironmentContractV1 = base.route({
|
|
1342
1649
|
path: "/v1/environments/{environmentId}",
|
|
1343
1650
|
method: "GET",
|
|
1344
1651
|
summary: "Get an environment",
|
|
@@ -1395,7 +1702,7 @@ const projectOutputSchema = z.object({
|
|
|
1395
1702
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1396
1703
|
environments: z.array(environmentSchema)
|
|
1397
1704
|
});
|
|
1398
|
-
const getProjectContractV1 =
|
|
1705
|
+
const getProjectContractV1 = base.route({
|
|
1399
1706
|
path: "/v1/projects/{projectId}",
|
|
1400
1707
|
method: "GET",
|
|
1401
1708
|
summary: "Get a project",
|
|
@@ -1403,18 +1710,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1403
1710
|
tags: ["projects"],
|
|
1404
1711
|
successDescription: "The project details"
|
|
1405
1712
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1406
|
-
const listProjectsContractV1 =
|
|
1713
|
+
const listProjectsContractV1 = base.route({
|
|
1407
1714
|
path: "/v1/projects",
|
|
1408
1715
|
method: "GET",
|
|
1409
1716
|
summary: "List projects",
|
|
1410
1717
|
description: "List all projects for a team",
|
|
1411
1718
|
tags: ["projects"],
|
|
1412
1719
|
successDescription: "The list of projects"
|
|
1413
|
-
}).errors({
|
|
1414
|
-
|
|
1415
|
-
BAD_REQUEST: {}
|
|
1416
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1417
|
-
const createProjectContractV1 = oc.route({
|
|
1720
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1721
|
+
const createProjectContractV1 = base.route({
|
|
1418
1722
|
path: "/v1/projects",
|
|
1419
1723
|
method: "POST",
|
|
1420
1724
|
summary: "Create a project",
|
|
@@ -1423,7 +1727,7 @@ const createProjectContractV1 = oc.route({
|
|
|
1423
1727
|
successDescription: "The project has been created successfully"
|
|
1424
1728
|
}).errors({
|
|
1425
1729
|
NOT_FOUND: {},
|
|
1426
|
-
|
|
1730
|
+
FORBIDDEN: {}
|
|
1427
1731
|
}).input(z.object({
|
|
1428
1732
|
teamId: z.string().optional(),
|
|
1429
1733
|
name: z.string().trim().min(1).max(100),
|
|
@@ -1463,7 +1767,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1463
1767
|
isSecret: z.boolean(),
|
|
1464
1768
|
createdAt: z.coerce.date()
|
|
1465
1769
|
});
|
|
1466
|
-
const listEnvironmentVariablesContractV1 =
|
|
1770
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1467
1771
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1468
1772
|
method: "GET",
|
|
1469
1773
|
summary: "List environment variables",
|
|
@@ -1471,48 +1775,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1471
1775
|
tags: ["environments"],
|
|
1472
1776
|
successDescription: "The list of environment variables"
|
|
1473
1777
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1474
|
-
const createEnvironmentVariablesContractV1 =
|
|
1778
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1475
1779
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1476
1780
|
method: "POST",
|
|
1477
1781
|
summary: "Add environment variables",
|
|
1478
1782
|
description: "Add one or more environment variables to an environment",
|
|
1479
1783
|
tags: ["environments"],
|
|
1480
1784
|
successDescription: "The environment variables have been added successfully"
|
|
1481
|
-
}).errors({
|
|
1482
|
-
NOT_FOUND: {},
|
|
1483
|
-
BAD_REQUEST: {}
|
|
1484
|
-
}).input(z.object({
|
|
1785
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1485
1786
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1486
1787
|
environmentVariables: environmentVariablesSchema
|
|
1487
1788
|
})).output(z.object({ success: z.literal(true) }));
|
|
1488
|
-
const updateEnvironmentVariableContractV1 =
|
|
1789
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1489
1790
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1490
1791
|
method: "PATCH",
|
|
1491
1792
|
summary: "Update an environment variable",
|
|
1492
1793
|
description: "Update an environment variable by ID",
|
|
1493
1794
|
tags: ["environments"],
|
|
1494
1795
|
successDescription: "The environment variable has been updated successfully"
|
|
1495
|
-
}).errors({
|
|
1496
|
-
NOT_FOUND: {},
|
|
1497
|
-
BAD_REQUEST: {}
|
|
1498
|
-
}).input(z.object({
|
|
1796
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1499
1797
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1500
1798
|
key: environmentVariableSchema.shape.key,
|
|
1501
1799
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1502
1800
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1503
1801
|
})).output(z.object({ success: z.literal(true) }));
|
|
1504
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1802
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1505
1803
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1506
1804
|
method: "DELETE",
|
|
1507
1805
|
summary: "Delete an environment variable",
|
|
1508
1806
|
description: "Delete an environment variable by ID",
|
|
1509
1807
|
tags: ["environments"],
|
|
1510
1808
|
successDescription: "The environment variable has been deleted successfully"
|
|
1511
|
-
}).errors({
|
|
1512
|
-
|
|
1513
|
-
BAD_REQUEST: {}
|
|
1514
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1515
|
-
const deleteProjectContractV1 = oc.route({
|
|
1809
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1810
|
+
const deleteProjectContractV1 = base.route({
|
|
1516
1811
|
path: "/v1/projects/{projectId}",
|
|
1517
1812
|
method: "DELETE",
|
|
1518
1813
|
summary: "Delete a project",
|
|
@@ -1520,7 +1815,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1520
1815
|
tags: ["projects"],
|
|
1521
1816
|
successDescription: "The project has been deleted successfully"
|
|
1522
1817
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1523
|
-
const updateProjectContractV1 =
|
|
1818
|
+
const updateProjectContractV1 = base.route({
|
|
1524
1819
|
path: "/v1/projects/{projectId}",
|
|
1525
1820
|
method: "PATCH",
|
|
1526
1821
|
summary: "Update a project",
|
|
@@ -1529,13 +1824,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1529
1824
|
successDescription: "The project has been updated successfully"
|
|
1530
1825
|
}).errors({
|
|
1531
1826
|
NOT_FOUND: {},
|
|
1532
|
-
|
|
1827
|
+
FORBIDDEN: {}
|
|
1533
1828
|
}).input(z.object({
|
|
1534
1829
|
projectId: z.string().describe("The ID of the project"),
|
|
1535
1830
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1536
1831
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1537
1832
|
})).output(projectOutputSchema);
|
|
1538
|
-
const deployEnvironmentContractV1 =
|
|
1833
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1539
1834
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1540
1835
|
method: "POST",
|
|
1541
1836
|
summary: "Deploy an environment",
|
|
@@ -1544,27 +1839,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1544
1839
|
successDescription: "The environment has been deployed successfully"
|
|
1545
1840
|
}).errors({
|
|
1546
1841
|
NOT_FOUND: {},
|
|
1547
|
-
|
|
1842
|
+
CONFLICT: {}
|
|
1548
1843
|
}).input(z.object({
|
|
1549
1844
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1550
|
-
token: z.string().describe("The token to identify the source archive").optional()
|
|
1845
|
+
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1846
|
+
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1551
1847
|
})).output(deploymentSchema);
|
|
1552
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1848
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1553
1849
|
path: "/v1/deployments/upload",
|
|
1554
1850
|
method: "POST",
|
|
1555
1851
|
summary: "Upload deployment artifacts",
|
|
1556
1852
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1557
1853
|
tags: ["deployments"],
|
|
1558
1854
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1559
|
-
}).errors({
|
|
1560
|
-
NOT_FOUND: {},
|
|
1561
|
-
BAD_REQUEST: {}
|
|
1562
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1855
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1563
1856
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1564
1857
|
token: z.string().describe("Token to identify the source archive"),
|
|
1565
1858
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1566
1859
|
}));
|
|
1567
|
-
const listDeploymentsContractV1 =
|
|
1860
|
+
const listDeploymentsContractV1 = base.route({
|
|
1568
1861
|
path: "/v1/projects/{projectId}/deployments",
|
|
1569
1862
|
method: "GET",
|
|
1570
1863
|
summary: "List project deployments",
|
|
@@ -1576,7 +1869,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1576
1869
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1577
1870
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1578
1871
|
})).output(z.array(deploymentSchema));
|
|
1579
|
-
const getDeploymentContractV1 =
|
|
1872
|
+
const getDeploymentContractV1 = base.route({
|
|
1580
1873
|
path: "/v1/deployments/{deploymentId}",
|
|
1581
1874
|
method: "GET",
|
|
1582
1875
|
summary: "Get a deployment",
|
|
@@ -1584,20 +1877,32 @@ const getDeploymentContractV1 = oc.route({
|
|
|
1584
1877
|
tags: ["deployments"],
|
|
1585
1878
|
successDescription: "The deployment details"
|
|
1586
1879
|
}).errors({ NOT_FOUND: {} }).input(z.object({ deploymentId: z.string().describe("The ID of the deployment") })).output(deploymentSchema);
|
|
1587
|
-
const
|
|
1880
|
+
const logEntrySchema = z.object({
|
|
1881
|
+
timestamp: z.coerce.date(),
|
|
1882
|
+
type: z.enum([
|
|
1883
|
+
"START",
|
|
1884
|
+
"END",
|
|
1885
|
+
"INFO",
|
|
1886
|
+
"ERROR",
|
|
1887
|
+
"WARNING",
|
|
1888
|
+
"DEBUG"
|
|
1889
|
+
]),
|
|
1890
|
+
requestId: z.string(),
|
|
1891
|
+
content: z.string().optional(),
|
|
1892
|
+
method: z.string().optional(),
|
|
1893
|
+
durationInMs: z.number().optional()
|
|
1894
|
+
});
|
|
1895
|
+
const getLogsContractV1 = base.route({
|
|
1588
1896
|
path: "/v1/environments/{environmentId}/logs",
|
|
1589
1897
|
method: "GET",
|
|
1590
1898
|
summary: "Get logs",
|
|
1591
1899
|
description: "Get logs for an environment",
|
|
1592
1900
|
tags: ["environments"],
|
|
1593
1901
|
successDescription: "The logs"
|
|
1594
|
-
}).errors({
|
|
1595
|
-
NOT_FOUND: {},
|
|
1596
|
-
BAD_REQUEST: {}
|
|
1597
|
-
}).input(z.object({
|
|
1902
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1598
1903
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1599
|
-
since:
|
|
1600
|
-
until:
|
|
1904
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1905
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1601
1906
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1602
1907
|
level: z.array(z.enum([
|
|
1603
1908
|
"INFO",
|
|
@@ -1608,34 +1913,17 @@ const getLogsContractV1 = oc.route({
|
|
|
1608
1913
|
search: z.string().optional().describe("Filter pattern to search for in log content"),
|
|
1609
1914
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1610
1915
|
})).output(z.object({
|
|
1611
|
-
logs: z.array(
|
|
1612
|
-
timestamp: z.coerce.date(),
|
|
1613
|
-
type: z.enum([
|
|
1614
|
-
"START",
|
|
1615
|
-
"END",
|
|
1616
|
-
"INFO",
|
|
1617
|
-
"ERROR",
|
|
1618
|
-
"WARNING",
|
|
1619
|
-
"DEBUG"
|
|
1620
|
-
]),
|
|
1621
|
-
requestId: z.string(),
|
|
1622
|
-
content: z.string().optional(),
|
|
1623
|
-
method: z.string().optional(),
|
|
1624
|
-
durationInMs: z.number().optional()
|
|
1625
|
-
})),
|
|
1916
|
+
logs: z.array(logEntrySchema),
|
|
1626
1917
|
nextToken: z.string().nullable()
|
|
1627
1918
|
}));
|
|
1628
|
-
const getLatestLogsContractV1 =
|
|
1919
|
+
const getLatestLogsContractV1 = base.route({
|
|
1629
1920
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1630
1921
|
method: "GET",
|
|
1631
1922
|
summary: "Get latest logs",
|
|
1632
1923
|
description: "Get the N most recent logs for an environment",
|
|
1633
1924
|
tags: ["environments"],
|
|
1634
1925
|
successDescription: "The latest logs"
|
|
1635
|
-
}).errors({
|
|
1636
|
-
NOT_FOUND: {},
|
|
1637
|
-
BAD_REQUEST: {}
|
|
1638
|
-
}).input(z.object({
|
|
1926
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1639
1927
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1640
1928
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1641
1929
|
level: z.array(z.enum([
|
|
@@ -1645,22 +1933,8 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1645
1933
|
"DEBUG"
|
|
1646
1934
|
])).optional().describe("Filter by log level"),
|
|
1647
1935
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1648
|
-
})).output(z.object({ logs: z.array(
|
|
1649
|
-
|
|
1650
|
-
type: z.enum([
|
|
1651
|
-
"START",
|
|
1652
|
-
"END",
|
|
1653
|
-
"INFO",
|
|
1654
|
-
"ERROR",
|
|
1655
|
-
"WARNING",
|
|
1656
|
-
"DEBUG"
|
|
1657
|
-
]),
|
|
1658
|
-
requestId: z.string(),
|
|
1659
|
-
content: z.string().optional(),
|
|
1660
|
-
method: z.string().optional(),
|
|
1661
|
-
durationInMs: z.number().optional()
|
|
1662
|
-
})) }));
|
|
1663
|
-
const getDeploymentLogsContractV1 = oc.route({
|
|
1936
|
+
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1937
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1664
1938
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1665
1939
|
method: "GET",
|
|
1666
1940
|
summary: "Get deployment logs",
|
|
@@ -1687,22 +1961,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1687
1961
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1688
1962
|
task_count: z.array(analyticsDataPointSchema)
|
|
1689
1963
|
});
|
|
1690
|
-
const getProjectAnalyticsContractV1 =
|
|
1964
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1691
1965
|
path: "/v1/analytics/{projectId}",
|
|
1692
1966
|
method: "GET",
|
|
1693
1967
|
summary: "Get project analytics",
|
|
1694
1968
|
description: "Get analytics data for a project over a time range",
|
|
1695
1969
|
tags: ["analytics"],
|
|
1696
1970
|
successDescription: "The project analytics data"
|
|
1697
|
-
}).errors({
|
|
1698
|
-
NOT_FOUND: {},
|
|
1699
|
-
BAD_REQUEST: {}
|
|
1700
|
-
}).input(z.object({
|
|
1971
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1701
1972
|
projectId: z.string().describe("The ID of the project"),
|
|
1702
1973
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1703
1974
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1704
1975
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1705
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
1976
|
+
}).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({
|
|
1706
1977
|
metadata: z.object({
|
|
1707
1978
|
startTimestamp: z.number(),
|
|
1708
1979
|
endTimestamp: z.number(),
|
|
@@ -1712,7 +1983,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1712
1983
|
}),
|
|
1713
1984
|
timeSeries: analyticsTimeSeriesSchema
|
|
1714
1985
|
}));
|
|
1715
|
-
const
|
|
1986
|
+
const paginatedInsightsInputShape = {
|
|
1987
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1988
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1989
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1990
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1991
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1992
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1993
|
+
};
|
|
1994
|
+
const listIntentsContractV1 = base.route({
|
|
1995
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1996
|
+
method: "GET",
|
|
1997
|
+
summary: "List intents",
|
|
1998
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1999
|
+
tags: ["insights"],
|
|
2000
|
+
successDescription: "The grouped user intents"
|
|
2001
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2002
|
+
...paginatedInsightsInputShape,
|
|
2003
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2004
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2005
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2006
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2007
|
+
})).output(z.object({
|
|
2008
|
+
intents: z.array(z.object({
|
|
2009
|
+
id: z.string(),
|
|
2010
|
+
intentIds: z.array(z.string()).min(1),
|
|
2011
|
+
environmentId: z.string(),
|
|
2012
|
+
message: z.string(),
|
|
2013
|
+
toolName: z.string(),
|
|
2014
|
+
createdAt: z.coerce.date(),
|
|
2015
|
+
occurrenceCount: z.number().int().positive(),
|
|
2016
|
+
clientName: z.string().nullable(),
|
|
2017
|
+
clientId: z.string().nullable(),
|
|
2018
|
+
categories: z.array(z.object({
|
|
2019
|
+
id: z.string(),
|
|
2020
|
+
name: z.string(),
|
|
2021
|
+
color: intentCategoryColorSchema
|
|
2022
|
+
}))
|
|
2023
|
+
})),
|
|
2024
|
+
totalCount: z.number().int().nonnegative()
|
|
2025
|
+
}));
|
|
2026
|
+
const listFeedbacksContractV1 = base.route({
|
|
2027
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2028
|
+
method: "GET",
|
|
2029
|
+
summary: "List feedbacks",
|
|
2030
|
+
description: "List user feedback for an environment over a time range",
|
|
2031
|
+
tags: ["insights"],
|
|
2032
|
+
successDescription: "The user feedback"
|
|
2033
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2034
|
+
...paginatedInsightsInputShape,
|
|
2035
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2036
|
+
})).output(z.object({
|
|
2037
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2038
|
+
totalCount: z.number().int().nonnegative()
|
|
2039
|
+
}));
|
|
2040
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2041
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2042
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2043
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2044
|
+
method: "GET",
|
|
2045
|
+
summary: "List intent categories",
|
|
2046
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2047
|
+
tags: ["insights"],
|
|
2048
|
+
successDescription: "The intent categories"
|
|
2049
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2050
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2051
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2052
|
+
method: "POST",
|
|
2053
|
+
summary: "Create an intent category",
|
|
2054
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2055
|
+
tags: ["insights"],
|
|
2056
|
+
successDescription: "The created intent category"
|
|
2057
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2058
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2059
|
+
name: intentCategoryNameSchema,
|
|
2060
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2061
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2062
|
+
})).output(intentCategorySchema);
|
|
2063
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2064
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2065
|
+
method: "PATCH",
|
|
2066
|
+
summary: "Update an intent category",
|
|
2067
|
+
description: "Rename or recolor an intent category",
|
|
2068
|
+
tags: ["insights"],
|
|
2069
|
+
successDescription: "The updated intent category"
|
|
2070
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2071
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2072
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2073
|
+
name: intentCategoryNameSchema.optional(),
|
|
2074
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2075
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2076
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2077
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2078
|
+
method: "DELETE",
|
|
2079
|
+
summary: "Delete an intent category",
|
|
2080
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2081
|
+
tags: ["insights"],
|
|
2082
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2083
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2084
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2085
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2086
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2087
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2088
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2089
|
+
method: "POST",
|
|
2090
|
+
summary: "Link an intent category",
|
|
2091
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2092
|
+
tags: ["insights"],
|
|
2093
|
+
successDescription: "The intents have been linked successfully"
|
|
2094
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2095
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2096
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2097
|
+
intentIds: categorizableIntentIdsSchema
|
|
2098
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2099
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2100
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2101
|
+
method: "POST",
|
|
2102
|
+
summary: "Unlink an intent category",
|
|
2103
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2104
|
+
tags: ["insights"],
|
|
2105
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2106
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2107
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2108
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2109
|
+
intentIds: categorizableIntentIdsSchema
|
|
2110
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2111
|
+
const listTeamsContractV1 = base.route({
|
|
1716
2112
|
path: "/v1/teams",
|
|
1717
2113
|
method: "GET",
|
|
1718
2114
|
summary: "List teams",
|
|
@@ -1725,28 +2121,40 @@ const listTeamsContractV1 = oc.route({
|
|
|
1725
2121
|
createdAt: z.coerce.date(),
|
|
1726
2122
|
hasStripeAccount: z.boolean()
|
|
1727
2123
|
})));
|
|
1728
|
-
const
|
|
2124
|
+
const getTeamUsageContractV1 = base.route({
|
|
2125
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2126
|
+
method: "GET",
|
|
2127
|
+
summary: "Get team usage",
|
|
2128
|
+
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.",
|
|
2129
|
+
tags: ["teams"],
|
|
2130
|
+
successDescription: "The current billing window usage"
|
|
2131
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2132
|
+
teamId: z.string(),
|
|
2133
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2134
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2135
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2136
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2137
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2138
|
+
}));
|
|
2139
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1729
2140
|
path: "/v1/tunnels/ticket",
|
|
1730
2141
|
method: "GET",
|
|
1731
2142
|
summary: "Get a tunnel ticket",
|
|
1732
2143
|
description: "Get a signed ticket for establishing a tunnel connection. Requires user authentication (API keys are not supported).",
|
|
1733
2144
|
tags: ["tunnels"],
|
|
1734
2145
|
successDescription: "The tunnel ticket"
|
|
1735
|
-
}).errors({ FORBIDDEN: {} }).output(z.object({
|
|
2146
|
+
}).meta({ authScope: AUTH_SCOPE_USER }).errors({ FORBIDDEN: {} }).output(z.object({
|
|
1736
2147
|
subdomain: z.string().describe("The subdomain assigned to the user"),
|
|
1737
2148
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1738
2149
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1739
2150
|
}));
|
|
1740
|
-
const publishServerContractV1 =
|
|
2151
|
+
const publishServerContractV1 = base.route({
|
|
1741
2152
|
path: "/v1/distribution/publish",
|
|
1742
2153
|
method: "POST",
|
|
1743
2154
|
summary: "Publish a server to the MCP registry",
|
|
1744
2155
|
tags: ["distribution"],
|
|
1745
2156
|
successDescription: "The server has been published successfully"
|
|
1746
|
-
}).errors({
|
|
1747
|
-
NOT_FOUND: {},
|
|
1748
|
-
BAD_REQUEST: {}
|
|
1749
|
-
}).input(z.object({
|
|
2157
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1750
2158
|
projectId: z.string(),
|
|
1751
2159
|
domain: z.string(),
|
|
1752
2160
|
title: z.string().min(1).max(100),
|
|
@@ -1755,17 +2163,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1755
2163
|
iconSrc: z.url().max(255).optional(),
|
|
1756
2164
|
dryRun: z.boolean().optional()
|
|
1757
2165
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1758
|
-
const getServerInfoContractV1 =
|
|
2166
|
+
const getServerInfoContractV1 = base.route({
|
|
1759
2167
|
path: "/v1/distribution/get",
|
|
1760
2168
|
method: "GET",
|
|
1761
2169
|
summary: "Get server info",
|
|
1762
2170
|
description: "Get info about a server",
|
|
1763
2171
|
tags: ["distribution"],
|
|
1764
2172
|
successDescription: "The server info"
|
|
1765
|
-
}).errors({
|
|
1766
|
-
NOT_FOUND: {},
|
|
1767
|
-
BAD_REQUEST: {}
|
|
1768
|
-
}).input(z.object({
|
|
2173
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1769
2174
|
projectId: z.string(),
|
|
1770
2175
|
domain: z.string()
|
|
1771
2176
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1784,7 +2189,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1784
2189
|
isPlaygroundEnabled: z.boolean(),
|
|
1785
2190
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1786
2191
|
});
|
|
1787
|
-
const getPlaygroundContractV1 =
|
|
2192
|
+
const getPlaygroundContractV1 = base.route({
|
|
1788
2193
|
path: "/v1/environments/{environmentId}/playground",
|
|
1789
2194
|
method: "GET",
|
|
1790
2195
|
summary: "Get playground configuration",
|
|
@@ -1792,17 +2197,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1792
2197
|
tags: ["environments"],
|
|
1793
2198
|
successDescription: "The playground configuration"
|
|
1794
2199
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1795
|
-
const upsertPlaygroundContractV1 =
|
|
2200
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1796
2201
|
path: "/v1/environments/{environmentId}/playground",
|
|
1797
2202
|
method: "PUT",
|
|
1798
2203
|
summary: "Update playground configuration",
|
|
1799
2204
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1800
2205
|
tags: ["environments"],
|
|
1801
2206
|
successDescription: "The updated playground configuration"
|
|
1802
|
-
}).errors({
|
|
1803
|
-
NOT_FOUND: {},
|
|
1804
|
-
BAD_REQUEST: {}
|
|
1805
|
-
}).input(z.object({
|
|
2207
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1806
2208
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1807
2209
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1808
2210
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1810,7 +2212,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1810
2212
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1811
2213
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1812
2214
|
})).output(playgroundOutputSchema);
|
|
1813
|
-
const createBeaconContractV1 =
|
|
2215
|
+
const createBeaconContractV1 = base.route({
|
|
1814
2216
|
path: "/v1/beacon/audits",
|
|
1815
2217
|
method: "POST",
|
|
1816
2218
|
summary: "Create a beacon audit",
|
|
@@ -1819,7 +2221,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1819
2221
|
successDescription: "The audit has been created"
|
|
1820
2222
|
}).errors({
|
|
1821
2223
|
NOT_FOUND: {},
|
|
1822
|
-
BAD_REQUEST: {},
|
|
1823
2224
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1824
2225
|
}).input(z.object({
|
|
1825
2226
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1827,7 +2228,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1827
2228
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1828
2229
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1829
2230
|
})).output(z.object({ id: z.string() }));
|
|
1830
|
-
const getBeaconContractV1 =
|
|
2231
|
+
const getBeaconContractV1 = base.route({
|
|
1831
2232
|
path: "/v1/beacon/audits/{auditId}",
|
|
1832
2233
|
method: "GET",
|
|
1833
2234
|
summary: "Get a beacon audit",
|
|
@@ -1843,8 +2244,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1843
2244
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1844
2245
|
}));
|
|
1845
2246
|
const contract = {
|
|
1846
|
-
teams: {
|
|
2247
|
+
teams: {
|
|
2248
|
+
list: { v1: listTeamsContractV1 },
|
|
2249
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2250
|
+
},
|
|
1847
2251
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2252
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2253
|
+
intentCategories: {
|
|
2254
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2255
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2256
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2257
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2258
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2259
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2260
|
+
},
|
|
2261
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1848
2262
|
deployments: {
|
|
1849
2263
|
list: { v1: listDeploymentsContractV1 },
|
|
1850
2264
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1885,5 +2299,10 @@ const contract = {
|
|
|
1885
2299
|
get: { v1: getBeaconContractV1 }
|
|
1886
2300
|
}
|
|
1887
2301
|
};
|
|
2302
|
+
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
2303
|
+
const contractForDocs = {
|
|
2304
|
+
...contract,
|
|
2305
|
+
deployments: deploymentsForDocs
|
|
2306
|
+
};
|
|
1888
2307
|
//#endregion
|
|
1889
|
-
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2308
|
+
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 };
|