@salesforce/plugin-agent 1.43.0 → 1.44.5
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 +78 -46
- package/lib/adlUtils.d.ts +2 -0
- package/lib/adlUtils.js +31 -0
- package/lib/adlUtils.js.map +1 -0
- package/lib/commands/agent/adl/create.d.ts +6 -1
- package/lib/commands/agent/adl/create.js +83 -19
- package/lib/commands/agent/adl/create.js.map +1 -1
- package/lib/commands/agent/adl/delete.d.ts +0 -1
- package/lib/commands/agent/adl/delete.js +3 -2
- package/lib/commands/agent/adl/delete.js.map +1 -1
- package/lib/commands/agent/adl/file/add.d.ts +0 -1
- package/lib/commands/agent/adl/file/add.js +3 -2
- package/lib/commands/agent/adl/file/add.js.map +1 -1
- package/lib/commands/agent/adl/file/delete.d.ts +0 -1
- package/lib/commands/agent/adl/file/delete.js +4 -3
- package/lib/commands/agent/adl/file/delete.js.map +1 -1
- package/lib/commands/agent/adl/file/list.d.ts +5 -5
- package/lib/commands/agent/adl/file/list.js +31 -7
- package/lib/commands/agent/adl/file/list.js.map +1 -1
- package/lib/commands/agent/adl/get.d.ts +0 -1
- package/lib/commands/agent/adl/get.js +15 -3
- package/lib/commands/agent/adl/get.js.map +1 -1
- package/lib/commands/agent/adl/list.d.ts +0 -1
- package/lib/commands/agent/adl/list.js +3 -2
- package/lib/commands/agent/adl/list.js.map +1 -1
- package/lib/commands/agent/adl/status.d.ts +1 -1
- package/lib/commands/agent/adl/status.js +21 -4
- package/lib/commands/agent/adl/status.js.map +1 -1
- package/lib/commands/agent/adl/update.d.ts +1 -1
- package/lib/commands/agent/adl/update.js +18 -5
- package/lib/commands/agent/adl/update.js.map +1 -1
- package/lib/commands/agent/adl/upload.d.ts +0 -1
- package/lib/commands/agent/adl/upload.js +3 -2
- package/lib/commands/agent/adl/upload.js.map +1 -1
- package/messages/agent.adl.create.md +22 -0
- package/messages/agent.adl.file.add.md +2 -0
- package/messages/agent.adl.file.delete.md +4 -0
- package/messages/agent.adl.file.list.md +12 -0
- package/messages/agent.adl.status.md +5 -1
- package/messages/agent.adl.update.md +4 -0
- package/messages/agent.adl.upload.md +2 -0
- package/oclif.manifest.json +579 -517
- package/package.json +4 -4
- package/schemas/agent-adl-create.json +63 -3
- package/schemas/agent-adl-delete.json +5 -2
- package/schemas/agent-adl-file-add.json +7 -2
- package/schemas/agent-adl-file-delete.json +5 -2
- package/schemas/agent-adl-file-list.json +26 -3
- package/schemas/agent-adl-get.json +63 -3
- package/schemas/agent-adl-list.json +55 -3
- package/schemas/agent-adl-status.json +44 -4
- package/schemas/agent-adl-update.json +63 -3
- package/schemas/agent-adl-upload.json +5 -2
- package/schemas/agent-preview-end.json +8 -3
- package/schemas/agent-publish-authoring__bundle.json +8 -3
- package/schemas/agent-trace-delete.json +7 -2
- package/schemas/agent-trace-list.json +9 -2
- package/schemas/agent-trace-read.json +131 -21
package/oclif.manifest.json
CHANGED
|
@@ -421,7 +421,7 @@
|
|
|
421
421
|
"agent:adl:create": {
|
|
422
422
|
"aliases": [],
|
|
423
423
|
"args": {},
|
|
424
|
-
"description": "Creates a new data library in the target org. The --source-type flag determines the type of library: SFDRIVE (file upload), KNOWLEDGE (Salesforce Knowledge articles), or RETRIEVER (existing active Custom Retriever).",
|
|
424
|
+
"description": "Creates a new data library in the target org. The --source-type flag determines the type of library: SFDRIVE (file upload), KNOWLEDGE (Salesforce Knowledge articles), or RETRIEVER (existing active Custom Retriever).\n\nFor SFDRIVE libraries, creation provisions the full Data Cloud pipeline (DLO → DMO → SearchIndex → Retriever). Upload files with `sf agent adl upload` after creation.",
|
|
425
425
|
"examples": [
|
|
426
426
|
"Create an SFDRIVE library:\n<%= config.bin %> <%= command.id %> --target-org myOrg --name \"My Docs\" --developer-name My_Docs --source-type sfdrive",
|
|
427
427
|
"Create a KNOWLEDGE library with index fields:\n<%= config.bin %> <%= command.id %> --target-org myOrg --name \"KB Library\" --developer-name KB_Library --source-type knowledge --primary-index-field1 Title --primary-index-field2 Summary",
|
|
@@ -528,6 +528,35 @@
|
|
|
528
528
|
"hasDynamicHelp": false,
|
|
529
529
|
"multiple": false,
|
|
530
530
|
"type": "option"
|
|
531
|
+
},
|
|
532
|
+
"content-fields": {
|
|
533
|
+
"name": "content-fields",
|
|
534
|
+
"summary": "Comma-separated list of content fields for KNOWLEDGE libraries (optional, mutable after creation).",
|
|
535
|
+
"hasDynamicHelp": false,
|
|
536
|
+
"multiple": false,
|
|
537
|
+
"type": "option"
|
|
538
|
+
},
|
|
539
|
+
"data-category-ids": {
|
|
540
|
+
"name": "data-category-ids",
|
|
541
|
+
"summary": "Comma-separated list of data category selection IDs for KNOWLEDGE libraries. Mutually exclusive with --data-category-names (provide one or the other, not both).",
|
|
542
|
+
"hasDynamicHelp": false,
|
|
543
|
+
"multiple": false,
|
|
544
|
+
"type": "option"
|
|
545
|
+
},
|
|
546
|
+
"data-category-names": {
|
|
547
|
+
"name": "data-category-names",
|
|
548
|
+
"summary": "Comma-separated list of data category names in qualified format (e.g., \"Group_API_Name.Category\"). Mutually exclusive with --data-category-ids (provide one or the other, not both).",
|
|
549
|
+
"hasDynamicHelp": false,
|
|
550
|
+
"multiple": false,
|
|
551
|
+
"type": "option"
|
|
552
|
+
},
|
|
553
|
+
"wait": {
|
|
554
|
+
"char": "w",
|
|
555
|
+
"name": "wait",
|
|
556
|
+
"summary": "Wait N minutes for indexing to complete (KNOWLEDGE libraries). SFDRIVE libraries require upload before indexing; RETRIEVER libraries are ready immediately.",
|
|
557
|
+
"hasDynamicHelp": true,
|
|
558
|
+
"multiple": false,
|
|
559
|
+
"type": "option"
|
|
531
560
|
}
|
|
532
561
|
},
|
|
533
562
|
"hasDynamicHelp": true,
|
|
@@ -536,7 +565,6 @@
|
|
|
536
565
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
537
566
|
"pluginName": "@salesforce/plugin-agent",
|
|
538
567
|
"pluginType": "core",
|
|
539
|
-
"state": "preview",
|
|
540
568
|
"strict": true,
|
|
541
569
|
"summary": "Create an Agentforce Data Library.",
|
|
542
570
|
"enableJsonFlag": true,
|
|
@@ -614,7 +642,6 @@
|
|
|
614
642
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
615
643
|
"pluginName": "@salesforce/plugin-agent",
|
|
616
644
|
"pluginType": "core",
|
|
617
|
-
"state": "preview",
|
|
618
645
|
"strict": true,
|
|
619
646
|
"summary": "Delete an Agentforce Data Library.",
|
|
620
647
|
"enableJsonFlag": true,
|
|
@@ -692,7 +719,6 @@
|
|
|
692
719
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
693
720
|
"pluginName": "@salesforce/plugin-agent",
|
|
694
721
|
"pluginType": "core",
|
|
695
|
-
"state": "preview",
|
|
696
722
|
"strict": true,
|
|
697
723
|
"summary": "Get details of an Agentforce Data Library.",
|
|
698
724
|
"enableJsonFlag": true,
|
|
@@ -774,7 +800,6 @@
|
|
|
774
800
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
775
801
|
"pluginName": "@salesforce/plugin-agent",
|
|
776
802
|
"pluginType": "core",
|
|
777
|
-
"state": "preview",
|
|
778
803
|
"strict": true,
|
|
779
804
|
"summary": "List Agentforce Data Libraries in an org.",
|
|
780
805
|
"enableJsonFlag": true,
|
|
@@ -799,7 +824,7 @@
|
|
|
799
824
|
"agent:adl:status": {
|
|
800
825
|
"aliases": [],
|
|
801
826
|
"args": {},
|
|
802
|
-
"description": "Returns the current indexing status including stage details (DATA_LAKE_OBJECT, SEARCH_INDEX, RETRIEVER) and any errors.",
|
|
827
|
+
"description": "Returns the current indexing status including stage details (DATA_STREAM, DATA_LAKE_OBJECT, DATA_MODEL_OBJECT, SEARCH_INDEX, RETRIEVER) and any errors.",
|
|
803
828
|
"examples": [
|
|
804
829
|
"Get status of a data library:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --target-org myOrg"
|
|
805
830
|
],
|
|
@@ -844,6 +869,12 @@
|
|
|
844
869
|
"hasDynamicHelp": false,
|
|
845
870
|
"multiple": false,
|
|
846
871
|
"type": "option"
|
|
872
|
+
},
|
|
873
|
+
"include-artifacts": {
|
|
874
|
+
"name": "include-artifacts",
|
|
875
|
+
"summary": "Resolve DC asset artifacts (DataStream, DLO, DMO, SearchIndex, Retriever) with entity IDs and names on each stage. Slower — requires additional queries.",
|
|
876
|
+
"allowNo": false,
|
|
877
|
+
"type": "boolean"
|
|
847
878
|
}
|
|
848
879
|
},
|
|
849
880
|
"hasDynamicHelp": true,
|
|
@@ -852,7 +883,6 @@
|
|
|
852
883
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
853
884
|
"pluginName": "@salesforce/plugin-agent",
|
|
854
885
|
"pluginType": "core",
|
|
855
|
-
"state": "preview",
|
|
856
886
|
"strict": true,
|
|
857
887
|
"summary": "Get indexing status of an Agentforce Data Library.",
|
|
858
888
|
"enableJsonFlag": true,
|
|
@@ -954,6 +984,12 @@
|
|
|
954
984
|
"allowNo": true,
|
|
955
985
|
"type": "boolean"
|
|
956
986
|
},
|
|
987
|
+
"data-category-rule": {
|
|
988
|
+
"name": "data-category-rule",
|
|
989
|
+
"summary": "Enable or disable data category filtering for KNOWLEDGE libraries. Use --no-data-category-rule to disable.",
|
|
990
|
+
"allowNo": true,
|
|
991
|
+
"type": "boolean"
|
|
992
|
+
},
|
|
957
993
|
"retriever-id": {
|
|
958
994
|
"name": "retriever-id",
|
|
959
995
|
"summary": "Swap the retriever for a RETRIEVER library (must be an active Custom Retriever ID).",
|
|
@@ -968,7 +1004,6 @@
|
|
|
968
1004
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
969
1005
|
"pluginName": "@salesforce/plugin-agent",
|
|
970
1006
|
"pluginType": "core",
|
|
971
|
-
"state": "preview",
|
|
972
1007
|
"strict": true,
|
|
973
1008
|
"summary": "Update an Agentforce Data Library.",
|
|
974
1009
|
"enableJsonFlag": true,
|
|
@@ -993,7 +1028,7 @@
|
|
|
993
1028
|
"agent:adl:upload": {
|
|
994
1029
|
"aliases": [],
|
|
995
1030
|
"args": {},
|
|
996
|
-
"description": "Performs the multi-step upload workflow: checks upload readiness, obtains a pre-signed S3 URL, uploads the file, triggers indexing, and optionally polls until the library is ready (retrieverId is populated).\n\nThis command only works with SFDRIVE libraries. KNOWLEDGE libraries index automatically after creation, and RETRIEVER libraries require no file upload.",
|
|
1031
|
+
"description": "Performs the multi-step upload workflow: checks upload readiness, obtains a pre-signed S3 URL, uploads the file, triggers indexing, and optionally polls until the library is ready (retrieverId is populated).\n\nUpload triggers the full Data Cloud provisioning pipeline, creating all downstream assets (DLO, DMO, SearchIndex, Retriever). Use `sf agent adl status` to monitor progress. For adding files to an already-provisioned library, use `sf agent adl file add` instead.\n\nThis command only works with SFDRIVE libraries. KNOWLEDGE libraries index automatically after creation, and RETRIEVER libraries require no file upload.",
|
|
997
1032
|
"examples": [
|
|
998
1033
|
"Upload a file and wait for indexing to complete:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg --wait 10",
|
|
999
1034
|
"Upload a file without waiting:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg"
|
|
@@ -1064,7 +1099,6 @@
|
|
|
1064
1099
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1065
1100
|
"pluginName": "@salesforce/plugin-agent",
|
|
1066
1101
|
"pluginType": "core",
|
|
1067
|
-
"state": "preview",
|
|
1068
1102
|
"strict": true,
|
|
1069
1103
|
"summary": "Upload a file to an SFDRIVE Agentforce Data Library.",
|
|
1070
1104
|
"enableJsonFlag": true,
|
|
@@ -1086,13 +1120,16 @@
|
|
|
1086
1120
|
"upload:adl:agent"
|
|
1087
1121
|
]
|
|
1088
1122
|
},
|
|
1089
|
-
"agent:
|
|
1123
|
+
"agent:generate:agent-spec": {
|
|
1090
1124
|
"aliases": [],
|
|
1091
1125
|
"args": {},
|
|
1092
|
-
"description": "
|
|
1126
|
+
"description": "An agent spec is a YAML-formatted file that contains basic information about the agent, such as its role, company description, and an AI-generated list of topics based on this information. Topics define the range of jobs your agent can handle.\n\nUse flags, such as --role and --company-description, to provide details about your company and the role that the agent plays in your company. If you prefer, you can also be prompted for the basic information; use --full-interview to be prompted for all required and optional properties. Upon command execution, the large language model (LLM) associated with your org uses the provided information to generate a list of topics for the agent. Because the LLM uses the company and role information to generate the topics, we recommend that you provide accurate, complete, and specific details so the LLM generates the best and most relevant topics. Once generated, you can edit the spec file; for example, you can remove topics that don't apply or change a topic's description.\n\nYou can also iterate the spec generation process by using the --spec flag to pass an existing agent spec file to this command, and then using the --role, --company-description, etc, flags to refine your agent properties. Iteratively improving the description of your agent allows the LLM to generate progressively better topics.\n\nYou can also specify other agent properties, such as a custom prompt template, how to ground the prompt template to add context to the agent's prompts, the tone of the prompts, and the username of a user in the org to assign to the agent.\n\nWhen your agent spec is ready, generate an authoring bundle from it by passing the spec file to the --spec flag of the \"agent generate authoring-bundle\" CLI command. An authoring bundle is a metadata type that contains an Agent Script file, which is the blueprint for an agent. (While not recommended, you can also use the agent spec file to immediately create an agent with the \"agent create\" command. We don't recommend this workflow because these types of agents don't use Agent Script, and are thus less flexible and more difficult to maintain.)",
|
|
1093
1127
|
"examples": [
|
|
1094
|
-
"
|
|
1095
|
-
"
|
|
1128
|
+
"Generate an agent spec in the default location and use flags to specify the agent properties, such as its role and your company details; use your default org:\n<%= config.bin %> <%= command.id %> --type customer --role \"Field customer complaints and manage employee schedules.\" --company-name \"Coral Cloud Resorts\" --company-description \"Provide customers with exceptional destination activities, unforgettable experiences, and reservation services.\"",
|
|
1129
|
+
"Generate an agent spec by being prompted for the required agent properties and generate a maxiumum of 5 topics; write the generated file to the \"specs/resortManagerSpec.yaml\" file and use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --max-topics 5 --output-file specs/resortManagerAgent.yaml --target-org my-org",
|
|
1130
|
+
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
1131
|
+
"Specify an existing agent spec file called \"specs/resortManagerAgent.yaml\", and then overwrite it with a new version that contains newly AI-generated topics based on the updated role information passed in with the --role flag:\n<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role \"Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly\"",
|
|
1132
|
+
"Specify that the conversational tone of the agent is formal and to attach the \"resortmanager@myorg.com\" username to it; be prompted for the required properties and use your default org:\n<%= config.bin %> <%= command.id %> --tone formal --agent-user resortmanager@myorg.com"
|
|
1096
1133
|
],
|
|
1097
1134
|
"flags": {
|
|
1098
1135
|
"json": {
|
|
@@ -1127,113 +1164,164 @@
|
|
|
1127
1164
|
"multiple": false,
|
|
1128
1165
|
"type": "option"
|
|
1129
1166
|
},
|
|
1130
|
-
"
|
|
1131
|
-
"
|
|
1132
|
-
"
|
|
1133
|
-
"required": true,
|
|
1134
|
-
"summary": "Unique name of the MCP server.",
|
|
1167
|
+
"type": {
|
|
1168
|
+
"name": "type",
|
|
1169
|
+
"summary": "Type of agent to create. Internal types are copilots used internally by your company and customer types are the agents you create for your customers.",
|
|
1135
1170
|
"hasDynamicHelp": false,
|
|
1136
1171
|
"multiple": false,
|
|
1172
|
+
"options": [
|
|
1173
|
+
"customer",
|
|
1174
|
+
"internal"
|
|
1175
|
+
],
|
|
1137
1176
|
"type": "option"
|
|
1138
1177
|
},
|
|
1139
|
-
"
|
|
1140
|
-
"name": "
|
|
1141
|
-
"summary": "
|
|
1178
|
+
"role": {
|
|
1179
|
+
"name": "role",
|
|
1180
|
+
"summary": "Role of the agent.",
|
|
1142
1181
|
"hasDynamicHelp": false,
|
|
1143
1182
|
"multiple": false,
|
|
1144
1183
|
"type": "option"
|
|
1145
1184
|
},
|
|
1146
|
-
"
|
|
1147
|
-
"name": "
|
|
1148
|
-
"summary": "
|
|
1185
|
+
"company-name": {
|
|
1186
|
+
"name": "company-name",
|
|
1187
|
+
"summary": "Name of your company.",
|
|
1149
1188
|
"hasDynamicHelp": false,
|
|
1150
1189
|
"multiple": false,
|
|
1151
1190
|
"type": "option"
|
|
1152
1191
|
},
|
|
1153
|
-
"
|
|
1154
|
-
"name": "
|
|
1155
|
-
"
|
|
1156
|
-
"summary": "URL of the external MCP server.",
|
|
1192
|
+
"company-description": {
|
|
1193
|
+
"name": "company-description",
|
|
1194
|
+
"summary": "Description of your company.",
|
|
1157
1195
|
"hasDynamicHelp": false,
|
|
1158
1196
|
"multiple": false,
|
|
1159
1197
|
"type": "option"
|
|
1160
1198
|
},
|
|
1161
|
-
"
|
|
1162
|
-
"name": "
|
|
1163
|
-
"summary": "
|
|
1164
|
-
"
|
|
1199
|
+
"company-website": {
|
|
1200
|
+
"name": "company-website",
|
|
1201
|
+
"summary": "Website URL of your company.",
|
|
1202
|
+
"hasDynamicHelp": false,
|
|
1203
|
+
"multiple": false,
|
|
1204
|
+
"type": "option"
|
|
1205
|
+
},
|
|
1206
|
+
"max-topics": {
|
|
1207
|
+
"name": "max-topics",
|
|
1208
|
+
"summary": "Maximum number of topics to generate in the agent spec; default is 5.",
|
|
1209
|
+
"hasDynamicHelp": false,
|
|
1210
|
+
"multiple": false,
|
|
1211
|
+
"type": "option"
|
|
1212
|
+
},
|
|
1213
|
+
"agent-user": {
|
|
1214
|
+
"name": "agent-user",
|
|
1215
|
+
"summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
|
|
1216
|
+
"hasDynamicHelp": false,
|
|
1217
|
+
"multiple": false,
|
|
1218
|
+
"type": "option"
|
|
1219
|
+
},
|
|
1220
|
+
"enrich-logs": {
|
|
1221
|
+
"name": "enrich-logs",
|
|
1222
|
+
"summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
|
|
1165
1223
|
"hasDynamicHelp": false,
|
|
1166
1224
|
"multiple": false,
|
|
1167
1225
|
"options": [
|
|
1168
|
-
"
|
|
1169
|
-
"
|
|
1226
|
+
"true",
|
|
1227
|
+
"false"
|
|
1170
1228
|
],
|
|
1171
1229
|
"type": "option"
|
|
1172
1230
|
},
|
|
1173
|
-
"
|
|
1174
|
-
"name": "
|
|
1175
|
-
"summary": "
|
|
1231
|
+
"tone": {
|
|
1232
|
+
"name": "tone",
|
|
1233
|
+
"summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
|
|
1176
1234
|
"hasDynamicHelp": false,
|
|
1177
1235
|
"multiple": false,
|
|
1236
|
+
"options": [
|
|
1237
|
+
"formal",
|
|
1238
|
+
"casual",
|
|
1239
|
+
"neutral"
|
|
1240
|
+
],
|
|
1178
1241
|
"type": "option"
|
|
1179
1242
|
},
|
|
1180
|
-
"
|
|
1181
|
-
"name": "
|
|
1182
|
-
"summary": "
|
|
1243
|
+
"spec": {
|
|
1244
|
+
"name": "spec",
|
|
1245
|
+
"summary": "Agent spec file, in YAML format, to use as input to the command.",
|
|
1183
1246
|
"hasDynamicHelp": false,
|
|
1184
1247
|
"multiple": false,
|
|
1185
1248
|
"type": "option"
|
|
1186
1249
|
},
|
|
1187
|
-
"
|
|
1188
|
-
"name": "
|
|
1189
|
-
"summary": "
|
|
1250
|
+
"output-file": {
|
|
1251
|
+
"name": "output-file",
|
|
1252
|
+
"summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
|
|
1253
|
+
"default": "specs/agentSpec.yaml",
|
|
1190
1254
|
"hasDynamicHelp": false,
|
|
1191
1255
|
"multiple": false,
|
|
1192
1256
|
"type": "option"
|
|
1193
1257
|
},
|
|
1194
|
-
"
|
|
1195
|
-
"name": "
|
|
1196
|
-
"summary": "
|
|
1258
|
+
"full-interview": {
|
|
1259
|
+
"name": "full-interview",
|
|
1260
|
+
"summary": "Prompt for both required and optional flags.",
|
|
1261
|
+
"allowNo": false,
|
|
1262
|
+
"type": "boolean"
|
|
1263
|
+
},
|
|
1264
|
+
"prompt-template": {
|
|
1265
|
+
"name": "prompt-template",
|
|
1266
|
+
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
1197
1267
|
"hasDynamicHelp": false,
|
|
1198
1268
|
"multiple": false,
|
|
1199
1269
|
"type": "option"
|
|
1270
|
+
},
|
|
1271
|
+
"grounding-context": {
|
|
1272
|
+
"dependsOn": [
|
|
1273
|
+
"prompt-template"
|
|
1274
|
+
],
|
|
1275
|
+
"name": "grounding-context",
|
|
1276
|
+
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
1277
|
+
"hasDynamicHelp": false,
|
|
1278
|
+
"multiple": false,
|
|
1279
|
+
"type": "option"
|
|
1280
|
+
},
|
|
1281
|
+
"force-overwrite": {
|
|
1282
|
+
"name": "force-overwrite",
|
|
1283
|
+
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
1284
|
+
"allowNo": false,
|
|
1285
|
+
"type": "boolean"
|
|
1200
1286
|
}
|
|
1201
1287
|
},
|
|
1202
1288
|
"hasDynamicHelp": true,
|
|
1203
1289
|
"hiddenAliases": [],
|
|
1204
|
-
"id": "agent:
|
|
1290
|
+
"id": "agent:generate:agent-spec",
|
|
1205
1291
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1206
1292
|
"pluginName": "@salesforce/plugin-agent",
|
|
1207
1293
|
"pluginType": "core",
|
|
1208
|
-
"state": "preview",
|
|
1209
1294
|
"strict": true,
|
|
1210
|
-
"summary": "
|
|
1295
|
+
"summary": "Generate an agent spec, which is a YAML file that captures what an agent can do.",
|
|
1211
1296
|
"enableJsonFlag": true,
|
|
1297
|
+
"requiresProject": true,
|
|
1212
1298
|
"isESM": true,
|
|
1213
1299
|
"relativePath": [
|
|
1214
1300
|
"lib",
|
|
1215
1301
|
"commands",
|
|
1216
1302
|
"agent",
|
|
1217
|
-
"
|
|
1218
|
-
"
|
|
1303
|
+
"generate",
|
|
1304
|
+
"agent-spec.js"
|
|
1219
1305
|
],
|
|
1220
1306
|
"aliasPermutations": [],
|
|
1221
1307
|
"permutations": [
|
|
1222
|
-
"agent:
|
|
1223
|
-
"
|
|
1224
|
-
"
|
|
1225
|
-
"agent:
|
|
1226
|
-
"
|
|
1227
|
-
"
|
|
1308
|
+
"agent:generate:agent-spec",
|
|
1309
|
+
"generate:agent:agent-spec",
|
|
1310
|
+
"generate:agent-spec:agent",
|
|
1311
|
+
"agent:agent-spec:generate",
|
|
1312
|
+
"agent-spec:agent:generate",
|
|
1313
|
+
"agent-spec:generate:agent"
|
|
1228
1314
|
]
|
|
1229
1315
|
},
|
|
1230
|
-
"agent:
|
|
1316
|
+
"agent:generate:authoring-bundle": {
|
|
1231
1317
|
"aliases": [],
|
|
1232
1318
|
"args": {},
|
|
1233
|
-
"description": "
|
|
1319
|
+
"description": "Authoring bundles are metadata components that contain an agent's Agent Script file. The Agent Script file is the agent's blueprint; it fully describes what the agent can do using the Agent Script language.\n\nUse this command to generate a new authoring bundle based on an agent spec YAML file, which you create with the \"agent generate agent-spec\" command. The agent spec YAML file is a high-level description of the agent; it describes its essence rather than exactly what it can do. The resulting Agent Script file is customized to reflect what's in the agent spec file. You can also create an authoring bundle without an agent spec file by specifying the \"--no-spec\" flag; in this case, the resulting Agent Script file is just the default boilerplate.\n\nThe metadata type for authoring bundles is aiAuthoringBundle, which consist of a standard \"<bundle-api-name>.bundle-meta.xml\" metadata file and the Agent Script file (with extension \".agent\"). When you run this command, the new authoring bundle is generated in the force-app/main/default/aiAuthoringBundles/<bundle-api-name> directory. Use the --output-dir flag to generate them elsewhere.\n\nAfter you generate the initial authoring bundle, code the Agent Script file so your agent behaves exactly as you want. The Agent Script file generated by this command is just a first draft of your agent! Interactively test the agent by conversing with it using the \"agent preview\" command. Then publish the agent to your org with the \"agent publish authoring-bundle\" command.\n\nThis command requires an org because it uses it to access an LLM for generating the Agent Script file.",
|
|
1234
1320
|
"examples": [
|
|
1235
|
-
"
|
|
1236
|
-
"
|
|
1321
|
+
"Generate an authoring bundle by being prompted for all required values, such as the agent spec YAML file, the bundle name, and the API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1322
|
+
"Generate an authoring bundle without using an agent spec file; give the bundle the label \"My Authoring Bundle\" and use your default org:\n<%= config.bin %> <%= command.id %> --no-spec --name \"My Authoring Bundle\"",
|
|
1323
|
+
"Generate an authoring bundle from the \"specs/agentSpec.yaml\" agent spec YAML file and give it the label \"My Authoring Bundle\"; use your default org:\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\"",
|
|
1324
|
+
"Similar to previous example, but generate the authoring bundle files in the \"other-package-dir/main/default\" package directory; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\" --output-dir other-package-dir/main/default --target-org my-dev-org"
|
|
1237
1325
|
],
|
|
1238
1326
|
"flags": {
|
|
1239
1327
|
"json": {
|
|
@@ -1261,6 +1349,13 @@
|
|
|
1261
1349
|
"multiple": false,
|
|
1262
1350
|
"type": "option"
|
|
1263
1351
|
},
|
|
1352
|
+
"api-name": {
|
|
1353
|
+
"name": "api-name",
|
|
1354
|
+
"summary": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name can't exist in the org.",
|
|
1355
|
+
"hasDynamicHelp": false,
|
|
1356
|
+
"multiple": false,
|
|
1357
|
+
"type": "option"
|
|
1358
|
+
},
|
|
1264
1359
|
"api-version": {
|
|
1265
1360
|
"description": "Override the api version used for api requests made by this command",
|
|
1266
1361
|
"name": "api-version",
|
|
@@ -1268,57 +1363,77 @@
|
|
|
1268
1363
|
"multiple": false,
|
|
1269
1364
|
"type": "option"
|
|
1270
1365
|
},
|
|
1271
|
-
"
|
|
1272
|
-
"char": "
|
|
1273
|
-
"name": "
|
|
1274
|
-
"
|
|
1275
|
-
"summary": "ID of the MCP server to delete.",
|
|
1366
|
+
"spec": {
|
|
1367
|
+
"char": "f",
|
|
1368
|
+
"name": "spec",
|
|
1369
|
+
"summary": "Path to the agent spec YAML file. If you don't specify the flag, the command provides a list that you can choose from. Use the --no-spec flag to skip using an agent spec entirely.",
|
|
1276
1370
|
"hasDynamicHelp": false,
|
|
1277
1371
|
"multiple": false,
|
|
1278
1372
|
"type": "option"
|
|
1279
1373
|
},
|
|
1280
|
-
"no-
|
|
1281
|
-
"name": "no-
|
|
1282
|
-
"summary": "Skip
|
|
1374
|
+
"no-spec": {
|
|
1375
|
+
"name": "no-spec",
|
|
1376
|
+
"summary": "Skip prompting for an agent spec and use the default Agent Script boilerplate in the generated authoring bundle.",
|
|
1377
|
+
"allowNo": false,
|
|
1378
|
+
"type": "boolean"
|
|
1379
|
+
},
|
|
1380
|
+
"output-dir": {
|
|
1381
|
+
"char": "d",
|
|
1382
|
+
"name": "output-dir",
|
|
1383
|
+
"summary": "Directory where the authoring bundle files are generated.",
|
|
1384
|
+
"hasDynamicHelp": false,
|
|
1385
|
+
"multiple": false,
|
|
1386
|
+
"type": "option"
|
|
1387
|
+
},
|
|
1388
|
+
"name": {
|
|
1389
|
+
"char": "n",
|
|
1390
|
+
"name": "name",
|
|
1391
|
+
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
1392
|
+
"hasDynamicHelp": false,
|
|
1393
|
+
"multiple": false,
|
|
1394
|
+
"type": "option"
|
|
1395
|
+
},
|
|
1396
|
+
"force-overwrite": {
|
|
1397
|
+
"name": "force-overwrite",
|
|
1398
|
+
"summary": "Overwrite the existing authoring bundle if one with the same API name already exists locally.",
|
|
1283
1399
|
"allowNo": false,
|
|
1284
1400
|
"type": "boolean"
|
|
1285
1401
|
}
|
|
1286
1402
|
},
|
|
1287
1403
|
"hasDynamicHelp": true,
|
|
1288
1404
|
"hiddenAliases": [],
|
|
1289
|
-
"id": "agent:
|
|
1405
|
+
"id": "agent:generate:authoring-bundle",
|
|
1290
1406
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1291
1407
|
"pluginName": "@salesforce/plugin-agent",
|
|
1292
1408
|
"pluginType": "core",
|
|
1293
|
-
"state": "preview",
|
|
1294
1409
|
"strict": true,
|
|
1295
|
-
"summary": "
|
|
1410
|
+
"summary": "Generate an authoring bundle from an existing agent spec YAML file.",
|
|
1296
1411
|
"enableJsonFlag": true,
|
|
1412
|
+
"requiresProject": true,
|
|
1297
1413
|
"isESM": true,
|
|
1298
1414
|
"relativePath": [
|
|
1299
1415
|
"lib",
|
|
1300
1416
|
"commands",
|
|
1301
1417
|
"agent",
|
|
1302
|
-
"
|
|
1303
|
-
"
|
|
1418
|
+
"generate",
|
|
1419
|
+
"authoring-bundle.js"
|
|
1304
1420
|
],
|
|
1305
1421
|
"aliasPermutations": [],
|
|
1306
1422
|
"permutations": [
|
|
1307
|
-
"agent:
|
|
1308
|
-
"
|
|
1309
|
-
"
|
|
1310
|
-
"agent:
|
|
1311
|
-
"
|
|
1312
|
-
"
|
|
1313
|
-
]
|
|
1314
|
-
},
|
|
1315
|
-
"agent:
|
|
1316
|
-
"aliases": [],
|
|
1423
|
+
"agent:generate:authoring-bundle",
|
|
1424
|
+
"generate:agent:authoring-bundle",
|
|
1425
|
+
"generate:authoring-bundle:agent",
|
|
1426
|
+
"agent:authoring-bundle:generate",
|
|
1427
|
+
"authoring-bundle:agent:generate",
|
|
1428
|
+
"authoring-bundle:generate:agent"
|
|
1429
|
+
]
|
|
1430
|
+
},
|
|
1431
|
+
"agent:generate:template": {
|
|
1432
|
+
"aliases": [],
|
|
1317
1433
|
"args": {},
|
|
1318
|
-
"description": "
|
|
1434
|
+
"description": "WARNING: This command doesn't work for agents that were created from an Agent Script file. In other words, you can't currently package an agent template for agents that use Agent Script.\n\nAt a high-level, agents are defined by the Bot, BotVersion, and GenAiPlannerBundle metadata types. The GenAiPlannerBundle type in turn defines the agent's topics and actions. This command uses the metadata files for these three types, located in your local DX project, to generate a BotTemplate metadata file for a specific agent (Bot). You then use the BotTemplate metadata file, along with the GenAiPlannerBundle metadata file that references the BotTemplate, to package the template in a managed package that you can share between orgs or on AppExchange.\n\nUse the --agent-file flag to specify the relative or full pathname of the Bot metadata file, such as force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml. A single Bot can have multiple BotVersions, so use the --agent-version flag to specify the version. The corresponding BotVersion metadata file must exist locally. For example, if you specify \"--agent-version 4\", then the file force-app/main/default/bots/My_Awesome_Agent/v4.botVersion-meta.xml must exist.\n\nThe new BotTemplate metadata file is generated in the \"botTemplates\" directory in the output directory specified with the --output-dir flag, and has the name <Agent_API_name>\\_v<Version>\\_Template.botTemplate-meta.xml, such as my-package/botTemplates/My_Awesome_Agent_v4_Template.botTemplate-meta.xml. The command displays the full pathname of the generated files when it completes.\n\nSee \"Develop and Package Agent Templates Using Scratch Orgs\" (https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/dev2gp_package_agent_templates.htm) for details about the complete process, which includes using a scratch org to create and test the agent, retrieving the agent metadata to your DX project, running this command to create the agent template, and then packaging the template.",
|
|
1319
1435
|
"examples": [
|
|
1320
|
-
"
|
|
1321
|
-
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
1436
|
+
"Generate an agent template from the My_Awesome_Agent Bot metadata file in your DX project and save the BotTemplate and GenAiPlannerBundle to the specified directory; use version 1 of the agent. The agent that the template is based on is in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --agent-file force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1 --output-dir my-package --source-org my-scratch-org"
|
|
1322
1437
|
],
|
|
1323
1438
|
"flags": {
|
|
1324
1439
|
"json": {
|
|
@@ -1336,16 +1451,6 @@
|
|
|
1336
1451
|
"multiple": false,
|
|
1337
1452
|
"type": "option"
|
|
1338
1453
|
},
|
|
1339
|
-
"target-org": {
|
|
1340
|
-
"char": "o",
|
|
1341
|
-
"name": "target-org",
|
|
1342
|
-
"noCacheDefault": true,
|
|
1343
|
-
"required": true,
|
|
1344
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1345
|
-
"hasDynamicHelp": true,
|
|
1346
|
-
"multiple": false,
|
|
1347
|
-
"type": "option"
|
|
1348
|
-
},
|
|
1349
1454
|
"api-version": {
|
|
1350
1455
|
"description": "Override the api version used for api requests made by this command",
|
|
1351
1456
|
"name": "api-version",
|
|
@@ -1353,90 +1458,37 @@
|
|
|
1353
1458
|
"multiple": false,
|
|
1354
1459
|
"type": "option"
|
|
1355
1460
|
},
|
|
1356
|
-
"
|
|
1357
|
-
"char": "
|
|
1358
|
-
"name": "
|
|
1461
|
+
"source-org": {
|
|
1462
|
+
"char": "s",
|
|
1463
|
+
"name": "source-org",
|
|
1464
|
+
"noCacheDefault": true,
|
|
1359
1465
|
"required": true,
|
|
1360
|
-
"summary": "
|
|
1361
|
-
"hasDynamicHelp":
|
|
1466
|
+
"summary": "Username or alias of the namespaced scratch org that contains the agent which this template is based on.",
|
|
1467
|
+
"hasDynamicHelp": true,
|
|
1362
1468
|
"multiple": false,
|
|
1363
1469
|
"type": "option"
|
|
1364
|
-
}
|
|
1365
|
-
},
|
|
1366
|
-
"hasDynamicHelp": true,
|
|
1367
|
-
"hiddenAliases": [],
|
|
1368
|
-
"id": "agent:mcp:fetch",
|
|
1369
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
1370
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1371
|
-
"pluginType": "core",
|
|
1372
|
-
"state": "preview",
|
|
1373
|
-
"strict": true,
|
|
1374
|
-
"summary": "Fetch the live assets (tools, prompts, resources) advertised by an MCP server.",
|
|
1375
|
-
"enableJsonFlag": true,
|
|
1376
|
-
"isESM": true,
|
|
1377
|
-
"relativePath": [
|
|
1378
|
-
"lib",
|
|
1379
|
-
"commands",
|
|
1380
|
-
"agent",
|
|
1381
|
-
"mcp",
|
|
1382
|
-
"fetch.js"
|
|
1383
|
-
],
|
|
1384
|
-
"aliasPermutations": [],
|
|
1385
|
-
"permutations": [
|
|
1386
|
-
"agent:mcp:fetch",
|
|
1387
|
-
"mcp:agent:fetch",
|
|
1388
|
-
"mcp:fetch:agent",
|
|
1389
|
-
"agent:fetch:mcp",
|
|
1390
|
-
"fetch:agent:mcp",
|
|
1391
|
-
"fetch:mcp:agent"
|
|
1392
|
-
]
|
|
1393
|
-
},
|
|
1394
|
-
"agent:mcp:get": {
|
|
1395
|
-
"aliases": [],
|
|
1396
|
-
"args": {},
|
|
1397
|
-
"description": "Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.",
|
|
1398
|
-
"examples": [
|
|
1399
|
-
"Get an MCP server by id in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001",
|
|
1400
|
-
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
1401
|
-
],
|
|
1402
|
-
"flags": {
|
|
1403
|
-
"json": {
|
|
1404
|
-
"description": "Format output as json.",
|
|
1405
|
-
"helpGroup": "GLOBAL",
|
|
1406
|
-
"name": "json",
|
|
1407
|
-
"allowNo": false,
|
|
1408
|
-
"type": "boolean"
|
|
1409
1470
|
},
|
|
1410
|
-
"
|
|
1411
|
-
"
|
|
1412
|
-
"
|
|
1413
|
-
"summary": "
|
|
1471
|
+
"agent-version": {
|
|
1472
|
+
"name": "agent-version",
|
|
1473
|
+
"required": true,
|
|
1474
|
+
"summary": "Version of the agent (BotVersion).",
|
|
1414
1475
|
"hasDynamicHelp": false,
|
|
1415
1476
|
"multiple": false,
|
|
1416
1477
|
"type": "option"
|
|
1417
1478
|
},
|
|
1418
|
-
"
|
|
1419
|
-
"char": "
|
|
1420
|
-
"name": "
|
|
1421
|
-
"noCacheDefault": true,
|
|
1479
|
+
"agent-file": {
|
|
1480
|
+
"char": "f",
|
|
1481
|
+
"name": "agent-file",
|
|
1422
1482
|
"required": true,
|
|
1423
|
-
"summary": "
|
|
1424
|
-
"hasDynamicHelp": true,
|
|
1425
|
-
"multiple": false,
|
|
1426
|
-
"type": "option"
|
|
1427
|
-
},
|
|
1428
|
-
"api-version": {
|
|
1429
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1430
|
-
"name": "api-version",
|
|
1483
|
+
"summary": "Path to an agent (Bot) metadata file.",
|
|
1431
1484
|
"hasDynamicHelp": false,
|
|
1432
1485
|
"multiple": false,
|
|
1433
1486
|
"type": "option"
|
|
1434
1487
|
},
|
|
1435
|
-
"
|
|
1436
|
-
"char": "
|
|
1437
|
-
"name": "
|
|
1438
|
-
"
|
|
1439
|
-
"summary": "The identifier of the MCP server to retrieve.",
|
|
1488
|
+
"output-dir": {
|
|
1489
|
+
"char": "r",
|
|
1490
|
+
"name": "output-dir",
|
|
1491
|
+
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
1440
1492
|
"hasDynamicHelp": false,
|
|
1441
1493
|
"multiple": false,
|
|
1442
1494
|
"type": "option"
|
|
@@ -1444,48 +1496,44 @@
|
|
|
1444
1496
|
},
|
|
1445
1497
|
"hasDynamicHelp": true,
|
|
1446
1498
|
"hiddenAliases": [],
|
|
1447
|
-
"id": "agent:
|
|
1499
|
+
"id": "agent:generate:template",
|
|
1448
1500
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1449
1501
|
"pluginName": "@salesforce/plugin-agent",
|
|
1450
1502
|
"pluginType": "core",
|
|
1451
|
-
"state": "preview",
|
|
1452
1503
|
"strict": true,
|
|
1453
|
-
"summary": "
|
|
1504
|
+
"summary": "Generate an agent template from an existing agent in your DX project so you can then package the template in a second-generation managed package.",
|
|
1454
1505
|
"enableJsonFlag": true,
|
|
1506
|
+
"requiresProject": true,
|
|
1455
1507
|
"isESM": true,
|
|
1456
1508
|
"relativePath": [
|
|
1457
1509
|
"lib",
|
|
1458
1510
|
"commands",
|
|
1459
1511
|
"agent",
|
|
1460
|
-
"
|
|
1461
|
-
"
|
|
1512
|
+
"generate",
|
|
1513
|
+
"template.js"
|
|
1462
1514
|
],
|
|
1463
1515
|
"aliasPermutations": [],
|
|
1464
1516
|
"permutations": [
|
|
1465
|
-
"agent:
|
|
1466
|
-
"
|
|
1467
|
-
"
|
|
1468
|
-
"agent:
|
|
1469
|
-
"
|
|
1470
|
-
"
|
|
1517
|
+
"agent:generate:template",
|
|
1518
|
+
"generate:agent:template",
|
|
1519
|
+
"generate:template:agent",
|
|
1520
|
+
"agent:template:generate",
|
|
1521
|
+
"template:agent:generate",
|
|
1522
|
+
"template:generate:agent"
|
|
1471
1523
|
]
|
|
1472
1524
|
},
|
|
1473
|
-
"agent:
|
|
1525
|
+
"agent:generate:test-spec": {
|
|
1474
1526
|
"aliases": [],
|
|
1475
1527
|
"args": {},
|
|
1476
|
-
"description": "
|
|
1528
|
+
"description": "The first step when using Salesforce CLI to create an agent test in your org is to use this interactive command to generate a local YAML-formatted test spec file. The test spec YAML file contains information about the agent being tested, such as its API name, and then one or more test cases. This command uses the metadata components in your DX project when prompting for information, such as the agent API name; it doesn't look in your org.\n\nTo generate a specific agent test case, this command prompts you for this information; when possible, the command provides a list of options for you to choose from:\n\n- Utterance: Natural language statement, question, or command used to test the agent.\n- Expected topic: API name of the topic you expect the agent to use when responding to the utterance.\n- Expected actions: One or more API names of the expection actions the agent takes.\n- Expected outcome: Natural language description of the outcome you expect.\n- (Optional) Custom evaluation: Test an agent's response for specific strings or numbers.\n- (Optional) Conversation history: Boilerplate for additional context you can add to the test in the form of a conversation history.\n\nYou can manually add contextVariables to test cases in the generated YAML file to inject contextual data (such as CaseId or RoutableId) into agent sessions. This is useful for testing agent behavior with different contextual information.\n\nWhen your test spec is ready, you then run the \"agent test create\" command to actually create the test in your org and synchronize the metadata with your DX project. The metadata type for an agent test is `AiEvaluationDefinition` (legacy testing-center) or `AiTestingDefinition` (Agentforce Studio / NGT), selected via --test-runner.\n\nIf you have an existing AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project, you can generate its equivalent YAML test spec file with the --from-definition flag. The runner is inferred from the file extension; pass --test-runner to override.",
|
|
1477
1529
|
"examples": [
|
|
1478
|
-
"
|
|
1479
|
-
"
|
|
1530
|
+
"Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
|
|
1531
|
+
"Generate an Agentforce Studio (NGT) test spec YAML file interactively:\n<%= config.bin %> <%= command.id %> --test-runner agentforce-studio",
|
|
1532
|
+
"Generate an agent test spec YAML file and specify a name for the new file; if the file exists, overwrite it without confirmation:\n<%= config.bin %> <%= command.id %> --output-file specs/Resort_Manager-new-version-testSpec.yaml --force-overwrite",
|
|
1533
|
+
"Generate an agent test spec YAML file from an existing AiEvaluationDefinition metadata XML file in your DX project:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml",
|
|
1534
|
+
"Generate an Agentforce Studio (NGT) test spec YAML file from an existing AiTestingDefinition metadata XML file:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiTestingDefinitions/Returns_Checkout_Tests.aiTestingDefinition-meta.xml"
|
|
1480
1535
|
],
|
|
1481
1536
|
"flags": {
|
|
1482
|
-
"json": {
|
|
1483
|
-
"description": "Format output as json.",
|
|
1484
|
-
"helpGroup": "GLOBAL",
|
|
1485
|
-
"name": "json",
|
|
1486
|
-
"allowNo": false,
|
|
1487
|
-
"type": "boolean"
|
|
1488
|
-
},
|
|
1489
1537
|
"flags-dir": {
|
|
1490
1538
|
"helpGroup": "GLOBAL",
|
|
1491
1539
|
"name": "flags-dir",
|
|
@@ -1494,87 +1542,75 @@
|
|
|
1494
1542
|
"multiple": false,
|
|
1495
1543
|
"type": "option"
|
|
1496
1544
|
},
|
|
1497
|
-
"
|
|
1498
|
-
"char": "
|
|
1499
|
-
"name": "
|
|
1500
|
-
"
|
|
1501
|
-
"required": true,
|
|
1502
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1503
|
-
"hasDynamicHelp": true,
|
|
1504
|
-
"multiple": false,
|
|
1505
|
-
"type": "option"
|
|
1506
|
-
},
|
|
1507
|
-
"api-version": {
|
|
1508
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1509
|
-
"name": "api-version",
|
|
1545
|
+
"from-definition": {
|
|
1546
|
+
"char": "d",
|
|
1547
|
+
"name": "from-definition",
|
|
1548
|
+
"summary": "Filepath to an AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project that you want to convert to a test spec YAML file.",
|
|
1510
1549
|
"hasDynamicHelp": false,
|
|
1511
1550
|
"multiple": false,
|
|
1512
1551
|
"type": "option"
|
|
1513
1552
|
},
|
|
1514
|
-
"
|
|
1515
|
-
"name": "
|
|
1516
|
-
"summary": "
|
|
1517
|
-
"
|
|
1518
|
-
"
|
|
1519
|
-
"type": "option"
|
|
1553
|
+
"force-overwrite": {
|
|
1554
|
+
"name": "force-overwrite",
|
|
1555
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test spec YAML file.",
|
|
1556
|
+
"allowNo": false,
|
|
1557
|
+
"type": "boolean"
|
|
1520
1558
|
},
|
|
1521
|
-
"
|
|
1522
|
-
"
|
|
1523
|
-
"
|
|
1559
|
+
"output-file": {
|
|
1560
|
+
"char": "f",
|
|
1561
|
+
"name": "output-file",
|
|
1562
|
+
"summary": "Name of the generated test spec YAML file. Default value is \"specs/<AGENT_API_NAME>-testSpec.yaml\" (legacy) or \"specs/<AGENT_API_NAME>-ngtTestSpec.yaml\" (Agentforce Studio).",
|
|
1524
1563
|
"hasDynamicHelp": false,
|
|
1525
1564
|
"multiple": false,
|
|
1526
|
-
"options": [
|
|
1527
|
-
"EXTERNAL"
|
|
1528
|
-
],
|
|
1529
1565
|
"type": "option"
|
|
1530
1566
|
},
|
|
1531
|
-
"
|
|
1532
|
-
"
|
|
1533
|
-
"
|
|
1567
|
+
"test-runner": {
|
|
1568
|
+
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
1569
|
+
"name": "test-runner",
|
|
1570
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
1534
1571
|
"hasDynamicHelp": false,
|
|
1535
1572
|
"multiple": false,
|
|
1536
1573
|
"options": [
|
|
1537
|
-
"
|
|
1538
|
-
"
|
|
1574
|
+
"agentforce-studio",
|
|
1575
|
+
"testing-center"
|
|
1539
1576
|
],
|
|
1540
1577
|
"type": "option"
|
|
1541
1578
|
}
|
|
1542
1579
|
},
|
|
1543
|
-
"hasDynamicHelp":
|
|
1580
|
+
"hasDynamicHelp": false,
|
|
1544
1581
|
"hiddenAliases": [],
|
|
1545
|
-
"id": "agent:
|
|
1582
|
+
"id": "agent:generate:test-spec",
|
|
1546
1583
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1547
1584
|
"pluginName": "@salesforce/plugin-agent",
|
|
1548
1585
|
"pluginType": "core",
|
|
1549
|
-
"state": "preview",
|
|
1550
1586
|
"strict": true,
|
|
1551
|
-
"summary": "
|
|
1552
|
-
"enableJsonFlag":
|
|
1587
|
+
"summary": "Generate an agent test spec, which is a YAML file that lists the test cases for testing a specific agent.",
|
|
1588
|
+
"enableJsonFlag": false,
|
|
1553
1589
|
"isESM": true,
|
|
1554
1590
|
"relativePath": [
|
|
1555
1591
|
"lib",
|
|
1556
1592
|
"commands",
|
|
1557
1593
|
"agent",
|
|
1558
|
-
"
|
|
1559
|
-
"
|
|
1594
|
+
"generate",
|
|
1595
|
+
"test-spec.js"
|
|
1560
1596
|
],
|
|
1561
1597
|
"aliasPermutations": [],
|
|
1562
1598
|
"permutations": [
|
|
1563
|
-
"agent:
|
|
1564
|
-
"
|
|
1565
|
-
"
|
|
1566
|
-
"agent:
|
|
1567
|
-
"
|
|
1568
|
-
"
|
|
1599
|
+
"agent:generate:test-spec",
|
|
1600
|
+
"generate:agent:test-spec",
|
|
1601
|
+
"generate:test-spec:agent",
|
|
1602
|
+
"agent:test-spec:generate",
|
|
1603
|
+
"test-spec:agent:generate",
|
|
1604
|
+
"test-spec:generate:agent"
|
|
1569
1605
|
]
|
|
1570
1606
|
},
|
|
1571
|
-
"agent:mcp:
|
|
1607
|
+
"agent:mcp:create": {
|
|
1572
1608
|
"aliases": [],
|
|
1573
1609
|
"args": {},
|
|
1574
|
-
"description": "
|
|
1610
|
+
"description": "Registers an external Model Context Protocol (MCP) server with the API Catalog and discovers its assets (tools, prompts, and resources). Provide the server URL and, when the server requires it, OAuth authorization details. When the authorization type is OAUTH you must supply the identity provider, client ID, client secret, and scope.",
|
|
1575
1611
|
"examples": [
|
|
1576
|
-
"
|
|
1577
|
-
"
|
|
1612
|
+
"Create an MCP server with no authentication:\n<%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --target-org myOrg",
|
|
1613
|
+
"Create an MCP server that uses OAuth authentication, piping the client secret from stdin to keep it out of shell history:\ncat secret.txt | <%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --auth-type OAUTH --identity-provider myIdp --client-id abc123 --client-secret - --scope \"read write\" --target-org myOrg"
|
|
1578
1614
|
],
|
|
1579
1615
|
"flags": {
|
|
1580
1616
|
"json": {
|
|
@@ -1609,39 +1645,41 @@
|
|
|
1609
1645
|
"multiple": false,
|
|
1610
1646
|
"type": "option"
|
|
1611
1647
|
},
|
|
1612
|
-
"
|
|
1613
|
-
"char": "
|
|
1614
|
-
"name": "
|
|
1648
|
+
"name": {
|
|
1649
|
+
"char": "n",
|
|
1650
|
+
"name": "name",
|
|
1615
1651
|
"required": true,
|
|
1616
|
-
"summary": "
|
|
1652
|
+
"summary": "Unique name of the MCP server.",
|
|
1617
1653
|
"hasDynamicHelp": false,
|
|
1618
1654
|
"multiple": false,
|
|
1619
1655
|
"type": "option"
|
|
1620
1656
|
},
|
|
1621
1657
|
"label": {
|
|
1622
1658
|
"name": "label",
|
|
1623
|
-
"summary": "
|
|
1659
|
+
"summary": "Human-readable label for the MCP server.",
|
|
1624
1660
|
"hasDynamicHelp": false,
|
|
1625
1661
|
"multiple": false,
|
|
1626
1662
|
"type": "option"
|
|
1627
1663
|
},
|
|
1628
1664
|
"description": {
|
|
1629
1665
|
"name": "description",
|
|
1630
|
-
"summary": "
|
|
1666
|
+
"summary": "Description of the MCP server.",
|
|
1631
1667
|
"hasDynamicHelp": false,
|
|
1632
1668
|
"multiple": false,
|
|
1633
1669
|
"type": "option"
|
|
1634
1670
|
},
|
|
1635
1671
|
"server-url": {
|
|
1636
1672
|
"name": "server-url",
|
|
1637
|
-
"
|
|
1673
|
+
"required": true,
|
|
1674
|
+
"summary": "URL of the external MCP server.",
|
|
1638
1675
|
"hasDynamicHelp": false,
|
|
1639
1676
|
"multiple": false,
|
|
1640
1677
|
"type": "option"
|
|
1641
1678
|
},
|
|
1642
1679
|
"auth-type": {
|
|
1643
1680
|
"name": "auth-type",
|
|
1644
|
-
"summary": "Authorization type to
|
|
1681
|
+
"summary": "Authorization type to use when connecting to the MCP server.",
|
|
1682
|
+
"default": "NO_AUTH",
|
|
1645
1683
|
"hasDynamicHelp": false,
|
|
1646
1684
|
"multiple": false,
|
|
1647
1685
|
"options": [
|
|
@@ -1652,28 +1690,28 @@
|
|
|
1652
1690
|
},
|
|
1653
1691
|
"identity-provider": {
|
|
1654
1692
|
"name": "identity-provider",
|
|
1655
|
-
"summary": "Identity provider
|
|
1693
|
+
"summary": "Identity provider to use for OAuth authorization. Required when auth-type is OAUTH.",
|
|
1656
1694
|
"hasDynamicHelp": false,
|
|
1657
1695
|
"multiple": false,
|
|
1658
1696
|
"type": "option"
|
|
1659
1697
|
},
|
|
1660
1698
|
"client-id": {
|
|
1661
1699
|
"name": "client-id",
|
|
1662
|
-
"summary": "OAuth client ID
|
|
1700
|
+
"summary": "OAuth client ID. Required when auth-type is OAUTH.",
|
|
1663
1701
|
"hasDynamicHelp": false,
|
|
1664
1702
|
"multiple": false,
|
|
1665
1703
|
"type": "option"
|
|
1666
1704
|
},
|
|
1667
1705
|
"client-secret": {
|
|
1668
1706
|
"name": "client-secret",
|
|
1669
|
-
"summary": "OAuth client secret
|
|
1707
|
+
"summary": "OAuth client secret. Required when auth-type is OAUTH. Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
1670
1708
|
"hasDynamicHelp": false,
|
|
1671
1709
|
"multiple": false,
|
|
1672
1710
|
"type": "option"
|
|
1673
1711
|
},
|
|
1674
1712
|
"scope": {
|
|
1675
1713
|
"name": "scope",
|
|
1676
|
-
"summary": "OAuth scope
|
|
1714
|
+
"summary": "OAuth scope to request. Required when auth-type is OAUTH.",
|
|
1677
1715
|
"hasDynamicHelp": false,
|
|
1678
1716
|
"multiple": false,
|
|
1679
1717
|
"type": "option"
|
|
@@ -1681,13 +1719,13 @@
|
|
|
1681
1719
|
},
|
|
1682
1720
|
"hasDynamicHelp": true,
|
|
1683
1721
|
"hiddenAliases": [],
|
|
1684
|
-
"id": "agent:mcp:
|
|
1722
|
+
"id": "agent:mcp:create",
|
|
1685
1723
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1686
1724
|
"pluginName": "@salesforce/plugin-agent",
|
|
1687
1725
|
"pluginType": "core",
|
|
1688
1726
|
"state": "preview",
|
|
1689
1727
|
"strict": true,
|
|
1690
|
-
"summary": "
|
|
1728
|
+
"summary": "Create an MCP server in the API Catalog.",
|
|
1691
1729
|
"enableJsonFlag": true,
|
|
1692
1730
|
"isESM": true,
|
|
1693
1731
|
"relativePath": [
|
|
@@ -1695,28 +1733,25 @@
|
|
|
1695
1733
|
"commands",
|
|
1696
1734
|
"agent",
|
|
1697
1735
|
"mcp",
|
|
1698
|
-
"
|
|
1736
|
+
"create.js"
|
|
1699
1737
|
],
|
|
1700
1738
|
"aliasPermutations": [],
|
|
1701
1739
|
"permutations": [
|
|
1702
|
-
"agent:mcp:
|
|
1703
|
-
"mcp:agent:
|
|
1704
|
-
"mcp:
|
|
1705
|
-
"agent:
|
|
1706
|
-
"
|
|
1707
|
-
"
|
|
1740
|
+
"agent:mcp:create",
|
|
1741
|
+
"mcp:agent:create",
|
|
1742
|
+
"mcp:create:agent",
|
|
1743
|
+
"agent:create:mcp",
|
|
1744
|
+
"create:agent:mcp",
|
|
1745
|
+
"create:mcp:agent"
|
|
1708
1746
|
]
|
|
1709
1747
|
},
|
|
1710
|
-
"agent:
|
|
1748
|
+
"agent:mcp:delete": {
|
|
1711
1749
|
"aliases": [],
|
|
1712
1750
|
"args": {},
|
|
1713
|
-
"description": "
|
|
1751
|
+
"description": "Permanently removes an MCP (Model Context Protocol) server registration from the API Catalog, identified by its ID. By default you are prompted to confirm the deletion; pass --no-prompt to skip the confirmation (for example in scripts and CI).",
|
|
1714
1752
|
"examples": [
|
|
1715
|
-
"
|
|
1716
|
-
"
|
|
1717
|
-
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
1718
|
-
"Specify an existing agent spec file called \"specs/resortManagerAgent.yaml\", and then overwrite it with a new version that contains newly AI-generated topics based on the updated role information passed in with the --role flag:\n<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role \"Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly\"",
|
|
1719
|
-
"Specify that the conversational tone of the agent is formal and to attach the \"resortmanager@myorg.com\" username to it; be prompted for the required properties and use your default org:\n<%= config.bin %> <%= command.id %> --tone formal --agent-user resortmanager@myorg.com"
|
|
1753
|
+
"Delete an MCP server, confirming interactively:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg",
|
|
1754
|
+
"Delete an MCP server without a confirmation prompt:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg --no-prompt"
|
|
1720
1755
|
],
|
|
1721
1756
|
"flags": {
|
|
1722
1757
|
"json": {
|
|
@@ -1751,164 +1786,215 @@
|
|
|
1751
1786
|
"multiple": false,
|
|
1752
1787
|
"type": "option"
|
|
1753
1788
|
},
|
|
1754
|
-
"
|
|
1755
|
-
"
|
|
1756
|
-
"
|
|
1757
|
-
"
|
|
1758
|
-
"
|
|
1759
|
-
"options": [
|
|
1760
|
-
"customer",
|
|
1761
|
-
"internal"
|
|
1762
|
-
],
|
|
1763
|
-
"type": "option"
|
|
1764
|
-
},
|
|
1765
|
-
"role": {
|
|
1766
|
-
"name": "role",
|
|
1767
|
-
"summary": "Role of the agent.",
|
|
1768
|
-
"hasDynamicHelp": false,
|
|
1769
|
-
"multiple": false,
|
|
1770
|
-
"type": "option"
|
|
1771
|
-
},
|
|
1772
|
-
"company-name": {
|
|
1773
|
-
"name": "company-name",
|
|
1774
|
-
"summary": "Name of your company.",
|
|
1775
|
-
"hasDynamicHelp": false,
|
|
1776
|
-
"multiple": false,
|
|
1777
|
-
"type": "option"
|
|
1778
|
-
},
|
|
1779
|
-
"company-description": {
|
|
1780
|
-
"name": "company-description",
|
|
1781
|
-
"summary": "Description of your company.",
|
|
1789
|
+
"mcp-server-id": {
|
|
1790
|
+
"char": "i",
|
|
1791
|
+
"name": "mcp-server-id",
|
|
1792
|
+
"required": true,
|
|
1793
|
+
"summary": "ID of the MCP server to delete.",
|
|
1782
1794
|
"hasDynamicHelp": false,
|
|
1783
1795
|
"multiple": false,
|
|
1784
1796
|
"type": "option"
|
|
1785
1797
|
},
|
|
1786
|
-
"
|
|
1787
|
-
"name": "
|
|
1788
|
-
"summary": "
|
|
1789
|
-
"
|
|
1790
|
-
"
|
|
1791
|
-
|
|
1798
|
+
"no-prompt": {
|
|
1799
|
+
"name": "no-prompt",
|
|
1800
|
+
"summary": "Skip the confirmation prompt and delete the MCP server immediately.",
|
|
1801
|
+
"allowNo": false,
|
|
1802
|
+
"type": "boolean"
|
|
1803
|
+
}
|
|
1804
|
+
},
|
|
1805
|
+
"hasDynamicHelp": true,
|
|
1806
|
+
"hiddenAliases": [],
|
|
1807
|
+
"id": "agent:mcp:delete",
|
|
1808
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
1809
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
1810
|
+
"pluginType": "core",
|
|
1811
|
+
"state": "preview",
|
|
1812
|
+
"strict": true,
|
|
1813
|
+
"summary": "Delete an MCP server from the API Catalog.",
|
|
1814
|
+
"enableJsonFlag": true,
|
|
1815
|
+
"isESM": true,
|
|
1816
|
+
"relativePath": [
|
|
1817
|
+
"lib",
|
|
1818
|
+
"commands",
|
|
1819
|
+
"agent",
|
|
1820
|
+
"mcp",
|
|
1821
|
+
"delete.js"
|
|
1822
|
+
],
|
|
1823
|
+
"aliasPermutations": [],
|
|
1824
|
+
"permutations": [
|
|
1825
|
+
"agent:mcp:delete",
|
|
1826
|
+
"mcp:agent:delete",
|
|
1827
|
+
"mcp:delete:agent",
|
|
1828
|
+
"agent:delete:mcp",
|
|
1829
|
+
"delete:agent:mcp",
|
|
1830
|
+
"delete:mcp:agent"
|
|
1831
|
+
]
|
|
1832
|
+
},
|
|
1833
|
+
"agent:mcp:fetch": {
|
|
1834
|
+
"aliases": [],
|
|
1835
|
+
"args": {},
|
|
1836
|
+
"description": "Performs a live fetch against the configured MCP server identified by its ID, returning the assets (MCP tools, prompts, and resources) it currently advertises along with their status and activation state. Use this to refresh the view of what an MCP server exposes before activating its assets as agent actions.",
|
|
1837
|
+
"examples": [
|
|
1838
|
+
"Fetch the assets advertised by an MCP server in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001",
|
|
1839
|
+
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
1840
|
+
],
|
|
1841
|
+
"flags": {
|
|
1842
|
+
"json": {
|
|
1843
|
+
"description": "Format output as json.",
|
|
1844
|
+
"helpGroup": "GLOBAL",
|
|
1845
|
+
"name": "json",
|
|
1846
|
+
"allowNo": false,
|
|
1847
|
+
"type": "boolean"
|
|
1792
1848
|
},
|
|
1793
|
-
"
|
|
1794
|
-
"
|
|
1795
|
-
"
|
|
1849
|
+
"flags-dir": {
|
|
1850
|
+
"helpGroup": "GLOBAL",
|
|
1851
|
+
"name": "flags-dir",
|
|
1852
|
+
"summary": "Import flag values from a directory.",
|
|
1796
1853
|
"hasDynamicHelp": false,
|
|
1797
1854
|
"multiple": false,
|
|
1798
1855
|
"type": "option"
|
|
1799
1856
|
},
|
|
1800
|
-
"
|
|
1801
|
-
"
|
|
1802
|
-
"
|
|
1803
|
-
"
|
|
1857
|
+
"target-org": {
|
|
1858
|
+
"char": "o",
|
|
1859
|
+
"name": "target-org",
|
|
1860
|
+
"noCacheDefault": true,
|
|
1861
|
+
"required": true,
|
|
1862
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1863
|
+
"hasDynamicHelp": true,
|
|
1804
1864
|
"multiple": false,
|
|
1805
1865
|
"type": "option"
|
|
1806
1866
|
},
|
|
1807
|
-
"
|
|
1808
|
-
"
|
|
1809
|
-
"
|
|
1867
|
+
"api-version": {
|
|
1868
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1869
|
+
"name": "api-version",
|
|
1810
1870
|
"hasDynamicHelp": false,
|
|
1811
1871
|
"multiple": false,
|
|
1812
|
-
"options": [
|
|
1813
|
-
"true",
|
|
1814
|
-
"false"
|
|
1815
|
-
],
|
|
1816
1872
|
"type": "option"
|
|
1817
1873
|
},
|
|
1818
|
-
"
|
|
1819
|
-
"
|
|
1820
|
-
"
|
|
1874
|
+
"mcp-server-id": {
|
|
1875
|
+
"char": "i",
|
|
1876
|
+
"name": "mcp-server-id",
|
|
1877
|
+
"required": true,
|
|
1878
|
+
"summary": "ID of the MCP server to fetch assets from.",
|
|
1821
1879
|
"hasDynamicHelp": false,
|
|
1822
1880
|
"multiple": false,
|
|
1823
|
-
"options": [
|
|
1824
|
-
"formal",
|
|
1825
|
-
"casual",
|
|
1826
|
-
"neutral"
|
|
1827
|
-
],
|
|
1828
1881
|
"type": "option"
|
|
1882
|
+
}
|
|
1883
|
+
},
|
|
1884
|
+
"hasDynamicHelp": true,
|
|
1885
|
+
"hiddenAliases": [],
|
|
1886
|
+
"id": "agent:mcp:fetch",
|
|
1887
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
1888
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
1889
|
+
"pluginType": "core",
|
|
1890
|
+
"state": "preview",
|
|
1891
|
+
"strict": true,
|
|
1892
|
+
"summary": "Fetch the live assets (tools, prompts, resources) advertised by an MCP server.",
|
|
1893
|
+
"enableJsonFlag": true,
|
|
1894
|
+
"isESM": true,
|
|
1895
|
+
"relativePath": [
|
|
1896
|
+
"lib",
|
|
1897
|
+
"commands",
|
|
1898
|
+
"agent",
|
|
1899
|
+
"mcp",
|
|
1900
|
+
"fetch.js"
|
|
1901
|
+
],
|
|
1902
|
+
"aliasPermutations": [],
|
|
1903
|
+
"permutations": [
|
|
1904
|
+
"agent:mcp:fetch",
|
|
1905
|
+
"mcp:agent:fetch",
|
|
1906
|
+
"mcp:fetch:agent",
|
|
1907
|
+
"agent:fetch:mcp",
|
|
1908
|
+
"fetch:agent:mcp",
|
|
1909
|
+
"fetch:mcp:agent"
|
|
1910
|
+
]
|
|
1911
|
+
},
|
|
1912
|
+
"agent:mcp:get": {
|
|
1913
|
+
"aliases": [],
|
|
1914
|
+
"args": {},
|
|
1915
|
+
"description": "Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.",
|
|
1916
|
+
"examples": [
|
|
1917
|
+
"Get an MCP server by id in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001",
|
|
1918
|
+
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
1919
|
+
],
|
|
1920
|
+
"flags": {
|
|
1921
|
+
"json": {
|
|
1922
|
+
"description": "Format output as json.",
|
|
1923
|
+
"helpGroup": "GLOBAL",
|
|
1924
|
+
"name": "json",
|
|
1925
|
+
"allowNo": false,
|
|
1926
|
+
"type": "boolean"
|
|
1829
1927
|
},
|
|
1830
|
-
"
|
|
1831
|
-
"
|
|
1832
|
-
"
|
|
1928
|
+
"flags-dir": {
|
|
1929
|
+
"helpGroup": "GLOBAL",
|
|
1930
|
+
"name": "flags-dir",
|
|
1931
|
+
"summary": "Import flag values from a directory.",
|
|
1833
1932
|
"hasDynamicHelp": false,
|
|
1834
1933
|
"multiple": false,
|
|
1835
1934
|
"type": "option"
|
|
1836
1935
|
},
|
|
1837
|
-
"
|
|
1838
|
-
"
|
|
1839
|
-
"
|
|
1840
|
-
"
|
|
1841
|
-
"
|
|
1936
|
+
"target-org": {
|
|
1937
|
+
"char": "o",
|
|
1938
|
+
"name": "target-org",
|
|
1939
|
+
"noCacheDefault": true,
|
|
1940
|
+
"required": true,
|
|
1941
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1942
|
+
"hasDynamicHelp": true,
|
|
1842
1943
|
"multiple": false,
|
|
1843
1944
|
"type": "option"
|
|
1844
1945
|
},
|
|
1845
|
-
"
|
|
1846
|
-
"
|
|
1847
|
-
"
|
|
1848
|
-
"allowNo": false,
|
|
1849
|
-
"type": "boolean"
|
|
1850
|
-
},
|
|
1851
|
-
"prompt-template": {
|
|
1852
|
-
"name": "prompt-template",
|
|
1853
|
-
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
1946
|
+
"api-version": {
|
|
1947
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1948
|
+
"name": "api-version",
|
|
1854
1949
|
"hasDynamicHelp": false,
|
|
1855
1950
|
"multiple": false,
|
|
1856
1951
|
"type": "option"
|
|
1857
1952
|
},
|
|
1858
|
-
"
|
|
1859
|
-
"
|
|
1860
|
-
|
|
1861
|
-
|
|
1862
|
-
"
|
|
1863
|
-
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
1953
|
+
"mcp-server-id": {
|
|
1954
|
+
"char": "i",
|
|
1955
|
+
"name": "mcp-server-id",
|
|
1956
|
+
"required": true,
|
|
1957
|
+
"summary": "The identifier of the MCP server to retrieve.",
|
|
1864
1958
|
"hasDynamicHelp": false,
|
|
1865
1959
|
"multiple": false,
|
|
1866
1960
|
"type": "option"
|
|
1867
|
-
},
|
|
1868
|
-
"force-overwrite": {
|
|
1869
|
-
"name": "force-overwrite",
|
|
1870
|
-
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
1871
|
-
"allowNo": false,
|
|
1872
|
-
"type": "boolean"
|
|
1873
1961
|
}
|
|
1874
1962
|
},
|
|
1875
1963
|
"hasDynamicHelp": true,
|
|
1876
1964
|
"hiddenAliases": [],
|
|
1877
|
-
"id": "agent:
|
|
1965
|
+
"id": "agent:mcp:get",
|
|
1878
1966
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1879
1967
|
"pluginName": "@salesforce/plugin-agent",
|
|
1880
1968
|
"pluginType": "core",
|
|
1969
|
+
"state": "preview",
|
|
1881
1970
|
"strict": true,
|
|
1882
|
-
"summary": "
|
|
1971
|
+
"summary": "Get a single MCP server registered in the API Catalog.",
|
|
1883
1972
|
"enableJsonFlag": true,
|
|
1884
|
-
"requiresProject": true,
|
|
1885
1973
|
"isESM": true,
|
|
1886
1974
|
"relativePath": [
|
|
1887
1975
|
"lib",
|
|
1888
1976
|
"commands",
|
|
1889
1977
|
"agent",
|
|
1890
|
-
"
|
|
1891
|
-
"
|
|
1978
|
+
"mcp",
|
|
1979
|
+
"get.js"
|
|
1892
1980
|
],
|
|
1893
1981
|
"aliasPermutations": [],
|
|
1894
1982
|
"permutations": [
|
|
1895
|
-
"agent:
|
|
1896
|
-
"
|
|
1897
|
-
"
|
|
1898
|
-
"agent:
|
|
1899
|
-
"
|
|
1900
|
-
"
|
|
1983
|
+
"agent:mcp:get",
|
|
1984
|
+
"mcp:agent:get",
|
|
1985
|
+
"mcp:get:agent",
|
|
1986
|
+
"agent:get:mcp",
|
|
1987
|
+
"get:agent:mcp",
|
|
1988
|
+
"get:mcp:agent"
|
|
1901
1989
|
]
|
|
1902
1990
|
},
|
|
1903
|
-
"agent:
|
|
1991
|
+
"agent:mcp:list": {
|
|
1904
1992
|
"aliases": [],
|
|
1905
1993
|
"args": {},
|
|
1906
|
-
"description": "
|
|
1907
|
-
"examples": [
|
|
1908
|
-
"
|
|
1909
|
-
"
|
|
1910
|
-
"Generate an authoring bundle from the \"specs/agentSpec.yaml\" agent spec YAML file and give it the label \"My Authoring Bundle\"; use your default org:\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\"",
|
|
1911
|
-
"Similar to previous example, but generate the authoring bundle files in the \"other-package-dir/main/default\" package directory; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\" --output-dir other-package-dir/main/default --target-org my-dev-org"
|
|
1994
|
+
"description": "Returns the Model Context Protocol (MCP) servers registered in the API Catalog, optionally filtered by label, type, or status. Use this to discover which MCP servers are available and inspect their server URLs and current status.",
|
|
1995
|
+
"examples": [
|
|
1996
|
+
"List all MCP servers in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
1997
|
+
"List external MCP servers filtered by status and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json"
|
|
1912
1998
|
],
|
|
1913
1999
|
"flags": {
|
|
1914
2000
|
"json": {
|
|
@@ -1936,13 +2022,6 @@
|
|
|
1936
2022
|
"multiple": false,
|
|
1937
2023
|
"type": "option"
|
|
1938
2024
|
},
|
|
1939
|
-
"api-name": {
|
|
1940
|
-
"name": "api-name",
|
|
1941
|
-
"summary": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name can't exist in the org.",
|
|
1942
|
-
"hasDynamicHelp": false,
|
|
1943
|
-
"multiple": false,
|
|
1944
|
-
"type": "option"
|
|
1945
|
-
},
|
|
1946
2025
|
"api-version": {
|
|
1947
2026
|
"description": "Override the api version used for api requests made by this command",
|
|
1948
2027
|
"name": "api-version",
|
|
@@ -1950,77 +2029,70 @@
|
|
|
1950
2029
|
"multiple": false,
|
|
1951
2030
|
"type": "option"
|
|
1952
2031
|
},
|
|
1953
|
-
"
|
|
1954
|
-
"
|
|
1955
|
-
"
|
|
1956
|
-
"summary": "Path to the agent spec YAML file. If you don't specify the flag, the command provides a list that you can choose from. Use the --no-spec flag to skip using an agent spec entirely.",
|
|
2032
|
+
"label": {
|
|
2033
|
+
"name": "label",
|
|
2034
|
+
"summary": "Filter the MCP servers by label.",
|
|
1957
2035
|
"hasDynamicHelp": false,
|
|
1958
2036
|
"multiple": false,
|
|
1959
2037
|
"type": "option"
|
|
1960
2038
|
},
|
|
1961
|
-
"
|
|
1962
|
-
"name": "
|
|
1963
|
-
"summary": "
|
|
1964
|
-
"allowNo": false,
|
|
1965
|
-
"type": "boolean"
|
|
1966
|
-
},
|
|
1967
|
-
"output-dir": {
|
|
1968
|
-
"char": "d",
|
|
1969
|
-
"name": "output-dir",
|
|
1970
|
-
"summary": "Directory where the authoring bundle files are generated.",
|
|
2039
|
+
"type": {
|
|
2040
|
+
"name": "type",
|
|
2041
|
+
"summary": "Filter the MCP servers by type.",
|
|
1971
2042
|
"hasDynamicHelp": false,
|
|
1972
2043
|
"multiple": false,
|
|
2044
|
+
"options": [
|
|
2045
|
+
"EXTERNAL"
|
|
2046
|
+
],
|
|
1973
2047
|
"type": "option"
|
|
1974
2048
|
},
|
|
1975
|
-
"
|
|
1976
|
-
"
|
|
1977
|
-
"
|
|
1978
|
-
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
2049
|
+
"status": {
|
|
2050
|
+
"name": "status",
|
|
2051
|
+
"summary": "Filter the MCP servers by connection status. Only ACTIVE and DISCONNECTED are supported as filters.",
|
|
1979
2052
|
"hasDynamicHelp": false,
|
|
1980
2053
|
"multiple": false,
|
|
2054
|
+
"options": [
|
|
2055
|
+
"ACTIVE",
|
|
2056
|
+
"DISCONNECTED"
|
|
2057
|
+
],
|
|
1981
2058
|
"type": "option"
|
|
1982
|
-
},
|
|
1983
|
-
"force-overwrite": {
|
|
1984
|
-
"name": "force-overwrite",
|
|
1985
|
-
"summary": "Overwrite the existing authoring bundle if one with the same API name already exists locally.",
|
|
1986
|
-
"allowNo": false,
|
|
1987
|
-
"type": "boolean"
|
|
1988
2059
|
}
|
|
1989
2060
|
},
|
|
1990
2061
|
"hasDynamicHelp": true,
|
|
1991
2062
|
"hiddenAliases": [],
|
|
1992
|
-
"id": "agent:
|
|
2063
|
+
"id": "agent:mcp:list",
|
|
1993
2064
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1994
2065
|
"pluginName": "@salesforce/plugin-agent",
|
|
1995
2066
|
"pluginType": "core",
|
|
2067
|
+
"state": "preview",
|
|
1996
2068
|
"strict": true,
|
|
1997
|
-
"summary": "
|
|
2069
|
+
"summary": "List the MCP servers registered in the API Catalog.",
|
|
1998
2070
|
"enableJsonFlag": true,
|
|
1999
|
-
"requiresProject": true,
|
|
2000
2071
|
"isESM": true,
|
|
2001
2072
|
"relativePath": [
|
|
2002
2073
|
"lib",
|
|
2003
2074
|
"commands",
|
|
2004
2075
|
"agent",
|
|
2005
|
-
"
|
|
2006
|
-
"
|
|
2076
|
+
"mcp",
|
|
2077
|
+
"list.js"
|
|
2007
2078
|
],
|
|
2008
2079
|
"aliasPermutations": [],
|
|
2009
2080
|
"permutations": [
|
|
2010
|
-
"agent:
|
|
2011
|
-
"
|
|
2012
|
-
"
|
|
2013
|
-
"agent:
|
|
2014
|
-
"
|
|
2015
|
-
"
|
|
2081
|
+
"agent:mcp:list",
|
|
2082
|
+
"mcp:agent:list",
|
|
2083
|
+
"mcp:list:agent",
|
|
2084
|
+
"agent:list:mcp",
|
|
2085
|
+
"list:agent:mcp",
|
|
2086
|
+
"list:mcp:agent"
|
|
2016
2087
|
]
|
|
2017
2088
|
},
|
|
2018
|
-
"agent:
|
|
2089
|
+
"agent:mcp:update": {
|
|
2019
2090
|
"aliases": [],
|
|
2020
2091
|
"args": {},
|
|
2021
|
-
"description": "
|
|
2092
|
+
"description": "Updates an existing MCP server in the API Catalog. Only the fields you provide are changed; omitted fields are left untouched. You can update the label, description, and server URL, and replace the authorization configuration. When setting `--auth-type OAUTH`, you must also provide `--identity-provider`, `--client-id`, `--client-secret`, and `--scope`. When setting `--auth-type NO_AUTH`, no authorization credentials are required. At least one updatable field must be supplied.",
|
|
2022
2093
|
"examples": [
|
|
2023
|
-
"
|
|
2094
|
+
"Update the label and description of an MCP server in the default target org:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --label \"Orders MCP\" --description \"Order tooling\" --target-org myOrg",
|
|
2095
|
+
"Update the server URL and switch the authorization to OAuth, piping the client secret from stdin and outputting as JSON:\ncat secret.txt | <%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --server-url https://mcp.example.com --auth-type OAUTH --identity-provider MyIdp --client-id abc --client-secret - --scope \"read write\" --target-org myOrg --json"
|
|
2024
2096
|
],
|
|
2025
2097
|
"flags": {
|
|
2026
2098
|
"json": {
|
|
@@ -2038,6 +2110,16 @@
|
|
|
2038
2110
|
"multiple": false,
|
|
2039
2111
|
"type": "option"
|
|
2040
2112
|
},
|
|
2113
|
+
"target-org": {
|
|
2114
|
+
"char": "o",
|
|
2115
|
+
"name": "target-org",
|
|
2116
|
+
"noCacheDefault": true,
|
|
2117
|
+
"required": true,
|
|
2118
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2119
|
+
"hasDynamicHelp": true,
|
|
2120
|
+
"multiple": false,
|
|
2121
|
+
"type": "option"
|
|
2122
|
+
},
|
|
2041
2123
|
"api-version": {
|
|
2042
2124
|
"description": "Override the api version used for api requests made by this command",
|
|
2043
2125
|
"name": "api-version",
|
|
@@ -2045,150 +2127,102 @@
|
|
|
2045
2127
|
"multiple": false,
|
|
2046
2128
|
"type": "option"
|
|
2047
2129
|
},
|
|
2048
|
-
"
|
|
2049
|
-
"char": "
|
|
2050
|
-
"name": "
|
|
2051
|
-
"noCacheDefault": true,
|
|
2130
|
+
"mcp-server-id": {
|
|
2131
|
+
"char": "i",
|
|
2132
|
+
"name": "mcp-server-id",
|
|
2052
2133
|
"required": true,
|
|
2053
|
-
"summary": "
|
|
2054
|
-
"hasDynamicHelp":
|
|
2134
|
+
"summary": "ID of the MCP server to update.",
|
|
2135
|
+
"hasDynamicHelp": false,
|
|
2055
2136
|
"multiple": false,
|
|
2056
2137
|
"type": "option"
|
|
2057
2138
|
},
|
|
2058
|
-
"
|
|
2059
|
-
"name": "
|
|
2060
|
-
"
|
|
2061
|
-
"summary": "Version of the agent (BotVersion).",
|
|
2139
|
+
"label": {
|
|
2140
|
+
"name": "label",
|
|
2141
|
+
"summary": "New display label for the MCP server.",
|
|
2062
2142
|
"hasDynamicHelp": false,
|
|
2063
2143
|
"multiple": false,
|
|
2064
2144
|
"type": "option"
|
|
2065
2145
|
},
|
|
2066
|
-
"
|
|
2067
|
-
"
|
|
2068
|
-
"
|
|
2069
|
-
"required": true,
|
|
2070
|
-
"summary": "Path to an agent (Bot) metadata file.",
|
|
2146
|
+
"description": {
|
|
2147
|
+
"name": "description",
|
|
2148
|
+
"summary": "New description for the MCP server.",
|
|
2071
2149
|
"hasDynamicHelp": false,
|
|
2072
2150
|
"multiple": false,
|
|
2073
2151
|
"type": "option"
|
|
2074
2152
|
},
|
|
2075
|
-
"
|
|
2076
|
-
"
|
|
2077
|
-
"
|
|
2078
|
-
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
2153
|
+
"server-url": {
|
|
2154
|
+
"name": "server-url",
|
|
2155
|
+
"summary": "New endpoint URL of the MCP server.",
|
|
2079
2156
|
"hasDynamicHelp": false,
|
|
2080
2157
|
"multiple": false,
|
|
2081
2158
|
"type": "option"
|
|
2082
|
-
}
|
|
2083
|
-
|
|
2084
|
-
|
|
2085
|
-
|
|
2086
|
-
"id": "agent:generate:template",
|
|
2087
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
2088
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
2089
|
-
"pluginType": "core",
|
|
2090
|
-
"strict": true,
|
|
2091
|
-
"summary": "Generate an agent template from an existing agent in your DX project so you can then package the template in a second-generation managed package.",
|
|
2092
|
-
"enableJsonFlag": true,
|
|
2093
|
-
"requiresProject": true,
|
|
2094
|
-
"isESM": true,
|
|
2095
|
-
"relativePath": [
|
|
2096
|
-
"lib",
|
|
2097
|
-
"commands",
|
|
2098
|
-
"agent",
|
|
2099
|
-
"generate",
|
|
2100
|
-
"template.js"
|
|
2101
|
-
],
|
|
2102
|
-
"aliasPermutations": [],
|
|
2103
|
-
"permutations": [
|
|
2104
|
-
"agent:generate:template",
|
|
2105
|
-
"generate:agent:template",
|
|
2106
|
-
"generate:template:agent",
|
|
2107
|
-
"agent:template:generate",
|
|
2108
|
-
"template:agent:generate",
|
|
2109
|
-
"template:generate:agent"
|
|
2110
|
-
]
|
|
2111
|
-
},
|
|
2112
|
-
"agent:generate:test-spec": {
|
|
2113
|
-
"aliases": [],
|
|
2114
|
-
"args": {},
|
|
2115
|
-
"description": "The first step when using Salesforce CLI to create an agent test in your org is to use this interactive command to generate a local YAML-formatted test spec file. The test spec YAML file contains information about the agent being tested, such as its API name, and then one or more test cases. This command uses the metadata components in your DX project when prompting for information, such as the agent API name; it doesn't look in your org.\n\nTo generate a specific agent test case, this command prompts you for this information; when possible, the command provides a list of options for you to choose from:\n\n- Utterance: Natural language statement, question, or command used to test the agent.\n- Expected topic: API name of the topic you expect the agent to use when responding to the utterance.\n- Expected actions: One or more API names of the expection actions the agent takes.\n- Expected outcome: Natural language description of the outcome you expect.\n- (Optional) Custom evaluation: Test an agent's response for specific strings or numbers.\n- (Optional) Conversation history: Boilerplate for additional context you can add to the test in the form of a conversation history.\n\nYou can manually add contextVariables to test cases in the generated YAML file to inject contextual data (such as CaseId or RoutableId) into agent sessions. This is useful for testing agent behavior with different contextual information.\n\nWhen your test spec is ready, you then run the \"agent test create\" command to actually create the test in your org and synchronize the metadata with your DX project. The metadata type for an agent test is `AiEvaluationDefinition` (legacy testing-center) or `AiTestingDefinition` (Agentforce Studio / NGT), selected via --test-runner.\n\nIf you have an existing AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project, you can generate its equivalent YAML test spec file with the --from-definition flag. The runner is inferred from the file extension; pass --test-runner to override.",
|
|
2116
|
-
"examples": [
|
|
2117
|
-
"Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
|
|
2118
|
-
"Generate an Agentforce Studio (NGT) test spec YAML file interactively:\n<%= config.bin %> <%= command.id %> --test-runner agentforce-studio",
|
|
2119
|
-
"Generate an agent test spec YAML file and specify a name for the new file; if the file exists, overwrite it without confirmation:\n<%= config.bin %> <%= command.id %> --output-file specs/Resort_Manager-new-version-testSpec.yaml --force-overwrite",
|
|
2120
|
-
"Generate an agent test spec YAML file from an existing AiEvaluationDefinition metadata XML file in your DX project:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml",
|
|
2121
|
-
"Generate an Agentforce Studio (NGT) test spec YAML file from an existing AiTestingDefinition metadata XML file:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiTestingDefinitions/Returns_Checkout_Tests.aiTestingDefinition-meta.xml"
|
|
2122
|
-
],
|
|
2123
|
-
"flags": {
|
|
2124
|
-
"flags-dir": {
|
|
2125
|
-
"helpGroup": "GLOBAL",
|
|
2126
|
-
"name": "flags-dir",
|
|
2127
|
-
"summary": "Import flag values from a directory.",
|
|
2159
|
+
},
|
|
2160
|
+
"auth-type": {
|
|
2161
|
+
"name": "auth-type",
|
|
2162
|
+
"summary": "Authorization type to apply to the MCP server (OAUTH or NO_AUTH).",
|
|
2128
2163
|
"hasDynamicHelp": false,
|
|
2129
2164
|
"multiple": false,
|
|
2165
|
+
"options": [
|
|
2166
|
+
"OAUTH",
|
|
2167
|
+
"NO_AUTH"
|
|
2168
|
+
],
|
|
2130
2169
|
"type": "option"
|
|
2131
2170
|
},
|
|
2132
|
-
"
|
|
2133
|
-
"
|
|
2134
|
-
"
|
|
2135
|
-
"summary": "Filepath to an AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project that you want to convert to a test spec YAML file.",
|
|
2171
|
+
"identity-provider": {
|
|
2172
|
+
"name": "identity-provider",
|
|
2173
|
+
"summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
|
|
2136
2174
|
"hasDynamicHelp": false,
|
|
2137
2175
|
"multiple": false,
|
|
2138
2176
|
"type": "option"
|
|
2139
2177
|
},
|
|
2140
|
-
"
|
|
2141
|
-
"name": "
|
|
2142
|
-
"summary": "
|
|
2143
|
-
"
|
|
2144
|
-
"
|
|
2178
|
+
"client-id": {
|
|
2179
|
+
"name": "client-id",
|
|
2180
|
+
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
2181
|
+
"hasDynamicHelp": false,
|
|
2182
|
+
"multiple": false,
|
|
2183
|
+
"type": "option"
|
|
2145
2184
|
},
|
|
2146
|
-
"
|
|
2147
|
-
"
|
|
2148
|
-
"
|
|
2149
|
-
"summary": "Name of the generated test spec YAML file. Default value is \"specs/<AGENT_API_NAME>-testSpec.yaml\" (legacy) or \"specs/<AGENT_API_NAME>-ngtTestSpec.yaml\" (Agentforce Studio).",
|
|
2185
|
+
"client-secret": {
|
|
2186
|
+
"name": "client-secret",
|
|
2187
|
+
"summary": "OAuth client secret (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
2150
2188
|
"hasDynamicHelp": false,
|
|
2151
2189
|
"multiple": false,
|
|
2152
2190
|
"type": "option"
|
|
2153
2191
|
},
|
|
2154
|
-
"
|
|
2155
|
-
"
|
|
2156
|
-
"
|
|
2157
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2192
|
+
"scope": {
|
|
2193
|
+
"name": "scope",
|
|
2194
|
+
"summary": "OAuth scope (required when --auth-type is OAUTH).",
|
|
2158
2195
|
"hasDynamicHelp": false,
|
|
2159
2196
|
"multiple": false,
|
|
2160
|
-
"options": [
|
|
2161
|
-
"agentforce-studio",
|
|
2162
|
-
"testing-center"
|
|
2163
|
-
],
|
|
2164
2197
|
"type": "option"
|
|
2165
2198
|
}
|
|
2166
2199
|
},
|
|
2167
|
-
"hasDynamicHelp":
|
|
2200
|
+
"hasDynamicHelp": true,
|
|
2168
2201
|
"hiddenAliases": [],
|
|
2169
|
-
"id": "agent:
|
|
2202
|
+
"id": "agent:mcp:update",
|
|
2170
2203
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2171
2204
|
"pluginName": "@salesforce/plugin-agent",
|
|
2172
2205
|
"pluginType": "core",
|
|
2206
|
+
"state": "preview",
|
|
2173
2207
|
"strict": true,
|
|
2174
|
-
"summary": "
|
|
2175
|
-
"enableJsonFlag":
|
|
2208
|
+
"summary": "Update an MCP server registered in the API Catalog.",
|
|
2209
|
+
"enableJsonFlag": true,
|
|
2176
2210
|
"isESM": true,
|
|
2177
2211
|
"relativePath": [
|
|
2178
2212
|
"lib",
|
|
2179
2213
|
"commands",
|
|
2180
2214
|
"agent",
|
|
2181
|
-
"
|
|
2182
|
-
"
|
|
2215
|
+
"mcp",
|
|
2216
|
+
"update.js"
|
|
2183
2217
|
],
|
|
2184
2218
|
"aliasPermutations": [],
|
|
2185
2219
|
"permutations": [
|
|
2186
|
-
"agent:
|
|
2187
|
-
"
|
|
2188
|
-
"
|
|
2189
|
-
"agent:
|
|
2190
|
-
"
|
|
2191
|
-
"
|
|
2220
|
+
"agent:mcp:update",
|
|
2221
|
+
"mcp:agent:update",
|
|
2222
|
+
"mcp:update:agent",
|
|
2223
|
+
"agent:update:mcp",
|
|
2224
|
+
"update:agent:mcp",
|
|
2225
|
+
"update:mcp:agent"
|
|
2192
2226
|
]
|
|
2193
2227
|
},
|
|
2194
2228
|
"agent:preview:end": {
|
|
@@ -4080,7 +4114,7 @@
|
|
|
4080
4114
|
"agent:adl:file:add": {
|
|
4081
4115
|
"aliases": [],
|
|
4082
4116
|
"args": {},
|
|
4083
|
-
"description": "Adds one or more files to an existing SFDRIVE data library and triggers SearchIndex re-hydration. This is the day-2 operation for adding files to an already-provisioned library.\n\nConstraints: at least 1 file required, no duplicate file names in a batch, maximum 1000 files per library.",
|
|
4117
|
+
"description": "Adds one or more files to an existing SFDRIVE data library and triggers SearchIndex re-hydration. This is the day-2 operation for adding files to an already-provisioned library.\n\nAdds files to an existing READY library. Unlike `sf agent adl upload`, this does NOT create new downstream Data Cloud assets — it appends files to the existing SearchIndex and triggers re-indexing.\n\nConstraints: at least 1 file required, no duplicate file names in a batch, maximum 1000 files per library.",
|
|
4084
4118
|
"examples": [
|
|
4085
4119
|
"Add a file to an existing library:\n<%= config.bin %> <%= command.id %> -i 1JDSG000007IbWX4A0 --path ./docs/new-guide.pdf --target-org myOrg",
|
|
4086
4120
|
"Add multiple files:\n<%= config.bin %> <%= command.id %> -i 1JDSG000007IbWX4A0 --path ./docs/guide.pdf --path ./docs/faq.txt --target-org myOrg"
|
|
@@ -4143,7 +4177,6 @@
|
|
|
4143
4177
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
4144
4178
|
"pluginName": "@salesforce/plugin-agent",
|
|
4145
4179
|
"pluginType": "core",
|
|
4146
|
-
"state": "preview",
|
|
4147
4180
|
"strict": true,
|
|
4148
4181
|
"summary": "Add files to an existing Agentforce Data Library.",
|
|
4149
4182
|
"enableJsonFlag": true,
|
|
@@ -4248,7 +4281,6 @@
|
|
|
4248
4281
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
4249
4282
|
"pluginName": "@salesforce/plugin-agent",
|
|
4250
4283
|
"pluginType": "core",
|
|
4251
|
-
"state": "preview",
|
|
4252
4284
|
"strict": true,
|
|
4253
4285
|
"summary": "Delete a file from an Agentforce Data Library.",
|
|
4254
4286
|
"enableJsonFlag": true,
|
|
@@ -4338,6 +4370,37 @@
|
|
|
4338
4370
|
"hasDynamicHelp": false,
|
|
4339
4371
|
"multiple": false,
|
|
4340
4372
|
"type": "option"
|
|
4373
|
+
},
|
|
4374
|
+
"page-size": {
|
|
4375
|
+
"name": "page-size",
|
|
4376
|
+
"summary": "Number of files to return per page (1-200, default 50).",
|
|
4377
|
+
"default": 50,
|
|
4378
|
+
"hasDynamicHelp": false,
|
|
4379
|
+
"multiple": false,
|
|
4380
|
+
"type": "option"
|
|
4381
|
+
},
|
|
4382
|
+
"offset": {
|
|
4383
|
+
"name": "offset",
|
|
4384
|
+
"summary": "Number of files to skip before returning results (for pagination).",
|
|
4385
|
+
"default": 0,
|
|
4386
|
+
"hasDynamicHelp": false,
|
|
4387
|
+
"multiple": false,
|
|
4388
|
+
"type": "option"
|
|
4389
|
+
},
|
|
4390
|
+
"status": {
|
|
4391
|
+
"name": "status",
|
|
4392
|
+
"summary": "Filter files by indexing status.",
|
|
4393
|
+
"hasDynamicHelp": false,
|
|
4394
|
+
"multiple": false,
|
|
4395
|
+
"options": [
|
|
4396
|
+
"uploaded",
|
|
4397
|
+
"indexing",
|
|
4398
|
+
"indexed",
|
|
4399
|
+
"index_failed",
|
|
4400
|
+
"deleting",
|
|
4401
|
+
"delete_failed"
|
|
4402
|
+
],
|
|
4403
|
+
"type": "option"
|
|
4341
4404
|
}
|
|
4342
4405
|
},
|
|
4343
4406
|
"hasDynamicHelp": true,
|
|
@@ -4346,7 +4409,6 @@
|
|
|
4346
4409
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
4347
4410
|
"pluginName": "@salesforce/plugin-agent",
|
|
4348
4411
|
"pluginType": "core",
|
|
4349
|
-
"state": "preview",
|
|
4350
4412
|
"strict": true,
|
|
4351
4413
|
"summary": "List files in an Agentforce Data Library.",
|
|
4352
4414
|
"enableJsonFlag": true,
|
|
@@ -4605,5 +4667,5 @@
|
|
|
4605
4667
|
]
|
|
4606
4668
|
}
|
|
4607
4669
|
},
|
|
4608
|
-
"version": "1.
|
|
4670
|
+
"version": "1.44.5"
|
|
4609
4671
|
}
|