@m6d/cortex-cli 0.20.0 → 0.22.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/client-tools/index.ts +21 -0
- package/src/contracts/egress-policy/index.ts +1 -0
- package/src/contracts/egress-policy/url.ts +1 -1
- package/src/contracts/management/procedures.generated.ts +452 -171
- package/src/contracts/manifest/index.ts +121 -106
- package/src/contracts/server/index.ts +35 -10
- package/src/contracts/triggers/index.ts +9 -9
- package/src/contracts/wire/index.ts +54 -0
- package/src/scaffold/files.ts +11 -13
|
@@ -233,6 +233,7 @@ export const managementProcedureKinds = {
|
|
|
233
233
|
"credentials.delete": "mutation",
|
|
234
234
|
"credentials.list": "query",
|
|
235
235
|
"credentials.names": "query",
|
|
236
|
+
"credentials.rotateKey": "mutation",
|
|
236
237
|
"credentials.update": "mutation",
|
|
237
238
|
"datasetHosts.create": "mutation",
|
|
238
239
|
"datasetHosts.delete": "mutation",
|
|
@@ -257,6 +258,8 @@ export const managementProcedureKinds = {
|
|
|
257
258
|
"manifests.sync": "mutation",
|
|
258
259
|
"mcpServers.create": "mutation",
|
|
259
260
|
"mcpServers.delete": "mutation",
|
|
261
|
+
"mcpServers.detectSignIn": "query",
|
|
262
|
+
"mcpServers.disconnect": "mutation",
|
|
260
263
|
"mcpServers.get": "query",
|
|
261
264
|
"mcpServers.list": "query",
|
|
262
265
|
"mcpServers.publish": "mutation",
|
|
@@ -299,6 +302,7 @@ export const managementProcedureKinds = {
|
|
|
299
302
|
"secrets.names": "query",
|
|
300
303
|
"secrets.rotate": "mutation",
|
|
301
304
|
"secrets.set": "mutation",
|
|
305
|
+
"secrets.update": "mutation",
|
|
302
306
|
"servers.create": "mutation",
|
|
303
307
|
"servers.delete": "mutation",
|
|
304
308
|
"servers.get": "query",
|
|
@@ -379,9 +383,10 @@ export const managementProcedureKinds = {
|
|
|
379
383
|
|
|
380
384
|
/** Each procedure's input, as it is sent, and output, as JSON carries it. */
|
|
381
385
|
export type ManagementProcedures = {
|
|
382
|
-
/** Give an agent an alias: a second
|
|
386
|
+
/** 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
387
|
"agents.addAlias": {
|
|
384
388
|
input: {
|
|
389
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
385
390
|
alias: string;
|
|
386
391
|
agentId: string;
|
|
387
392
|
};
|
|
@@ -395,8 +400,9 @@ export type ManagementProcedures = {
|
|
|
395
400
|
/** 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
401
|
"agents.create": {
|
|
397
402
|
input: {
|
|
398
|
-
|
|
403
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
399
404
|
name: string;
|
|
405
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
400
406
|
serverId: string | null;
|
|
401
407
|
};
|
|
402
408
|
output: {
|
|
@@ -405,9 +411,9 @@ export type ManagementProcedures = {
|
|
|
405
411
|
sourceId: string | null;
|
|
406
412
|
overridable: Array<string>;
|
|
407
413
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
408
|
-
slug: string;
|
|
409
|
-
serverId: string | null;
|
|
410
414
|
name: string;
|
|
415
|
+
serverId: string | null;
|
|
416
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
411
417
|
promptDraft: string;
|
|
412
418
|
ragEnabled: boolean;
|
|
413
419
|
toolRegistryEnabled: boolean;
|
|
@@ -450,9 +456,9 @@ export type ManagementProcedures = {
|
|
|
450
456
|
sourceId: string | null;
|
|
451
457
|
overridable: Array<string>;
|
|
452
458
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
453
|
-
slug: string;
|
|
454
|
-
serverId: string | null;
|
|
455
459
|
name: string;
|
|
460
|
+
serverId: string | null;
|
|
461
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
456
462
|
promptDraft: string;
|
|
457
463
|
ragEnabled: boolean;
|
|
458
464
|
toolRegistryEnabled: boolean;
|
|
@@ -486,6 +492,7 @@ export type ManagementProcedures = {
|
|
|
486
492
|
/** Remove an alias. */
|
|
487
493
|
"agents.deleteAlias": {
|
|
488
494
|
input: {
|
|
495
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
489
496
|
alias: string;
|
|
490
497
|
};
|
|
491
498
|
output: {
|
|
@@ -506,9 +513,9 @@ export type ManagementProcedures = {
|
|
|
506
513
|
sourceId: string | null;
|
|
507
514
|
overridable: Array<string>;
|
|
508
515
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
509
|
-
slug: string;
|
|
510
|
-
serverId: string | null;
|
|
511
516
|
name: string;
|
|
517
|
+
serverId: string | null;
|
|
518
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
512
519
|
promptDraft: string;
|
|
513
520
|
ragEnabled: boolean;
|
|
514
521
|
toolRegistryEnabled: boolean;
|
|
@@ -535,7 +542,10 @@ export type ManagementProcedures = {
|
|
|
535
542
|
summarizationModel: string | null;
|
|
536
543
|
context: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
537
544
|
limits: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
538
|
-
|
|
545
|
+
server: {
|
|
546
|
+
name: string;
|
|
547
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
548
|
+
} | null;
|
|
539
549
|
serverVerifies: boolean;
|
|
540
550
|
variables: Array<{
|
|
541
551
|
name: string;
|
|
@@ -566,13 +576,16 @@ export type ManagementProcedures = {
|
|
|
566
576
|
output: {
|
|
567
577
|
items: Array<{
|
|
568
578
|
id: string;
|
|
569
|
-
slug: string;
|
|
570
579
|
name: string;
|
|
580
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
571
581
|
updatedAt: string;
|
|
572
582
|
source: "direct" | "manifest" | "server";
|
|
573
583
|
sourceId: string | null;
|
|
574
584
|
overridable: Array<string>;
|
|
575
|
-
|
|
585
|
+
server: {
|
|
586
|
+
name: string;
|
|
587
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
588
|
+
} | null;
|
|
576
589
|
published: boolean;
|
|
577
590
|
toolCount: number;
|
|
578
591
|
serviceCount: number;
|
|
@@ -585,7 +598,7 @@ export type ManagementProcedures = {
|
|
|
585
598
|
filteredCount: number;
|
|
586
599
|
};
|
|
587
600
|
};
|
|
588
|
-
/** List an agent's aliases (second
|
|
601
|
+
/** List an agent's aliases (second names, unique across the deployment beside every agent's own), with pagination. */
|
|
589
602
|
"agents.listAliases": {
|
|
590
603
|
input: {
|
|
591
604
|
pageIndex?: number;
|
|
@@ -606,13 +619,13 @@ export type ManagementProcedures = {
|
|
|
606
619
|
filteredCount: number;
|
|
607
620
|
};
|
|
608
621
|
};
|
|
609
|
-
/** Agent
|
|
622
|
+
/** Agent ids, names and display names for selectors. */
|
|
610
623
|
"agents.options": {
|
|
611
624
|
input: undefined;
|
|
612
625
|
output: Array<{
|
|
613
626
|
id: string;
|
|
614
|
-
slug: string;
|
|
615
627
|
name: string;
|
|
628
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
616
629
|
serverId: string | null;
|
|
617
630
|
}>;
|
|
618
631
|
};
|
|
@@ -666,9 +679,9 @@ export type ManagementProcedures = {
|
|
|
666
679
|
sourceId: string | null;
|
|
667
680
|
overridable: Array<string>;
|
|
668
681
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
669
|
-
slug: string;
|
|
670
|
-
serverId: string | null;
|
|
671
682
|
name: string;
|
|
683
|
+
serverId: string | null;
|
|
684
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
672
685
|
promptDraft: string;
|
|
673
686
|
ragEnabled: boolean;
|
|
674
687
|
toolRegistryEnabled: boolean;
|
|
@@ -776,9 +789,9 @@ export type ManagementProcedures = {
|
|
|
776
789
|
sourceId: string | null;
|
|
777
790
|
overridable: Array<string>;
|
|
778
791
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
779
|
-
slug: string;
|
|
780
|
-
serverId: string | null;
|
|
781
792
|
name: string;
|
|
793
|
+
serverId: string | null;
|
|
794
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
782
795
|
promptDraft: string;
|
|
783
796
|
ragEnabled: boolean;
|
|
784
797
|
toolRegistryEnabled: boolean;
|
|
@@ -809,11 +822,11 @@ export type ManagementProcedures = {
|
|
|
809
822
|
updatedAt: string;
|
|
810
823
|
};
|
|
811
824
|
};
|
|
812
|
-
/**
|
|
825
|
+
/** Set an agent's display name, a text per locale. It applies at once; it is not part of the published prompt. */
|
|
813
826
|
"agents.update": {
|
|
814
827
|
input: {
|
|
815
828
|
id: string;
|
|
816
|
-
|
|
829
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
817
830
|
};
|
|
818
831
|
output: {
|
|
819
832
|
id: string;
|
|
@@ -821,9 +834,9 @@ export type ManagementProcedures = {
|
|
|
821
834
|
sourceId: string | null;
|
|
822
835
|
overridable: Array<string>;
|
|
823
836
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
824
|
-
slug: string;
|
|
825
|
-
serverId: string | null;
|
|
826
837
|
name: string;
|
|
838
|
+
serverId: string | null;
|
|
839
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
827
840
|
promptDraft: string;
|
|
828
841
|
ragEnabled: boolean;
|
|
829
842
|
toolRegistryEnabled: boolean;
|
|
@@ -875,7 +888,7 @@ export type ManagementProcedures = {
|
|
|
875
888
|
output: {
|
|
876
889
|
id: string;
|
|
877
890
|
actorId: string;
|
|
878
|
-
credentialKind: "session" | "managementKey" | "operatorToken" | "system";
|
|
891
|
+
credentialKind: "session" | "managementKey" | "operatorToken" | "oauthToken" | "system";
|
|
879
892
|
credentialId: string | null;
|
|
880
893
|
entityType: string;
|
|
881
894
|
entityId: string;
|
|
@@ -883,9 +896,16 @@ export type ManagementProcedures = {
|
|
|
883
896
|
createdAt: string;
|
|
884
897
|
actorName: string;
|
|
885
898
|
actorEmail: string;
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
899
|
+
entity: {
|
|
900
|
+
name: string;
|
|
901
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
902
|
+
} | null;
|
|
903
|
+
managementKey: {
|
|
904
|
+
name: string;
|
|
905
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
906
|
+
fingerprint: string;
|
|
907
|
+
} | null;
|
|
908
|
+
oauthClientName: string | null;
|
|
889
909
|
before: unknown;
|
|
890
910
|
after: unknown;
|
|
891
911
|
};
|
|
@@ -906,7 +926,7 @@ export type ManagementProcedures = {
|
|
|
906
926
|
items: Array<{
|
|
907
927
|
id: string;
|
|
908
928
|
actorId: string;
|
|
909
|
-
credentialKind: "session" | "managementKey" | "operatorToken" | "system";
|
|
929
|
+
credentialKind: "session" | "managementKey" | "operatorToken" | "oauthToken" | "system";
|
|
910
930
|
credentialId: string | null;
|
|
911
931
|
entityType: string;
|
|
912
932
|
entityId: string;
|
|
@@ -914,9 +934,16 @@ export type ManagementProcedures = {
|
|
|
914
934
|
createdAt: string;
|
|
915
935
|
actorName: string;
|
|
916
936
|
actorEmail: string;
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
937
|
+
entity: {
|
|
938
|
+
name: string;
|
|
939
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
940
|
+
} | null;
|
|
941
|
+
managementKey: {
|
|
942
|
+
name: string;
|
|
943
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
944
|
+
fingerprint: string;
|
|
945
|
+
} | null;
|
|
946
|
+
oauthClientName: string | null;
|
|
920
947
|
}>;
|
|
921
948
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
922
949
|
count: number;
|
|
@@ -924,10 +951,12 @@ export type ManagementProcedures = {
|
|
|
924
951
|
filteredCount: number;
|
|
925
952
|
};
|
|
926
953
|
};
|
|
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. */
|
|
954
|
+
/** 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
955
|
"collections.create": {
|
|
929
956
|
input: {
|
|
957
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
930
958
|
name: string;
|
|
959
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
931
960
|
description: string;
|
|
932
961
|
serviceId: string | null;
|
|
933
962
|
citable: boolean;
|
|
@@ -968,6 +997,7 @@ export type ManagementProcedures = {
|
|
|
968
997
|
citable: boolean;
|
|
969
998
|
createdAt: string;
|
|
970
999
|
updatedAt: string;
|
|
1000
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
971
1001
|
source: "direct" | "manifest" | "server";
|
|
972
1002
|
sourceId: string | null;
|
|
973
1003
|
overridable: Array<string>;
|
|
@@ -981,9 +1011,10 @@ export type ManagementProcedures = {
|
|
|
981
1011
|
agentIds: Array<string>;
|
|
982
1012
|
};
|
|
983
1013
|
referrers: Array<{
|
|
1014
|
+
name: string;
|
|
1015
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
984
1016
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
985
1017
|
id: string;
|
|
986
|
-
name: string;
|
|
987
1018
|
readers: {
|
|
988
1019
|
kind: "all";
|
|
989
1020
|
} | {
|
|
@@ -994,7 +1025,10 @@ export type ManagementProcedures = {
|
|
|
994
1025
|
agentIds: Array<string>;
|
|
995
1026
|
};
|
|
996
1027
|
}>;
|
|
997
|
-
|
|
1028
|
+
service: {
|
|
1029
|
+
name: string;
|
|
1030
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1031
|
+
} | null;
|
|
998
1032
|
};
|
|
999
1033
|
};
|
|
1000
1034
|
/** List knowledge collections with pagination and search, optionally the ones an agent sees or the ones reaching a server. */
|
|
@@ -1015,6 +1049,7 @@ export type ManagementProcedures = {
|
|
|
1015
1049
|
description: string;
|
|
1016
1050
|
serviceId: string | null;
|
|
1017
1051
|
updatedAt: string;
|
|
1052
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1018
1053
|
source: "direct" | "manifest" | "server";
|
|
1019
1054
|
sourceId: string | null;
|
|
1020
1055
|
overridable: Array<string>;
|
|
@@ -1027,7 +1062,10 @@ export type ManagementProcedures = {
|
|
|
1027
1062
|
kind: "agents";
|
|
1028
1063
|
agentIds: Array<string>;
|
|
1029
1064
|
};
|
|
1030
|
-
|
|
1065
|
+
service: {
|
|
1066
|
+
name: string;
|
|
1067
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1068
|
+
} | null;
|
|
1031
1069
|
documentCount: number;
|
|
1032
1070
|
}>;
|
|
1033
1071
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
@@ -1087,10 +1125,10 @@ export type ManagementProcedures = {
|
|
|
1087
1125
|
};
|
|
1088
1126
|
}>;
|
|
1089
1127
|
};
|
|
1090
|
-
/**
|
|
1128
|
+
/** Set a knowledge collection's display name, describe it or change its service tag. A tag change applies to agents at once. */
|
|
1091
1129
|
"collections.update": {
|
|
1092
1130
|
input: {
|
|
1093
|
-
|
|
1131
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1094
1132
|
description: string;
|
|
1095
1133
|
serviceId: string | null;
|
|
1096
1134
|
citable: boolean;
|
|
@@ -1101,24 +1139,31 @@ export type ManagementProcedures = {
|
|
|
1101
1139
|
name: string;
|
|
1102
1140
|
};
|
|
1103
1141
|
};
|
|
1104
|
-
/** Create a
|
|
1142
|
+
/** Create a credential over a stored secret, with a display name (`{}` for none). `static` presents the secret's value; `oauth2-client-credentials` gets a bearer at `tokenUrl` (https) as `clientId`, by `authMethod`: `client_secret_basic` sends the secret; `private_key_jwt` signs with a key Cortex generates into a new secret named `secretName`, which nothing else may compose or rewrite (`signing_key_secret`), and needs `issuer` and an engine public URL to publish its key under (`jwks_unavailable`); `none` is a public app for MCP sign-in at `issuer`, with no secret. `issuer` is the authorization server's exact identifier. Name, kind and auth method never change. Needs `secrets:write`. */
|
|
1105
1143
|
"credentials.create": {
|
|
1106
1144
|
input: {
|
|
1145
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1107
1146
|
kind: "static" | "oauth2-client-credentials";
|
|
1147
|
+
authMethod: "client_secret_basic" | "private_key_jwt" | "none";
|
|
1108
1148
|
secretName: string;
|
|
1109
1149
|
tokenUrl: string;
|
|
1110
1150
|
clientId: string;
|
|
1111
1151
|
scope: string;
|
|
1152
|
+
issuer: string;
|
|
1153
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
1112
1154
|
name: string;
|
|
1113
1155
|
};
|
|
1114
1156
|
output: {
|
|
1115
1157
|
id: string;
|
|
1116
1158
|
name: string;
|
|
1159
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1117
1160
|
kind: "static" | "oauth2-client-credentials";
|
|
1118
|
-
|
|
1161
|
+
authMethod: "client_secret_basic" | "private_key_jwt" | "none" | null;
|
|
1162
|
+
secretName: string | null;
|
|
1119
1163
|
tokenUrl: string | null;
|
|
1120
1164
|
clientId: string | null;
|
|
1121
1165
|
scope: string | null;
|
|
1166
|
+
issuer: string | null;
|
|
1122
1167
|
createdAt: string;
|
|
1123
1168
|
updatedAt: string;
|
|
1124
1169
|
};
|
|
@@ -1131,16 +1176,19 @@ export type ManagementProcedures = {
|
|
|
1131
1176
|
output: {
|
|
1132
1177
|
id: string;
|
|
1133
1178
|
name: string;
|
|
1179
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1134
1180
|
kind: "static" | "oauth2-client-credentials";
|
|
1135
|
-
|
|
1181
|
+
authMethod: "client_secret_basic" | "private_key_jwt" | "none" | null;
|
|
1182
|
+
secretName: string | null;
|
|
1136
1183
|
tokenUrl: string | null;
|
|
1137
1184
|
clientId: string | null;
|
|
1138
1185
|
scope: string | null;
|
|
1186
|
+
issuer: string | null;
|
|
1139
1187
|
createdAt: string;
|
|
1140
1188
|
updatedAt: string;
|
|
1141
1189
|
};
|
|
1142
1190
|
};
|
|
1143
|
-
/** List credentials with pagination and search: the name tools, dataset hosts and triggers reference, its kind, the secret it composes,
|
|
1191
|
+
/** List credentials with pagination and search: the name tools, dataset hosts and triggers reference, its display name, its kind and auth method, the secret it composes, how many rows name it with the first few (`usedBy`), and, for a `private_key_jwt` one, the URL of its public key set (`jwksUrl`, null without an engine public URL), which its authorization server is registered with, and the `kid` of the key it signs with now (null for any other). */
|
|
1144
1192
|
"credentials.list": {
|
|
1145
1193
|
input: {
|
|
1146
1194
|
pageIndex?: number;
|
|
@@ -1151,21 +1199,27 @@ export type ManagementProcedures = {
|
|
|
1151
1199
|
items: Array<{
|
|
1152
1200
|
id: string;
|
|
1153
1201
|
name: string;
|
|
1202
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1154
1203
|
kind: "static" | "oauth2-client-credentials";
|
|
1155
|
-
|
|
1204
|
+
authMethod: "client_secret_basic" | "private_key_jwt" | "none" | null;
|
|
1205
|
+
secretName: string | null;
|
|
1156
1206
|
tokenUrl: string | null;
|
|
1157
1207
|
clientId: string | null;
|
|
1158
1208
|
scope: string | null;
|
|
1209
|
+
issuer: string | null;
|
|
1159
1210
|
createdAt: string;
|
|
1160
1211
|
updatedAt: string;
|
|
1161
1212
|
usedBy: {
|
|
1162
1213
|
count: number;
|
|
1163
1214
|
preview: Array<{
|
|
1215
|
+
name: string;
|
|
1216
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1164
1217
|
kind: "credential" | "model_provider" | "server" | "agent" | "tool" | "trigger" | "dataset_host" | "webhook" | "mcp_server";
|
|
1165
1218
|
id: string;
|
|
1166
|
-
name: string;
|
|
1167
1219
|
}>;
|
|
1168
1220
|
};
|
|
1221
|
+
jwksUrl: string | null;
|
|
1222
|
+
kid: string | null;
|
|
1169
1223
|
}>;
|
|
1170
1224
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
1171
1225
|
count: number;
|
|
@@ -1173,31 +1227,60 @@ export type ManagementProcedures = {
|
|
|
1173
1227
|
filteredCount: number;
|
|
1174
1228
|
};
|
|
1175
1229
|
};
|
|
1176
|
-
/**
|
|
1230
|
+
/** 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). `signIn`: what an MCP server's sign-in may present as its pre-registered app (OAuth2 client credentials ones naming their `issuer`). */
|
|
1177
1231
|
"credentials.names": {
|
|
1178
1232
|
input: {
|
|
1179
|
-
use: "present" | "fire";
|
|
1233
|
+
use: "present" | "fire" | "signIn";
|
|
1180
1234
|
};
|
|
1181
|
-
output: Array<
|
|
1235
|
+
output: Array<{
|
|
1236
|
+
name: string;
|
|
1237
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1238
|
+
}>;
|
|
1182
1239
|
};
|
|
1183
|
-
/**
|
|
1240
|
+
/** Replace a `private_key_jwt` credential's signing key with a new one, under a new `kid`, rewriting its secret (`no_signing_key` for any other credential). Its key set serves only the new public key at once, so assertions verify again once the authorization server refetches it. */
|
|
1241
|
+
"credentials.rotateKey": {
|
|
1242
|
+
input: {
|
|
1243
|
+
id: string;
|
|
1244
|
+
};
|
|
1245
|
+
output: {
|
|
1246
|
+
id: string;
|
|
1247
|
+
name: string;
|
|
1248
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1249
|
+
kind: "static" | "oauth2-client-credentials";
|
|
1250
|
+
authMethod: "client_secret_basic" | "private_key_jwt" | "none" | null;
|
|
1251
|
+
secretName: string | null;
|
|
1252
|
+
tokenUrl: string | null;
|
|
1253
|
+
clientId: string | null;
|
|
1254
|
+
scope: string | null;
|
|
1255
|
+
issuer: string | null;
|
|
1256
|
+
createdAt: string;
|
|
1257
|
+
updatedAt: string;
|
|
1258
|
+
};
|
|
1259
|
+
};
|
|
1260
|
+
/** Change a credential's display name, the secret it composes and, for an OAuth2 one, its token URL, client id, scope and issuer. Applies to the next call of every tool, dataset host and trigger naming it. Changing the secret, the token URL or the issuer needs `secrets:write` too (`secret_binding_forbidden`): each sends a stored secret somewhere new. A `private_key_jwt` one keeps its secret, which holds its key, like its kind and auth method (`kind_locked`). */
|
|
1184
1261
|
"credentials.update": {
|
|
1185
1262
|
input: {
|
|
1263
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1186
1264
|
kind: "static" | "oauth2-client-credentials";
|
|
1265
|
+
authMethod: "client_secret_basic" | "private_key_jwt" | "none";
|
|
1187
1266
|
secretName: string;
|
|
1188
1267
|
tokenUrl: string;
|
|
1189
1268
|
clientId: string;
|
|
1190
1269
|
scope: string;
|
|
1270
|
+
issuer: string;
|
|
1191
1271
|
id: string;
|
|
1192
1272
|
};
|
|
1193
1273
|
output: {
|
|
1194
1274
|
id: string;
|
|
1195
1275
|
name: string;
|
|
1276
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1196
1277
|
kind: "static" | "oauth2-client-credentials";
|
|
1197
|
-
|
|
1278
|
+
authMethod: "client_secret_basic" | "private_key_jwt" | "none" | null;
|
|
1279
|
+
secretName: string | null;
|
|
1198
1280
|
tokenUrl: string | null;
|
|
1199
1281
|
clientId: string | null;
|
|
1200
1282
|
scope: string | null;
|
|
1283
|
+
issuer: string | null;
|
|
1201
1284
|
createdAt: string;
|
|
1202
1285
|
updatedAt: string;
|
|
1203
1286
|
};
|
|
@@ -1207,6 +1290,7 @@ export type ManagementProcedures = {
|
|
|
1207
1290
|
input: {
|
|
1208
1291
|
name: string;
|
|
1209
1292
|
url: string;
|
|
1293
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1210
1294
|
audience: {
|
|
1211
1295
|
kind: "all";
|
|
1212
1296
|
} | {
|
|
@@ -1252,6 +1336,7 @@ export type ManagementProcedures = {
|
|
|
1252
1336
|
agentIds: Array<string>;
|
|
1253
1337
|
};
|
|
1254
1338
|
name: string;
|
|
1339
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1255
1340
|
url: string;
|
|
1256
1341
|
headers: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
1257
1342
|
timeoutMs: number;
|
|
@@ -1284,9 +1369,10 @@ export type ManagementProcedures = {
|
|
|
1284
1369
|
revision: number;
|
|
1285
1370
|
updatedAt: string;
|
|
1286
1371
|
referrers: Array<{
|
|
1372
|
+
name: string;
|
|
1373
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1287
1374
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
1288
1375
|
id: string;
|
|
1289
|
-
name: string;
|
|
1290
1376
|
readers: {
|
|
1291
1377
|
kind: "all";
|
|
1292
1378
|
} | {
|
|
@@ -1297,7 +1383,6 @@ export type ManagementProcedures = {
|
|
|
1297
1383
|
agentIds: Array<string>;
|
|
1298
1384
|
};
|
|
1299
1385
|
}>;
|
|
1300
|
-
nameLocked: boolean;
|
|
1301
1386
|
variables: Array<{
|
|
1302
1387
|
name: string;
|
|
1303
1388
|
description: string;
|
|
@@ -1327,6 +1412,7 @@ export type ManagementProcedures = {
|
|
|
1327
1412
|
manifestVersion: string | null;
|
|
1328
1413
|
syncedAt: string | null;
|
|
1329
1414
|
expose: Array<string>;
|
|
1415
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1330
1416
|
source: "direct" | "manifest" | "server";
|
|
1331
1417
|
sourceId: string | null;
|
|
1332
1418
|
overridable: Array<string>;
|
|
@@ -1462,7 +1548,6 @@ export type ManagementProcedures = {
|
|
|
1462
1548
|
/** 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
1549
|
"datasetHosts.update": {
|
|
1464
1550
|
input: {
|
|
1465
|
-
name: string;
|
|
1466
1551
|
url: string;
|
|
1467
1552
|
headers: Array<{
|
|
1468
1553
|
header: string;
|
|
@@ -1492,6 +1577,7 @@ export type ManagementProcedures = {
|
|
|
1492
1577
|
expose: Array<string>;
|
|
1493
1578
|
pinned: Array<string>;
|
|
1494
1579
|
id: string;
|
|
1580
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1495
1581
|
};
|
|
1496
1582
|
output: {
|
|
1497
1583
|
id: string;
|
|
@@ -1636,7 +1722,7 @@ export type ManagementProcedures = {
|
|
|
1636
1722
|
updatedAt: string;
|
|
1637
1723
|
};
|
|
1638
1724
|
};
|
|
1639
|
-
/** The caller's live management keys with pagination and search: name, fingerprint, scope, and dates. Never the key itself. */
|
|
1725
|
+
/** 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
1726
|
"managementKeys.list": {
|
|
1641
1727
|
input: {
|
|
1642
1728
|
pageIndex?: number;
|
|
@@ -1647,6 +1733,7 @@ export type ManagementProcedures = {
|
|
|
1647
1733
|
items: Array<{
|
|
1648
1734
|
id: string;
|
|
1649
1735
|
name: string;
|
|
1736
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1650
1737
|
fingerprint: string;
|
|
1651
1738
|
permissions: Array<string> | null;
|
|
1652
1739
|
lastUsedAt: string | null;
|
|
@@ -1659,12 +1746,13 @@ export type ManagementProcedures = {
|
|
|
1659
1746
|
filteredCount: number;
|
|
1660
1747
|
};
|
|
1661
1748
|
};
|
|
1662
|
-
/** The management key this request authenticated with (name, fingerprint, scope, dates). Refused for a session or an operator token, which are not keys. */
|
|
1749
|
+
/** 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
1750
|
"managementKeys.mine": {
|
|
1664
1751
|
input: undefined;
|
|
1665
1752
|
output: {
|
|
1666
1753
|
id: string;
|
|
1667
1754
|
name: string;
|
|
1755
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1668
1756
|
fingerprint: string;
|
|
1669
1757
|
permissions: Array<string> | null;
|
|
1670
1758
|
lastUsedAt: string | null;
|
|
@@ -1677,8 +1765,8 @@ export type ManagementProcedures = {
|
|
|
1677
1765
|
input: {
|
|
1678
1766
|
id: string;
|
|
1679
1767
|
agents?: Array<{
|
|
1680
|
-
slug: string;
|
|
1681
1768
|
name: string;
|
|
1769
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1682
1770
|
server?: string;
|
|
1683
1771
|
prompt: string;
|
|
1684
1772
|
auth: {
|
|
@@ -1755,11 +1843,12 @@ export type ManagementProcedures = {
|
|
|
1755
1843
|
prompt: string;
|
|
1756
1844
|
}>>;
|
|
1757
1845
|
greeting?: Record<"en" | "ar", string>;
|
|
1758
|
-
overridable?: Array<"
|
|
1846
|
+
overridable?: Array<"displayName" | "prompt" | "models" | "settings" | "rateLimits" | "suggestions" | "greeting">;
|
|
1759
1847
|
}>;
|
|
1760
1848
|
tools?: Array<{
|
|
1761
1849
|
name: string;
|
|
1762
1850
|
description: string;
|
|
1851
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1763
1852
|
inputSchema?: {
|
|
1764
1853
|
type: "object";
|
|
1765
1854
|
properties?: Record<string, ManifestsPreviewSchema0>;
|
|
@@ -1790,7 +1879,7 @@ export type ManagementProcedures = {
|
|
|
1790
1879
|
} | {
|
|
1791
1880
|
agents: Array<string>;
|
|
1792
1881
|
};
|
|
1793
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1882
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1794
1883
|
url: string;
|
|
1795
1884
|
headers?: Array<{
|
|
1796
1885
|
header: string;
|
|
@@ -1818,6 +1907,7 @@ export type ManagementProcedures = {
|
|
|
1818
1907
|
} | {
|
|
1819
1908
|
name: string;
|
|
1820
1909
|
description: string;
|
|
1910
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1821
1911
|
inputSchema?: {
|
|
1822
1912
|
type: "object";
|
|
1823
1913
|
properties?: Record<string, ManifestsPreviewSchema0>;
|
|
@@ -1848,7 +1938,7 @@ export type ManagementProcedures = {
|
|
|
1848
1938
|
} | {
|
|
1849
1939
|
agents: Array<string>;
|
|
1850
1940
|
};
|
|
1851
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1941
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1852
1942
|
url: string;
|
|
1853
1943
|
headers?: Array<{
|
|
1854
1944
|
header: string;
|
|
@@ -1873,6 +1963,7 @@ export type ManagementProcedures = {
|
|
|
1873
1963
|
} | {
|
|
1874
1964
|
name: string;
|
|
1875
1965
|
description: string;
|
|
1966
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1876
1967
|
inputSchema?: {
|
|
1877
1968
|
type: "object";
|
|
1878
1969
|
properties?: Record<string, ManifestsPreviewSchema0>;
|
|
@@ -1903,7 +1994,7 @@ export type ManagementProcedures = {
|
|
|
1903
1994
|
} | {
|
|
1904
1995
|
agents: Array<string>;
|
|
1905
1996
|
};
|
|
1906
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1997
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1907
1998
|
url: string;
|
|
1908
1999
|
headers?: Array<{
|
|
1909
2000
|
header: string;
|
|
@@ -1935,6 +2026,7 @@ export type ManagementProcedures = {
|
|
|
1935
2026
|
} | {
|
|
1936
2027
|
name: string;
|
|
1937
2028
|
description: string;
|
|
2029
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1938
2030
|
inputSchema?: {
|
|
1939
2031
|
type: "object";
|
|
1940
2032
|
properties?: Record<string, ManifestsPreviewSchema0>;
|
|
@@ -1965,7 +2057,7 @@ export type ManagementProcedures = {
|
|
|
1965
2057
|
} | {
|
|
1966
2058
|
agents: Array<string>;
|
|
1967
2059
|
};
|
|
1968
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags">;
|
|
2060
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags">;
|
|
1969
2061
|
type: "client";
|
|
1970
2062
|
}>;
|
|
1971
2063
|
openapi?: Array<{
|
|
@@ -1998,21 +2090,22 @@ export type ManagementProcedures = {
|
|
|
1998
2090
|
} | {
|
|
1999
2091
|
agents: Array<string>;
|
|
2000
2092
|
};
|
|
2001
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2093
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2002
2094
|
}>;
|
|
2003
2095
|
services?: Array<{
|
|
2004
|
-
|
|
2005
|
-
|
|
2096
|
+
name: string;
|
|
2097
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2006
2098
|
description: Record<"en" | "ar", string>;
|
|
2007
2099
|
audience: "all" | {
|
|
2008
2100
|
server: string;
|
|
2009
2101
|
} | {
|
|
2010
2102
|
agents: Array<string>;
|
|
2011
2103
|
};
|
|
2012
|
-
overridable?: Array<"description">;
|
|
2104
|
+
overridable?: Array<"displayName" | "description">;
|
|
2013
2105
|
}>;
|
|
2014
2106
|
skills?: Array<{
|
|
2015
2107
|
name: string;
|
|
2108
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2016
2109
|
description: string;
|
|
2017
2110
|
body: string;
|
|
2018
2111
|
service?: string;
|
|
@@ -2021,10 +2114,11 @@ export type ManagementProcedures = {
|
|
|
2021
2114
|
} | {
|
|
2022
2115
|
agents: Array<string>;
|
|
2023
2116
|
};
|
|
2024
|
-
overridable?: Array<"description" | "body">;
|
|
2117
|
+
overridable?: Array<"displayName" | "description" | "body">;
|
|
2025
2118
|
}>;
|
|
2026
2119
|
triggers?: Array<{
|
|
2027
2120
|
name: string;
|
|
2121
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2028
2122
|
description: string;
|
|
2029
2123
|
inputSchema?: {
|
|
2030
2124
|
type: "object";
|
|
@@ -2063,10 +2157,11 @@ export type ManagementProcedures = {
|
|
|
2063
2157
|
} | {
|
|
2064
2158
|
agents: Array<string>;
|
|
2065
2159
|
};
|
|
2066
|
-
overridable?: Array<"description" | "instructions" | "threadPolicy" | "budgetPerDay" | "disableAfterFailures" | "model">;
|
|
2160
|
+
overridable?: Array<"displayName" | "description" | "instructions" | "threadPolicy" | "budgetPerDay" | "disableAfterFailures" | "model">;
|
|
2067
2161
|
}>;
|
|
2068
2162
|
datasetHosts?: Array<{
|
|
2069
2163
|
name: string;
|
|
2164
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2070
2165
|
url: string;
|
|
2071
2166
|
headers?: Array<{
|
|
2072
2167
|
header: string;
|
|
@@ -2100,10 +2195,11 @@ export type ManagementProcedures = {
|
|
|
2100
2195
|
} | {
|
|
2101
2196
|
agents: Array<string>;
|
|
2102
2197
|
};
|
|
2103
|
-
overridable?: Array<"timeoutMs" | "rateLimits" | "headers">;
|
|
2198
|
+
overridable?: Array<"displayName" | "timeoutMs" | "rateLimits" | "headers">;
|
|
2104
2199
|
}>;
|
|
2105
2200
|
mcpServers?: Array<{
|
|
2106
2201
|
name: string;
|
|
2202
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2107
2203
|
url: string;
|
|
2108
2204
|
headers?: Array<{
|
|
2109
2205
|
header: string;
|
|
@@ -2121,6 +2217,11 @@ export type ManagementProcedures = {
|
|
|
2121
2217
|
value: string;
|
|
2122
2218
|
};
|
|
2123
2219
|
}>;
|
|
2220
|
+
signIn?: {
|
|
2221
|
+
connects: "shared" | "endUser";
|
|
2222
|
+
scope?: string;
|
|
2223
|
+
credential?: string;
|
|
2224
|
+
};
|
|
2124
2225
|
include?: Array<string>;
|
|
2125
2226
|
exclude?: Array<string>;
|
|
2126
2227
|
audience: "all" | {
|
|
@@ -2128,10 +2229,11 @@ export type ManagementProcedures = {
|
|
|
2128
2229
|
} | {
|
|
2129
2230
|
agents: Array<string>;
|
|
2130
2231
|
};
|
|
2131
|
-
overridable?: Array<"include" | "exclude" | "headers">;
|
|
2232
|
+
overridable?: Array<"displayName" | "include" | "exclude" | "headers" | "signIn">;
|
|
2132
2233
|
}>;
|
|
2133
2234
|
webhooks?: Array<{
|
|
2134
2235
|
name: string;
|
|
2236
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2135
2237
|
description?: string;
|
|
2136
2238
|
event: "approval_requested";
|
|
2137
2239
|
url: string;
|
|
@@ -2152,10 +2254,11 @@ export type ManagementProcedures = {
|
|
|
2152
2254
|
} | {
|
|
2153
2255
|
agents: Array<string>;
|
|
2154
2256
|
};
|
|
2155
|
-
overridable?: Array<"description" | "timeoutMs" | "headers">;
|
|
2257
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "headers">;
|
|
2156
2258
|
}>;
|
|
2157
2259
|
collections?: Array<{
|
|
2158
2260
|
name: string;
|
|
2261
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2159
2262
|
description?: string;
|
|
2160
2263
|
service?: string;
|
|
2161
2264
|
citable?: boolean;
|
|
@@ -2174,7 +2277,7 @@ export type ManagementProcedures = {
|
|
|
2174
2277
|
} | {
|
|
2175
2278
|
agents: Array<string>;
|
|
2176
2279
|
};
|
|
2177
|
-
overridable?: Array<"description" | "documents">;
|
|
2280
|
+
overridable?: Array<"displayName" | "description" | "documents">;
|
|
2178
2281
|
}>;
|
|
2179
2282
|
prefer?: "live" | "manifest";
|
|
2180
2283
|
resolutions?: Array<{
|
|
@@ -2202,8 +2305,8 @@ export type ManagementProcedures = {
|
|
|
2202
2305
|
input: {
|
|
2203
2306
|
id: string;
|
|
2204
2307
|
agents?: Array<{
|
|
2205
|
-
slug: string;
|
|
2206
2308
|
name: string;
|
|
2309
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2207
2310
|
server?: string;
|
|
2208
2311
|
prompt: string;
|
|
2209
2312
|
auth: {
|
|
@@ -2280,11 +2383,12 @@ export type ManagementProcedures = {
|
|
|
2280
2383
|
prompt: string;
|
|
2281
2384
|
}>>;
|
|
2282
2385
|
greeting?: Record<"en" | "ar", string>;
|
|
2283
|
-
overridable?: Array<"
|
|
2386
|
+
overridable?: Array<"displayName" | "prompt" | "models" | "settings" | "rateLimits" | "suggestions" | "greeting">;
|
|
2284
2387
|
}>;
|
|
2285
2388
|
tools?: Array<{
|
|
2286
2389
|
name: string;
|
|
2287
2390
|
description: string;
|
|
2391
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2288
2392
|
inputSchema?: {
|
|
2289
2393
|
type: "object";
|
|
2290
2394
|
properties?: Record<string, ManifestsSyncSchema0>;
|
|
@@ -2315,7 +2419,7 @@ export type ManagementProcedures = {
|
|
|
2315
2419
|
} | {
|
|
2316
2420
|
agents: Array<string>;
|
|
2317
2421
|
};
|
|
2318
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2422
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2319
2423
|
url: string;
|
|
2320
2424
|
headers?: Array<{
|
|
2321
2425
|
header: string;
|
|
@@ -2343,6 +2447,7 @@ export type ManagementProcedures = {
|
|
|
2343
2447
|
} | {
|
|
2344
2448
|
name: string;
|
|
2345
2449
|
description: string;
|
|
2450
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2346
2451
|
inputSchema?: {
|
|
2347
2452
|
type: "object";
|
|
2348
2453
|
properties?: Record<string, ManifestsSyncSchema0>;
|
|
@@ -2373,7 +2478,7 @@ export type ManagementProcedures = {
|
|
|
2373
2478
|
} | {
|
|
2374
2479
|
agents: Array<string>;
|
|
2375
2480
|
};
|
|
2376
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2481
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2377
2482
|
url: string;
|
|
2378
2483
|
headers?: Array<{
|
|
2379
2484
|
header: string;
|
|
@@ -2398,6 +2503,7 @@ export type ManagementProcedures = {
|
|
|
2398
2503
|
} | {
|
|
2399
2504
|
name: string;
|
|
2400
2505
|
description: string;
|
|
2506
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2401
2507
|
inputSchema?: {
|
|
2402
2508
|
type: "object";
|
|
2403
2509
|
properties?: Record<string, ManifestsSyncSchema0>;
|
|
@@ -2428,7 +2534,7 @@ export type ManagementProcedures = {
|
|
|
2428
2534
|
} | {
|
|
2429
2535
|
agents: Array<string>;
|
|
2430
2536
|
};
|
|
2431
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2537
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2432
2538
|
url: string;
|
|
2433
2539
|
headers?: Array<{
|
|
2434
2540
|
header: string;
|
|
@@ -2460,6 +2566,7 @@ export type ManagementProcedures = {
|
|
|
2460
2566
|
} | {
|
|
2461
2567
|
name: string;
|
|
2462
2568
|
description: string;
|
|
2569
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2463
2570
|
inputSchema?: {
|
|
2464
2571
|
type: "object";
|
|
2465
2572
|
properties?: Record<string, ManifestsSyncSchema0>;
|
|
@@ -2490,7 +2597,7 @@ export type ManagementProcedures = {
|
|
|
2490
2597
|
} | {
|
|
2491
2598
|
agents: Array<string>;
|
|
2492
2599
|
};
|
|
2493
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags">;
|
|
2600
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags">;
|
|
2494
2601
|
type: "client";
|
|
2495
2602
|
}>;
|
|
2496
2603
|
openapi?: Array<{
|
|
@@ -2523,21 +2630,22 @@ export type ManagementProcedures = {
|
|
|
2523
2630
|
} | {
|
|
2524
2631
|
agents: Array<string>;
|
|
2525
2632
|
};
|
|
2526
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2633
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2527
2634
|
}>;
|
|
2528
2635
|
services?: Array<{
|
|
2529
|
-
|
|
2530
|
-
|
|
2636
|
+
name: string;
|
|
2637
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2531
2638
|
description: Record<"en" | "ar", string>;
|
|
2532
2639
|
audience: "all" | {
|
|
2533
2640
|
server: string;
|
|
2534
2641
|
} | {
|
|
2535
2642
|
agents: Array<string>;
|
|
2536
2643
|
};
|
|
2537
|
-
overridable?: Array<"description">;
|
|
2644
|
+
overridable?: Array<"displayName" | "description">;
|
|
2538
2645
|
}>;
|
|
2539
2646
|
skills?: Array<{
|
|
2540
2647
|
name: string;
|
|
2648
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2541
2649
|
description: string;
|
|
2542
2650
|
body: string;
|
|
2543
2651
|
service?: string;
|
|
@@ -2546,10 +2654,11 @@ export type ManagementProcedures = {
|
|
|
2546
2654
|
} | {
|
|
2547
2655
|
agents: Array<string>;
|
|
2548
2656
|
};
|
|
2549
|
-
overridable?: Array<"description" | "body">;
|
|
2657
|
+
overridable?: Array<"displayName" | "description" | "body">;
|
|
2550
2658
|
}>;
|
|
2551
2659
|
triggers?: Array<{
|
|
2552
2660
|
name: string;
|
|
2661
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2553
2662
|
description: string;
|
|
2554
2663
|
inputSchema?: {
|
|
2555
2664
|
type: "object";
|
|
@@ -2588,10 +2697,11 @@ export type ManagementProcedures = {
|
|
|
2588
2697
|
} | {
|
|
2589
2698
|
agents: Array<string>;
|
|
2590
2699
|
};
|
|
2591
|
-
overridable?: Array<"description" | "instructions" | "threadPolicy" | "budgetPerDay" | "disableAfterFailures" | "model">;
|
|
2700
|
+
overridable?: Array<"displayName" | "description" | "instructions" | "threadPolicy" | "budgetPerDay" | "disableAfterFailures" | "model">;
|
|
2592
2701
|
}>;
|
|
2593
2702
|
datasetHosts?: Array<{
|
|
2594
2703
|
name: string;
|
|
2704
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2595
2705
|
url: string;
|
|
2596
2706
|
headers?: Array<{
|
|
2597
2707
|
header: string;
|
|
@@ -2625,10 +2735,11 @@ export type ManagementProcedures = {
|
|
|
2625
2735
|
} | {
|
|
2626
2736
|
agents: Array<string>;
|
|
2627
2737
|
};
|
|
2628
|
-
overridable?: Array<"timeoutMs" | "rateLimits" | "headers">;
|
|
2738
|
+
overridable?: Array<"displayName" | "timeoutMs" | "rateLimits" | "headers">;
|
|
2629
2739
|
}>;
|
|
2630
2740
|
mcpServers?: Array<{
|
|
2631
2741
|
name: string;
|
|
2742
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2632
2743
|
url: string;
|
|
2633
2744
|
headers?: Array<{
|
|
2634
2745
|
header: string;
|
|
@@ -2646,6 +2757,11 @@ export type ManagementProcedures = {
|
|
|
2646
2757
|
value: string;
|
|
2647
2758
|
};
|
|
2648
2759
|
}>;
|
|
2760
|
+
signIn?: {
|
|
2761
|
+
connects: "shared" | "endUser";
|
|
2762
|
+
scope?: string;
|
|
2763
|
+
credential?: string;
|
|
2764
|
+
};
|
|
2649
2765
|
include?: Array<string>;
|
|
2650
2766
|
exclude?: Array<string>;
|
|
2651
2767
|
audience: "all" | {
|
|
@@ -2653,10 +2769,11 @@ export type ManagementProcedures = {
|
|
|
2653
2769
|
} | {
|
|
2654
2770
|
agents: Array<string>;
|
|
2655
2771
|
};
|
|
2656
|
-
overridable?: Array<"include" | "exclude" | "headers">;
|
|
2772
|
+
overridable?: Array<"displayName" | "include" | "exclude" | "headers" | "signIn">;
|
|
2657
2773
|
}>;
|
|
2658
2774
|
webhooks?: Array<{
|
|
2659
2775
|
name: string;
|
|
2776
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2660
2777
|
description?: string;
|
|
2661
2778
|
event: "approval_requested";
|
|
2662
2779
|
url: string;
|
|
@@ -2677,10 +2794,11 @@ export type ManagementProcedures = {
|
|
|
2677
2794
|
} | {
|
|
2678
2795
|
agents: Array<string>;
|
|
2679
2796
|
};
|
|
2680
|
-
overridable?: Array<"description" | "timeoutMs" | "headers">;
|
|
2797
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "headers">;
|
|
2681
2798
|
}>;
|
|
2682
2799
|
collections?: Array<{
|
|
2683
2800
|
name: string;
|
|
2801
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2684
2802
|
description?: string;
|
|
2685
2803
|
service?: string;
|
|
2686
2804
|
citable?: boolean;
|
|
@@ -2699,7 +2817,7 @@ export type ManagementProcedures = {
|
|
|
2699
2817
|
} | {
|
|
2700
2818
|
agents: Array<string>;
|
|
2701
2819
|
};
|
|
2702
|
-
overridable?: Array<"description" | "documents">;
|
|
2820
|
+
overridable?: Array<"displayName" | "description" | "documents">;
|
|
2703
2821
|
}>;
|
|
2704
2822
|
prefer?: "live" | "manifest";
|
|
2705
2823
|
resolutions?: Array<{
|
|
@@ -2722,6 +2840,7 @@ export type ManagementProcedures = {
|
|
|
2722
2840
|
input: {
|
|
2723
2841
|
name: string;
|
|
2724
2842
|
url: string;
|
|
2843
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2725
2844
|
audience: {
|
|
2726
2845
|
kind: "all";
|
|
2727
2846
|
} | {
|
|
@@ -2746,7 +2865,30 @@ export type ManagementProcedures = {
|
|
|
2746
2865
|
id: string;
|
|
2747
2866
|
};
|
|
2748
2867
|
};
|
|
2749
|
-
/**
|
|
2868
|
+
/** Find how Cortex would sign in to the MCP server with OAuth, from its metadata: the authorization server's issuer, the method Cortex would use (`preRegistered`, `clientIdDocument`, `dynamicRegistration`, or null for none), the scopes on offer, whether PKCE with S256 is supported, and the resource tokens are for. A pre-registered app for another issuer is refused as `sign_in_issuer_mismatch`. */
|
|
2869
|
+
"mcpServers.detectSignIn": {
|
|
2870
|
+
input: {
|
|
2871
|
+
id: string;
|
|
2872
|
+
};
|
|
2873
|
+
output: {
|
|
2874
|
+
issuer: string;
|
|
2875
|
+
method: "preRegistered" | "clientIdDocument" | "dynamicRegistration" | null;
|
|
2876
|
+
scopes: Array<string>;
|
|
2877
|
+
pkce: boolean;
|
|
2878
|
+
resource: string;
|
|
2879
|
+
};
|
|
2880
|
+
};
|
|
2881
|
+
/** Forget every connection Cortex holds to the MCP server: the shared one, or every end user's. Its turns report it not connected until someone signs in again. The tokens are not revoked at the authorization server. */
|
|
2882
|
+
"mcpServers.disconnect": {
|
|
2883
|
+
input: {
|
|
2884
|
+
id: string;
|
|
2885
|
+
};
|
|
2886
|
+
output: {
|
|
2887
|
+
id: string;
|
|
2888
|
+
name: string;
|
|
2889
|
+
};
|
|
2890
|
+
};
|
|
2891
|
+
/** One MCP server by id with its url, headers, sign-in, tool filters, and sharing; its shared connection, never its tokens, with `stepUp` once its server refused a call for lack of scope (the scopes it lacks, and whether a sign-in may still ask for them); how many end users are connected or must sign in again; and `signInUrl`, where a browser form-posts an operator token and the server's id to connect it (null while the engine or the console has no public URL). */
|
|
2750
2892
|
"mcpServers.get": {
|
|
2751
2893
|
input: {
|
|
2752
2894
|
id: string;
|
|
@@ -2767,6 +2909,7 @@ export type ManagementProcedures = {
|
|
|
2767
2909
|
agentIds: Array<string>;
|
|
2768
2910
|
};
|
|
2769
2911
|
name: string;
|
|
2912
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2770
2913
|
url: string;
|
|
2771
2914
|
headers: Array<{
|
|
2772
2915
|
header: string;
|
|
@@ -2784,14 +2927,20 @@ export type ManagementProcedures = {
|
|
|
2784
2927
|
value: string;
|
|
2785
2928
|
};
|
|
2786
2929
|
}>;
|
|
2930
|
+
signIn: {
|
|
2931
|
+
connects: "shared" | "endUser";
|
|
2932
|
+
scope?: string;
|
|
2933
|
+
credential?: string;
|
|
2934
|
+
} | null;
|
|
2787
2935
|
include: Array<string>;
|
|
2788
2936
|
exclude: Array<string>;
|
|
2789
2937
|
status: "draft" | "published" | "disabled";
|
|
2790
2938
|
updatedAt: string;
|
|
2791
2939
|
referrers: Array<{
|
|
2940
|
+
name: string;
|
|
2941
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2792
2942
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
2793
2943
|
id: string;
|
|
2794
|
-
name: string;
|
|
2795
2944
|
readers: {
|
|
2796
2945
|
kind: "all";
|
|
2797
2946
|
} | {
|
|
@@ -2802,7 +2951,6 @@ export type ManagementProcedures = {
|
|
|
2802
2951
|
agentIds: Array<string>;
|
|
2803
2952
|
};
|
|
2804
2953
|
}>;
|
|
2805
|
-
nameLocked: boolean;
|
|
2806
2954
|
variables: Array<{
|
|
2807
2955
|
name: string;
|
|
2808
2956
|
description: string;
|
|
@@ -2810,6 +2958,22 @@ export type ManagementProcedures = {
|
|
|
2810
2958
|
type: "string" | "number" | "boolean";
|
|
2811
2959
|
computed: boolean;
|
|
2812
2960
|
}>;
|
|
2961
|
+
connection: {
|
|
2962
|
+
status: "connected" | "needs_scope" | "broken";
|
|
2963
|
+
issuer: string;
|
|
2964
|
+
scope: string;
|
|
2965
|
+
expiresAt: string | null;
|
|
2966
|
+
updatedAt: string;
|
|
2967
|
+
stepUp: {
|
|
2968
|
+
missing: string;
|
|
2969
|
+
grantable: boolean;
|
|
2970
|
+
} | null;
|
|
2971
|
+
} | null;
|
|
2972
|
+
endUsers: {
|
|
2973
|
+
connected: number;
|
|
2974
|
+
broken: number;
|
|
2975
|
+
};
|
|
2976
|
+
signInUrl: string | null;
|
|
2813
2977
|
};
|
|
2814
2978
|
};
|
|
2815
2979
|
/** List MCP servers with pagination and search. */
|
|
@@ -2828,6 +2992,7 @@ export type ManagementProcedures = {
|
|
|
2828
2992
|
name: string;
|
|
2829
2993
|
url: string;
|
|
2830
2994
|
status: "draft" | "published" | "disabled";
|
|
2995
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2831
2996
|
source: "direct" | "manifest" | "server";
|
|
2832
2997
|
sourceId: string | null;
|
|
2833
2998
|
overridable: Array<string>;
|
|
@@ -2938,10 +3103,9 @@ export type ManagementProcedures = {
|
|
|
2938
3103
|
unchanged: boolean;
|
|
2939
3104
|
};
|
|
2940
3105
|
};
|
|
2941
|
-
/** Update an MCP server's draft:
|
|
3106
|
+
/** 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, headers (each with a prefix and its value from a credential, the run token, a variable or a constant) and `signIn` apply live without a publish. `signIn` (null for none) has Cortex sign in with OAuth: `connects` is `shared` (an operator connects once for every agent) or `endUser` (each end user connects their own), `scope` what to ask for, and `credential` names the app registered with the authorization server beforehand, an `oauth2-client-credentials` credential naming its `issuer`. A server that signs in declares no Authorization header. */
|
|
2942
3107
|
"mcpServers.update": {
|
|
2943
3108
|
input: {
|
|
2944
|
-
name: string;
|
|
2945
3109
|
url: string;
|
|
2946
3110
|
headers: Array<{
|
|
2947
3111
|
header: string;
|
|
@@ -2959,27 +3123,36 @@ export type ManagementProcedures = {
|
|
|
2959
3123
|
value: string;
|
|
2960
3124
|
};
|
|
2961
3125
|
}>;
|
|
3126
|
+
signIn: {
|
|
3127
|
+
connects: "shared" | "endUser";
|
|
3128
|
+
scope?: string;
|
|
3129
|
+
credential?: string;
|
|
3130
|
+
} | null;
|
|
2962
3131
|
include: Array<string>;
|
|
2963
3132
|
exclude: Array<string>;
|
|
2964
3133
|
id: string;
|
|
3134
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2965
3135
|
};
|
|
2966
3136
|
output: {
|
|
2967
3137
|
id: string;
|
|
2968
3138
|
name: string;
|
|
2969
3139
|
};
|
|
2970
3140
|
};
|
|
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`. */
|
|
3141
|
+
/** 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
3142
|
"modelProviders.create": {
|
|
2973
3143
|
input: {
|
|
3144
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2974
3145
|
baseUrl: string;
|
|
2975
3146
|
secretName: string;
|
|
2976
3147
|
models: Array<string>;
|
|
2977
3148
|
efforts: Array<string>;
|
|
3149
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
2978
3150
|
name: string;
|
|
2979
3151
|
};
|
|
2980
3152
|
output: {
|
|
2981
3153
|
id: string;
|
|
2982
3154
|
name: string;
|
|
3155
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2983
3156
|
baseUrl: string;
|
|
2984
3157
|
secretName: string;
|
|
2985
3158
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
@@ -2996,6 +3169,7 @@ export type ManagementProcedures = {
|
|
|
2996
3169
|
output: {
|
|
2997
3170
|
id: string;
|
|
2998
3171
|
name: string;
|
|
3172
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2999
3173
|
baseUrl: string;
|
|
3000
3174
|
secretName: string;
|
|
3001
3175
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
@@ -3026,6 +3200,7 @@ export type ManagementProcedures = {
|
|
|
3026
3200
|
items: Array<{
|
|
3027
3201
|
id: string;
|
|
3028
3202
|
name: string;
|
|
3203
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3029
3204
|
baseUrl: string;
|
|
3030
3205
|
secretName: string;
|
|
3031
3206
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
@@ -3035,9 +3210,10 @@ export type ManagementProcedures = {
|
|
|
3035
3210
|
usedBy: {
|
|
3036
3211
|
count: number;
|
|
3037
3212
|
preview: Array<{
|
|
3213
|
+
name: string;
|
|
3214
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3038
3215
|
kind: "credential" | "model_provider" | "server" | "agent" | "tool" | "trigger" | "dataset_host" | "webhook" | "mcp_server";
|
|
3039
3216
|
id: string;
|
|
3040
|
-
name: string;
|
|
3041
3217
|
}>;
|
|
3042
3218
|
};
|
|
3043
3219
|
}>;
|
|
@@ -3047,18 +3223,20 @@ export type ManagementProcedures = {
|
|
|
3047
3223
|
filteredCount: number;
|
|
3048
3224
|
};
|
|
3049
3225
|
};
|
|
3050
|
-
/** Every model provider with its models and efforts, in name order, for a model picker. */
|
|
3226
|
+
/** Every model provider with its display name, models and efforts, in name order, for a model picker. */
|
|
3051
3227
|
"modelProviders.options": {
|
|
3052
3228
|
input: undefined;
|
|
3053
3229
|
output: Array<{
|
|
3054
3230
|
name: string;
|
|
3231
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3055
3232
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
3056
3233
|
efforts: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
3057
3234
|
}>;
|
|
3058
3235
|
};
|
|
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. */
|
|
3236
|
+
/** 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
3237
|
"modelProviders.update": {
|
|
3061
3238
|
input: {
|
|
3239
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3062
3240
|
baseUrl: string;
|
|
3063
3241
|
secretName: string;
|
|
3064
3242
|
models: Array<string>;
|
|
@@ -3068,6 +3246,7 @@ export type ManagementProcedures = {
|
|
|
3068
3246
|
output: {
|
|
3069
3247
|
id: string;
|
|
3070
3248
|
name: string;
|
|
3249
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3071
3250
|
baseUrl: string;
|
|
3072
3251
|
secretName: string;
|
|
3073
3252
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
@@ -3090,7 +3269,10 @@ export type ManagementProcedures = {
|
|
|
3090
3269
|
callerId: string | null;
|
|
3091
3270
|
toolName: string;
|
|
3092
3271
|
createdAt: string;
|
|
3093
|
-
|
|
3272
|
+
agent: {
|
|
3273
|
+
name: string;
|
|
3274
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3275
|
+
};
|
|
3094
3276
|
triggerName: string | null;
|
|
3095
3277
|
threadId: string | null;
|
|
3096
3278
|
threadTitle: string | null;
|
|
@@ -3126,7 +3308,8 @@ export type ManagementProcedures = {
|
|
|
3126
3308
|
entityType: "knowledge" | "service" | "tool";
|
|
3127
3309
|
entityId: string;
|
|
3128
3310
|
collectionId: string | null;
|
|
3129
|
-
name:
|
|
3311
|
+
name: string;
|
|
3312
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3130
3313
|
resolutionCount: number;
|
|
3131
3314
|
}>;
|
|
3132
3315
|
broadTools: Array<{
|
|
@@ -3138,13 +3321,19 @@ export type ManagementProcedures = {
|
|
|
3138
3321
|
missingQueries: Array<{
|
|
3139
3322
|
queryHash: string;
|
|
3140
3323
|
agentId: string;
|
|
3141
|
-
|
|
3324
|
+
agent: {
|
|
3325
|
+
name: string;
|
|
3326
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3327
|
+
};
|
|
3142
3328
|
searchCount: number;
|
|
3143
3329
|
lastSearchedAt: string;
|
|
3144
3330
|
}>;
|
|
3145
3331
|
hitRates: Array<{
|
|
3146
3332
|
agentId: string;
|
|
3147
|
-
|
|
3333
|
+
agent: {
|
|
3334
|
+
name: string;
|
|
3335
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3336
|
+
};
|
|
3148
3337
|
retrievalCount: number;
|
|
3149
3338
|
hitCount: number;
|
|
3150
3339
|
hitRate: number;
|
|
@@ -3163,9 +3352,14 @@ export type ManagementProcedures = {
|
|
|
3163
3352
|
outcome: "started" | "awaiting_approval" | "completed" | "failed" | "rejected" | "dropped";
|
|
3164
3353
|
reason: "busy" | "approval_pending" | "budget" | "rate_limited" | "invalid_payload" | "missing_thread_key" | "no_turn" | "no_output" | "invalid_output" | null;
|
|
3165
3354
|
output: unknown;
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
|
|
3355
|
+
server: {
|
|
3356
|
+
name: string;
|
|
3357
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3358
|
+
} | null;
|
|
3359
|
+
agent: {
|
|
3360
|
+
name: string;
|
|
3361
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3362
|
+
};
|
|
3169
3363
|
threadTitle: string | null;
|
|
3170
3364
|
createdAt: string;
|
|
3171
3365
|
finishedAt: string | null;
|
|
@@ -3200,7 +3394,10 @@ export type ManagementProcedures = {
|
|
|
3200
3394
|
};
|
|
3201
3395
|
perUser: Array<{
|
|
3202
3396
|
scopeId: string;
|
|
3203
|
-
|
|
3397
|
+
scope: {
|
|
3398
|
+
name: string;
|
|
3399
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3400
|
+
};
|
|
3204
3401
|
userId: string;
|
|
3205
3402
|
triggerName: string | null;
|
|
3206
3403
|
threads: number;
|
|
@@ -3213,11 +3410,17 @@ export type ManagementProcedures = {
|
|
|
3213
3410
|
}>;
|
|
3214
3411
|
perServer: Array<{
|
|
3215
3412
|
serverId: string | null;
|
|
3216
|
-
|
|
3413
|
+
server: {
|
|
3414
|
+
name: string;
|
|
3415
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3416
|
+
} | null;
|
|
3217
3417
|
totalTokens: number;
|
|
3218
3418
|
}>;
|
|
3219
3419
|
perAgent: Array<{
|
|
3220
|
-
|
|
3420
|
+
agent: {
|
|
3421
|
+
name: string;
|
|
3422
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3423
|
+
};
|
|
3221
3424
|
totalTokens: number;
|
|
3222
3425
|
}>;
|
|
3223
3426
|
perDay: Array<{
|
|
@@ -3251,9 +3454,14 @@ export type ManagementProcedures = {
|
|
|
3251
3454
|
detail: string | null;
|
|
3252
3455
|
threadId: string;
|
|
3253
3456
|
createdAt: string;
|
|
3254
|
-
|
|
3255
|
-
|
|
3256
|
-
|
|
3457
|
+
server: {
|
|
3458
|
+
name: string;
|
|
3459
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3460
|
+
} | null;
|
|
3461
|
+
agent: {
|
|
3462
|
+
name: string;
|
|
3463
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3464
|
+
};
|
|
3257
3465
|
threadTitle: string | null;
|
|
3258
3466
|
}>;
|
|
3259
3467
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
@@ -3286,7 +3494,10 @@ export type ManagementProcedures = {
|
|
|
3286
3494
|
callerId: string | null;
|
|
3287
3495
|
toolName: string;
|
|
3288
3496
|
createdAt: string;
|
|
3289
|
-
|
|
3497
|
+
agent: {
|
|
3498
|
+
name: string;
|
|
3499
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3500
|
+
};
|
|
3290
3501
|
triggerName: string | null;
|
|
3291
3502
|
}>;
|
|
3292
3503
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
@@ -3356,7 +3567,10 @@ export type ManagementProcedures = {
|
|
|
3356
3567
|
output: {
|
|
3357
3568
|
items: Array<{
|
|
3358
3569
|
agentId: string;
|
|
3359
|
-
|
|
3570
|
+
agent: {
|
|
3571
|
+
name: string;
|
|
3572
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3573
|
+
};
|
|
3360
3574
|
skillName: string;
|
|
3361
3575
|
misses: number;
|
|
3362
3576
|
lastSeenAt: string | null;
|
|
@@ -3433,9 +3647,14 @@ export type ManagementProcedures = {
|
|
|
3433
3647
|
outcome: "started" | "awaiting_approval" | "completed" | "failed" | "rejected" | "dropped";
|
|
3434
3648
|
reason: "busy" | "approval_pending" | "budget" | "rate_limited" | "invalid_payload" | "missing_thread_key" | "no_turn" | "no_output" | "invalid_output" | null;
|
|
3435
3649
|
output: unknown;
|
|
3436
|
-
|
|
3437
|
-
|
|
3438
|
-
|
|
3650
|
+
server: {
|
|
3651
|
+
name: string;
|
|
3652
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3653
|
+
} | null;
|
|
3654
|
+
agent: {
|
|
3655
|
+
name: string;
|
|
3656
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3657
|
+
};
|
|
3439
3658
|
threadTitle: string | null;
|
|
3440
3659
|
createdAt: string;
|
|
3441
3660
|
finishedAt: string | null;
|
|
@@ -3480,9 +3699,10 @@ export type ManagementProcedures = {
|
|
|
3480
3699
|
agentId: string;
|
|
3481
3700
|
};
|
|
3482
3701
|
output: Array<{
|
|
3702
|
+
name: string;
|
|
3703
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3483
3704
|
kind: "tool" | "service" | "skill" | "trigger" | "dataset_host" | "mcp_server" | "webhook" | "knowledge_collection";
|
|
3484
3705
|
id: string;
|
|
3485
|
-
name: string;
|
|
3486
3706
|
}>;
|
|
3487
3707
|
};
|
|
3488
3708
|
/** Publication history of an entity with pagination. */
|
|
@@ -3589,11 +3809,12 @@ export type ManagementProcedures = {
|
|
|
3589
3809
|
output: {
|
|
3590
3810
|
id: string;
|
|
3591
3811
|
name: string;
|
|
3812
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3592
3813
|
createdAt: string;
|
|
3593
3814
|
updatedAt: string;
|
|
3594
3815
|
};
|
|
3595
3816
|
};
|
|
3596
|
-
/** List
|
|
3817
|
+
/** 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
3818
|
"secrets.list": {
|
|
3598
3819
|
input: {
|
|
3599
3820
|
pageIndex?: number;
|
|
@@ -3604,14 +3825,16 @@ export type ManagementProcedures = {
|
|
|
3604
3825
|
items: Array<{
|
|
3605
3826
|
id: string;
|
|
3606
3827
|
name: string;
|
|
3828
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3607
3829
|
createdAt: string;
|
|
3608
3830
|
updatedAt: string;
|
|
3609
3831
|
usedBy: {
|
|
3610
3832
|
count: number;
|
|
3611
3833
|
preview: Array<{
|
|
3834
|
+
name: string;
|
|
3835
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3612
3836
|
kind: "credential" | "model_provider" | "server" | "agent" | "tool" | "trigger" | "dataset_host" | "webhook" | "mcp_server";
|
|
3613
3837
|
id: string;
|
|
3614
|
-
name: string;
|
|
3615
3838
|
}>;
|
|
3616
3839
|
};
|
|
3617
3840
|
}>;
|
|
@@ -3621,12 +3844,15 @@ export type ManagementProcedures = {
|
|
|
3621
3844
|
filteredCount: number;
|
|
3622
3845
|
};
|
|
3623
3846
|
};
|
|
3624
|
-
/** Every secret name in order, for a picker. */
|
|
3847
|
+
/** Every secret's name and display name, in name order, for a picker. */
|
|
3625
3848
|
"secrets.names": {
|
|
3626
3849
|
input: undefined;
|
|
3627
|
-
output: Array<
|
|
3850
|
+
output: Array<{
|
|
3851
|
+
name: string;
|
|
3852
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3853
|
+
}>;
|
|
3628
3854
|
};
|
|
3629
|
-
/** Replace a secret's value in place. */
|
|
3855
|
+
/** Replace a secret's value in place; a `private_key_jwt` credential's generated key is refused (`signing_key_secret`), since only `credentials.rotateKey` rewrites it. */
|
|
3630
3856
|
"secrets.rotate": {
|
|
3631
3857
|
input: {
|
|
3632
3858
|
id: string;
|
|
@@ -3635,27 +3861,45 @@ export type ManagementProcedures = {
|
|
|
3635
3861
|
output: {
|
|
3636
3862
|
id: string;
|
|
3637
3863
|
name: string;
|
|
3864
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3638
3865
|
createdAt: string;
|
|
3639
3866
|
updatedAt: string;
|
|
3640
3867
|
};
|
|
3641
3868
|
};
|
|
3642
|
-
/** Create a named secret; credentials compose it by name, and a tool input field may read it. */
|
|
3869
|
+
/** 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
3870
|
"secrets.set": {
|
|
3644
3871
|
input: {
|
|
3872
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
3645
3873
|
name: string;
|
|
3874
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3646
3875
|
value: string;
|
|
3647
3876
|
};
|
|
3648
3877
|
output: {
|
|
3649
3878
|
id: string;
|
|
3650
3879
|
name: string;
|
|
3880
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3651
3881
|
createdAt: string;
|
|
3652
3882
|
updatedAt: string;
|
|
3653
3883
|
};
|
|
3654
3884
|
};
|
|
3655
|
-
/**
|
|
3656
|
-
"
|
|
3885
|
+
/** Set a secret's display name, a text per locale. Its name and value stay; `secrets.rotate` replaces the value. */
|
|
3886
|
+
"secrets.update": {
|
|
3657
3887
|
input: {
|
|
3888
|
+
id: string;
|
|
3889
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3890
|
+
};
|
|
3891
|
+
output: {
|
|
3892
|
+
id: string;
|
|
3658
3893
|
name: string;
|
|
3894
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3895
|
+
createdAt: string;
|
|
3896
|
+
updatedAt: string;
|
|
3897
|
+
};
|
|
3898
|
+
};
|
|
3899
|
+
/** 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. */
|
|
3900
|
+
"servers.create": {
|
|
3901
|
+
input: {
|
|
3902
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3659
3903
|
description: string;
|
|
3660
3904
|
url: string | "";
|
|
3661
3905
|
keySecretName: string;
|
|
@@ -3664,10 +3908,13 @@ export type ManagementProcedures = {
|
|
|
3664
3908
|
modelEffort: string | null;
|
|
3665
3909
|
signInChecksPerMinute: number;
|
|
3666
3910
|
triggerChecksPerMinute: number;
|
|
3911
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
3912
|
+
name: string;
|
|
3667
3913
|
};
|
|
3668
3914
|
output: {
|
|
3669
3915
|
id: string;
|
|
3670
3916
|
name: string;
|
|
3917
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3671
3918
|
description: string | null;
|
|
3672
3919
|
url: string | null;
|
|
3673
3920
|
keySecretName: string | null;
|
|
@@ -3681,6 +3928,7 @@ export type ManagementProcedures = {
|
|
|
3681
3928
|
}>;
|
|
3682
3929
|
tools: Array<{
|
|
3683
3930
|
name: string;
|
|
3931
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
3684
3932
|
description: string;
|
|
3685
3933
|
inputSchema: Record<string, unknown>;
|
|
3686
3934
|
outputSchema?: Record<string, unknown>;
|
|
@@ -3712,6 +3960,7 @@ export type ManagementProcedures = {
|
|
|
3712
3960
|
output: {
|
|
3713
3961
|
id: string;
|
|
3714
3962
|
name: string;
|
|
3963
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3715
3964
|
description: string | null;
|
|
3716
3965
|
url: string | null;
|
|
3717
3966
|
keySecretName: string | null;
|
|
@@ -3725,6 +3974,7 @@ export type ManagementProcedures = {
|
|
|
3725
3974
|
}>;
|
|
3726
3975
|
tools: Array<{
|
|
3727
3976
|
name: string;
|
|
3977
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
3728
3978
|
description: string;
|
|
3729
3979
|
inputSchema: Record<string, unknown>;
|
|
3730
3980
|
outputSchema?: Record<string, unknown>;
|
|
@@ -3756,6 +4006,7 @@ export type ManagementProcedures = {
|
|
|
3756
4006
|
output: {
|
|
3757
4007
|
id: string;
|
|
3758
4008
|
name: string;
|
|
4009
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3759
4010
|
description: string | null;
|
|
3760
4011
|
url: string | null;
|
|
3761
4012
|
keySecretName: string | null;
|
|
@@ -3777,9 +4028,10 @@ export type ManagementProcedures = {
|
|
|
3777
4028
|
computed: boolean;
|
|
3778
4029
|
}>;
|
|
3779
4030
|
components: Array<{
|
|
4031
|
+
name: string;
|
|
4032
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3780
4033
|
kind: "tool" | "service" | "skill" | "trigger" | "dataset_host" | "mcp_server" | "webhook" | "knowledge_collection";
|
|
3781
4034
|
id: string;
|
|
3782
|
-
name: string;
|
|
3783
4035
|
}>;
|
|
3784
4036
|
};
|
|
3785
4037
|
};
|
|
@@ -3795,6 +4047,7 @@ export type ManagementProcedures = {
|
|
|
3795
4047
|
items: Array<{
|
|
3796
4048
|
id: string;
|
|
3797
4049
|
name: string;
|
|
4050
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3798
4051
|
description: string | null;
|
|
3799
4052
|
url: string | null;
|
|
3800
4053
|
keySecretName: string | null;
|
|
@@ -3810,7 +4063,7 @@ export type ManagementProcedures = {
|
|
|
3810
4063
|
filteredCount: number;
|
|
3811
4064
|
};
|
|
3812
4065
|
};
|
|
3813
|
-
/**
|
|
4066
|
+
/** 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
4067
|
"servers.options": {
|
|
3815
4068
|
input: {
|
|
3816
4069
|
includeSystem?: boolean;
|
|
@@ -3818,6 +4071,7 @@ export type ManagementProcedures = {
|
|
|
3818
4071
|
output: Array<{
|
|
3819
4072
|
id: string;
|
|
3820
4073
|
name: string;
|
|
4074
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3821
4075
|
}>;
|
|
3822
4076
|
};
|
|
3823
4077
|
/** Read the server's manifest now and apply its variables and native tools; a refused manifest leaves the previous one in place. */
|
|
@@ -3829,10 +4083,10 @@ export type ManagementProcedures = {
|
|
|
3829
4083
|
syncedAt: string;
|
|
3830
4084
|
};
|
|
3831
4085
|
};
|
|
3832
|
-
/**
|
|
4086
|
+
/** 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
4087
|
"servers.update": {
|
|
3834
4088
|
input: {
|
|
3835
|
-
|
|
4089
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3836
4090
|
description: string;
|
|
3837
4091
|
url: string | "";
|
|
3838
4092
|
keySecretName: string;
|
|
@@ -3846,6 +4100,7 @@ export type ManagementProcedures = {
|
|
|
3846
4100
|
output: {
|
|
3847
4101
|
id: string;
|
|
3848
4102
|
name: string;
|
|
4103
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3849
4104
|
description: string | null;
|
|
3850
4105
|
url: string | null;
|
|
3851
4106
|
keySecretName: string | null;
|
|
@@ -3859,6 +4114,7 @@ export type ManagementProcedures = {
|
|
|
3859
4114
|
}>;
|
|
3860
4115
|
tools: Array<{
|
|
3861
4116
|
name: string;
|
|
4117
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
3862
4118
|
description: string;
|
|
3863
4119
|
inputSchema: Record<string, unknown>;
|
|
3864
4120
|
outputSchema?: Record<string, unknown>;
|
|
@@ -3885,9 +4141,9 @@ export type ManagementProcedures = {
|
|
|
3885
4141
|
/** 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
4142
|
"services.create": {
|
|
3887
4143
|
input: {
|
|
3888
|
-
/** A
|
|
3889
|
-
|
|
3890
|
-
|
|
4144
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
4145
|
+
name: string;
|
|
4146
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3891
4147
|
audience: {
|
|
3892
4148
|
kind: "all";
|
|
3893
4149
|
} | {
|
|
@@ -3900,7 +4156,7 @@ export type ManagementProcedures = {
|
|
|
3900
4156
|
};
|
|
3901
4157
|
output: {
|
|
3902
4158
|
id: string;
|
|
3903
|
-
name:
|
|
4159
|
+
name: string;
|
|
3904
4160
|
};
|
|
3905
4161
|
};
|
|
3906
4162
|
/** Delete a service; fails while tools reference it. */
|
|
@@ -3919,11 +4175,11 @@ export type ManagementProcedures = {
|
|
|
3919
4175
|
};
|
|
3920
4176
|
output: {
|
|
3921
4177
|
id: string;
|
|
3922
|
-
|
|
3923
|
-
name: Record<"en" | "ar", string>;
|
|
4178
|
+
name: string;
|
|
3924
4179
|
description: Record<"en" | "ar", string>;
|
|
3925
4180
|
status: "draft" | "published" | "disabled";
|
|
3926
4181
|
updatedAt: string;
|
|
4182
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3927
4183
|
source: "direct" | "manifest" | "server";
|
|
3928
4184
|
sourceId: string | null;
|
|
3929
4185
|
overridable: Array<string>;
|
|
@@ -3937,9 +4193,10 @@ export type ManagementProcedures = {
|
|
|
3937
4193
|
agentIds: Array<string>;
|
|
3938
4194
|
};
|
|
3939
4195
|
referrers: Array<{
|
|
4196
|
+
name: string;
|
|
4197
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3940
4198
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
3941
4199
|
id: string;
|
|
3942
|
-
name: string;
|
|
3943
4200
|
readers: {
|
|
3944
4201
|
kind: "all";
|
|
3945
4202
|
} | {
|
|
@@ -3958,7 +4215,6 @@ export type ManagementProcedures = {
|
|
|
3958
4215
|
id: string;
|
|
3959
4216
|
name: string;
|
|
3960
4217
|
}>;
|
|
3961
|
-
nameLocked: boolean;
|
|
3962
4218
|
};
|
|
3963
4219
|
};
|
|
3964
4220
|
/** List services (upstream API groupings for tools) with pagination and search. */
|
|
@@ -3974,10 +4230,10 @@ export type ManagementProcedures = {
|
|
|
3974
4230
|
output: {
|
|
3975
4231
|
items: Array<{
|
|
3976
4232
|
id: string;
|
|
3977
|
-
|
|
3978
|
-
name: Record<"en" | "ar", string>;
|
|
4233
|
+
name: string;
|
|
3979
4234
|
description: Record<"en" | "ar", string>;
|
|
3980
4235
|
status: "draft" | "published" | "disabled";
|
|
4236
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3981
4237
|
source: "direct" | "manifest" | "server";
|
|
3982
4238
|
sourceId: string | null;
|
|
3983
4239
|
overridable: Array<string>;
|
|
@@ -3997,7 +4253,7 @@ export type ManagementProcedures = {
|
|
|
3997
4253
|
filteredCount: number;
|
|
3998
4254
|
};
|
|
3999
4255
|
};
|
|
4000
|
-
/** Every service a component with the given audience may be scoped to, as id,
|
|
4256
|
+
/** Every service a component with the given audience may be scoped to, as id, name and display name, for selectors. */
|
|
4001
4257
|
"services.options": {
|
|
4002
4258
|
input: {
|
|
4003
4259
|
audience: {
|
|
@@ -4012,8 +4268,8 @@ export type ManagementProcedures = {
|
|
|
4012
4268
|
};
|
|
4013
4269
|
output: Array<{
|
|
4014
4270
|
id: string;
|
|
4015
|
-
|
|
4016
|
-
|
|
4271
|
+
name: string;
|
|
4272
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4017
4273
|
}>;
|
|
4018
4274
|
};
|
|
4019
4275
|
/** Publish the service's current draft. */
|
|
@@ -4094,15 +4350,13 @@ export type ManagementProcedures = {
|
|
|
4094
4350
|
/** Update a service's draft. Saved as a draft; call the entity's publish procedure to make it live. */
|
|
4095
4351
|
"services.update": {
|
|
4096
4352
|
input: {
|
|
4097
|
-
|
|
4098
|
-
key: string;
|
|
4099
|
-
name: Record<"en" | "ar", string>;
|
|
4353
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4100
4354
|
description: Record<"en" | "ar", string>;
|
|
4101
4355
|
id: string;
|
|
4102
4356
|
};
|
|
4103
4357
|
output: {
|
|
4104
4358
|
id: string;
|
|
4105
|
-
name:
|
|
4359
|
+
name: string;
|
|
4106
4360
|
};
|
|
4107
4361
|
};
|
|
4108
4362
|
/** Deployment settings: log and thread retention. */
|
|
@@ -4134,8 +4388,9 @@ export type ManagementProcedures = {
|
|
|
4134
4388
|
/** 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
4389
|
"skills.create": {
|
|
4136
4390
|
input: {
|
|
4137
|
-
/** A
|
|
4391
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
4138
4392
|
name: string;
|
|
4393
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4139
4394
|
audience: {
|
|
4140
4395
|
kind: "all";
|
|
4141
4396
|
} | {
|
|
@@ -4174,6 +4429,7 @@ export type ManagementProcedures = {
|
|
|
4174
4429
|
body: string;
|
|
4175
4430
|
status: "draft" | "published" | "disabled";
|
|
4176
4431
|
updatedAt: string;
|
|
4432
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4177
4433
|
source: "direct" | "manifest" | "server";
|
|
4178
4434
|
sourceId: string | null;
|
|
4179
4435
|
overridable: Array<string>;
|
|
@@ -4187,9 +4443,10 @@ export type ManagementProcedures = {
|
|
|
4187
4443
|
agentIds: Array<string>;
|
|
4188
4444
|
};
|
|
4189
4445
|
referrers: Array<{
|
|
4446
|
+
name: string;
|
|
4447
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4190
4448
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
4191
4449
|
id: string;
|
|
4192
|
-
name: string;
|
|
4193
4450
|
readers: {
|
|
4194
4451
|
kind: "all";
|
|
4195
4452
|
} | {
|
|
@@ -4200,7 +4457,10 @@ export type ManagementProcedures = {
|
|
|
4200
4457
|
agentIds: Array<string>;
|
|
4201
4458
|
};
|
|
4202
4459
|
}>;
|
|
4203
|
-
|
|
4460
|
+
service: {
|
|
4461
|
+
name: string;
|
|
4462
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4463
|
+
} | null;
|
|
4204
4464
|
variables: Array<{
|
|
4205
4465
|
name: string;
|
|
4206
4466
|
description: string;
|
|
@@ -4220,7 +4480,6 @@ export type ManagementProcedures = {
|
|
|
4220
4480
|
id: string;
|
|
4221
4481
|
name: string;
|
|
4222
4482
|
}>;
|
|
4223
|
-
nameLocked: boolean;
|
|
4224
4483
|
};
|
|
4225
4484
|
};
|
|
4226
4485
|
/** List skills with pagination and search: every skill of an agent, or only those scoped to no service or to one service. */
|
|
@@ -4241,6 +4500,7 @@ export type ManagementProcedures = {
|
|
|
4241
4500
|
name: string;
|
|
4242
4501
|
description: string;
|
|
4243
4502
|
status: "draft" | "published" | "disabled";
|
|
4503
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4244
4504
|
source: "direct" | "manifest" | "server";
|
|
4245
4505
|
sourceId: string | null;
|
|
4246
4506
|
overridable: Array<string>;
|
|
@@ -4335,14 +4595,13 @@ export type ManagementProcedures = {
|
|
|
4335
4595
|
unchanged: boolean;
|
|
4336
4596
|
};
|
|
4337
4597
|
};
|
|
4338
|
-
/** Update a skill's
|
|
4598
|
+
/** 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
4599
|
"skills.update": {
|
|
4340
4600
|
input: {
|
|
4341
|
-
/** A slug: lowercase letters, digits, and single hyphens. */
|
|
4342
|
-
name: string;
|
|
4343
4601
|
description: string;
|
|
4344
4602
|
body: string;
|
|
4345
4603
|
id: string;
|
|
4604
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4346
4605
|
variables: Array<string>;
|
|
4347
4606
|
};
|
|
4348
4607
|
output: {
|
|
@@ -4364,10 +4623,15 @@ export type ManagementProcedures = {
|
|
|
4364
4623
|
createdAt: string;
|
|
4365
4624
|
updatedAt: string;
|
|
4366
4625
|
serverId: string | null;
|
|
4367
|
-
|
|
4368
|
-
|
|
4626
|
+
server: {
|
|
4627
|
+
name: string;
|
|
4628
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4629
|
+
} | null;
|
|
4630
|
+
agent: {
|
|
4631
|
+
name: string;
|
|
4632
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4633
|
+
};
|
|
4369
4634
|
agentId: string;
|
|
4370
|
-
agentName: string;
|
|
4371
4635
|
agentUrl: string | null;
|
|
4372
4636
|
messageCount: number;
|
|
4373
4637
|
totalTokens: number;
|
|
@@ -4386,7 +4650,7 @@ export type ManagementProcedures = {
|
|
|
4386
4650
|
pageSize?: number;
|
|
4387
4651
|
q?: string;
|
|
4388
4652
|
serverId?: string;
|
|
4389
|
-
|
|
4653
|
+
agentName?: string;
|
|
4390
4654
|
userId?: string;
|
|
4391
4655
|
dateFrom?: string;
|
|
4392
4656
|
dateTo?: string;
|
|
@@ -4403,8 +4667,14 @@ export type ManagementProcedures = {
|
|
|
4403
4667
|
createdAt: string;
|
|
4404
4668
|
updatedAt: string;
|
|
4405
4669
|
serverId: string | null;
|
|
4406
|
-
|
|
4407
|
-
|
|
4670
|
+
server: {
|
|
4671
|
+
name: string;
|
|
4672
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4673
|
+
} | null;
|
|
4674
|
+
agent: {
|
|
4675
|
+
name: string;
|
|
4676
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4677
|
+
};
|
|
4408
4678
|
}>;
|
|
4409
4679
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
4410
4680
|
count: number;
|
|
@@ -4593,6 +4863,7 @@ export type ManagementProcedures = {
|
|
|
4593
4863
|
description: string;
|
|
4594
4864
|
endpointUrl: string;
|
|
4595
4865
|
method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
|
|
4866
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4596
4867
|
audience: {
|
|
4597
4868
|
kind: "all";
|
|
4598
4869
|
} | {
|
|
@@ -4824,6 +5095,7 @@ export type ManagementProcedures = {
|
|
|
4824
5095
|
agentIds: Array<string>;
|
|
4825
5096
|
};
|
|
4826
5097
|
name: string;
|
|
5098
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4827
5099
|
description: string;
|
|
4828
5100
|
type: "http" | "embedded" | "soap" | "native" | "client";
|
|
4829
5101
|
config: {
|
|
@@ -4858,9 +5130,10 @@ export type ManagementProcedures = {
|
|
|
4858
5130
|
createdAt: string;
|
|
4859
5131
|
updatedAt: string;
|
|
4860
5132
|
referrers: Array<{
|
|
5133
|
+
name: string;
|
|
5134
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4861
5135
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
4862
5136
|
id: string;
|
|
4863
|
-
name: string;
|
|
4864
5137
|
readers: {
|
|
4865
5138
|
kind: "all";
|
|
4866
5139
|
} | {
|
|
@@ -4880,7 +5153,6 @@ export type ManagementProcedures = {
|
|
|
4880
5153
|
}>;
|
|
4881
5154
|
inputFields: Array<StoredSchemaFieldRow>;
|
|
4882
5155
|
outputFields: Array<StoredSchemaFieldRow>;
|
|
4883
|
-
nameLocked: boolean;
|
|
4884
5156
|
};
|
|
4885
5157
|
};
|
|
4886
5158
|
/** List tools with pagination and search. */
|
|
@@ -4904,6 +5176,7 @@ export type ManagementProcedures = {
|
|
|
4904
5176
|
status: "draft" | "published" | "disabled";
|
|
4905
5177
|
pinned: boolean;
|
|
4906
5178
|
importSource: string | null;
|
|
5179
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4907
5180
|
source: "direct" | "manifest" | "server";
|
|
4908
5181
|
sourceId: string | null;
|
|
4909
5182
|
overridable: Array<string>;
|
|
@@ -4923,12 +5196,13 @@ export type ManagementProcedures = {
|
|
|
4923
5196
|
filteredCount: number;
|
|
4924
5197
|
};
|
|
4925
5198
|
};
|
|
4926
|
-
/**
|
|
5199
|
+
/** Each tool's id, name and display name, for selectors. */
|
|
4927
5200
|
"tools.options": {
|
|
4928
5201
|
input: undefined;
|
|
4929
5202
|
output: Array<{
|
|
4930
5203
|
id: string;
|
|
4931
5204
|
name: string;
|
|
5205
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4932
5206
|
}>;
|
|
4933
5207
|
};
|
|
4934
5208
|
/** Parse an OpenAPI document and list the operations it would import as tools, and the tools already importing some of them. */
|
|
@@ -5108,8 +5382,6 @@ export type ManagementProcedures = {
|
|
|
5108
5382
|
/** 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
5383
|
"tools.update": {
|
|
5110
5384
|
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
5385
|
description: string;
|
|
5114
5386
|
endpointUrl: string;
|
|
5115
5387
|
method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
|
|
@@ -5144,6 +5416,7 @@ export type ManagementProcedures = {
|
|
|
5144
5416
|
projectOutput: boolean;
|
|
5145
5417
|
tags: Array<string>;
|
|
5146
5418
|
id: string;
|
|
5419
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5147
5420
|
variables: Array<{
|
|
5148
5421
|
name: string;
|
|
5149
5422
|
description: string;
|
|
@@ -5237,8 +5510,9 @@ export type ManagementProcedures = {
|
|
|
5237
5510
|
/** 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
5511
|
"triggers.create": {
|
|
5239
5512
|
input: {
|
|
5240
|
-
/** A
|
|
5513
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
5241
5514
|
name: string;
|
|
5515
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5242
5516
|
audience: {
|
|
5243
5517
|
kind: "all";
|
|
5244
5518
|
} | {
|
|
@@ -5349,6 +5623,7 @@ export type ManagementProcedures = {
|
|
|
5349
5623
|
modelEffort: string | null;
|
|
5350
5624
|
status: "draft" | "published" | "disabled";
|
|
5351
5625
|
updatedAt: string;
|
|
5626
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5352
5627
|
source: "direct" | "manifest" | "server";
|
|
5353
5628
|
sourceId: string | null;
|
|
5354
5629
|
overridable: Array<string>;
|
|
@@ -5362,9 +5637,10 @@ export type ManagementProcedures = {
|
|
|
5362
5637
|
agentIds: Array<string>;
|
|
5363
5638
|
};
|
|
5364
5639
|
referrers: Array<{
|
|
5640
|
+
name: string;
|
|
5641
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5365
5642
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
5366
5643
|
id: string;
|
|
5367
|
-
name: string;
|
|
5368
5644
|
readers: {
|
|
5369
5645
|
kind: "all";
|
|
5370
5646
|
} | {
|
|
@@ -5377,8 +5653,8 @@ export type ManagementProcedures = {
|
|
|
5377
5653
|
}>;
|
|
5378
5654
|
agents: Array<{
|
|
5379
5655
|
id: string;
|
|
5380
|
-
slug: string;
|
|
5381
5656
|
name: string;
|
|
5657
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5382
5658
|
}>;
|
|
5383
5659
|
engineUrl: string | null;
|
|
5384
5660
|
variables: Array<{
|
|
@@ -5402,7 +5678,6 @@ export type ManagementProcedures = {
|
|
|
5402
5678
|
id: string;
|
|
5403
5679
|
name: string;
|
|
5404
5680
|
}>;
|
|
5405
|
-
nameLocked: boolean;
|
|
5406
5681
|
};
|
|
5407
5682
|
};
|
|
5408
5683
|
/** List triggers with pagination and search. */
|
|
@@ -5432,6 +5707,7 @@ export type ManagementProcedures = {
|
|
|
5432
5707
|
};
|
|
5433
5708
|
status: "draft" | "published" | "disabled";
|
|
5434
5709
|
secretPrefix: string;
|
|
5710
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5435
5711
|
source: "direct" | "manifest" | "server";
|
|
5436
5712
|
sourceId: string | null;
|
|
5437
5713
|
overridable: Array<string>;
|
|
@@ -5537,11 +5813,9 @@ export type ManagementProcedures = {
|
|
|
5537
5813
|
unchanged: boolean;
|
|
5538
5814
|
};
|
|
5539
5815
|
};
|
|
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. */
|
|
5816
|
+
/** 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
5817
|
"triggers.update": {
|
|
5542
5818
|
input: {
|
|
5543
|
-
/** A slug: lowercase letters, digits, and single hyphens. */
|
|
5544
|
-
name: string;
|
|
5545
5819
|
description: string;
|
|
5546
5820
|
inputFields: Array<SchemaFieldRow>;
|
|
5547
5821
|
outputFields: Array<SchemaFieldRow>;
|
|
@@ -5559,6 +5833,7 @@ export type ManagementProcedures = {
|
|
|
5559
5833
|
budgetPerDay: number | null;
|
|
5560
5834
|
disableAfterFailures: number;
|
|
5561
5835
|
id: string;
|
|
5836
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5562
5837
|
credentialName: string | null;
|
|
5563
5838
|
fireCredentialName: string | null;
|
|
5564
5839
|
modelProvider: string | null;
|
|
@@ -5648,9 +5923,10 @@ export type ManagementProcedures = {
|
|
|
5648
5923
|
/** 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
5924
|
"webhooks.create": {
|
|
5650
5925
|
input: {
|
|
5651
|
-
/** A
|
|
5926
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
5652
5927
|
name: string;
|
|
5653
5928
|
url: string;
|
|
5929
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5654
5930
|
audience: {
|
|
5655
5931
|
kind: "all";
|
|
5656
5932
|
} | {
|
|
@@ -5696,6 +5972,7 @@ export type ManagementProcedures = {
|
|
|
5696
5972
|
agentIds: Array<string>;
|
|
5697
5973
|
};
|
|
5698
5974
|
name: string;
|
|
5975
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5699
5976
|
description: string;
|
|
5700
5977
|
event: "approval_requested";
|
|
5701
5978
|
url: string;
|
|
@@ -5719,9 +5996,10 @@ export type ManagementProcedures = {
|
|
|
5719
5996
|
enabled: boolean;
|
|
5720
5997
|
updatedAt: string;
|
|
5721
5998
|
referrers: Array<{
|
|
5999
|
+
name: string;
|
|
6000
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5722
6001
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
5723
6002
|
id: string;
|
|
5724
|
-
name: string;
|
|
5725
6003
|
readers: {
|
|
5726
6004
|
kind: "all";
|
|
5727
6005
|
} | {
|
|
@@ -5751,6 +6029,7 @@ export type ManagementProcedures = {
|
|
|
5751
6029
|
event: "approval_requested";
|
|
5752
6030
|
url: string;
|
|
5753
6031
|
enabled: boolean;
|
|
6032
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5754
6033
|
source: "direct" | "manifest" | "server";
|
|
5755
6034
|
sourceId: string | null;
|
|
5756
6035
|
overridable: Array<string>;
|
|
@@ -5798,7 +6077,10 @@ export type ManagementProcedures = {
|
|
|
5798
6077
|
durationMs: number;
|
|
5799
6078
|
error: "upstream_status" | "upstream_failed" | "egress_blocked" | "timeout" | "response_too_large" | "token_missing" | "unknown_credential" | "credential_unavailable" | "unexpected" | null;
|
|
5800
6079
|
createdAt: string;
|
|
5801
|
-
|
|
6080
|
+
agent: {
|
|
6081
|
+
name: string;
|
|
6082
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
6083
|
+
} | null;
|
|
5802
6084
|
}>;
|
|
5803
6085
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
5804
6086
|
count: number;
|
|
@@ -5861,8 +6143,6 @@ export type ManagementProcedures = {
|
|
|
5861
6143
|
/** 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
6144
|
"webhooks.update": {
|
|
5863
6145
|
input: {
|
|
5864
|
-
/** A slug: lowercase letters, digits, and single hyphens. */
|
|
5865
|
-
name: string;
|
|
5866
6146
|
description: string;
|
|
5867
6147
|
event: "approval_requested";
|
|
5868
6148
|
url: string;
|
|
@@ -5884,6 +6164,7 @@ export type ManagementProcedures = {
|
|
|
5884
6164
|
}>;
|
|
5885
6165
|
timeoutMs: number;
|
|
5886
6166
|
id: string;
|
|
6167
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5887
6168
|
};
|
|
5888
6169
|
output: {
|
|
5889
6170
|
id: string;
|