@m6d/cortex-cli 0.20.0 → 0.21.0
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/README.md +3 -3
- package/package.json +1 -1
- package/src/commands/new.ts +4 -4
- package/src/commands/setup.ts +19 -10
- package/src/contracts/management/procedures.generated.ts +345 -162
- package/src/contracts/manifest/index.ts +62 -91
- package/src/contracts/server/index.ts +33 -9
- package/src/contracts/triggers/index.ts +9 -9
- package/src/contracts/wire/index.ts +11 -0
- package/src/scaffold/files.ts +11 -13
|
@@ -299,6 +299,7 @@ export const managementProcedureKinds = {
|
|
|
299
299
|
"secrets.names": "query",
|
|
300
300
|
"secrets.rotate": "mutation",
|
|
301
301
|
"secrets.set": "mutation",
|
|
302
|
+
"secrets.update": "mutation",
|
|
302
303
|
"servers.create": "mutation",
|
|
303
304
|
"servers.delete": "mutation",
|
|
304
305
|
"servers.get": "query",
|
|
@@ -379,9 +380,10 @@ export const managementProcedureKinds = {
|
|
|
379
380
|
|
|
380
381
|
/** Each procedure's input, as it is sent, and output, as JSON carries it. */
|
|
381
382
|
export type ManagementProcedures = {
|
|
382
|
-
/** Give an agent an alias: a second
|
|
383
|
+
/** Give an agent an alias: a second name it answers to wherever a name is resolved. Refused (name_taken) when an agent's name or another alias holds the name; to move an alias, delete it and add it to the other agent. */
|
|
383
384
|
"agents.addAlias": {
|
|
384
385
|
input: {
|
|
386
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
385
387
|
alias: string;
|
|
386
388
|
agentId: string;
|
|
387
389
|
};
|
|
@@ -395,8 +397,9 @@ export type ManagementProcedures = {
|
|
|
395
397
|
/** Create an agent on a registered server, or on none (`serverId` null), fixed for good either way. An agent with no server has no native tools, no server variables and no server auth, and publishes only on a chat model of its own. The draft has no prompt yet; save one with agents.savePrompt before publishing. */
|
|
396
398
|
"agents.create": {
|
|
397
399
|
input: {
|
|
398
|
-
|
|
400
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
399
401
|
name: string;
|
|
402
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
400
403
|
serverId: string | null;
|
|
401
404
|
};
|
|
402
405
|
output: {
|
|
@@ -405,9 +408,9 @@ export type ManagementProcedures = {
|
|
|
405
408
|
sourceId: string | null;
|
|
406
409
|
overridable: Array<string>;
|
|
407
410
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
408
|
-
slug: string;
|
|
409
|
-
serverId: string | null;
|
|
410
411
|
name: string;
|
|
412
|
+
serverId: string | null;
|
|
413
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
411
414
|
promptDraft: string;
|
|
412
415
|
ragEnabled: boolean;
|
|
413
416
|
toolRegistryEnabled: boolean;
|
|
@@ -450,9 +453,9 @@ export type ManagementProcedures = {
|
|
|
450
453
|
sourceId: string | null;
|
|
451
454
|
overridable: Array<string>;
|
|
452
455
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
453
|
-
slug: string;
|
|
454
|
-
serverId: string | null;
|
|
455
456
|
name: string;
|
|
457
|
+
serverId: string | null;
|
|
458
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
456
459
|
promptDraft: string;
|
|
457
460
|
ragEnabled: boolean;
|
|
458
461
|
toolRegistryEnabled: boolean;
|
|
@@ -486,6 +489,7 @@ export type ManagementProcedures = {
|
|
|
486
489
|
/** Remove an alias. */
|
|
487
490
|
"agents.deleteAlias": {
|
|
488
491
|
input: {
|
|
492
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
489
493
|
alias: string;
|
|
490
494
|
};
|
|
491
495
|
output: {
|
|
@@ -506,9 +510,9 @@ export type ManagementProcedures = {
|
|
|
506
510
|
sourceId: string | null;
|
|
507
511
|
overridable: Array<string>;
|
|
508
512
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
509
|
-
slug: string;
|
|
510
|
-
serverId: string | null;
|
|
511
513
|
name: string;
|
|
514
|
+
serverId: string | null;
|
|
515
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
512
516
|
promptDraft: string;
|
|
513
517
|
ragEnabled: boolean;
|
|
514
518
|
toolRegistryEnabled: boolean;
|
|
@@ -535,7 +539,10 @@ export type ManagementProcedures = {
|
|
|
535
539
|
summarizationModel: string | null;
|
|
536
540
|
context: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
537
541
|
limits: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
538
|
-
|
|
542
|
+
server: {
|
|
543
|
+
name: string;
|
|
544
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
545
|
+
} | null;
|
|
539
546
|
serverVerifies: boolean;
|
|
540
547
|
variables: Array<{
|
|
541
548
|
name: string;
|
|
@@ -566,13 +573,16 @@ export type ManagementProcedures = {
|
|
|
566
573
|
output: {
|
|
567
574
|
items: Array<{
|
|
568
575
|
id: string;
|
|
569
|
-
slug: string;
|
|
570
576
|
name: string;
|
|
577
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
571
578
|
updatedAt: string;
|
|
572
579
|
source: "direct" | "manifest" | "server";
|
|
573
580
|
sourceId: string | null;
|
|
574
581
|
overridable: Array<string>;
|
|
575
|
-
|
|
582
|
+
server: {
|
|
583
|
+
name: string;
|
|
584
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
585
|
+
} | null;
|
|
576
586
|
published: boolean;
|
|
577
587
|
toolCount: number;
|
|
578
588
|
serviceCount: number;
|
|
@@ -585,7 +595,7 @@ export type ManagementProcedures = {
|
|
|
585
595
|
filteredCount: number;
|
|
586
596
|
};
|
|
587
597
|
};
|
|
588
|
-
/** List an agent's aliases (second
|
|
598
|
+
/** List an agent's aliases (second names, unique across the deployment beside every agent's own), with pagination. */
|
|
589
599
|
"agents.listAliases": {
|
|
590
600
|
input: {
|
|
591
601
|
pageIndex?: number;
|
|
@@ -606,13 +616,13 @@ export type ManagementProcedures = {
|
|
|
606
616
|
filteredCount: number;
|
|
607
617
|
};
|
|
608
618
|
};
|
|
609
|
-
/** Agent
|
|
619
|
+
/** Agent ids, names and display names for selectors. */
|
|
610
620
|
"agents.options": {
|
|
611
621
|
input: undefined;
|
|
612
622
|
output: Array<{
|
|
613
623
|
id: string;
|
|
614
|
-
slug: string;
|
|
615
624
|
name: string;
|
|
625
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
616
626
|
serverId: string | null;
|
|
617
627
|
}>;
|
|
618
628
|
};
|
|
@@ -666,9 +676,9 @@ export type ManagementProcedures = {
|
|
|
666
676
|
sourceId: string | null;
|
|
667
677
|
overridable: Array<string>;
|
|
668
678
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
669
|
-
slug: string;
|
|
670
|
-
serverId: string | null;
|
|
671
679
|
name: string;
|
|
680
|
+
serverId: string | null;
|
|
681
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
672
682
|
promptDraft: string;
|
|
673
683
|
ragEnabled: boolean;
|
|
674
684
|
toolRegistryEnabled: boolean;
|
|
@@ -776,9 +786,9 @@ export type ManagementProcedures = {
|
|
|
776
786
|
sourceId: string | null;
|
|
777
787
|
overridable: Array<string>;
|
|
778
788
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
779
|
-
slug: string;
|
|
780
|
-
serverId: string | null;
|
|
781
789
|
name: string;
|
|
790
|
+
serverId: string | null;
|
|
791
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
782
792
|
promptDraft: string;
|
|
783
793
|
ragEnabled: boolean;
|
|
784
794
|
toolRegistryEnabled: boolean;
|
|
@@ -809,11 +819,11 @@ export type ManagementProcedures = {
|
|
|
809
819
|
updatedAt: string;
|
|
810
820
|
};
|
|
811
821
|
};
|
|
812
|
-
/**
|
|
822
|
+
/** Set an agent's display name, a text per locale. It applies at once; it is not part of the published prompt. */
|
|
813
823
|
"agents.update": {
|
|
814
824
|
input: {
|
|
815
825
|
id: string;
|
|
816
|
-
|
|
826
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
817
827
|
};
|
|
818
828
|
output: {
|
|
819
829
|
id: string;
|
|
@@ -821,9 +831,9 @@ export type ManagementProcedures = {
|
|
|
821
831
|
sourceId: string | null;
|
|
822
832
|
overridable: Array<string>;
|
|
823
833
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
824
|
-
slug: string;
|
|
825
|
-
serverId: string | null;
|
|
826
834
|
name: string;
|
|
835
|
+
serverId: string | null;
|
|
836
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
827
837
|
promptDraft: string;
|
|
828
838
|
ragEnabled: boolean;
|
|
829
839
|
toolRegistryEnabled: boolean;
|
|
@@ -883,9 +893,15 @@ export type ManagementProcedures = {
|
|
|
883
893
|
createdAt: string;
|
|
884
894
|
actorName: string;
|
|
885
895
|
actorEmail: string;
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
896
|
+
entity: {
|
|
897
|
+
name: string;
|
|
898
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
899
|
+
} | null;
|
|
900
|
+
managementKey: {
|
|
901
|
+
name: string;
|
|
902
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
903
|
+
fingerprint: string;
|
|
904
|
+
} | null;
|
|
889
905
|
before: unknown;
|
|
890
906
|
after: unknown;
|
|
891
907
|
};
|
|
@@ -914,9 +930,15 @@ export type ManagementProcedures = {
|
|
|
914
930
|
createdAt: string;
|
|
915
931
|
actorName: string;
|
|
916
932
|
actorEmail: string;
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
933
|
+
entity: {
|
|
934
|
+
name: string;
|
|
935
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
936
|
+
} | null;
|
|
937
|
+
managementKey: {
|
|
938
|
+
name: string;
|
|
939
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
940
|
+
fingerprint: string;
|
|
941
|
+
} | null;
|
|
920
942
|
}>;
|
|
921
943
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
922
944
|
count: number;
|
|
@@ -924,10 +946,12 @@ export type ManagementProcedures = {
|
|
|
924
946
|
filteredCount: number;
|
|
925
947
|
};
|
|
926
948
|
};
|
|
927
|
-
/** Create a knowledge collection with an audience ({ kind: "all" }, { kind: "server", serverId }, or { kind: "agents", agentIds }). Documents are uploaded into it; a service tag scopes every document to that service. */
|
|
949
|
+
/** Create a knowledge collection with a display name (a text per locale, `{}` for none) and an audience ({ kind: "all" }, { kind: "server", serverId }, or { kind: "agents", agentIds }). Documents are uploaded into it; a service tag scopes every document to that service. */
|
|
928
950
|
"collections.create": {
|
|
929
951
|
input: {
|
|
952
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
930
953
|
name: string;
|
|
954
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
931
955
|
description: string;
|
|
932
956
|
serviceId: string | null;
|
|
933
957
|
citable: boolean;
|
|
@@ -968,6 +992,7 @@ export type ManagementProcedures = {
|
|
|
968
992
|
citable: boolean;
|
|
969
993
|
createdAt: string;
|
|
970
994
|
updatedAt: string;
|
|
995
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
971
996
|
source: "direct" | "manifest" | "server";
|
|
972
997
|
sourceId: string | null;
|
|
973
998
|
overridable: Array<string>;
|
|
@@ -981,9 +1006,10 @@ export type ManagementProcedures = {
|
|
|
981
1006
|
agentIds: Array<string>;
|
|
982
1007
|
};
|
|
983
1008
|
referrers: Array<{
|
|
1009
|
+
name: string;
|
|
1010
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
984
1011
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
985
1012
|
id: string;
|
|
986
|
-
name: string;
|
|
987
1013
|
readers: {
|
|
988
1014
|
kind: "all";
|
|
989
1015
|
} | {
|
|
@@ -994,7 +1020,10 @@ export type ManagementProcedures = {
|
|
|
994
1020
|
agentIds: Array<string>;
|
|
995
1021
|
};
|
|
996
1022
|
}>;
|
|
997
|
-
|
|
1023
|
+
service: {
|
|
1024
|
+
name: string;
|
|
1025
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1026
|
+
} | null;
|
|
998
1027
|
};
|
|
999
1028
|
};
|
|
1000
1029
|
/** List knowledge collections with pagination and search, optionally the ones an agent sees or the ones reaching a server. */
|
|
@@ -1015,6 +1044,7 @@ export type ManagementProcedures = {
|
|
|
1015
1044
|
description: string;
|
|
1016
1045
|
serviceId: string | null;
|
|
1017
1046
|
updatedAt: string;
|
|
1047
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1018
1048
|
source: "direct" | "manifest" | "server";
|
|
1019
1049
|
sourceId: string | null;
|
|
1020
1050
|
overridable: Array<string>;
|
|
@@ -1027,7 +1057,10 @@ export type ManagementProcedures = {
|
|
|
1027
1057
|
kind: "agents";
|
|
1028
1058
|
agentIds: Array<string>;
|
|
1029
1059
|
};
|
|
1030
|
-
|
|
1060
|
+
service: {
|
|
1061
|
+
name: string;
|
|
1062
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1063
|
+
} | null;
|
|
1031
1064
|
documentCount: number;
|
|
1032
1065
|
}>;
|
|
1033
1066
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
@@ -1087,10 +1120,10 @@ export type ManagementProcedures = {
|
|
|
1087
1120
|
};
|
|
1088
1121
|
}>;
|
|
1089
1122
|
};
|
|
1090
|
-
/**
|
|
1123
|
+
/** Set a knowledge collection's display name, describe it or change its service tag. A tag change applies to agents at once. */
|
|
1091
1124
|
"collections.update": {
|
|
1092
1125
|
input: {
|
|
1093
|
-
|
|
1126
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1094
1127
|
description: string;
|
|
1095
1128
|
serviceId: string | null;
|
|
1096
1129
|
citable: boolean;
|
|
@@ -1101,19 +1134,22 @@ export type ManagementProcedures = {
|
|
|
1101
1134
|
name: string;
|
|
1102
1135
|
};
|
|
1103
1136
|
};
|
|
1104
|
-
/** Create a named credential over a stored secret: `static` presents the secret's value; `oauth2-client-credentials` exchanges it, as the client secret of `clientId`, for a bearer at `tokenUrl` (https, or http on loopback or on a host `EGRESS_ALLOWED_HOSTS` admits). A credential's name and kind never change. Needs `secrets:write` too: whatever presents the credential sends its secret. */
|
|
1137
|
+
/** Create a named credential, with a display name (a text per locale, `{}` for none), over a stored secret: `static` presents the secret's value; `oauth2-client-credentials` exchanges it, as the client secret of `clientId`, for a bearer at `tokenUrl` (https, or http on loopback or on a host `EGRESS_ALLOWED_HOSTS` admits). A credential's name and kind never change. Needs `secrets:write` too: whatever presents the credential sends its secret. */
|
|
1105
1138
|
"credentials.create": {
|
|
1106
1139
|
input: {
|
|
1140
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1107
1141
|
kind: "static" | "oauth2-client-credentials";
|
|
1108
1142
|
secretName: string;
|
|
1109
1143
|
tokenUrl: string;
|
|
1110
1144
|
clientId: string;
|
|
1111
1145
|
scope: string;
|
|
1146
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
1112
1147
|
name: string;
|
|
1113
1148
|
};
|
|
1114
1149
|
output: {
|
|
1115
1150
|
id: string;
|
|
1116
1151
|
name: string;
|
|
1152
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1117
1153
|
kind: "static" | "oauth2-client-credentials";
|
|
1118
1154
|
secretName: string;
|
|
1119
1155
|
tokenUrl: string | null;
|
|
@@ -1131,6 +1167,7 @@ export type ManagementProcedures = {
|
|
|
1131
1167
|
output: {
|
|
1132
1168
|
id: string;
|
|
1133
1169
|
name: string;
|
|
1170
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1134
1171
|
kind: "static" | "oauth2-client-credentials";
|
|
1135
1172
|
secretName: string;
|
|
1136
1173
|
tokenUrl: string | null;
|
|
@@ -1140,7 +1177,7 @@ export type ManagementProcedures = {
|
|
|
1140
1177
|
updatedAt: string;
|
|
1141
1178
|
};
|
|
1142
1179
|
};
|
|
1143
|
-
/** List credentials with pagination and search: the name tools, dataset hosts and triggers reference, its kind, the secret it composes, and how many rows name it with the first few (`usedBy`). */
|
|
1180
|
+
/** List credentials with pagination and search: the name tools, dataset hosts and triggers reference, its display name, its kind, the secret it composes, and how many rows name it with the first few (`usedBy`). */
|
|
1144
1181
|
"credentials.list": {
|
|
1145
1182
|
input: {
|
|
1146
1183
|
pageIndex?: number;
|
|
@@ -1151,6 +1188,7 @@ export type ManagementProcedures = {
|
|
|
1151
1188
|
items: Array<{
|
|
1152
1189
|
id: string;
|
|
1153
1190
|
name: string;
|
|
1191
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1154
1192
|
kind: "static" | "oauth2-client-credentials";
|
|
1155
1193
|
secretName: string;
|
|
1156
1194
|
tokenUrl: string | null;
|
|
@@ -1161,9 +1199,10 @@ export type ManagementProcedures = {
|
|
|
1161
1199
|
usedBy: {
|
|
1162
1200
|
count: number;
|
|
1163
1201
|
preview: Array<{
|
|
1202
|
+
name: string;
|
|
1203
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1164
1204
|
kind: "credential" | "model_provider" | "server" | "agent" | "tool" | "trigger" | "dataset_host" | "webhook" | "mcp_server";
|
|
1165
1205
|
id: string;
|
|
1166
|
-
name: string;
|
|
1167
1206
|
}>;
|
|
1168
1207
|
};
|
|
1169
1208
|
}>;
|
|
@@ -1173,16 +1212,20 @@ export type ManagementProcedures = {
|
|
|
1173
1212
|
filteredCount: number;
|
|
1174
1213
|
};
|
|
1175
1214
|
};
|
|
1176
|
-
/**
|
|
1215
|
+
/** Each credential's name and display name, in name order, for a picker. `present`: what a tool, dataset host, webhook or trigger run may present upstream (every credential but a trigger's fire credential). `fire`: what a trigger may be fired with (static credentials). */
|
|
1177
1216
|
"credentials.names": {
|
|
1178
1217
|
input: {
|
|
1179
1218
|
use: "present" | "fire";
|
|
1180
1219
|
};
|
|
1181
|
-
output: Array<
|
|
1220
|
+
output: Array<{
|
|
1221
|
+
name: string;
|
|
1222
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1223
|
+
}>;
|
|
1182
1224
|
};
|
|
1183
|
-
/** Change the secret
|
|
1225
|
+
/** Change a credential's display name, the secret it composes and, for an OAuth2 one, its token URL, client id and scope. Applies to the next call of every tool, dataset host and trigger naming it. Changing the secret or the token URL needs `secrets:write` too (`secret_binding_forbidden`): either sends a stored secret somewhere new. */
|
|
1184
1226
|
"credentials.update": {
|
|
1185
1227
|
input: {
|
|
1228
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1186
1229
|
kind: "static" | "oauth2-client-credentials";
|
|
1187
1230
|
secretName: string;
|
|
1188
1231
|
tokenUrl: string;
|
|
@@ -1193,6 +1236,7 @@ export type ManagementProcedures = {
|
|
|
1193
1236
|
output: {
|
|
1194
1237
|
id: string;
|
|
1195
1238
|
name: string;
|
|
1239
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1196
1240
|
kind: "static" | "oauth2-client-credentials";
|
|
1197
1241
|
secretName: string;
|
|
1198
1242
|
tokenUrl: string | null;
|
|
@@ -1207,6 +1251,7 @@ export type ManagementProcedures = {
|
|
|
1207
1251
|
input: {
|
|
1208
1252
|
name: string;
|
|
1209
1253
|
url: string;
|
|
1254
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1210
1255
|
audience: {
|
|
1211
1256
|
kind: "all";
|
|
1212
1257
|
} | {
|
|
@@ -1252,6 +1297,7 @@ export type ManagementProcedures = {
|
|
|
1252
1297
|
agentIds: Array<string>;
|
|
1253
1298
|
};
|
|
1254
1299
|
name: string;
|
|
1300
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1255
1301
|
url: string;
|
|
1256
1302
|
headers: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
1257
1303
|
timeoutMs: number;
|
|
@@ -1284,9 +1330,10 @@ export type ManagementProcedures = {
|
|
|
1284
1330
|
revision: number;
|
|
1285
1331
|
updatedAt: string;
|
|
1286
1332
|
referrers: Array<{
|
|
1333
|
+
name: string;
|
|
1334
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1287
1335
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
1288
1336
|
id: string;
|
|
1289
|
-
name: string;
|
|
1290
1337
|
readers: {
|
|
1291
1338
|
kind: "all";
|
|
1292
1339
|
} | {
|
|
@@ -1297,7 +1344,6 @@ export type ManagementProcedures = {
|
|
|
1297
1344
|
agentIds: Array<string>;
|
|
1298
1345
|
};
|
|
1299
1346
|
}>;
|
|
1300
|
-
nameLocked: boolean;
|
|
1301
1347
|
variables: Array<{
|
|
1302
1348
|
name: string;
|
|
1303
1349
|
description: string;
|
|
@@ -1327,6 +1373,7 @@ export type ManagementProcedures = {
|
|
|
1327
1373
|
manifestVersion: string | null;
|
|
1328
1374
|
syncedAt: string | null;
|
|
1329
1375
|
expose: Array<string>;
|
|
1376
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1330
1377
|
source: "direct" | "manifest" | "server";
|
|
1331
1378
|
sourceId: string | null;
|
|
1332
1379
|
overridable: Array<string>;
|
|
@@ -1462,7 +1509,6 @@ export type ManagementProcedures = {
|
|
|
1462
1509
|
/** Update a dataset host's draft: which synced datasets the agent may query (`expose`) and which are listed in every turn (`pinned`). Saved as a draft; call the entity's publish procedure to make it live. The url, headers (each with a prefix and its value from a credential, the run token, a variable or a constant), timeout, and `rateLimits` (queries per minute for all users and per user, null for no limit) apply live without a publish. */
|
|
1463
1510
|
"datasetHosts.update": {
|
|
1464
1511
|
input: {
|
|
1465
|
-
name: string;
|
|
1466
1512
|
url: string;
|
|
1467
1513
|
headers: Array<{
|
|
1468
1514
|
header: string;
|
|
@@ -1492,6 +1538,7 @@ export type ManagementProcedures = {
|
|
|
1492
1538
|
expose: Array<string>;
|
|
1493
1539
|
pinned: Array<string>;
|
|
1494
1540
|
id: string;
|
|
1541
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1495
1542
|
};
|
|
1496
1543
|
output: {
|
|
1497
1544
|
id: string;
|
|
@@ -1636,7 +1683,7 @@ export type ManagementProcedures = {
|
|
|
1636
1683
|
updatedAt: string;
|
|
1637
1684
|
};
|
|
1638
1685
|
};
|
|
1639
|
-
/** The caller's live management keys with pagination and search: name, fingerprint, scope, and dates. Never the key itself. */
|
|
1686
|
+
/** The caller's live management keys in name order, with pagination and search: name, display name, fingerprint, scope, and dates. Never the key itself. */
|
|
1640
1687
|
"managementKeys.list": {
|
|
1641
1688
|
input: {
|
|
1642
1689
|
pageIndex?: number;
|
|
@@ -1647,6 +1694,7 @@ export type ManagementProcedures = {
|
|
|
1647
1694
|
items: Array<{
|
|
1648
1695
|
id: string;
|
|
1649
1696
|
name: string;
|
|
1697
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1650
1698
|
fingerprint: string;
|
|
1651
1699
|
permissions: Array<string> | null;
|
|
1652
1700
|
lastUsedAt: string | null;
|
|
@@ -1659,12 +1707,13 @@ export type ManagementProcedures = {
|
|
|
1659
1707
|
filteredCount: number;
|
|
1660
1708
|
};
|
|
1661
1709
|
};
|
|
1662
|
-
/** The management key this request authenticated with (name, fingerprint, scope, dates). Refused for a session or an operator token, which are not keys. */
|
|
1710
|
+
/** The management key this request authenticated with (name, display name, fingerprint, scope, dates). Refused for a session or an operator token, which are not keys. */
|
|
1663
1711
|
"managementKeys.mine": {
|
|
1664
1712
|
input: undefined;
|
|
1665
1713
|
output: {
|
|
1666
1714
|
id: string;
|
|
1667
1715
|
name: string;
|
|
1716
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1668
1717
|
fingerprint: string;
|
|
1669
1718
|
permissions: Array<string> | null;
|
|
1670
1719
|
lastUsedAt: string | null;
|
|
@@ -1677,8 +1726,8 @@ export type ManagementProcedures = {
|
|
|
1677
1726
|
input: {
|
|
1678
1727
|
id: string;
|
|
1679
1728
|
agents?: Array<{
|
|
1680
|
-
slug: string;
|
|
1681
1729
|
name: string;
|
|
1730
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1682
1731
|
server?: string;
|
|
1683
1732
|
prompt: string;
|
|
1684
1733
|
auth: {
|
|
@@ -1755,11 +1804,12 @@ export type ManagementProcedures = {
|
|
|
1755
1804
|
prompt: string;
|
|
1756
1805
|
}>>;
|
|
1757
1806
|
greeting?: Record<"en" | "ar", string>;
|
|
1758
|
-
overridable?: Array<"
|
|
1807
|
+
overridable?: Array<"displayName" | "prompt" | "models" | "settings" | "rateLimits" | "suggestions" | "greeting">;
|
|
1759
1808
|
}>;
|
|
1760
1809
|
tools?: Array<{
|
|
1761
1810
|
name: string;
|
|
1762
1811
|
description: string;
|
|
1812
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1763
1813
|
inputSchema?: {
|
|
1764
1814
|
type: "object";
|
|
1765
1815
|
properties?: Record<string, ManifestsPreviewSchema0>;
|
|
@@ -1790,7 +1840,7 @@ export type ManagementProcedures = {
|
|
|
1790
1840
|
} | {
|
|
1791
1841
|
agents: Array<string>;
|
|
1792
1842
|
};
|
|
1793
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1843
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1794
1844
|
url: string;
|
|
1795
1845
|
headers?: Array<{
|
|
1796
1846
|
header: string;
|
|
@@ -1818,6 +1868,7 @@ export type ManagementProcedures = {
|
|
|
1818
1868
|
} | {
|
|
1819
1869
|
name: string;
|
|
1820
1870
|
description: string;
|
|
1871
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1821
1872
|
inputSchema?: {
|
|
1822
1873
|
type: "object";
|
|
1823
1874
|
properties?: Record<string, ManifestsPreviewSchema0>;
|
|
@@ -1848,7 +1899,7 @@ export type ManagementProcedures = {
|
|
|
1848
1899
|
} | {
|
|
1849
1900
|
agents: Array<string>;
|
|
1850
1901
|
};
|
|
1851
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1902
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1852
1903
|
url: string;
|
|
1853
1904
|
headers?: Array<{
|
|
1854
1905
|
header: string;
|
|
@@ -1873,6 +1924,7 @@ export type ManagementProcedures = {
|
|
|
1873
1924
|
} | {
|
|
1874
1925
|
name: string;
|
|
1875
1926
|
description: string;
|
|
1927
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1876
1928
|
inputSchema?: {
|
|
1877
1929
|
type: "object";
|
|
1878
1930
|
properties?: Record<string, ManifestsPreviewSchema0>;
|
|
@@ -1903,7 +1955,7 @@ export type ManagementProcedures = {
|
|
|
1903
1955
|
} | {
|
|
1904
1956
|
agents: Array<string>;
|
|
1905
1957
|
};
|
|
1906
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1958
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1907
1959
|
url: string;
|
|
1908
1960
|
headers?: Array<{
|
|
1909
1961
|
header: string;
|
|
@@ -1935,6 +1987,7 @@ export type ManagementProcedures = {
|
|
|
1935
1987
|
} | {
|
|
1936
1988
|
name: string;
|
|
1937
1989
|
description: string;
|
|
1990
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1938
1991
|
inputSchema?: {
|
|
1939
1992
|
type: "object";
|
|
1940
1993
|
properties?: Record<string, ManifestsPreviewSchema0>;
|
|
@@ -1965,7 +2018,7 @@ export type ManagementProcedures = {
|
|
|
1965
2018
|
} | {
|
|
1966
2019
|
agents: Array<string>;
|
|
1967
2020
|
};
|
|
1968
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags">;
|
|
2021
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags">;
|
|
1969
2022
|
type: "client";
|
|
1970
2023
|
}>;
|
|
1971
2024
|
openapi?: Array<{
|
|
@@ -1998,21 +2051,22 @@ export type ManagementProcedures = {
|
|
|
1998
2051
|
} | {
|
|
1999
2052
|
agents: Array<string>;
|
|
2000
2053
|
};
|
|
2001
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2054
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2002
2055
|
}>;
|
|
2003
2056
|
services?: Array<{
|
|
2004
|
-
|
|
2005
|
-
|
|
2057
|
+
name: string;
|
|
2058
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2006
2059
|
description: Record<"en" | "ar", string>;
|
|
2007
2060
|
audience: "all" | {
|
|
2008
2061
|
server: string;
|
|
2009
2062
|
} | {
|
|
2010
2063
|
agents: Array<string>;
|
|
2011
2064
|
};
|
|
2012
|
-
overridable?: Array<"description">;
|
|
2065
|
+
overridable?: Array<"displayName" | "description">;
|
|
2013
2066
|
}>;
|
|
2014
2067
|
skills?: Array<{
|
|
2015
2068
|
name: string;
|
|
2069
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2016
2070
|
description: string;
|
|
2017
2071
|
body: string;
|
|
2018
2072
|
service?: string;
|
|
@@ -2021,10 +2075,11 @@ export type ManagementProcedures = {
|
|
|
2021
2075
|
} | {
|
|
2022
2076
|
agents: Array<string>;
|
|
2023
2077
|
};
|
|
2024
|
-
overridable?: Array<"description" | "body">;
|
|
2078
|
+
overridable?: Array<"displayName" | "description" | "body">;
|
|
2025
2079
|
}>;
|
|
2026
2080
|
triggers?: Array<{
|
|
2027
2081
|
name: string;
|
|
2082
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2028
2083
|
description: string;
|
|
2029
2084
|
inputSchema?: {
|
|
2030
2085
|
type: "object";
|
|
@@ -2063,10 +2118,11 @@ export type ManagementProcedures = {
|
|
|
2063
2118
|
} | {
|
|
2064
2119
|
agents: Array<string>;
|
|
2065
2120
|
};
|
|
2066
|
-
overridable?: Array<"description" | "instructions" | "threadPolicy" | "budgetPerDay" | "disableAfterFailures" | "model">;
|
|
2121
|
+
overridable?: Array<"displayName" | "description" | "instructions" | "threadPolicy" | "budgetPerDay" | "disableAfterFailures" | "model">;
|
|
2067
2122
|
}>;
|
|
2068
2123
|
datasetHosts?: Array<{
|
|
2069
2124
|
name: string;
|
|
2125
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2070
2126
|
url: string;
|
|
2071
2127
|
headers?: Array<{
|
|
2072
2128
|
header: string;
|
|
@@ -2100,10 +2156,11 @@ export type ManagementProcedures = {
|
|
|
2100
2156
|
} | {
|
|
2101
2157
|
agents: Array<string>;
|
|
2102
2158
|
};
|
|
2103
|
-
overridable?: Array<"timeoutMs" | "rateLimits" | "headers">;
|
|
2159
|
+
overridable?: Array<"displayName" | "timeoutMs" | "rateLimits" | "headers">;
|
|
2104
2160
|
}>;
|
|
2105
2161
|
mcpServers?: Array<{
|
|
2106
2162
|
name: string;
|
|
2163
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2107
2164
|
url: string;
|
|
2108
2165
|
headers?: Array<{
|
|
2109
2166
|
header: string;
|
|
@@ -2128,10 +2185,11 @@ export type ManagementProcedures = {
|
|
|
2128
2185
|
} | {
|
|
2129
2186
|
agents: Array<string>;
|
|
2130
2187
|
};
|
|
2131
|
-
overridable?: Array<"include" | "exclude" | "headers">;
|
|
2188
|
+
overridable?: Array<"displayName" | "include" | "exclude" | "headers">;
|
|
2132
2189
|
}>;
|
|
2133
2190
|
webhooks?: Array<{
|
|
2134
2191
|
name: string;
|
|
2192
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2135
2193
|
description?: string;
|
|
2136
2194
|
event: "approval_requested";
|
|
2137
2195
|
url: string;
|
|
@@ -2152,10 +2210,11 @@ export type ManagementProcedures = {
|
|
|
2152
2210
|
} | {
|
|
2153
2211
|
agents: Array<string>;
|
|
2154
2212
|
};
|
|
2155
|
-
overridable?: Array<"description" | "timeoutMs" | "headers">;
|
|
2213
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "headers">;
|
|
2156
2214
|
}>;
|
|
2157
2215
|
collections?: Array<{
|
|
2158
2216
|
name: string;
|
|
2217
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2159
2218
|
description?: string;
|
|
2160
2219
|
service?: string;
|
|
2161
2220
|
citable?: boolean;
|
|
@@ -2174,7 +2233,7 @@ export type ManagementProcedures = {
|
|
|
2174
2233
|
} | {
|
|
2175
2234
|
agents: Array<string>;
|
|
2176
2235
|
};
|
|
2177
|
-
overridable?: Array<"description" | "documents">;
|
|
2236
|
+
overridable?: Array<"displayName" | "description" | "documents">;
|
|
2178
2237
|
}>;
|
|
2179
2238
|
prefer?: "live" | "manifest";
|
|
2180
2239
|
resolutions?: Array<{
|
|
@@ -2202,8 +2261,8 @@ export type ManagementProcedures = {
|
|
|
2202
2261
|
input: {
|
|
2203
2262
|
id: string;
|
|
2204
2263
|
agents?: Array<{
|
|
2205
|
-
slug: string;
|
|
2206
2264
|
name: string;
|
|
2265
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2207
2266
|
server?: string;
|
|
2208
2267
|
prompt: string;
|
|
2209
2268
|
auth: {
|
|
@@ -2280,11 +2339,12 @@ export type ManagementProcedures = {
|
|
|
2280
2339
|
prompt: string;
|
|
2281
2340
|
}>>;
|
|
2282
2341
|
greeting?: Record<"en" | "ar", string>;
|
|
2283
|
-
overridable?: Array<"
|
|
2342
|
+
overridable?: Array<"displayName" | "prompt" | "models" | "settings" | "rateLimits" | "suggestions" | "greeting">;
|
|
2284
2343
|
}>;
|
|
2285
2344
|
tools?: Array<{
|
|
2286
2345
|
name: string;
|
|
2287
2346
|
description: string;
|
|
2347
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2288
2348
|
inputSchema?: {
|
|
2289
2349
|
type: "object";
|
|
2290
2350
|
properties?: Record<string, ManifestsSyncSchema0>;
|
|
@@ -2315,7 +2375,7 @@ export type ManagementProcedures = {
|
|
|
2315
2375
|
} | {
|
|
2316
2376
|
agents: Array<string>;
|
|
2317
2377
|
};
|
|
2318
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2378
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2319
2379
|
url: string;
|
|
2320
2380
|
headers?: Array<{
|
|
2321
2381
|
header: string;
|
|
@@ -2343,6 +2403,7 @@ export type ManagementProcedures = {
|
|
|
2343
2403
|
} | {
|
|
2344
2404
|
name: string;
|
|
2345
2405
|
description: string;
|
|
2406
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2346
2407
|
inputSchema?: {
|
|
2347
2408
|
type: "object";
|
|
2348
2409
|
properties?: Record<string, ManifestsSyncSchema0>;
|
|
@@ -2373,7 +2434,7 @@ export type ManagementProcedures = {
|
|
|
2373
2434
|
} | {
|
|
2374
2435
|
agents: Array<string>;
|
|
2375
2436
|
};
|
|
2376
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2437
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2377
2438
|
url: string;
|
|
2378
2439
|
headers?: Array<{
|
|
2379
2440
|
header: string;
|
|
@@ -2398,6 +2459,7 @@ export type ManagementProcedures = {
|
|
|
2398
2459
|
} | {
|
|
2399
2460
|
name: string;
|
|
2400
2461
|
description: string;
|
|
2462
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2401
2463
|
inputSchema?: {
|
|
2402
2464
|
type: "object";
|
|
2403
2465
|
properties?: Record<string, ManifestsSyncSchema0>;
|
|
@@ -2428,7 +2490,7 @@ export type ManagementProcedures = {
|
|
|
2428
2490
|
} | {
|
|
2429
2491
|
agents: Array<string>;
|
|
2430
2492
|
};
|
|
2431
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2493
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2432
2494
|
url: string;
|
|
2433
2495
|
headers?: Array<{
|
|
2434
2496
|
header: string;
|
|
@@ -2460,6 +2522,7 @@ export type ManagementProcedures = {
|
|
|
2460
2522
|
} | {
|
|
2461
2523
|
name: string;
|
|
2462
2524
|
description: string;
|
|
2525
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2463
2526
|
inputSchema?: {
|
|
2464
2527
|
type: "object";
|
|
2465
2528
|
properties?: Record<string, ManifestsSyncSchema0>;
|
|
@@ -2490,7 +2553,7 @@ export type ManagementProcedures = {
|
|
|
2490
2553
|
} | {
|
|
2491
2554
|
agents: Array<string>;
|
|
2492
2555
|
};
|
|
2493
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags">;
|
|
2556
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags">;
|
|
2494
2557
|
type: "client";
|
|
2495
2558
|
}>;
|
|
2496
2559
|
openapi?: Array<{
|
|
@@ -2523,21 +2586,22 @@ export type ManagementProcedures = {
|
|
|
2523
2586
|
} | {
|
|
2524
2587
|
agents: Array<string>;
|
|
2525
2588
|
};
|
|
2526
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2589
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2527
2590
|
}>;
|
|
2528
2591
|
services?: Array<{
|
|
2529
|
-
|
|
2530
|
-
|
|
2592
|
+
name: string;
|
|
2593
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2531
2594
|
description: Record<"en" | "ar", string>;
|
|
2532
2595
|
audience: "all" | {
|
|
2533
2596
|
server: string;
|
|
2534
2597
|
} | {
|
|
2535
2598
|
agents: Array<string>;
|
|
2536
2599
|
};
|
|
2537
|
-
overridable?: Array<"description">;
|
|
2600
|
+
overridable?: Array<"displayName" | "description">;
|
|
2538
2601
|
}>;
|
|
2539
2602
|
skills?: Array<{
|
|
2540
2603
|
name: string;
|
|
2604
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2541
2605
|
description: string;
|
|
2542
2606
|
body: string;
|
|
2543
2607
|
service?: string;
|
|
@@ -2546,10 +2610,11 @@ export type ManagementProcedures = {
|
|
|
2546
2610
|
} | {
|
|
2547
2611
|
agents: Array<string>;
|
|
2548
2612
|
};
|
|
2549
|
-
overridable?: Array<"description" | "body">;
|
|
2613
|
+
overridable?: Array<"displayName" | "description" | "body">;
|
|
2550
2614
|
}>;
|
|
2551
2615
|
triggers?: Array<{
|
|
2552
2616
|
name: string;
|
|
2617
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2553
2618
|
description: string;
|
|
2554
2619
|
inputSchema?: {
|
|
2555
2620
|
type: "object";
|
|
@@ -2588,10 +2653,11 @@ export type ManagementProcedures = {
|
|
|
2588
2653
|
} | {
|
|
2589
2654
|
agents: Array<string>;
|
|
2590
2655
|
};
|
|
2591
|
-
overridable?: Array<"description" | "instructions" | "threadPolicy" | "budgetPerDay" | "disableAfterFailures" | "model">;
|
|
2656
|
+
overridable?: Array<"displayName" | "description" | "instructions" | "threadPolicy" | "budgetPerDay" | "disableAfterFailures" | "model">;
|
|
2592
2657
|
}>;
|
|
2593
2658
|
datasetHosts?: Array<{
|
|
2594
2659
|
name: string;
|
|
2660
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2595
2661
|
url: string;
|
|
2596
2662
|
headers?: Array<{
|
|
2597
2663
|
header: string;
|
|
@@ -2625,10 +2691,11 @@ export type ManagementProcedures = {
|
|
|
2625
2691
|
} | {
|
|
2626
2692
|
agents: Array<string>;
|
|
2627
2693
|
};
|
|
2628
|
-
overridable?: Array<"timeoutMs" | "rateLimits" | "headers">;
|
|
2694
|
+
overridable?: Array<"displayName" | "timeoutMs" | "rateLimits" | "headers">;
|
|
2629
2695
|
}>;
|
|
2630
2696
|
mcpServers?: Array<{
|
|
2631
2697
|
name: string;
|
|
2698
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2632
2699
|
url: string;
|
|
2633
2700
|
headers?: Array<{
|
|
2634
2701
|
header: string;
|
|
@@ -2653,10 +2720,11 @@ export type ManagementProcedures = {
|
|
|
2653
2720
|
} | {
|
|
2654
2721
|
agents: Array<string>;
|
|
2655
2722
|
};
|
|
2656
|
-
overridable?: Array<"include" | "exclude" | "headers">;
|
|
2723
|
+
overridable?: Array<"displayName" | "include" | "exclude" | "headers">;
|
|
2657
2724
|
}>;
|
|
2658
2725
|
webhooks?: Array<{
|
|
2659
2726
|
name: string;
|
|
2727
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2660
2728
|
description?: string;
|
|
2661
2729
|
event: "approval_requested";
|
|
2662
2730
|
url: string;
|
|
@@ -2677,10 +2745,11 @@ export type ManagementProcedures = {
|
|
|
2677
2745
|
} | {
|
|
2678
2746
|
agents: Array<string>;
|
|
2679
2747
|
};
|
|
2680
|
-
overridable?: Array<"description" | "timeoutMs" | "headers">;
|
|
2748
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "headers">;
|
|
2681
2749
|
}>;
|
|
2682
2750
|
collections?: Array<{
|
|
2683
2751
|
name: string;
|
|
2752
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2684
2753
|
description?: string;
|
|
2685
2754
|
service?: string;
|
|
2686
2755
|
citable?: boolean;
|
|
@@ -2699,7 +2768,7 @@ export type ManagementProcedures = {
|
|
|
2699
2768
|
} | {
|
|
2700
2769
|
agents: Array<string>;
|
|
2701
2770
|
};
|
|
2702
|
-
overridable?: Array<"description" | "documents">;
|
|
2771
|
+
overridable?: Array<"displayName" | "description" | "documents">;
|
|
2703
2772
|
}>;
|
|
2704
2773
|
prefer?: "live" | "manifest";
|
|
2705
2774
|
resolutions?: Array<{
|
|
@@ -2722,6 +2791,7 @@ export type ManagementProcedures = {
|
|
|
2722
2791
|
input: {
|
|
2723
2792
|
name: string;
|
|
2724
2793
|
url: string;
|
|
2794
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2725
2795
|
audience: {
|
|
2726
2796
|
kind: "all";
|
|
2727
2797
|
} | {
|
|
@@ -2767,6 +2837,7 @@ export type ManagementProcedures = {
|
|
|
2767
2837
|
agentIds: Array<string>;
|
|
2768
2838
|
};
|
|
2769
2839
|
name: string;
|
|
2840
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2770
2841
|
url: string;
|
|
2771
2842
|
headers: Array<{
|
|
2772
2843
|
header: string;
|
|
@@ -2789,9 +2860,10 @@ export type ManagementProcedures = {
|
|
|
2789
2860
|
status: "draft" | "published" | "disabled";
|
|
2790
2861
|
updatedAt: string;
|
|
2791
2862
|
referrers: Array<{
|
|
2863
|
+
name: string;
|
|
2864
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2792
2865
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
2793
2866
|
id: string;
|
|
2794
|
-
name: string;
|
|
2795
2867
|
readers: {
|
|
2796
2868
|
kind: "all";
|
|
2797
2869
|
} | {
|
|
@@ -2802,7 +2874,6 @@ export type ManagementProcedures = {
|
|
|
2802
2874
|
agentIds: Array<string>;
|
|
2803
2875
|
};
|
|
2804
2876
|
}>;
|
|
2805
|
-
nameLocked: boolean;
|
|
2806
2877
|
variables: Array<{
|
|
2807
2878
|
name: string;
|
|
2808
2879
|
description: string;
|
|
@@ -2828,6 +2899,7 @@ export type ManagementProcedures = {
|
|
|
2828
2899
|
name: string;
|
|
2829
2900
|
url: string;
|
|
2830
2901
|
status: "draft" | "published" | "disabled";
|
|
2902
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2831
2903
|
source: "direct" | "manifest" | "server";
|
|
2832
2904
|
sourceId: string | null;
|
|
2833
2905
|
overridable: Array<string>;
|
|
@@ -2938,10 +3010,9 @@ export type ManagementProcedures = {
|
|
|
2938
3010
|
unchanged: boolean;
|
|
2939
3011
|
};
|
|
2940
3012
|
};
|
|
2941
|
-
/** Update an MCP server's draft:
|
|
3013
|
+
/** Update an MCP server's draft: which of its tools agents may call (`include`, empty for every tool, and `exclude`, tool names as the server spells them). Saved as a draft; call publish to make it live. The url and headers (each with a prefix and its value from a credential, the run token, a variable or a constant) apply live without a publish. */
|
|
2942
3014
|
"mcpServers.update": {
|
|
2943
3015
|
input: {
|
|
2944
|
-
name: string;
|
|
2945
3016
|
url: string;
|
|
2946
3017
|
headers: Array<{
|
|
2947
3018
|
header: string;
|
|
@@ -2962,24 +3033,28 @@ export type ManagementProcedures = {
|
|
|
2962
3033
|
include: Array<string>;
|
|
2963
3034
|
exclude: Array<string>;
|
|
2964
3035
|
id: string;
|
|
3036
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2965
3037
|
};
|
|
2966
3038
|
output: {
|
|
2967
3039
|
id: string;
|
|
2968
3040
|
name: string;
|
|
2969
3041
|
};
|
|
2970
3042
|
};
|
|
2971
|
-
/** Create a model provider: an OpenAI-compatible `baseUrl` (https, or http on loopback or on a host `EGRESS_ALLOWED_HOSTS` admits), the secret holding its key, the model ids it offers, and the values it accepts as `reasoning_effort`. Its name never changes. Needs `secrets:write` too: every model call sends the key to `baseUrl`. */
|
|
3043
|
+
/** Create a model provider: a display name (a text per locale, `{}` for none), an OpenAI-compatible `baseUrl` (https, or http on loopback or on a host `EGRESS_ALLOWED_HOSTS` admits), the secret holding its key, the model ids it offers, and the values it accepts as `reasoning_effort`. Its name never changes. Needs `secrets:write` too: every model call sends the key to `baseUrl`. */
|
|
2972
3044
|
"modelProviders.create": {
|
|
2973
3045
|
input: {
|
|
3046
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2974
3047
|
baseUrl: string;
|
|
2975
3048
|
secretName: string;
|
|
2976
3049
|
models: Array<string>;
|
|
2977
3050
|
efforts: Array<string>;
|
|
3051
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
2978
3052
|
name: string;
|
|
2979
3053
|
};
|
|
2980
3054
|
output: {
|
|
2981
3055
|
id: string;
|
|
2982
3056
|
name: string;
|
|
3057
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2983
3058
|
baseUrl: string;
|
|
2984
3059
|
secretName: string;
|
|
2985
3060
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
@@ -2996,6 +3071,7 @@ export type ManagementProcedures = {
|
|
|
2996
3071
|
output: {
|
|
2997
3072
|
id: string;
|
|
2998
3073
|
name: string;
|
|
3074
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2999
3075
|
baseUrl: string;
|
|
3000
3076
|
secretName: string;
|
|
3001
3077
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
@@ -3026,6 +3102,7 @@ export type ManagementProcedures = {
|
|
|
3026
3102
|
items: Array<{
|
|
3027
3103
|
id: string;
|
|
3028
3104
|
name: string;
|
|
3105
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3029
3106
|
baseUrl: string;
|
|
3030
3107
|
secretName: string;
|
|
3031
3108
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
@@ -3035,9 +3112,10 @@ export type ManagementProcedures = {
|
|
|
3035
3112
|
usedBy: {
|
|
3036
3113
|
count: number;
|
|
3037
3114
|
preview: Array<{
|
|
3115
|
+
name: string;
|
|
3116
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3038
3117
|
kind: "credential" | "model_provider" | "server" | "agent" | "tool" | "trigger" | "dataset_host" | "webhook" | "mcp_server";
|
|
3039
3118
|
id: string;
|
|
3040
|
-
name: string;
|
|
3041
3119
|
}>;
|
|
3042
3120
|
};
|
|
3043
3121
|
}>;
|
|
@@ -3047,18 +3125,20 @@ export type ManagementProcedures = {
|
|
|
3047
3125
|
filteredCount: number;
|
|
3048
3126
|
};
|
|
3049
3127
|
};
|
|
3050
|
-
/** Every model provider with its models and efforts, in name order, for a model picker. */
|
|
3128
|
+
/** Every model provider with its display name, models and efforts, in name order, for a model picker. */
|
|
3051
3129
|
"modelProviders.options": {
|
|
3052
3130
|
input: undefined;
|
|
3053
3131
|
output: Array<{
|
|
3054
3132
|
name: string;
|
|
3133
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3055
3134
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
3056
3135
|
efforts: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
3057
3136
|
}>;
|
|
3058
3137
|
};
|
|
3059
|
-
/** Change a model provider's URL, key secret, models and efforts. Refused with `in_use` while a server, agent or trigger picks a model or effort it would drop. Changing the URL or the key secret needs `secrets:write` too (`secret_binding_forbidden`): either sends a stored secret somewhere new. Applies from each agent's next turn. */
|
|
3138
|
+
/** Change a model provider's display name, URL, key secret, models and efforts. Refused with `in_use` while a server, agent or trigger picks a model or effort it would drop. Changing the URL or the key secret needs `secrets:write` too (`secret_binding_forbidden`): either sends a stored secret somewhere new. Applies from each agent's next turn. */
|
|
3060
3139
|
"modelProviders.update": {
|
|
3061
3140
|
input: {
|
|
3141
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3062
3142
|
baseUrl: string;
|
|
3063
3143
|
secretName: string;
|
|
3064
3144
|
models: Array<string>;
|
|
@@ -3068,6 +3148,7 @@ export type ManagementProcedures = {
|
|
|
3068
3148
|
output: {
|
|
3069
3149
|
id: string;
|
|
3070
3150
|
name: string;
|
|
3151
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3071
3152
|
baseUrl: string;
|
|
3072
3153
|
secretName: string;
|
|
3073
3154
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
@@ -3090,7 +3171,10 @@ export type ManagementProcedures = {
|
|
|
3090
3171
|
callerId: string | null;
|
|
3091
3172
|
toolName: string;
|
|
3092
3173
|
createdAt: string;
|
|
3093
|
-
|
|
3174
|
+
agent: {
|
|
3175
|
+
name: string;
|
|
3176
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3177
|
+
};
|
|
3094
3178
|
triggerName: string | null;
|
|
3095
3179
|
threadId: string | null;
|
|
3096
3180
|
threadTitle: string | null;
|
|
@@ -3126,7 +3210,8 @@ export type ManagementProcedures = {
|
|
|
3126
3210
|
entityType: "knowledge" | "service" | "tool";
|
|
3127
3211
|
entityId: string;
|
|
3128
3212
|
collectionId: string | null;
|
|
3129
|
-
name:
|
|
3213
|
+
name: string;
|
|
3214
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3130
3215
|
resolutionCount: number;
|
|
3131
3216
|
}>;
|
|
3132
3217
|
broadTools: Array<{
|
|
@@ -3138,13 +3223,19 @@ export type ManagementProcedures = {
|
|
|
3138
3223
|
missingQueries: Array<{
|
|
3139
3224
|
queryHash: string;
|
|
3140
3225
|
agentId: string;
|
|
3141
|
-
|
|
3226
|
+
agent: {
|
|
3227
|
+
name: string;
|
|
3228
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3229
|
+
};
|
|
3142
3230
|
searchCount: number;
|
|
3143
3231
|
lastSearchedAt: string;
|
|
3144
3232
|
}>;
|
|
3145
3233
|
hitRates: Array<{
|
|
3146
3234
|
agentId: string;
|
|
3147
|
-
|
|
3235
|
+
agent: {
|
|
3236
|
+
name: string;
|
|
3237
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3238
|
+
};
|
|
3148
3239
|
retrievalCount: number;
|
|
3149
3240
|
hitCount: number;
|
|
3150
3241
|
hitRate: number;
|
|
@@ -3163,9 +3254,14 @@ export type ManagementProcedures = {
|
|
|
3163
3254
|
outcome: "started" | "awaiting_approval" | "completed" | "failed" | "rejected" | "dropped";
|
|
3164
3255
|
reason: "busy" | "approval_pending" | "budget" | "rate_limited" | "invalid_payload" | "missing_thread_key" | "no_turn" | "no_output" | "invalid_output" | null;
|
|
3165
3256
|
output: unknown;
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
|
|
3257
|
+
server: {
|
|
3258
|
+
name: string;
|
|
3259
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3260
|
+
} | null;
|
|
3261
|
+
agent: {
|
|
3262
|
+
name: string;
|
|
3263
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3264
|
+
};
|
|
3169
3265
|
threadTitle: string | null;
|
|
3170
3266
|
createdAt: string;
|
|
3171
3267
|
finishedAt: string | null;
|
|
@@ -3200,7 +3296,10 @@ export type ManagementProcedures = {
|
|
|
3200
3296
|
};
|
|
3201
3297
|
perUser: Array<{
|
|
3202
3298
|
scopeId: string;
|
|
3203
|
-
|
|
3299
|
+
scope: {
|
|
3300
|
+
name: string;
|
|
3301
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3302
|
+
};
|
|
3204
3303
|
userId: string;
|
|
3205
3304
|
triggerName: string | null;
|
|
3206
3305
|
threads: number;
|
|
@@ -3213,11 +3312,17 @@ export type ManagementProcedures = {
|
|
|
3213
3312
|
}>;
|
|
3214
3313
|
perServer: Array<{
|
|
3215
3314
|
serverId: string | null;
|
|
3216
|
-
|
|
3315
|
+
server: {
|
|
3316
|
+
name: string;
|
|
3317
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3318
|
+
} | null;
|
|
3217
3319
|
totalTokens: number;
|
|
3218
3320
|
}>;
|
|
3219
3321
|
perAgent: Array<{
|
|
3220
|
-
|
|
3322
|
+
agent: {
|
|
3323
|
+
name: string;
|
|
3324
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3325
|
+
};
|
|
3221
3326
|
totalTokens: number;
|
|
3222
3327
|
}>;
|
|
3223
3328
|
perDay: Array<{
|
|
@@ -3251,9 +3356,14 @@ export type ManagementProcedures = {
|
|
|
3251
3356
|
detail: string | null;
|
|
3252
3357
|
threadId: string;
|
|
3253
3358
|
createdAt: string;
|
|
3254
|
-
|
|
3255
|
-
|
|
3256
|
-
|
|
3359
|
+
server: {
|
|
3360
|
+
name: string;
|
|
3361
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3362
|
+
} | null;
|
|
3363
|
+
agent: {
|
|
3364
|
+
name: string;
|
|
3365
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3366
|
+
};
|
|
3257
3367
|
threadTitle: string | null;
|
|
3258
3368
|
}>;
|
|
3259
3369
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
@@ -3286,7 +3396,10 @@ export type ManagementProcedures = {
|
|
|
3286
3396
|
callerId: string | null;
|
|
3287
3397
|
toolName: string;
|
|
3288
3398
|
createdAt: string;
|
|
3289
|
-
|
|
3399
|
+
agent: {
|
|
3400
|
+
name: string;
|
|
3401
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3402
|
+
};
|
|
3290
3403
|
triggerName: string | null;
|
|
3291
3404
|
}>;
|
|
3292
3405
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
@@ -3356,7 +3469,10 @@ export type ManagementProcedures = {
|
|
|
3356
3469
|
output: {
|
|
3357
3470
|
items: Array<{
|
|
3358
3471
|
agentId: string;
|
|
3359
|
-
|
|
3472
|
+
agent: {
|
|
3473
|
+
name: string;
|
|
3474
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3475
|
+
};
|
|
3360
3476
|
skillName: string;
|
|
3361
3477
|
misses: number;
|
|
3362
3478
|
lastSeenAt: string | null;
|
|
@@ -3433,9 +3549,14 @@ export type ManagementProcedures = {
|
|
|
3433
3549
|
outcome: "started" | "awaiting_approval" | "completed" | "failed" | "rejected" | "dropped";
|
|
3434
3550
|
reason: "busy" | "approval_pending" | "budget" | "rate_limited" | "invalid_payload" | "missing_thread_key" | "no_turn" | "no_output" | "invalid_output" | null;
|
|
3435
3551
|
output: unknown;
|
|
3436
|
-
|
|
3437
|
-
|
|
3438
|
-
|
|
3552
|
+
server: {
|
|
3553
|
+
name: string;
|
|
3554
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3555
|
+
} | null;
|
|
3556
|
+
agent: {
|
|
3557
|
+
name: string;
|
|
3558
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3559
|
+
};
|
|
3439
3560
|
threadTitle: string | null;
|
|
3440
3561
|
createdAt: string;
|
|
3441
3562
|
finishedAt: string | null;
|
|
@@ -3480,9 +3601,10 @@ export type ManagementProcedures = {
|
|
|
3480
3601
|
agentId: string;
|
|
3481
3602
|
};
|
|
3482
3603
|
output: Array<{
|
|
3604
|
+
name: string;
|
|
3605
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3483
3606
|
kind: "tool" | "service" | "skill" | "trigger" | "dataset_host" | "mcp_server" | "webhook" | "knowledge_collection";
|
|
3484
3607
|
id: string;
|
|
3485
|
-
name: string;
|
|
3486
3608
|
}>;
|
|
3487
3609
|
};
|
|
3488
3610
|
/** Publication history of an entity with pagination. */
|
|
@@ -3589,11 +3711,12 @@ export type ManagementProcedures = {
|
|
|
3589
3711
|
output: {
|
|
3590
3712
|
id: string;
|
|
3591
3713
|
name: string;
|
|
3714
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3592
3715
|
createdAt: string;
|
|
3593
3716
|
updatedAt: string;
|
|
3594
3717
|
};
|
|
3595
3718
|
};
|
|
3596
|
-
/** List
|
|
3719
|
+
/** List secrets' names, display names and dates with pagination and search, each with how many rows name it and the first few (`usedBy`); values are never returned. */
|
|
3597
3720
|
"secrets.list": {
|
|
3598
3721
|
input: {
|
|
3599
3722
|
pageIndex?: number;
|
|
@@ -3604,14 +3727,16 @@ export type ManagementProcedures = {
|
|
|
3604
3727
|
items: Array<{
|
|
3605
3728
|
id: string;
|
|
3606
3729
|
name: string;
|
|
3730
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3607
3731
|
createdAt: string;
|
|
3608
3732
|
updatedAt: string;
|
|
3609
3733
|
usedBy: {
|
|
3610
3734
|
count: number;
|
|
3611
3735
|
preview: Array<{
|
|
3736
|
+
name: string;
|
|
3737
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3612
3738
|
kind: "credential" | "model_provider" | "server" | "agent" | "tool" | "trigger" | "dataset_host" | "webhook" | "mcp_server";
|
|
3613
3739
|
id: string;
|
|
3614
|
-
name: string;
|
|
3615
3740
|
}>;
|
|
3616
3741
|
};
|
|
3617
3742
|
}>;
|
|
@@ -3621,10 +3746,13 @@ export type ManagementProcedures = {
|
|
|
3621
3746
|
filteredCount: number;
|
|
3622
3747
|
};
|
|
3623
3748
|
};
|
|
3624
|
-
/** Every secret name in order, for a picker. */
|
|
3749
|
+
/** Every secret's name and display name, in name order, for a picker. */
|
|
3625
3750
|
"secrets.names": {
|
|
3626
3751
|
input: undefined;
|
|
3627
|
-
output: Array<
|
|
3752
|
+
output: Array<{
|
|
3753
|
+
name: string;
|
|
3754
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3755
|
+
}>;
|
|
3628
3756
|
};
|
|
3629
3757
|
/** Replace a secret's value in place. */
|
|
3630
3758
|
"secrets.rotate": {
|
|
@@ -3635,27 +3763,45 @@ export type ManagementProcedures = {
|
|
|
3635
3763
|
output: {
|
|
3636
3764
|
id: string;
|
|
3637
3765
|
name: string;
|
|
3766
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3638
3767
|
createdAt: string;
|
|
3639
3768
|
updatedAt: string;
|
|
3640
3769
|
};
|
|
3641
3770
|
};
|
|
3642
|
-
/** Create a named secret; credentials compose it by name, and a tool input field may read it. */
|
|
3771
|
+
/** Create a named secret with a display name (a text per locale, `{}` for none); credentials compose it by name, and a tool input field may read it. */
|
|
3643
3772
|
"secrets.set": {
|
|
3644
3773
|
input: {
|
|
3774
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
3645
3775
|
name: string;
|
|
3776
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3646
3777
|
value: string;
|
|
3647
3778
|
};
|
|
3648
3779
|
output: {
|
|
3649
3780
|
id: string;
|
|
3650
3781
|
name: string;
|
|
3782
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3651
3783
|
createdAt: string;
|
|
3652
3784
|
updatedAt: string;
|
|
3653
3785
|
};
|
|
3654
3786
|
};
|
|
3655
|
-
/**
|
|
3656
|
-
"
|
|
3787
|
+
/** Set a secret's display name, a text per locale. Its name and value stay; `secrets.rotate` replaces the value. */
|
|
3788
|
+
"secrets.update": {
|
|
3657
3789
|
input: {
|
|
3790
|
+
id: string;
|
|
3791
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3792
|
+
};
|
|
3793
|
+
output: {
|
|
3794
|
+
id: string;
|
|
3658
3795
|
name: string;
|
|
3796
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3797
|
+
createdAt: string;
|
|
3798
|
+
updatedAt: string;
|
|
3799
|
+
};
|
|
3800
|
+
};
|
|
3801
|
+
/** Register a server by name, with a display name (a text per locale, `{}` for none), the URL it serves the server protocol at, the secret holding its key, optionally the model its agents run on by default, and how often Cortex may check callers with it: `signInChecksPerMinute` (new end-user tokens it verifies) and `triggerChecksPerMinute` (trigger secrets). Its manifest is read at once; a failed read is the row's `syncError` and does not fail the registration. */
|
|
3802
|
+
"servers.create": {
|
|
3803
|
+
input: {
|
|
3804
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3659
3805
|
description: string;
|
|
3660
3806
|
url: string | "";
|
|
3661
3807
|
keySecretName: string;
|
|
@@ -3664,10 +3810,13 @@ export type ManagementProcedures = {
|
|
|
3664
3810
|
modelEffort: string | null;
|
|
3665
3811
|
signInChecksPerMinute: number;
|
|
3666
3812
|
triggerChecksPerMinute: number;
|
|
3813
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
3814
|
+
name: string;
|
|
3667
3815
|
};
|
|
3668
3816
|
output: {
|
|
3669
3817
|
id: string;
|
|
3670
3818
|
name: string;
|
|
3819
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3671
3820
|
description: string | null;
|
|
3672
3821
|
url: string | null;
|
|
3673
3822
|
keySecretName: string | null;
|
|
@@ -3681,6 +3830,7 @@ export type ManagementProcedures = {
|
|
|
3681
3830
|
}>;
|
|
3682
3831
|
tools: Array<{
|
|
3683
3832
|
name: string;
|
|
3833
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
3684
3834
|
description: string;
|
|
3685
3835
|
inputSchema: Record<string, unknown>;
|
|
3686
3836
|
outputSchema?: Record<string, unknown>;
|
|
@@ -3712,6 +3862,7 @@ export type ManagementProcedures = {
|
|
|
3712
3862
|
output: {
|
|
3713
3863
|
id: string;
|
|
3714
3864
|
name: string;
|
|
3865
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3715
3866
|
description: string | null;
|
|
3716
3867
|
url: string | null;
|
|
3717
3868
|
keySecretName: string | null;
|
|
@@ -3725,6 +3876,7 @@ export type ManagementProcedures = {
|
|
|
3725
3876
|
}>;
|
|
3726
3877
|
tools: Array<{
|
|
3727
3878
|
name: string;
|
|
3879
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
3728
3880
|
description: string;
|
|
3729
3881
|
inputSchema: Record<string, unknown>;
|
|
3730
3882
|
outputSchema?: Record<string, unknown>;
|
|
@@ -3756,6 +3908,7 @@ export type ManagementProcedures = {
|
|
|
3756
3908
|
output: {
|
|
3757
3909
|
id: string;
|
|
3758
3910
|
name: string;
|
|
3911
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3759
3912
|
description: string | null;
|
|
3760
3913
|
url: string | null;
|
|
3761
3914
|
keySecretName: string | null;
|
|
@@ -3777,9 +3930,10 @@ export type ManagementProcedures = {
|
|
|
3777
3930
|
computed: boolean;
|
|
3778
3931
|
}>;
|
|
3779
3932
|
components: Array<{
|
|
3933
|
+
name: string;
|
|
3934
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3780
3935
|
kind: "tool" | "service" | "skill" | "trigger" | "dataset_host" | "mcp_server" | "webhook" | "knowledge_collection";
|
|
3781
3936
|
id: string;
|
|
3782
|
-
name: string;
|
|
3783
3937
|
}>;
|
|
3784
3938
|
};
|
|
3785
3939
|
};
|
|
@@ -3795,6 +3949,7 @@ export type ManagementProcedures = {
|
|
|
3795
3949
|
items: Array<{
|
|
3796
3950
|
id: string;
|
|
3797
3951
|
name: string;
|
|
3952
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3798
3953
|
description: string | null;
|
|
3799
3954
|
url: string | null;
|
|
3800
3955
|
keySecretName: string | null;
|
|
@@ -3810,7 +3965,7 @@ export type ManagementProcedures = {
|
|
|
3810
3965
|
filteredCount: number;
|
|
3811
3966
|
};
|
|
3812
3967
|
};
|
|
3813
|
-
/**
|
|
3968
|
+
/** Each server's id, name and display name, for selectors. Cortex's own system server is left out unless `includeSystem` asks for it, as a filter over its threads does. */
|
|
3814
3969
|
"servers.options": {
|
|
3815
3970
|
input: {
|
|
3816
3971
|
includeSystem?: boolean;
|
|
@@ -3818,6 +3973,7 @@ export type ManagementProcedures = {
|
|
|
3818
3973
|
output: Array<{
|
|
3819
3974
|
id: string;
|
|
3820
3975
|
name: string;
|
|
3976
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3821
3977
|
}>;
|
|
3822
3978
|
};
|
|
3823
3979
|
/** Read the server's manifest now and apply its variables and native tools; a refused manifest leaves the previous one in place. */
|
|
@@ -3829,10 +3985,10 @@ export type ManagementProcedures = {
|
|
|
3829
3985
|
syncedAt: string;
|
|
3830
3986
|
};
|
|
3831
3987
|
};
|
|
3832
|
-
/**
|
|
3988
|
+
/** Change a server's display name, URL or key, set how often Cortex may check callers with it (`signInChecksPerMinute`, `triggerChecksPerMinute`; resend the current values to keep them), or pick the model its agents run on by default: `modelProvider` with one of its `modelName`s, and a `modelEffort` that provider lists; all null leaves each agent to pick its own. Refused as `model_not_offered` otherwise, and as `model_in_use` when an agent on the server picks an effort alone the new provider does not list, or is published with no model of its own and would be left without one. Clearing the URL or key drops what its manifest offered, refused as a sync dropping it all would be: `verify_in_use` while an agent's auth is the server's, `variable_in_use` or `still_referenced` while a published component reads a variable or calls a native tool it declared. A new URL or key has its manifest read at once, as on registration. */
|
|
3833
3989
|
"servers.update": {
|
|
3834
3990
|
input: {
|
|
3835
|
-
|
|
3991
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3836
3992
|
description: string;
|
|
3837
3993
|
url: string | "";
|
|
3838
3994
|
keySecretName: string;
|
|
@@ -3846,6 +4002,7 @@ export type ManagementProcedures = {
|
|
|
3846
4002
|
output: {
|
|
3847
4003
|
id: string;
|
|
3848
4004
|
name: string;
|
|
4005
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3849
4006
|
description: string | null;
|
|
3850
4007
|
url: string | null;
|
|
3851
4008
|
keySecretName: string | null;
|
|
@@ -3859,6 +4016,7 @@ export type ManagementProcedures = {
|
|
|
3859
4016
|
}>;
|
|
3860
4017
|
tools: Array<{
|
|
3861
4018
|
name: string;
|
|
4019
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
3862
4020
|
description: string;
|
|
3863
4021
|
inputSchema: Record<string, unknown>;
|
|
3864
4022
|
outputSchema?: Record<string, unknown>;
|
|
@@ -3885,9 +4043,9 @@ export type ManagementProcedures = {
|
|
|
3885
4043
|
/** Create a service with an audience ({ kind: "all" }, { kind: "server", serverId }, or { kind: "agents", agentIds }). The draft has no tools yet; add them before publishing. */
|
|
3886
4044
|
"services.create": {
|
|
3887
4045
|
input: {
|
|
3888
|
-
/** A
|
|
3889
|
-
|
|
3890
|
-
|
|
4046
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
4047
|
+
name: string;
|
|
4048
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3891
4049
|
audience: {
|
|
3892
4050
|
kind: "all";
|
|
3893
4051
|
} | {
|
|
@@ -3900,7 +4058,7 @@ export type ManagementProcedures = {
|
|
|
3900
4058
|
};
|
|
3901
4059
|
output: {
|
|
3902
4060
|
id: string;
|
|
3903
|
-
name:
|
|
4061
|
+
name: string;
|
|
3904
4062
|
};
|
|
3905
4063
|
};
|
|
3906
4064
|
/** Delete a service; fails while tools reference it. */
|
|
@@ -3919,11 +4077,11 @@ export type ManagementProcedures = {
|
|
|
3919
4077
|
};
|
|
3920
4078
|
output: {
|
|
3921
4079
|
id: string;
|
|
3922
|
-
|
|
3923
|
-
name: Record<"en" | "ar", string>;
|
|
4080
|
+
name: string;
|
|
3924
4081
|
description: Record<"en" | "ar", string>;
|
|
3925
4082
|
status: "draft" | "published" | "disabled";
|
|
3926
4083
|
updatedAt: string;
|
|
4084
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3927
4085
|
source: "direct" | "manifest" | "server";
|
|
3928
4086
|
sourceId: string | null;
|
|
3929
4087
|
overridable: Array<string>;
|
|
@@ -3937,9 +4095,10 @@ export type ManagementProcedures = {
|
|
|
3937
4095
|
agentIds: Array<string>;
|
|
3938
4096
|
};
|
|
3939
4097
|
referrers: Array<{
|
|
4098
|
+
name: string;
|
|
4099
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3940
4100
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
3941
4101
|
id: string;
|
|
3942
|
-
name: string;
|
|
3943
4102
|
readers: {
|
|
3944
4103
|
kind: "all";
|
|
3945
4104
|
} | {
|
|
@@ -3958,7 +4117,6 @@ export type ManagementProcedures = {
|
|
|
3958
4117
|
id: string;
|
|
3959
4118
|
name: string;
|
|
3960
4119
|
}>;
|
|
3961
|
-
nameLocked: boolean;
|
|
3962
4120
|
};
|
|
3963
4121
|
};
|
|
3964
4122
|
/** List services (upstream API groupings for tools) with pagination and search. */
|
|
@@ -3974,10 +4132,10 @@ export type ManagementProcedures = {
|
|
|
3974
4132
|
output: {
|
|
3975
4133
|
items: Array<{
|
|
3976
4134
|
id: string;
|
|
3977
|
-
|
|
3978
|
-
name: Record<"en" | "ar", string>;
|
|
4135
|
+
name: string;
|
|
3979
4136
|
description: Record<"en" | "ar", string>;
|
|
3980
4137
|
status: "draft" | "published" | "disabled";
|
|
4138
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3981
4139
|
source: "direct" | "manifest" | "server";
|
|
3982
4140
|
sourceId: string | null;
|
|
3983
4141
|
overridable: Array<string>;
|
|
@@ -3997,7 +4155,7 @@ export type ManagementProcedures = {
|
|
|
3997
4155
|
filteredCount: number;
|
|
3998
4156
|
};
|
|
3999
4157
|
};
|
|
4000
|
-
/** Every service a component with the given audience may be scoped to, as id,
|
|
4158
|
+
/** Every service a component with the given audience may be scoped to, as id, name and display name, for selectors. */
|
|
4001
4159
|
"services.options": {
|
|
4002
4160
|
input: {
|
|
4003
4161
|
audience: {
|
|
@@ -4012,8 +4170,8 @@ export type ManagementProcedures = {
|
|
|
4012
4170
|
};
|
|
4013
4171
|
output: Array<{
|
|
4014
4172
|
id: string;
|
|
4015
|
-
|
|
4016
|
-
|
|
4173
|
+
name: string;
|
|
4174
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4017
4175
|
}>;
|
|
4018
4176
|
};
|
|
4019
4177
|
/** Publish the service's current draft. */
|
|
@@ -4094,15 +4252,13 @@ export type ManagementProcedures = {
|
|
|
4094
4252
|
/** Update a service's draft. Saved as a draft; call the entity's publish procedure to make it live. */
|
|
4095
4253
|
"services.update": {
|
|
4096
4254
|
input: {
|
|
4097
|
-
|
|
4098
|
-
key: string;
|
|
4099
|
-
name: Record<"en" | "ar", string>;
|
|
4255
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4100
4256
|
description: Record<"en" | "ar", string>;
|
|
4101
4257
|
id: string;
|
|
4102
4258
|
};
|
|
4103
4259
|
output: {
|
|
4104
4260
|
id: string;
|
|
4105
|
-
name:
|
|
4261
|
+
name: string;
|
|
4106
4262
|
};
|
|
4107
4263
|
};
|
|
4108
4264
|
/** Deployment settings: log and thread retention. */
|
|
@@ -4134,8 +4290,9 @@ export type ManagementProcedures = {
|
|
|
4134
4290
|
/** Create a skill with an audience ({ kind: "all" }, { kind: "server", serverId }, or { kind: "agents", agentIds }). The draft has no body yet; fill it with update before publishing. */
|
|
4135
4291
|
"skills.create": {
|
|
4136
4292
|
input: {
|
|
4137
|
-
/** A
|
|
4293
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
4138
4294
|
name: string;
|
|
4295
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4139
4296
|
audience: {
|
|
4140
4297
|
kind: "all";
|
|
4141
4298
|
} | {
|
|
@@ -4174,6 +4331,7 @@ export type ManagementProcedures = {
|
|
|
4174
4331
|
body: string;
|
|
4175
4332
|
status: "draft" | "published" | "disabled";
|
|
4176
4333
|
updatedAt: string;
|
|
4334
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4177
4335
|
source: "direct" | "manifest" | "server";
|
|
4178
4336
|
sourceId: string | null;
|
|
4179
4337
|
overridable: Array<string>;
|
|
@@ -4187,9 +4345,10 @@ export type ManagementProcedures = {
|
|
|
4187
4345
|
agentIds: Array<string>;
|
|
4188
4346
|
};
|
|
4189
4347
|
referrers: Array<{
|
|
4348
|
+
name: string;
|
|
4349
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4190
4350
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
4191
4351
|
id: string;
|
|
4192
|
-
name: string;
|
|
4193
4352
|
readers: {
|
|
4194
4353
|
kind: "all";
|
|
4195
4354
|
} | {
|
|
@@ -4200,7 +4359,10 @@ export type ManagementProcedures = {
|
|
|
4200
4359
|
agentIds: Array<string>;
|
|
4201
4360
|
};
|
|
4202
4361
|
}>;
|
|
4203
|
-
|
|
4362
|
+
service: {
|
|
4363
|
+
name: string;
|
|
4364
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4365
|
+
} | null;
|
|
4204
4366
|
variables: Array<{
|
|
4205
4367
|
name: string;
|
|
4206
4368
|
description: string;
|
|
@@ -4220,7 +4382,6 @@ export type ManagementProcedures = {
|
|
|
4220
4382
|
id: string;
|
|
4221
4383
|
name: string;
|
|
4222
4384
|
}>;
|
|
4223
|
-
nameLocked: boolean;
|
|
4224
4385
|
};
|
|
4225
4386
|
};
|
|
4226
4387
|
/** List skills with pagination and search: every skill of an agent, or only those scoped to no service or to one service. */
|
|
@@ -4241,6 +4402,7 @@ export type ManagementProcedures = {
|
|
|
4241
4402
|
name: string;
|
|
4242
4403
|
description: string;
|
|
4243
4404
|
status: "draft" | "published" | "disabled";
|
|
4405
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4244
4406
|
source: "direct" | "manifest" | "server";
|
|
4245
4407
|
sourceId: string | null;
|
|
4246
4408
|
overridable: Array<string>;
|
|
@@ -4335,14 +4497,13 @@ export type ManagementProcedures = {
|
|
|
4335
4497
|
unchanged: boolean;
|
|
4336
4498
|
};
|
|
4337
4499
|
};
|
|
4338
|
-
/** Update a skill's
|
|
4500
|
+
/** Update a skill's display name, or its draft description or body. The description and body are saved as a draft; call the entity's publish procedure to make them live. The display name applies at once. */
|
|
4339
4501
|
"skills.update": {
|
|
4340
4502
|
input: {
|
|
4341
|
-
/** A slug: lowercase letters, digits, and single hyphens. */
|
|
4342
|
-
name: string;
|
|
4343
4503
|
description: string;
|
|
4344
4504
|
body: string;
|
|
4345
4505
|
id: string;
|
|
4506
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4346
4507
|
variables: Array<string>;
|
|
4347
4508
|
};
|
|
4348
4509
|
output: {
|
|
@@ -4364,10 +4525,15 @@ export type ManagementProcedures = {
|
|
|
4364
4525
|
createdAt: string;
|
|
4365
4526
|
updatedAt: string;
|
|
4366
4527
|
serverId: string | null;
|
|
4367
|
-
|
|
4368
|
-
|
|
4528
|
+
server: {
|
|
4529
|
+
name: string;
|
|
4530
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4531
|
+
} | null;
|
|
4532
|
+
agent: {
|
|
4533
|
+
name: string;
|
|
4534
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4535
|
+
};
|
|
4369
4536
|
agentId: string;
|
|
4370
|
-
agentName: string;
|
|
4371
4537
|
agentUrl: string | null;
|
|
4372
4538
|
messageCount: number;
|
|
4373
4539
|
totalTokens: number;
|
|
@@ -4386,7 +4552,7 @@ export type ManagementProcedures = {
|
|
|
4386
4552
|
pageSize?: number;
|
|
4387
4553
|
q?: string;
|
|
4388
4554
|
serverId?: string;
|
|
4389
|
-
|
|
4555
|
+
agentName?: string;
|
|
4390
4556
|
userId?: string;
|
|
4391
4557
|
dateFrom?: string;
|
|
4392
4558
|
dateTo?: string;
|
|
@@ -4403,8 +4569,14 @@ export type ManagementProcedures = {
|
|
|
4403
4569
|
createdAt: string;
|
|
4404
4570
|
updatedAt: string;
|
|
4405
4571
|
serverId: string | null;
|
|
4406
|
-
|
|
4407
|
-
|
|
4572
|
+
server: {
|
|
4573
|
+
name: string;
|
|
4574
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4575
|
+
} | null;
|
|
4576
|
+
agent: {
|
|
4577
|
+
name: string;
|
|
4578
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4579
|
+
};
|
|
4408
4580
|
}>;
|
|
4409
4581
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
4410
4582
|
count: number;
|
|
@@ -4593,6 +4765,7 @@ export type ManagementProcedures = {
|
|
|
4593
4765
|
description: string;
|
|
4594
4766
|
endpointUrl: string;
|
|
4595
4767
|
method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
|
|
4768
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4596
4769
|
audience: {
|
|
4597
4770
|
kind: "all";
|
|
4598
4771
|
} | {
|
|
@@ -4824,6 +4997,7 @@ export type ManagementProcedures = {
|
|
|
4824
4997
|
agentIds: Array<string>;
|
|
4825
4998
|
};
|
|
4826
4999
|
name: string;
|
|
5000
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4827
5001
|
description: string;
|
|
4828
5002
|
type: "http" | "embedded" | "soap" | "native" | "client";
|
|
4829
5003
|
config: {
|
|
@@ -4858,9 +5032,10 @@ export type ManagementProcedures = {
|
|
|
4858
5032
|
createdAt: string;
|
|
4859
5033
|
updatedAt: string;
|
|
4860
5034
|
referrers: Array<{
|
|
5035
|
+
name: string;
|
|
5036
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4861
5037
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
4862
5038
|
id: string;
|
|
4863
|
-
name: string;
|
|
4864
5039
|
readers: {
|
|
4865
5040
|
kind: "all";
|
|
4866
5041
|
} | {
|
|
@@ -4880,7 +5055,6 @@ export type ManagementProcedures = {
|
|
|
4880
5055
|
}>;
|
|
4881
5056
|
inputFields: Array<StoredSchemaFieldRow>;
|
|
4882
5057
|
outputFields: Array<StoredSchemaFieldRow>;
|
|
4883
|
-
nameLocked: boolean;
|
|
4884
5058
|
};
|
|
4885
5059
|
};
|
|
4886
5060
|
/** List tools with pagination and search. */
|
|
@@ -4904,6 +5078,7 @@ export type ManagementProcedures = {
|
|
|
4904
5078
|
status: "draft" | "published" | "disabled";
|
|
4905
5079
|
pinned: boolean;
|
|
4906
5080
|
importSource: string | null;
|
|
5081
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4907
5082
|
source: "direct" | "manifest" | "server";
|
|
4908
5083
|
sourceId: string | null;
|
|
4909
5084
|
overridable: Array<string>;
|
|
@@ -4923,12 +5098,13 @@ export type ManagementProcedures = {
|
|
|
4923
5098
|
filteredCount: number;
|
|
4924
5099
|
};
|
|
4925
5100
|
};
|
|
4926
|
-
/**
|
|
5101
|
+
/** Each tool's id, name and display name, for selectors. */
|
|
4927
5102
|
"tools.options": {
|
|
4928
5103
|
input: undefined;
|
|
4929
5104
|
output: Array<{
|
|
4930
5105
|
id: string;
|
|
4931
5106
|
name: string;
|
|
5107
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4932
5108
|
}>;
|
|
4933
5109
|
};
|
|
4934
5110
|
/** Parse an OpenAPI document and list the operations it would import as tools, and the tools already importing some of them. */
|
|
@@ -5108,8 +5284,6 @@ export type ManagementProcedures = {
|
|
|
5108
5284
|
/** Update a tool's draft. Saved as a draft; call the entity's publish procedure to make it live. `headers` (the headers every call carries, each with a prefix and where its value comes from: `{ kind: "credential", name }`, `{ kind: "runToken" }`, `{ kind: "variable", name }` or `{ kind: "constant", value }`) and `rateLimits` (calls per minute for all users and per user, null for no limit) apply live without a publish. A variable must be one every agent the tool reaches is filled with. */
|
|
5109
5285
|
"tools.update": {
|
|
5110
5286
|
input: {
|
|
5111
|
-
/** An identifier of up to 64 characters: letters, digits, _ or $, not starting with a digit, and not the name of a built-in tool (submitAnswer, loadSkill, executeCode, requestLocation and the like). */
|
|
5112
|
-
name: string;
|
|
5113
5287
|
description: string;
|
|
5114
5288
|
endpointUrl: string;
|
|
5115
5289
|
method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
|
|
@@ -5144,6 +5318,7 @@ export type ManagementProcedures = {
|
|
|
5144
5318
|
projectOutput: boolean;
|
|
5145
5319
|
tags: Array<string>;
|
|
5146
5320
|
id: string;
|
|
5321
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5147
5322
|
variables: Array<{
|
|
5148
5323
|
name: string;
|
|
5149
5324
|
description: string;
|
|
@@ -5237,8 +5412,9 @@ export type ManagementProcedures = {
|
|
|
5237
5412
|
/** Create a trigger (a named entry point external systems fire on an agent) with an audience ({ kind: "all" }, { kind: "server", serverId }, or { kind: "agents", agentIds }), fired on any agent in it. The draft has no instructions yet; fill them with update before publishing. */
|
|
5238
5413
|
"triggers.create": {
|
|
5239
5414
|
input: {
|
|
5240
|
-
/** A
|
|
5415
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
5241
5416
|
name: string;
|
|
5417
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5242
5418
|
audience: {
|
|
5243
5419
|
kind: "all";
|
|
5244
5420
|
} | {
|
|
@@ -5349,6 +5525,7 @@ export type ManagementProcedures = {
|
|
|
5349
5525
|
modelEffort: string | null;
|
|
5350
5526
|
status: "draft" | "published" | "disabled";
|
|
5351
5527
|
updatedAt: string;
|
|
5528
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5352
5529
|
source: "direct" | "manifest" | "server";
|
|
5353
5530
|
sourceId: string | null;
|
|
5354
5531
|
overridable: Array<string>;
|
|
@@ -5362,9 +5539,10 @@ export type ManagementProcedures = {
|
|
|
5362
5539
|
agentIds: Array<string>;
|
|
5363
5540
|
};
|
|
5364
5541
|
referrers: Array<{
|
|
5542
|
+
name: string;
|
|
5543
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5365
5544
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
5366
5545
|
id: string;
|
|
5367
|
-
name: string;
|
|
5368
5546
|
readers: {
|
|
5369
5547
|
kind: "all";
|
|
5370
5548
|
} | {
|
|
@@ -5377,8 +5555,8 @@ export type ManagementProcedures = {
|
|
|
5377
5555
|
}>;
|
|
5378
5556
|
agents: Array<{
|
|
5379
5557
|
id: string;
|
|
5380
|
-
slug: string;
|
|
5381
5558
|
name: string;
|
|
5559
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5382
5560
|
}>;
|
|
5383
5561
|
engineUrl: string | null;
|
|
5384
5562
|
variables: Array<{
|
|
@@ -5402,7 +5580,6 @@ export type ManagementProcedures = {
|
|
|
5402
5580
|
id: string;
|
|
5403
5581
|
name: string;
|
|
5404
5582
|
}>;
|
|
5405
|
-
nameLocked: boolean;
|
|
5406
5583
|
};
|
|
5407
5584
|
};
|
|
5408
5585
|
/** List triggers with pagination and search. */
|
|
@@ -5432,6 +5609,7 @@ export type ManagementProcedures = {
|
|
|
5432
5609
|
};
|
|
5433
5610
|
status: "draft" | "published" | "disabled";
|
|
5434
5611
|
secretPrefix: string;
|
|
5612
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5435
5613
|
source: "direct" | "manifest" | "server";
|
|
5436
5614
|
sourceId: string | null;
|
|
5437
5615
|
overridable: Array<string>;
|
|
@@ -5537,11 +5715,9 @@ export type ManagementProcedures = {
|
|
|
5537
5715
|
unchanged: boolean;
|
|
5538
5716
|
};
|
|
5539
5717
|
};
|
|
5540
|
-
/** Update a trigger's draft. Saved as a draft; call the entity's publish procedure to make it live. `credentialName`, `fireCredentialName` and the model pick are the exceptions: they apply without a publish, the fire credential from the next firing and the others from each agent's next turn. Giving the run a different `credentialName` needs `secrets:write`, since tools forwarding the run token send its value upstream. The model pick (`modelProvider` with one of its `modelName`s and optionally a `modelEffort`, all null to run on each agent's own) is refused as `model_not_offered` when the provider does not list the model or the effort, or an effort is picked without a model. `fireCredentialName` names a static credential whose value callers present to fire, shared by every trigger naming it; that credential and its secret may serve nothing else. Clearing it leaves the trigger shut until `triggers.rotateSecret` mints a secret. */
|
|
5718
|
+
/** Update a trigger's draft. Saved as a draft; call the entity's publish procedure to make it live. `displayName`, `credentialName`, `fireCredentialName` and the model pick are the exceptions: they apply without a publish, the display name at once, the fire credential from the next firing and the others from each agent's next turn. Giving the run a different `credentialName` needs `secrets:write`, since tools forwarding the run token send its value upstream. The model pick (`modelProvider` with one of its `modelName`s and optionally a `modelEffort`, all null to run on each agent's own) is refused as `model_not_offered` when the provider does not list the model or the effort, or an effort is picked without a model. `fireCredentialName` names a static credential whose value callers present to fire, shared by every trigger naming it; that credential and its secret may serve nothing else. Clearing it leaves the trigger shut until `triggers.rotateSecret` mints a secret. */
|
|
5541
5719
|
"triggers.update": {
|
|
5542
5720
|
input: {
|
|
5543
|
-
/** A slug: lowercase letters, digits, and single hyphens. */
|
|
5544
|
-
name: string;
|
|
5545
5721
|
description: string;
|
|
5546
5722
|
inputFields: Array<SchemaFieldRow>;
|
|
5547
5723
|
outputFields: Array<SchemaFieldRow>;
|
|
@@ -5559,6 +5735,7 @@ export type ManagementProcedures = {
|
|
|
5559
5735
|
budgetPerDay: number | null;
|
|
5560
5736
|
disableAfterFailures: number;
|
|
5561
5737
|
id: string;
|
|
5738
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5562
5739
|
credentialName: string | null;
|
|
5563
5740
|
fireCredentialName: string | null;
|
|
5564
5741
|
modelProvider: string | null;
|
|
@@ -5648,9 +5825,10 @@ export type ManagementProcedures = {
|
|
|
5648
5825
|
/** Create a webhook (an HTTP endpoint Cortex posts an event to when a run on an agent parks for approval) with an audience ({ kind: "all" }, { kind: "server", serverId }, or { kind: "agents", agentIds }). It starts disabled: set its headers with update, then enable it with toggle. */
|
|
5649
5826
|
"webhooks.create": {
|
|
5650
5827
|
input: {
|
|
5651
|
-
/** A
|
|
5828
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
5652
5829
|
name: string;
|
|
5653
5830
|
url: string;
|
|
5831
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5654
5832
|
audience: {
|
|
5655
5833
|
kind: "all";
|
|
5656
5834
|
} | {
|
|
@@ -5696,6 +5874,7 @@ export type ManagementProcedures = {
|
|
|
5696
5874
|
agentIds: Array<string>;
|
|
5697
5875
|
};
|
|
5698
5876
|
name: string;
|
|
5877
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5699
5878
|
description: string;
|
|
5700
5879
|
event: "approval_requested";
|
|
5701
5880
|
url: string;
|
|
@@ -5719,9 +5898,10 @@ export type ManagementProcedures = {
|
|
|
5719
5898
|
enabled: boolean;
|
|
5720
5899
|
updatedAt: string;
|
|
5721
5900
|
referrers: Array<{
|
|
5901
|
+
name: string;
|
|
5902
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5722
5903
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
5723
5904
|
id: string;
|
|
5724
|
-
name: string;
|
|
5725
5905
|
readers: {
|
|
5726
5906
|
kind: "all";
|
|
5727
5907
|
} | {
|
|
@@ -5751,6 +5931,7 @@ export type ManagementProcedures = {
|
|
|
5751
5931
|
event: "approval_requested";
|
|
5752
5932
|
url: string;
|
|
5753
5933
|
enabled: boolean;
|
|
5934
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5754
5935
|
source: "direct" | "manifest" | "server";
|
|
5755
5936
|
sourceId: string | null;
|
|
5756
5937
|
overridable: Array<string>;
|
|
@@ -5798,7 +5979,10 @@ export type ManagementProcedures = {
|
|
|
5798
5979
|
durationMs: number;
|
|
5799
5980
|
error: "upstream_status" | "upstream_failed" | "egress_blocked" | "timeout" | "response_too_large" | "token_missing" | "unknown_credential" | "credential_unavailable" | "unexpected" | null;
|
|
5800
5981
|
createdAt: string;
|
|
5801
|
-
|
|
5982
|
+
agent: {
|
|
5983
|
+
name: string;
|
|
5984
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5985
|
+
} | null;
|
|
5802
5986
|
}>;
|
|
5803
5987
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
5804
5988
|
count: number;
|
|
@@ -5861,8 +6045,6 @@ export type ManagementProcedures = {
|
|
|
5861
6045
|
/** Update a webhook. Every delivery reads it live, so a change applies to the next one at once. A header's value comes from a credential or a constant: a delivery has no run of its own, so no run token or variable. */
|
|
5862
6046
|
"webhooks.update": {
|
|
5863
6047
|
input: {
|
|
5864
|
-
/** A slug: lowercase letters, digits, and single hyphens. */
|
|
5865
|
-
name: string;
|
|
5866
6048
|
description: string;
|
|
5867
6049
|
event: "approval_requested";
|
|
5868
6050
|
url: string;
|
|
@@ -5884,6 +6066,7 @@ export type ManagementProcedures = {
|
|
|
5884
6066
|
}>;
|
|
5885
6067
|
timeoutMs: number;
|
|
5886
6068
|
id: string;
|
|
6069
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5887
6070
|
};
|
|
5888
6071
|
output: {
|
|
5889
6072
|
id: string;
|