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