@alpic-ai/api 0.0.0-staging.c65131c → 0.0.0-staging.c6b023d
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 +30 -171
- package/dist/index.mjs +397 -70
- package/package.json +17 -5
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
1
2
|
import * as _$_orpc_contract0 from "@orpc/contract";
|
|
2
3
|
import { InferContractRouterInputs, InferContractRouterOutputs } from "@orpc/contract";
|
|
3
|
-
import { z } from "zod";
|
|
4
4
|
|
|
5
5
|
//#region src/api.contract.d.ts
|
|
6
6
|
type ApiContext = {
|
|
@@ -11,9 +11,9 @@ type ApiContext = {
|
|
|
11
11
|
};
|
|
12
12
|
};
|
|
13
13
|
declare const deploymentStatusSchema: z.ZodEnum<{
|
|
14
|
-
failed: "failed";
|
|
15
14
|
ongoing: "ongoing";
|
|
16
15
|
deployed: "deployed";
|
|
16
|
+
failed: "failed";
|
|
17
17
|
canceled: "canceled";
|
|
18
18
|
}>;
|
|
19
19
|
declare const createEnvironmentContractV1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
@@ -103,18 +103,18 @@ declare const contract: {
|
|
|
103
103
|
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
104
104
|
projectId: z.ZodString;
|
|
105
105
|
status: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
106
|
-
failed: "failed";
|
|
107
106
|
ongoing: "ongoing";
|
|
108
107
|
deployed: "deployed";
|
|
108
|
+
failed: "failed";
|
|
109
109
|
canceled: "canceled";
|
|
110
110
|
}>>>;
|
|
111
111
|
environmentId: z.ZodOptional<z.ZodString>;
|
|
112
112
|
}, z.core.$strip>, z.ZodArray<z.ZodObject<{
|
|
113
113
|
id: z.ZodString;
|
|
114
114
|
status: z.ZodEnum<{
|
|
115
|
-
failed: "failed";
|
|
116
115
|
ongoing: "ongoing";
|
|
117
116
|
deployed: "deployed";
|
|
117
|
+
failed: "failed";
|
|
118
118
|
canceled: "canceled";
|
|
119
119
|
}>;
|
|
120
120
|
sourceRef: z.ZodNullable<z.ZodString>;
|
|
@@ -138,9 +138,9 @@ declare const contract: {
|
|
|
138
138
|
}, z.core.$strip>, z.ZodObject<{
|
|
139
139
|
id: z.ZodString;
|
|
140
140
|
status: z.ZodEnum<{
|
|
141
|
-
failed: "failed";
|
|
142
141
|
ongoing: "ongoing";
|
|
143
142
|
deployed: "deployed";
|
|
143
|
+
failed: "failed";
|
|
144
144
|
canceled: "canceled";
|
|
145
145
|
}>;
|
|
146
146
|
sourceRef: z.ZodNullable<z.ZodString>;
|
|
@@ -226,9 +226,9 @@ declare const contract: {
|
|
|
226
226
|
}, z.core.$strip>, z.ZodObject<{
|
|
227
227
|
id: z.ZodString;
|
|
228
228
|
status: z.ZodEnum<{
|
|
229
|
-
failed: "failed";
|
|
230
229
|
ongoing: "ongoing";
|
|
231
230
|
deployed: "deployed";
|
|
231
|
+
failed: "failed";
|
|
232
232
|
canceled: "canceled";
|
|
233
233
|
}>;
|
|
234
234
|
sourceRef: z.ZodNullable<z.ZodString>;
|
|
@@ -403,18 +403,18 @@ declare const contract: {
|
|
|
403
403
|
domains: z.ZodArray<z.ZodObject<{
|
|
404
404
|
domain: z.ZodString;
|
|
405
405
|
status: z.ZodEnum<{
|
|
406
|
-
failed: "failed";
|
|
407
406
|
ongoing: "ongoing";
|
|
408
407
|
deployed: "deployed";
|
|
408
|
+
failed: "failed";
|
|
409
409
|
}>;
|
|
410
410
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
411
411
|
}, z.core.$strip>>;
|
|
412
412
|
latestDeployment: z.ZodNullable<z.ZodObject<{
|
|
413
413
|
id: z.ZodString;
|
|
414
414
|
status: z.ZodEnum<{
|
|
415
|
-
failed: "failed";
|
|
416
415
|
ongoing: "ongoing";
|
|
417
416
|
deployed: "deployed";
|
|
417
|
+
failed: "failed";
|
|
418
418
|
canceled: "canceled";
|
|
419
419
|
}>;
|
|
420
420
|
sourceCommitId: z.ZodNullable<z.ZodString>;
|
|
@@ -432,9 +432,9 @@ declare const contract: {
|
|
|
432
432
|
latestDeployment: z.ZodNullable<z.ZodObject<{
|
|
433
433
|
id: z.ZodString;
|
|
434
434
|
status: z.ZodEnum<{
|
|
435
|
-
failed: "failed";
|
|
436
435
|
ongoing: "ongoing";
|
|
437
436
|
deployed: "deployed";
|
|
437
|
+
failed: "failed";
|
|
438
438
|
canceled: "canceled";
|
|
439
439
|
}>;
|
|
440
440
|
sourceCommitId: z.ZodNullable<z.ZodString>;
|
|
@@ -479,18 +479,18 @@ declare const contract: {
|
|
|
479
479
|
domains: z.ZodArray<z.ZodObject<{
|
|
480
480
|
domain: z.ZodString;
|
|
481
481
|
status: z.ZodEnum<{
|
|
482
|
-
failed: "failed";
|
|
483
482
|
ongoing: "ongoing";
|
|
484
483
|
deployed: "deployed";
|
|
484
|
+
failed: "failed";
|
|
485
485
|
}>;
|
|
486
486
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
487
487
|
}, z.core.$strip>>;
|
|
488
488
|
latestDeployment: z.ZodNullable<z.ZodObject<{
|
|
489
489
|
id: z.ZodString;
|
|
490
490
|
status: z.ZodEnum<{
|
|
491
|
-
failed: "failed";
|
|
492
491
|
ongoing: "ongoing";
|
|
493
492
|
deployed: "deployed";
|
|
493
|
+
failed: "failed";
|
|
494
494
|
canceled: "canceled";
|
|
495
495
|
}>;
|
|
496
496
|
sourceCommitId: z.ZodNullable<z.ZodString>;
|
|
@@ -508,9 +508,9 @@ declare const contract: {
|
|
|
508
508
|
latestDeployment: z.ZodNullable<z.ZodObject<{
|
|
509
509
|
id: z.ZodString;
|
|
510
510
|
status: z.ZodEnum<{
|
|
511
|
-
failed: "failed";
|
|
512
511
|
ongoing: "ongoing";
|
|
513
512
|
deployed: "deployed";
|
|
513
|
+
failed: "failed";
|
|
514
514
|
canceled: "canceled";
|
|
515
515
|
}>;
|
|
516
516
|
sourceCommitId: z.ZodNullable<z.ZodString>;
|
|
@@ -554,18 +554,18 @@ declare const contract: {
|
|
|
554
554
|
domains: z.ZodArray<z.ZodObject<{
|
|
555
555
|
domain: z.ZodString;
|
|
556
556
|
status: z.ZodEnum<{
|
|
557
|
-
failed: "failed";
|
|
558
557
|
ongoing: "ongoing";
|
|
559
558
|
deployed: "deployed";
|
|
559
|
+
failed: "failed";
|
|
560
560
|
}>;
|
|
561
561
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
562
562
|
}, z.core.$strip>>;
|
|
563
563
|
latestDeployment: z.ZodNullable<z.ZodObject<{
|
|
564
564
|
id: z.ZodString;
|
|
565
565
|
status: z.ZodEnum<{
|
|
566
|
-
failed: "failed";
|
|
567
566
|
ongoing: "ongoing";
|
|
568
567
|
deployed: "deployed";
|
|
568
|
+
failed: "failed";
|
|
569
569
|
canceled: "canceled";
|
|
570
570
|
}>;
|
|
571
571
|
sourceCommitId: z.ZodNullable<z.ZodString>;
|
|
@@ -583,9 +583,9 @@ declare const contract: {
|
|
|
583
583
|
latestDeployment: z.ZodNullable<z.ZodObject<{
|
|
584
584
|
id: z.ZodString;
|
|
585
585
|
status: z.ZodEnum<{
|
|
586
|
-
failed: "failed";
|
|
587
586
|
ongoing: "ongoing";
|
|
588
587
|
deployed: "deployed";
|
|
588
|
+
failed: "failed";
|
|
589
589
|
canceled: "canceled";
|
|
590
590
|
}>;
|
|
591
591
|
sourceCommitId: z.ZodNullable<z.ZodString>;
|
|
@@ -816,7 +816,7 @@ declare const contract: {
|
|
|
816
816
|
beacon: {
|
|
817
817
|
create: {
|
|
818
818
|
v1: _$_orpc_contract0.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
|
|
819
|
-
targetUrl: z.
|
|
819
|
+
targetUrl: z.ZodURL;
|
|
820
820
|
teamId: z.ZodOptional<z.ZodString>;
|
|
821
821
|
projectId: z.ZodOptional<z.ZodString>;
|
|
822
822
|
excludeCategories: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
@@ -840,10 +840,10 @@ declare const contract: {
|
|
|
840
840
|
id: z.ZodString;
|
|
841
841
|
targetUrl: z.ZodString;
|
|
842
842
|
status: z.ZodEnum<{
|
|
843
|
+
failed: "failed";
|
|
843
844
|
pending: "pending";
|
|
844
845
|
partial: "partial";
|
|
845
846
|
completed: "completed";
|
|
846
|
-
failed: "failed";
|
|
847
847
|
}>;
|
|
848
848
|
durationMs: z.ZodNullable<z.ZodNumber>;
|
|
849
849
|
createdAt: z.ZodCoercedDate<unknown>;
|
|
@@ -905,18 +905,18 @@ declare const contract: {
|
|
|
905
905
|
chatgpt: "chatgpt";
|
|
906
906
|
claudeai: "claudeai";
|
|
907
907
|
}>, z.ZodBoolean>;
|
|
908
|
-
widgetScreenshotKeys: z.
|
|
908
|
+
widgetScreenshotKeys: z.ZodObject<{
|
|
909
909
|
chatgpt: z.ZodOptional<z.ZodString>;
|
|
910
910
|
claudeai: z.ZodOptional<z.ZodString>;
|
|
911
|
-
}, z.core.$strip
|
|
912
|
-
widgetScreenshots: z.
|
|
911
|
+
}, z.core.$strip>;
|
|
912
|
+
widgetScreenshots: z.ZodObject<{
|
|
913
913
|
chatgpt: z.ZodOptional<z.ZodObject<{
|
|
914
914
|
url: z.ZodString;
|
|
915
915
|
}, z.core.$strip>>;
|
|
916
916
|
claudeai: z.ZodOptional<z.ZodObject<{
|
|
917
917
|
url: z.ZodString;
|
|
918
918
|
}, z.core.$strip>>;
|
|
919
|
-
}, z.core.$strip
|
|
919
|
+
}, z.core.$strip>;
|
|
920
920
|
}, z.core.$strip>>;
|
|
921
921
|
}, z.core.$strip>, _$_orpc_contract0.MergedErrorMap<Record<never, never>, {
|
|
922
922
|
NOT_FOUND: {};
|
|
@@ -927,6 +927,14 @@ declare const contract: {
|
|
|
927
927
|
type RouterInput = InferContractRouterInputs<typeof contract>;
|
|
928
928
|
type RouterOutput = InferContractRouterOutputs<typeof contract>;
|
|
929
929
|
//#endregion
|
|
930
|
+
//#region ../domains/src/platforms/schemas.d.ts
|
|
931
|
+
declare const platformSchema: z.ZodEnum<{
|
|
932
|
+
chatgpt: "chatgpt";
|
|
933
|
+
claudeai: "claudeai";
|
|
934
|
+
}>;
|
|
935
|
+
type Platform = z.infer<typeof platformSchema>;
|
|
936
|
+
declare const PLATFORM_LABELS: Record<Platform, string>;
|
|
937
|
+
//#endregion
|
|
930
938
|
//#region src/schemas.d.ts
|
|
931
939
|
declare const environmentVariableSchema: z.ZodObject<{
|
|
932
940
|
key: z.ZodString;
|
|
@@ -962,155 +970,6 @@ declare const transportSchema: z.ZodEnum<{
|
|
|
962
970
|
streamablehttp: "streamablehttp";
|
|
963
971
|
}>;
|
|
964
972
|
type Transport = z.infer<typeof transportSchema>;
|
|
965
|
-
declare const auditStatusSchema: z.ZodEnum<{
|
|
966
|
-
pending: "pending";
|
|
967
|
-
partial: "partial";
|
|
968
|
-
completed: "completed";
|
|
969
|
-
failed: "failed";
|
|
970
|
-
}>;
|
|
971
|
-
declare const platformSchema: z.ZodEnum<{
|
|
972
|
-
chatgpt: "chatgpt";
|
|
973
|
-
claudeai: "claudeai";
|
|
974
|
-
}>;
|
|
975
|
-
type Platform = z.infer<typeof platformSchema>;
|
|
976
|
-
declare const checkSeveritySchema: z.ZodEnum<{
|
|
977
|
-
error: "error";
|
|
978
|
-
warning: "warning";
|
|
979
|
-
info: "info";
|
|
980
|
-
}>;
|
|
981
|
-
type CheckSeverity = z.infer<typeof checkSeveritySchema>;
|
|
982
|
-
declare const checkCategorySchema: z.ZodEnum<{
|
|
983
|
-
connectivity: "connectivity";
|
|
984
|
-
"tool-metadata": "tool-metadata";
|
|
985
|
-
"resource-metadata": "resource-metadata";
|
|
986
|
-
performance: "performance";
|
|
987
|
-
e2e: "e2e";
|
|
988
|
-
}>;
|
|
989
|
-
type CheckCategory = z.infer<typeof checkCategorySchema>;
|
|
990
|
-
declare const checkScopeSchema: z.ZodEnum<{
|
|
991
|
-
server: "server";
|
|
992
|
-
view: "view";
|
|
993
|
-
}>;
|
|
994
|
-
type CheckScope = z.infer<typeof checkScopeSchema>;
|
|
995
|
-
declare const checkDetailSchema: z.ZodObject<{
|
|
996
|
-
label: z.ZodString;
|
|
997
|
-
value: z.ZodOptional<z.ZodString>;
|
|
998
|
-
}, z.core.$strip>;
|
|
999
|
-
type CheckDetail = z.infer<typeof checkDetailSchema>;
|
|
1000
|
-
declare const checkResultSchema: z.ZodObject<{
|
|
1001
|
-
checkId: z.ZodString;
|
|
1002
|
-
checkName: z.ZodString;
|
|
1003
|
-
description: z.ZodString;
|
|
1004
|
-
status: z.ZodEnum<{
|
|
1005
|
-
pending: "pending";
|
|
1006
|
-
pass: "pass";
|
|
1007
|
-
fail: "fail";
|
|
1008
|
-
skip: "skip";
|
|
1009
|
-
}>;
|
|
1010
|
-
message: z.ZodString;
|
|
1011
|
-
skipReason: z.ZodOptional<z.ZodString>;
|
|
1012
|
-
severity: z.ZodEnum<{
|
|
1013
|
-
error: "error";
|
|
1014
|
-
warning: "warning";
|
|
1015
|
-
info: "info";
|
|
1016
|
-
}>;
|
|
1017
|
-
category: z.ZodEnum<{
|
|
1018
|
-
connectivity: "connectivity";
|
|
1019
|
-
"tool-metadata": "tool-metadata";
|
|
1020
|
-
"resource-metadata": "resource-metadata";
|
|
1021
|
-
performance: "performance";
|
|
1022
|
-
e2e: "e2e";
|
|
1023
|
-
}>;
|
|
1024
|
-
scope: z.ZodEnum<{
|
|
1025
|
-
server: "server";
|
|
1026
|
-
view: "view";
|
|
1027
|
-
}>;
|
|
1028
|
-
platforms: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
|
|
1029
|
-
chatgpt: "chatgpt";
|
|
1030
|
-
claudeai: "claudeai";
|
|
1031
|
-
}>>>>;
|
|
1032
|
-
durationMs: z.ZodNumber;
|
|
1033
|
-
details: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1034
|
-
label: z.ZodString;
|
|
1035
|
-
value: z.ZodOptional<z.ZodString>;
|
|
1036
|
-
}, z.core.$strip>>>;
|
|
1037
|
-
hint: z.ZodOptional<z.ZodObject<{
|
|
1038
|
-
text: z.ZodString;
|
|
1039
|
-
}, z.core.$strip>>;
|
|
1040
|
-
}, z.core.$strip>;
|
|
1041
|
-
type CheckResult = z.infer<typeof checkResultSchema>;
|
|
1042
|
-
declare const auditReportSchema: z.ZodObject<{
|
|
1043
|
-
schemaVersion: z.ZodString;
|
|
1044
|
-
auditId: z.ZodString;
|
|
1045
|
-
targetUrl: z.ZodString;
|
|
1046
|
-
startedAt: z.ZodString;
|
|
1047
|
-
completedAt: z.ZodString;
|
|
1048
|
-
durationMs: z.ZodNumber;
|
|
1049
|
-
results: z.ZodArray<z.ZodObject<{
|
|
1050
|
-
checkId: z.ZodString;
|
|
1051
|
-
checkName: z.ZodString;
|
|
1052
|
-
description: z.ZodString;
|
|
1053
|
-
status: z.ZodEnum<{
|
|
1054
|
-
pending: "pending";
|
|
1055
|
-
pass: "pass";
|
|
1056
|
-
fail: "fail";
|
|
1057
|
-
skip: "skip";
|
|
1058
|
-
}>;
|
|
1059
|
-
message: z.ZodString;
|
|
1060
|
-
skipReason: z.ZodOptional<z.ZodString>;
|
|
1061
|
-
severity: z.ZodEnum<{
|
|
1062
|
-
error: "error";
|
|
1063
|
-
warning: "warning";
|
|
1064
|
-
info: "info";
|
|
1065
|
-
}>;
|
|
1066
|
-
category: z.ZodEnum<{
|
|
1067
|
-
connectivity: "connectivity";
|
|
1068
|
-
"tool-metadata": "tool-metadata";
|
|
1069
|
-
"resource-metadata": "resource-metadata";
|
|
1070
|
-
performance: "performance";
|
|
1071
|
-
e2e: "e2e";
|
|
1072
|
-
}>;
|
|
1073
|
-
scope: z.ZodEnum<{
|
|
1074
|
-
server: "server";
|
|
1075
|
-
view: "view";
|
|
1076
|
-
}>;
|
|
1077
|
-
platforms: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
|
|
1078
|
-
chatgpt: "chatgpt";
|
|
1079
|
-
claudeai: "claudeai";
|
|
1080
|
-
}>>>>;
|
|
1081
|
-
durationMs: z.ZodNumber;
|
|
1082
|
-
details: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1083
|
-
label: z.ZodString;
|
|
1084
|
-
value: z.ZodOptional<z.ZodString>;
|
|
1085
|
-
}, z.core.$strip>>>;
|
|
1086
|
-
hint: z.ZodOptional<z.ZodObject<{
|
|
1087
|
-
text: z.ZodString;
|
|
1088
|
-
}, z.core.$strip>>;
|
|
1089
|
-
}, z.core.$strip>>;
|
|
1090
|
-
requiresAuth: z.ZodBoolean;
|
|
1091
|
-
hasViewSupport: z.ZodBoolean;
|
|
1092
|
-
viewPlatforms: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
|
|
1093
|
-
chatgpt: "chatgpt";
|
|
1094
|
-
claudeai: "claudeai";
|
|
1095
|
-
}>>>>;
|
|
1096
|
-
isReadyForPlatform: z.ZodRecord<z.ZodEnum<{
|
|
1097
|
-
chatgpt: "chatgpt";
|
|
1098
|
-
claudeai: "claudeai";
|
|
1099
|
-
}>, z.ZodBoolean>;
|
|
1100
|
-
widgetScreenshotKeys: z.ZodOptional<z.ZodObject<{
|
|
1101
|
-
chatgpt: z.ZodOptional<z.ZodString>;
|
|
1102
|
-
claudeai: z.ZodOptional<z.ZodString>;
|
|
1103
|
-
}, z.core.$strip>>;
|
|
1104
|
-
widgetScreenshots: z.ZodOptional<z.ZodObject<{
|
|
1105
|
-
chatgpt: z.ZodOptional<z.ZodObject<{
|
|
1106
|
-
url: z.ZodString;
|
|
1107
|
-
}, z.core.$strip>>;
|
|
1108
|
-
claudeai: z.ZodOptional<z.ZodObject<{
|
|
1109
|
-
url: z.ZodString;
|
|
1110
|
-
}, z.core.$strip>>;
|
|
1111
|
-
}, z.core.$strip>>;
|
|
1112
|
-
}, z.core.$strip>;
|
|
1113
|
-
type AuditReport = z.infer<typeof auditReportSchema>;
|
|
1114
973
|
declare const playgroundHeaderSchema: z.ZodObject<{
|
|
1115
974
|
name: z.ZodString;
|
|
1116
975
|
description: z.ZodString;
|
|
@@ -1145,4 +1004,4 @@ declare const serverFieldsSchema: z.ZodObject<{
|
|
|
1145
1004
|
}, z.core.$strip>>>;
|
|
1146
1005
|
}, z.core.$strip>;
|
|
1147
1006
|
//#endregion
|
|
1148
|
-
export { ApiContext,
|
|
1007
|
+
export { ApiContext, PLATFORM_LABELS, type Platform, RouterInput, RouterOutput, Runtime, Transport, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
package/dist/index.mjs
CHANGED
|
@@ -1,6 +1,398 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
1
2
|
import { oc } from "@orpc/contract";
|
|
2
3
|
import ms from "ms";
|
|
3
|
-
|
|
4
|
+
const platformSchema = z.enum(["chatgpt", "claudeai"]);
|
|
5
|
+
const PLATFORM_LABELS = {
|
|
6
|
+
chatgpt: "ChatGPT",
|
|
7
|
+
claudeai: "Claude.ai"
|
|
8
|
+
};
|
|
9
|
+
const auditStatusSchema = z.enum([
|
|
10
|
+
"pending",
|
|
11
|
+
"partial",
|
|
12
|
+
"completed",
|
|
13
|
+
"failed"
|
|
14
|
+
]);
|
|
15
|
+
const checkSeveritySchema = z.enum([
|
|
16
|
+
"error",
|
|
17
|
+
"warning",
|
|
18
|
+
"info"
|
|
19
|
+
]);
|
|
20
|
+
const checkCategorySchema = z.enum([
|
|
21
|
+
"connectivity",
|
|
22
|
+
"tool-metadata",
|
|
23
|
+
"resource-metadata",
|
|
24
|
+
"performance",
|
|
25
|
+
"e2e"
|
|
26
|
+
]);
|
|
27
|
+
const checkScopeSchema = z.enum(["server", "view"]);
|
|
28
|
+
const checkDetailSchema = z.object({
|
|
29
|
+
label: z.string(),
|
|
30
|
+
value: z.string().optional()
|
|
31
|
+
});
|
|
32
|
+
const checkResultSchema = z.object({
|
|
33
|
+
checkId: z.string(),
|
|
34
|
+
checkName: z.string(),
|
|
35
|
+
description: z.string(),
|
|
36
|
+
status: z.enum([
|
|
37
|
+
"pass",
|
|
38
|
+
"fail",
|
|
39
|
+
"skip",
|
|
40
|
+
"pending"
|
|
41
|
+
]),
|
|
42
|
+
message: z.string(),
|
|
43
|
+
skipReason: z.string().optional(),
|
|
44
|
+
severity: checkSeveritySchema,
|
|
45
|
+
category: checkCategorySchema,
|
|
46
|
+
scope: checkScopeSchema,
|
|
47
|
+
platforms: z.array(platformSchema).readonly().optional(),
|
|
48
|
+
durationMs: z.number(),
|
|
49
|
+
details: z.array(checkDetailSchema).optional(),
|
|
50
|
+
hint: z.object({ text: z.string() }).optional()
|
|
51
|
+
});
|
|
52
|
+
const auditReportSchema = z.object({
|
|
53
|
+
schemaVersion: z.string(),
|
|
54
|
+
auditId: z.string(),
|
|
55
|
+
targetUrl: z.string(),
|
|
56
|
+
startedAt: z.string(),
|
|
57
|
+
completedAt: z.string(),
|
|
58
|
+
durationMs: z.number(),
|
|
59
|
+
results: z.array(checkResultSchema),
|
|
60
|
+
requiresAuth: z.boolean(),
|
|
61
|
+
hasViewSupport: z.boolean(),
|
|
62
|
+
viewPlatforms: z.array(platformSchema).readonly().optional(),
|
|
63
|
+
isReadyForPlatform: z.record(platformSchema, z.boolean()),
|
|
64
|
+
widgetScreenshotKeys: z.object({
|
|
65
|
+
chatgpt: z.string().optional(),
|
|
66
|
+
claudeai: z.string().optional()
|
|
67
|
+
})
|
|
68
|
+
});
|
|
69
|
+
const widgetScreenshotSchema = z.object({ url: z.string() });
|
|
70
|
+
const auditReportWithScreenshotsSchema = auditReportSchema.extend({ widgetScreenshots: z.object({
|
|
71
|
+
chatgpt: widgetScreenshotSchema.optional(),
|
|
72
|
+
claudeai: widgetScreenshotSchema.optional()
|
|
73
|
+
}) });
|
|
74
|
+
z.object({
|
|
75
|
+
id: z.string(),
|
|
76
|
+
createdAt: z.coerce.date(),
|
|
77
|
+
environmentId: z.string(),
|
|
78
|
+
content: z.string(),
|
|
79
|
+
source: z.enum(["model", "user"])
|
|
80
|
+
});
|
|
81
|
+
z.object({
|
|
82
|
+
content: z.string(),
|
|
83
|
+
source: z.enum(["model", "user"])
|
|
84
|
+
});
|
|
85
|
+
const toolDefinitionSchema = z.object({
|
|
86
|
+
name: z.string(),
|
|
87
|
+
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
88
|
+
description: z.string().optional(),
|
|
89
|
+
annotations: z.object({
|
|
90
|
+
readOnlyHint: z.boolean().optional(),
|
|
91
|
+
destructiveHint: z.boolean().optional(),
|
|
92
|
+
openWorldHint: z.boolean().optional(),
|
|
93
|
+
idempotentHint: z.boolean().optional()
|
|
94
|
+
}).optional()
|
|
95
|
+
});
|
|
96
|
+
const positiveTestCaseSchema = z.object({
|
|
97
|
+
scenario: z.string(),
|
|
98
|
+
userPrompt: z.string(),
|
|
99
|
+
toolTriggered: z.string().optional(),
|
|
100
|
+
expectedOutput: z.string().optional()
|
|
101
|
+
}).partial().describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
102
|
+
/** Accepts either a valid email or URL. */
|
|
103
|
+
const supportChannelSchema = z.string().refine((value) => z.email().safeParse(value).success || z.url().safeParse(value).success, { error: "Must be a valid email or URL" });
|
|
104
|
+
const chatgptCategorySchema = z.enum([
|
|
105
|
+
"BUSINESS",
|
|
106
|
+
"COLLABORATION",
|
|
107
|
+
"DESIGN",
|
|
108
|
+
"DEVELOPER_TOOLS",
|
|
109
|
+
"EDUCATION",
|
|
110
|
+
"ENTERTAINMENT",
|
|
111
|
+
"FINANCE",
|
|
112
|
+
"FOOD",
|
|
113
|
+
"LIFESTYLE",
|
|
114
|
+
"NEWS",
|
|
115
|
+
"PRODUCTIVITY",
|
|
116
|
+
"SHOPPING",
|
|
117
|
+
"TRAVEL"
|
|
118
|
+
]);
|
|
119
|
+
const chatgptAuthenticationSchema = z.enum(["No auth needed", "OAuth 2.0"]);
|
|
120
|
+
const chatgptAllowedCountriesSchema = z.enum(["Allow all", "Restrict to specific countries"]);
|
|
121
|
+
const negativeTestCaseSchema = z.object({
|
|
122
|
+
scenario: z.string(),
|
|
123
|
+
userPrompt: z.string()
|
|
124
|
+
}).partial().describe("Each case: Scenario + User prompt (the app should NOT trigger).");
|
|
125
|
+
const chatgptToolJustificationSchema = z.object({
|
|
126
|
+
toolName: z.string(),
|
|
127
|
+
readOnlyJustification: z.string(),
|
|
128
|
+
openWorldJustification: z.string(),
|
|
129
|
+
destructiveJustification: z.string()
|
|
130
|
+
}).describe("Per-tool justification of each MCP annotation value (one sentence per hint).");
|
|
131
|
+
const chatgptTranslationSchema = z.object({
|
|
132
|
+
locale: z.string(),
|
|
133
|
+
tagline: z.string().optional(),
|
|
134
|
+
description: z.string().optional()
|
|
135
|
+
}).describe("Locale-scoped override for tagline + description. English (US) is the default.");
|
|
136
|
+
/**
|
|
137
|
+
* Field order mirrors the ChatGPT (OpenAI) submission spreadsheet, grouped by section.
|
|
138
|
+
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
139
|
+
*/
|
|
140
|
+
const chatgptSubmissionFormDataSchema = z.object({
|
|
141
|
+
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
142
|
+
logoDark: z.string().describe("Logo icon for dark mode. Square PNG. Same specs as the light icon."),
|
|
143
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Apps Directory."),
|
|
144
|
+
tagline: z.string().max(30).describe("Plain-language phrase focused on function and user value. 30 chars max."),
|
|
145
|
+
description: z.string().describe("Clear, engaging description highlighting what the app does and why people will love it. Appears publicly on the directory page."),
|
|
146
|
+
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
147
|
+
developerName: z.string().describe("Developer name shown publicly on the app's directory page."),
|
|
148
|
+
companyUrl: z.url().describe("Your company's main website URL."),
|
|
149
|
+
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
150
|
+
privacyPolicyUrl: z.url().describe("URL to your privacy policy."),
|
|
151
|
+
termsOfServiceUrl: z.url().describe("URL to the app's terms of service."),
|
|
152
|
+
demoRecordingUrl: z.url().describe("URL to a video demonstrating the app, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
153
|
+
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."),
|
|
154
|
+
serverUrl: z.url().describe("URL of the MCP server."),
|
|
155
|
+
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
156
|
+
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
157
|
+
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values."),
|
|
158
|
+
testCases: z.array(positiveTestCaseSchema).describe("At least 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Coverage over all major use cases."),
|
|
159
|
+
negativeTestCases: z.array(negativeTestCaseSchema).describe("3 negative test cases — prompts where the app should NOT trigger but the model might think it's relevant."),
|
|
160
|
+
screenshots: z.array(z.url()).describe("URLs of in-app screenshots. Widget apps must show the widget UI; non-widget apps show the model response. Min 1, max 4. First three are public."),
|
|
161
|
+
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
162
|
+
allowedCountries: chatgptAllowedCountriesSchema.describe("'Allow all' or restrict to a specific list. See OpenAI's supported countries list."),
|
|
163
|
+
releaseNotes: z.string().describe("Publicly displayed on the app details page.")
|
|
164
|
+
});
|
|
165
|
+
chatgptSubmissionFormDataSchema.pick({
|
|
166
|
+
appName: true,
|
|
167
|
+
developerName: true,
|
|
168
|
+
serverUrl: true,
|
|
169
|
+
tools: true,
|
|
170
|
+
authentication: true
|
|
171
|
+
});
|
|
172
|
+
chatgptSubmissionFormDataSchema.pick({
|
|
173
|
+
tagline: true,
|
|
174
|
+
description: true,
|
|
175
|
+
category: true,
|
|
176
|
+
testCases: true,
|
|
177
|
+
negativeTestCases: true,
|
|
178
|
+
toolJustifications: true
|
|
179
|
+
});
|
|
180
|
+
const claudeCategorySchema = z.enum([
|
|
181
|
+
"Business & Productivity",
|
|
182
|
+
"Communication",
|
|
183
|
+
"Data & Analytics",
|
|
184
|
+
"Development tools",
|
|
185
|
+
"Financial Services",
|
|
186
|
+
"Consumer Health",
|
|
187
|
+
"Health & Life Sciences",
|
|
188
|
+
"Media & Entertainment",
|
|
189
|
+
"Commerce & Shopping"
|
|
190
|
+
]);
|
|
191
|
+
z.enum([
|
|
192
|
+
"No auth needed",
|
|
193
|
+
"OAuth 2.0",
|
|
194
|
+
"Custom URL"
|
|
195
|
+
]);
|
|
196
|
+
const claudeMcpUrlTypeSchema = z.enum(["Universal URL", "Custom MCP URLs"]);
|
|
197
|
+
z.enum(["Static OAuth Client", "Dynamic OAuth Client (DCR / CIMD)"]);
|
|
198
|
+
const claudeReadWriteCapabilitiesSchema = z.enum([
|
|
199
|
+
"Read only",
|
|
200
|
+
"Write only",
|
|
201
|
+
"Read + write"
|
|
202
|
+
]);
|
|
203
|
+
const claudeTransportSchema = z.enum(["Streamable HTTP", "SSE"]);
|
|
204
|
+
const claudeThirdPartySchema = z.enum([
|
|
205
|
+
"Web access (open web fetch / scraping / arbitrary URLs)",
|
|
206
|
+
"Third-party AI model integration",
|
|
207
|
+
"Third-party data retrieval (via workflow / aggregator)",
|
|
208
|
+
"Third-party data modification (via workflow / aggregator)",
|
|
209
|
+
"N/A"
|
|
210
|
+
]);
|
|
211
|
+
const claudeDataHandlingSchema = z.enum([
|
|
212
|
+
"Server only accesses data explicitly requested by user",
|
|
213
|
+
"No data is stored beyond session requirements",
|
|
214
|
+
"Data transmission is encrypted (HTTPS / TLS)",
|
|
215
|
+
"GDPR compliant (if applicable)"
|
|
216
|
+
]);
|
|
217
|
+
const claudeSponsoredContentSchema = z.enum([
|
|
218
|
+
"No, there is no sponsored content or advertisements",
|
|
219
|
+
"Yes, there are banner ads or other paid visual elements",
|
|
220
|
+
"Yes, returned content or ranking is impacted by sponsorship or ad placement"
|
|
221
|
+
]);
|
|
222
|
+
/**
|
|
223
|
+
* Field order mirrors the Claude (Anthropic) submission spreadsheet, grouped by section.
|
|
224
|
+
* When adding/removing/reordering fields, keep this in sync with the sheet.
|
|
225
|
+
*/
|
|
226
|
+
const claudeSubmissionFormDataSchema = z.object({
|
|
227
|
+
companyName: z.string().describe("Enter your company's legal name or the name under which your product is publicly known. This is used for internal tracking and may appear in directory listings."),
|
|
228
|
+
companyUrl: z.url().describe("Your company's main website URL, e.g. https://mycompany.com. Must be a valid URL with https://. This should be the root domain of the company behind this MCP server."),
|
|
229
|
+
primaryContactName: z.string().describe("Full name of the person Anthropic should contact about this submission. This person will receive review feedback, approval notices, and any follow-up questions."),
|
|
230
|
+
primaryContactEmail: z.email().describe("Business email for the primary contact. Must be a valid email address. Anthropic uses this to communicate about your submission status, required changes, and post-listing issues. Avoid using personal email addresses."),
|
|
231
|
+
primaryContactRole: z.string().optional().describe("The job title or role of the primary contact (e.g. 'CTO', 'Developer Relations Lead', 'Founder'). Optional but helps Anthropic route questions to the right person."),
|
|
232
|
+
anthropicPointOfContact: z.string().optional().describe("If you have a direct contact at Anthropic (e.g. from a partnership or sales conversation), enter their name here. This is optional but can greatly help expedite the review process. Leave blank if you don't have one."),
|
|
233
|
+
appName: z.string().describe(`The public display name for your connector as it will appear in the Connectors Directory.
|
|
234
|
+
|
|
235
|
+
Rules:
|
|
236
|
+
(1) Do NOT include the words 'MCP' or 'Server' — these are auto-rejected.
|
|
237
|
+
(2) Use your brand/product name, e.g. 'Notion', 'Linear', 'Slack'.
|
|
238
|
+
(3) You must own or have the right to use this brand name. For example, don't call it 'Google Drive Helper' if you're not Google.`),
|
|
239
|
+
mcpUrlType: claudeMcpUrlTypeSchema.describe(`Choose how your server URL works:
|
|
240
|
+
• 'Universal URL': one single URL that all users connect to (most common). Example: https://mcp.myapp.com
|
|
241
|
+
• 'Custom MCP URLs': each user gets their own unique URL (e.g. based on their workspace or instance).
|
|
242
|
+
If you choose this, you'll need to provide both a signup URL and a regex pattern that matches valid server URLs for your service.`),
|
|
243
|
+
serverUrl: z.url().describe(`If 'Universal URL': enter the full https:// URL where your MCP server is hosted and reachable. Example: https://mcp.myapp.com/
|
|
244
|
+
If 'Custom MCP URLs': provide (1) the signup/onboarding URL where users create an account, and (2) a regex pattern that matches all valid server URLs for your service (e.g. https://[a-z0-9-]+\\.myapp\\.com/mcp). The server must be publicly accessible without VPN or whitelisting required.`),
|
|
245
|
+
tagline: z.string().max(55).describe(`A very short, punchy description shown below your server name in the directory listing. Max 55 characters including spaces.
|
|
246
|
+
Think of it as a subtitle or elevator pitch fragment. Example: 'Manage tasks and projects in Linear' or 'Search and read your Notion workspace'. Avoid generic phrases like 'The best MCP server for...'`),
|
|
247
|
+
description: z.string().describe(`A 50–100 word description of what your MCP server does. This appears in the connector's detail page inside Claude. Write it from a user perspective: what can users do with this connector? What are the key features/tools? Avoid marketing fluff. Be specific. Example: 'Connect Claude to your Linear workspace. Create and update issues, search projects, manage teams, and track engineering cycles, all from within Claude.' Anthropic reviewers check this for accuracy against your actual tools.`),
|
|
248
|
+
testCases: z.array(positiveTestCaseSchema).describe(`Provide at least 3 concrete use cases, each with an example prompt a user could type to Claude. These are critical: Anthropic reviewers literally test your server using these prompts. Good examples are specific and demonstrate real value.
|
|
249
|
+
Best format: [Use case]: [exact prompt]"
|
|
250
|
+
Example for a task manager:
|
|
251
|
+
1. Create a task: 'Create a task called Review Q3 report, due Friday, assigned to Alice'
|
|
252
|
+
2. Search tasks: 'Show me all open bugs in the Mobile project'
|
|
253
|
+
3. Update status: 'Mark the Deploy v2.1 task as done'"`),
|
|
254
|
+
connectionRequirements: z.string().describe(`Describe any prerequisites a user must have before they can connect your server. Be exhaustive. Examples of things to mention:
|
|
255
|
+
• Account type required (free vs paid plan)
|
|
256
|
+
• Admin permissions or specific roles needed
|
|
257
|
+
• Geographic restrictions (e.g. 'US only' or 'Not available in EU')
|
|
258
|
+
• If users need to provide their own server URL or instance domain
|
|
259
|
+
• Any setup steps needed before connecting (e.g. 'Enable API access in your account settings')
|
|
260
|
+
If there are genuinely no special requirements, write exactly: 'No special requirements.'`),
|
|
261
|
+
readWriteCapabilities: claudeReadWriteCapabilitiesSchema.describe(`Select the option that best describes what your server can do:
|
|
262
|
+
|
|
263
|
+
'Read Only': your tools only fetch/retrieve data (GET operations). Claude cannot modify anything via your server.
|
|
264
|
+
'Write Only': your tools only create/update/delete data (rare).
|
|
265
|
+
'Read + Write': your tools can both retrieve AND modify data (most common for full-featured connectors).
|
|
266
|
+
|
|
267
|
+
Note: Anthropic rejects catch-all tools that accept both safe (GET) and unsafe (POST, PUT, DELETE) HTTP methods via a parameter e.g. a single api_request(method, endpoint) tool. Each tool should have a fixed, specific purpose. `),
|
|
268
|
+
isMcpApp: z.boolean().describe(`Select 'Yes' if your MCP server renders interactive UI elements (aka widgets or views) inside the Claude conversation.
|
|
269
|
+
Select 'No' if your server only returns text/data responses.
|
|
270
|
+
If 'Yes', you will also be required to provide screenshots of your UI (see Promotional Images section). MCP Apps are displayed with a special badge in the directory.`),
|
|
271
|
+
thirdPartyConnectionsAndWebAccess: z.array(claudeThirdPartySchema).describe(`Multi-select all that apply to your server's behavior:
|
|
272
|
+
• 'Web access' — your server fetches arbitrary URLs, scrapes websites, or makes open-ended HTTP requests to the web (not just your own API).
|
|
273
|
+
• 'Third-party AI model integration' — your server calls another AI model (e.g. OpenAI, Gemini, Cohere) as part of its processing.
|
|
274
|
+
• 'Third-party data retrieval' — your server retrieves data via a workflow or aggregator platform (e.g. Zapier, Make, n8n) rather than calling your own API directly.
|
|
275
|
+
• 'Third-party data modification' — your server modifies data via such a platform.
|
|
276
|
+
• 'N/A' — your server only calls your own first-party API and does nothing else. Select this only if none of the above apply.`),
|
|
277
|
+
dataHandling: z.array(claudeDataHandlingSchema).describe(`Multi-select all data handling practices that accurately apply to your server. You must select at least 3. Key points:
|
|
278
|
+
• 'Server only accesses data explicitly requested by user' — your server doesn't silently read unrelated user data.
|
|
279
|
+
• 'No data is stored beyond session requirements' — you don't log or retain conversation data after the session.
|
|
280
|
+
• 'Data transmission is encrypted (HTTPS/TLS)' — all data in transit is encrypted. This should always apply for remote servers.
|
|
281
|
+
• 'GDPR compliant' — if you operate in the EU or serve EU users, check this only if you are genuinely compliant. Don't check it without having proper data processing agreements and procedures in place.
|
|
282
|
+
Note: These are attestations — you are legally agreeing to these practices by submitting the form.`),
|
|
283
|
+
personalDataHealthAccess: z.boolean().describe(`Select 'Yes' ONLY if your connector gives users access to their own personal health information — such as medical records, lab results, diagnoses, prescriptions, wearable health metrics (heart rate, sleep data, etc.), or mental health data.
|
|
284
|
+
Select 'No' for the vast majority of business/productivity/dev tools. When in doubt, select 'No'. This field triggers additional compliance review if 'Yes'.`),
|
|
285
|
+
categories: z.array(claudeCategorySchema).describe(`Select the category or categories that best describe your connector. This determines where it appears in the directory's browse experience. Choose the most specific fit:
|
|
286
|
+
• Business & Productivity — project management, CRM, HR, office tools
|
|
287
|
+
• Communication — email, chat, messaging, notifications
|
|
288
|
+
• Data & Analytics — dashboards, reporting, databases, BI tools
|
|
289
|
+
• Development tools — code repositories, CI/CD, issue trackers, monitoring
|
|
290
|
+
• Financial Services — accounting, invoicing, fintech (note: financial transaction execution is not permitted)
|
|
291
|
+
• Consumer Health — fitness, wellness, personal health tracking
|
|
292
|
+
• Health & Life Sciences — clinical, pharma, medical professional tools
|
|
293
|
+
• Media & Entertainment — content, publishing, streaming
|
|
294
|
+
• Commerce & Shopping — e-commerce, inventory, orders
|
|
295
|
+
Multiple categories are allowed if genuinely applicable.`),
|
|
296
|
+
sponsoredContentsOrAdvertisement: claudeSponsoredContentSchema.describe(`Be honest here — advertising is not permitted in the Connectors Directory per Anthropic's policy. Select the option that accurately describes your server:
|
|
297
|
+
• 'No, there is no sponsored content or advertisements' — the results your server returns are not influenced by paid placement or sponsorship. This is what almost all connectors should select.
|
|
298
|
+
• 'Yes, there are banner ads or other paid visual elements' — your UI includes visual ads. NOTE: this will likely lead to rejection, as Anthropic prohibits advertising in Claude.
|
|
299
|
+
• 'Yes, the returned content or ranking of returned content is impacted by sponsorship or ad placement' — paid results affect what you return. NOTE: this also likely leads to rejection.
|
|
300
|
+
If your server returns organic results from a platform that has ads in its own UI (but your API results are not affected by ads), select 'No'.`),
|
|
301
|
+
transportSupport: z.array(claudeTransportSchema).describe(`Select all transport protocols your server supports:
|
|
302
|
+
• 'Streamable HTTP' — the modern, recommended transport. Anthropic strongly recommends implementing this. This is the future-proof option and should be your default.
|
|
303
|
+
• '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.
|
|
304
|
+
If you support both, select both. If you're building from scratch, implement Streamable HTTP only.`),
|
|
305
|
+
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:
|
|
306
|
+
• What the connector does and its key capabilities
|
|
307
|
+
• How to connect/set it up (step by step)
|
|
308
|
+
• What each tool does (or at least the main ones)
|
|
309
|
+
• How to troubleshoot common issues
|
|
310
|
+
• A support contact or channel
|
|
311
|
+
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.`),
|
|
312
|
+
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:
|
|
313
|
+
• What data you collect (and how)
|
|
314
|
+
• How you use the collected data
|
|
315
|
+
• Where and how long you store it
|
|
316
|
+
• Whether you share data with third parties (and who)
|
|
317
|
+
• How users can contact you about data concerns
|
|
318
|
+
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.`),
|
|
319
|
+
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:
|
|
320
|
+
• Email address (e.g. support@myapp.com)
|
|
321
|
+
• Link to a GitHub Issues page
|
|
322
|
+
• Link to a help center or support article
|
|
323
|
+
• Link to a Discord/Slack community
|
|
324
|
+
• Link to your documentation's troubleshooting section
|
|
325
|
+
Also uses this to notify you of security or compliance issues, so make sure it's actively monitored.`),
|
|
326
|
+
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:
|
|
327
|
+
• The account must have sample/demo data loaded — reviewers need to actually test your tools with real data.
|
|
328
|
+
• No 2FA — reviewers can't receive SMS codes. Disable 2FA on this account.
|
|
329
|
+
• 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.
|
|
330
|
+
• Credentials must remain valid for at least 30 days from submission.
|
|
331
|
+
• If your service requires API keys instead of a password, provide those.
|
|
332
|
+
Format suggestion: Username/email: xxx | Password: xxx | Any other notes`),
|
|
333
|
+
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.
|
|
334
|
+
Example: list_issues (List Issues), create_issue (Create Issue), update_issue (Update Issue), delete_issue (Delete Issue), search_issues (Search Issues)
|
|
335
|
+
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.`),
|
|
336
|
+
toolTitlesAnnotationsConfirmed: z.boolean().describe(`This is a compliance confirmation — check both boxes only if you have actually implemented these in your server code:
|
|
337
|
+
• 'I've specified user-friendly titles for all tools' — every tool has a 'title' annotation (a human-readable label, different from the tool name).
|
|
338
|
+
• '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).
|
|
339
|
+
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.`),
|
|
340
|
+
logoLight: z.string().describe(`Your connector's logo as displayed in the directory. Requirements:
|
|
341
|
+
• Format: SVG only
|
|
342
|
+
• Aspect ratio: square (1:1)
|
|
343
|
+
• Should work on both light and dark backgrounds (or you can provide separate light/dark versions)
|
|
344
|
+
• Provide via URL (Google Drive link is fine) or upload directly
|
|
345
|
+
Tip: use a simple, recognizable icon — not a full wordmark. The logo appears at small sizes in the directory grid.`),
|
|
346
|
+
screenshots: z.array(z.url()).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:
|
|
347
|
+
• 3–5 images is ideal
|
|
348
|
+
• Minimum 1000px width, PNG format preferred
|
|
349
|
+
• Crop to just the relevant part of the Claude interface (the tool response area)
|
|
350
|
+
• Show your connector doing something impressive and useful — real data, real results
|
|
351
|
+
• If you're an MCP App, include screenshots of your interactive UI elements
|
|
352
|
+
• Videos are also welcome
|
|
353
|
+
These images appear in your directory listing and are a key factor in driving user installs.`)
|
|
354
|
+
});
|
|
355
|
+
claudeSubmissionFormDataSchema.pick({
|
|
356
|
+
companyName: true,
|
|
357
|
+
appName: true,
|
|
358
|
+
mcpUrlType: true,
|
|
359
|
+
serverUrl: true,
|
|
360
|
+
tools: true,
|
|
361
|
+
readWriteCapabilities: true,
|
|
362
|
+
isMcpApp: true,
|
|
363
|
+
transportSupport: true,
|
|
364
|
+
primaryContactEmail: true,
|
|
365
|
+
primaryContactName: true
|
|
366
|
+
});
|
|
367
|
+
claudeSubmissionFormDataSchema.pick({
|
|
368
|
+
tagline: true,
|
|
369
|
+
description: true,
|
|
370
|
+
categories: true,
|
|
371
|
+
testCases: true
|
|
372
|
+
});
|
|
373
|
+
const submissionMetaFieldsSchema = z.object({
|
|
374
|
+
id: z.string(),
|
|
375
|
+
environmentId: z.string(),
|
|
376
|
+
createdAt: z.coerce.date(),
|
|
377
|
+
updatedAt: z.coerce.date()
|
|
378
|
+
});
|
|
379
|
+
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
380
|
+
platform: z.literal("claudeai"),
|
|
381
|
+
formData: claudeSubmissionFormDataSchema.partial()
|
|
382
|
+
});
|
|
383
|
+
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
384
|
+
platform: z.literal("chatgpt"),
|
|
385
|
+
formData: chatgptSubmissionFormDataSchema.partial()
|
|
386
|
+
});
|
|
387
|
+
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
388
|
+
z.union([claudeSubmissionFormDataSchema.partial(), chatgptSubmissionFormDataSchema.partial()]);
|
|
389
|
+
const subscriptionPlanSchema = z.enum([
|
|
390
|
+
"pro",
|
|
391
|
+
"business",
|
|
392
|
+
"enterprise"
|
|
393
|
+
]);
|
|
394
|
+
z.object({ plan: subscriptionPlanSchema.nullable() });
|
|
395
|
+
//#endregion
|
|
4
396
|
//#region src/schemas.ts
|
|
5
397
|
const RESERVED_KEYS = [
|
|
6
398
|
"_HANDLER",
|
|
@@ -36,7 +428,7 @@ const RESERVED_KEYS = [
|
|
|
36
428
|
"BUILD_ARG_START_COMMAND",
|
|
37
429
|
"ALPIC_HOST",
|
|
38
430
|
"ALPIC_CUSTOM_DOMAINS",
|
|
39
|
-
"
|
|
431
|
+
"ALPIC_INTENT_META_KEY"
|
|
40
432
|
];
|
|
41
433
|
const environmentVariableSchema = z.object({
|
|
42
434
|
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"),
|
|
@@ -65,71 +457,6 @@ const transportSchema = z.enum([
|
|
|
65
457
|
"sse",
|
|
66
458
|
"streamablehttp"
|
|
67
459
|
]);
|
|
68
|
-
const auditStatusSchema = z.enum([
|
|
69
|
-
"pending",
|
|
70
|
-
"partial",
|
|
71
|
-
"completed",
|
|
72
|
-
"failed"
|
|
73
|
-
]);
|
|
74
|
-
const platformSchema = z.enum(["chatgpt", "claudeai"]);
|
|
75
|
-
const checkSeveritySchema = z.enum([
|
|
76
|
-
"error",
|
|
77
|
-
"warning",
|
|
78
|
-
"info"
|
|
79
|
-
]);
|
|
80
|
-
const checkCategorySchema = z.enum([
|
|
81
|
-
"connectivity",
|
|
82
|
-
"tool-metadata",
|
|
83
|
-
"resource-metadata",
|
|
84
|
-
"performance",
|
|
85
|
-
"e2e"
|
|
86
|
-
]);
|
|
87
|
-
const checkScopeSchema = z.enum(["server", "view"]);
|
|
88
|
-
const checkDetailSchema = z.object({
|
|
89
|
-
label: z.string(),
|
|
90
|
-
value: z.string().optional()
|
|
91
|
-
});
|
|
92
|
-
const checkResultSchema = z.object({
|
|
93
|
-
checkId: z.string(),
|
|
94
|
-
checkName: z.string(),
|
|
95
|
-
description: z.string(),
|
|
96
|
-
status: z.enum([
|
|
97
|
-
"pass",
|
|
98
|
-
"fail",
|
|
99
|
-
"skip",
|
|
100
|
-
"pending"
|
|
101
|
-
]),
|
|
102
|
-
message: z.string(),
|
|
103
|
-
skipReason: z.string().optional(),
|
|
104
|
-
severity: checkSeveritySchema,
|
|
105
|
-
category: checkCategorySchema,
|
|
106
|
-
scope: checkScopeSchema,
|
|
107
|
-
platforms: z.array(platformSchema).readonly().optional(),
|
|
108
|
-
durationMs: z.number(),
|
|
109
|
-
details: z.array(checkDetailSchema).optional(),
|
|
110
|
-
hint: z.object({ text: z.string() }).optional()
|
|
111
|
-
});
|
|
112
|
-
const auditReportSchema = z.object({
|
|
113
|
-
schemaVersion: z.string(),
|
|
114
|
-
auditId: z.string(),
|
|
115
|
-
targetUrl: z.string(),
|
|
116
|
-
startedAt: z.string(),
|
|
117
|
-
completedAt: z.string(),
|
|
118
|
-
durationMs: z.number(),
|
|
119
|
-
results: z.array(checkResultSchema),
|
|
120
|
-
requiresAuth: z.boolean(),
|
|
121
|
-
hasViewSupport: z.boolean(),
|
|
122
|
-
viewPlatforms: z.array(platformSchema).readonly().optional(),
|
|
123
|
-
isReadyForPlatform: z.record(platformSchema, z.boolean()),
|
|
124
|
-
widgetScreenshotKeys: z.object({
|
|
125
|
-
chatgpt: z.string().optional(),
|
|
126
|
-
claudeai: z.string().optional()
|
|
127
|
-
}).optional(),
|
|
128
|
-
widgetScreenshots: z.object({
|
|
129
|
-
chatgpt: z.object({ url: z.string() }).optional(),
|
|
130
|
-
claudeai: z.object({ url: z.string() }).optional()
|
|
131
|
-
}).optional()
|
|
132
|
-
});
|
|
133
460
|
const playgroundHeaderSchema = z.object({
|
|
134
461
|
name: z.string().min(1).max(100),
|
|
135
462
|
description: z.string().max(200),
|
|
@@ -694,7 +1021,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
694
1021
|
NOT_FOUND: {},
|
|
695
1022
|
BAD_REQUEST: {}
|
|
696
1023
|
}).input(z.object({
|
|
697
|
-
targetUrl: z.
|
|
1024
|
+
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
698
1025
|
teamId: z.string().optional().describe("The team ID to associate the audit with"),
|
|
699
1026
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
700
1027
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
@@ -712,7 +1039,7 @@ const getBeaconContractV1 = oc.route({
|
|
|
712
1039
|
status: auditStatusSchema,
|
|
713
1040
|
durationMs: z.number().nullable(),
|
|
714
1041
|
createdAt: z.coerce.date(),
|
|
715
|
-
report:
|
|
1042
|
+
report: auditReportWithScreenshotsSchema.nullable()
|
|
716
1043
|
}));
|
|
717
1044
|
const contract = {
|
|
718
1045
|
teams: { list: { v1: listTeamsContractV1 } },
|
|
@@ -758,4 +1085,4 @@ const contract = {
|
|
|
758
1085
|
}
|
|
759
1086
|
};
|
|
760
1087
|
//#endregion
|
|
761
|
-
export {
|
|
1088
|
+
export { PLATFORM_LABELS, buildSettingsSchema, contract, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alpic-ai/api",
|
|
3
|
-
"version": "0.0.0-staging.
|
|
3
|
+
"version": "0.0.0-staging.c6b023d",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -14,20 +14,32 @@
|
|
|
14
14
|
"files": [
|
|
15
15
|
"dist"
|
|
16
16
|
],
|
|
17
|
+
"nx": {
|
|
18
|
+
"targets": {
|
|
19
|
+
"build": {
|
|
20
|
+
"dependsOn": [
|
|
21
|
+
"^build"
|
|
22
|
+
]
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
},
|
|
17
26
|
"author": "Alpic",
|
|
18
27
|
"license": "ISC",
|
|
19
28
|
"dependencies": {
|
|
20
|
-
"@orpc/contract": "^1.
|
|
29
|
+
"@orpc/contract": "^1.14.3",
|
|
21
30
|
"ms": "^2.1.3",
|
|
22
|
-
"zod": "^4.3
|
|
31
|
+
"zod": "^4.4.3"
|
|
23
32
|
},
|
|
24
33
|
"devDependencies": {
|
|
34
|
+
"@orpc/openapi": "^1.14.3",
|
|
35
|
+
"@orpc/zod": "^1.14.3",
|
|
25
36
|
"@total-typescript/tsconfig": "^1.0.4",
|
|
26
37
|
"@types/ms": "^2.1.0",
|
|
27
38
|
"shx": "^0.4.0",
|
|
28
|
-
"tsdown": "^0.
|
|
39
|
+
"tsdown": "^0.22.0",
|
|
29
40
|
"typescript": "^6.0.3",
|
|
30
|
-
"vitest": "^4.1.
|
|
41
|
+
"vitest": "^4.1.6",
|
|
42
|
+
"@alpic-ai/domains": "0.0.0"
|
|
31
43
|
},
|
|
32
44
|
"scripts": {
|
|
33
45
|
"build": "shx rm -rf dist && tsdown",
|