@m6d/cortex-cli 0.19.0 → 0.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/package.json +3 -3
- package/src/commands/new.ts +4 -4
- package/src/commands/setup.ts +19 -10
- package/src/contracts/datasets/dataset-sql.ts +1 -1
- package/src/contracts/management/index.ts +13 -1
- package/src/contracts/management/procedures.generated.ts +401 -216
- package/src/contracts/manifest/index.ts +130 -137
- package/src/contracts/server/index.ts +33 -9
- package/src/contracts/triggers/index.ts +9 -9
- package/src/contracts/wire/index.ts +11 -0
- package/src/management/client.ts +2 -0
- package/src/scaffold/files.ts +41 -37
- package/src/scaffold/ports.ts +5 -4
- package/src/scaffold/templates/cspell.json.txt +1 -1
- package/src/scaffold/templates/oxlintrc.json.txt +67 -0
- package/src/scaffold/templates/setup.ts.txt +1 -0
- package/src/scaffold/templates/eslint.config.mjs.txt +0 -20
|
@@ -206,10 +206,13 @@ export type StoredSchemaFieldRow = {
|
|
|
206
206
|
|
|
207
207
|
/** Whether each procedure is a query (GET) or a mutation (POST). */
|
|
208
208
|
export const managementProcedureKinds = {
|
|
209
|
+
"agents.addAlias": "mutation",
|
|
209
210
|
"agents.create": "mutation",
|
|
210
211
|
"agents.delete": "mutation",
|
|
212
|
+
"agents.deleteAlias": "mutation",
|
|
211
213
|
"agents.get": "query",
|
|
212
214
|
"agents.list": "query",
|
|
215
|
+
"agents.listAliases": "query",
|
|
213
216
|
"agents.options": "query",
|
|
214
217
|
"agents.publishPrompt": "mutation",
|
|
215
218
|
"agents.rollbackPrompt": "mutation",
|
|
@@ -296,14 +299,12 @@ export const managementProcedureKinds = {
|
|
|
296
299
|
"secrets.names": "query",
|
|
297
300
|
"secrets.rotate": "mutation",
|
|
298
301
|
"secrets.set": "mutation",
|
|
302
|
+
"secrets.update": "mutation",
|
|
299
303
|
"servers.create": "mutation",
|
|
300
304
|
"servers.delete": "mutation",
|
|
301
|
-
"servers.deleteAlias": "mutation",
|
|
302
305
|
"servers.get": "query",
|
|
303
306
|
"servers.list": "query",
|
|
304
|
-
"servers.listAliases": "query",
|
|
305
307
|
"servers.options": "query",
|
|
306
|
-
"servers.setAlias": "mutation",
|
|
307
308
|
"servers.sync": "mutation",
|
|
308
309
|
"servers.update": "mutation",
|
|
309
310
|
"services.create": "mutation",
|
|
@@ -379,12 +380,27 @@ export const managementProcedureKinds = {
|
|
|
379
380
|
|
|
380
381
|
/** Each procedure's input, as it is sent, and output, as JSON carries it. */
|
|
381
382
|
export type ManagementProcedures = {
|
|
382
|
-
/**
|
|
383
|
+
/** Give an agent an alias: a second name it answers to wherever a name is resolved. Refused (name_taken) when an agent's name or another alias holds the name; to move an alias, delete it and add it to the other agent. */
|
|
384
|
+
"agents.addAlias": {
|
|
385
|
+
input: {
|
|
386
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
387
|
+
alias: string;
|
|
388
|
+
agentId: string;
|
|
389
|
+
};
|
|
390
|
+
output: {
|
|
391
|
+
alias: string;
|
|
392
|
+
agentId: string;
|
|
393
|
+
createdAt: string;
|
|
394
|
+
updatedAt: string;
|
|
395
|
+
};
|
|
396
|
+
};
|
|
397
|
+
/** Create an agent on a registered server, or on none (`serverId` null), fixed for good either way. An agent with no server has no native tools, no server variables and no server auth, and publishes only on a chat model of its own. The draft has no prompt yet; save one with agents.savePrompt before publishing. */
|
|
383
398
|
"agents.create": {
|
|
384
399
|
input: {
|
|
385
|
-
|
|
400
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
386
401
|
name: string;
|
|
387
|
-
|
|
402
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
403
|
+
serverId: string | null;
|
|
388
404
|
};
|
|
389
405
|
output: {
|
|
390
406
|
id: string;
|
|
@@ -392,9 +408,9 @@ export type ManagementProcedures = {
|
|
|
392
408
|
sourceId: string | null;
|
|
393
409
|
overridable: Array<string>;
|
|
394
410
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
395
|
-
slug: string;
|
|
396
|
-
serverId: string;
|
|
397
411
|
name: string;
|
|
412
|
+
serverId: string | null;
|
|
413
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
398
414
|
promptDraft: string;
|
|
399
415
|
ragEnabled: boolean;
|
|
400
416
|
toolRegistryEnabled: boolean;
|
|
@@ -437,9 +453,9 @@ export type ManagementProcedures = {
|
|
|
437
453
|
sourceId: string | null;
|
|
438
454
|
overridable: Array<string>;
|
|
439
455
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
440
|
-
slug: string;
|
|
441
|
-
serverId: string;
|
|
442
456
|
name: string;
|
|
457
|
+
serverId: string | null;
|
|
458
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
443
459
|
promptDraft: string;
|
|
444
460
|
ragEnabled: boolean;
|
|
445
461
|
toolRegistryEnabled: boolean;
|
|
@@ -470,6 +486,19 @@ export type ManagementProcedures = {
|
|
|
470
486
|
updatedAt: string;
|
|
471
487
|
};
|
|
472
488
|
};
|
|
489
|
+
/** Remove an alias. */
|
|
490
|
+
"agents.deleteAlias": {
|
|
491
|
+
input: {
|
|
492
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
493
|
+
alias: string;
|
|
494
|
+
};
|
|
495
|
+
output: {
|
|
496
|
+
alias: string;
|
|
497
|
+
agentId: string;
|
|
498
|
+
createdAt: string;
|
|
499
|
+
updatedAt: string;
|
|
500
|
+
};
|
|
501
|
+
};
|
|
473
502
|
/** One agent by id, including its draft prompt and settings. */
|
|
474
503
|
"agents.get": {
|
|
475
504
|
input: {
|
|
@@ -481,9 +510,9 @@ export type ManagementProcedures = {
|
|
|
481
510
|
sourceId: string | null;
|
|
482
511
|
overridable: Array<string>;
|
|
483
512
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
484
|
-
slug: string;
|
|
485
|
-
serverId: string;
|
|
486
513
|
name: string;
|
|
514
|
+
serverId: string | null;
|
|
515
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
487
516
|
promptDraft: string;
|
|
488
517
|
ragEnabled: boolean;
|
|
489
518
|
toolRegistryEnabled: boolean;
|
|
@@ -510,7 +539,10 @@ export type ManagementProcedures = {
|
|
|
510
539
|
summarizationModel: string | null;
|
|
511
540
|
context: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
512
541
|
limits: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
513
|
-
|
|
542
|
+
server: {
|
|
543
|
+
name: string;
|
|
544
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
545
|
+
} | null;
|
|
514
546
|
serverVerifies: boolean;
|
|
515
547
|
variables: Array<{
|
|
516
548
|
name: string;
|
|
@@ -541,13 +573,16 @@ export type ManagementProcedures = {
|
|
|
541
573
|
output: {
|
|
542
574
|
items: Array<{
|
|
543
575
|
id: string;
|
|
544
|
-
slug: string;
|
|
545
576
|
name: string;
|
|
577
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
546
578
|
updatedAt: string;
|
|
547
579
|
source: "direct" | "manifest" | "server";
|
|
548
580
|
sourceId: string | null;
|
|
549
581
|
overridable: Array<string>;
|
|
550
|
-
|
|
582
|
+
server: {
|
|
583
|
+
name: string;
|
|
584
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
585
|
+
} | null;
|
|
551
586
|
published: boolean;
|
|
552
587
|
toolCount: number;
|
|
553
588
|
serviceCount: number;
|
|
@@ -560,14 +595,35 @@ export type ManagementProcedures = {
|
|
|
560
595
|
filteredCount: number;
|
|
561
596
|
};
|
|
562
597
|
};
|
|
563
|
-
/**
|
|
598
|
+
/** List an agent's aliases (second names, unique across the deployment beside every agent's own), with pagination. */
|
|
599
|
+
"agents.listAliases": {
|
|
600
|
+
input: {
|
|
601
|
+
pageIndex?: number;
|
|
602
|
+
pageSize?: number;
|
|
603
|
+
q?: string;
|
|
604
|
+
agentId: string;
|
|
605
|
+
};
|
|
606
|
+
output: {
|
|
607
|
+
items: Array<{
|
|
608
|
+
alias: string;
|
|
609
|
+
agentId: string;
|
|
610
|
+
createdAt: string;
|
|
611
|
+
updatedAt: string;
|
|
612
|
+
}>;
|
|
613
|
+
/** Every row the caller may see, ignoring the search and filters. */
|
|
614
|
+
count: number;
|
|
615
|
+
/** The rows matching the search and filters, over all pages: the total to report. */
|
|
616
|
+
filteredCount: number;
|
|
617
|
+
};
|
|
618
|
+
};
|
|
619
|
+
/** Agent ids, names and display names for selectors. */
|
|
564
620
|
"agents.options": {
|
|
565
621
|
input: undefined;
|
|
566
622
|
output: Array<{
|
|
567
623
|
id: string;
|
|
568
|
-
slug: string;
|
|
569
624
|
name: string;
|
|
570
|
-
|
|
625
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
626
|
+
serverId: string | null;
|
|
571
627
|
}>;
|
|
572
628
|
};
|
|
573
629
|
/** Publish the agent's current draft prompt and settings so Cortex serves them. Refused as `auth_required` while the agent's end-user authentication is unchosen, and as `chat_model_required` when neither the agent nor its server picks a chat model. `warnings` says what the publish went ahead despite: published tools the prompt names without an @-mention (neither pinned nor mentioned by a skill it mentions), which the agent usually cannot see. */
|
|
@@ -620,9 +676,9 @@ export type ManagementProcedures = {
|
|
|
620
676
|
sourceId: string | null;
|
|
621
677
|
overridable: Array<string>;
|
|
622
678
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
623
|
-
slug: string;
|
|
624
|
-
serverId: string;
|
|
625
679
|
name: string;
|
|
680
|
+
serverId: string | null;
|
|
681
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
626
682
|
promptDraft: string;
|
|
627
683
|
ragEnabled: boolean;
|
|
628
684
|
toolRegistryEnabled: boolean;
|
|
@@ -730,9 +786,9 @@ export type ManagementProcedures = {
|
|
|
730
786
|
sourceId: string | null;
|
|
731
787
|
overridable: Array<string>;
|
|
732
788
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
733
|
-
slug: string;
|
|
734
|
-
serverId: string;
|
|
735
789
|
name: string;
|
|
790
|
+
serverId: string | null;
|
|
791
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
736
792
|
promptDraft: string;
|
|
737
793
|
ragEnabled: boolean;
|
|
738
794
|
toolRegistryEnabled: boolean;
|
|
@@ -763,11 +819,11 @@ export type ManagementProcedures = {
|
|
|
763
819
|
updatedAt: string;
|
|
764
820
|
};
|
|
765
821
|
};
|
|
766
|
-
/**
|
|
822
|
+
/** Set an agent's display name, a text per locale. It applies at once; it is not part of the published prompt. */
|
|
767
823
|
"agents.update": {
|
|
768
824
|
input: {
|
|
769
825
|
id: string;
|
|
770
|
-
|
|
826
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
771
827
|
};
|
|
772
828
|
output: {
|
|
773
829
|
id: string;
|
|
@@ -775,9 +831,9 @@ export type ManagementProcedures = {
|
|
|
775
831
|
sourceId: string | null;
|
|
776
832
|
overridable: Array<string>;
|
|
777
833
|
applied: string | number | boolean | null | Record<string, unknown> | Array<unknown> | null;
|
|
778
|
-
slug: string;
|
|
779
|
-
serverId: string;
|
|
780
834
|
name: string;
|
|
835
|
+
serverId: string | null;
|
|
836
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
781
837
|
promptDraft: string;
|
|
782
838
|
ragEnabled: boolean;
|
|
783
839
|
toolRegistryEnabled: boolean;
|
|
@@ -837,9 +893,15 @@ export type ManagementProcedures = {
|
|
|
837
893
|
createdAt: string;
|
|
838
894
|
actorName: string;
|
|
839
895
|
actorEmail: string;
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
896
|
+
entity: {
|
|
897
|
+
name: string;
|
|
898
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
899
|
+
} | null;
|
|
900
|
+
managementKey: {
|
|
901
|
+
name: string;
|
|
902
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
903
|
+
fingerprint: string;
|
|
904
|
+
} | null;
|
|
843
905
|
before: unknown;
|
|
844
906
|
after: unknown;
|
|
845
907
|
};
|
|
@@ -868,9 +930,15 @@ export type ManagementProcedures = {
|
|
|
868
930
|
createdAt: string;
|
|
869
931
|
actorName: string;
|
|
870
932
|
actorEmail: string;
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
933
|
+
entity: {
|
|
934
|
+
name: string;
|
|
935
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
936
|
+
} | null;
|
|
937
|
+
managementKey: {
|
|
938
|
+
name: string;
|
|
939
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
940
|
+
fingerprint: string;
|
|
941
|
+
} | null;
|
|
874
942
|
}>;
|
|
875
943
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
876
944
|
count: number;
|
|
@@ -878,10 +946,12 @@ export type ManagementProcedures = {
|
|
|
878
946
|
filteredCount: number;
|
|
879
947
|
};
|
|
880
948
|
};
|
|
881
|
-
/** Create a knowledge collection with an audience ({ kind: "all" }, { kind: "server", serverId }, or { kind: "agents", agentIds }). Documents are uploaded into it; a service tag scopes every document to that service. */
|
|
949
|
+
/** Create a knowledge collection with a display name (a text per locale, `{}` for none) and an audience ({ kind: "all" }, { kind: "server", serverId }, or { kind: "agents", agentIds }). Documents are uploaded into it; a service tag scopes every document to that service. */
|
|
882
950
|
"collections.create": {
|
|
883
951
|
input: {
|
|
952
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
884
953
|
name: string;
|
|
954
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
885
955
|
description: string;
|
|
886
956
|
serviceId: string | null;
|
|
887
957
|
citable: boolean;
|
|
@@ -922,6 +992,7 @@ export type ManagementProcedures = {
|
|
|
922
992
|
citable: boolean;
|
|
923
993
|
createdAt: string;
|
|
924
994
|
updatedAt: string;
|
|
995
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
925
996
|
source: "direct" | "manifest" | "server";
|
|
926
997
|
sourceId: string | null;
|
|
927
998
|
overridable: Array<string>;
|
|
@@ -935,9 +1006,10 @@ export type ManagementProcedures = {
|
|
|
935
1006
|
agentIds: Array<string>;
|
|
936
1007
|
};
|
|
937
1008
|
referrers: Array<{
|
|
1009
|
+
name: string;
|
|
1010
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
938
1011
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
939
1012
|
id: string;
|
|
940
|
-
name: string;
|
|
941
1013
|
readers: {
|
|
942
1014
|
kind: "all";
|
|
943
1015
|
} | {
|
|
@@ -948,7 +1020,10 @@ export type ManagementProcedures = {
|
|
|
948
1020
|
agentIds: Array<string>;
|
|
949
1021
|
};
|
|
950
1022
|
}>;
|
|
951
|
-
|
|
1023
|
+
service: {
|
|
1024
|
+
name: string;
|
|
1025
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1026
|
+
} | null;
|
|
952
1027
|
};
|
|
953
1028
|
};
|
|
954
1029
|
/** List knowledge collections with pagination and search, optionally the ones an agent sees or the ones reaching a server. */
|
|
@@ -969,6 +1044,7 @@ export type ManagementProcedures = {
|
|
|
969
1044
|
description: string;
|
|
970
1045
|
serviceId: string | null;
|
|
971
1046
|
updatedAt: string;
|
|
1047
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
972
1048
|
source: "direct" | "manifest" | "server";
|
|
973
1049
|
sourceId: string | null;
|
|
974
1050
|
overridable: Array<string>;
|
|
@@ -981,7 +1057,10 @@ export type ManagementProcedures = {
|
|
|
981
1057
|
kind: "agents";
|
|
982
1058
|
agentIds: Array<string>;
|
|
983
1059
|
};
|
|
984
|
-
|
|
1060
|
+
service: {
|
|
1061
|
+
name: string;
|
|
1062
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1063
|
+
} | null;
|
|
985
1064
|
documentCount: number;
|
|
986
1065
|
}>;
|
|
987
1066
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
@@ -1041,10 +1120,10 @@ export type ManagementProcedures = {
|
|
|
1041
1120
|
};
|
|
1042
1121
|
}>;
|
|
1043
1122
|
};
|
|
1044
|
-
/**
|
|
1123
|
+
/** Set a knowledge collection's display name, describe it or change its service tag. A tag change applies to agents at once. */
|
|
1045
1124
|
"collections.update": {
|
|
1046
1125
|
input: {
|
|
1047
|
-
|
|
1126
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1048
1127
|
description: string;
|
|
1049
1128
|
serviceId: string | null;
|
|
1050
1129
|
citable: boolean;
|
|
@@ -1055,19 +1134,22 @@ export type ManagementProcedures = {
|
|
|
1055
1134
|
name: string;
|
|
1056
1135
|
};
|
|
1057
1136
|
};
|
|
1058
|
-
/** Create a named credential over a stored secret: `static` presents the secret's value; `oauth2-client-credentials` exchanges it, as the client secret of `clientId`, for a bearer at `tokenUrl` (https, or http on loopback or on a host `EGRESS_ALLOWED_HOSTS` admits). A credential's name and kind never change. Needs `secrets:write` too: whatever presents the credential sends its secret. */
|
|
1137
|
+
/** Create a named credential, with a display name (a text per locale, `{}` for none), over a stored secret: `static` presents the secret's value; `oauth2-client-credentials` exchanges it, as the client secret of `clientId`, for a bearer at `tokenUrl` (https, or http on loopback or on a host `EGRESS_ALLOWED_HOSTS` admits). A credential's name and kind never change. Needs `secrets:write` too: whatever presents the credential sends its secret. */
|
|
1059
1138
|
"credentials.create": {
|
|
1060
1139
|
input: {
|
|
1140
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1061
1141
|
kind: "static" | "oauth2-client-credentials";
|
|
1062
1142
|
secretName: string;
|
|
1063
1143
|
tokenUrl: string;
|
|
1064
1144
|
clientId: string;
|
|
1065
1145
|
scope: string;
|
|
1146
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
1066
1147
|
name: string;
|
|
1067
1148
|
};
|
|
1068
1149
|
output: {
|
|
1069
1150
|
id: string;
|
|
1070
1151
|
name: string;
|
|
1152
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1071
1153
|
kind: "static" | "oauth2-client-credentials";
|
|
1072
1154
|
secretName: string;
|
|
1073
1155
|
tokenUrl: string | null;
|
|
@@ -1085,6 +1167,7 @@ export type ManagementProcedures = {
|
|
|
1085
1167
|
output: {
|
|
1086
1168
|
id: string;
|
|
1087
1169
|
name: string;
|
|
1170
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1088
1171
|
kind: "static" | "oauth2-client-credentials";
|
|
1089
1172
|
secretName: string;
|
|
1090
1173
|
tokenUrl: string | null;
|
|
@@ -1094,7 +1177,7 @@ export type ManagementProcedures = {
|
|
|
1094
1177
|
updatedAt: string;
|
|
1095
1178
|
};
|
|
1096
1179
|
};
|
|
1097
|
-
/** List credentials with pagination and search: the name tools, dataset hosts and triggers reference, its kind, the secret it composes, and how many rows name it with the first few (`usedBy`). */
|
|
1180
|
+
/** List credentials with pagination and search: the name tools, dataset hosts and triggers reference, its display name, its kind, the secret it composes, and how many rows name it with the first few (`usedBy`). */
|
|
1098
1181
|
"credentials.list": {
|
|
1099
1182
|
input: {
|
|
1100
1183
|
pageIndex?: number;
|
|
@@ -1105,6 +1188,7 @@ export type ManagementProcedures = {
|
|
|
1105
1188
|
items: Array<{
|
|
1106
1189
|
id: string;
|
|
1107
1190
|
name: string;
|
|
1191
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1108
1192
|
kind: "static" | "oauth2-client-credentials";
|
|
1109
1193
|
secretName: string;
|
|
1110
1194
|
tokenUrl: string | null;
|
|
@@ -1115,9 +1199,10 @@ export type ManagementProcedures = {
|
|
|
1115
1199
|
usedBy: {
|
|
1116
1200
|
count: number;
|
|
1117
1201
|
preview: Array<{
|
|
1202
|
+
name: string;
|
|
1203
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1118
1204
|
kind: "credential" | "model_provider" | "server" | "agent" | "tool" | "trigger" | "dataset_host" | "webhook" | "mcp_server";
|
|
1119
1205
|
id: string;
|
|
1120
|
-
name: string;
|
|
1121
1206
|
}>;
|
|
1122
1207
|
};
|
|
1123
1208
|
}>;
|
|
@@ -1127,16 +1212,20 @@ export type ManagementProcedures = {
|
|
|
1127
1212
|
filteredCount: number;
|
|
1128
1213
|
};
|
|
1129
1214
|
};
|
|
1130
|
-
/**
|
|
1215
|
+
/** Each credential's name and display name, in name order, for a picker. `present`: what a tool, dataset host, webhook or trigger run may present upstream (every credential but a trigger's fire credential). `fire`: what a trigger may be fired with (static credentials). */
|
|
1131
1216
|
"credentials.names": {
|
|
1132
1217
|
input: {
|
|
1133
1218
|
use: "present" | "fire";
|
|
1134
1219
|
};
|
|
1135
|
-
output: Array<
|
|
1220
|
+
output: Array<{
|
|
1221
|
+
name: string;
|
|
1222
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1223
|
+
}>;
|
|
1136
1224
|
};
|
|
1137
|
-
/** Change the secret
|
|
1225
|
+
/** Change a credential's display name, the secret it composes and, for an OAuth2 one, its token URL, client id and scope. Applies to the next call of every tool, dataset host and trigger naming it. Changing the secret or the token URL needs `secrets:write` too (`secret_binding_forbidden`): either sends a stored secret somewhere new. */
|
|
1138
1226
|
"credentials.update": {
|
|
1139
1227
|
input: {
|
|
1228
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1140
1229
|
kind: "static" | "oauth2-client-credentials";
|
|
1141
1230
|
secretName: string;
|
|
1142
1231
|
tokenUrl: string;
|
|
@@ -1147,6 +1236,7 @@ export type ManagementProcedures = {
|
|
|
1147
1236
|
output: {
|
|
1148
1237
|
id: string;
|
|
1149
1238
|
name: string;
|
|
1239
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1150
1240
|
kind: "static" | "oauth2-client-credentials";
|
|
1151
1241
|
secretName: string;
|
|
1152
1242
|
tokenUrl: string | null;
|
|
@@ -1161,6 +1251,7 @@ export type ManagementProcedures = {
|
|
|
1161
1251
|
input: {
|
|
1162
1252
|
name: string;
|
|
1163
1253
|
url: string;
|
|
1254
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1164
1255
|
audience: {
|
|
1165
1256
|
kind: "all";
|
|
1166
1257
|
} | {
|
|
@@ -1206,6 +1297,7 @@ export type ManagementProcedures = {
|
|
|
1206
1297
|
agentIds: Array<string>;
|
|
1207
1298
|
};
|
|
1208
1299
|
name: string;
|
|
1300
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1209
1301
|
url: string;
|
|
1210
1302
|
headers: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
1211
1303
|
timeoutMs: number;
|
|
@@ -1238,9 +1330,10 @@ export type ManagementProcedures = {
|
|
|
1238
1330
|
revision: number;
|
|
1239
1331
|
updatedAt: string;
|
|
1240
1332
|
referrers: Array<{
|
|
1333
|
+
name: string;
|
|
1334
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1241
1335
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
1242
1336
|
id: string;
|
|
1243
|
-
name: string;
|
|
1244
1337
|
readers: {
|
|
1245
1338
|
kind: "all";
|
|
1246
1339
|
} | {
|
|
@@ -1251,7 +1344,6 @@ export type ManagementProcedures = {
|
|
|
1251
1344
|
agentIds: Array<string>;
|
|
1252
1345
|
};
|
|
1253
1346
|
}>;
|
|
1254
|
-
nameLocked: boolean;
|
|
1255
1347
|
variables: Array<{
|
|
1256
1348
|
name: string;
|
|
1257
1349
|
description: string;
|
|
@@ -1281,6 +1373,7 @@ export type ManagementProcedures = {
|
|
|
1281
1373
|
manifestVersion: string | null;
|
|
1282
1374
|
syncedAt: string | null;
|
|
1283
1375
|
expose: Array<string>;
|
|
1376
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1284
1377
|
source: "direct" | "manifest" | "server";
|
|
1285
1378
|
sourceId: string | null;
|
|
1286
1379
|
overridable: Array<string>;
|
|
@@ -1416,7 +1509,6 @@ export type ManagementProcedures = {
|
|
|
1416
1509
|
/** Update a dataset host's draft: which synced datasets the agent may query (`expose`) and which are listed in every turn (`pinned`). Saved as a draft; call the entity's publish procedure to make it live. The url, headers (each with a prefix and its value from a credential, the run token, a variable or a constant), timeout, and `rateLimits` (queries per minute for all users and per user, null for no limit) apply live without a publish. */
|
|
1417
1510
|
"datasetHosts.update": {
|
|
1418
1511
|
input: {
|
|
1419
|
-
name: string;
|
|
1420
1512
|
url: string;
|
|
1421
1513
|
headers: Array<{
|
|
1422
1514
|
header: string;
|
|
@@ -1446,6 +1538,7 @@ export type ManagementProcedures = {
|
|
|
1446
1538
|
expose: Array<string>;
|
|
1447
1539
|
pinned: Array<string>;
|
|
1448
1540
|
id: string;
|
|
1541
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1449
1542
|
};
|
|
1450
1543
|
output: {
|
|
1451
1544
|
id: string;
|
|
@@ -1590,7 +1683,7 @@ export type ManagementProcedures = {
|
|
|
1590
1683
|
updatedAt: string;
|
|
1591
1684
|
};
|
|
1592
1685
|
};
|
|
1593
|
-
/** The caller's live management keys with pagination and search: name, fingerprint, scope, and dates. Never the key itself. */
|
|
1686
|
+
/** The caller's live management keys in name order, with pagination and search: name, display name, fingerprint, scope, and dates. Never the key itself. */
|
|
1594
1687
|
"managementKeys.list": {
|
|
1595
1688
|
input: {
|
|
1596
1689
|
pageIndex?: number;
|
|
@@ -1601,6 +1694,7 @@ export type ManagementProcedures = {
|
|
|
1601
1694
|
items: Array<{
|
|
1602
1695
|
id: string;
|
|
1603
1696
|
name: string;
|
|
1697
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1604
1698
|
fingerprint: string;
|
|
1605
1699
|
permissions: Array<string> | null;
|
|
1606
1700
|
lastUsedAt: string | null;
|
|
@@ -1613,12 +1707,13 @@ export type ManagementProcedures = {
|
|
|
1613
1707
|
filteredCount: number;
|
|
1614
1708
|
};
|
|
1615
1709
|
};
|
|
1616
|
-
/** The management key this request authenticated with (name, fingerprint, scope, dates). Refused for a session or an operator token, which are not keys. */
|
|
1710
|
+
/** The management key this request authenticated with (name, display name, fingerprint, scope, dates). Refused for a session or an operator token, which are not keys. */
|
|
1617
1711
|
"managementKeys.mine": {
|
|
1618
1712
|
input: undefined;
|
|
1619
1713
|
output: {
|
|
1620
1714
|
id: string;
|
|
1621
1715
|
name: string;
|
|
1716
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
1622
1717
|
fingerprint: string;
|
|
1623
1718
|
permissions: Array<string> | null;
|
|
1624
1719
|
lastUsedAt: string | null;
|
|
@@ -1631,9 +1726,9 @@ export type ManagementProcedures = {
|
|
|
1631
1726
|
input: {
|
|
1632
1727
|
id: string;
|
|
1633
1728
|
agents?: Array<{
|
|
1634
|
-
slug: string;
|
|
1635
1729
|
name: string;
|
|
1636
|
-
|
|
1730
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1731
|
+
server?: string;
|
|
1637
1732
|
prompt: string;
|
|
1638
1733
|
auth: {
|
|
1639
1734
|
kind: "jwks";
|
|
@@ -1709,11 +1804,12 @@ export type ManagementProcedures = {
|
|
|
1709
1804
|
prompt: string;
|
|
1710
1805
|
}>>;
|
|
1711
1806
|
greeting?: Record<"en" | "ar", string>;
|
|
1712
|
-
overridable?: Array<"
|
|
1807
|
+
overridable?: Array<"displayName" | "prompt" | "models" | "settings" | "rateLimits" | "suggestions" | "greeting">;
|
|
1713
1808
|
}>;
|
|
1714
1809
|
tools?: Array<{
|
|
1715
1810
|
name: string;
|
|
1716
1811
|
description: string;
|
|
1812
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1717
1813
|
inputSchema?: {
|
|
1718
1814
|
type: "object";
|
|
1719
1815
|
properties?: Record<string, ManifestsPreviewSchema0>;
|
|
@@ -1744,7 +1840,7 @@ export type ManagementProcedures = {
|
|
|
1744
1840
|
} | {
|
|
1745
1841
|
agents: Array<string>;
|
|
1746
1842
|
};
|
|
1747
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1843
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1748
1844
|
url: string;
|
|
1749
1845
|
headers?: Array<{
|
|
1750
1846
|
header: string;
|
|
@@ -1772,6 +1868,7 @@ export type ManagementProcedures = {
|
|
|
1772
1868
|
} | {
|
|
1773
1869
|
name: string;
|
|
1774
1870
|
description: string;
|
|
1871
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1775
1872
|
inputSchema?: {
|
|
1776
1873
|
type: "object";
|
|
1777
1874
|
properties?: Record<string, ManifestsPreviewSchema0>;
|
|
@@ -1802,7 +1899,7 @@ export type ManagementProcedures = {
|
|
|
1802
1899
|
} | {
|
|
1803
1900
|
agents: Array<string>;
|
|
1804
1901
|
};
|
|
1805
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1902
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1806
1903
|
url: string;
|
|
1807
1904
|
headers?: Array<{
|
|
1808
1905
|
header: string;
|
|
@@ -1827,6 +1924,7 @@ export type ManagementProcedures = {
|
|
|
1827
1924
|
} | {
|
|
1828
1925
|
name: string;
|
|
1829
1926
|
description: string;
|
|
1927
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1830
1928
|
inputSchema?: {
|
|
1831
1929
|
type: "object";
|
|
1832
1930
|
properties?: Record<string, ManifestsPreviewSchema0>;
|
|
@@ -1857,7 +1955,7 @@ export type ManagementProcedures = {
|
|
|
1857
1955
|
} | {
|
|
1858
1956
|
agents: Array<string>;
|
|
1859
1957
|
};
|
|
1860
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1958
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1861
1959
|
url: string;
|
|
1862
1960
|
headers?: Array<{
|
|
1863
1961
|
header: string;
|
|
@@ -1889,6 +1987,7 @@ export type ManagementProcedures = {
|
|
|
1889
1987
|
} | {
|
|
1890
1988
|
name: string;
|
|
1891
1989
|
description: string;
|
|
1990
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1892
1991
|
inputSchema?: {
|
|
1893
1992
|
type: "object";
|
|
1894
1993
|
properties?: Record<string, ManifestsPreviewSchema0>;
|
|
@@ -1919,7 +2018,7 @@ export type ManagementProcedures = {
|
|
|
1919
2018
|
} | {
|
|
1920
2019
|
agents: Array<string>;
|
|
1921
2020
|
};
|
|
1922
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags">;
|
|
2021
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags">;
|
|
1923
2022
|
type: "client";
|
|
1924
2023
|
}>;
|
|
1925
2024
|
openapi?: Array<{
|
|
@@ -1952,21 +2051,22 @@ export type ManagementProcedures = {
|
|
|
1952
2051
|
} | {
|
|
1953
2052
|
agents: Array<string>;
|
|
1954
2053
|
};
|
|
1955
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2054
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
1956
2055
|
}>;
|
|
1957
2056
|
services?: Array<{
|
|
1958
|
-
|
|
1959
|
-
|
|
2057
|
+
name: string;
|
|
2058
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1960
2059
|
description: Record<"en" | "ar", string>;
|
|
1961
2060
|
audience: "all" | {
|
|
1962
2061
|
server: string;
|
|
1963
2062
|
} | {
|
|
1964
2063
|
agents: Array<string>;
|
|
1965
2064
|
};
|
|
1966
|
-
overridable?: Array<"description">;
|
|
2065
|
+
overridable?: Array<"displayName" | "description">;
|
|
1967
2066
|
}>;
|
|
1968
2067
|
skills?: Array<{
|
|
1969
2068
|
name: string;
|
|
2069
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1970
2070
|
description: string;
|
|
1971
2071
|
body: string;
|
|
1972
2072
|
service?: string;
|
|
@@ -1975,10 +2075,11 @@ export type ManagementProcedures = {
|
|
|
1975
2075
|
} | {
|
|
1976
2076
|
agents: Array<string>;
|
|
1977
2077
|
};
|
|
1978
|
-
overridable?: Array<"description" | "body">;
|
|
2078
|
+
overridable?: Array<"displayName" | "description" | "body">;
|
|
1979
2079
|
}>;
|
|
1980
2080
|
triggers?: Array<{
|
|
1981
2081
|
name: string;
|
|
2082
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
1982
2083
|
description: string;
|
|
1983
2084
|
inputSchema?: {
|
|
1984
2085
|
type: "object";
|
|
@@ -2017,10 +2118,11 @@ export type ManagementProcedures = {
|
|
|
2017
2118
|
} | {
|
|
2018
2119
|
agents: Array<string>;
|
|
2019
2120
|
};
|
|
2020
|
-
overridable?: Array<"description" | "instructions" | "threadPolicy" | "budgetPerDay" | "disableAfterFailures" | "model">;
|
|
2121
|
+
overridable?: Array<"displayName" | "description" | "instructions" | "threadPolicy" | "budgetPerDay" | "disableAfterFailures" | "model">;
|
|
2021
2122
|
}>;
|
|
2022
2123
|
datasetHosts?: Array<{
|
|
2023
2124
|
name: string;
|
|
2125
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2024
2126
|
url: string;
|
|
2025
2127
|
headers?: Array<{
|
|
2026
2128
|
header: string;
|
|
@@ -2054,10 +2156,11 @@ export type ManagementProcedures = {
|
|
|
2054
2156
|
} | {
|
|
2055
2157
|
agents: Array<string>;
|
|
2056
2158
|
};
|
|
2057
|
-
overridable?: Array<"timeoutMs" | "rateLimits" | "headers">;
|
|
2159
|
+
overridable?: Array<"displayName" | "timeoutMs" | "rateLimits" | "headers">;
|
|
2058
2160
|
}>;
|
|
2059
2161
|
mcpServers?: Array<{
|
|
2060
2162
|
name: string;
|
|
2163
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2061
2164
|
url: string;
|
|
2062
2165
|
headers?: Array<{
|
|
2063
2166
|
header: string;
|
|
@@ -2082,10 +2185,11 @@ export type ManagementProcedures = {
|
|
|
2082
2185
|
} | {
|
|
2083
2186
|
agents: Array<string>;
|
|
2084
2187
|
};
|
|
2085
|
-
overridable?: Array<"include" | "exclude" | "headers">;
|
|
2188
|
+
overridable?: Array<"displayName" | "include" | "exclude" | "headers">;
|
|
2086
2189
|
}>;
|
|
2087
2190
|
webhooks?: Array<{
|
|
2088
2191
|
name: string;
|
|
2192
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2089
2193
|
description?: string;
|
|
2090
2194
|
event: "approval_requested";
|
|
2091
2195
|
url: string;
|
|
@@ -2106,10 +2210,11 @@ export type ManagementProcedures = {
|
|
|
2106
2210
|
} | {
|
|
2107
2211
|
agents: Array<string>;
|
|
2108
2212
|
};
|
|
2109
|
-
overridable?: Array<"description" | "timeoutMs" | "headers">;
|
|
2213
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "headers">;
|
|
2110
2214
|
}>;
|
|
2111
2215
|
collections?: Array<{
|
|
2112
2216
|
name: string;
|
|
2217
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2113
2218
|
description?: string;
|
|
2114
2219
|
service?: string;
|
|
2115
2220
|
citable?: boolean;
|
|
@@ -2128,7 +2233,7 @@ export type ManagementProcedures = {
|
|
|
2128
2233
|
} | {
|
|
2129
2234
|
agents: Array<string>;
|
|
2130
2235
|
};
|
|
2131
|
-
overridable?: Array<"description" | "documents">;
|
|
2236
|
+
overridable?: Array<"displayName" | "description" | "documents">;
|
|
2132
2237
|
}>;
|
|
2133
2238
|
prefer?: "live" | "manifest";
|
|
2134
2239
|
resolutions?: Array<{
|
|
@@ -2156,9 +2261,9 @@ export type ManagementProcedures = {
|
|
|
2156
2261
|
input: {
|
|
2157
2262
|
id: string;
|
|
2158
2263
|
agents?: Array<{
|
|
2159
|
-
slug: string;
|
|
2160
2264
|
name: string;
|
|
2161
|
-
|
|
2265
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2266
|
+
server?: string;
|
|
2162
2267
|
prompt: string;
|
|
2163
2268
|
auth: {
|
|
2164
2269
|
kind: "jwks";
|
|
@@ -2234,11 +2339,12 @@ export type ManagementProcedures = {
|
|
|
2234
2339
|
prompt: string;
|
|
2235
2340
|
}>>;
|
|
2236
2341
|
greeting?: Record<"en" | "ar", string>;
|
|
2237
|
-
overridable?: Array<"
|
|
2342
|
+
overridable?: Array<"displayName" | "prompt" | "models" | "settings" | "rateLimits" | "suggestions" | "greeting">;
|
|
2238
2343
|
}>;
|
|
2239
2344
|
tools?: Array<{
|
|
2240
2345
|
name: string;
|
|
2241
2346
|
description: string;
|
|
2347
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2242
2348
|
inputSchema?: {
|
|
2243
2349
|
type: "object";
|
|
2244
2350
|
properties?: Record<string, ManifestsSyncSchema0>;
|
|
@@ -2269,7 +2375,7 @@ export type ManagementProcedures = {
|
|
|
2269
2375
|
} | {
|
|
2270
2376
|
agents: Array<string>;
|
|
2271
2377
|
};
|
|
2272
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2378
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2273
2379
|
url: string;
|
|
2274
2380
|
headers?: Array<{
|
|
2275
2381
|
header: string;
|
|
@@ -2297,6 +2403,7 @@ export type ManagementProcedures = {
|
|
|
2297
2403
|
} | {
|
|
2298
2404
|
name: string;
|
|
2299
2405
|
description: string;
|
|
2406
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2300
2407
|
inputSchema?: {
|
|
2301
2408
|
type: "object";
|
|
2302
2409
|
properties?: Record<string, ManifestsSyncSchema0>;
|
|
@@ -2327,7 +2434,7 @@ export type ManagementProcedures = {
|
|
|
2327
2434
|
} | {
|
|
2328
2435
|
agents: Array<string>;
|
|
2329
2436
|
};
|
|
2330
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2437
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2331
2438
|
url: string;
|
|
2332
2439
|
headers?: Array<{
|
|
2333
2440
|
header: string;
|
|
@@ -2352,6 +2459,7 @@ export type ManagementProcedures = {
|
|
|
2352
2459
|
} | {
|
|
2353
2460
|
name: string;
|
|
2354
2461
|
description: string;
|
|
2462
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2355
2463
|
inputSchema?: {
|
|
2356
2464
|
type: "object";
|
|
2357
2465
|
properties?: Record<string, ManifestsSyncSchema0>;
|
|
@@ -2382,7 +2490,7 @@ export type ManagementProcedures = {
|
|
|
2382
2490
|
} | {
|
|
2383
2491
|
agents: Array<string>;
|
|
2384
2492
|
};
|
|
2385
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2493
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2386
2494
|
url: string;
|
|
2387
2495
|
headers?: Array<{
|
|
2388
2496
|
header: string;
|
|
@@ -2414,6 +2522,7 @@ export type ManagementProcedures = {
|
|
|
2414
2522
|
} | {
|
|
2415
2523
|
name: string;
|
|
2416
2524
|
description: string;
|
|
2525
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2417
2526
|
inputSchema?: {
|
|
2418
2527
|
type: "object";
|
|
2419
2528
|
properties?: Record<string, ManifestsSyncSchema0>;
|
|
@@ -2444,7 +2553,7 @@ export type ManagementProcedures = {
|
|
|
2444
2553
|
} | {
|
|
2445
2554
|
agents: Array<string>;
|
|
2446
2555
|
};
|
|
2447
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags">;
|
|
2556
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags">;
|
|
2448
2557
|
type: "client";
|
|
2449
2558
|
}>;
|
|
2450
2559
|
openapi?: Array<{
|
|
@@ -2477,21 +2586,22 @@ export type ManagementProcedures = {
|
|
|
2477
2586
|
} | {
|
|
2478
2587
|
agents: Array<string>;
|
|
2479
2588
|
};
|
|
2480
|
-
overridable?: Array<"description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2589
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "maxResponseBytes" | "rateLimits" | "pinned" | "tags" | "headers">;
|
|
2481
2590
|
}>;
|
|
2482
2591
|
services?: Array<{
|
|
2483
|
-
|
|
2484
|
-
|
|
2592
|
+
name: string;
|
|
2593
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2485
2594
|
description: Record<"en" | "ar", string>;
|
|
2486
2595
|
audience: "all" | {
|
|
2487
2596
|
server: string;
|
|
2488
2597
|
} | {
|
|
2489
2598
|
agents: Array<string>;
|
|
2490
2599
|
};
|
|
2491
|
-
overridable?: Array<"description">;
|
|
2600
|
+
overridable?: Array<"displayName" | "description">;
|
|
2492
2601
|
}>;
|
|
2493
2602
|
skills?: Array<{
|
|
2494
2603
|
name: string;
|
|
2604
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2495
2605
|
description: string;
|
|
2496
2606
|
body: string;
|
|
2497
2607
|
service?: string;
|
|
@@ -2500,10 +2610,11 @@ export type ManagementProcedures = {
|
|
|
2500
2610
|
} | {
|
|
2501
2611
|
agents: Array<string>;
|
|
2502
2612
|
};
|
|
2503
|
-
overridable?: Array<"description" | "body">;
|
|
2613
|
+
overridable?: Array<"displayName" | "description" | "body">;
|
|
2504
2614
|
}>;
|
|
2505
2615
|
triggers?: Array<{
|
|
2506
2616
|
name: string;
|
|
2617
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2507
2618
|
description: string;
|
|
2508
2619
|
inputSchema?: {
|
|
2509
2620
|
type: "object";
|
|
@@ -2542,10 +2653,11 @@ export type ManagementProcedures = {
|
|
|
2542
2653
|
} | {
|
|
2543
2654
|
agents: Array<string>;
|
|
2544
2655
|
};
|
|
2545
|
-
overridable?: Array<"description" | "instructions" | "threadPolicy" | "budgetPerDay" | "disableAfterFailures" | "model">;
|
|
2656
|
+
overridable?: Array<"displayName" | "description" | "instructions" | "threadPolicy" | "budgetPerDay" | "disableAfterFailures" | "model">;
|
|
2546
2657
|
}>;
|
|
2547
2658
|
datasetHosts?: Array<{
|
|
2548
2659
|
name: string;
|
|
2660
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2549
2661
|
url: string;
|
|
2550
2662
|
headers?: Array<{
|
|
2551
2663
|
header: string;
|
|
@@ -2579,10 +2691,11 @@ export type ManagementProcedures = {
|
|
|
2579
2691
|
} | {
|
|
2580
2692
|
agents: Array<string>;
|
|
2581
2693
|
};
|
|
2582
|
-
overridable?: Array<"timeoutMs" | "rateLimits" | "headers">;
|
|
2694
|
+
overridable?: Array<"displayName" | "timeoutMs" | "rateLimits" | "headers">;
|
|
2583
2695
|
}>;
|
|
2584
2696
|
mcpServers?: Array<{
|
|
2585
2697
|
name: string;
|
|
2698
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2586
2699
|
url: string;
|
|
2587
2700
|
headers?: Array<{
|
|
2588
2701
|
header: string;
|
|
@@ -2607,10 +2720,11 @@ export type ManagementProcedures = {
|
|
|
2607
2720
|
} | {
|
|
2608
2721
|
agents: Array<string>;
|
|
2609
2722
|
};
|
|
2610
|
-
overridable?: Array<"include" | "exclude" | "headers">;
|
|
2723
|
+
overridable?: Array<"displayName" | "include" | "exclude" | "headers">;
|
|
2611
2724
|
}>;
|
|
2612
2725
|
webhooks?: Array<{
|
|
2613
2726
|
name: string;
|
|
2727
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2614
2728
|
description?: string;
|
|
2615
2729
|
event: "approval_requested";
|
|
2616
2730
|
url: string;
|
|
@@ -2631,10 +2745,11 @@ export type ManagementProcedures = {
|
|
|
2631
2745
|
} | {
|
|
2632
2746
|
agents: Array<string>;
|
|
2633
2747
|
};
|
|
2634
|
-
overridable?: Array<"description" | "timeoutMs" | "headers">;
|
|
2748
|
+
overridable?: Array<"displayName" | "description" | "timeoutMs" | "headers">;
|
|
2635
2749
|
}>;
|
|
2636
2750
|
collections?: Array<{
|
|
2637
2751
|
name: string;
|
|
2752
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
2638
2753
|
description?: string;
|
|
2639
2754
|
service?: string;
|
|
2640
2755
|
citable?: boolean;
|
|
@@ -2653,7 +2768,7 @@ export type ManagementProcedures = {
|
|
|
2653
2768
|
} | {
|
|
2654
2769
|
agents: Array<string>;
|
|
2655
2770
|
};
|
|
2656
|
-
overridable?: Array<"description" | "documents">;
|
|
2771
|
+
overridable?: Array<"displayName" | "description" | "documents">;
|
|
2657
2772
|
}>;
|
|
2658
2773
|
prefer?: "live" | "manifest";
|
|
2659
2774
|
resolutions?: Array<{
|
|
@@ -2676,6 +2791,7 @@ export type ManagementProcedures = {
|
|
|
2676
2791
|
input: {
|
|
2677
2792
|
name: string;
|
|
2678
2793
|
url: string;
|
|
2794
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2679
2795
|
audience: {
|
|
2680
2796
|
kind: "all";
|
|
2681
2797
|
} | {
|
|
@@ -2721,6 +2837,7 @@ export type ManagementProcedures = {
|
|
|
2721
2837
|
agentIds: Array<string>;
|
|
2722
2838
|
};
|
|
2723
2839
|
name: string;
|
|
2840
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2724
2841
|
url: string;
|
|
2725
2842
|
headers: Array<{
|
|
2726
2843
|
header: string;
|
|
@@ -2743,9 +2860,10 @@ export type ManagementProcedures = {
|
|
|
2743
2860
|
status: "draft" | "published" | "disabled";
|
|
2744
2861
|
updatedAt: string;
|
|
2745
2862
|
referrers: Array<{
|
|
2863
|
+
name: string;
|
|
2864
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2746
2865
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
2747
2866
|
id: string;
|
|
2748
|
-
name: string;
|
|
2749
2867
|
readers: {
|
|
2750
2868
|
kind: "all";
|
|
2751
2869
|
} | {
|
|
@@ -2756,7 +2874,6 @@ export type ManagementProcedures = {
|
|
|
2756
2874
|
agentIds: Array<string>;
|
|
2757
2875
|
};
|
|
2758
2876
|
}>;
|
|
2759
|
-
nameLocked: boolean;
|
|
2760
2877
|
variables: Array<{
|
|
2761
2878
|
name: string;
|
|
2762
2879
|
description: string;
|
|
@@ -2782,6 +2899,7 @@ export type ManagementProcedures = {
|
|
|
2782
2899
|
name: string;
|
|
2783
2900
|
url: string;
|
|
2784
2901
|
status: "draft" | "published" | "disabled";
|
|
2902
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2785
2903
|
source: "direct" | "manifest" | "server";
|
|
2786
2904
|
sourceId: string | null;
|
|
2787
2905
|
overridable: Array<string>;
|
|
@@ -2892,10 +3010,9 @@ export type ManagementProcedures = {
|
|
|
2892
3010
|
unchanged: boolean;
|
|
2893
3011
|
};
|
|
2894
3012
|
};
|
|
2895
|
-
/** Update an MCP server's draft:
|
|
3013
|
+
/** Update an MCP server's draft: which of its tools agents may call (`include`, empty for every tool, and `exclude`, tool names as the server spells them). Saved as a draft; call publish to make it live. The url and headers (each with a prefix and its value from a credential, the run token, a variable or a constant) apply live without a publish. */
|
|
2896
3014
|
"mcpServers.update": {
|
|
2897
3015
|
input: {
|
|
2898
|
-
name: string;
|
|
2899
3016
|
url: string;
|
|
2900
3017
|
headers: Array<{
|
|
2901
3018
|
header: string;
|
|
@@ -2916,24 +3033,28 @@ export type ManagementProcedures = {
|
|
|
2916
3033
|
include: Array<string>;
|
|
2917
3034
|
exclude: Array<string>;
|
|
2918
3035
|
id: string;
|
|
3036
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2919
3037
|
};
|
|
2920
3038
|
output: {
|
|
2921
3039
|
id: string;
|
|
2922
3040
|
name: string;
|
|
2923
3041
|
};
|
|
2924
3042
|
};
|
|
2925
|
-
/** Create a model provider: an OpenAI-compatible `baseUrl` (https, or http on loopback or on a host `EGRESS_ALLOWED_HOSTS` admits), the secret holding its key, the model ids it offers, and the values it accepts as `reasoning_effort`. Its name never changes. Needs `secrets:write` too: every model call sends the key to `baseUrl`. */
|
|
3043
|
+
/** Create a model provider: a display name (a text per locale, `{}` for none), an OpenAI-compatible `baseUrl` (https, or http on loopback or on a host `EGRESS_ALLOWED_HOSTS` admits), the secret holding its key, the model ids it offers, and the values it accepts as `reasoning_effort`. Its name never changes. Needs `secrets:write` too: every model call sends the key to `baseUrl`. */
|
|
2926
3044
|
"modelProviders.create": {
|
|
2927
3045
|
input: {
|
|
3046
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2928
3047
|
baseUrl: string;
|
|
2929
3048
|
secretName: string;
|
|
2930
3049
|
models: Array<string>;
|
|
2931
3050
|
efforts: Array<string>;
|
|
3051
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
2932
3052
|
name: string;
|
|
2933
3053
|
};
|
|
2934
3054
|
output: {
|
|
2935
3055
|
id: string;
|
|
2936
3056
|
name: string;
|
|
3057
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2937
3058
|
baseUrl: string;
|
|
2938
3059
|
secretName: string;
|
|
2939
3060
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
@@ -2950,6 +3071,7 @@ export type ManagementProcedures = {
|
|
|
2950
3071
|
output: {
|
|
2951
3072
|
id: string;
|
|
2952
3073
|
name: string;
|
|
3074
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2953
3075
|
baseUrl: string;
|
|
2954
3076
|
secretName: string;
|
|
2955
3077
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
@@ -2980,6 +3102,7 @@ export type ManagementProcedures = {
|
|
|
2980
3102
|
items: Array<{
|
|
2981
3103
|
id: string;
|
|
2982
3104
|
name: string;
|
|
3105
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2983
3106
|
baseUrl: string;
|
|
2984
3107
|
secretName: string;
|
|
2985
3108
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
@@ -2989,9 +3112,10 @@ export type ManagementProcedures = {
|
|
|
2989
3112
|
usedBy: {
|
|
2990
3113
|
count: number;
|
|
2991
3114
|
preview: Array<{
|
|
3115
|
+
name: string;
|
|
3116
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
2992
3117
|
kind: "credential" | "model_provider" | "server" | "agent" | "tool" | "trigger" | "dataset_host" | "webhook" | "mcp_server";
|
|
2993
3118
|
id: string;
|
|
2994
|
-
name: string;
|
|
2995
3119
|
}>;
|
|
2996
3120
|
};
|
|
2997
3121
|
}>;
|
|
@@ -3001,18 +3125,20 @@ export type ManagementProcedures = {
|
|
|
3001
3125
|
filteredCount: number;
|
|
3002
3126
|
};
|
|
3003
3127
|
};
|
|
3004
|
-
/** Every model provider with its models and efforts, in name order, for a model picker. */
|
|
3128
|
+
/** Every model provider with its display name, models and efforts, in name order, for a model picker. */
|
|
3005
3129
|
"modelProviders.options": {
|
|
3006
3130
|
input: undefined;
|
|
3007
3131
|
output: Array<{
|
|
3008
3132
|
name: string;
|
|
3133
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3009
3134
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
3010
3135
|
efforts: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
3011
3136
|
}>;
|
|
3012
3137
|
};
|
|
3013
|
-
/** Change a model provider's URL, key secret, models and efforts. Refused with `in_use` while a server, agent or trigger picks a model or effort it would drop. Changing the URL or the key secret needs `secrets:write` too (`secret_binding_forbidden`): either sends a stored secret somewhere new. Applies from each agent's next turn. */
|
|
3138
|
+
/** Change a model provider's display name, URL, key secret, models and efforts. Refused with `in_use` while a server, agent or trigger picks a model or effort it would drop. Changing the URL or the key secret needs `secrets:write` too (`secret_binding_forbidden`): either sends a stored secret somewhere new. Applies from each agent's next turn. */
|
|
3014
3139
|
"modelProviders.update": {
|
|
3015
3140
|
input: {
|
|
3141
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3016
3142
|
baseUrl: string;
|
|
3017
3143
|
secretName: string;
|
|
3018
3144
|
models: Array<string>;
|
|
@@ -3022,6 +3148,7 @@ export type ManagementProcedures = {
|
|
|
3022
3148
|
output: {
|
|
3023
3149
|
id: string;
|
|
3024
3150
|
name: string;
|
|
3151
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3025
3152
|
baseUrl: string;
|
|
3026
3153
|
secretName: string;
|
|
3027
3154
|
models: string | number | boolean | null | Record<string, unknown> | Array<unknown>;
|
|
@@ -3044,7 +3171,10 @@ export type ManagementProcedures = {
|
|
|
3044
3171
|
callerId: string | null;
|
|
3045
3172
|
toolName: string;
|
|
3046
3173
|
createdAt: string;
|
|
3047
|
-
|
|
3174
|
+
agent: {
|
|
3175
|
+
name: string;
|
|
3176
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3177
|
+
};
|
|
3048
3178
|
triggerName: string | null;
|
|
3049
3179
|
threadId: string | null;
|
|
3050
3180
|
threadTitle: string | null;
|
|
@@ -3080,7 +3210,8 @@ export type ManagementProcedures = {
|
|
|
3080
3210
|
entityType: "knowledge" | "service" | "tool";
|
|
3081
3211
|
entityId: string;
|
|
3082
3212
|
collectionId: string | null;
|
|
3083
|
-
name:
|
|
3213
|
+
name: string;
|
|
3214
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3084
3215
|
resolutionCount: number;
|
|
3085
3216
|
}>;
|
|
3086
3217
|
broadTools: Array<{
|
|
@@ -3092,13 +3223,19 @@ export type ManagementProcedures = {
|
|
|
3092
3223
|
missingQueries: Array<{
|
|
3093
3224
|
queryHash: string;
|
|
3094
3225
|
agentId: string;
|
|
3095
|
-
|
|
3226
|
+
agent: {
|
|
3227
|
+
name: string;
|
|
3228
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3229
|
+
};
|
|
3096
3230
|
searchCount: number;
|
|
3097
3231
|
lastSearchedAt: string;
|
|
3098
3232
|
}>;
|
|
3099
3233
|
hitRates: Array<{
|
|
3100
3234
|
agentId: string;
|
|
3101
|
-
|
|
3235
|
+
agent: {
|
|
3236
|
+
name: string;
|
|
3237
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3238
|
+
};
|
|
3102
3239
|
retrievalCount: number;
|
|
3103
3240
|
hitCount: number;
|
|
3104
3241
|
hitRate: number;
|
|
@@ -3117,9 +3254,14 @@ export type ManagementProcedures = {
|
|
|
3117
3254
|
outcome: "started" | "awaiting_approval" | "completed" | "failed" | "rejected" | "dropped";
|
|
3118
3255
|
reason: "busy" | "approval_pending" | "budget" | "rate_limited" | "invalid_payload" | "missing_thread_key" | "no_turn" | "no_output" | "invalid_output" | null;
|
|
3119
3256
|
output: unknown;
|
|
3120
|
-
|
|
3121
|
-
|
|
3122
|
-
|
|
3257
|
+
server: {
|
|
3258
|
+
name: string;
|
|
3259
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3260
|
+
} | null;
|
|
3261
|
+
agent: {
|
|
3262
|
+
name: string;
|
|
3263
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3264
|
+
};
|
|
3123
3265
|
threadTitle: string | null;
|
|
3124
3266
|
createdAt: string;
|
|
3125
3267
|
finishedAt: string | null;
|
|
@@ -3153,8 +3295,11 @@ export type ManagementProcedures = {
|
|
|
3153
3295
|
activeUsers: number;
|
|
3154
3296
|
};
|
|
3155
3297
|
perUser: Array<{
|
|
3156
|
-
|
|
3157
|
-
|
|
3298
|
+
scopeId: string;
|
|
3299
|
+
scope: {
|
|
3300
|
+
name: string;
|
|
3301
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3302
|
+
};
|
|
3158
3303
|
userId: string;
|
|
3159
3304
|
triggerName: string | null;
|
|
3160
3305
|
threads: number;
|
|
@@ -3166,12 +3311,18 @@ export type ManagementProcedures = {
|
|
|
3166
3311
|
messages: number;
|
|
3167
3312
|
}>;
|
|
3168
3313
|
perServer: Array<{
|
|
3169
|
-
serverId: string;
|
|
3170
|
-
|
|
3314
|
+
serverId: string | null;
|
|
3315
|
+
server: {
|
|
3316
|
+
name: string;
|
|
3317
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3318
|
+
} | null;
|
|
3171
3319
|
totalTokens: number;
|
|
3172
3320
|
}>;
|
|
3173
3321
|
perAgent: Array<{
|
|
3174
|
-
|
|
3322
|
+
agent: {
|
|
3323
|
+
name: string;
|
|
3324
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3325
|
+
};
|
|
3175
3326
|
totalTokens: number;
|
|
3176
3327
|
}>;
|
|
3177
3328
|
perDay: Array<{
|
|
@@ -3205,9 +3356,14 @@ export type ManagementProcedures = {
|
|
|
3205
3356
|
detail: string | null;
|
|
3206
3357
|
threadId: string;
|
|
3207
3358
|
createdAt: string;
|
|
3208
|
-
|
|
3209
|
-
|
|
3210
|
-
|
|
3359
|
+
server: {
|
|
3360
|
+
name: string;
|
|
3361
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3362
|
+
} | null;
|
|
3363
|
+
agent: {
|
|
3364
|
+
name: string;
|
|
3365
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3366
|
+
};
|
|
3211
3367
|
threadTitle: string | null;
|
|
3212
3368
|
}>;
|
|
3213
3369
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
@@ -3240,7 +3396,10 @@ export type ManagementProcedures = {
|
|
|
3240
3396
|
callerId: string | null;
|
|
3241
3397
|
toolName: string;
|
|
3242
3398
|
createdAt: string;
|
|
3243
|
-
|
|
3399
|
+
agent: {
|
|
3400
|
+
name: string;
|
|
3401
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3402
|
+
};
|
|
3244
3403
|
triggerName: string | null;
|
|
3245
3404
|
}>;
|
|
3246
3405
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
@@ -3310,7 +3469,10 @@ export type ManagementProcedures = {
|
|
|
3310
3469
|
output: {
|
|
3311
3470
|
items: Array<{
|
|
3312
3471
|
agentId: string;
|
|
3313
|
-
|
|
3472
|
+
agent: {
|
|
3473
|
+
name: string;
|
|
3474
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3475
|
+
};
|
|
3314
3476
|
skillName: string;
|
|
3315
3477
|
misses: number;
|
|
3316
3478
|
lastSeenAt: string | null;
|
|
@@ -3387,9 +3549,14 @@ export type ManagementProcedures = {
|
|
|
3387
3549
|
outcome: "started" | "awaiting_approval" | "completed" | "failed" | "rejected" | "dropped";
|
|
3388
3550
|
reason: "busy" | "approval_pending" | "budget" | "rate_limited" | "invalid_payload" | "missing_thread_key" | "no_turn" | "no_output" | "invalid_output" | null;
|
|
3389
3551
|
output: unknown;
|
|
3390
|
-
|
|
3391
|
-
|
|
3392
|
-
|
|
3552
|
+
server: {
|
|
3553
|
+
name: string;
|
|
3554
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3555
|
+
} | null;
|
|
3556
|
+
agent: {
|
|
3557
|
+
name: string;
|
|
3558
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3559
|
+
};
|
|
3393
3560
|
threadTitle: string | null;
|
|
3394
3561
|
createdAt: string;
|
|
3395
3562
|
finishedAt: string | null;
|
|
@@ -3434,9 +3601,10 @@ export type ManagementProcedures = {
|
|
|
3434
3601
|
agentId: string;
|
|
3435
3602
|
};
|
|
3436
3603
|
output: Array<{
|
|
3604
|
+
name: string;
|
|
3605
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3437
3606
|
kind: "tool" | "service" | "skill" | "trigger" | "dataset_host" | "mcp_server" | "webhook" | "knowledge_collection";
|
|
3438
3607
|
id: string;
|
|
3439
|
-
name: string;
|
|
3440
3608
|
}>;
|
|
3441
3609
|
};
|
|
3442
3610
|
/** Publication history of an entity with pagination. */
|
|
@@ -3543,11 +3711,12 @@ export type ManagementProcedures = {
|
|
|
3543
3711
|
output: {
|
|
3544
3712
|
id: string;
|
|
3545
3713
|
name: string;
|
|
3714
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3546
3715
|
createdAt: string;
|
|
3547
3716
|
updatedAt: string;
|
|
3548
3717
|
};
|
|
3549
3718
|
};
|
|
3550
|
-
/** List
|
|
3719
|
+
/** List secrets' names, display names and dates with pagination and search, each with how many rows name it and the first few (`usedBy`); values are never returned. */
|
|
3551
3720
|
"secrets.list": {
|
|
3552
3721
|
input: {
|
|
3553
3722
|
pageIndex?: number;
|
|
@@ -3558,14 +3727,16 @@ export type ManagementProcedures = {
|
|
|
3558
3727
|
items: Array<{
|
|
3559
3728
|
id: string;
|
|
3560
3729
|
name: string;
|
|
3730
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3561
3731
|
createdAt: string;
|
|
3562
3732
|
updatedAt: string;
|
|
3563
3733
|
usedBy: {
|
|
3564
3734
|
count: number;
|
|
3565
3735
|
preview: Array<{
|
|
3736
|
+
name: string;
|
|
3737
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3566
3738
|
kind: "credential" | "model_provider" | "server" | "agent" | "tool" | "trigger" | "dataset_host" | "webhook" | "mcp_server";
|
|
3567
3739
|
id: string;
|
|
3568
|
-
name: string;
|
|
3569
3740
|
}>;
|
|
3570
3741
|
};
|
|
3571
3742
|
}>;
|
|
@@ -3575,10 +3746,13 @@ export type ManagementProcedures = {
|
|
|
3575
3746
|
filteredCount: number;
|
|
3576
3747
|
};
|
|
3577
3748
|
};
|
|
3578
|
-
/** Every secret name in order, for a picker. */
|
|
3749
|
+
/** Every secret's name and display name, in name order, for a picker. */
|
|
3579
3750
|
"secrets.names": {
|
|
3580
3751
|
input: undefined;
|
|
3581
|
-
output: Array<
|
|
3752
|
+
output: Array<{
|
|
3753
|
+
name: string;
|
|
3754
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3755
|
+
}>;
|
|
3582
3756
|
};
|
|
3583
3757
|
/** Replace a secret's value in place. */
|
|
3584
3758
|
"secrets.rotate": {
|
|
@@ -3589,27 +3763,45 @@ export type ManagementProcedures = {
|
|
|
3589
3763
|
output: {
|
|
3590
3764
|
id: string;
|
|
3591
3765
|
name: string;
|
|
3766
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3592
3767
|
createdAt: string;
|
|
3593
3768
|
updatedAt: string;
|
|
3594
3769
|
};
|
|
3595
3770
|
};
|
|
3596
|
-
/** Create a named secret; credentials compose it by name, and a tool input field may read it. */
|
|
3771
|
+
/** Create a named secret with a display name (a text per locale, `{}` for none); credentials compose it by name, and a tool input field may read it. */
|
|
3597
3772
|
"secrets.set": {
|
|
3598
3773
|
input: {
|
|
3774
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
3599
3775
|
name: string;
|
|
3776
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3600
3777
|
value: string;
|
|
3601
3778
|
};
|
|
3602
3779
|
output: {
|
|
3603
3780
|
id: string;
|
|
3604
3781
|
name: string;
|
|
3782
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3605
3783
|
createdAt: string;
|
|
3606
3784
|
updatedAt: string;
|
|
3607
3785
|
};
|
|
3608
3786
|
};
|
|
3609
|
-
/**
|
|
3610
|
-
"
|
|
3787
|
+
/** Set a secret's display name, a text per locale. Its name and value stay; `secrets.rotate` replaces the value. */
|
|
3788
|
+
"secrets.update": {
|
|
3611
3789
|
input: {
|
|
3790
|
+
id: string;
|
|
3791
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3792
|
+
};
|
|
3793
|
+
output: {
|
|
3794
|
+
id: string;
|
|
3612
3795
|
name: string;
|
|
3796
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3797
|
+
createdAt: string;
|
|
3798
|
+
updatedAt: string;
|
|
3799
|
+
};
|
|
3800
|
+
};
|
|
3801
|
+
/** Register a server by name, with a display name (a text per locale, `{}` for none), the URL it serves the server protocol at, the secret holding its key, optionally the model its agents run on by default, and how often Cortex may check callers with it: `signInChecksPerMinute` (new end-user tokens it verifies) and `triggerChecksPerMinute` (trigger secrets). Its manifest is read at once; a failed read is the row's `syncError` and does not fail the registration. */
|
|
3802
|
+
"servers.create": {
|
|
3803
|
+
input: {
|
|
3804
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3613
3805
|
description: string;
|
|
3614
3806
|
url: string | "";
|
|
3615
3807
|
keySecretName: string;
|
|
@@ -3618,10 +3810,13 @@ export type ManagementProcedures = {
|
|
|
3618
3810
|
modelEffort: string | null;
|
|
3619
3811
|
signInChecksPerMinute: number;
|
|
3620
3812
|
triggerChecksPerMinute: number;
|
|
3813
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
3814
|
+
name: string;
|
|
3621
3815
|
};
|
|
3622
3816
|
output: {
|
|
3623
3817
|
id: string;
|
|
3624
3818
|
name: string;
|
|
3819
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3625
3820
|
description: string | null;
|
|
3626
3821
|
url: string | null;
|
|
3627
3822
|
keySecretName: string | null;
|
|
@@ -3635,6 +3830,7 @@ export type ManagementProcedures = {
|
|
|
3635
3830
|
}>;
|
|
3636
3831
|
tools: Array<{
|
|
3637
3832
|
name: string;
|
|
3833
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
3638
3834
|
description: string;
|
|
3639
3835
|
inputSchema: Record<string, unknown>;
|
|
3640
3836
|
outputSchema?: Record<string, unknown>;
|
|
@@ -3666,6 +3862,7 @@ export type ManagementProcedures = {
|
|
|
3666
3862
|
output: {
|
|
3667
3863
|
id: string;
|
|
3668
3864
|
name: string;
|
|
3865
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3669
3866
|
description: string | null;
|
|
3670
3867
|
url: string | null;
|
|
3671
3868
|
keySecretName: string | null;
|
|
@@ -3679,6 +3876,7 @@ export type ManagementProcedures = {
|
|
|
3679
3876
|
}>;
|
|
3680
3877
|
tools: Array<{
|
|
3681
3878
|
name: string;
|
|
3879
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
3682
3880
|
description: string;
|
|
3683
3881
|
inputSchema: Record<string, unknown>;
|
|
3684
3882
|
outputSchema?: Record<string, unknown>;
|
|
@@ -3702,18 +3900,6 @@ export type ManagementProcedures = {
|
|
|
3702
3900
|
updatedAt: string;
|
|
3703
3901
|
};
|
|
3704
3902
|
};
|
|
3705
|
-
/** Remove an alias. */
|
|
3706
|
-
"servers.deleteAlias": {
|
|
3707
|
-
input: {
|
|
3708
|
-
alias: string;
|
|
3709
|
-
};
|
|
3710
|
-
output: {
|
|
3711
|
-
alias: string;
|
|
3712
|
-
agentId: string;
|
|
3713
|
-
createdAt: string;
|
|
3714
|
-
updatedAt: string;
|
|
3715
|
-
};
|
|
3716
|
-
};
|
|
3717
3903
|
/** One server by id with its declared variables and the components whose audience is the server. */
|
|
3718
3904
|
"servers.get": {
|
|
3719
3905
|
input: {
|
|
@@ -3722,6 +3908,7 @@ export type ManagementProcedures = {
|
|
|
3722
3908
|
output: {
|
|
3723
3909
|
id: string;
|
|
3724
3910
|
name: string;
|
|
3911
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3725
3912
|
description: string | null;
|
|
3726
3913
|
url: string | null;
|
|
3727
3914
|
keySecretName: string | null;
|
|
@@ -3743,9 +3930,10 @@ export type ManagementProcedures = {
|
|
|
3743
3930
|
computed: boolean;
|
|
3744
3931
|
}>;
|
|
3745
3932
|
components: Array<{
|
|
3933
|
+
name: string;
|
|
3934
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3746
3935
|
kind: "tool" | "service" | "skill" | "trigger" | "dataset_host" | "mcp_server" | "webhook" | "knowledge_collection";
|
|
3747
3936
|
id: string;
|
|
3748
|
-
name: string;
|
|
3749
3937
|
}>;
|
|
3750
3938
|
};
|
|
3751
3939
|
};
|
|
@@ -3761,6 +3949,7 @@ export type ManagementProcedures = {
|
|
|
3761
3949
|
items: Array<{
|
|
3762
3950
|
id: string;
|
|
3763
3951
|
name: string;
|
|
3952
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3764
3953
|
description: string | null;
|
|
3765
3954
|
url: string | null;
|
|
3766
3955
|
keySecretName: string | null;
|
|
@@ -3776,28 +3965,7 @@ export type ManagementProcedures = {
|
|
|
3776
3965
|
filteredCount: number;
|
|
3777
3966
|
};
|
|
3778
3967
|
};
|
|
3779
|
-
/**
|
|
3780
|
-
"servers.listAliases": {
|
|
3781
|
-
input: {
|
|
3782
|
-
pageIndex?: number;
|
|
3783
|
-
pageSize?: number;
|
|
3784
|
-
q?: string;
|
|
3785
|
-
serverId: string;
|
|
3786
|
-
};
|
|
3787
|
-
output: {
|
|
3788
|
-
items: Array<{
|
|
3789
|
-
alias: string;
|
|
3790
|
-
agentId: string;
|
|
3791
|
-
agentName: string;
|
|
3792
|
-
agentSlug: string;
|
|
3793
|
-
}>;
|
|
3794
|
-
/** Every row the caller may see, ignoring the search and filters. */
|
|
3795
|
-
count: number;
|
|
3796
|
-
/** The rows matching the search and filters, over all pages: the total to report. */
|
|
3797
|
-
filteredCount: number;
|
|
3798
|
-
};
|
|
3799
|
-
};
|
|
3800
|
-
/** Server id and name pairs for selectors. Cortex's own system server is left out unless `includeSystem` asks for it, as a filter over its threads does. */
|
|
3968
|
+
/** Each server's id, name and display name, for selectors. Cortex's own system server is left out unless `includeSystem` asks for it, as a filter over its threads does. */
|
|
3801
3969
|
"servers.options": {
|
|
3802
3970
|
input: {
|
|
3803
3971
|
includeSystem?: boolean;
|
|
@@ -3805,19 +3973,9 @@ export type ManagementProcedures = {
|
|
|
3805
3973
|
output: Array<{
|
|
3806
3974
|
id: string;
|
|
3807
3975
|
name: string;
|
|
3976
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3808
3977
|
}>;
|
|
3809
3978
|
};
|
|
3810
|
-
/** Point an alias at an agent, creating it or moving it among the agents of one server. Refused (slug_taken) when an agent goes by the name or it is an alias of another server's agent. */
|
|
3811
|
-
"servers.setAlias": {
|
|
3812
|
-
input: {
|
|
3813
|
-
alias: string;
|
|
3814
|
-
agentId: string;
|
|
3815
|
-
};
|
|
3816
|
-
output: {
|
|
3817
|
-
alias: string;
|
|
3818
|
-
agentId: string;
|
|
3819
|
-
};
|
|
3820
|
-
};
|
|
3821
3979
|
/** Read the server's manifest now and apply its variables and native tools; a refused manifest leaves the previous one in place. */
|
|
3822
3980
|
"servers.sync": {
|
|
3823
3981
|
input: {
|
|
@@ -3827,10 +3985,10 @@ export type ManagementProcedures = {
|
|
|
3827
3985
|
syncedAt: string;
|
|
3828
3986
|
};
|
|
3829
3987
|
};
|
|
3830
|
-
/**
|
|
3988
|
+
/** Change a server's display name, URL or key, set how often Cortex may check callers with it (`signInChecksPerMinute`, `triggerChecksPerMinute`; resend the current values to keep them), or pick the model its agents run on by default: `modelProvider` with one of its `modelName`s, and a `modelEffort` that provider lists; all null leaves each agent to pick its own. Refused as `model_not_offered` otherwise, and as `model_in_use` when an agent on the server picks an effort alone the new provider does not list, or is published with no model of its own and would be left without one. Clearing the URL or key drops what its manifest offered, refused as a sync dropping it all would be: `verify_in_use` while an agent's auth is the server's, `variable_in_use` or `still_referenced` while a published component reads a variable or calls a native tool it declared. A new URL or key has its manifest read at once, as on registration. */
|
|
3831
3989
|
"servers.update": {
|
|
3832
3990
|
input: {
|
|
3833
|
-
|
|
3991
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3834
3992
|
description: string;
|
|
3835
3993
|
url: string | "";
|
|
3836
3994
|
keySecretName: string;
|
|
@@ -3844,6 +4002,7 @@ export type ManagementProcedures = {
|
|
|
3844
4002
|
output: {
|
|
3845
4003
|
id: string;
|
|
3846
4004
|
name: string;
|
|
4005
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3847
4006
|
description: string | null;
|
|
3848
4007
|
url: string | null;
|
|
3849
4008
|
keySecretName: string | null;
|
|
@@ -3857,6 +4016,7 @@ export type ManagementProcedures = {
|
|
|
3857
4016
|
}>;
|
|
3858
4017
|
tools: Array<{
|
|
3859
4018
|
name: string;
|
|
4019
|
+
displayName?: Partial<Record<"en" | "ar", string>>;
|
|
3860
4020
|
description: string;
|
|
3861
4021
|
inputSchema: Record<string, unknown>;
|
|
3862
4022
|
outputSchema?: Record<string, unknown>;
|
|
@@ -3883,9 +4043,9 @@ export type ManagementProcedures = {
|
|
|
3883
4043
|
/** Create a service with an audience ({ kind: "all" }, { kind: "server", serverId }, or { kind: "agents", agentIds }). The draft has no tools yet; add them before publishing. */
|
|
3884
4044
|
"services.create": {
|
|
3885
4045
|
input: {
|
|
3886
|
-
/** A
|
|
3887
|
-
|
|
3888
|
-
|
|
4046
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
4047
|
+
name: string;
|
|
4048
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3889
4049
|
audience: {
|
|
3890
4050
|
kind: "all";
|
|
3891
4051
|
} | {
|
|
@@ -3898,7 +4058,7 @@ export type ManagementProcedures = {
|
|
|
3898
4058
|
};
|
|
3899
4059
|
output: {
|
|
3900
4060
|
id: string;
|
|
3901
|
-
name:
|
|
4061
|
+
name: string;
|
|
3902
4062
|
};
|
|
3903
4063
|
};
|
|
3904
4064
|
/** Delete a service; fails while tools reference it. */
|
|
@@ -3917,11 +4077,11 @@ export type ManagementProcedures = {
|
|
|
3917
4077
|
};
|
|
3918
4078
|
output: {
|
|
3919
4079
|
id: string;
|
|
3920
|
-
|
|
3921
|
-
name: Record<"en" | "ar", string>;
|
|
4080
|
+
name: string;
|
|
3922
4081
|
description: Record<"en" | "ar", string>;
|
|
3923
4082
|
status: "draft" | "published" | "disabled";
|
|
3924
4083
|
updatedAt: string;
|
|
4084
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3925
4085
|
source: "direct" | "manifest" | "server";
|
|
3926
4086
|
sourceId: string | null;
|
|
3927
4087
|
overridable: Array<string>;
|
|
@@ -3935,9 +4095,10 @@ export type ManagementProcedures = {
|
|
|
3935
4095
|
agentIds: Array<string>;
|
|
3936
4096
|
};
|
|
3937
4097
|
referrers: Array<{
|
|
4098
|
+
name: string;
|
|
4099
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3938
4100
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
3939
4101
|
id: string;
|
|
3940
|
-
name: string;
|
|
3941
4102
|
readers: {
|
|
3942
4103
|
kind: "all";
|
|
3943
4104
|
} | {
|
|
@@ -3956,7 +4117,6 @@ export type ManagementProcedures = {
|
|
|
3956
4117
|
id: string;
|
|
3957
4118
|
name: string;
|
|
3958
4119
|
}>;
|
|
3959
|
-
nameLocked: boolean;
|
|
3960
4120
|
};
|
|
3961
4121
|
};
|
|
3962
4122
|
/** List services (upstream API groupings for tools) with pagination and search. */
|
|
@@ -3972,10 +4132,10 @@ export type ManagementProcedures = {
|
|
|
3972
4132
|
output: {
|
|
3973
4133
|
items: Array<{
|
|
3974
4134
|
id: string;
|
|
3975
|
-
|
|
3976
|
-
name: Record<"en" | "ar", string>;
|
|
4135
|
+
name: string;
|
|
3977
4136
|
description: Record<"en" | "ar", string>;
|
|
3978
4137
|
status: "draft" | "published" | "disabled";
|
|
4138
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
3979
4139
|
source: "direct" | "manifest" | "server";
|
|
3980
4140
|
sourceId: string | null;
|
|
3981
4141
|
overridable: Array<string>;
|
|
@@ -3995,7 +4155,7 @@ export type ManagementProcedures = {
|
|
|
3995
4155
|
filteredCount: number;
|
|
3996
4156
|
};
|
|
3997
4157
|
};
|
|
3998
|
-
/** Every service a component with the given audience may be scoped to, as id,
|
|
4158
|
+
/** Every service a component with the given audience may be scoped to, as id, name and display name, for selectors. */
|
|
3999
4159
|
"services.options": {
|
|
4000
4160
|
input: {
|
|
4001
4161
|
audience: {
|
|
@@ -4010,8 +4170,8 @@ export type ManagementProcedures = {
|
|
|
4010
4170
|
};
|
|
4011
4171
|
output: Array<{
|
|
4012
4172
|
id: string;
|
|
4013
|
-
|
|
4014
|
-
|
|
4173
|
+
name: string;
|
|
4174
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4015
4175
|
}>;
|
|
4016
4176
|
};
|
|
4017
4177
|
/** Publish the service's current draft. */
|
|
@@ -4092,15 +4252,13 @@ export type ManagementProcedures = {
|
|
|
4092
4252
|
/** Update a service's draft. Saved as a draft; call the entity's publish procedure to make it live. */
|
|
4093
4253
|
"services.update": {
|
|
4094
4254
|
input: {
|
|
4095
|
-
|
|
4096
|
-
key: string;
|
|
4097
|
-
name: Record<"en" | "ar", string>;
|
|
4255
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4098
4256
|
description: Record<"en" | "ar", string>;
|
|
4099
4257
|
id: string;
|
|
4100
4258
|
};
|
|
4101
4259
|
output: {
|
|
4102
4260
|
id: string;
|
|
4103
|
-
name:
|
|
4261
|
+
name: string;
|
|
4104
4262
|
};
|
|
4105
4263
|
};
|
|
4106
4264
|
/** Deployment settings: log and thread retention. */
|
|
@@ -4132,8 +4290,9 @@ export type ManagementProcedures = {
|
|
|
4132
4290
|
/** Create a skill with an audience ({ kind: "all" }, { kind: "server", serverId }, or { kind: "agents", agentIds }). The draft has no body yet; fill it with update before publishing. */
|
|
4133
4291
|
"skills.create": {
|
|
4134
4292
|
input: {
|
|
4135
|
-
/** A
|
|
4293
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
4136
4294
|
name: string;
|
|
4295
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4137
4296
|
audience: {
|
|
4138
4297
|
kind: "all";
|
|
4139
4298
|
} | {
|
|
@@ -4172,6 +4331,7 @@ export type ManagementProcedures = {
|
|
|
4172
4331
|
body: string;
|
|
4173
4332
|
status: "draft" | "published" | "disabled";
|
|
4174
4333
|
updatedAt: string;
|
|
4334
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4175
4335
|
source: "direct" | "manifest" | "server";
|
|
4176
4336
|
sourceId: string | null;
|
|
4177
4337
|
overridable: Array<string>;
|
|
@@ -4185,9 +4345,10 @@ export type ManagementProcedures = {
|
|
|
4185
4345
|
agentIds: Array<string>;
|
|
4186
4346
|
};
|
|
4187
4347
|
referrers: Array<{
|
|
4348
|
+
name: string;
|
|
4349
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4188
4350
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
4189
4351
|
id: string;
|
|
4190
|
-
name: string;
|
|
4191
4352
|
readers: {
|
|
4192
4353
|
kind: "all";
|
|
4193
4354
|
} | {
|
|
@@ -4198,7 +4359,10 @@ export type ManagementProcedures = {
|
|
|
4198
4359
|
agentIds: Array<string>;
|
|
4199
4360
|
};
|
|
4200
4361
|
}>;
|
|
4201
|
-
|
|
4362
|
+
service: {
|
|
4363
|
+
name: string;
|
|
4364
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4365
|
+
} | null;
|
|
4202
4366
|
variables: Array<{
|
|
4203
4367
|
name: string;
|
|
4204
4368
|
description: string;
|
|
@@ -4218,7 +4382,6 @@ export type ManagementProcedures = {
|
|
|
4218
4382
|
id: string;
|
|
4219
4383
|
name: string;
|
|
4220
4384
|
}>;
|
|
4221
|
-
nameLocked: boolean;
|
|
4222
4385
|
};
|
|
4223
4386
|
};
|
|
4224
4387
|
/** List skills with pagination and search: every skill of an agent, or only those scoped to no service or to one service. */
|
|
@@ -4239,6 +4402,7 @@ export type ManagementProcedures = {
|
|
|
4239
4402
|
name: string;
|
|
4240
4403
|
description: string;
|
|
4241
4404
|
status: "draft" | "published" | "disabled";
|
|
4405
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4242
4406
|
source: "direct" | "manifest" | "server";
|
|
4243
4407
|
sourceId: string | null;
|
|
4244
4408
|
overridable: Array<string>;
|
|
@@ -4333,14 +4497,13 @@ export type ManagementProcedures = {
|
|
|
4333
4497
|
unchanged: boolean;
|
|
4334
4498
|
};
|
|
4335
4499
|
};
|
|
4336
|
-
/** Update a skill's
|
|
4500
|
+
/** Update a skill's display name, or its draft description or body. The description and body are saved as a draft; call the entity's publish procedure to make them live. The display name applies at once. */
|
|
4337
4501
|
"skills.update": {
|
|
4338
4502
|
input: {
|
|
4339
|
-
/** A slug: lowercase letters, digits, and single hyphens. */
|
|
4340
|
-
name: string;
|
|
4341
4503
|
description: string;
|
|
4342
4504
|
body: string;
|
|
4343
4505
|
id: string;
|
|
4506
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4344
4507
|
variables: Array<string>;
|
|
4345
4508
|
};
|
|
4346
4509
|
output: {
|
|
@@ -4361,11 +4524,16 @@ export type ManagementProcedures = {
|
|
|
4361
4524
|
triggerName: string | null;
|
|
4362
4525
|
createdAt: string;
|
|
4363
4526
|
updatedAt: string;
|
|
4364
|
-
serverId: string;
|
|
4365
|
-
|
|
4366
|
-
|
|
4527
|
+
serverId: string | null;
|
|
4528
|
+
server: {
|
|
4529
|
+
name: string;
|
|
4530
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4531
|
+
} | null;
|
|
4532
|
+
agent: {
|
|
4533
|
+
name: string;
|
|
4534
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4535
|
+
};
|
|
4367
4536
|
agentId: string;
|
|
4368
|
-
agentName: string;
|
|
4369
4537
|
agentUrl: string | null;
|
|
4370
4538
|
messageCount: number;
|
|
4371
4539
|
totalTokens: number;
|
|
@@ -4384,7 +4552,7 @@ export type ManagementProcedures = {
|
|
|
4384
4552
|
pageSize?: number;
|
|
4385
4553
|
q?: string;
|
|
4386
4554
|
serverId?: string;
|
|
4387
|
-
|
|
4555
|
+
agentName?: string;
|
|
4388
4556
|
userId?: string;
|
|
4389
4557
|
dateFrom?: string;
|
|
4390
4558
|
dateTo?: string;
|
|
@@ -4400,9 +4568,15 @@ export type ManagementProcedures = {
|
|
|
4400
4568
|
triggerName: string | null;
|
|
4401
4569
|
createdAt: string;
|
|
4402
4570
|
updatedAt: string;
|
|
4403
|
-
serverId: string;
|
|
4404
|
-
|
|
4405
|
-
|
|
4571
|
+
serverId: string | null;
|
|
4572
|
+
server: {
|
|
4573
|
+
name: string;
|
|
4574
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4575
|
+
} | null;
|
|
4576
|
+
agent: {
|
|
4577
|
+
name: string;
|
|
4578
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4579
|
+
};
|
|
4406
4580
|
}>;
|
|
4407
4581
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
4408
4582
|
count: number;
|
|
@@ -4591,6 +4765,7 @@ export type ManagementProcedures = {
|
|
|
4591
4765
|
description: string;
|
|
4592
4766
|
endpointUrl: string;
|
|
4593
4767
|
method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
|
|
4768
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4594
4769
|
audience: {
|
|
4595
4770
|
kind: "all";
|
|
4596
4771
|
} | {
|
|
@@ -4822,6 +4997,7 @@ export type ManagementProcedures = {
|
|
|
4822
4997
|
agentIds: Array<string>;
|
|
4823
4998
|
};
|
|
4824
4999
|
name: string;
|
|
5000
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4825
5001
|
description: string;
|
|
4826
5002
|
type: "http" | "embedded" | "soap" | "native" | "client";
|
|
4827
5003
|
config: {
|
|
@@ -4856,9 +5032,10 @@ export type ManagementProcedures = {
|
|
|
4856
5032
|
createdAt: string;
|
|
4857
5033
|
updatedAt: string;
|
|
4858
5034
|
referrers: Array<{
|
|
5035
|
+
name: string;
|
|
5036
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4859
5037
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
4860
5038
|
id: string;
|
|
4861
|
-
name: string;
|
|
4862
5039
|
readers: {
|
|
4863
5040
|
kind: "all";
|
|
4864
5041
|
} | {
|
|
@@ -4878,7 +5055,6 @@ export type ManagementProcedures = {
|
|
|
4878
5055
|
}>;
|
|
4879
5056
|
inputFields: Array<StoredSchemaFieldRow>;
|
|
4880
5057
|
outputFields: Array<StoredSchemaFieldRow>;
|
|
4881
|
-
nameLocked: boolean;
|
|
4882
5058
|
};
|
|
4883
5059
|
};
|
|
4884
5060
|
/** List tools with pagination and search. */
|
|
@@ -4902,6 +5078,7 @@ export type ManagementProcedures = {
|
|
|
4902
5078
|
status: "draft" | "published" | "disabled";
|
|
4903
5079
|
pinned: boolean;
|
|
4904
5080
|
importSource: string | null;
|
|
5081
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4905
5082
|
source: "direct" | "manifest" | "server";
|
|
4906
5083
|
sourceId: string | null;
|
|
4907
5084
|
overridable: Array<string>;
|
|
@@ -4921,12 +5098,13 @@ export type ManagementProcedures = {
|
|
|
4921
5098
|
filteredCount: number;
|
|
4922
5099
|
};
|
|
4923
5100
|
};
|
|
4924
|
-
/**
|
|
5101
|
+
/** Each tool's id, name and display name, for selectors. */
|
|
4925
5102
|
"tools.options": {
|
|
4926
5103
|
input: undefined;
|
|
4927
5104
|
output: Array<{
|
|
4928
5105
|
id: string;
|
|
4929
5106
|
name: string;
|
|
5107
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
4930
5108
|
}>;
|
|
4931
5109
|
};
|
|
4932
5110
|
/** Parse an OpenAPI document and list the operations it would import as tools, and the tools already importing some of them. */
|
|
@@ -5106,8 +5284,6 @@ export type ManagementProcedures = {
|
|
|
5106
5284
|
/** Update a tool's draft. Saved as a draft; call the entity's publish procedure to make it live. `headers` (the headers every call carries, each with a prefix and where its value comes from: `{ kind: "credential", name }`, `{ kind: "runToken" }`, `{ kind: "variable", name }` or `{ kind: "constant", value }`) and `rateLimits` (calls per minute for all users and per user, null for no limit) apply live without a publish. A variable must be one every agent the tool reaches is filled with. */
|
|
5107
5285
|
"tools.update": {
|
|
5108
5286
|
input: {
|
|
5109
|
-
/** 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). */
|
|
5110
|
-
name: string;
|
|
5111
5287
|
description: string;
|
|
5112
5288
|
endpointUrl: string;
|
|
5113
5289
|
method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
|
|
@@ -5142,6 +5318,7 @@ export type ManagementProcedures = {
|
|
|
5142
5318
|
projectOutput: boolean;
|
|
5143
5319
|
tags: Array<string>;
|
|
5144
5320
|
id: string;
|
|
5321
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5145
5322
|
variables: Array<{
|
|
5146
5323
|
name: string;
|
|
5147
5324
|
description: string;
|
|
@@ -5235,8 +5412,9 @@ export type ManagementProcedures = {
|
|
|
5235
5412
|
/** Create a trigger (a named entry point external systems fire on an agent) with an audience ({ kind: "all" }, { kind: "server", serverId }, or { kind: "agents", agentIds }), fired on any agent in it. The draft has no instructions yet; fill them with update before publishing. */
|
|
5236
5413
|
"triggers.create": {
|
|
5237
5414
|
input: {
|
|
5238
|
-
/** A
|
|
5415
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
5239
5416
|
name: string;
|
|
5417
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5240
5418
|
audience: {
|
|
5241
5419
|
kind: "all";
|
|
5242
5420
|
} | {
|
|
@@ -5347,6 +5525,7 @@ export type ManagementProcedures = {
|
|
|
5347
5525
|
modelEffort: string | null;
|
|
5348
5526
|
status: "draft" | "published" | "disabled";
|
|
5349
5527
|
updatedAt: string;
|
|
5528
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5350
5529
|
source: "direct" | "manifest" | "server";
|
|
5351
5530
|
sourceId: string | null;
|
|
5352
5531
|
overridable: Array<string>;
|
|
@@ -5360,9 +5539,10 @@ export type ManagementProcedures = {
|
|
|
5360
5539
|
agentIds: Array<string>;
|
|
5361
5540
|
};
|
|
5362
5541
|
referrers: Array<{
|
|
5542
|
+
name: string;
|
|
5543
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5363
5544
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
5364
5545
|
id: string;
|
|
5365
|
-
name: string;
|
|
5366
5546
|
readers: {
|
|
5367
5547
|
kind: "all";
|
|
5368
5548
|
} | {
|
|
@@ -5375,8 +5555,8 @@ export type ManagementProcedures = {
|
|
|
5375
5555
|
}>;
|
|
5376
5556
|
agents: Array<{
|
|
5377
5557
|
id: string;
|
|
5378
|
-
slug: string;
|
|
5379
5558
|
name: string;
|
|
5559
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5380
5560
|
}>;
|
|
5381
5561
|
engineUrl: string | null;
|
|
5382
5562
|
variables: Array<{
|
|
@@ -5400,7 +5580,6 @@ export type ManagementProcedures = {
|
|
|
5400
5580
|
id: string;
|
|
5401
5581
|
name: string;
|
|
5402
5582
|
}>;
|
|
5403
|
-
nameLocked: boolean;
|
|
5404
5583
|
};
|
|
5405
5584
|
};
|
|
5406
5585
|
/** List triggers with pagination and search. */
|
|
@@ -5430,6 +5609,7 @@ export type ManagementProcedures = {
|
|
|
5430
5609
|
};
|
|
5431
5610
|
status: "draft" | "published" | "disabled";
|
|
5432
5611
|
secretPrefix: string;
|
|
5612
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5433
5613
|
source: "direct" | "manifest" | "server";
|
|
5434
5614
|
sourceId: string | null;
|
|
5435
5615
|
overridable: Array<string>;
|
|
@@ -5535,11 +5715,9 @@ export type ManagementProcedures = {
|
|
|
5535
5715
|
unchanged: boolean;
|
|
5536
5716
|
};
|
|
5537
5717
|
};
|
|
5538
|
-
/** Update a trigger's draft. Saved as a draft; call the entity's publish procedure to make it live. `credentialName`, `fireCredentialName` and the model pick are the exceptions: they apply without a publish, the fire credential from the next firing and the others from each agent's next turn. Giving the run a different `credentialName` needs `secrets:write`, since tools forwarding the run token send its value upstream. The model pick (`modelProvider` with one of its `modelName`s and optionally a `modelEffort`, all null to run on each agent's own) is refused as `model_not_offered` when the provider does not list the model or the effort, or an effort is picked without a model. `fireCredentialName` names a static credential whose value callers present to fire, shared by every trigger naming it; that credential and its secret may serve nothing else. Clearing it leaves the trigger shut until `triggers.rotateSecret` mints a secret. */
|
|
5718
|
+
/** Update a trigger's draft. Saved as a draft; call the entity's publish procedure to make it live. `displayName`, `credentialName`, `fireCredentialName` and the model pick are the exceptions: they apply without a publish, the display name at once, the fire credential from the next firing and the others from each agent's next turn. Giving the run a different `credentialName` needs `secrets:write`, since tools forwarding the run token send its value upstream. The model pick (`modelProvider` with one of its `modelName`s and optionally a `modelEffort`, all null to run on each agent's own) is refused as `model_not_offered` when the provider does not list the model or the effort, or an effort is picked without a model. `fireCredentialName` names a static credential whose value callers present to fire, shared by every trigger naming it; that credential and its secret may serve nothing else. Clearing it leaves the trigger shut until `triggers.rotateSecret` mints a secret. */
|
|
5539
5719
|
"triggers.update": {
|
|
5540
5720
|
input: {
|
|
5541
|
-
/** A slug: lowercase letters, digits, and single hyphens. */
|
|
5542
|
-
name: string;
|
|
5543
5721
|
description: string;
|
|
5544
5722
|
inputFields: Array<SchemaFieldRow>;
|
|
5545
5723
|
outputFields: Array<SchemaFieldRow>;
|
|
@@ -5557,6 +5735,7 @@ export type ManagementProcedures = {
|
|
|
5557
5735
|
budgetPerDay: number | null;
|
|
5558
5736
|
disableAfterFailures: number;
|
|
5559
5737
|
id: string;
|
|
5738
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5560
5739
|
credentialName: string | null;
|
|
5561
5740
|
fireCredentialName: string | null;
|
|
5562
5741
|
modelProvider: string | null;
|
|
@@ -5646,9 +5825,10 @@ export type ManagementProcedures = {
|
|
|
5646
5825
|
/** Create a webhook (an HTTP endpoint Cortex posts an event to when a run on an agent parks for approval) with an audience ({ kind: "all" }, { kind: "server", serverId }, or { kind: "agents", agentIds }). It starts disabled: set its headers with update, then enable it with toggle. */
|
|
5647
5826
|
"webhooks.create": {
|
|
5648
5827
|
input: {
|
|
5649
|
-
/** A
|
|
5828
|
+
/** A name: lowercase letters, digits, and single hyphens. */
|
|
5650
5829
|
name: string;
|
|
5651
5830
|
url: string;
|
|
5831
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5652
5832
|
audience: {
|
|
5653
5833
|
kind: "all";
|
|
5654
5834
|
} | {
|
|
@@ -5694,6 +5874,7 @@ export type ManagementProcedures = {
|
|
|
5694
5874
|
agentIds: Array<string>;
|
|
5695
5875
|
};
|
|
5696
5876
|
name: string;
|
|
5877
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5697
5878
|
description: string;
|
|
5698
5879
|
event: "approval_requested";
|
|
5699
5880
|
url: string;
|
|
@@ -5717,9 +5898,10 @@ export type ManagementProcedures = {
|
|
|
5717
5898
|
enabled: boolean;
|
|
5718
5899
|
updatedAt: string;
|
|
5719
5900
|
referrers: Array<{
|
|
5901
|
+
name: string;
|
|
5902
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5720
5903
|
kind: "agent_prompt" | "service" | "skill" | "trigger" | "knowledge_collection";
|
|
5721
5904
|
id: string;
|
|
5722
|
-
name: string;
|
|
5723
5905
|
readers: {
|
|
5724
5906
|
kind: "all";
|
|
5725
5907
|
} | {
|
|
@@ -5749,6 +5931,7 @@ export type ManagementProcedures = {
|
|
|
5749
5931
|
event: "approval_requested";
|
|
5750
5932
|
url: string;
|
|
5751
5933
|
enabled: boolean;
|
|
5934
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5752
5935
|
source: "direct" | "manifest" | "server";
|
|
5753
5936
|
sourceId: string | null;
|
|
5754
5937
|
overridable: Array<string>;
|
|
@@ -5796,7 +5979,10 @@ export type ManagementProcedures = {
|
|
|
5796
5979
|
durationMs: number;
|
|
5797
5980
|
error: "upstream_status" | "upstream_failed" | "egress_blocked" | "timeout" | "response_too_large" | "token_missing" | "unknown_credential" | "credential_unavailable" | "unexpected" | null;
|
|
5798
5981
|
createdAt: string;
|
|
5799
|
-
|
|
5982
|
+
agent: {
|
|
5983
|
+
name: string;
|
|
5984
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5985
|
+
} | null;
|
|
5800
5986
|
}>;
|
|
5801
5987
|
/** Every row the caller may see, ignoring the search and filters. */
|
|
5802
5988
|
count: number;
|
|
@@ -5859,8 +6045,6 @@ export type ManagementProcedures = {
|
|
|
5859
6045
|
/** Update a webhook. Every delivery reads it live, so a change applies to the next one at once. A header's value comes from a credential or a constant: a delivery has no run of its own, so no run token or variable. */
|
|
5860
6046
|
"webhooks.update": {
|
|
5861
6047
|
input: {
|
|
5862
|
-
/** A slug: lowercase letters, digits, and single hyphens. */
|
|
5863
|
-
name: string;
|
|
5864
6048
|
description: string;
|
|
5865
6049
|
event: "approval_requested";
|
|
5866
6050
|
url: string;
|
|
@@ -5882,6 +6066,7 @@ export type ManagementProcedures = {
|
|
|
5882
6066
|
}>;
|
|
5883
6067
|
timeoutMs: number;
|
|
5884
6068
|
id: string;
|
|
6069
|
+
displayName: Partial<Record<"en" | "ar", string>>;
|
|
5885
6070
|
};
|
|
5886
6071
|
output: {
|
|
5887
6072
|
id: string;
|