@salesforce/plugin-agent 2.0.0 → 2.0.1
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 +41 -41
- package/oclif.manifest.json +1333 -1333
- package/package.json +4 -4
package/oclif.manifest.json
CHANGED
|
@@ -1120,13 +1120,16 @@
|
|
|
1120
1120
|
"upload:adl:agent"
|
|
1121
1121
|
]
|
|
1122
1122
|
},
|
|
1123
|
-
"agent:
|
|
1123
|
+
"agent:preview:end": {
|
|
1124
1124
|
"aliases": [],
|
|
1125
1125
|
"args": {},
|
|
1126
|
-
"description": "
|
|
1126
|
+
"description": "You must have previously started a programmatic agent preview session with the \"agent preview start\" command to then use this command to end it. This command also displays the local directory where the session trace files are stored.\n\nThe original \"agent preview start\" command outputs a session ID which you then use with the --session-id flag of this command to end the session. You don't have to specify the --session-id flag if an agent has only one active preview session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring bundle or the published agent, respectively. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.\n\nUse the --all flag to end all active preview sessions at once. You can combine --all with --api-name or --authoring-bundle to end only sessions for a specific agent, or use --all on its own to end every session across all agents in the project.",
|
|
1127
1127
|
"examples": [
|
|
1128
|
-
"
|
|
1129
|
-
"
|
|
1128
|
+
"End a preview session of a published agent by specifying its session ID and API name; use the default org:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --api-name My_Published_Agent",
|
|
1129
|
+
"Similar to previous example, but don't specify a session ID; you get an error if the published agent has more than one active session. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent --target-org my-dev-org",
|
|
1130
|
+
"End a preview session of an agent using its authoring bundle API name; you get an error if the agent has more than one active session.\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Local_Agent",
|
|
1131
|
+
"End all active preview sessions for a specific agent without prompting:\n<%= config.bin %> <%= command.id %> --all --authoring-bundle My_Local_Agent --target-org <target_org> --no-prompt",
|
|
1132
|
+
"End all active preview sessions across every agent in the local session cache for an org:\n<%= config.bin %> <%= command.id %> --all --target-org <target_org>"
|
|
1130
1133
|
],
|
|
1131
1134
|
"flags": {
|
|
1132
1135
|
"json": {
|
|
@@ -1161,113 +1164,129 @@
|
|
|
1161
1164
|
"multiple": false,
|
|
1162
1165
|
"type": "option"
|
|
1163
1166
|
},
|
|
1164
|
-
"
|
|
1165
|
-
"
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
"
|
|
1169
|
-
"
|
|
1170
|
-
"
|
|
1171
|
-
"type": "option"
|
|
1172
|
-
},
|
|
1173
|
-
"label": {
|
|
1174
|
-
"name": "label",
|
|
1175
|
-
"summary": "Human-readable label for the MCP server.",
|
|
1176
|
-
"hasDynamicHelp": false,
|
|
1177
|
-
"multiple": false,
|
|
1178
|
-
"type": "option"
|
|
1179
|
-
},
|
|
1180
|
-
"description": {
|
|
1181
|
-
"name": "description",
|
|
1182
|
-
"summary": "Description of the MCP server.",
|
|
1183
|
-
"hasDynamicHelp": false,
|
|
1184
|
-
"multiple": false,
|
|
1185
|
-
"type": "option"
|
|
1186
|
-
},
|
|
1187
|
-
"server-url": {
|
|
1188
|
-
"name": "server-url",
|
|
1189
|
-
"required": true,
|
|
1190
|
-
"summary": "URL of the external MCP server.",
|
|
1167
|
+
"session-id": {
|
|
1168
|
+
"exclusive": [
|
|
1169
|
+
"all"
|
|
1170
|
+
],
|
|
1171
|
+
"name": "session-id",
|
|
1172
|
+
"required": false,
|
|
1173
|
+
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see the list of all sessions.",
|
|
1191
1174
|
"hasDynamicHelp": false,
|
|
1192
1175
|
"multiple": false,
|
|
1193
1176
|
"type": "option"
|
|
1194
1177
|
},
|
|
1195
|
-
"
|
|
1196
|
-
"
|
|
1197
|
-
"
|
|
1198
|
-
|
|
1199
|
-
"hasDynamicHelp": false,
|
|
1200
|
-
"multiple": false,
|
|
1201
|
-
"options": [
|
|
1202
|
-
"OAUTH",
|
|
1203
|
-
"NO_AUTH"
|
|
1178
|
+
"api-name": {
|
|
1179
|
+
"char": "n",
|
|
1180
|
+
"exclusive": [
|
|
1181
|
+
"authoring-bundle"
|
|
1204
1182
|
],
|
|
1205
|
-
"
|
|
1206
|
-
|
|
1207
|
-
"identity-provider": {
|
|
1208
|
-
"name": "identity-provider",
|
|
1209
|
-
"summary": "Identity provider to use for OAuth authorization. Required when auth-type is OAUTH.",
|
|
1183
|
+
"name": "api-name",
|
|
1184
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
1210
1185
|
"hasDynamicHelp": false,
|
|
1211
1186
|
"multiple": false,
|
|
1212
1187
|
"type": "option"
|
|
1213
1188
|
},
|
|
1214
|
-
"
|
|
1215
|
-
"
|
|
1216
|
-
|
|
1189
|
+
"authoring-bundle": {
|
|
1190
|
+
"exclusive": [
|
|
1191
|
+
"api-name"
|
|
1192
|
+
],
|
|
1193
|
+
"name": "authoring-bundle",
|
|
1194
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1217
1195
|
"hasDynamicHelp": false,
|
|
1218
1196
|
"multiple": false,
|
|
1219
1197
|
"type": "option"
|
|
1220
1198
|
},
|
|
1221
|
-
"
|
|
1222
|
-
"
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
"
|
|
1226
|
-
"
|
|
1199
|
+
"all": {
|
|
1200
|
+
"exclusive": [
|
|
1201
|
+
"session-id"
|
|
1202
|
+
],
|
|
1203
|
+
"name": "all",
|
|
1204
|
+
"summary": "End all active preview sessions. Combine with --api-name or --authoring-bundle to limit to a specific agent, or use with only --target-org to end sessions for all agents found in the local session cache. Requires --target-org.",
|
|
1205
|
+
"allowNo": false,
|
|
1206
|
+
"type": "boolean"
|
|
1227
1207
|
},
|
|
1228
|
-
"
|
|
1229
|
-
"
|
|
1230
|
-
"
|
|
1231
|
-
"
|
|
1232
|
-
"
|
|
1233
|
-
"type": "
|
|
1208
|
+
"no-prompt": {
|
|
1209
|
+
"char": "p",
|
|
1210
|
+
"name": "no-prompt",
|
|
1211
|
+
"summary": "Don't prompt for confirmation before ending sessions. Has an effect only when used with --all.",
|
|
1212
|
+
"allowNo": false,
|
|
1213
|
+
"type": "boolean"
|
|
1234
1214
|
}
|
|
1235
1215
|
},
|
|
1236
1216
|
"hasDynamicHelp": true,
|
|
1237
1217
|
"hiddenAliases": [],
|
|
1238
|
-
"id": "agent:
|
|
1218
|
+
"id": "agent:preview:end",
|
|
1239
1219
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1240
1220
|
"pluginName": "@salesforce/plugin-agent",
|
|
1241
1221
|
"pluginType": "core",
|
|
1242
|
-
"state": "preview",
|
|
1243
1222
|
"strict": true,
|
|
1244
|
-
"summary": "
|
|
1223
|
+
"summary": "End an existing programmatic agent preview session and get trace location.",
|
|
1245
1224
|
"enableJsonFlag": true,
|
|
1225
|
+
"requiresProject": true,
|
|
1226
|
+
"envVariablesSection": {
|
|
1227
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1228
|
+
"body": [
|
|
1229
|
+
{
|
|
1230
|
+
"name": "SF_TARGET_ORG",
|
|
1231
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1232
|
+
}
|
|
1233
|
+
]
|
|
1234
|
+
},
|
|
1235
|
+
"errorCodes": {
|
|
1236
|
+
"header": "ERROR CODES",
|
|
1237
|
+
"body": [
|
|
1238
|
+
{
|
|
1239
|
+
"name": "Succeeded (0)",
|
|
1240
|
+
"description": "Preview session ended successfully and traces saved."
|
|
1241
|
+
},
|
|
1242
|
+
{
|
|
1243
|
+
"name": "ExactlyOneRequired (2)",
|
|
1244
|
+
"description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
|
|
1245
|
+
},
|
|
1246
|
+
{
|
|
1247
|
+
"name": "NotFound (2)",
|
|
1248
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
1249
|
+
},
|
|
1250
|
+
{
|
|
1251
|
+
"name": "PreviewEndFailed (4)",
|
|
1252
|
+
"description": "Failed to end the preview session."
|
|
1253
|
+
},
|
|
1254
|
+
{
|
|
1255
|
+
"name": "PreviewEndPartialFailure (68)",
|
|
1256
|
+
"description": "With --all, one or more sessions failed to end while others succeeded."
|
|
1257
|
+
},
|
|
1258
|
+
{
|
|
1259
|
+
"name": "SessionAmbiguous (5)",
|
|
1260
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
1261
|
+
}
|
|
1262
|
+
]
|
|
1263
|
+
},
|
|
1246
1264
|
"isESM": true,
|
|
1247
1265
|
"relativePath": [
|
|
1248
1266
|
"lib",
|
|
1249
1267
|
"commands",
|
|
1250
1268
|
"agent",
|
|
1251
|
-
"
|
|
1252
|
-
"
|
|
1269
|
+
"preview",
|
|
1270
|
+
"end.js"
|
|
1253
1271
|
],
|
|
1254
1272
|
"aliasPermutations": [],
|
|
1255
1273
|
"permutations": [
|
|
1256
|
-
"agent:
|
|
1257
|
-
"
|
|
1258
|
-
"
|
|
1259
|
-
"agent:
|
|
1260
|
-
"
|
|
1261
|
-
"
|
|
1274
|
+
"agent:preview:end",
|
|
1275
|
+
"preview:agent:end",
|
|
1276
|
+
"preview:end:agent",
|
|
1277
|
+
"agent:end:preview",
|
|
1278
|
+
"end:agent:preview",
|
|
1279
|
+
"end:preview:agent"
|
|
1262
1280
|
]
|
|
1263
1281
|
},
|
|
1264
|
-
"agent:
|
|
1282
|
+
"agent:preview:send": {
|
|
1265
1283
|
"aliases": [],
|
|
1266
1284
|
"args": {},
|
|
1267
|
-
"description": "
|
|
1285
|
+
"description": "You must have previously started a programmatic agent preview session with the \"agent preview start\" command to then use this command to send the agent a message (utterance). This command then displays the agent's response.\n\nThe original \"agent preview start\" command outputs a session ID which you then use with the --session-id flag of this command to send a message. You don't have to specify the --session-id flag if an agent has only one active preview session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.",
|
|
1268
1286
|
"examples": [
|
|
1269
|
-
"
|
|
1270
|
-
"
|
|
1287
|
+
"Send a message to an activated published agent using its API name and session ID; use the default org:\n<%= config.bin %> <%= command.id %> --utterance \"What can you help me with?\" --api-name My_Published_Agent --session-id <SESSION_ID>",
|
|
1288
|
+
"Similar to previous example, but don't specify a session ID; you get an error if the agent has more than one active session. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --utterance \"What can you help me with?\" --api-name My_Published_Agent --target-org my-dev-org",
|
|
1289
|
+
"Send a message to an agent using its authoring bundle API name; you get an error if the agent has more than one active session:\n<%= config.bin %> <%= command.id %> --utterance \"what can you help me with?\" --authoring-bundle My_Local_Agent"
|
|
1271
1290
|
],
|
|
1272
1291
|
"flags": {
|
|
1273
1292
|
"json": {
|
|
@@ -1302,57 +1321,103 @@
|
|
|
1302
1321
|
"multiple": false,
|
|
1303
1322
|
"type": "option"
|
|
1304
1323
|
},
|
|
1305
|
-
"
|
|
1306
|
-
"
|
|
1307
|
-
"
|
|
1324
|
+
"session-id": {
|
|
1325
|
+
"name": "session-id",
|
|
1326
|
+
"required": false,
|
|
1327
|
+
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see list of all sessions.",
|
|
1328
|
+
"hasDynamicHelp": false,
|
|
1329
|
+
"multiple": false,
|
|
1330
|
+
"type": "option"
|
|
1331
|
+
},
|
|
1332
|
+
"utterance": {
|
|
1333
|
+
"char": "u",
|
|
1334
|
+
"name": "utterance",
|
|
1308
1335
|
"required": true,
|
|
1309
|
-
"summary": "
|
|
1336
|
+
"summary": "Utterance to send to the agent, enclosed in double quotes.",
|
|
1310
1337
|
"hasDynamicHelp": false,
|
|
1311
1338
|
"multiple": false,
|
|
1312
1339
|
"type": "option"
|
|
1313
1340
|
},
|
|
1314
|
-
"
|
|
1315
|
-
"
|
|
1316
|
-
"
|
|
1317
|
-
"
|
|
1318
|
-
"
|
|
1341
|
+
"api-name": {
|
|
1342
|
+
"char": "n",
|
|
1343
|
+
"name": "api-name",
|
|
1344
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
1345
|
+
"hasDynamicHelp": false,
|
|
1346
|
+
"multiple": false,
|
|
1347
|
+
"type": "option"
|
|
1348
|
+
},
|
|
1349
|
+
"authoring-bundle": {
|
|
1350
|
+
"name": "authoring-bundle",
|
|
1351
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1352
|
+
"hasDynamicHelp": false,
|
|
1353
|
+
"multiple": false,
|
|
1354
|
+
"type": "option"
|
|
1319
1355
|
}
|
|
1320
1356
|
},
|
|
1321
1357
|
"hasDynamicHelp": true,
|
|
1322
1358
|
"hiddenAliases": [],
|
|
1323
|
-
"id": "agent:
|
|
1359
|
+
"id": "agent:preview:send",
|
|
1324
1360
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1325
1361
|
"pluginName": "@salesforce/plugin-agent",
|
|
1326
1362
|
"pluginType": "core",
|
|
1327
|
-
"state": "preview",
|
|
1328
1363
|
"strict": true,
|
|
1329
|
-
"summary": "
|
|
1364
|
+
"summary": "Send a message to an existing agent preview session.",
|
|
1330
1365
|
"enableJsonFlag": true,
|
|
1366
|
+
"requiresProject": true,
|
|
1367
|
+
"envVariablesSection": {
|
|
1368
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1369
|
+
"body": [
|
|
1370
|
+
{
|
|
1371
|
+
"name": "SF_TARGET_ORG",
|
|
1372
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1373
|
+
}
|
|
1374
|
+
]
|
|
1375
|
+
},
|
|
1376
|
+
"errorCodes": {
|
|
1377
|
+
"header": "ERROR CODES",
|
|
1378
|
+
"body": [
|
|
1379
|
+
{
|
|
1380
|
+
"name": "Succeeded (0)",
|
|
1381
|
+
"description": "Message sent successfully and agent response received."
|
|
1382
|
+
},
|
|
1383
|
+
{
|
|
1384
|
+
"name": "NotFound (2)",
|
|
1385
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
1386
|
+
},
|
|
1387
|
+
{
|
|
1388
|
+
"name": "PreviewSendFailed (4)",
|
|
1389
|
+
"description": "Failed to send message or receive response from the preview session."
|
|
1390
|
+
},
|
|
1391
|
+
{
|
|
1392
|
+
"name": "SessionAmbiguous (5)",
|
|
1393
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
1394
|
+
}
|
|
1395
|
+
]
|
|
1396
|
+
},
|
|
1331
1397
|
"isESM": true,
|
|
1332
1398
|
"relativePath": [
|
|
1333
1399
|
"lib",
|
|
1334
1400
|
"commands",
|
|
1335
1401
|
"agent",
|
|
1336
|
-
"
|
|
1337
|
-
"
|
|
1402
|
+
"preview",
|
|
1403
|
+
"send.js"
|
|
1338
1404
|
],
|
|
1339
1405
|
"aliasPermutations": [],
|
|
1340
1406
|
"permutations": [
|
|
1341
|
-
"agent:
|
|
1342
|
-
"
|
|
1343
|
-
"
|
|
1344
|
-
"agent:
|
|
1345
|
-
"
|
|
1346
|
-
"
|
|
1407
|
+
"agent:preview:send",
|
|
1408
|
+
"preview:agent:send",
|
|
1409
|
+
"preview:send:agent",
|
|
1410
|
+
"agent:send:preview",
|
|
1411
|
+
"send:agent:preview",
|
|
1412
|
+
"send:preview:agent"
|
|
1347
1413
|
]
|
|
1348
1414
|
},
|
|
1349
|
-
"agent:
|
|
1415
|
+
"agent:preview:sessions": {
|
|
1350
1416
|
"aliases": [],
|
|
1351
1417
|
"args": {},
|
|
1352
|
-
"description": "
|
|
1418
|
+
"description": "This command lists the agent preview sessions that were started with the \"agent preview start\" command and are still in the local cache. Use this command to discover specific session IDs that you can pass to the \"agent preview send\" or \"agent preview end\" commands with the --session-id flag.\n\nProgrammatic agent preview sessions can be started for both published activated agents and by using an agent's local authoring bundle, which contains its Agent Script file. In this command's output table, the Agent column contains either the API name of the authoring bundle or the published agent, whichever was used when starting the session. In the table, if the same API name has multiple rows with different session IDs, then it means that you previously started multiple preview sessions with the associated agent.",
|
|
1353
1419
|
"examples": [
|
|
1354
|
-
"
|
|
1355
|
-
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
1420
|
+
"List all cached agent preview sessions:\n<%= config.bin %> <%= command.id %>"
|
|
1356
1421
|
],
|
|
1357
1422
|
"flags": {
|
|
1358
1423
|
"json": {
|
|
@@ -1369,69 +1434,53 @@
|
|
|
1369
1434
|
"hasDynamicHelp": false,
|
|
1370
1435
|
"multiple": false,
|
|
1371
1436
|
"type": "option"
|
|
1372
|
-
},
|
|
1373
|
-
"target-org": {
|
|
1374
|
-
"char": "o",
|
|
1375
|
-
"name": "target-org",
|
|
1376
|
-
"noCacheDefault": true,
|
|
1377
|
-
"required": true,
|
|
1378
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1379
|
-
"hasDynamicHelp": true,
|
|
1380
|
-
"multiple": false,
|
|
1381
|
-
"type": "option"
|
|
1382
|
-
},
|
|
1383
|
-
"api-version": {
|
|
1384
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1385
|
-
"name": "api-version",
|
|
1386
|
-
"hasDynamicHelp": false,
|
|
1387
|
-
"multiple": false,
|
|
1388
|
-
"type": "option"
|
|
1389
|
-
},
|
|
1390
|
-
"mcp-server-id": {
|
|
1391
|
-
"char": "i",
|
|
1392
|
-
"name": "mcp-server-id",
|
|
1393
|
-
"required": true,
|
|
1394
|
-
"summary": "ID of the MCP server to fetch assets from.",
|
|
1395
|
-
"hasDynamicHelp": false,
|
|
1396
|
-
"multiple": false,
|
|
1397
|
-
"type": "option"
|
|
1398
1437
|
}
|
|
1399
1438
|
},
|
|
1400
|
-
"hasDynamicHelp":
|
|
1439
|
+
"hasDynamicHelp": false,
|
|
1401
1440
|
"hiddenAliases": [],
|
|
1402
|
-
"id": "agent:
|
|
1441
|
+
"id": "agent:preview:sessions",
|
|
1403
1442
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1404
1443
|
"pluginName": "@salesforce/plugin-agent",
|
|
1405
1444
|
"pluginType": "core",
|
|
1406
|
-
"state": "preview",
|
|
1407
1445
|
"strict": true,
|
|
1408
|
-
"summary": "
|
|
1446
|
+
"summary": "List all known programmatic agent preview sessions.",
|
|
1409
1447
|
"enableJsonFlag": true,
|
|
1448
|
+
"requiresProject": true,
|
|
1449
|
+
"errorCodes": {
|
|
1450
|
+
"header": "ERROR CODES",
|
|
1451
|
+
"body": [
|
|
1452
|
+
{
|
|
1453
|
+
"name": "Succeeded (0)",
|
|
1454
|
+
"description": "Sessions listed successfully (or empty list if no active sessions)."
|
|
1455
|
+
}
|
|
1456
|
+
]
|
|
1457
|
+
},
|
|
1410
1458
|
"isESM": true,
|
|
1411
1459
|
"relativePath": [
|
|
1412
1460
|
"lib",
|
|
1413
1461
|
"commands",
|
|
1414
1462
|
"agent",
|
|
1415
|
-
"
|
|
1416
|
-
"
|
|
1463
|
+
"preview",
|
|
1464
|
+
"sessions.js"
|
|
1417
1465
|
],
|
|
1418
1466
|
"aliasPermutations": [],
|
|
1419
1467
|
"permutations": [
|
|
1420
|
-
"agent:
|
|
1421
|
-
"
|
|
1422
|
-
"
|
|
1423
|
-
"agent:
|
|
1424
|
-
"
|
|
1425
|
-
"
|
|
1468
|
+
"agent:preview:sessions",
|
|
1469
|
+
"preview:agent:sessions",
|
|
1470
|
+
"preview:sessions:agent",
|
|
1471
|
+
"agent:sessions:preview",
|
|
1472
|
+
"sessions:agent:preview",
|
|
1473
|
+
"sessions:preview:agent"
|
|
1426
1474
|
]
|
|
1427
1475
|
},
|
|
1428
|
-
"agent:
|
|
1476
|
+
"agent:preview:start": {
|
|
1429
1477
|
"aliases": [],
|
|
1430
1478
|
"args": {},
|
|
1431
|
-
"description": "
|
|
1479
|
+
"description": "This command outputs a session ID that you then use with the \"agent preview send\" command to send an utterance to the agent. Use the \"agent preview sessions\" command to list all active sessions and the \"agent preview end\" command to end a specific session.\n\nIdentify the agent you want to start previewing with either the --authoring-bundle flag to specify a local authoring bundle's API name or --api-name to specify an activated published agent's API name. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.\n\nWhen starting a preview session with --authoring-bundle, you must explicitly specify the execution mode using one of these flags:\n\n- --use-live-actions: Executes real Apex classes, flows, and other actions in the org. This surfaces compile and validation errors during preview.\n- --simulate-actions: Uses AI to simulate action execution without calling real implementations.\n\nPublished agents (--api-name) always use live actions. The mode flags are optional and have no effect for published agents.",
|
|
1432
1480
|
"examples": [
|
|
1433
|
-
"
|
|
1434
|
-
"
|
|
1481
|
+
"Start a programmatic agent preview session by specifying an authoring bundle; use simulated actions. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --target-org my-dev-org --simulate-actions",
|
|
1482
|
+
"Similar to previous example but use live actions and the default org:\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --use-live-actions",
|
|
1483
|
+
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
1435
1484
|
],
|
|
1436
1485
|
"flags": {
|
|
1437
1486
|
"json": {
|
|
@@ -1466,11 +1515,55 @@
|
|
|
1466
1515
|
"multiple": false,
|
|
1467
1516
|
"type": "option"
|
|
1468
1517
|
},
|
|
1469
|
-
"
|
|
1470
|
-
"char": "
|
|
1471
|
-
"name": "
|
|
1472
|
-
"
|
|
1473
|
-
"
|
|
1518
|
+
"api-name": {
|
|
1519
|
+
"char": "n",
|
|
1520
|
+
"name": "api-name",
|
|
1521
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
1522
|
+
"hasDynamicHelp": false,
|
|
1523
|
+
"multiple": false,
|
|
1524
|
+
"type": "option"
|
|
1525
|
+
},
|
|
1526
|
+
"authoring-bundle": {
|
|
1527
|
+
"name": "authoring-bundle",
|
|
1528
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1529
|
+
"hasDynamicHelp": false,
|
|
1530
|
+
"multiple": false,
|
|
1531
|
+
"type": "option"
|
|
1532
|
+
},
|
|
1533
|
+
"use-live-actions": {
|
|
1534
|
+
"exclusive": [
|
|
1535
|
+
"simulate-actions"
|
|
1536
|
+
],
|
|
1537
|
+
"name": "use-live-actions",
|
|
1538
|
+
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
1539
|
+
"allowNo": false,
|
|
1540
|
+
"type": "boolean"
|
|
1541
|
+
},
|
|
1542
|
+
"simulate-actions": {
|
|
1543
|
+
"exclusive": [
|
|
1544
|
+
"use-live-actions"
|
|
1545
|
+
],
|
|
1546
|
+
"name": "simulate-actions",
|
|
1547
|
+
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
1548
|
+
"allowNo": false,
|
|
1549
|
+
"type": "boolean"
|
|
1550
|
+
},
|
|
1551
|
+
"context-variables": {
|
|
1552
|
+
"description": "Sets variables on the agent preview session, mirroring what the in-org Agentforce Builder UI does when you override variables before sending a message. Specify this flag multiple times or use comma-separated values. Two namespaces are supported, distinguished by the name shape. Names pass through to the runtime verbatim — the CLI doesn't transform them.\n\nLinked context variables use the \"$Context.\" prefix. These map to externally-provided fields that the runtime resolves (declared in the bundle's globalConfiguration.contextVariables) and are read by live actions and topic-routing expressions via $Context.Name. Example: $Context.MyLinkedVar=some-value.\n\nState variables use the bare developerName, no prefix. These seed mutable agent state declared in agentVersion.stateVariables. Example: MyStateVar=some-value.\n\nBoth namespaces can be mixed in one value. Example: --context-variables '$Context.MyLinkedVar=foo,MyStateVar=bar'.\n\nTips: (1) Quote the whole value in single quotes so $Context isn't shell-expanded. (2) Names are sent verbatim — a bare name is treated as a state variable, not a linked context variable, so live actions that bind via $Context.Name will see null. (3) Type defaults to Text.",
|
|
1553
|
+
"name": "context-variables",
|
|
1554
|
+
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
1555
|
+
"delimiter": ",",
|
|
1556
|
+
"hasDynamicHelp": false,
|
|
1557
|
+
"multiple": true,
|
|
1558
|
+
"type": "option"
|
|
1559
|
+
},
|
|
1560
|
+
"agent-json": {
|
|
1561
|
+
"dependsOn": [
|
|
1562
|
+
"authoring-bundle"
|
|
1563
|
+
],
|
|
1564
|
+
"hidden": true,
|
|
1565
|
+
"name": "agent-json",
|
|
1566
|
+
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
1474
1567
|
"hasDynamicHelp": false,
|
|
1475
1568
|
"multiple": false,
|
|
1476
1569
|
"type": "option"
|
|
@@ -1478,39 +1571,73 @@
|
|
|
1478
1571
|
},
|
|
1479
1572
|
"hasDynamicHelp": true,
|
|
1480
1573
|
"hiddenAliases": [],
|
|
1481
|
-
"id": "agent:
|
|
1574
|
+
"id": "agent:preview:start",
|
|
1482
1575
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1483
1576
|
"pluginName": "@salesforce/plugin-agent",
|
|
1484
1577
|
"pluginType": "core",
|
|
1485
|
-
"state": "preview",
|
|
1486
1578
|
"strict": true,
|
|
1487
|
-
"summary": "
|
|
1579
|
+
"summary": "Start a programmatic agent preview session.",
|
|
1488
1580
|
"enableJsonFlag": true,
|
|
1581
|
+
"requiresProject": true,
|
|
1582
|
+
"envVariablesSection": {
|
|
1583
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1584
|
+
"body": [
|
|
1585
|
+
{
|
|
1586
|
+
"name": "SF_TARGET_ORG",
|
|
1587
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1588
|
+
}
|
|
1589
|
+
]
|
|
1590
|
+
},
|
|
1591
|
+
"errorCodes": {
|
|
1592
|
+
"header": "ERROR CODES",
|
|
1593
|
+
"body": [
|
|
1594
|
+
{
|
|
1595
|
+
"name": "Succeeded (0)",
|
|
1596
|
+
"description": "Preview session started successfully."
|
|
1597
|
+
},
|
|
1598
|
+
{
|
|
1599
|
+
"name": "Failed (1)",
|
|
1600
|
+
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
1601
|
+
},
|
|
1602
|
+
{
|
|
1603
|
+
"name": "NotFound (2)",
|
|
1604
|
+
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
1605
|
+
},
|
|
1606
|
+
{
|
|
1607
|
+
"name": "ServerError (3)",
|
|
1608
|
+
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
1609
|
+
},
|
|
1610
|
+
{
|
|
1611
|
+
"name": "PreviewStartFailed (4)",
|
|
1612
|
+
"description": "Preview session failed to start due to API or network errors."
|
|
1613
|
+
}
|
|
1614
|
+
]
|
|
1615
|
+
},
|
|
1489
1616
|
"isESM": true,
|
|
1490
1617
|
"relativePath": [
|
|
1491
1618
|
"lib",
|
|
1492
1619
|
"commands",
|
|
1493
1620
|
"agent",
|
|
1494
|
-
"
|
|
1495
|
-
"
|
|
1621
|
+
"preview",
|
|
1622
|
+
"start.js"
|
|
1496
1623
|
],
|
|
1497
1624
|
"aliasPermutations": [],
|
|
1498
1625
|
"permutations": [
|
|
1499
|
-
"agent:
|
|
1500
|
-
"
|
|
1501
|
-
"
|
|
1502
|
-
"agent:
|
|
1503
|
-
"
|
|
1504
|
-
"
|
|
1626
|
+
"agent:preview:start",
|
|
1627
|
+
"preview:agent:start",
|
|
1628
|
+
"preview:start:agent",
|
|
1629
|
+
"agent:start:preview",
|
|
1630
|
+
"start:agent:preview",
|
|
1631
|
+
"start:preview:agent"
|
|
1505
1632
|
]
|
|
1506
1633
|
},
|
|
1507
|
-
"agent:mcp:
|
|
1634
|
+
"agent:mcp:create": {
|
|
1508
1635
|
"aliases": [],
|
|
1509
1636
|
"args": {},
|
|
1510
|
-
"description": "
|
|
1637
|
+
"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.",
|
|
1511
1638
|
"examples": [
|
|
1512
|
-
"
|
|
1513
|
-
"
|
|
1639
|
+
"Create an MCP server with no authentication:\n<%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --target-org myOrg",
|
|
1640
|
+
"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"
|
|
1514
1641
|
],
|
|
1515
1642
|
"flags": {
|
|
1516
1643
|
"json": {
|
|
@@ -1545,70 +1672,113 @@
|
|
|
1545
1672
|
"multiple": false,
|
|
1546
1673
|
"type": "option"
|
|
1547
1674
|
},
|
|
1675
|
+
"name": {
|
|
1676
|
+
"char": "n",
|
|
1677
|
+
"name": "name",
|
|
1678
|
+
"required": true,
|
|
1679
|
+
"summary": "Unique name of the MCP server.",
|
|
1680
|
+
"hasDynamicHelp": false,
|
|
1681
|
+
"multiple": false,
|
|
1682
|
+
"type": "option"
|
|
1683
|
+
},
|
|
1548
1684
|
"label": {
|
|
1549
1685
|
"name": "label",
|
|
1550
|
-
"summary": "
|
|
1686
|
+
"summary": "Human-readable label for the MCP server.",
|
|
1551
1687
|
"hasDynamicHelp": false,
|
|
1552
1688
|
"multiple": false,
|
|
1553
1689
|
"type": "option"
|
|
1554
1690
|
},
|
|
1555
|
-
"
|
|
1556
|
-
"name": "
|
|
1557
|
-
"summary": "
|
|
1691
|
+
"description": {
|
|
1692
|
+
"name": "description",
|
|
1693
|
+
"summary": "Description of the MCP server.",
|
|
1558
1694
|
"hasDynamicHelp": false,
|
|
1559
1695
|
"multiple": false,
|
|
1560
|
-
"options": [
|
|
1561
|
-
"EXTERNAL"
|
|
1562
|
-
],
|
|
1563
1696
|
"type": "option"
|
|
1564
1697
|
},
|
|
1565
|
-
"
|
|
1566
|
-
"name": "
|
|
1567
|
-
"
|
|
1698
|
+
"server-url": {
|
|
1699
|
+
"name": "server-url",
|
|
1700
|
+
"required": true,
|
|
1701
|
+
"summary": "URL of the external MCP server.",
|
|
1702
|
+
"hasDynamicHelp": false,
|
|
1703
|
+
"multiple": false,
|
|
1704
|
+
"type": "option"
|
|
1705
|
+
},
|
|
1706
|
+
"auth-type": {
|
|
1707
|
+
"name": "auth-type",
|
|
1708
|
+
"summary": "Authorization type to use when connecting to the MCP server.",
|
|
1709
|
+
"default": "NO_AUTH",
|
|
1568
1710
|
"hasDynamicHelp": false,
|
|
1569
1711
|
"multiple": false,
|
|
1570
1712
|
"options": [
|
|
1571
|
-
"
|
|
1572
|
-
"
|
|
1713
|
+
"OAUTH",
|
|
1714
|
+
"NO_AUTH"
|
|
1573
1715
|
],
|
|
1574
1716
|
"type": "option"
|
|
1575
|
-
}
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
|
|
1583
|
-
|
|
1584
|
-
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
|
|
1590
|
-
"
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
|
|
1596
|
-
|
|
1597
|
-
"
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
|
|
1717
|
+
},
|
|
1718
|
+
"identity-provider": {
|
|
1719
|
+
"name": "identity-provider",
|
|
1720
|
+
"summary": "Identity provider to use for OAuth authorization. Required when auth-type is OAUTH.",
|
|
1721
|
+
"hasDynamicHelp": false,
|
|
1722
|
+
"multiple": false,
|
|
1723
|
+
"type": "option"
|
|
1724
|
+
},
|
|
1725
|
+
"client-id": {
|
|
1726
|
+
"name": "client-id",
|
|
1727
|
+
"summary": "OAuth client ID. Required when auth-type is OAUTH.",
|
|
1728
|
+
"hasDynamicHelp": false,
|
|
1729
|
+
"multiple": false,
|
|
1730
|
+
"type": "option"
|
|
1731
|
+
},
|
|
1732
|
+
"client-secret": {
|
|
1733
|
+
"name": "client-secret",
|
|
1734
|
+
"summary": "OAuth client secret. Required when auth-type is OAUTH. Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
1735
|
+
"hasDynamicHelp": false,
|
|
1736
|
+
"multiple": false,
|
|
1737
|
+
"type": "option"
|
|
1738
|
+
},
|
|
1739
|
+
"scope": {
|
|
1740
|
+
"name": "scope",
|
|
1741
|
+
"summary": "OAuth scope to request. Required when auth-type is OAUTH.",
|
|
1742
|
+
"hasDynamicHelp": false,
|
|
1743
|
+
"multiple": false,
|
|
1744
|
+
"type": "option"
|
|
1745
|
+
}
|
|
1746
|
+
},
|
|
1747
|
+
"hasDynamicHelp": true,
|
|
1748
|
+
"hiddenAliases": [],
|
|
1749
|
+
"id": "agent:mcp:create",
|
|
1750
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
1751
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
1752
|
+
"pluginType": "core",
|
|
1753
|
+
"state": "preview",
|
|
1754
|
+
"strict": true,
|
|
1755
|
+
"summary": "Create an MCP server in the API Catalog.",
|
|
1756
|
+
"enableJsonFlag": true,
|
|
1757
|
+
"isESM": true,
|
|
1758
|
+
"relativePath": [
|
|
1759
|
+
"lib",
|
|
1760
|
+
"commands",
|
|
1761
|
+
"agent",
|
|
1762
|
+
"mcp",
|
|
1763
|
+
"create.js"
|
|
1764
|
+
],
|
|
1765
|
+
"aliasPermutations": [],
|
|
1766
|
+
"permutations": [
|
|
1767
|
+
"agent:mcp:create",
|
|
1768
|
+
"mcp:agent:create",
|
|
1769
|
+
"mcp:create:agent",
|
|
1770
|
+
"agent:create:mcp",
|
|
1771
|
+
"create:agent:mcp",
|
|
1772
|
+
"create:mcp:agent"
|
|
1603
1773
|
]
|
|
1604
1774
|
},
|
|
1605
|
-
"agent:mcp:
|
|
1775
|
+
"agent:mcp:delete": {
|
|
1606
1776
|
"aliases": [],
|
|
1607
1777
|
"args": {},
|
|
1608
|
-
"description": "
|
|
1778
|
+
"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).",
|
|
1609
1779
|
"examples": [
|
|
1610
|
-
"
|
|
1611
|
-
"
|
|
1780
|
+
"Delete an MCP server, confirming interactively:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg",
|
|
1781
|
+
"Delete an MCP server without a confirmation prompt:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg --no-prompt"
|
|
1612
1782
|
],
|
|
1613
1783
|
"flags": {
|
|
1614
1784
|
"json": {
|
|
@@ -1647,81 +1817,27 @@
|
|
|
1647
1817
|
"char": "i",
|
|
1648
1818
|
"name": "mcp-server-id",
|
|
1649
1819
|
"required": true,
|
|
1650
|
-
"summary": "ID of the MCP server to
|
|
1651
|
-
"hasDynamicHelp": false,
|
|
1652
|
-
"multiple": false,
|
|
1653
|
-
"type": "option"
|
|
1654
|
-
},
|
|
1655
|
-
"label": {
|
|
1656
|
-
"name": "label",
|
|
1657
|
-
"summary": "New display label for the MCP server.",
|
|
1658
|
-
"hasDynamicHelp": false,
|
|
1659
|
-
"multiple": false,
|
|
1660
|
-
"type": "option"
|
|
1661
|
-
},
|
|
1662
|
-
"description": {
|
|
1663
|
-
"name": "description",
|
|
1664
|
-
"summary": "New description for the MCP server.",
|
|
1665
|
-
"hasDynamicHelp": false,
|
|
1666
|
-
"multiple": false,
|
|
1667
|
-
"type": "option"
|
|
1668
|
-
},
|
|
1669
|
-
"server-url": {
|
|
1670
|
-
"name": "server-url",
|
|
1671
|
-
"summary": "New endpoint URL of the MCP server.",
|
|
1672
|
-
"hasDynamicHelp": false,
|
|
1673
|
-
"multiple": false,
|
|
1674
|
-
"type": "option"
|
|
1675
|
-
},
|
|
1676
|
-
"auth-type": {
|
|
1677
|
-
"name": "auth-type",
|
|
1678
|
-
"summary": "Authorization type to apply to the MCP server (OAUTH or NO_AUTH).",
|
|
1679
|
-
"hasDynamicHelp": false,
|
|
1680
|
-
"multiple": false,
|
|
1681
|
-
"options": [
|
|
1682
|
-
"OAUTH",
|
|
1683
|
-
"NO_AUTH"
|
|
1684
|
-
],
|
|
1685
|
-
"type": "option"
|
|
1686
|
-
},
|
|
1687
|
-
"identity-provider": {
|
|
1688
|
-
"name": "identity-provider",
|
|
1689
|
-
"summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
|
|
1690
|
-
"hasDynamicHelp": false,
|
|
1691
|
-
"multiple": false,
|
|
1692
|
-
"type": "option"
|
|
1693
|
-
},
|
|
1694
|
-
"client-id": {
|
|
1695
|
-
"name": "client-id",
|
|
1696
|
-
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
1697
|
-
"hasDynamicHelp": false,
|
|
1698
|
-
"multiple": false,
|
|
1699
|
-
"type": "option"
|
|
1700
|
-
},
|
|
1701
|
-
"client-secret": {
|
|
1702
|
-
"name": "client-secret",
|
|
1703
|
-
"summary": "OAuth client secret (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
1820
|
+
"summary": "ID of the MCP server to delete.",
|
|
1704
1821
|
"hasDynamicHelp": false,
|
|
1705
1822
|
"multiple": false,
|
|
1706
1823
|
"type": "option"
|
|
1707
1824
|
},
|
|
1708
|
-
"
|
|
1709
|
-
"name": "
|
|
1710
|
-
"summary": "
|
|
1711
|
-
"
|
|
1712
|
-
"
|
|
1713
|
-
"type": "option"
|
|
1825
|
+
"no-prompt": {
|
|
1826
|
+
"name": "no-prompt",
|
|
1827
|
+
"summary": "Skip the confirmation prompt and delete the MCP server immediately.",
|
|
1828
|
+
"allowNo": false,
|
|
1829
|
+
"type": "boolean"
|
|
1714
1830
|
}
|
|
1715
1831
|
},
|
|
1716
1832
|
"hasDynamicHelp": true,
|
|
1717
1833
|
"hiddenAliases": [],
|
|
1718
|
-
"id": "agent:mcp:
|
|
1834
|
+
"id": "agent:mcp:delete",
|
|
1719
1835
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1720
1836
|
"pluginName": "@salesforce/plugin-agent",
|
|
1721
1837
|
"pluginType": "core",
|
|
1722
1838
|
"state": "preview",
|
|
1723
1839
|
"strict": true,
|
|
1724
|
-
"summary": "
|
|
1840
|
+
"summary": "Delete an MCP server from the API Catalog.",
|
|
1725
1841
|
"enableJsonFlag": true,
|
|
1726
1842
|
"isESM": true,
|
|
1727
1843
|
"relativePath": [
|
|
@@ -1729,28 +1845,25 @@
|
|
|
1729
1845
|
"commands",
|
|
1730
1846
|
"agent",
|
|
1731
1847
|
"mcp",
|
|
1732
|
-
"
|
|
1848
|
+
"delete.js"
|
|
1733
1849
|
],
|
|
1734
1850
|
"aliasPermutations": [],
|
|
1735
1851
|
"permutations": [
|
|
1736
|
-
"agent:mcp:
|
|
1737
|
-
"mcp:agent:
|
|
1738
|
-
"mcp:
|
|
1739
|
-
"agent:
|
|
1740
|
-
"
|
|
1741
|
-
"
|
|
1852
|
+
"agent:mcp:delete",
|
|
1853
|
+
"mcp:agent:delete",
|
|
1854
|
+
"mcp:delete:agent",
|
|
1855
|
+
"agent:delete:mcp",
|
|
1856
|
+
"delete:agent:mcp",
|
|
1857
|
+
"delete:mcp:agent"
|
|
1742
1858
|
]
|
|
1743
1859
|
},
|
|
1744
|
-
"agent:
|
|
1860
|
+
"agent:mcp:fetch": {
|
|
1745
1861
|
"aliases": [],
|
|
1746
1862
|
"args": {},
|
|
1747
|
-
"description": "
|
|
1863
|
+
"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.",
|
|
1748
1864
|
"examples": [
|
|
1749
|
-
"
|
|
1750
|
-
"
|
|
1751
|
-
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
1752
|
-
"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\"",
|
|
1753
|
-
"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"
|
|
1865
|
+
"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",
|
|
1866
|
+
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
1754
1867
|
],
|
|
1755
1868
|
"flags": {
|
|
1756
1869
|
"json": {
|
|
@@ -1785,164 +1898,130 @@
|
|
|
1785
1898
|
"multiple": false,
|
|
1786
1899
|
"type": "option"
|
|
1787
1900
|
},
|
|
1788
|
-
"
|
|
1789
|
-
"
|
|
1790
|
-
"
|
|
1901
|
+
"mcp-server-id": {
|
|
1902
|
+
"char": "i",
|
|
1903
|
+
"name": "mcp-server-id",
|
|
1904
|
+
"required": true,
|
|
1905
|
+
"summary": "ID of the MCP server to fetch assets from.",
|
|
1791
1906
|
"hasDynamicHelp": false,
|
|
1792
1907
|
"multiple": false,
|
|
1793
|
-
"options": [
|
|
1794
|
-
"customer",
|
|
1795
|
-
"internal"
|
|
1796
|
-
],
|
|
1797
1908
|
"type": "option"
|
|
1909
|
+
}
|
|
1910
|
+
},
|
|
1911
|
+
"hasDynamicHelp": true,
|
|
1912
|
+
"hiddenAliases": [],
|
|
1913
|
+
"id": "agent:mcp:fetch",
|
|
1914
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
1915
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
1916
|
+
"pluginType": "core",
|
|
1917
|
+
"state": "preview",
|
|
1918
|
+
"strict": true,
|
|
1919
|
+
"summary": "Fetch the live assets (tools, prompts, resources) advertised by an MCP server.",
|
|
1920
|
+
"enableJsonFlag": true,
|
|
1921
|
+
"isESM": true,
|
|
1922
|
+
"relativePath": [
|
|
1923
|
+
"lib",
|
|
1924
|
+
"commands",
|
|
1925
|
+
"agent",
|
|
1926
|
+
"mcp",
|
|
1927
|
+
"fetch.js"
|
|
1928
|
+
],
|
|
1929
|
+
"aliasPermutations": [],
|
|
1930
|
+
"permutations": [
|
|
1931
|
+
"agent:mcp:fetch",
|
|
1932
|
+
"mcp:agent:fetch",
|
|
1933
|
+
"mcp:fetch:agent",
|
|
1934
|
+
"agent:fetch:mcp",
|
|
1935
|
+
"fetch:agent:mcp",
|
|
1936
|
+
"fetch:mcp:agent"
|
|
1937
|
+
]
|
|
1938
|
+
},
|
|
1939
|
+
"agent:mcp:get": {
|
|
1940
|
+
"aliases": [],
|
|
1941
|
+
"args": {},
|
|
1942
|
+
"description": "Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.",
|
|
1943
|
+
"examples": [
|
|
1944
|
+
"Get an MCP server by id in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001",
|
|
1945
|
+
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
1946
|
+
],
|
|
1947
|
+
"flags": {
|
|
1948
|
+
"json": {
|
|
1949
|
+
"description": "Format output as json.",
|
|
1950
|
+
"helpGroup": "GLOBAL",
|
|
1951
|
+
"name": "json",
|
|
1952
|
+
"allowNo": false,
|
|
1953
|
+
"type": "boolean"
|
|
1798
1954
|
},
|
|
1799
|
-
"
|
|
1800
|
-
"
|
|
1801
|
-
"
|
|
1955
|
+
"flags-dir": {
|
|
1956
|
+
"helpGroup": "GLOBAL",
|
|
1957
|
+
"name": "flags-dir",
|
|
1958
|
+
"summary": "Import flag values from a directory.",
|
|
1802
1959
|
"hasDynamicHelp": false,
|
|
1803
1960
|
"multiple": false,
|
|
1804
1961
|
"type": "option"
|
|
1805
1962
|
},
|
|
1806
|
-
"
|
|
1807
|
-
"
|
|
1808
|
-
"
|
|
1809
|
-
"
|
|
1963
|
+
"target-org": {
|
|
1964
|
+
"char": "o",
|
|
1965
|
+
"name": "target-org",
|
|
1966
|
+
"noCacheDefault": true,
|
|
1967
|
+
"required": true,
|
|
1968
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1969
|
+
"hasDynamicHelp": true,
|
|
1810
1970
|
"multiple": false,
|
|
1811
1971
|
"type": "option"
|
|
1812
1972
|
},
|
|
1813
|
-
"
|
|
1814
|
-
"
|
|
1815
|
-
"
|
|
1973
|
+
"api-version": {
|
|
1974
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1975
|
+
"name": "api-version",
|
|
1816
1976
|
"hasDynamicHelp": false,
|
|
1817
1977
|
"multiple": false,
|
|
1818
1978
|
"type": "option"
|
|
1819
1979
|
},
|
|
1820
|
-
"
|
|
1821
|
-
"
|
|
1822
|
-
"
|
|
1980
|
+
"mcp-server-id": {
|
|
1981
|
+
"char": "i",
|
|
1982
|
+
"name": "mcp-server-id",
|
|
1983
|
+
"required": true,
|
|
1984
|
+
"summary": "The identifier of the MCP server to retrieve.",
|
|
1823
1985
|
"hasDynamicHelp": false,
|
|
1824
1986
|
"multiple": false,
|
|
1825
1987
|
"type": "option"
|
|
1826
|
-
},
|
|
1827
|
-
"max-topics": {
|
|
1828
|
-
"name": "max-topics",
|
|
1829
|
-
"summary": "Maximum number of topics to generate in the agent spec; default is 5.",
|
|
1830
|
-
"hasDynamicHelp": false,
|
|
1831
|
-
"multiple": false,
|
|
1832
|
-
"type": "option"
|
|
1833
|
-
},
|
|
1834
|
-
"agent-user": {
|
|
1835
|
-
"name": "agent-user",
|
|
1836
|
-
"summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
|
|
1837
|
-
"hasDynamicHelp": false,
|
|
1838
|
-
"multiple": false,
|
|
1839
|
-
"type": "option"
|
|
1840
|
-
},
|
|
1841
|
-
"enrich-logs": {
|
|
1842
|
-
"name": "enrich-logs",
|
|
1843
|
-
"summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
|
|
1844
|
-
"hasDynamicHelp": false,
|
|
1845
|
-
"multiple": false,
|
|
1846
|
-
"options": [
|
|
1847
|
-
"true",
|
|
1848
|
-
"false"
|
|
1849
|
-
],
|
|
1850
|
-
"type": "option"
|
|
1851
|
-
},
|
|
1852
|
-
"tone": {
|
|
1853
|
-
"name": "tone",
|
|
1854
|
-
"summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
|
|
1855
|
-
"hasDynamicHelp": false,
|
|
1856
|
-
"multiple": false,
|
|
1857
|
-
"options": [
|
|
1858
|
-
"formal",
|
|
1859
|
-
"casual",
|
|
1860
|
-
"neutral"
|
|
1861
|
-
],
|
|
1862
|
-
"type": "option"
|
|
1863
|
-
},
|
|
1864
|
-
"spec": {
|
|
1865
|
-
"name": "spec",
|
|
1866
|
-
"summary": "Agent spec file, in YAML format, to use as input to the command.",
|
|
1867
|
-
"hasDynamicHelp": false,
|
|
1868
|
-
"multiple": false,
|
|
1869
|
-
"type": "option"
|
|
1870
|
-
},
|
|
1871
|
-
"output-file": {
|
|
1872
|
-
"name": "output-file",
|
|
1873
|
-
"summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
|
|
1874
|
-
"default": "specs/agentSpec.yaml",
|
|
1875
|
-
"hasDynamicHelp": false,
|
|
1876
|
-
"multiple": false,
|
|
1877
|
-
"type": "option"
|
|
1878
|
-
},
|
|
1879
|
-
"full-interview": {
|
|
1880
|
-
"name": "full-interview",
|
|
1881
|
-
"summary": "Prompt for both required and optional flags.",
|
|
1882
|
-
"allowNo": false,
|
|
1883
|
-
"type": "boolean"
|
|
1884
|
-
},
|
|
1885
|
-
"prompt-template": {
|
|
1886
|
-
"name": "prompt-template",
|
|
1887
|
-
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
1888
|
-
"hasDynamicHelp": false,
|
|
1889
|
-
"multiple": false,
|
|
1890
|
-
"type": "option"
|
|
1891
|
-
},
|
|
1892
|
-
"grounding-context": {
|
|
1893
|
-
"dependsOn": [
|
|
1894
|
-
"prompt-template"
|
|
1895
|
-
],
|
|
1896
|
-
"name": "grounding-context",
|
|
1897
|
-
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
1898
|
-
"hasDynamicHelp": false,
|
|
1899
|
-
"multiple": false,
|
|
1900
|
-
"type": "option"
|
|
1901
|
-
},
|
|
1902
|
-
"force-overwrite": {
|
|
1903
|
-
"name": "force-overwrite",
|
|
1904
|
-
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
1905
|
-
"allowNo": false,
|
|
1906
|
-
"type": "boolean"
|
|
1907
1988
|
}
|
|
1908
1989
|
},
|
|
1909
1990
|
"hasDynamicHelp": true,
|
|
1910
1991
|
"hiddenAliases": [],
|
|
1911
|
-
"id": "agent:
|
|
1992
|
+
"id": "agent:mcp:get",
|
|
1912
1993
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1913
1994
|
"pluginName": "@salesforce/plugin-agent",
|
|
1914
1995
|
"pluginType": "core",
|
|
1996
|
+
"state": "preview",
|
|
1915
1997
|
"strict": true,
|
|
1916
|
-
"summary": "
|
|
1998
|
+
"summary": "Get a single MCP server registered in the API Catalog.",
|
|
1917
1999
|
"enableJsonFlag": true,
|
|
1918
|
-
"requiresProject": true,
|
|
1919
2000
|
"isESM": true,
|
|
1920
2001
|
"relativePath": [
|
|
1921
2002
|
"lib",
|
|
1922
2003
|
"commands",
|
|
1923
2004
|
"agent",
|
|
1924
|
-
"
|
|
1925
|
-
"
|
|
2005
|
+
"mcp",
|
|
2006
|
+
"get.js"
|
|
1926
2007
|
],
|
|
1927
2008
|
"aliasPermutations": [],
|
|
1928
2009
|
"permutations": [
|
|
1929
|
-
"agent:
|
|
1930
|
-
"
|
|
1931
|
-
"
|
|
1932
|
-
"agent:
|
|
1933
|
-
"
|
|
1934
|
-
"
|
|
2010
|
+
"agent:mcp:get",
|
|
2011
|
+
"mcp:agent:get",
|
|
2012
|
+
"mcp:get:agent",
|
|
2013
|
+
"agent:get:mcp",
|
|
2014
|
+
"get:agent:mcp",
|
|
2015
|
+
"get:mcp:agent"
|
|
1935
2016
|
]
|
|
1936
2017
|
},
|
|
1937
|
-
"agent:
|
|
2018
|
+
"agent:mcp:list": {
|
|
1938
2019
|
"aliases": [],
|
|
1939
2020
|
"args": {},
|
|
1940
|
-
"description": "
|
|
2021
|
+
"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.",
|
|
1941
2022
|
"examples": [
|
|
1942
|
-
"
|
|
1943
|
-
"
|
|
1944
|
-
"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\"",
|
|
1945
|
-
"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"
|
|
2023
|
+
"List all MCP servers in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
2024
|
+
"List external MCP servers filtered by status and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json"
|
|
1946
2025
|
],
|
|
1947
2026
|
"flags": {
|
|
1948
2027
|
"json": {
|
|
@@ -1970,13 +2049,6 @@
|
|
|
1970
2049
|
"multiple": false,
|
|
1971
2050
|
"type": "option"
|
|
1972
2051
|
},
|
|
1973
|
-
"api-name": {
|
|
1974
|
-
"name": "api-name",
|
|
1975
|
-
"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.",
|
|
1976
|
-
"hasDynamicHelp": false,
|
|
1977
|
-
"multiple": false,
|
|
1978
|
-
"type": "option"
|
|
1979
|
-
},
|
|
1980
2052
|
"api-version": {
|
|
1981
2053
|
"description": "Override the api version used for api requests made by this command",
|
|
1982
2054
|
"name": "api-version",
|
|
@@ -1984,77 +2056,70 @@
|
|
|
1984
2056
|
"multiple": false,
|
|
1985
2057
|
"type": "option"
|
|
1986
2058
|
},
|
|
1987
|
-
"
|
|
1988
|
-
"
|
|
1989
|
-
"
|
|
1990
|
-
"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.",
|
|
2059
|
+
"label": {
|
|
2060
|
+
"name": "label",
|
|
2061
|
+
"summary": "Filter the MCP servers by label.",
|
|
1991
2062
|
"hasDynamicHelp": false,
|
|
1992
2063
|
"multiple": false,
|
|
1993
2064
|
"type": "option"
|
|
1994
2065
|
},
|
|
1995
|
-
"
|
|
1996
|
-
"name": "
|
|
1997
|
-
"summary": "
|
|
1998
|
-
"allowNo": false,
|
|
1999
|
-
"type": "boolean"
|
|
2000
|
-
},
|
|
2001
|
-
"output-dir": {
|
|
2002
|
-
"char": "d",
|
|
2003
|
-
"name": "output-dir",
|
|
2004
|
-
"summary": "Directory where the authoring bundle files are generated.",
|
|
2066
|
+
"type": {
|
|
2067
|
+
"name": "type",
|
|
2068
|
+
"summary": "Filter the MCP servers by type.",
|
|
2005
2069
|
"hasDynamicHelp": false,
|
|
2006
2070
|
"multiple": false,
|
|
2071
|
+
"options": [
|
|
2072
|
+
"EXTERNAL"
|
|
2073
|
+
],
|
|
2007
2074
|
"type": "option"
|
|
2008
2075
|
},
|
|
2009
|
-
"
|
|
2010
|
-
"
|
|
2011
|
-
"
|
|
2012
|
-
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
2076
|
+
"status": {
|
|
2077
|
+
"name": "status",
|
|
2078
|
+
"summary": "Filter the MCP servers by connection status. Only ACTIVE and DISCONNECTED are supported as filters.",
|
|
2013
2079
|
"hasDynamicHelp": false,
|
|
2014
2080
|
"multiple": false,
|
|
2081
|
+
"options": [
|
|
2082
|
+
"ACTIVE",
|
|
2083
|
+
"DISCONNECTED"
|
|
2084
|
+
],
|
|
2015
2085
|
"type": "option"
|
|
2016
|
-
},
|
|
2017
|
-
"force-overwrite": {
|
|
2018
|
-
"name": "force-overwrite",
|
|
2019
|
-
"summary": "Overwrite the existing authoring bundle if one with the same API name already exists locally.",
|
|
2020
|
-
"allowNo": false,
|
|
2021
|
-
"type": "boolean"
|
|
2022
2086
|
}
|
|
2023
2087
|
},
|
|
2024
2088
|
"hasDynamicHelp": true,
|
|
2025
2089
|
"hiddenAliases": [],
|
|
2026
|
-
"id": "agent:
|
|
2090
|
+
"id": "agent:mcp:list",
|
|
2027
2091
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2028
2092
|
"pluginName": "@salesforce/plugin-agent",
|
|
2029
2093
|
"pluginType": "core",
|
|
2094
|
+
"state": "preview",
|
|
2030
2095
|
"strict": true,
|
|
2031
|
-
"summary": "
|
|
2096
|
+
"summary": "List the MCP servers registered in the API Catalog.",
|
|
2032
2097
|
"enableJsonFlag": true,
|
|
2033
|
-
"requiresProject": true,
|
|
2034
2098
|
"isESM": true,
|
|
2035
2099
|
"relativePath": [
|
|
2036
2100
|
"lib",
|
|
2037
2101
|
"commands",
|
|
2038
2102
|
"agent",
|
|
2039
|
-
"
|
|
2040
|
-
"
|
|
2103
|
+
"mcp",
|
|
2104
|
+
"list.js"
|
|
2041
2105
|
],
|
|
2042
2106
|
"aliasPermutations": [],
|
|
2043
2107
|
"permutations": [
|
|
2044
|
-
"agent:
|
|
2045
|
-
"
|
|
2046
|
-
"
|
|
2047
|
-
"agent:
|
|
2048
|
-
"
|
|
2049
|
-
"
|
|
2108
|
+
"agent:mcp:list",
|
|
2109
|
+
"mcp:agent:list",
|
|
2110
|
+
"mcp:list:agent",
|
|
2111
|
+
"agent:list:mcp",
|
|
2112
|
+
"list:agent:mcp",
|
|
2113
|
+
"list:mcp:agent"
|
|
2050
2114
|
]
|
|
2051
2115
|
},
|
|
2052
|
-
"agent:
|
|
2116
|
+
"agent:mcp:update": {
|
|
2053
2117
|
"aliases": [],
|
|
2054
2118
|
"args": {},
|
|
2055
|
-
"description": "
|
|
2119
|
+
"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.",
|
|
2056
2120
|
"examples": [
|
|
2057
|
-
"
|
|
2121
|
+
"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",
|
|
2122
|
+
"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"
|
|
2058
2123
|
],
|
|
2059
2124
|
"flags": {
|
|
2060
2125
|
"json": {
|
|
@@ -2072,6 +2137,16 @@
|
|
|
2072
2137
|
"multiple": false,
|
|
2073
2138
|
"type": "option"
|
|
2074
2139
|
},
|
|
2140
|
+
"target-org": {
|
|
2141
|
+
"char": "o",
|
|
2142
|
+
"name": "target-org",
|
|
2143
|
+
"noCacheDefault": true,
|
|
2144
|
+
"required": true,
|
|
2145
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2146
|
+
"hasDynamicHelp": true,
|
|
2147
|
+
"multiple": false,
|
|
2148
|
+
"type": "option"
|
|
2149
|
+
},
|
|
2075
2150
|
"api-version": {
|
|
2076
2151
|
"description": "Override the api version used for api requests made by this command",
|
|
2077
2152
|
"name": "api-version",
|
|
@@ -2079,162 +2154,114 @@
|
|
|
2079
2154
|
"multiple": false,
|
|
2080
2155
|
"type": "option"
|
|
2081
2156
|
},
|
|
2082
|
-
"
|
|
2083
|
-
"char": "
|
|
2084
|
-
"name": "
|
|
2085
|
-
"noCacheDefault": true,
|
|
2157
|
+
"mcp-server-id": {
|
|
2158
|
+
"char": "i",
|
|
2159
|
+
"name": "mcp-server-id",
|
|
2086
2160
|
"required": true,
|
|
2087
|
-
"summary": "
|
|
2088
|
-
"hasDynamicHelp":
|
|
2161
|
+
"summary": "ID of the MCP server to update.",
|
|
2162
|
+
"hasDynamicHelp": false,
|
|
2089
2163
|
"multiple": false,
|
|
2090
2164
|
"type": "option"
|
|
2091
2165
|
},
|
|
2092
|
-
"
|
|
2093
|
-
"name": "
|
|
2094
|
-
"
|
|
2095
|
-
"summary": "Version of the agent (BotVersion).",
|
|
2166
|
+
"label": {
|
|
2167
|
+
"name": "label",
|
|
2168
|
+
"summary": "New display label for the MCP server.",
|
|
2096
2169
|
"hasDynamicHelp": false,
|
|
2097
2170
|
"multiple": false,
|
|
2098
2171
|
"type": "option"
|
|
2099
2172
|
},
|
|
2100
|
-
"
|
|
2101
|
-
"
|
|
2102
|
-
"
|
|
2103
|
-
"required": true,
|
|
2104
|
-
"summary": "Path to an agent (Bot) metadata file.",
|
|
2173
|
+
"description": {
|
|
2174
|
+
"name": "description",
|
|
2175
|
+
"summary": "New description for the MCP server.",
|
|
2105
2176
|
"hasDynamicHelp": false,
|
|
2106
2177
|
"multiple": false,
|
|
2107
2178
|
"type": "option"
|
|
2108
2179
|
},
|
|
2109
|
-
"
|
|
2110
|
-
"
|
|
2111
|
-
"
|
|
2112
|
-
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
2180
|
+
"server-url": {
|
|
2181
|
+
"name": "server-url",
|
|
2182
|
+
"summary": "New endpoint URL of the MCP server.",
|
|
2113
2183
|
"hasDynamicHelp": false,
|
|
2114
2184
|
"multiple": false,
|
|
2115
2185
|
"type": "option"
|
|
2116
|
-
}
|
|
2117
|
-
|
|
2118
|
-
|
|
2119
|
-
|
|
2120
|
-
"id": "agent:generate:template",
|
|
2121
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
2122
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
2123
|
-
"pluginType": "core",
|
|
2124
|
-
"strict": true,
|
|
2125
|
-
"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.",
|
|
2126
|
-
"enableJsonFlag": true,
|
|
2127
|
-
"requiresProject": true,
|
|
2128
|
-
"isESM": true,
|
|
2129
|
-
"relativePath": [
|
|
2130
|
-
"lib",
|
|
2131
|
-
"commands",
|
|
2132
|
-
"agent",
|
|
2133
|
-
"generate",
|
|
2134
|
-
"template.js"
|
|
2135
|
-
],
|
|
2136
|
-
"aliasPermutations": [],
|
|
2137
|
-
"permutations": [
|
|
2138
|
-
"agent:generate:template",
|
|
2139
|
-
"generate:agent:template",
|
|
2140
|
-
"generate:template:agent",
|
|
2141
|
-
"agent:template:generate",
|
|
2142
|
-
"template:agent:generate",
|
|
2143
|
-
"template:generate:agent"
|
|
2144
|
-
]
|
|
2145
|
-
},
|
|
2146
|
-
"agent:generate:test-spec": {
|
|
2147
|
-
"aliases": [],
|
|
2148
|
-
"args": {},
|
|
2149
|
-
"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.",
|
|
2150
|
-
"examples": [
|
|
2151
|
-
"Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
|
|
2152
|
-
"Generate an Agentforce Studio (NGT) test spec YAML file interactively:\n<%= config.bin %> <%= command.id %> --test-runner agentforce-studio",
|
|
2153
|
-
"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",
|
|
2154
|
-
"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",
|
|
2155
|
-
"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"
|
|
2156
|
-
],
|
|
2157
|
-
"flags": {
|
|
2158
|
-
"flags-dir": {
|
|
2159
|
-
"helpGroup": "GLOBAL",
|
|
2160
|
-
"name": "flags-dir",
|
|
2161
|
-
"summary": "Import flag values from a directory.",
|
|
2186
|
+
},
|
|
2187
|
+
"auth-type": {
|
|
2188
|
+
"name": "auth-type",
|
|
2189
|
+
"summary": "Authorization type to apply to the MCP server (OAUTH or NO_AUTH).",
|
|
2162
2190
|
"hasDynamicHelp": false,
|
|
2163
2191
|
"multiple": false,
|
|
2192
|
+
"options": [
|
|
2193
|
+
"OAUTH",
|
|
2194
|
+
"NO_AUTH"
|
|
2195
|
+
],
|
|
2164
2196
|
"type": "option"
|
|
2165
2197
|
},
|
|
2166
|
-
"
|
|
2167
|
-
"
|
|
2168
|
-
"
|
|
2169
|
-
"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.",
|
|
2198
|
+
"identity-provider": {
|
|
2199
|
+
"name": "identity-provider",
|
|
2200
|
+
"summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
|
|
2170
2201
|
"hasDynamicHelp": false,
|
|
2171
2202
|
"multiple": false,
|
|
2172
2203
|
"type": "option"
|
|
2173
2204
|
},
|
|
2174
|
-
"
|
|
2175
|
-
"name": "
|
|
2176
|
-
"summary": "
|
|
2177
|
-
"
|
|
2178
|
-
"
|
|
2205
|
+
"client-id": {
|
|
2206
|
+
"name": "client-id",
|
|
2207
|
+
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
2208
|
+
"hasDynamicHelp": false,
|
|
2209
|
+
"multiple": false,
|
|
2210
|
+
"type": "option"
|
|
2179
2211
|
},
|
|
2180
|
-
"
|
|
2181
|
-
"
|
|
2182
|
-
"
|
|
2183
|
-
"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).",
|
|
2212
|
+
"client-secret": {
|
|
2213
|
+
"name": "client-secret",
|
|
2214
|
+
"summary": "OAuth client secret (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
2184
2215
|
"hasDynamicHelp": false,
|
|
2185
2216
|
"multiple": false,
|
|
2186
2217
|
"type": "option"
|
|
2187
2218
|
},
|
|
2188
|
-
"
|
|
2189
|
-
"
|
|
2190
|
-
"
|
|
2191
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2219
|
+
"scope": {
|
|
2220
|
+
"name": "scope",
|
|
2221
|
+
"summary": "OAuth scope (required when --auth-type is OAUTH).",
|
|
2192
2222
|
"hasDynamicHelp": false,
|
|
2193
2223
|
"multiple": false,
|
|
2194
|
-
"options": [
|
|
2195
|
-
"agentforce-studio",
|
|
2196
|
-
"testing-center"
|
|
2197
|
-
],
|
|
2198
2224
|
"type": "option"
|
|
2199
2225
|
}
|
|
2200
2226
|
},
|
|
2201
|
-
"hasDynamicHelp":
|
|
2227
|
+
"hasDynamicHelp": true,
|
|
2202
2228
|
"hiddenAliases": [],
|
|
2203
|
-
"id": "agent:
|
|
2229
|
+
"id": "agent:mcp:update",
|
|
2204
2230
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2205
2231
|
"pluginName": "@salesforce/plugin-agent",
|
|
2206
2232
|
"pluginType": "core",
|
|
2233
|
+
"state": "preview",
|
|
2207
2234
|
"strict": true,
|
|
2208
|
-
"summary": "
|
|
2209
|
-
"enableJsonFlag":
|
|
2235
|
+
"summary": "Update an MCP server registered in the API Catalog.",
|
|
2236
|
+
"enableJsonFlag": true,
|
|
2210
2237
|
"isESM": true,
|
|
2211
2238
|
"relativePath": [
|
|
2212
2239
|
"lib",
|
|
2213
2240
|
"commands",
|
|
2214
2241
|
"agent",
|
|
2215
|
-
"
|
|
2216
|
-
"
|
|
2242
|
+
"mcp",
|
|
2243
|
+
"update.js"
|
|
2217
2244
|
],
|
|
2218
2245
|
"aliasPermutations": [],
|
|
2219
2246
|
"permutations": [
|
|
2220
|
-
"agent:
|
|
2221
|
-
"
|
|
2222
|
-
"
|
|
2223
|
-
"agent:
|
|
2224
|
-
"
|
|
2225
|
-
"
|
|
2247
|
+
"agent:mcp:update",
|
|
2248
|
+
"mcp:agent:update",
|
|
2249
|
+
"mcp:update:agent",
|
|
2250
|
+
"agent:update:mcp",
|
|
2251
|
+
"update:agent:mcp",
|
|
2252
|
+
"update:mcp:agent"
|
|
2226
2253
|
]
|
|
2227
2254
|
},
|
|
2228
|
-
"agent:
|
|
2255
|
+
"agent:generate:agent-spec": {
|
|
2229
2256
|
"aliases": [],
|
|
2230
2257
|
"args": {},
|
|
2231
|
-
"description": "
|
|
2258
|
+
"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.)",
|
|
2232
2259
|
"examples": [
|
|
2233
|
-
"
|
|
2234
|
-
"
|
|
2235
|
-
"
|
|
2236
|
-
"
|
|
2237
|
-
"
|
|
2260
|
+
"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.\"",
|
|
2261
|
+
"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",
|
|
2262
|
+
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
2263
|
+
"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\"",
|
|
2264
|
+
"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"
|
|
2238
2265
|
],
|
|
2239
2266
|
"flags": {
|
|
2240
2267
|
"json": {
|
|
@@ -2269,129 +2296,164 @@
|
|
|
2269
2296
|
"multiple": false,
|
|
2270
2297
|
"type": "option"
|
|
2271
2298
|
},
|
|
2272
|
-
"
|
|
2273
|
-
"
|
|
2274
|
-
|
|
2299
|
+
"type": {
|
|
2300
|
+
"name": "type",
|
|
2301
|
+
"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.",
|
|
2302
|
+
"hasDynamicHelp": false,
|
|
2303
|
+
"multiple": false,
|
|
2304
|
+
"options": [
|
|
2305
|
+
"customer",
|
|
2306
|
+
"internal"
|
|
2275
2307
|
],
|
|
2276
|
-
"
|
|
2277
|
-
|
|
2278
|
-
|
|
2308
|
+
"type": "option"
|
|
2309
|
+
},
|
|
2310
|
+
"role": {
|
|
2311
|
+
"name": "role",
|
|
2312
|
+
"summary": "Role of the agent.",
|
|
2279
2313
|
"hasDynamicHelp": false,
|
|
2280
2314
|
"multiple": false,
|
|
2281
2315
|
"type": "option"
|
|
2282
2316
|
},
|
|
2283
|
-
"
|
|
2284
|
-
"
|
|
2285
|
-
"
|
|
2286
|
-
"authoring-bundle"
|
|
2287
|
-
],
|
|
2288
|
-
"name": "api-name",
|
|
2289
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
2317
|
+
"company-name": {
|
|
2318
|
+
"name": "company-name",
|
|
2319
|
+
"summary": "Name of your company.",
|
|
2290
2320
|
"hasDynamicHelp": false,
|
|
2291
2321
|
"multiple": false,
|
|
2292
2322
|
"type": "option"
|
|
2293
2323
|
},
|
|
2294
|
-
"
|
|
2295
|
-
"
|
|
2296
|
-
|
|
2297
|
-
],
|
|
2298
|
-
"name": "authoring-bundle",
|
|
2299
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2324
|
+
"company-description": {
|
|
2325
|
+
"name": "company-description",
|
|
2326
|
+
"summary": "Description of your company.",
|
|
2300
2327
|
"hasDynamicHelp": false,
|
|
2301
2328
|
"multiple": false,
|
|
2302
2329
|
"type": "option"
|
|
2303
2330
|
},
|
|
2304
|
-
"
|
|
2305
|
-
"
|
|
2306
|
-
|
|
2331
|
+
"company-website": {
|
|
2332
|
+
"name": "company-website",
|
|
2333
|
+
"summary": "Website URL of your company.",
|
|
2334
|
+
"hasDynamicHelp": false,
|
|
2335
|
+
"multiple": false,
|
|
2336
|
+
"type": "option"
|
|
2337
|
+
},
|
|
2338
|
+
"max-topics": {
|
|
2339
|
+
"name": "max-topics",
|
|
2340
|
+
"summary": "Maximum number of topics to generate in the agent spec; default is 5.",
|
|
2341
|
+
"hasDynamicHelp": false,
|
|
2342
|
+
"multiple": false,
|
|
2343
|
+
"type": "option"
|
|
2344
|
+
},
|
|
2345
|
+
"agent-user": {
|
|
2346
|
+
"name": "agent-user",
|
|
2347
|
+
"summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
|
|
2348
|
+
"hasDynamicHelp": false,
|
|
2349
|
+
"multiple": false,
|
|
2350
|
+
"type": "option"
|
|
2351
|
+
},
|
|
2352
|
+
"enrich-logs": {
|
|
2353
|
+
"name": "enrich-logs",
|
|
2354
|
+
"summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
|
|
2355
|
+
"hasDynamicHelp": false,
|
|
2356
|
+
"multiple": false,
|
|
2357
|
+
"options": [
|
|
2358
|
+
"true",
|
|
2359
|
+
"false"
|
|
2307
2360
|
],
|
|
2308
|
-
"
|
|
2309
|
-
|
|
2361
|
+
"type": "option"
|
|
2362
|
+
},
|
|
2363
|
+
"tone": {
|
|
2364
|
+
"name": "tone",
|
|
2365
|
+
"summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
|
|
2366
|
+
"hasDynamicHelp": false,
|
|
2367
|
+
"multiple": false,
|
|
2368
|
+
"options": [
|
|
2369
|
+
"formal",
|
|
2370
|
+
"casual",
|
|
2371
|
+
"neutral"
|
|
2372
|
+
],
|
|
2373
|
+
"type": "option"
|
|
2374
|
+
},
|
|
2375
|
+
"spec": {
|
|
2376
|
+
"name": "spec",
|
|
2377
|
+
"summary": "Agent spec file, in YAML format, to use as input to the command.",
|
|
2378
|
+
"hasDynamicHelp": false,
|
|
2379
|
+
"multiple": false,
|
|
2380
|
+
"type": "option"
|
|
2381
|
+
},
|
|
2382
|
+
"output-file": {
|
|
2383
|
+
"name": "output-file",
|
|
2384
|
+
"summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
|
|
2385
|
+
"default": "specs/agentSpec.yaml",
|
|
2386
|
+
"hasDynamicHelp": false,
|
|
2387
|
+
"multiple": false,
|
|
2388
|
+
"type": "option"
|
|
2389
|
+
},
|
|
2390
|
+
"full-interview": {
|
|
2391
|
+
"name": "full-interview",
|
|
2392
|
+
"summary": "Prompt for both required and optional flags.",
|
|
2310
2393
|
"allowNo": false,
|
|
2311
2394
|
"type": "boolean"
|
|
2312
2395
|
},
|
|
2313
|
-
"
|
|
2314
|
-
"
|
|
2315
|
-
"
|
|
2316
|
-
"
|
|
2396
|
+
"prompt-template": {
|
|
2397
|
+
"name": "prompt-template",
|
|
2398
|
+
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
2399
|
+
"hasDynamicHelp": false,
|
|
2400
|
+
"multiple": false,
|
|
2401
|
+
"type": "option"
|
|
2402
|
+
},
|
|
2403
|
+
"grounding-context": {
|
|
2404
|
+
"dependsOn": [
|
|
2405
|
+
"prompt-template"
|
|
2406
|
+
],
|
|
2407
|
+
"name": "grounding-context",
|
|
2408
|
+
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
2409
|
+
"hasDynamicHelp": false,
|
|
2410
|
+
"multiple": false,
|
|
2411
|
+
"type": "option"
|
|
2412
|
+
},
|
|
2413
|
+
"force-overwrite": {
|
|
2414
|
+
"name": "force-overwrite",
|
|
2415
|
+
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
2317
2416
|
"allowNo": false,
|
|
2318
2417
|
"type": "boolean"
|
|
2319
2418
|
}
|
|
2320
2419
|
},
|
|
2321
2420
|
"hasDynamicHelp": true,
|
|
2322
2421
|
"hiddenAliases": [],
|
|
2323
|
-
"id": "agent:
|
|
2422
|
+
"id": "agent:generate:agent-spec",
|
|
2324
2423
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2325
2424
|
"pluginName": "@salesforce/plugin-agent",
|
|
2326
2425
|
"pluginType": "core",
|
|
2327
2426
|
"strict": true,
|
|
2328
|
-
"summary": "
|
|
2427
|
+
"summary": "Generate an agent spec, which is a YAML file that captures what an agent can do.",
|
|
2329
2428
|
"enableJsonFlag": true,
|
|
2330
2429
|
"requiresProject": true,
|
|
2331
|
-
"envVariablesSection": {
|
|
2332
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2333
|
-
"body": [
|
|
2334
|
-
{
|
|
2335
|
-
"name": "SF_TARGET_ORG",
|
|
2336
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2337
|
-
}
|
|
2338
|
-
]
|
|
2339
|
-
},
|
|
2340
|
-
"errorCodes": {
|
|
2341
|
-
"header": "ERROR CODES",
|
|
2342
|
-
"body": [
|
|
2343
|
-
{
|
|
2344
|
-
"name": "Succeeded (0)",
|
|
2345
|
-
"description": "Preview session ended successfully and traces saved."
|
|
2346
|
-
},
|
|
2347
|
-
{
|
|
2348
|
-
"name": "ExactlyOneRequired (2)",
|
|
2349
|
-
"description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
|
|
2350
|
-
},
|
|
2351
|
-
{
|
|
2352
|
-
"name": "NotFound (2)",
|
|
2353
|
-
"description": "Agent not found, or no preview session exists for this agent."
|
|
2354
|
-
},
|
|
2355
|
-
{
|
|
2356
|
-
"name": "PreviewEndFailed (4)",
|
|
2357
|
-
"description": "Failed to end the preview session."
|
|
2358
|
-
},
|
|
2359
|
-
{
|
|
2360
|
-
"name": "PreviewEndPartialFailure (68)",
|
|
2361
|
-
"description": "With --all, one or more sessions failed to end while others succeeded."
|
|
2362
|
-
},
|
|
2363
|
-
{
|
|
2364
|
-
"name": "SessionAmbiguous (5)",
|
|
2365
|
-
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2366
|
-
}
|
|
2367
|
-
]
|
|
2368
|
-
},
|
|
2369
2430
|
"isESM": true,
|
|
2370
2431
|
"relativePath": [
|
|
2371
2432
|
"lib",
|
|
2372
2433
|
"commands",
|
|
2373
2434
|
"agent",
|
|
2374
|
-
"
|
|
2375
|
-
"
|
|
2435
|
+
"generate",
|
|
2436
|
+
"agent-spec.js"
|
|
2376
2437
|
],
|
|
2377
2438
|
"aliasPermutations": [],
|
|
2378
2439
|
"permutations": [
|
|
2379
|
-
"agent:
|
|
2380
|
-
"
|
|
2381
|
-
"
|
|
2382
|
-
"agent:
|
|
2383
|
-
"
|
|
2384
|
-
"
|
|
2440
|
+
"agent:generate:agent-spec",
|
|
2441
|
+
"generate:agent:agent-spec",
|
|
2442
|
+
"generate:agent-spec:agent",
|
|
2443
|
+
"agent:agent-spec:generate",
|
|
2444
|
+
"agent-spec:agent:generate",
|
|
2445
|
+
"agent-spec:generate:agent"
|
|
2385
2446
|
]
|
|
2386
2447
|
},
|
|
2387
|
-
"agent:
|
|
2448
|
+
"agent:generate:authoring-bundle": {
|
|
2388
2449
|
"aliases": [],
|
|
2389
2450
|
"args": {},
|
|
2390
|
-
"description": "
|
|
2451
|
+
"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.",
|
|
2391
2452
|
"examples": [
|
|
2392
|
-
"
|
|
2393
|
-
"
|
|
2394
|
-
"
|
|
2453
|
+
"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 %>",
|
|
2454
|
+
"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\"",
|
|
2455
|
+
"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\"",
|
|
2456
|
+
"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"
|
|
2395
2457
|
],
|
|
2396
2458
|
"flags": {
|
|
2397
2459
|
"json": {
|
|
@@ -2419,6 +2481,13 @@
|
|
|
2419
2481
|
"multiple": false,
|
|
2420
2482
|
"type": "option"
|
|
2421
2483
|
},
|
|
2484
|
+
"api-name": {
|
|
2485
|
+
"name": "api-name",
|
|
2486
|
+
"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.",
|
|
2487
|
+
"hasDynamicHelp": false,
|
|
2488
|
+
"multiple": false,
|
|
2489
|
+
"type": "option"
|
|
2490
|
+
},
|
|
2422
2491
|
"api-version": {
|
|
2423
2492
|
"description": "Override the api version used for api requests made by this command",
|
|
2424
2493
|
"name": "api-version",
|
|
@@ -2426,103 +2495,77 @@
|
|
|
2426
2495
|
"multiple": false,
|
|
2427
2496
|
"type": "option"
|
|
2428
2497
|
},
|
|
2429
|
-
"
|
|
2430
|
-
"
|
|
2431
|
-
"
|
|
2432
|
-
"summary": "
|
|
2498
|
+
"spec": {
|
|
2499
|
+
"char": "f",
|
|
2500
|
+
"name": "spec",
|
|
2501
|
+
"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.",
|
|
2433
2502
|
"hasDynamicHelp": false,
|
|
2434
2503
|
"multiple": false,
|
|
2435
2504
|
"type": "option"
|
|
2436
2505
|
},
|
|
2437
|
-
"
|
|
2438
|
-
"
|
|
2439
|
-
"
|
|
2440
|
-
"
|
|
2441
|
-
"
|
|
2506
|
+
"no-spec": {
|
|
2507
|
+
"name": "no-spec",
|
|
2508
|
+
"summary": "Skip prompting for an agent spec and use the default Agent Script boilerplate in the generated authoring bundle.",
|
|
2509
|
+
"allowNo": false,
|
|
2510
|
+
"type": "boolean"
|
|
2511
|
+
},
|
|
2512
|
+
"output-dir": {
|
|
2513
|
+
"char": "d",
|
|
2514
|
+
"name": "output-dir",
|
|
2515
|
+
"summary": "Directory where the authoring bundle files are generated.",
|
|
2442
2516
|
"hasDynamicHelp": false,
|
|
2443
2517
|
"multiple": false,
|
|
2444
2518
|
"type": "option"
|
|
2445
2519
|
},
|
|
2446
|
-
"
|
|
2520
|
+
"name": {
|
|
2447
2521
|
"char": "n",
|
|
2448
|
-
"name": "
|
|
2449
|
-
"summary": "
|
|
2522
|
+
"name": "name",
|
|
2523
|
+
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
2450
2524
|
"hasDynamicHelp": false,
|
|
2451
2525
|
"multiple": false,
|
|
2452
2526
|
"type": "option"
|
|
2453
2527
|
},
|
|
2454
|
-
"
|
|
2455
|
-
"name": "
|
|
2456
|
-
"summary": "
|
|
2457
|
-
"
|
|
2458
|
-
"
|
|
2459
|
-
"type": "option"
|
|
2528
|
+
"force-overwrite": {
|
|
2529
|
+
"name": "force-overwrite",
|
|
2530
|
+
"summary": "Overwrite the existing authoring bundle if one with the same API name already exists locally.",
|
|
2531
|
+
"allowNo": false,
|
|
2532
|
+
"type": "boolean"
|
|
2460
2533
|
}
|
|
2461
2534
|
},
|
|
2462
2535
|
"hasDynamicHelp": true,
|
|
2463
2536
|
"hiddenAliases": [],
|
|
2464
|
-
"id": "agent:
|
|
2537
|
+
"id": "agent:generate:authoring-bundle",
|
|
2465
2538
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2466
2539
|
"pluginName": "@salesforce/plugin-agent",
|
|
2467
2540
|
"pluginType": "core",
|
|
2468
2541
|
"strict": true,
|
|
2469
|
-
"summary": "
|
|
2542
|
+
"summary": "Generate an authoring bundle from an existing agent spec YAML file.",
|
|
2470
2543
|
"enableJsonFlag": true,
|
|
2471
2544
|
"requiresProject": true,
|
|
2472
|
-
"envVariablesSection": {
|
|
2473
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2474
|
-
"body": [
|
|
2475
|
-
{
|
|
2476
|
-
"name": "SF_TARGET_ORG",
|
|
2477
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2478
|
-
}
|
|
2479
|
-
]
|
|
2480
|
-
},
|
|
2481
|
-
"errorCodes": {
|
|
2482
|
-
"header": "ERROR CODES",
|
|
2483
|
-
"body": [
|
|
2484
|
-
{
|
|
2485
|
-
"name": "Succeeded (0)",
|
|
2486
|
-
"description": "Message sent successfully and agent response received."
|
|
2487
|
-
},
|
|
2488
|
-
{
|
|
2489
|
-
"name": "NotFound (2)",
|
|
2490
|
-
"description": "Agent not found, or no preview session exists for this agent."
|
|
2491
|
-
},
|
|
2492
|
-
{
|
|
2493
|
-
"name": "PreviewSendFailed (4)",
|
|
2494
|
-
"description": "Failed to send message or receive response from the preview session."
|
|
2495
|
-
},
|
|
2496
|
-
{
|
|
2497
|
-
"name": "SessionAmbiguous (5)",
|
|
2498
|
-
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2499
|
-
}
|
|
2500
|
-
]
|
|
2501
|
-
},
|
|
2502
2545
|
"isESM": true,
|
|
2503
2546
|
"relativePath": [
|
|
2504
2547
|
"lib",
|
|
2505
2548
|
"commands",
|
|
2506
2549
|
"agent",
|
|
2507
|
-
"
|
|
2508
|
-
"
|
|
2550
|
+
"generate",
|
|
2551
|
+
"authoring-bundle.js"
|
|
2509
2552
|
],
|
|
2510
2553
|
"aliasPermutations": [],
|
|
2511
2554
|
"permutations": [
|
|
2512
|
-
"agent:
|
|
2513
|
-
"
|
|
2514
|
-
"
|
|
2515
|
-
"agent:
|
|
2516
|
-
"
|
|
2517
|
-
"
|
|
2555
|
+
"agent:generate:authoring-bundle",
|
|
2556
|
+
"generate:agent:authoring-bundle",
|
|
2557
|
+
"generate:authoring-bundle:agent",
|
|
2558
|
+
"agent:authoring-bundle:generate",
|
|
2559
|
+
"authoring-bundle:agent:generate",
|
|
2560
|
+
"authoring-bundle:generate:agent"
|
|
2518
2561
|
]
|
|
2519
2562
|
},
|
|
2520
|
-
"agent:
|
|
2563
|
+
"agent:generate:template": {
|
|
2521
2564
|
"aliases": [],
|
|
2522
2565
|
"args": {},
|
|
2523
|
-
"description": "This command
|
|
2566
|
+
"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.",
|
|
2524
2567
|
"examples": [
|
|
2525
|
-
"
|
|
2568
|
+
"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"
|
|
2526
2569
|
],
|
|
2527
2570
|
"flags": {
|
|
2528
2571
|
"json": {
|
|
@@ -2539,62 +2582,90 @@
|
|
|
2539
2582
|
"hasDynamicHelp": false,
|
|
2540
2583
|
"multiple": false,
|
|
2541
2584
|
"type": "option"
|
|
2585
|
+
},
|
|
2586
|
+
"api-version": {
|
|
2587
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2588
|
+
"name": "api-version",
|
|
2589
|
+
"hasDynamicHelp": false,
|
|
2590
|
+
"multiple": false,
|
|
2591
|
+
"type": "option"
|
|
2592
|
+
},
|
|
2593
|
+
"source-org": {
|
|
2594
|
+
"char": "s",
|
|
2595
|
+
"name": "source-org",
|
|
2596
|
+
"noCacheDefault": true,
|
|
2597
|
+
"required": true,
|
|
2598
|
+
"summary": "Username or alias of the namespaced scratch org that contains the agent which this template is based on.",
|
|
2599
|
+
"hasDynamicHelp": true,
|
|
2600
|
+
"multiple": false,
|
|
2601
|
+
"type": "option"
|
|
2602
|
+
},
|
|
2603
|
+
"agent-version": {
|
|
2604
|
+
"name": "agent-version",
|
|
2605
|
+
"required": true,
|
|
2606
|
+
"summary": "Version of the agent (BotVersion).",
|
|
2607
|
+
"hasDynamicHelp": false,
|
|
2608
|
+
"multiple": false,
|
|
2609
|
+
"type": "option"
|
|
2610
|
+
},
|
|
2611
|
+
"agent-file": {
|
|
2612
|
+
"char": "f",
|
|
2613
|
+
"name": "agent-file",
|
|
2614
|
+
"required": true,
|
|
2615
|
+
"summary": "Path to an agent (Bot) metadata file.",
|
|
2616
|
+
"hasDynamicHelp": false,
|
|
2617
|
+
"multiple": false,
|
|
2618
|
+
"type": "option"
|
|
2619
|
+
},
|
|
2620
|
+
"output-dir": {
|
|
2621
|
+
"char": "r",
|
|
2622
|
+
"name": "output-dir",
|
|
2623
|
+
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
2624
|
+
"hasDynamicHelp": false,
|
|
2625
|
+
"multiple": false,
|
|
2626
|
+
"type": "option"
|
|
2542
2627
|
}
|
|
2543
2628
|
},
|
|
2544
|
-
"hasDynamicHelp":
|
|
2629
|
+
"hasDynamicHelp": true,
|
|
2545
2630
|
"hiddenAliases": [],
|
|
2546
|
-
"id": "agent:
|
|
2631
|
+
"id": "agent:generate:template",
|
|
2547
2632
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2548
2633
|
"pluginName": "@salesforce/plugin-agent",
|
|
2549
2634
|
"pluginType": "core",
|
|
2550
2635
|
"strict": true,
|
|
2551
|
-
"summary": "
|
|
2636
|
+
"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.",
|
|
2552
2637
|
"enableJsonFlag": true,
|
|
2553
2638
|
"requiresProject": true,
|
|
2554
|
-
"errorCodes": {
|
|
2555
|
-
"header": "ERROR CODES",
|
|
2556
|
-
"body": [
|
|
2557
|
-
{
|
|
2558
|
-
"name": "Succeeded (0)",
|
|
2559
|
-
"description": "Sessions listed successfully (or empty list if no active sessions)."
|
|
2560
|
-
}
|
|
2561
|
-
]
|
|
2562
|
-
},
|
|
2563
2639
|
"isESM": true,
|
|
2564
2640
|
"relativePath": [
|
|
2565
2641
|
"lib",
|
|
2566
2642
|
"commands",
|
|
2567
2643
|
"agent",
|
|
2568
|
-
"
|
|
2569
|
-
"
|
|
2644
|
+
"generate",
|
|
2645
|
+
"template.js"
|
|
2570
2646
|
],
|
|
2571
2647
|
"aliasPermutations": [],
|
|
2572
2648
|
"permutations": [
|
|
2573
|
-
"agent:
|
|
2574
|
-
"
|
|
2575
|
-
"
|
|
2576
|
-
"agent:
|
|
2577
|
-
"
|
|
2578
|
-
"
|
|
2649
|
+
"agent:generate:template",
|
|
2650
|
+
"generate:agent:template",
|
|
2651
|
+
"generate:template:agent",
|
|
2652
|
+
"agent:template:generate",
|
|
2653
|
+
"template:agent:generate",
|
|
2654
|
+
"template:generate:agent"
|
|
2579
2655
|
]
|
|
2580
2656
|
},
|
|
2581
|
-
"agent:
|
|
2657
|
+
"agent:generate:test-spec": {
|
|
2582
2658
|
"aliases": [],
|
|
2583
2659
|
"args": {},
|
|
2584
|
-
"description": "
|
|
2660
|
+
"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.",
|
|
2585
2661
|
"examples": [
|
|
2586
|
-
"
|
|
2587
|
-
"
|
|
2588
|
-
"
|
|
2662
|
+
"Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
|
|
2663
|
+
"Generate an Agentforce Studio (NGT) test spec YAML file interactively:\n<%= config.bin %> <%= command.id %> --test-runner agentforce-studio",
|
|
2664
|
+
"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",
|
|
2665
|
+
"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",
|
|
2666
|
+
"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"
|
|
2589
2667
|
],
|
|
2590
2668
|
"flags": {
|
|
2591
|
-
"json": {
|
|
2592
|
-
"description": "Format output as json.",
|
|
2593
|
-
"helpGroup": "GLOBAL",
|
|
2594
|
-
"name": "json",
|
|
2595
|
-
"allowNo": false,
|
|
2596
|
-
"type": "boolean"
|
|
2597
|
-
},
|
|
2598
2669
|
"flags-dir": {
|
|
2599
2670
|
"helpGroup": "GLOBAL",
|
|
2600
2671
|
"name": "flags-dir",
|
|
@@ -2603,137 +2674,66 @@
|
|
|
2603
2674
|
"multiple": false,
|
|
2604
2675
|
"type": "option"
|
|
2605
2676
|
},
|
|
2606
|
-
"
|
|
2607
|
-
"char": "
|
|
2608
|
-
"name": "
|
|
2609
|
-
"
|
|
2610
|
-
"required": true,
|
|
2611
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2612
|
-
"hasDynamicHelp": true,
|
|
2613
|
-
"multiple": false,
|
|
2614
|
-
"type": "option"
|
|
2615
|
-
},
|
|
2616
|
-
"api-version": {
|
|
2617
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2618
|
-
"name": "api-version",
|
|
2619
|
-
"hasDynamicHelp": false,
|
|
2620
|
-
"multiple": false,
|
|
2621
|
-
"type": "option"
|
|
2622
|
-
},
|
|
2623
|
-
"api-name": {
|
|
2624
|
-
"char": "n",
|
|
2625
|
-
"name": "api-name",
|
|
2626
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
2627
|
-
"hasDynamicHelp": false,
|
|
2628
|
-
"multiple": false,
|
|
2629
|
-
"type": "option"
|
|
2630
|
-
},
|
|
2631
|
-
"authoring-bundle": {
|
|
2632
|
-
"name": "authoring-bundle",
|
|
2633
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2677
|
+
"from-definition": {
|
|
2678
|
+
"char": "d",
|
|
2679
|
+
"name": "from-definition",
|
|
2680
|
+
"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.",
|
|
2634
2681
|
"hasDynamicHelp": false,
|
|
2635
2682
|
"multiple": false,
|
|
2636
2683
|
"type": "option"
|
|
2637
2684
|
},
|
|
2638
|
-
"
|
|
2639
|
-
"
|
|
2640
|
-
|
|
2641
|
-
],
|
|
2642
|
-
"name": "use-live-actions",
|
|
2643
|
-
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
2644
|
-
"allowNo": false,
|
|
2645
|
-
"type": "boolean"
|
|
2646
|
-
},
|
|
2647
|
-
"simulate-actions": {
|
|
2648
|
-
"exclusive": [
|
|
2649
|
-
"use-live-actions"
|
|
2650
|
-
],
|
|
2651
|
-
"name": "simulate-actions",
|
|
2652
|
-
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
2685
|
+
"force-overwrite": {
|
|
2686
|
+
"name": "force-overwrite",
|
|
2687
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test spec YAML file.",
|
|
2653
2688
|
"allowNo": false,
|
|
2654
2689
|
"type": "boolean"
|
|
2655
2690
|
},
|
|
2656
|
-
"
|
|
2657
|
-
"
|
|
2658
|
-
"name": "
|
|
2659
|
-
"summary": "
|
|
2660
|
-
"delimiter": ",",
|
|
2691
|
+
"output-file": {
|
|
2692
|
+
"char": "f",
|
|
2693
|
+
"name": "output-file",
|
|
2694
|
+
"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).",
|
|
2661
2695
|
"hasDynamicHelp": false,
|
|
2662
|
-
"multiple":
|
|
2696
|
+
"multiple": false,
|
|
2663
2697
|
"type": "option"
|
|
2664
2698
|
},
|
|
2665
|
-
"
|
|
2666
|
-
"
|
|
2667
|
-
|
|
2668
|
-
|
|
2669
|
-
"hidden": true,
|
|
2670
|
-
"name": "agent-json",
|
|
2671
|
-
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
2699
|
+
"test-runner": {
|
|
2700
|
+
"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.",
|
|
2701
|
+
"name": "test-runner",
|
|
2702
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2672
2703
|
"hasDynamicHelp": false,
|
|
2673
2704
|
"multiple": false,
|
|
2705
|
+
"options": [
|
|
2706
|
+
"agentforce-studio",
|
|
2707
|
+
"testing-center"
|
|
2708
|
+
],
|
|
2674
2709
|
"type": "option"
|
|
2675
2710
|
}
|
|
2676
2711
|
},
|
|
2677
|
-
"hasDynamicHelp":
|
|
2712
|
+
"hasDynamicHelp": false,
|
|
2678
2713
|
"hiddenAliases": [],
|
|
2679
|
-
"id": "agent:
|
|
2714
|
+
"id": "agent:generate:test-spec",
|
|
2680
2715
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2681
2716
|
"pluginName": "@salesforce/plugin-agent",
|
|
2682
2717
|
"pluginType": "core",
|
|
2683
2718
|
"strict": true,
|
|
2684
|
-
"summary": "
|
|
2685
|
-
"enableJsonFlag":
|
|
2686
|
-
"requiresProject": true,
|
|
2687
|
-
"envVariablesSection": {
|
|
2688
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2689
|
-
"body": [
|
|
2690
|
-
{
|
|
2691
|
-
"name": "SF_TARGET_ORG",
|
|
2692
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2693
|
-
}
|
|
2694
|
-
]
|
|
2695
|
-
},
|
|
2696
|
-
"errorCodes": {
|
|
2697
|
-
"header": "ERROR CODES",
|
|
2698
|
-
"body": [
|
|
2699
|
-
{
|
|
2700
|
-
"name": "Succeeded (0)",
|
|
2701
|
-
"description": "Preview session started successfully."
|
|
2702
|
-
},
|
|
2703
|
-
{
|
|
2704
|
-
"name": "Failed (1)",
|
|
2705
|
-
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
2706
|
-
},
|
|
2707
|
-
{
|
|
2708
|
-
"name": "NotFound (2)",
|
|
2709
|
-
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
2710
|
-
},
|
|
2711
|
-
{
|
|
2712
|
-
"name": "ServerError (3)",
|
|
2713
|
-
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
2714
|
-
},
|
|
2715
|
-
{
|
|
2716
|
-
"name": "PreviewStartFailed (4)",
|
|
2717
|
-
"description": "Preview session failed to start due to API or network errors."
|
|
2718
|
-
}
|
|
2719
|
-
]
|
|
2720
|
-
},
|
|
2719
|
+
"summary": "Generate an agent test spec, which is a YAML file that lists the test cases for testing a specific agent.",
|
|
2720
|
+
"enableJsonFlag": false,
|
|
2721
2721
|
"isESM": true,
|
|
2722
2722
|
"relativePath": [
|
|
2723
2723
|
"lib",
|
|
2724
2724
|
"commands",
|
|
2725
2725
|
"agent",
|
|
2726
|
-
"
|
|
2727
|
-
"
|
|
2726
|
+
"generate",
|
|
2727
|
+
"test-spec.js"
|
|
2728
2728
|
],
|
|
2729
2729
|
"aliasPermutations": [],
|
|
2730
2730
|
"permutations": [
|
|
2731
|
-
"agent:
|
|
2732
|
-
"
|
|
2733
|
-
"
|
|
2734
|
-
"agent:
|
|
2735
|
-
"
|
|
2736
|
-
"
|
|
2731
|
+
"agent:generate:test-spec",
|
|
2732
|
+
"generate:agent:test-spec",
|
|
2733
|
+
"generate:test-spec:agent",
|
|
2734
|
+
"agent:test-spec:generate",
|
|
2735
|
+
"test-spec:agent:generate",
|
|
2736
|
+
"test-spec:generate:agent"
|
|
2737
2737
|
]
|
|
2738
2738
|
},
|
|
2739
2739
|
"agent:publish:authoring-bundle": {
|
|
@@ -2860,17 +2860,15 @@
|
|
|
2860
2860
|
"authoring-bundle:publish:agent"
|
|
2861
2861
|
]
|
|
2862
2862
|
},
|
|
2863
|
-
"agent:
|
|
2863
|
+
"agent:test:create": {
|
|
2864
2864
|
"aliases": [],
|
|
2865
2865
|
"args": {},
|
|
2866
|
-
"description": "
|
|
2866
|
+
"description": "To run this command, you must have an agent test spec file, which is a YAML file that lists the test cases for testing a specific agent. Use the \"agent generate test-spec\" CLI command to generate a test spec file. Then specify the file to this command with the --spec flag, or run this command with no flags to be prompted.\n\nWhen this command completes, your org contains the new agent test, which you can view and edit using the Testing Center UI (legacy) or Agentforce Studio (NGT). This command also retrieves the metadata component associated with the new test to your local Salesforce DX project and displays its filename. By default, the legacy AiEvaluationDefinition is created; use --test-runner agentforce-studio to author an AiTestingDefinition (NGT) instead.\n\nAfter you've created the test in the org, use the \"agent test run\" command to run it.",
|
|
2867
2867
|
"examples": [
|
|
2868
|
-
"
|
|
2869
|
-
"
|
|
2870
|
-
"
|
|
2871
|
-
"
|
|
2872
|
-
"Delete traces older than 24 hours for a specific agent; don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --agent My_Agent --older-than 24h --no-prompt",
|
|
2873
|
-
"Delete all traces for all agents and sessions; don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --no-prompt"
|
|
2868
|
+
"Create an agent test interactively and be prompted for the test spec and API name of the test in the org; use the default org:\n<%= config.bin %> <%= command.id %>",
|
|
2869
|
+
"Create an agent test and use flags to specify all required information; if a test with same API name already exists in the org, overwrite it without confirmation. Use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --force-overwrite --target-org my-org",
|
|
2870
|
+
"Preview what the agent test metadata (AiEvaluationDefinition) looks like without deploying it to your default org:\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview",
|
|
2871
|
+
"Author an Agentforce Studio (NGT) test from an NGT-shaped YAML; writes an AiTestingDefinition metadata file:\n<%= config.bin %> <%= command.id %> --spec specs/ReturnsCheckout.ngt.yaml --api-name Returns_Checkout --test-runner agentforce-studio --target-org my-org"
|
|
2874
2872
|
],
|
|
2875
2873
|
"flags": {
|
|
2876
2874
|
"json": {
|
|
@@ -2888,141 +2886,98 @@
|
|
|
2888
2886
|
"multiple": false,
|
|
2889
2887
|
"type": "option"
|
|
2890
2888
|
},
|
|
2891
|
-
"
|
|
2892
|
-
"
|
|
2893
|
-
"
|
|
2894
|
-
"summary": "API name of the agent used to filter the list of trace files you want to delete. Matches against the API name used when starting the session, either an authoring bundle or a published agent API name.",
|
|
2889
|
+
"api-name": {
|
|
2890
|
+
"name": "api-name",
|
|
2891
|
+
"summary": "API name of the new test; the API name must not exist in the org.",
|
|
2895
2892
|
"hasDynamicHelp": false,
|
|
2896
2893
|
"multiple": false,
|
|
2897
2894
|
"type": "option"
|
|
2898
2895
|
},
|
|
2899
|
-
"
|
|
2900
|
-
"name": "
|
|
2901
|
-
"summary": "
|
|
2896
|
+
"spec": {
|
|
2897
|
+
"name": "spec",
|
|
2898
|
+
"summary": "Path to the test spec YAML file.",
|
|
2902
2899
|
"hasDynamicHelp": false,
|
|
2903
2900
|
"multiple": false,
|
|
2904
2901
|
"type": "option"
|
|
2905
2902
|
},
|
|
2906
|
-
"
|
|
2907
|
-
"
|
|
2908
|
-
"
|
|
2909
|
-
"
|
|
2903
|
+
"target-org": {
|
|
2904
|
+
"char": "o",
|
|
2905
|
+
"name": "target-org",
|
|
2906
|
+
"noCacheDefault": true,
|
|
2907
|
+
"required": true,
|
|
2908
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2909
|
+
"hasDynamicHelp": true,
|
|
2910
2910
|
"multiple": false,
|
|
2911
2911
|
"type": "option"
|
|
2912
2912
|
},
|
|
2913
|
-
"
|
|
2914
|
-
"
|
|
2915
|
-
"
|
|
2916
|
-
"allowNo": false,
|
|
2917
|
-
"type": "boolean"
|
|
2918
|
-
}
|
|
2919
|
-
},
|
|
2920
|
-
"hasDynamicHelp": false,
|
|
2921
|
-
"hiddenAliases": [],
|
|
2922
|
-
"id": "agent:trace:delete",
|
|
2923
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
2924
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
2925
|
-
"pluginType": "core",
|
|
2926
|
-
"strict": true,
|
|
2927
|
-
"summary": "Delete trace files from an agent preview session.",
|
|
2928
|
-
"enableJsonFlag": true,
|
|
2929
|
-
"requiresProject": true,
|
|
2930
|
-
"errorCodes": {
|
|
2931
|
-
"header": "ERROR CODES",
|
|
2932
|
-
"body": [
|
|
2933
|
-
{
|
|
2934
|
-
"name": "Succeeded (0)",
|
|
2935
|
-
"description": "Traces deleted successfully (or no traces matched)."
|
|
2936
|
-
}
|
|
2937
|
-
]
|
|
2938
|
-
},
|
|
2939
|
-
"isESM": true,
|
|
2940
|
-
"relativePath": [
|
|
2941
|
-
"lib",
|
|
2942
|
-
"commands",
|
|
2943
|
-
"agent",
|
|
2944
|
-
"trace",
|
|
2945
|
-
"delete.js"
|
|
2946
|
-
],
|
|
2947
|
-
"aliasPermutations": [],
|
|
2948
|
-
"permutations": [
|
|
2949
|
-
"agent:trace:delete",
|
|
2950
|
-
"trace:agent:delete",
|
|
2951
|
-
"trace:delete:agent",
|
|
2952
|
-
"agent:delete:trace",
|
|
2953
|
-
"delete:agent:trace",
|
|
2954
|
-
"delete:trace:agent"
|
|
2955
|
-
]
|
|
2956
|
-
},
|
|
2957
|
-
"agent:trace:list": {
|
|
2958
|
-
"aliases": [],
|
|
2959
|
-
"args": {},
|
|
2960
|
-
"description": "When you run an agent preview conversation (either interactive or programmatic), trace files are automatically recorded and saved in your local DX project. By default, this command lists all trace files for all agents and all of their sessions. Use flags to narrow results: filter by agent name (--agent), by session (--session-id), or by date (--since).\n\nEach row in the output corresponds to one trace file, which in turn corresponds to one agent session. The Agent column shows the authoring bundle or API name used when starting the session.",
|
|
2961
|
-
"examples": [
|
|
2962
|
-
"List all trace files for all agents and sessions:\n<%= config.bin %> <%= command.id %>",
|
|
2963
|
-
"List all trace files for a specific agent:\n<%= config.bin %> <%= command.id %> --agent My_Agent",
|
|
2964
|
-
"List trace files for a specific session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
2965
|
-
"List trace files recorded on or after April 20, 2026 (date-only, interpreted as UTC midnight):\n<%= config.bin %> <%= command.id %> --since 2026-04-20",
|
|
2966
|
-
"List trace files recorded on or after a specific UTC time:\n<%= config.bin %> <%= command.id %> --since 2026-04-20T14:00:00Z",
|
|
2967
|
-
"Filter by agent and date together:\n<%= config.bin %> <%= command.id %> --agent My_Agent --since 2026-04-20",
|
|
2968
|
-
"Return results as JSON:\n<%= config.bin %> <%= command.id %> --json"
|
|
2969
|
-
],
|
|
2970
|
-
"flags": {
|
|
2971
|
-
"json": {
|
|
2972
|
-
"description": "Format output as json.",
|
|
2973
|
-
"helpGroup": "GLOBAL",
|
|
2974
|
-
"name": "json",
|
|
2975
|
-
"allowNo": false,
|
|
2976
|
-
"type": "boolean"
|
|
2977
|
-
},
|
|
2978
|
-
"flags-dir": {
|
|
2979
|
-
"helpGroup": "GLOBAL",
|
|
2980
|
-
"name": "flags-dir",
|
|
2981
|
-
"summary": "Import flag values from a directory.",
|
|
2913
|
+
"api-version": {
|
|
2914
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2915
|
+
"name": "api-version",
|
|
2982
2916
|
"hasDynamicHelp": false,
|
|
2983
2917
|
"multiple": false,
|
|
2984
2918
|
"type": "option"
|
|
2985
2919
|
},
|
|
2986
|
-
"
|
|
2987
|
-
"name": "
|
|
2988
|
-
"summary": "
|
|
2989
|
-
"
|
|
2990
|
-
"
|
|
2991
|
-
"type": "option"
|
|
2920
|
+
"preview": {
|
|
2921
|
+
"name": "preview",
|
|
2922
|
+
"summary": "Preview the test metadata file without deploying to your org.",
|
|
2923
|
+
"allowNo": false,
|
|
2924
|
+
"type": "boolean"
|
|
2992
2925
|
},
|
|
2993
|
-
"
|
|
2994
|
-
"
|
|
2995
|
-
"
|
|
2996
|
-
"
|
|
2997
|
-
"
|
|
2998
|
-
"multiple": false,
|
|
2999
|
-
"type": "option"
|
|
2926
|
+
"force-overwrite": {
|
|
2927
|
+
"name": "force-overwrite",
|
|
2928
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test (based on API name) in your org.",
|
|
2929
|
+
"allowNo": false,
|
|
2930
|
+
"type": "boolean"
|
|
3000
2931
|
},
|
|
3001
|
-
"
|
|
3002
|
-
"description": "
|
|
3003
|
-
"name": "
|
|
3004
|
-
"summary": "
|
|
2932
|
+
"test-runner": {
|
|
2933
|
+
"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.",
|
|
2934
|
+
"name": "test-runner",
|
|
2935
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3005
2936
|
"hasDynamicHelp": false,
|
|
3006
2937
|
"multiple": false,
|
|
2938
|
+
"options": [
|
|
2939
|
+
"agentforce-studio",
|
|
2940
|
+
"testing-center"
|
|
2941
|
+
],
|
|
3007
2942
|
"type": "option"
|
|
3008
2943
|
}
|
|
3009
2944
|
},
|
|
3010
|
-
"hasDynamicHelp":
|
|
2945
|
+
"hasDynamicHelp": true,
|
|
3011
2946
|
"hiddenAliases": [],
|
|
3012
|
-
"id": "agent:
|
|
2947
|
+
"id": "agent:test:create",
|
|
3013
2948
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3014
2949
|
"pluginName": "@salesforce/plugin-agent",
|
|
3015
2950
|
"pluginType": "core",
|
|
3016
2951
|
"strict": true,
|
|
3017
|
-
"summary": "
|
|
2952
|
+
"summary": "Create an agent test in your org using a local test spec YAML file.",
|
|
3018
2953
|
"enableJsonFlag": true,
|
|
3019
|
-
"
|
|
2954
|
+
"envVariablesSection": {
|
|
2955
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2956
|
+
"body": [
|
|
2957
|
+
{
|
|
2958
|
+
"name": "SF_TARGET_ORG",
|
|
2959
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2960
|
+
}
|
|
2961
|
+
]
|
|
2962
|
+
},
|
|
3020
2963
|
"errorCodes": {
|
|
3021
2964
|
"header": "ERROR CODES",
|
|
3022
2965
|
"body": [
|
|
3023
2966
|
{
|
|
3024
2967
|
"name": "Succeeded (0)",
|
|
3025
|
-
"description": "
|
|
2968
|
+
"description": "Test created and deployed successfully."
|
|
2969
|
+
},
|
|
2970
|
+
{
|
|
2971
|
+
"name": "Failed (1)",
|
|
2972
|
+
"description": "Test validation errors or metadata format issues."
|
|
2973
|
+
},
|
|
2974
|
+
{
|
|
2975
|
+
"name": "NotFound (2)",
|
|
2976
|
+
"description": "Test spec file not found or org connection failed."
|
|
2977
|
+
},
|
|
2978
|
+
{
|
|
2979
|
+
"name": "DeploymentFailed (4)",
|
|
2980
|
+
"description": "Deployment failed due to API or network errors."
|
|
3026
2981
|
}
|
|
3027
2982
|
]
|
|
3028
2983
|
},
|
|
@@ -3031,31 +2986,26 @@
|
|
|
3031
2986
|
"lib",
|
|
3032
2987
|
"commands",
|
|
3033
2988
|
"agent",
|
|
3034
|
-
"
|
|
3035
|
-
"
|
|
2989
|
+
"test",
|
|
2990
|
+
"create.js"
|
|
3036
2991
|
],
|
|
3037
2992
|
"aliasPermutations": [],
|
|
3038
2993
|
"permutations": [
|
|
3039
|
-
"agent:
|
|
3040
|
-
"
|
|
3041
|
-
"
|
|
3042
|
-
"agent:
|
|
3043
|
-
"
|
|
3044
|
-
"
|
|
2994
|
+
"agent:test:create",
|
|
2995
|
+
"test:agent:create",
|
|
2996
|
+
"test:create:agent",
|
|
2997
|
+
"agent:create:test",
|
|
2998
|
+
"create:agent:test",
|
|
2999
|
+
"create:test:agent"
|
|
3045
3000
|
]
|
|
3046
3001
|
},
|
|
3047
|
-
"agent:
|
|
3002
|
+
"agent:test:list": {
|
|
3048
3003
|
"aliases": [],
|
|
3049
3004
|
"args": {},
|
|
3050
|
-
"description": "
|
|
3005
|
+
"description": "The command outputs a table with the name (API name) of each test along with its unique ID, type ('agentforce-studio' or 'testing-center'), and the date it was created in the org.",
|
|
3051
3006
|
"examples": [
|
|
3052
|
-
"
|
|
3053
|
-
"
|
|
3054
|
-
"Drill into action execution across all turns:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension actions",
|
|
3055
|
-
"Drill into routing decisions for the first turn of the conversation:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension routing --turn 1",
|
|
3056
|
-
"Show all errors across the session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension errors",
|
|
3057
|
-
"Output raw trace JSON for custom parsing:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format raw",
|
|
3058
|
-
"Return results as JSON:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --json"
|
|
3007
|
+
"List the agent tests in your default org:\n<%= config.bin %> <%= command.id %>",
|
|
3008
|
+
"List the agent tests in an org with alias \"my-org\"\"\n<%= config.bin %> <%= command.id %> --target-org my-org"
|
|
3059
3009
|
],
|
|
3060
3010
|
"flags": {
|
|
3061
3011
|
"json": {
|
|
@@ -3073,89 +3023,81 @@
|
|
|
3073
3023
|
"multiple": false,
|
|
3074
3024
|
"type": "option"
|
|
3075
3025
|
},
|
|
3076
|
-
"
|
|
3077
|
-
"char": "
|
|
3078
|
-
"name": "
|
|
3026
|
+
"target-org": {
|
|
3027
|
+
"char": "o",
|
|
3028
|
+
"name": "target-org",
|
|
3029
|
+
"noCacheDefault": true,
|
|
3079
3030
|
"required": true,
|
|
3080
|
-
"summary": "
|
|
3081
|
-
"hasDynamicHelp":
|
|
3082
|
-
"multiple": false,
|
|
3083
|
-
"type": "option"
|
|
3084
|
-
},
|
|
3085
|
-
"format": {
|
|
3086
|
-
"char": "f",
|
|
3087
|
-
"name": "format",
|
|
3088
|
-
"summary": "Output format of the trace data; specifies the level of detail you want in the trace files.",
|
|
3089
|
-
"default": "summary",
|
|
3090
|
-
"hasDynamicHelp": false,
|
|
3091
|
-
"multiple": false,
|
|
3092
|
-
"options": [
|
|
3093
|
-
"summary",
|
|
3094
|
-
"detail",
|
|
3095
|
-
"raw"
|
|
3096
|
-
],
|
|
3097
|
-
"type": "option"
|
|
3098
|
-
},
|
|
3099
|
-
"dimension": {
|
|
3100
|
-
"char": "d",
|
|
3101
|
-
"name": "dimension",
|
|
3102
|
-
"summary": "Dimension to drill into when using \"--format detail\"; used to filter and organize the trace data to answer a specific type of question.",
|
|
3103
|
-
"hasDynamicHelp": false,
|
|
3104
|
-
"multiple": false,
|
|
3105
|
-
"options": [
|
|
3106
|
-
"actions",
|
|
3107
|
-
"grounding",
|
|
3108
|
-
"routing",
|
|
3109
|
-
"errors"
|
|
3110
|
-
],
|
|
3031
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3032
|
+
"hasDynamicHelp": true,
|
|
3033
|
+
"multiple": false,
|
|
3111
3034
|
"type": "option"
|
|
3112
3035
|
},
|
|
3113
|
-
"
|
|
3114
|
-
"
|
|
3115
|
-
"name": "
|
|
3116
|
-
"summary": "Turn number for which you want trace data. A turn is a single utterance or response in a conversation, starting with 1.",
|
|
3036
|
+
"api-version": {
|
|
3037
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3038
|
+
"name": "api-version",
|
|
3117
3039
|
"hasDynamicHelp": false,
|
|
3118
3040
|
"multiple": false,
|
|
3119
3041
|
"type": "option"
|
|
3120
3042
|
}
|
|
3121
3043
|
},
|
|
3122
|
-
"hasDynamicHelp":
|
|
3044
|
+
"hasDynamicHelp": true,
|
|
3123
3045
|
"hiddenAliases": [],
|
|
3124
|
-
"id": "agent:
|
|
3046
|
+
"id": "agent:test:list",
|
|
3125
3047
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3126
3048
|
"pluginName": "@salesforce/plugin-agent",
|
|
3127
3049
|
"pluginType": "core",
|
|
3128
3050
|
"strict": true,
|
|
3129
|
-
"summary": "
|
|
3051
|
+
"summary": "List the available agent tests in your org.",
|
|
3130
3052
|
"enableJsonFlag": true,
|
|
3131
|
-
"
|
|
3053
|
+
"envVariablesSection": {
|
|
3054
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
3055
|
+
"body": [
|
|
3056
|
+
{
|
|
3057
|
+
"name": "SF_TARGET_ORG",
|
|
3058
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3059
|
+
}
|
|
3060
|
+
]
|
|
3061
|
+
},
|
|
3062
|
+
"errorCodes": {
|
|
3063
|
+
"header": "ERROR CODES",
|
|
3064
|
+
"body": [
|
|
3065
|
+
{
|
|
3066
|
+
"name": "Succeeded (0)",
|
|
3067
|
+
"description": "Agent tests listed successfully."
|
|
3068
|
+
},
|
|
3069
|
+
{
|
|
3070
|
+
"name": "Failed (4)",
|
|
3071
|
+
"description": "Failed to retrieve agent tests due to API or network errors."
|
|
3072
|
+
}
|
|
3073
|
+
]
|
|
3074
|
+
},
|
|
3132
3075
|
"isESM": true,
|
|
3133
3076
|
"relativePath": [
|
|
3134
3077
|
"lib",
|
|
3135
3078
|
"commands",
|
|
3136
3079
|
"agent",
|
|
3137
|
-
"
|
|
3138
|
-
"
|
|
3080
|
+
"test",
|
|
3081
|
+
"list.js"
|
|
3139
3082
|
],
|
|
3140
3083
|
"aliasPermutations": [],
|
|
3141
3084
|
"permutations": [
|
|
3142
|
-
"agent:
|
|
3143
|
-
"
|
|
3144
|
-
"
|
|
3145
|
-
"agent:
|
|
3146
|
-
"
|
|
3147
|
-
"
|
|
3085
|
+
"agent:test:list",
|
|
3086
|
+
"test:agent:list",
|
|
3087
|
+
"test:list:agent",
|
|
3088
|
+
"agent:list:test",
|
|
3089
|
+
"list:agent:test",
|
|
3090
|
+
"list:test:agent"
|
|
3148
3091
|
]
|
|
3149
3092
|
},
|
|
3150
|
-
"agent:test:
|
|
3093
|
+
"agent:test:results": {
|
|
3151
3094
|
"aliases": [],
|
|
3152
3095
|
"args": {},
|
|
3153
|
-
"description": "
|
|
3096
|
+
"description": "This command requires a job ID, which the original \"agent test run\" command displays when it completes. You can also use the --use-most-recent flag to see results for the most recently run agent test.\n\nBy default, this command outputs test results in human-readable tables for each test case. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
3154
3097
|
"examples": [
|
|
3155
|
-
"
|
|
3156
|
-
"
|
|
3157
|
-
"
|
|
3158
|
-
"Author an Agentforce Studio (NGT) test from an NGT-shaped YAML; writes an AiTestingDefinition metadata file:\n<%= config.bin %> <%= command.id %> --spec specs/ReturnsCheckout.ngt.yaml --api-name Returns_Checkout --test-runner agentforce-studio --target-org my-org"
|
|
3098
|
+
"Get the results of an agent test run in your default org using its job ID:\n<%= config.bin %> <%= command.id %> --job-id 4KBfake0000003F4AQ",
|
|
3099
|
+
"Get the results of the most recently run agent test in an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-org",
|
|
3100
|
+
"Get the results of the most recently run agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
3159
3101
|
],
|
|
3160
3102
|
"flags": {
|
|
3161
3103
|
"json": {
|
|
@@ -3173,20 +3115,6 @@
|
|
|
3173
3115
|
"multiple": false,
|
|
3174
3116
|
"type": "option"
|
|
3175
3117
|
},
|
|
3176
|
-
"api-name": {
|
|
3177
|
-
"name": "api-name",
|
|
3178
|
-
"summary": "API name of the new test; the API name must not exist in the org.",
|
|
3179
|
-
"hasDynamicHelp": false,
|
|
3180
|
-
"multiple": false,
|
|
3181
|
-
"type": "option"
|
|
3182
|
-
},
|
|
3183
|
-
"spec": {
|
|
3184
|
-
"name": "spec",
|
|
3185
|
-
"summary": "Path to the test spec YAML file.",
|
|
3186
|
-
"hasDynamicHelp": false,
|
|
3187
|
-
"multiple": false,
|
|
3188
|
-
"type": "option"
|
|
3189
|
-
},
|
|
3190
3118
|
"target-org": {
|
|
3191
3119
|
"char": "o",
|
|
3192
3120
|
"name": "target-org",
|
|
@@ -3204,17 +3132,37 @@
|
|
|
3204
3132
|
"multiple": false,
|
|
3205
3133
|
"type": "option"
|
|
3206
3134
|
},
|
|
3207
|
-
"
|
|
3208
|
-
"
|
|
3209
|
-
"
|
|
3210
|
-
"
|
|
3211
|
-
"
|
|
3135
|
+
"job-id": {
|
|
3136
|
+
"char": "i",
|
|
3137
|
+
"name": "job-id",
|
|
3138
|
+
"required": true,
|
|
3139
|
+
"summary": "Job ID of the completed agent test run.",
|
|
3140
|
+
"hasDynamicHelp": false,
|
|
3141
|
+
"multiple": false,
|
|
3142
|
+
"type": "option"
|
|
3212
3143
|
},
|
|
3213
|
-
"
|
|
3214
|
-
"name": "
|
|
3215
|
-
"summary": "
|
|
3216
|
-
"
|
|
3217
|
-
"
|
|
3144
|
+
"result-format": {
|
|
3145
|
+
"name": "result-format",
|
|
3146
|
+
"summary": "Format of the agent test run results.",
|
|
3147
|
+
"default": "human",
|
|
3148
|
+
"hasDynamicHelp": false,
|
|
3149
|
+
"multiple": false,
|
|
3150
|
+
"options": [
|
|
3151
|
+
"json",
|
|
3152
|
+
"human",
|
|
3153
|
+
"junit",
|
|
3154
|
+
"tap"
|
|
3155
|
+
],
|
|
3156
|
+
"type": "option"
|
|
3157
|
+
},
|
|
3158
|
+
"output-dir": {
|
|
3159
|
+
"char": "d",
|
|
3160
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
3161
|
+
"name": "output-dir",
|
|
3162
|
+
"summary": "Directory to write the agent test results into.",
|
|
3163
|
+
"hasDynamicHelp": false,
|
|
3164
|
+
"multiple": false,
|
|
3165
|
+
"type": "option"
|
|
3218
3166
|
},
|
|
3219
3167
|
"test-runner": {
|
|
3220
3168
|
"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.",
|
|
@@ -3227,16 +3175,23 @@
|
|
|
3227
3175
|
"testing-center"
|
|
3228
3176
|
],
|
|
3229
3177
|
"type": "option"
|
|
3178
|
+
},
|
|
3179
|
+
"verbose": {
|
|
3180
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3181
|
+
"name": "verbose",
|
|
3182
|
+
"summary": "Show generated data in the test results output.",
|
|
3183
|
+
"allowNo": false,
|
|
3184
|
+
"type": "boolean"
|
|
3230
3185
|
}
|
|
3231
3186
|
},
|
|
3232
3187
|
"hasDynamicHelp": true,
|
|
3233
3188
|
"hiddenAliases": [],
|
|
3234
|
-
"id": "agent:test:
|
|
3189
|
+
"id": "agent:test:results",
|
|
3235
3190
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3236
3191
|
"pluginName": "@salesforce/plugin-agent",
|
|
3237
3192
|
"pluginType": "core",
|
|
3238
3193
|
"strict": true,
|
|
3239
|
-
"summary": "
|
|
3194
|
+
"summary": "Get the results of a completed agent test run.",
|
|
3240
3195
|
"enableJsonFlag": true,
|
|
3241
3196
|
"envVariablesSection": {
|
|
3242
3197
|
"header": "ENVIRONMENT VARIABLES",
|
|
@@ -3252,19 +3207,15 @@
|
|
|
3252
3207
|
"body": [
|
|
3253
3208
|
{
|
|
3254
3209
|
"name": "Succeeded (0)",
|
|
3255
|
-
"description": "Test
|
|
3256
|
-
},
|
|
3257
|
-
{
|
|
3258
|
-
"name": "Failed (1)",
|
|
3259
|
-
"description": "Test validation errors or metadata format issues."
|
|
3210
|
+
"description": "Results retrieved successfully. Test results (passed/failed) are in the output."
|
|
3260
3211
|
},
|
|
3261
3212
|
{
|
|
3262
3213
|
"name": "NotFound (2)",
|
|
3263
|
-
"description": "
|
|
3214
|
+
"description": "Job ID not found or invalid."
|
|
3264
3215
|
},
|
|
3265
3216
|
{
|
|
3266
|
-
"name": "
|
|
3267
|
-
"description": "
|
|
3217
|
+
"name": "Failed (4)",
|
|
3218
|
+
"description": "Failed to retrieve results due to API or network errors."
|
|
3268
3219
|
}
|
|
3269
3220
|
]
|
|
3270
3221
|
},
|
|
@@ -3274,25 +3225,26 @@
|
|
|
3274
3225
|
"commands",
|
|
3275
3226
|
"agent",
|
|
3276
3227
|
"test",
|
|
3277
|
-
"
|
|
3228
|
+
"results.js"
|
|
3278
3229
|
],
|
|
3279
3230
|
"aliasPermutations": [],
|
|
3280
3231
|
"permutations": [
|
|
3281
|
-
"agent:test:
|
|
3282
|
-
"test:agent:
|
|
3283
|
-
"test:
|
|
3284
|
-
"agent:
|
|
3285
|
-
"
|
|
3286
|
-
"
|
|
3232
|
+
"agent:test:results",
|
|
3233
|
+
"test:agent:results",
|
|
3234
|
+
"test:results:agent",
|
|
3235
|
+
"agent:results:test",
|
|
3236
|
+
"results:agent:test",
|
|
3237
|
+
"results:test:agent"
|
|
3287
3238
|
]
|
|
3288
3239
|
},
|
|
3289
|
-
"agent:test:
|
|
3240
|
+
"agent:test:resume": {
|
|
3290
3241
|
"aliases": [],
|
|
3291
3242
|
"args": {},
|
|
3292
|
-
"description": "
|
|
3243
|
+
"description": "This command requires a job ID, which the original \"agent test run\" command displays when it completes. You can also use the --use-most-recent flag to see results for the most recently run agent test.\n\nUse the --wait flag to specify the number of minutes for this command to wait for the agent test to complete; if the test completes by the end of the wait time, the command displays the test results. If not, the CLI returns control of the terminal to you, and you must run \"agent test resume\" again.\n\nBy default, this command outputs test results in human-readable tables for each test case. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
3293
3244
|
"examples": [
|
|
3294
|
-
"
|
|
3295
|
-
"
|
|
3245
|
+
"Resume an agent test in your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 4KBfake0000003F4AQ",
|
|
3246
|
+
"Resume the most recently-run agent test in an org with alias \"my-org\" org; wait 10 minutes for the tests to finish:\n<%= config.bin %> <%= command.id %> --use-most-recent --wait 10 --target-org my-org",
|
|
3247
|
+
"Resume the most recent agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
3296
3248
|
],
|
|
3297
3249
|
"flags": {
|
|
3298
3250
|
"json": {
|
|
@@ -3326,16 +3278,82 @@
|
|
|
3326
3278
|
"hasDynamicHelp": false,
|
|
3327
3279
|
"multiple": false,
|
|
3328
3280
|
"type": "option"
|
|
3281
|
+
},
|
|
3282
|
+
"job-id": {
|
|
3283
|
+
"char": "i",
|
|
3284
|
+
"name": "job-id",
|
|
3285
|
+
"summary": "Job ID of the original agent test run.",
|
|
3286
|
+
"hasDynamicHelp": false,
|
|
3287
|
+
"multiple": false,
|
|
3288
|
+
"type": "option"
|
|
3289
|
+
},
|
|
3290
|
+
"use-most-recent": {
|
|
3291
|
+
"char": "r",
|
|
3292
|
+
"name": "use-most-recent",
|
|
3293
|
+
"summary": "Use the job ID of the most recent agent test run.",
|
|
3294
|
+
"allowNo": false,
|
|
3295
|
+
"type": "boolean"
|
|
3296
|
+
},
|
|
3297
|
+
"wait": {
|
|
3298
|
+
"char": "w",
|
|
3299
|
+
"name": "wait",
|
|
3300
|
+
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
3301
|
+
"default": "5 minutes",
|
|
3302
|
+
"hasDynamicHelp": true,
|
|
3303
|
+
"multiple": false,
|
|
3304
|
+
"type": "option"
|
|
3305
|
+
},
|
|
3306
|
+
"result-format": {
|
|
3307
|
+
"name": "result-format",
|
|
3308
|
+
"summary": "Format of the agent test run results.",
|
|
3309
|
+
"default": "human",
|
|
3310
|
+
"hasDynamicHelp": false,
|
|
3311
|
+
"multiple": false,
|
|
3312
|
+
"options": [
|
|
3313
|
+
"json",
|
|
3314
|
+
"human",
|
|
3315
|
+
"junit",
|
|
3316
|
+
"tap"
|
|
3317
|
+
],
|
|
3318
|
+
"type": "option"
|
|
3319
|
+
},
|
|
3320
|
+
"output-dir": {
|
|
3321
|
+
"char": "d",
|
|
3322
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
3323
|
+
"name": "output-dir",
|
|
3324
|
+
"summary": "Directory to write the agent test results into.",
|
|
3325
|
+
"hasDynamicHelp": false,
|
|
3326
|
+
"multiple": false,
|
|
3327
|
+
"type": "option"
|
|
3328
|
+
},
|
|
3329
|
+
"test-runner": {
|
|
3330
|
+
"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.",
|
|
3331
|
+
"name": "test-runner",
|
|
3332
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3333
|
+
"hasDynamicHelp": false,
|
|
3334
|
+
"multiple": false,
|
|
3335
|
+
"options": [
|
|
3336
|
+
"agentforce-studio",
|
|
3337
|
+
"testing-center"
|
|
3338
|
+
],
|
|
3339
|
+
"type": "option"
|
|
3340
|
+
},
|
|
3341
|
+
"verbose": {
|
|
3342
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3343
|
+
"name": "verbose",
|
|
3344
|
+
"summary": "Show generated data in the test results output.",
|
|
3345
|
+
"allowNo": false,
|
|
3346
|
+
"type": "boolean"
|
|
3329
3347
|
}
|
|
3330
3348
|
},
|
|
3331
3349
|
"hasDynamicHelp": true,
|
|
3332
3350
|
"hiddenAliases": [],
|
|
3333
|
-
"id": "agent:test:
|
|
3351
|
+
"id": "agent:test:resume",
|
|
3334
3352
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3335
3353
|
"pluginName": "@salesforce/plugin-agent",
|
|
3336
3354
|
"pluginType": "core",
|
|
3337
3355
|
"strict": true,
|
|
3338
|
-
"summary": "
|
|
3356
|
+
"summary": "Resume an agent test that you previously started in your org so you can view the test results.",
|
|
3339
3357
|
"enableJsonFlag": true,
|
|
3340
3358
|
"envVariablesSection": {
|
|
3341
3359
|
"header": "ENVIRONMENT VARIABLES",
|
|
@@ -3351,11 +3369,19 @@
|
|
|
3351
3369
|
"body": [
|
|
3352
3370
|
{
|
|
3353
3371
|
"name": "Succeeded (0)",
|
|
3354
|
-
"description": "
|
|
3372
|
+
"description": "Test completed successfully (with test results in the output)."
|
|
3355
3373
|
},
|
|
3356
3374
|
{
|
|
3357
|
-
"name": "Failed (
|
|
3358
|
-
"description": "
|
|
3375
|
+
"name": "Failed (1)",
|
|
3376
|
+
"description": "Tests encountered execution errors (test cases with ERROR status)."
|
|
3377
|
+
},
|
|
3378
|
+
{
|
|
3379
|
+
"name": "NotFound (2)",
|
|
3380
|
+
"description": "Job ID not found or invalid."
|
|
3381
|
+
},
|
|
3382
|
+
{
|
|
3383
|
+
"name": "OperationFailed (4)",
|
|
3384
|
+
"description": "Failed to poll test due to API or network errors."
|
|
3359
3385
|
}
|
|
3360
3386
|
]
|
|
3361
3387
|
},
|
|
@@ -3365,26 +3391,29 @@
|
|
|
3365
3391
|
"commands",
|
|
3366
3392
|
"agent",
|
|
3367
3393
|
"test",
|
|
3368
|
-
"
|
|
3394
|
+
"resume.js"
|
|
3369
3395
|
],
|
|
3370
3396
|
"aliasPermutations": [],
|
|
3371
3397
|
"permutations": [
|
|
3372
|
-
"agent:test:
|
|
3373
|
-
"test:agent:
|
|
3374
|
-
"test:
|
|
3375
|
-
"agent:
|
|
3376
|
-
"
|
|
3377
|
-
"
|
|
3398
|
+
"agent:test:resume",
|
|
3399
|
+
"test:agent:resume",
|
|
3400
|
+
"test:resume:agent",
|
|
3401
|
+
"agent:resume:test",
|
|
3402
|
+
"resume:agent:test",
|
|
3403
|
+
"resume:test:agent"
|
|
3378
3404
|
]
|
|
3379
3405
|
},
|
|
3380
|
-
"agent:test:
|
|
3406
|
+
"agent:test:run-eval": {
|
|
3381
3407
|
"aliases": [],
|
|
3382
3408
|
"args": {},
|
|
3383
|
-
"description": "
|
|
3409
|
+
"description": "Specify the tests you want to run with one of these inputs to the --spec flag:\n\n- YAML test spec generated by the `agent generate test-spec` CLI command\n- JSON payload\n\nWhen you provide a YAML test spec, this command automatically translates test cases into internal state-based evaluation framework calls and infers the agent name from the test spec's `subjectName` field. As a result, you can use the same test spec with both the `agent test run` and `agent test run-eval` commands. YAML test specs also support context variables, which allow you to inject contextual data (such as CaseId or RoutableId) into agent sessions for testing with different contexts.\n\nWhen you provide a JSON payload, it's sent directly to the evaluation framework with optional normalization. The normalizer auto-corrects common field name mistakes, converts shorthand references to JSONPath, and injects defaults. Use `--no-normalize` to disable this auto-normalization. JSON payloads can also include context_variables on agent.create_session steps for the same contextual testing capabilities as when you use a YAML test spec.\n\nThis command supports more than 8 evaluator types, including subagent routing assertions, action invocation checks, string/numeric assertions, semantic similarity scoring, and LLM-based quality ratings.",
|
|
3384
3410
|
"examples": [
|
|
3385
|
-
"
|
|
3386
|
-
"
|
|
3387
|
-
"
|
|
3411
|
+
"Run tests using a YAML test spec on the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --spec specs/my-agent-testSpec.yaml --target-org my-org",
|
|
3412
|
+
"Run tests using a YAML spec with explicit agent name override; use your default org:\n<%= config.bin %> <%= command.id %> --spec specs/my-agent-testSpec.yaml --api-name My_Agent",
|
|
3413
|
+
"Run tests using a JSON payload:\n<%= config.bin %> <%= command.id %> --spec specs/eval-payload.json --target-org my-org",
|
|
3414
|
+
"Run tests and output results in JUnit format; useful for continuous integration and deployment (CI/CD):\n<%= config.bin %> <%= command.id %> --spec specs/my-agent-testSpec.yaml --target-org my-org --result-format junit",
|
|
3415
|
+
"Run tests with contextVariables to inject contextual data into agent sessions (add contextVariables to test cases in your YAML spec):\n<%= config.bin %> <%= command.id %> --spec specs/agent-with-context.yaml --target-org my-org",
|
|
3416
|
+
"Pipe JSON payload from stdin (--spec flag is automatically populated from stdin):\n$ echo '{\"tests\":[...]}' | <%= config.bin %> <%= command.id %> --spec --target-org my-org"
|
|
3388
3417
|
],
|
|
3389
3418
|
"flags": {
|
|
3390
3419
|
"json": {
|
|
@@ -3419,11 +3448,19 @@
|
|
|
3419
3448
|
"multiple": false,
|
|
3420
3449
|
"type": "option"
|
|
3421
3450
|
},
|
|
3422
|
-
"
|
|
3423
|
-
"char": "
|
|
3424
|
-
"name": "
|
|
3451
|
+
"spec": {
|
|
3452
|
+
"char": "s",
|
|
3453
|
+
"name": "spec",
|
|
3425
3454
|
"required": true,
|
|
3426
|
-
"summary": "
|
|
3455
|
+
"summary": "Path to test spec file (YAML or JSON). Supports reading from stdin when piping content.",
|
|
3456
|
+
"hasDynamicHelp": false,
|
|
3457
|
+
"multiple": false,
|
|
3458
|
+
"type": "option"
|
|
3459
|
+
},
|
|
3460
|
+
"api-name": {
|
|
3461
|
+
"char": "n",
|
|
3462
|
+
"name": "api-name",
|
|
3463
|
+
"summary": "Agent API name (also called DeveloperName) used to resolve agent_id and agent_version_id. Auto-inferred from the YAML spec's subjectName.",
|
|
3427
3464
|
"hasDynamicHelp": false,
|
|
3428
3465
|
"multiple": false,
|
|
3429
3466
|
"type": "option"
|
|
@@ -3442,43 +3479,30 @@
|
|
|
3442
3479
|
],
|
|
3443
3480
|
"type": "option"
|
|
3444
3481
|
},
|
|
3445
|
-
"
|
|
3446
|
-
"
|
|
3447
|
-
"
|
|
3448
|
-
"
|
|
3449
|
-
"summary": "Directory to write the agent test results into.",
|
|
3450
|
-
"hasDynamicHelp": false,
|
|
3451
|
-
"multiple": false,
|
|
3452
|
-
"type": "option"
|
|
3453
|
-
},
|
|
3454
|
-
"test-runner": {
|
|
3455
|
-
"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.",
|
|
3456
|
-
"name": "test-runner",
|
|
3457
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3482
|
+
"batch-size": {
|
|
3483
|
+
"name": "batch-size",
|
|
3484
|
+
"summary": "Number of tests per API request (max 5).",
|
|
3485
|
+
"default": 5,
|
|
3458
3486
|
"hasDynamicHelp": false,
|
|
3459
3487
|
"multiple": false,
|
|
3460
|
-
"options": [
|
|
3461
|
-
"agentforce-studio",
|
|
3462
|
-
"testing-center"
|
|
3463
|
-
],
|
|
3464
3488
|
"type": "option"
|
|
3465
3489
|
},
|
|
3466
|
-
"
|
|
3467
|
-
"
|
|
3468
|
-
"
|
|
3469
|
-
"summary": "Show generated data in the test results output.",
|
|
3490
|
+
"no-normalize": {
|
|
3491
|
+
"name": "no-normalize",
|
|
3492
|
+
"summary": "Disable auto-normalization of field names and shorthand references.",
|
|
3470
3493
|
"allowNo": false,
|
|
3471
3494
|
"type": "boolean"
|
|
3472
3495
|
}
|
|
3473
3496
|
},
|
|
3474
3497
|
"hasDynamicHelp": true,
|
|
3475
3498
|
"hiddenAliases": [],
|
|
3476
|
-
"id": "agent:test:
|
|
3499
|
+
"id": "agent:test:run-eval",
|
|
3477
3500
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3478
3501
|
"pluginName": "@salesforce/plugin-agent",
|
|
3479
3502
|
"pluginType": "core",
|
|
3503
|
+
"state": "beta",
|
|
3480
3504
|
"strict": true,
|
|
3481
|
-
"summary": "
|
|
3505
|
+
"summary": "Run rich evaluation tests against an Agentforce agent.",
|
|
3482
3506
|
"enableJsonFlag": true,
|
|
3483
3507
|
"envVariablesSection": {
|
|
3484
3508
|
"header": "ENVIRONMENT VARIABLES",
|
|
@@ -3494,15 +3518,19 @@
|
|
|
3494
3518
|
"body": [
|
|
3495
3519
|
{
|
|
3496
3520
|
"name": "Succeeded (0)",
|
|
3497
|
-
"description": "
|
|
3521
|
+
"description": "Tests completed successfully. Test results (passed/failed) are in the JSON output."
|
|
3522
|
+
},
|
|
3523
|
+
{
|
|
3524
|
+
"name": "Failed (1)",
|
|
3525
|
+
"description": "Tests encountered execution errors (tests couldn't run properly)."
|
|
3498
3526
|
},
|
|
3499
3527
|
{
|
|
3500
3528
|
"name": "NotFound (2)",
|
|
3501
|
-
"description": "
|
|
3529
|
+
"description": "Agent not found, spec file not found, or invalid agent name."
|
|
3502
3530
|
},
|
|
3503
3531
|
{
|
|
3504
|
-
"name": "
|
|
3505
|
-
"description": "Failed to
|
|
3532
|
+
"name": "OperationFailed (4)",
|
|
3533
|
+
"description": "Failed to execute tests due to API or network errors."
|
|
3506
3534
|
}
|
|
3507
3535
|
]
|
|
3508
3536
|
},
|
|
@@ -3512,26 +3540,26 @@
|
|
|
3512
3540
|
"commands",
|
|
3513
3541
|
"agent",
|
|
3514
3542
|
"test",
|
|
3515
|
-
"
|
|
3543
|
+
"run-eval.js"
|
|
3516
3544
|
],
|
|
3517
3545
|
"aliasPermutations": [],
|
|
3518
3546
|
"permutations": [
|
|
3519
|
-
"agent:test:
|
|
3520
|
-
"test:agent:
|
|
3521
|
-
"test:
|
|
3522
|
-
"agent:
|
|
3523
|
-
"
|
|
3524
|
-
"
|
|
3547
|
+
"agent:test:run-eval",
|
|
3548
|
+
"test:agent:run-eval",
|
|
3549
|
+
"test:run-eval:agent",
|
|
3550
|
+
"agent:run-eval:test",
|
|
3551
|
+
"run-eval:agent:test",
|
|
3552
|
+
"run-eval:test:agent"
|
|
3525
3553
|
]
|
|
3526
3554
|
},
|
|
3527
|
-
"agent:test:
|
|
3555
|
+
"agent:test:run": {
|
|
3528
3556
|
"aliases": [],
|
|
3529
3557
|
"args": {},
|
|
3530
|
-
"description": "
|
|
3558
|
+
"description": "Use the --api-name flag to specify the name of the agent test you want to run. Use the output of the \"agent test list\" command to get the names of all the available agent tests in your org.\n\nBy default, this command starts the agent test in your org, but it doesn't wait for the test to finish. Instead, it displays the \"agent test resume\" command, with a job ID, that you execute to see the results of the test run, and then returns control of the terminal window to you. Use the --wait flag to specify the number of minutes for the command to wait for the agent test to complete; if the test completes by the end of the wait time, the command displays the test results. If not, run \"agent test resume\".\n\nBy default, this command outputs test results in human-readable tables for each test case, if the test completes in time. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
3531
3559
|
"examples": [
|
|
3532
|
-
"
|
|
3533
|
-
"
|
|
3534
|
-
"
|
|
3560
|
+
"Start an agent test called Resort_Manager_Test for an agent in your default org, don't wait for the test to finish:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test",
|
|
3561
|
+
"Start an agent test for an agent in an org with alias \"my-org\" and wait for 10 minutes for the test to finish:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --target-org my-org",
|
|
3562
|
+
"Start an agent test and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --output-dir ./test-results --result-format json"
|
|
3535
3563
|
],
|
|
3536
3564
|
"flags": {
|
|
3537
3565
|
"json": {
|
|
@@ -3566,26 +3594,18 @@
|
|
|
3566
3594
|
"multiple": false,
|
|
3567
3595
|
"type": "option"
|
|
3568
3596
|
},
|
|
3569
|
-
"
|
|
3570
|
-
"char": "
|
|
3571
|
-
"name": "
|
|
3572
|
-
"summary": "
|
|
3597
|
+
"api-name": {
|
|
3598
|
+
"char": "n",
|
|
3599
|
+
"name": "api-name",
|
|
3600
|
+
"summary": "API name of the agent test to run; corresponds to the name of the AiEvaluationDefinition metadata component that implements the agent test.",
|
|
3573
3601
|
"hasDynamicHelp": false,
|
|
3574
3602
|
"multiple": false,
|
|
3575
3603
|
"type": "option"
|
|
3576
3604
|
},
|
|
3577
|
-
"use-most-recent": {
|
|
3578
|
-
"char": "r",
|
|
3579
|
-
"name": "use-most-recent",
|
|
3580
|
-
"summary": "Use the job ID of the most recent agent test run.",
|
|
3581
|
-
"allowNo": false,
|
|
3582
|
-
"type": "boolean"
|
|
3583
|
-
},
|
|
3584
3605
|
"wait": {
|
|
3585
3606
|
"char": "w",
|
|
3586
3607
|
"name": "wait",
|
|
3587
3608
|
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
3588
|
-
"default": "5 minutes",
|
|
3589
3609
|
"hasDynamicHelp": true,
|
|
3590
3610
|
"multiple": false,
|
|
3591
3611
|
"type": "option"
|
|
@@ -3635,12 +3655,12 @@
|
|
|
3635
3655
|
},
|
|
3636
3656
|
"hasDynamicHelp": true,
|
|
3637
3657
|
"hiddenAliases": [],
|
|
3638
|
-
"id": "agent:test:
|
|
3658
|
+
"id": "agent:test:run",
|
|
3639
3659
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3640
3660
|
"pluginName": "@salesforce/plugin-agent",
|
|
3641
3661
|
"pluginType": "core",
|
|
3642
3662
|
"strict": true,
|
|
3643
|
-
"summary": "
|
|
3663
|
+
"summary": "Start an agent test in your org.",
|
|
3644
3664
|
"enableJsonFlag": true,
|
|
3645
3665
|
"envVariablesSection": {
|
|
3646
3666
|
"header": "ENVIRONMENT VARIABLES",
|
|
@@ -3656,19 +3676,19 @@
|
|
|
3656
3676
|
"body": [
|
|
3657
3677
|
{
|
|
3658
3678
|
"name": "Succeeded (0)",
|
|
3659
|
-
"description": "Test
|
|
3679
|
+
"description": "Test started successfully (without --wait), or test completed successfully (with --wait)."
|
|
3660
3680
|
},
|
|
3661
3681
|
{
|
|
3662
3682
|
"name": "Failed (1)",
|
|
3663
|
-
"description": "Tests encountered execution errors (test cases with ERROR status)."
|
|
3683
|
+
"description": "Tests encountered execution errors (test cases with ERROR status when using --wait)."
|
|
3664
3684
|
},
|
|
3665
3685
|
{
|
|
3666
3686
|
"name": "NotFound (2)",
|
|
3667
|
-
"description": "
|
|
3687
|
+
"description": "Test definition not found or invalid test name."
|
|
3668
3688
|
},
|
|
3669
3689
|
{
|
|
3670
3690
|
"name": "OperationFailed (4)",
|
|
3671
|
-
"description": "Failed to poll test due to API or network errors."
|
|
3691
|
+
"description": "Failed to start or poll test due to API or network errors."
|
|
3672
3692
|
}
|
|
3673
3693
|
]
|
|
3674
3694
|
},
|
|
@@ -3678,29 +3698,124 @@
|
|
|
3678
3698
|
"commands",
|
|
3679
3699
|
"agent",
|
|
3680
3700
|
"test",
|
|
3681
|
-
"
|
|
3701
|
+
"run.js"
|
|
3682
3702
|
],
|
|
3683
3703
|
"aliasPermutations": [],
|
|
3684
3704
|
"permutations": [
|
|
3685
|
-
"agent:test:
|
|
3686
|
-
"test:agent:
|
|
3687
|
-
"test:
|
|
3688
|
-
"agent:
|
|
3689
|
-
"
|
|
3690
|
-
"
|
|
3705
|
+
"agent:test:run",
|
|
3706
|
+
"test:agent:run",
|
|
3707
|
+
"test:run:agent",
|
|
3708
|
+
"agent:run:test",
|
|
3709
|
+
"run:agent:test",
|
|
3710
|
+
"run:test:agent"
|
|
3691
3711
|
]
|
|
3692
3712
|
},
|
|
3693
|
-
"agent:
|
|
3713
|
+
"agent:trace:delete": {
|
|
3694
3714
|
"aliases": [],
|
|
3695
3715
|
"args": {},
|
|
3696
|
-
"description": "
|
|
3716
|
+
"description": "When you run an agent preview conversation (either interactive or programmatic), trace files are automatically recorded and saved in your local DX project. Use this command to delete some or all of the trace files.\n\nBy default, this command shows a preview of what will be deleted and prompts for confirmation. Use --no-prompt to skip confirmation.\n\nWithout filters, this comamnd deletes all trace files for all agents and sessions. Use flags to narrow the scope: filter by agent API name (--agent), by session (--session-id), or by age (--older-than).",
|
|
3697
3717
|
"examples": [
|
|
3698
|
-
"
|
|
3699
|
-
"
|
|
3700
|
-
"
|
|
3701
|
-
"
|
|
3702
|
-
"
|
|
3703
|
-
"
|
|
3718
|
+
"Delete all traces for all agents and sessions; prompt for confirmation:\n<%= config.bin %> <%= command.id %>",
|
|
3719
|
+
"Delete all traces for a specific agent:\n<%= config.bin %> <%= command.id %> --agent My_Agent",
|
|
3720
|
+
"Delete traces from a specific session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
3721
|
+
"Delete traces older than 7 days:\n<%= config.bin %> <%= command.id %> --older-than 7d",
|
|
3722
|
+
"Delete traces older than 24 hours for a specific agent; don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --agent My_Agent --older-than 24h --no-prompt",
|
|
3723
|
+
"Delete all traces for all agents and sessions; don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --no-prompt"
|
|
3724
|
+
],
|
|
3725
|
+
"flags": {
|
|
3726
|
+
"json": {
|
|
3727
|
+
"description": "Format output as json.",
|
|
3728
|
+
"helpGroup": "GLOBAL",
|
|
3729
|
+
"name": "json",
|
|
3730
|
+
"allowNo": false,
|
|
3731
|
+
"type": "boolean"
|
|
3732
|
+
},
|
|
3733
|
+
"flags-dir": {
|
|
3734
|
+
"helpGroup": "GLOBAL",
|
|
3735
|
+
"name": "flags-dir",
|
|
3736
|
+
"summary": "Import flag values from a directory.",
|
|
3737
|
+
"hasDynamicHelp": false,
|
|
3738
|
+
"multiple": false,
|
|
3739
|
+
"type": "option"
|
|
3740
|
+
},
|
|
3741
|
+
"agent": {
|
|
3742
|
+
"char": "a",
|
|
3743
|
+
"name": "agent",
|
|
3744
|
+
"summary": "API name of the agent used to filter the list of trace files you want to delete. Matches against the API name used when starting the session, either an authoring bundle or a published agent API name.",
|
|
3745
|
+
"hasDynamicHelp": false,
|
|
3746
|
+
"multiple": false,
|
|
3747
|
+
"type": "option"
|
|
3748
|
+
},
|
|
3749
|
+
"session-id": {
|
|
3750
|
+
"name": "session-id",
|
|
3751
|
+
"summary": "Session ID used to filter the list of trace files you want to delete. Use the \"agent preview sessions\" CLI command to list all known agent preview sessions along with their session IDs.",
|
|
3752
|
+
"hasDynamicHelp": false,
|
|
3753
|
+
"multiple": false,
|
|
3754
|
+
"type": "option"
|
|
3755
|
+
},
|
|
3756
|
+
"older-than": {
|
|
3757
|
+
"name": "older-than",
|
|
3758
|
+
"summary": "Duration used to filter the list of trace files; only files older than the duration are deleted. Accepts a number followed by a unit: m/minutes, h/hours, d/days, w/weeks. Examples: 7d, 24h, 2w.",
|
|
3759
|
+
"hasDynamicHelp": false,
|
|
3760
|
+
"multiple": false,
|
|
3761
|
+
"type": "option"
|
|
3762
|
+
},
|
|
3763
|
+
"no-prompt": {
|
|
3764
|
+
"name": "no-prompt",
|
|
3765
|
+
"summary": "Skip the confirmation prompt and delete immediately.",
|
|
3766
|
+
"allowNo": false,
|
|
3767
|
+
"type": "boolean"
|
|
3768
|
+
}
|
|
3769
|
+
},
|
|
3770
|
+
"hasDynamicHelp": false,
|
|
3771
|
+
"hiddenAliases": [],
|
|
3772
|
+
"id": "agent:trace:delete",
|
|
3773
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
3774
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
3775
|
+
"pluginType": "core",
|
|
3776
|
+
"strict": true,
|
|
3777
|
+
"summary": "Delete trace files from an agent preview session.",
|
|
3778
|
+
"enableJsonFlag": true,
|
|
3779
|
+
"requiresProject": true,
|
|
3780
|
+
"errorCodes": {
|
|
3781
|
+
"header": "ERROR CODES",
|
|
3782
|
+
"body": [
|
|
3783
|
+
{
|
|
3784
|
+
"name": "Succeeded (0)",
|
|
3785
|
+
"description": "Traces deleted successfully (or no traces matched)."
|
|
3786
|
+
}
|
|
3787
|
+
]
|
|
3788
|
+
},
|
|
3789
|
+
"isESM": true,
|
|
3790
|
+
"relativePath": [
|
|
3791
|
+
"lib",
|
|
3792
|
+
"commands",
|
|
3793
|
+
"agent",
|
|
3794
|
+
"trace",
|
|
3795
|
+
"delete.js"
|
|
3796
|
+
],
|
|
3797
|
+
"aliasPermutations": [],
|
|
3798
|
+
"permutations": [
|
|
3799
|
+
"agent:trace:delete",
|
|
3800
|
+
"trace:agent:delete",
|
|
3801
|
+
"trace:delete:agent",
|
|
3802
|
+
"agent:delete:trace",
|
|
3803
|
+
"delete:agent:trace",
|
|
3804
|
+
"delete:trace:agent"
|
|
3805
|
+
]
|
|
3806
|
+
},
|
|
3807
|
+
"agent:trace:list": {
|
|
3808
|
+
"aliases": [],
|
|
3809
|
+
"args": {},
|
|
3810
|
+
"description": "When you run an agent preview conversation (either interactive or programmatic), trace files are automatically recorded and saved in your local DX project. By default, this command lists all trace files for all agents and all of their sessions. Use flags to narrow results: filter by agent name (--agent), by session (--session-id), or by date (--since).\n\nEach row in the output corresponds to one trace file, which in turn corresponds to one agent session. The Agent column shows the authoring bundle or API name used when starting the session.",
|
|
3811
|
+
"examples": [
|
|
3812
|
+
"List all trace files for all agents and sessions:\n<%= config.bin %> <%= command.id %>",
|
|
3813
|
+
"List all trace files for a specific agent:\n<%= config.bin %> <%= command.id %> --agent My_Agent",
|
|
3814
|
+
"List trace files for a specific session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
3815
|
+
"List trace files recorded on or after April 20, 2026 (date-only, interpreted as UTC midnight):\n<%= config.bin %> <%= command.id %> --since 2026-04-20",
|
|
3816
|
+
"List trace files recorded on or after a specific UTC time:\n<%= config.bin %> <%= command.id %> --since 2026-04-20T14:00:00Z",
|
|
3817
|
+
"Filter by agent and date together:\n<%= config.bin %> <%= command.id %> --agent My_Agent --since 2026-04-20",
|
|
3818
|
+
"Return results as JSON:\n<%= config.bin %> <%= command.id %> --json"
|
|
3704
3819
|
],
|
|
3705
3820
|
"flags": {
|
|
3706
3821
|
"json": {
|
|
@@ -3718,106 +3833,46 @@
|
|
|
3718
3833
|
"multiple": false,
|
|
3719
3834
|
"type": "option"
|
|
3720
3835
|
},
|
|
3721
|
-
"
|
|
3722
|
-
"
|
|
3723
|
-
"
|
|
3724
|
-
"noCacheDefault": true,
|
|
3725
|
-
"required": true,
|
|
3726
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3727
|
-
"hasDynamicHelp": true,
|
|
3728
|
-
"multiple": false,
|
|
3729
|
-
"type": "option"
|
|
3730
|
-
},
|
|
3731
|
-
"api-version": {
|
|
3732
|
-
"description": "Override the api version used for api requests made by this command",
|
|
3733
|
-
"name": "api-version",
|
|
3734
|
-
"hasDynamicHelp": false,
|
|
3735
|
-
"multiple": false,
|
|
3736
|
-
"type": "option"
|
|
3737
|
-
},
|
|
3738
|
-
"spec": {
|
|
3739
|
-
"char": "s",
|
|
3740
|
-
"name": "spec",
|
|
3741
|
-
"required": true,
|
|
3742
|
-
"summary": "Path to test spec file (YAML or JSON). Supports reading from stdin when piping content.",
|
|
3743
|
-
"hasDynamicHelp": false,
|
|
3744
|
-
"multiple": false,
|
|
3745
|
-
"type": "option"
|
|
3746
|
-
},
|
|
3747
|
-
"api-name": {
|
|
3748
|
-
"char": "n",
|
|
3749
|
-
"name": "api-name",
|
|
3750
|
-
"summary": "Agent API name (also called DeveloperName) used to resolve agent_id and agent_version_id. Auto-inferred from the YAML spec's subjectName.",
|
|
3836
|
+
"session-id": {
|
|
3837
|
+
"name": "session-id",
|
|
3838
|
+
"summary": "Session ID used to filter the list of trace files. Use the \"agent preview sessions\" CLI command to list all known agent preview sessions along with their session IDs.",
|
|
3751
3839
|
"hasDynamicHelp": false,
|
|
3752
3840
|
"multiple": false,
|
|
3753
3841
|
"type": "option"
|
|
3754
3842
|
},
|
|
3755
|
-
"
|
|
3756
|
-
"
|
|
3757
|
-
"
|
|
3758
|
-
"
|
|
3843
|
+
"agent": {
|
|
3844
|
+
"char": "a",
|
|
3845
|
+
"name": "agent",
|
|
3846
|
+
"summary": "API name of the agent used to filter the list of available trace files. Matches against the API name used when starting the session, either an authoring bundle or a published agent API name.",
|
|
3759
3847
|
"hasDynamicHelp": false,
|
|
3760
3848
|
"multiple": false,
|
|
3761
|
-
"options": [
|
|
3762
|
-
"json",
|
|
3763
|
-
"human",
|
|
3764
|
-
"junit",
|
|
3765
|
-
"tap"
|
|
3766
|
-
],
|
|
3767
3849
|
"type": "option"
|
|
3768
3850
|
},
|
|
3769
|
-
"
|
|
3770
|
-
"
|
|
3771
|
-
"
|
|
3772
|
-
"
|
|
3851
|
+
"since": {
|
|
3852
|
+
"description": "Accepts ISO 8601 format: date-only (2026-04-20), date-time (2026-04-20T14:00:00Z), or date-time with milliseconds (2026-04-20T14:00:00.000Z). The \"Recorded At\" values shown in the table output are valid inputs.",
|
|
3853
|
+
"name": "since",
|
|
3854
|
+
"summary": "Date used to filter the list of trace files; only those recorded on or after the date are listed.",
|
|
3773
3855
|
"hasDynamicHelp": false,
|
|
3774
3856
|
"multiple": false,
|
|
3775
3857
|
"type": "option"
|
|
3776
|
-
},
|
|
3777
|
-
"no-normalize": {
|
|
3778
|
-
"name": "no-normalize",
|
|
3779
|
-
"summary": "Disable auto-normalization of field names and shorthand references.",
|
|
3780
|
-
"allowNo": false,
|
|
3781
|
-
"type": "boolean"
|
|
3782
3858
|
}
|
|
3783
3859
|
},
|
|
3784
|
-
"hasDynamicHelp":
|
|
3860
|
+
"hasDynamicHelp": false,
|
|
3785
3861
|
"hiddenAliases": [],
|
|
3786
|
-
"id": "agent:
|
|
3862
|
+
"id": "agent:trace:list",
|
|
3787
3863
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3788
3864
|
"pluginName": "@salesforce/plugin-agent",
|
|
3789
3865
|
"pluginType": "core",
|
|
3790
|
-
"state": "beta",
|
|
3791
3866
|
"strict": true,
|
|
3792
|
-
"summary": "
|
|
3867
|
+
"summary": "List the available trace files that were recorded during all agent preview sessions.",
|
|
3793
3868
|
"enableJsonFlag": true,
|
|
3794
|
-
"
|
|
3795
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
3796
|
-
"body": [
|
|
3797
|
-
{
|
|
3798
|
-
"name": "SF_TARGET_ORG",
|
|
3799
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3800
|
-
}
|
|
3801
|
-
]
|
|
3802
|
-
},
|
|
3869
|
+
"requiresProject": true,
|
|
3803
3870
|
"errorCodes": {
|
|
3804
3871
|
"header": "ERROR CODES",
|
|
3805
3872
|
"body": [
|
|
3806
3873
|
{
|
|
3807
3874
|
"name": "Succeeded (0)",
|
|
3808
|
-
"description": "
|
|
3809
|
-
},
|
|
3810
|
-
{
|
|
3811
|
-
"name": "Failed (1)",
|
|
3812
|
-
"description": "Tests encountered execution errors (tests couldn't run properly)."
|
|
3813
|
-
},
|
|
3814
|
-
{
|
|
3815
|
-
"name": "NotFound (2)",
|
|
3816
|
-
"description": "Agent not found, spec file not found, or invalid agent name."
|
|
3817
|
-
},
|
|
3818
|
-
{
|
|
3819
|
-
"name": "OperationFailed (4)",
|
|
3820
|
-
"description": "Failed to execute tests due to API or network errors."
|
|
3875
|
+
"description": "Trace files listed successfully (or empty list if none found)."
|
|
3821
3876
|
}
|
|
3822
3877
|
]
|
|
3823
3878
|
},
|
|
@@ -3826,27 +3881,31 @@
|
|
|
3826
3881
|
"lib",
|
|
3827
3882
|
"commands",
|
|
3828
3883
|
"agent",
|
|
3829
|
-
"
|
|
3830
|
-
"
|
|
3884
|
+
"trace",
|
|
3885
|
+
"list.js"
|
|
3831
3886
|
],
|
|
3832
3887
|
"aliasPermutations": [],
|
|
3833
3888
|
"permutations": [
|
|
3834
|
-
"agent:
|
|
3835
|
-
"
|
|
3836
|
-
"
|
|
3837
|
-
"agent:
|
|
3838
|
-
"
|
|
3839
|
-
"
|
|
3889
|
+
"agent:trace:list",
|
|
3890
|
+
"trace:agent:list",
|
|
3891
|
+
"trace:list:agent",
|
|
3892
|
+
"agent:list:trace",
|
|
3893
|
+
"list:agent:trace",
|
|
3894
|
+
"list:trace:agent"
|
|
3840
3895
|
]
|
|
3841
3896
|
},
|
|
3842
|
-
"agent:
|
|
3897
|
+
"agent:trace:read": {
|
|
3843
3898
|
"aliases": [],
|
|
3844
3899
|
"args": {},
|
|
3845
|
-
"description": "
|
|
3900
|
+
"description": "When you run an agent preview conversation (either interactive or programmatic), trace files are automatically recorded and saved in your local DX project. Each turn (utterance or response) of a conversation creates trace data. Use this command to view trace data for a specific preview session, so you can then analyze the trace data to observe, monitor, investigate, and troubleshoot agent events and behavior.\n\nUse the --format flag to specify one of these formats of the outputted trace data:\n\n- summary (Default): A per-turn narrative showing topic routing, actions executed, and the agent's response. Use this to quickly understand what happened in a preview session.\n- detail: Diagnostic drill-down into a specific dimension. Filters output to only the trace steps relevant to that dimension, minimizing noise.\n- raw: Unprocessed trace JSON. Use this as a fallback when the trace schema has changed or you need to perform custom analysis.\n\nIf you specify \"--format detail\", you must also specify a dimension with the --dimension flag. Dimensions are a way to slice and analyze the agent execution trace from a specific angle or concern. Instead of looking at the raw sequence of everything that happened, each dimension filters and organizes the trace data to answer a specific type of question. These are the available dimensions and the information they provide:\n\n- actions: The actions the agent executed. Includes action name, input parameters, output, and latency. Use this dimension to understand what the agent actually did when answering an utterance in the preview session.\n- grounding: The reasoning steps used by the LLM. Use this dimension to see how the agent \"thought\" about the problem - the AI reasoning that determined which actions to take.\n- routing: How the agent navigated between subagents. Use this dimension to understand conversation flow - when and why the agent switched between different subagents or contexts during the conversation.\n- errors: Aggregates all errors during the session. Use this dimension to quickly identify and debug issues across all steps.",
|
|
3846
3901
|
"examples": [
|
|
3847
|
-
"
|
|
3848
|
-
"
|
|
3849
|
-
"
|
|
3902
|
+
"Show a session trace summary for all turns in the session with the specified ID:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
3903
|
+
"Show a trace summary for the second turn (utterance or response) of the conversation:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --turn 2",
|
|
3904
|
+
"Drill into action execution across all turns:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension actions",
|
|
3905
|
+
"Drill into routing decisions for the first turn of the conversation:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension routing --turn 1",
|
|
3906
|
+
"Show all errors across the session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension errors",
|
|
3907
|
+
"Output raw trace JSON for custom parsing:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format raw",
|
|
3908
|
+
"Return results as JSON:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --json"
|
|
3850
3909
|
],
|
|
3851
3910
|
"flags": {
|
|
3852
3911
|
"json": {
|
|
@@ -3864,137 +3923,78 @@
|
|
|
3864
3923
|
"multiple": false,
|
|
3865
3924
|
"type": "option"
|
|
3866
3925
|
},
|
|
3867
|
-
"
|
|
3868
|
-
"char": "
|
|
3869
|
-
"name": "
|
|
3870
|
-
"noCacheDefault": true,
|
|
3926
|
+
"session-id": {
|
|
3927
|
+
"char": "s",
|
|
3928
|
+
"name": "session-id",
|
|
3871
3929
|
"required": true,
|
|
3872
|
-
"summary": "
|
|
3873
|
-
"hasDynamicHelp": true,
|
|
3874
|
-
"multiple": false,
|
|
3875
|
-
"type": "option"
|
|
3876
|
-
},
|
|
3877
|
-
"api-version": {
|
|
3878
|
-
"description": "Override the api version used for api requests made by this command",
|
|
3879
|
-
"name": "api-version",
|
|
3880
|
-
"hasDynamicHelp": false,
|
|
3881
|
-
"multiple": false,
|
|
3882
|
-
"type": "option"
|
|
3883
|
-
},
|
|
3884
|
-
"api-name": {
|
|
3885
|
-
"char": "n",
|
|
3886
|
-
"name": "api-name",
|
|
3887
|
-
"summary": "API name of the agent test to run; corresponds to the name of the AiEvaluationDefinition metadata component that implements the agent test.",
|
|
3930
|
+
"summary": "Session ID to read traces for. Use the \"agent preview sessions\" CLI command to list all known agent preview sessions along with their session IDs",
|
|
3888
3931
|
"hasDynamicHelp": false,
|
|
3889
3932
|
"multiple": false,
|
|
3890
3933
|
"type": "option"
|
|
3891
3934
|
},
|
|
3892
|
-
"
|
|
3893
|
-
"char": "
|
|
3894
|
-
"name": "
|
|
3895
|
-
"summary": "
|
|
3896
|
-
"
|
|
3897
|
-
"multiple": false,
|
|
3898
|
-
"type": "option"
|
|
3899
|
-
},
|
|
3900
|
-
"result-format": {
|
|
3901
|
-
"name": "result-format",
|
|
3902
|
-
"summary": "Format of the agent test run results.",
|
|
3903
|
-
"default": "human",
|
|
3935
|
+
"format": {
|
|
3936
|
+
"char": "f",
|
|
3937
|
+
"name": "format",
|
|
3938
|
+
"summary": "Output format of the trace data; specifies the level of detail you want in the trace files.",
|
|
3939
|
+
"default": "summary",
|
|
3904
3940
|
"hasDynamicHelp": false,
|
|
3905
3941
|
"multiple": false,
|
|
3906
3942
|
"options": [
|
|
3907
|
-
"
|
|
3908
|
-
"
|
|
3909
|
-
"
|
|
3910
|
-
"tap"
|
|
3943
|
+
"summary",
|
|
3944
|
+
"detail",
|
|
3945
|
+
"raw"
|
|
3911
3946
|
],
|
|
3912
3947
|
"type": "option"
|
|
3913
3948
|
},
|
|
3914
|
-
"
|
|
3949
|
+
"dimension": {
|
|
3915
3950
|
"char": "d",
|
|
3916
|
-
"
|
|
3917
|
-
"
|
|
3918
|
-
"summary": "Directory to write the agent test results into.",
|
|
3951
|
+
"name": "dimension",
|
|
3952
|
+
"summary": "Dimension to drill into when using \"--format detail\"; used to filter and organize the trace data to answer a specific type of question.",
|
|
3919
3953
|
"hasDynamicHelp": false,
|
|
3920
3954
|
"multiple": false,
|
|
3955
|
+
"options": [
|
|
3956
|
+
"actions",
|
|
3957
|
+
"grounding",
|
|
3958
|
+
"routing",
|
|
3959
|
+
"errors"
|
|
3960
|
+
],
|
|
3921
3961
|
"type": "option"
|
|
3922
3962
|
},
|
|
3923
|
-
"
|
|
3924
|
-
"
|
|
3925
|
-
"name": "
|
|
3926
|
-
"summary": "
|
|
3963
|
+
"turn": {
|
|
3964
|
+
"char": "t",
|
|
3965
|
+
"name": "turn",
|
|
3966
|
+
"summary": "Turn number for which you want trace data. A turn is a single utterance or response in a conversation, starting with 1.",
|
|
3927
3967
|
"hasDynamicHelp": false,
|
|
3928
3968
|
"multiple": false,
|
|
3929
|
-
"options": [
|
|
3930
|
-
"agentforce-studio",
|
|
3931
|
-
"testing-center"
|
|
3932
|
-
],
|
|
3933
3969
|
"type": "option"
|
|
3934
|
-
},
|
|
3935
|
-
"verbose": {
|
|
3936
|
-
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3937
|
-
"name": "verbose",
|
|
3938
|
-
"summary": "Show generated data in the test results output.",
|
|
3939
|
-
"allowNo": false,
|
|
3940
|
-
"type": "boolean"
|
|
3941
3970
|
}
|
|
3942
3971
|
},
|
|
3943
|
-
"hasDynamicHelp":
|
|
3972
|
+
"hasDynamicHelp": false,
|
|
3944
3973
|
"hiddenAliases": [],
|
|
3945
|
-
"id": "agent:
|
|
3974
|
+
"id": "agent:trace:read",
|
|
3946
3975
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3947
3976
|
"pluginName": "@salesforce/plugin-agent",
|
|
3948
3977
|
"pluginType": "core",
|
|
3949
3978
|
"strict": true,
|
|
3950
|
-
"summary": "
|
|
3979
|
+
"summary": "Read trace files from an agent preview session.",
|
|
3951
3980
|
"enableJsonFlag": true,
|
|
3952
|
-
"
|
|
3953
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
3954
|
-
"body": [
|
|
3955
|
-
{
|
|
3956
|
-
"name": "SF_TARGET_ORG",
|
|
3957
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3958
|
-
}
|
|
3959
|
-
]
|
|
3960
|
-
},
|
|
3961
|
-
"errorCodes": {
|
|
3962
|
-
"header": "ERROR CODES",
|
|
3963
|
-
"body": [
|
|
3964
|
-
{
|
|
3965
|
-
"name": "Succeeded (0)",
|
|
3966
|
-
"description": "Test started successfully (without --wait), or test completed successfully (with --wait)."
|
|
3967
|
-
},
|
|
3968
|
-
{
|
|
3969
|
-
"name": "Failed (1)",
|
|
3970
|
-
"description": "Tests encountered execution errors (test cases with ERROR status when using --wait)."
|
|
3971
|
-
},
|
|
3972
|
-
{
|
|
3973
|
-
"name": "NotFound (2)",
|
|
3974
|
-
"description": "Test definition not found or invalid test name."
|
|
3975
|
-
},
|
|
3976
|
-
{
|
|
3977
|
-
"name": "OperationFailed (4)",
|
|
3978
|
-
"description": "Failed to start or poll test due to API or network errors."
|
|
3979
|
-
}
|
|
3980
|
-
]
|
|
3981
|
-
},
|
|
3981
|
+
"requiresProject": true,
|
|
3982
3982
|
"isESM": true,
|
|
3983
3983
|
"relativePath": [
|
|
3984
3984
|
"lib",
|
|
3985
3985
|
"commands",
|
|
3986
3986
|
"agent",
|
|
3987
|
-
"
|
|
3988
|
-
"
|
|
3987
|
+
"trace",
|
|
3988
|
+
"read.js"
|
|
3989
3989
|
],
|
|
3990
3990
|
"aliasPermutations": [],
|
|
3991
3991
|
"permutations": [
|
|
3992
|
-
"agent:
|
|
3993
|
-
"
|
|
3994
|
-
"
|
|
3995
|
-
"agent:
|
|
3996
|
-
"
|
|
3997
|
-
"
|
|
3992
|
+
"agent:trace:read",
|
|
3993
|
+
"trace:agent:read",
|
|
3994
|
+
"trace:read:agent",
|
|
3995
|
+
"agent:read:trace",
|
|
3996
|
+
"read:agent:trace",
|
|
3997
|
+
"read:trace:agent"
|
|
3998
3998
|
]
|
|
3999
3999
|
},
|
|
4000
4000
|
"agent:validate:authoring-bundle": {
|
|
@@ -4667,5 +4667,5 @@
|
|
|
4667
4667
|
]
|
|
4668
4668
|
}
|
|
4669
4669
|
},
|
|
4670
|
-
"version": "2.0.
|
|
4670
|
+
"version": "2.0.1"
|
|
4671
4671
|
}
|