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