@salesforce/plugin-agent 1.44.5 → 1.45.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -41
- package/lib/commands/agent/mcp/asset/list.js +4 -0
- package/lib/commands/agent/mcp/asset/list.js.map +1 -1
- package/lib/commands/agent/mcp/asset/replace.js +6 -0
- package/lib/commands/agent/mcp/asset/replace.js.map +1 -1
- package/lib/commands/agent/mcp/create.js +22 -0
- package/lib/commands/agent/mcp/create.js.map +1 -1
- package/lib/commands/agent/mcp/fetch.js +6 -0
- package/lib/commands/agent/mcp/fetch.js.map +1 -1
- package/lib/commands/agent/mcp/get.js +8 -6
- package/lib/commands/agent/mcp/get.js.map +1 -1
- package/lib/commands/agent/mcp/list.js +12 -1
- package/lib/commands/agent/mcp/list.js.map +1 -1
- package/oclif.manifest.json +1330 -1330
- package/package.json +4 -4
- package/schemas/agent-mcp-create.json +3 -0
- package/schemas/agent-mcp-fetch.json +3 -0
package/oclif.manifest.json
CHANGED
|
@@ -1120,16 +1120,13 @@
|
|
|
1120
1120
|
"upload:adl:agent"
|
|
1121
1121
|
]
|
|
1122
1122
|
},
|
|
1123
|
-
"agent:
|
|
1123
|
+
"agent:mcp:create": {
|
|
1124
1124
|
"aliases": [],
|
|
1125
1125
|
"args": {},
|
|
1126
|
-
"description": "
|
|
1126
|
+
"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.",
|
|
1127
1127
|
"examples": [
|
|
1128
|
-
"
|
|
1129
|
-
"
|
|
1130
|
-
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
1131
|
-
"Specify an existing agent spec file called \"specs/resortManagerAgent.yaml\", and then overwrite it with a new version that contains newly AI-generated topics based on the updated role information passed in with the --role flag:\n<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role \"Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly\"",
|
|
1132
|
-
"Specify that the conversational tone of the agent is formal and to attach the \"resortmanager@myorg.com\" username to it; be prompted for the required properties and use your default org:\n<%= config.bin %> <%= command.id %> --tone formal --agent-user resortmanager@myorg.com"
|
|
1128
|
+
"Create an MCP server with no authentication:\n<%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --target-org myOrg",
|
|
1129
|
+
"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"
|
|
1133
1130
|
],
|
|
1134
1131
|
"flags": {
|
|
1135
1132
|
"json": {
|
|
@@ -1164,164 +1161,113 @@
|
|
|
1164
1161
|
"multiple": false,
|
|
1165
1162
|
"type": "option"
|
|
1166
1163
|
},
|
|
1167
|
-
"
|
|
1168
|
-
"
|
|
1169
|
-
"
|
|
1170
|
-
"
|
|
1171
|
-
"
|
|
1172
|
-
"options": [
|
|
1173
|
-
"customer",
|
|
1174
|
-
"internal"
|
|
1175
|
-
],
|
|
1176
|
-
"type": "option"
|
|
1177
|
-
},
|
|
1178
|
-
"role": {
|
|
1179
|
-
"name": "role",
|
|
1180
|
-
"summary": "Role of the agent.",
|
|
1181
|
-
"hasDynamicHelp": false,
|
|
1182
|
-
"multiple": false,
|
|
1183
|
-
"type": "option"
|
|
1184
|
-
},
|
|
1185
|
-
"company-name": {
|
|
1186
|
-
"name": "company-name",
|
|
1187
|
-
"summary": "Name of your company.",
|
|
1188
|
-
"hasDynamicHelp": false,
|
|
1189
|
-
"multiple": false,
|
|
1190
|
-
"type": "option"
|
|
1191
|
-
},
|
|
1192
|
-
"company-description": {
|
|
1193
|
-
"name": "company-description",
|
|
1194
|
-
"summary": "Description of your company.",
|
|
1195
|
-
"hasDynamicHelp": false,
|
|
1196
|
-
"multiple": false,
|
|
1197
|
-
"type": "option"
|
|
1198
|
-
},
|
|
1199
|
-
"company-website": {
|
|
1200
|
-
"name": "company-website",
|
|
1201
|
-
"summary": "Website URL of your company.",
|
|
1164
|
+
"name": {
|
|
1165
|
+
"char": "n",
|
|
1166
|
+
"name": "name",
|
|
1167
|
+
"required": true,
|
|
1168
|
+
"summary": "Unique name of the MCP server.",
|
|
1202
1169
|
"hasDynamicHelp": false,
|
|
1203
1170
|
"multiple": false,
|
|
1204
1171
|
"type": "option"
|
|
1205
1172
|
},
|
|
1206
|
-
"
|
|
1207
|
-
"name": "
|
|
1208
|
-
"summary": "
|
|
1173
|
+
"label": {
|
|
1174
|
+
"name": "label",
|
|
1175
|
+
"summary": "Human-readable label for the MCP server.",
|
|
1209
1176
|
"hasDynamicHelp": false,
|
|
1210
1177
|
"multiple": false,
|
|
1211
1178
|
"type": "option"
|
|
1212
1179
|
},
|
|
1213
|
-
"
|
|
1214
|
-
"name": "
|
|
1215
|
-
"summary": "
|
|
1180
|
+
"description": {
|
|
1181
|
+
"name": "description",
|
|
1182
|
+
"summary": "Description of the MCP server.",
|
|
1216
1183
|
"hasDynamicHelp": false,
|
|
1217
1184
|
"multiple": false,
|
|
1218
1185
|
"type": "option"
|
|
1219
1186
|
},
|
|
1220
|
-
"
|
|
1221
|
-
"name": "
|
|
1222
|
-
"
|
|
1187
|
+
"server-url": {
|
|
1188
|
+
"name": "server-url",
|
|
1189
|
+
"required": true,
|
|
1190
|
+
"summary": "URL of the external MCP server.",
|
|
1223
1191
|
"hasDynamicHelp": false,
|
|
1224
1192
|
"multiple": false,
|
|
1225
|
-
"options": [
|
|
1226
|
-
"true",
|
|
1227
|
-
"false"
|
|
1228
|
-
],
|
|
1229
1193
|
"type": "option"
|
|
1230
1194
|
},
|
|
1231
|
-
"
|
|
1232
|
-
"name": "
|
|
1233
|
-
"summary": "
|
|
1195
|
+
"auth-type": {
|
|
1196
|
+
"name": "auth-type",
|
|
1197
|
+
"summary": "Authorization type to use when connecting to the MCP server.",
|
|
1198
|
+
"default": "NO_AUTH",
|
|
1234
1199
|
"hasDynamicHelp": false,
|
|
1235
1200
|
"multiple": false,
|
|
1236
1201
|
"options": [
|
|
1237
|
-
"
|
|
1238
|
-
"
|
|
1239
|
-
"neutral"
|
|
1202
|
+
"OAUTH",
|
|
1203
|
+
"NO_AUTH"
|
|
1240
1204
|
],
|
|
1241
1205
|
"type": "option"
|
|
1242
1206
|
},
|
|
1243
|
-
"
|
|
1244
|
-
"name": "
|
|
1245
|
-
"summary": "
|
|
1207
|
+
"identity-provider": {
|
|
1208
|
+
"name": "identity-provider",
|
|
1209
|
+
"summary": "Identity provider to use for OAuth authorization. Required when auth-type is OAUTH.",
|
|
1246
1210
|
"hasDynamicHelp": false,
|
|
1247
1211
|
"multiple": false,
|
|
1248
1212
|
"type": "option"
|
|
1249
1213
|
},
|
|
1250
|
-
"
|
|
1251
|
-
"name": "
|
|
1252
|
-
"summary": "
|
|
1253
|
-
"default": "specs/agentSpec.yaml",
|
|
1214
|
+
"client-id": {
|
|
1215
|
+
"name": "client-id",
|
|
1216
|
+
"summary": "OAuth client ID. Required when auth-type is OAUTH.",
|
|
1254
1217
|
"hasDynamicHelp": false,
|
|
1255
1218
|
"multiple": false,
|
|
1256
1219
|
"type": "option"
|
|
1257
1220
|
},
|
|
1258
|
-
"
|
|
1259
|
-
"name": "
|
|
1260
|
-
"summary": "
|
|
1261
|
-
"allowNo": false,
|
|
1262
|
-
"type": "boolean"
|
|
1263
|
-
},
|
|
1264
|
-
"prompt-template": {
|
|
1265
|
-
"name": "prompt-template",
|
|
1266
|
-
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
1221
|
+
"client-secret": {
|
|
1222
|
+
"name": "client-secret",
|
|
1223
|
+
"summary": "OAuth client secret. Required when auth-type is OAUTH. Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
1267
1224
|
"hasDynamicHelp": false,
|
|
1268
1225
|
"multiple": false,
|
|
1269
1226
|
"type": "option"
|
|
1270
1227
|
},
|
|
1271
|
-
"
|
|
1272
|
-
"
|
|
1273
|
-
|
|
1274
|
-
],
|
|
1275
|
-
"name": "grounding-context",
|
|
1276
|
-
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
1228
|
+
"scope": {
|
|
1229
|
+
"name": "scope",
|
|
1230
|
+
"summary": "OAuth scope to request. Required when auth-type is OAUTH.",
|
|
1277
1231
|
"hasDynamicHelp": false,
|
|
1278
1232
|
"multiple": false,
|
|
1279
1233
|
"type": "option"
|
|
1280
|
-
},
|
|
1281
|
-
"force-overwrite": {
|
|
1282
|
-
"name": "force-overwrite",
|
|
1283
|
-
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
1284
|
-
"allowNo": false,
|
|
1285
|
-
"type": "boolean"
|
|
1286
1234
|
}
|
|
1287
1235
|
},
|
|
1288
1236
|
"hasDynamicHelp": true,
|
|
1289
1237
|
"hiddenAliases": [],
|
|
1290
|
-
"id": "agent:
|
|
1238
|
+
"id": "agent:mcp:create",
|
|
1291
1239
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1292
1240
|
"pluginName": "@salesforce/plugin-agent",
|
|
1293
1241
|
"pluginType": "core",
|
|
1242
|
+
"state": "preview",
|
|
1294
1243
|
"strict": true,
|
|
1295
|
-
"summary": "
|
|
1244
|
+
"summary": "Create an MCP server in the API Catalog.",
|
|
1296
1245
|
"enableJsonFlag": true,
|
|
1297
|
-
"requiresProject": true,
|
|
1298
1246
|
"isESM": true,
|
|
1299
1247
|
"relativePath": [
|
|
1300
1248
|
"lib",
|
|
1301
1249
|
"commands",
|
|
1302
1250
|
"agent",
|
|
1303
|
-
"
|
|
1304
|
-
"
|
|
1251
|
+
"mcp",
|
|
1252
|
+
"create.js"
|
|
1305
1253
|
],
|
|
1306
1254
|
"aliasPermutations": [],
|
|
1307
1255
|
"permutations": [
|
|
1308
|
-
"agent:
|
|
1309
|
-
"
|
|
1310
|
-
"
|
|
1311
|
-
"agent:
|
|
1312
|
-
"
|
|
1313
|
-
"
|
|
1256
|
+
"agent:mcp:create",
|
|
1257
|
+
"mcp:agent:create",
|
|
1258
|
+
"mcp:create:agent",
|
|
1259
|
+
"agent:create:mcp",
|
|
1260
|
+
"create:agent:mcp",
|
|
1261
|
+
"create:mcp:agent"
|
|
1314
1262
|
]
|
|
1315
1263
|
},
|
|
1316
|
-
"agent:
|
|
1264
|
+
"agent:mcp:delete": {
|
|
1317
1265
|
"aliases": [],
|
|
1318
1266
|
"args": {},
|
|
1319
|
-
"description": "
|
|
1267
|
+
"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).",
|
|
1320
1268
|
"examples": [
|
|
1321
|
-
"
|
|
1322
|
-
"
|
|
1323
|
-
"Generate an authoring bundle from the \"specs/agentSpec.yaml\" agent spec YAML file and give it the label \"My Authoring Bundle\"; use your default org:\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\"",
|
|
1324
|
-
"Similar to previous example, but generate the authoring bundle files in the \"other-package-dir/main/default\" package directory; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\" --output-dir other-package-dir/main/default --target-org my-dev-org"
|
|
1269
|
+
"Delete an MCP server, confirming interactively:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg",
|
|
1270
|
+
"Delete an MCP server without a confirmation prompt:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg --no-prompt"
|
|
1325
1271
|
],
|
|
1326
1272
|
"flags": {
|
|
1327
1273
|
"json": {
|
|
@@ -1349,13 +1295,6 @@
|
|
|
1349
1295
|
"multiple": false,
|
|
1350
1296
|
"type": "option"
|
|
1351
1297
|
},
|
|
1352
|
-
"api-name": {
|
|
1353
|
-
"name": "api-name",
|
|
1354
|
-
"summary": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name can't exist in the org.",
|
|
1355
|
-
"hasDynamicHelp": false,
|
|
1356
|
-
"multiple": false,
|
|
1357
|
-
"type": "option"
|
|
1358
|
-
},
|
|
1359
1298
|
"api-version": {
|
|
1360
1299
|
"description": "Override the api version used for api requests made by this command",
|
|
1361
1300
|
"name": "api-version",
|
|
@@ -1363,77 +1302,57 @@
|
|
|
1363
1302
|
"multiple": false,
|
|
1364
1303
|
"type": "option"
|
|
1365
1304
|
},
|
|
1366
|
-
"
|
|
1367
|
-
"char": "
|
|
1368
|
-
"name": "
|
|
1369
|
-
"
|
|
1370
|
-
"
|
|
1371
|
-
"multiple": false,
|
|
1372
|
-
"type": "option"
|
|
1373
|
-
},
|
|
1374
|
-
"no-spec": {
|
|
1375
|
-
"name": "no-spec",
|
|
1376
|
-
"summary": "Skip prompting for an agent spec and use the default Agent Script boilerplate in the generated authoring bundle.",
|
|
1377
|
-
"allowNo": false,
|
|
1378
|
-
"type": "boolean"
|
|
1379
|
-
},
|
|
1380
|
-
"output-dir": {
|
|
1381
|
-
"char": "d",
|
|
1382
|
-
"name": "output-dir",
|
|
1383
|
-
"summary": "Directory where the authoring bundle files are generated.",
|
|
1384
|
-
"hasDynamicHelp": false,
|
|
1385
|
-
"multiple": false,
|
|
1386
|
-
"type": "option"
|
|
1387
|
-
},
|
|
1388
|
-
"name": {
|
|
1389
|
-
"char": "n",
|
|
1390
|
-
"name": "name",
|
|
1391
|
-
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
1305
|
+
"mcp-server-id": {
|
|
1306
|
+
"char": "i",
|
|
1307
|
+
"name": "mcp-server-id",
|
|
1308
|
+
"required": true,
|
|
1309
|
+
"summary": "ID of the MCP server to delete.",
|
|
1392
1310
|
"hasDynamicHelp": false,
|
|
1393
1311
|
"multiple": false,
|
|
1394
1312
|
"type": "option"
|
|
1395
1313
|
},
|
|
1396
|
-
"
|
|
1397
|
-
"name": "
|
|
1398
|
-
"summary": "
|
|
1314
|
+
"no-prompt": {
|
|
1315
|
+
"name": "no-prompt",
|
|
1316
|
+
"summary": "Skip the confirmation prompt and delete the MCP server immediately.",
|
|
1399
1317
|
"allowNo": false,
|
|
1400
1318
|
"type": "boolean"
|
|
1401
1319
|
}
|
|
1402
1320
|
},
|
|
1403
1321
|
"hasDynamicHelp": true,
|
|
1404
1322
|
"hiddenAliases": [],
|
|
1405
|
-
"id": "agent:
|
|
1323
|
+
"id": "agent:mcp:delete",
|
|
1406
1324
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1407
1325
|
"pluginName": "@salesforce/plugin-agent",
|
|
1408
1326
|
"pluginType": "core",
|
|
1327
|
+
"state": "preview",
|
|
1409
1328
|
"strict": true,
|
|
1410
|
-
"summary": "
|
|
1329
|
+
"summary": "Delete an MCP server from the API Catalog.",
|
|
1411
1330
|
"enableJsonFlag": true,
|
|
1412
|
-
"requiresProject": true,
|
|
1413
1331
|
"isESM": true,
|
|
1414
1332
|
"relativePath": [
|
|
1415
1333
|
"lib",
|
|
1416
1334
|
"commands",
|
|
1417
1335
|
"agent",
|
|
1418
|
-
"
|
|
1419
|
-
"
|
|
1336
|
+
"mcp",
|
|
1337
|
+
"delete.js"
|
|
1420
1338
|
],
|
|
1421
1339
|
"aliasPermutations": [],
|
|
1422
1340
|
"permutations": [
|
|
1423
|
-
"agent:
|
|
1424
|
-
"
|
|
1425
|
-
"
|
|
1426
|
-
"agent:
|
|
1427
|
-
"
|
|
1428
|
-
"
|
|
1341
|
+
"agent:mcp:delete",
|
|
1342
|
+
"mcp:agent:delete",
|
|
1343
|
+
"mcp:delete:agent",
|
|
1344
|
+
"agent:delete:mcp",
|
|
1345
|
+
"delete:agent:mcp",
|
|
1346
|
+
"delete:mcp:agent"
|
|
1429
1347
|
]
|
|
1430
1348
|
},
|
|
1431
|
-
"agent:
|
|
1349
|
+
"agent:mcp:fetch": {
|
|
1432
1350
|
"aliases": [],
|
|
1433
1351
|
"args": {},
|
|
1434
|
-
"description": "
|
|
1352
|
+
"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.",
|
|
1435
1353
|
"examples": [
|
|
1436
|
-
"
|
|
1354
|
+
"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",
|
|
1355
|
+
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
1437
1356
|
],
|
|
1438
1357
|
"flags": {
|
|
1439
1358
|
"json": {
|
|
@@ -1451,44 +1370,107 @@
|
|
|
1451
1370
|
"multiple": false,
|
|
1452
1371
|
"type": "option"
|
|
1453
1372
|
},
|
|
1454
|
-
"
|
|
1455
|
-
"
|
|
1456
|
-
"name": "
|
|
1457
|
-
"hasDynamicHelp": false,
|
|
1458
|
-
"multiple": false,
|
|
1459
|
-
"type": "option"
|
|
1460
|
-
},
|
|
1461
|
-
"source-org": {
|
|
1462
|
-
"char": "s",
|
|
1463
|
-
"name": "source-org",
|
|
1373
|
+
"target-org": {
|
|
1374
|
+
"char": "o",
|
|
1375
|
+
"name": "target-org",
|
|
1464
1376
|
"noCacheDefault": true,
|
|
1465
1377
|
"required": true,
|
|
1466
|
-
"summary": "Username or alias of the
|
|
1378
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1467
1379
|
"hasDynamicHelp": true,
|
|
1468
1380
|
"multiple": false,
|
|
1469
1381
|
"type": "option"
|
|
1470
1382
|
},
|
|
1471
|
-
"
|
|
1472
|
-
"
|
|
1473
|
-
"
|
|
1474
|
-
"summary": "Version of the agent (BotVersion).",
|
|
1383
|
+
"api-version": {
|
|
1384
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1385
|
+
"name": "api-version",
|
|
1475
1386
|
"hasDynamicHelp": false,
|
|
1476
1387
|
"multiple": false,
|
|
1477
1388
|
"type": "option"
|
|
1478
1389
|
},
|
|
1479
|
-
"
|
|
1480
|
-
"char": "
|
|
1481
|
-
"name": "
|
|
1390
|
+
"mcp-server-id": {
|
|
1391
|
+
"char": "i",
|
|
1392
|
+
"name": "mcp-server-id",
|
|
1482
1393
|
"required": true,
|
|
1483
|
-
"summary": "
|
|
1394
|
+
"summary": "ID of the MCP server to fetch assets from.",
|
|
1395
|
+
"hasDynamicHelp": false,
|
|
1396
|
+
"multiple": false,
|
|
1397
|
+
"type": "option"
|
|
1398
|
+
}
|
|
1399
|
+
},
|
|
1400
|
+
"hasDynamicHelp": true,
|
|
1401
|
+
"hiddenAliases": [],
|
|
1402
|
+
"id": "agent:mcp:fetch",
|
|
1403
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
1404
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
1405
|
+
"pluginType": "core",
|
|
1406
|
+
"state": "preview",
|
|
1407
|
+
"strict": true,
|
|
1408
|
+
"summary": "Fetch the live assets (tools, prompts, resources) advertised by an MCP server.",
|
|
1409
|
+
"enableJsonFlag": true,
|
|
1410
|
+
"isESM": true,
|
|
1411
|
+
"relativePath": [
|
|
1412
|
+
"lib",
|
|
1413
|
+
"commands",
|
|
1414
|
+
"agent",
|
|
1415
|
+
"mcp",
|
|
1416
|
+
"fetch.js"
|
|
1417
|
+
],
|
|
1418
|
+
"aliasPermutations": [],
|
|
1419
|
+
"permutations": [
|
|
1420
|
+
"agent:mcp:fetch",
|
|
1421
|
+
"mcp:agent:fetch",
|
|
1422
|
+
"mcp:fetch:agent",
|
|
1423
|
+
"agent:fetch:mcp",
|
|
1424
|
+
"fetch:agent:mcp",
|
|
1425
|
+
"fetch:mcp:agent"
|
|
1426
|
+
]
|
|
1427
|
+
},
|
|
1428
|
+
"agent:mcp:get": {
|
|
1429
|
+
"aliases": [],
|
|
1430
|
+
"args": {},
|
|
1431
|
+
"description": "Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.",
|
|
1432
|
+
"examples": [
|
|
1433
|
+
"Get an MCP server by id in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001",
|
|
1434
|
+
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
1435
|
+
],
|
|
1436
|
+
"flags": {
|
|
1437
|
+
"json": {
|
|
1438
|
+
"description": "Format output as json.",
|
|
1439
|
+
"helpGroup": "GLOBAL",
|
|
1440
|
+
"name": "json",
|
|
1441
|
+
"allowNo": false,
|
|
1442
|
+
"type": "boolean"
|
|
1443
|
+
},
|
|
1444
|
+
"flags-dir": {
|
|
1445
|
+
"helpGroup": "GLOBAL",
|
|
1446
|
+
"name": "flags-dir",
|
|
1447
|
+
"summary": "Import flag values from a directory.",
|
|
1484
1448
|
"hasDynamicHelp": false,
|
|
1485
1449
|
"multiple": false,
|
|
1486
1450
|
"type": "option"
|
|
1487
1451
|
},
|
|
1488
|
-
"
|
|
1489
|
-
"char": "
|
|
1490
|
-
"name": "
|
|
1491
|
-
"
|
|
1452
|
+
"target-org": {
|
|
1453
|
+
"char": "o",
|
|
1454
|
+
"name": "target-org",
|
|
1455
|
+
"noCacheDefault": true,
|
|
1456
|
+
"required": true,
|
|
1457
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1458
|
+
"hasDynamicHelp": true,
|
|
1459
|
+
"multiple": false,
|
|
1460
|
+
"type": "option"
|
|
1461
|
+
},
|
|
1462
|
+
"api-version": {
|
|
1463
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1464
|
+
"name": "api-version",
|
|
1465
|
+
"hasDynamicHelp": false,
|
|
1466
|
+
"multiple": false,
|
|
1467
|
+
"type": "option"
|
|
1468
|
+
},
|
|
1469
|
+
"mcp-server-id": {
|
|
1470
|
+
"char": "i",
|
|
1471
|
+
"name": "mcp-server-id",
|
|
1472
|
+
"required": true,
|
|
1473
|
+
"summary": "The identifier of the MCP server to retrieve.",
|
|
1492
1474
|
"hasDynamicHelp": false,
|
|
1493
1475
|
"multiple": false,
|
|
1494
1476
|
"type": "option"
|
|
@@ -1496,44 +1478,48 @@
|
|
|
1496
1478
|
},
|
|
1497
1479
|
"hasDynamicHelp": true,
|
|
1498
1480
|
"hiddenAliases": [],
|
|
1499
|
-
"id": "agent:
|
|
1481
|
+
"id": "agent:mcp:get",
|
|
1500
1482
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1501
1483
|
"pluginName": "@salesforce/plugin-agent",
|
|
1502
1484
|
"pluginType": "core",
|
|
1485
|
+
"state": "preview",
|
|
1503
1486
|
"strict": true,
|
|
1504
|
-
"summary": "
|
|
1487
|
+
"summary": "Get a single MCP server registered in the API Catalog.",
|
|
1505
1488
|
"enableJsonFlag": true,
|
|
1506
|
-
"requiresProject": true,
|
|
1507
1489
|
"isESM": true,
|
|
1508
1490
|
"relativePath": [
|
|
1509
1491
|
"lib",
|
|
1510
1492
|
"commands",
|
|
1511
1493
|
"agent",
|
|
1512
|
-
"
|
|
1513
|
-
"
|
|
1494
|
+
"mcp",
|
|
1495
|
+
"get.js"
|
|
1514
1496
|
],
|
|
1515
1497
|
"aliasPermutations": [],
|
|
1516
1498
|
"permutations": [
|
|
1517
|
-
"agent:
|
|
1518
|
-
"
|
|
1519
|
-
"
|
|
1520
|
-
"agent:
|
|
1521
|
-
"
|
|
1522
|
-
"
|
|
1499
|
+
"agent:mcp:get",
|
|
1500
|
+
"mcp:agent:get",
|
|
1501
|
+
"mcp:get:agent",
|
|
1502
|
+
"agent:get:mcp",
|
|
1503
|
+
"get:agent:mcp",
|
|
1504
|
+
"get:mcp:agent"
|
|
1523
1505
|
]
|
|
1524
1506
|
},
|
|
1525
|
-
"agent:
|
|
1507
|
+
"agent:mcp:list": {
|
|
1526
1508
|
"aliases": [],
|
|
1527
1509
|
"args": {},
|
|
1528
|
-
"description": "
|
|
1510
|
+
"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.",
|
|
1529
1511
|
"examples": [
|
|
1530
|
-
"
|
|
1531
|
-
"
|
|
1532
|
-
"Generate an agent test spec YAML file and specify a name for the new file; if the file exists, overwrite it without confirmation:\n<%= config.bin %> <%= command.id %> --output-file specs/Resort_Manager-new-version-testSpec.yaml --force-overwrite",
|
|
1533
|
-
"Generate an agent test spec YAML file from an existing AiEvaluationDefinition metadata XML file in your DX project:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml",
|
|
1534
|
-
"Generate an Agentforce Studio (NGT) test spec YAML file from an existing AiTestingDefinition metadata XML file:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiTestingDefinitions/Returns_Checkout_Tests.aiTestingDefinition-meta.xml"
|
|
1512
|
+
"List all MCP servers in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
1513
|
+
"List external MCP servers filtered by status and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json"
|
|
1535
1514
|
],
|
|
1536
1515
|
"flags": {
|
|
1516
|
+
"json": {
|
|
1517
|
+
"description": "Format output as json.",
|
|
1518
|
+
"helpGroup": "GLOBAL",
|
|
1519
|
+
"name": "json",
|
|
1520
|
+
"allowNo": false,
|
|
1521
|
+
"type": "boolean"
|
|
1522
|
+
},
|
|
1537
1523
|
"flags-dir": {
|
|
1538
1524
|
"helpGroup": "GLOBAL",
|
|
1539
1525
|
"name": "flags-dir",
|
|
@@ -1542,75 +1528,87 @@
|
|
|
1542
1528
|
"multiple": false,
|
|
1543
1529
|
"type": "option"
|
|
1544
1530
|
},
|
|
1545
|
-
"
|
|
1546
|
-
"char": "
|
|
1547
|
-
"name": "
|
|
1548
|
-
"
|
|
1531
|
+
"target-org": {
|
|
1532
|
+
"char": "o",
|
|
1533
|
+
"name": "target-org",
|
|
1534
|
+
"noCacheDefault": true,
|
|
1535
|
+
"required": true,
|
|
1536
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1537
|
+
"hasDynamicHelp": true,
|
|
1538
|
+
"multiple": false,
|
|
1539
|
+
"type": "option"
|
|
1540
|
+
},
|
|
1541
|
+
"api-version": {
|
|
1542
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1543
|
+
"name": "api-version",
|
|
1549
1544
|
"hasDynamicHelp": false,
|
|
1550
1545
|
"multiple": false,
|
|
1551
1546
|
"type": "option"
|
|
1552
1547
|
},
|
|
1553
|
-
"
|
|
1554
|
-
"name": "
|
|
1555
|
-
"summary": "
|
|
1556
|
-
"
|
|
1557
|
-
"
|
|
1548
|
+
"label": {
|
|
1549
|
+
"name": "label",
|
|
1550
|
+
"summary": "Filter the MCP servers by label.",
|
|
1551
|
+
"hasDynamicHelp": false,
|
|
1552
|
+
"multiple": false,
|
|
1553
|
+
"type": "option"
|
|
1558
1554
|
},
|
|
1559
|
-
"
|
|
1560
|
-
"
|
|
1561
|
-
"
|
|
1562
|
-
"summary": "Name of the generated test spec YAML file. Default value is \"specs/<AGENT_API_NAME>-testSpec.yaml\" (legacy) or \"specs/<AGENT_API_NAME>-ngtTestSpec.yaml\" (Agentforce Studio).",
|
|
1555
|
+
"type": {
|
|
1556
|
+
"name": "type",
|
|
1557
|
+
"summary": "Filter the MCP servers by type.",
|
|
1563
1558
|
"hasDynamicHelp": false,
|
|
1564
1559
|
"multiple": false,
|
|
1560
|
+
"options": [
|
|
1561
|
+
"EXTERNAL"
|
|
1562
|
+
],
|
|
1565
1563
|
"type": "option"
|
|
1566
1564
|
},
|
|
1567
|
-
"
|
|
1568
|
-
"
|
|
1569
|
-
"
|
|
1570
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
1565
|
+
"status": {
|
|
1566
|
+
"name": "status",
|
|
1567
|
+
"summary": "Filter the MCP servers by connection status. Only ACTIVE and DISCONNECTED are supported as filters.",
|
|
1571
1568
|
"hasDynamicHelp": false,
|
|
1572
1569
|
"multiple": false,
|
|
1573
1570
|
"options": [
|
|
1574
|
-
"
|
|
1575
|
-
"
|
|
1571
|
+
"ACTIVE",
|
|
1572
|
+
"DISCONNECTED"
|
|
1576
1573
|
],
|
|
1577
1574
|
"type": "option"
|
|
1578
1575
|
}
|
|
1579
1576
|
},
|
|
1580
|
-
"hasDynamicHelp":
|
|
1577
|
+
"hasDynamicHelp": true,
|
|
1581
1578
|
"hiddenAliases": [],
|
|
1582
|
-
"id": "agent:
|
|
1579
|
+
"id": "agent:mcp:list",
|
|
1583
1580
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1584
1581
|
"pluginName": "@salesforce/plugin-agent",
|
|
1585
1582
|
"pluginType": "core",
|
|
1583
|
+
"state": "preview",
|
|
1586
1584
|
"strict": true,
|
|
1587
|
-
"summary": "
|
|
1588
|
-
"enableJsonFlag":
|
|
1585
|
+
"summary": "List the MCP servers registered in the API Catalog.",
|
|
1586
|
+
"enableJsonFlag": true,
|
|
1589
1587
|
"isESM": true,
|
|
1590
1588
|
"relativePath": [
|
|
1591
1589
|
"lib",
|
|
1592
1590
|
"commands",
|
|
1593
1591
|
"agent",
|
|
1594
|
-
"
|
|
1595
|
-
"
|
|
1592
|
+
"mcp",
|
|
1593
|
+
"list.js"
|
|
1596
1594
|
],
|
|
1597
1595
|
"aliasPermutations": [],
|
|
1598
1596
|
"permutations": [
|
|
1599
|
-
"agent:
|
|
1600
|
-
"
|
|
1601
|
-
"
|
|
1602
|
-
"agent:
|
|
1603
|
-
"
|
|
1604
|
-
"
|
|
1597
|
+
"agent:mcp:list",
|
|
1598
|
+
"mcp:agent:list",
|
|
1599
|
+
"mcp:list:agent",
|
|
1600
|
+
"agent:list:mcp",
|
|
1601
|
+
"list:agent:mcp",
|
|
1602
|
+
"list:mcp:agent"
|
|
1605
1603
|
]
|
|
1606
1604
|
},
|
|
1607
|
-
"agent:mcp:
|
|
1605
|
+
"agent:mcp:update": {
|
|
1608
1606
|
"aliases": [],
|
|
1609
1607
|
"args": {},
|
|
1610
|
-
"description": "
|
|
1608
|
+
"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.",
|
|
1611
1609
|
"examples": [
|
|
1612
|
-
"
|
|
1613
|
-
"
|
|
1610
|
+
"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",
|
|
1611
|
+
"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"
|
|
1614
1612
|
],
|
|
1615
1613
|
"flags": {
|
|
1616
1614
|
"json": {
|
|
@@ -1645,41 +1643,39 @@
|
|
|
1645
1643
|
"multiple": false,
|
|
1646
1644
|
"type": "option"
|
|
1647
1645
|
},
|
|
1648
|
-
"
|
|
1649
|
-
"char": "
|
|
1650
|
-
"name": "
|
|
1646
|
+
"mcp-server-id": {
|
|
1647
|
+
"char": "i",
|
|
1648
|
+
"name": "mcp-server-id",
|
|
1651
1649
|
"required": true,
|
|
1652
|
-
"summary": "
|
|
1650
|
+
"summary": "ID of the MCP server to update.",
|
|
1653
1651
|
"hasDynamicHelp": false,
|
|
1654
1652
|
"multiple": false,
|
|
1655
1653
|
"type": "option"
|
|
1656
1654
|
},
|
|
1657
1655
|
"label": {
|
|
1658
1656
|
"name": "label",
|
|
1659
|
-
"summary": "
|
|
1657
|
+
"summary": "New display label for the MCP server.",
|
|
1660
1658
|
"hasDynamicHelp": false,
|
|
1661
1659
|
"multiple": false,
|
|
1662
1660
|
"type": "option"
|
|
1663
1661
|
},
|
|
1664
1662
|
"description": {
|
|
1665
1663
|
"name": "description",
|
|
1666
|
-
"summary": "
|
|
1664
|
+
"summary": "New description for the MCP server.",
|
|
1667
1665
|
"hasDynamicHelp": false,
|
|
1668
1666
|
"multiple": false,
|
|
1669
1667
|
"type": "option"
|
|
1670
1668
|
},
|
|
1671
1669
|
"server-url": {
|
|
1672
1670
|
"name": "server-url",
|
|
1673
|
-
"
|
|
1674
|
-
"summary": "URL of the external MCP server.",
|
|
1671
|
+
"summary": "New endpoint URL of the MCP server.",
|
|
1675
1672
|
"hasDynamicHelp": false,
|
|
1676
1673
|
"multiple": false,
|
|
1677
1674
|
"type": "option"
|
|
1678
1675
|
},
|
|
1679
1676
|
"auth-type": {
|
|
1680
1677
|
"name": "auth-type",
|
|
1681
|
-
"summary": "Authorization type to
|
|
1682
|
-
"default": "NO_AUTH",
|
|
1678
|
+
"summary": "Authorization type to apply to the MCP server (OAUTH or NO_AUTH).",
|
|
1683
1679
|
"hasDynamicHelp": false,
|
|
1684
1680
|
"multiple": false,
|
|
1685
1681
|
"options": [
|
|
@@ -1690,28 +1686,28 @@
|
|
|
1690
1686
|
},
|
|
1691
1687
|
"identity-provider": {
|
|
1692
1688
|
"name": "identity-provider",
|
|
1693
|
-
"summary": "Identity provider
|
|
1689
|
+
"summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
|
|
1694
1690
|
"hasDynamicHelp": false,
|
|
1695
1691
|
"multiple": false,
|
|
1696
1692
|
"type": "option"
|
|
1697
1693
|
},
|
|
1698
1694
|
"client-id": {
|
|
1699
1695
|
"name": "client-id",
|
|
1700
|
-
"summary": "OAuth client ID
|
|
1696
|
+
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
1701
1697
|
"hasDynamicHelp": false,
|
|
1702
1698
|
"multiple": false,
|
|
1703
1699
|
"type": "option"
|
|
1704
1700
|
},
|
|
1705
1701
|
"client-secret": {
|
|
1706
1702
|
"name": "client-secret",
|
|
1707
|
-
"summary": "OAuth 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.",
|
|
1708
1704
|
"hasDynamicHelp": false,
|
|
1709
1705
|
"multiple": false,
|
|
1710
1706
|
"type": "option"
|
|
1711
1707
|
},
|
|
1712
1708
|
"scope": {
|
|
1713
1709
|
"name": "scope",
|
|
1714
|
-
"summary": "OAuth scope
|
|
1710
|
+
"summary": "OAuth scope (required when --auth-type is OAUTH).",
|
|
1715
1711
|
"hasDynamicHelp": false,
|
|
1716
1712
|
"multiple": false,
|
|
1717
1713
|
"type": "option"
|
|
@@ -1719,13 +1715,13 @@
|
|
|
1719
1715
|
},
|
|
1720
1716
|
"hasDynamicHelp": true,
|
|
1721
1717
|
"hiddenAliases": [],
|
|
1722
|
-
"id": "agent:mcp:
|
|
1718
|
+
"id": "agent:mcp:update",
|
|
1723
1719
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1724
1720
|
"pluginName": "@salesforce/plugin-agent",
|
|
1725
1721
|
"pluginType": "core",
|
|
1726
1722
|
"state": "preview",
|
|
1727
1723
|
"strict": true,
|
|
1728
|
-
"summary": "
|
|
1724
|
+
"summary": "Update an MCP server registered in the API Catalog.",
|
|
1729
1725
|
"enableJsonFlag": true,
|
|
1730
1726
|
"isESM": true,
|
|
1731
1727
|
"relativePath": [
|
|
@@ -1733,25 +1729,28 @@
|
|
|
1733
1729
|
"commands",
|
|
1734
1730
|
"agent",
|
|
1735
1731
|
"mcp",
|
|
1736
|
-
"
|
|
1732
|
+
"update.js"
|
|
1737
1733
|
],
|
|
1738
1734
|
"aliasPermutations": [],
|
|
1739
1735
|
"permutations": [
|
|
1740
|
-
"agent:mcp:
|
|
1741
|
-
"mcp:agent:
|
|
1742
|
-
"mcp:
|
|
1743
|
-
"agent:
|
|
1744
|
-
"
|
|
1745
|
-
"
|
|
1736
|
+
"agent:mcp:update",
|
|
1737
|
+
"mcp:agent:update",
|
|
1738
|
+
"mcp:update:agent",
|
|
1739
|
+
"agent:update:mcp",
|
|
1740
|
+
"update:agent:mcp",
|
|
1741
|
+
"update:mcp:agent"
|
|
1746
1742
|
]
|
|
1747
1743
|
},
|
|
1748
|
-
"agent:
|
|
1744
|
+
"agent:preview:end": {
|
|
1749
1745
|
"aliases": [],
|
|
1750
1746
|
"args": {},
|
|
1751
|
-
"description": "
|
|
1747
|
+
"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.",
|
|
1752
1748
|
"examples": [
|
|
1753
|
-
"
|
|
1754
|
-
"
|
|
1749
|
+
"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",
|
|
1750
|
+
"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",
|
|
1751
|
+
"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",
|
|
1752
|
+
"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",
|
|
1753
|
+
"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>"
|
|
1755
1754
|
],
|
|
1756
1755
|
"flags": {
|
|
1757
1756
|
"json": {
|
|
@@ -1786,57 +1785,129 @@
|
|
|
1786
1785
|
"multiple": false,
|
|
1787
1786
|
"type": "option"
|
|
1788
1787
|
},
|
|
1789
|
-
"
|
|
1790
|
-
"
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
"
|
|
1788
|
+
"session-id": {
|
|
1789
|
+
"exclusive": [
|
|
1790
|
+
"all"
|
|
1791
|
+
],
|
|
1792
|
+
"name": "session-id",
|
|
1793
|
+
"required": false,
|
|
1794
|
+
"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.",
|
|
1795
|
+
"hasDynamicHelp": false,
|
|
1796
|
+
"multiple": false,
|
|
1797
|
+
"type": "option"
|
|
1798
|
+
},
|
|
1799
|
+
"api-name": {
|
|
1800
|
+
"char": "n",
|
|
1801
|
+
"exclusive": [
|
|
1802
|
+
"authoring-bundle"
|
|
1803
|
+
],
|
|
1804
|
+
"name": "api-name",
|
|
1805
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
1806
|
+
"hasDynamicHelp": false,
|
|
1807
|
+
"multiple": false,
|
|
1808
|
+
"type": "option"
|
|
1809
|
+
},
|
|
1810
|
+
"authoring-bundle": {
|
|
1811
|
+
"exclusive": [
|
|
1812
|
+
"api-name"
|
|
1813
|
+
],
|
|
1814
|
+
"name": "authoring-bundle",
|
|
1815
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1794
1816
|
"hasDynamicHelp": false,
|
|
1795
1817
|
"multiple": false,
|
|
1796
1818
|
"type": "option"
|
|
1797
1819
|
},
|
|
1820
|
+
"all": {
|
|
1821
|
+
"exclusive": [
|
|
1822
|
+
"session-id"
|
|
1823
|
+
],
|
|
1824
|
+
"name": "all",
|
|
1825
|
+
"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.",
|
|
1826
|
+
"allowNo": false,
|
|
1827
|
+
"type": "boolean"
|
|
1828
|
+
},
|
|
1798
1829
|
"no-prompt": {
|
|
1830
|
+
"char": "p",
|
|
1799
1831
|
"name": "no-prompt",
|
|
1800
|
-
"summary": "
|
|
1832
|
+
"summary": "Don't prompt for confirmation before ending sessions. Has an effect only when used with --all.",
|
|
1801
1833
|
"allowNo": false,
|
|
1802
1834
|
"type": "boolean"
|
|
1803
1835
|
}
|
|
1804
1836
|
},
|
|
1805
1837
|
"hasDynamicHelp": true,
|
|
1806
1838
|
"hiddenAliases": [],
|
|
1807
|
-
"id": "agent:
|
|
1839
|
+
"id": "agent:preview:end",
|
|
1808
1840
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1809
1841
|
"pluginName": "@salesforce/plugin-agent",
|
|
1810
1842
|
"pluginType": "core",
|
|
1811
|
-
"state": "preview",
|
|
1812
1843
|
"strict": true,
|
|
1813
|
-
"summary": "
|
|
1844
|
+
"summary": "End an existing programmatic agent preview session and get trace location.",
|
|
1814
1845
|
"enableJsonFlag": true,
|
|
1846
|
+
"requiresProject": true,
|
|
1847
|
+
"envVariablesSection": {
|
|
1848
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1849
|
+
"body": [
|
|
1850
|
+
{
|
|
1851
|
+
"name": "SF_TARGET_ORG",
|
|
1852
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1853
|
+
}
|
|
1854
|
+
]
|
|
1855
|
+
},
|
|
1856
|
+
"errorCodes": {
|
|
1857
|
+
"header": "ERROR CODES",
|
|
1858
|
+
"body": [
|
|
1859
|
+
{
|
|
1860
|
+
"name": "Succeeded (0)",
|
|
1861
|
+
"description": "Preview session ended successfully and traces saved."
|
|
1862
|
+
},
|
|
1863
|
+
{
|
|
1864
|
+
"name": "ExactlyOneRequired (2)",
|
|
1865
|
+
"description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
|
|
1866
|
+
},
|
|
1867
|
+
{
|
|
1868
|
+
"name": "NotFound (2)",
|
|
1869
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
1870
|
+
},
|
|
1871
|
+
{
|
|
1872
|
+
"name": "PreviewEndFailed (4)",
|
|
1873
|
+
"description": "Failed to end the preview session."
|
|
1874
|
+
},
|
|
1875
|
+
{
|
|
1876
|
+
"name": "PreviewEndPartialFailure (68)",
|
|
1877
|
+
"description": "With --all, one or more sessions failed to end while others succeeded."
|
|
1878
|
+
},
|
|
1879
|
+
{
|
|
1880
|
+
"name": "SessionAmbiguous (5)",
|
|
1881
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
1882
|
+
}
|
|
1883
|
+
]
|
|
1884
|
+
},
|
|
1815
1885
|
"isESM": true,
|
|
1816
1886
|
"relativePath": [
|
|
1817
1887
|
"lib",
|
|
1818
1888
|
"commands",
|
|
1819
1889
|
"agent",
|
|
1820
|
-
"
|
|
1821
|
-
"
|
|
1890
|
+
"preview",
|
|
1891
|
+
"end.js"
|
|
1822
1892
|
],
|
|
1823
1893
|
"aliasPermutations": [],
|
|
1824
1894
|
"permutations": [
|
|
1825
|
-
"agent:
|
|
1826
|
-
"
|
|
1827
|
-
"
|
|
1828
|
-
"agent:
|
|
1829
|
-
"
|
|
1830
|
-
"
|
|
1895
|
+
"agent:preview:end",
|
|
1896
|
+
"preview:agent:end",
|
|
1897
|
+
"preview:end:agent",
|
|
1898
|
+
"agent:end:preview",
|
|
1899
|
+
"end:agent:preview",
|
|
1900
|
+
"end:preview:agent"
|
|
1831
1901
|
]
|
|
1832
1902
|
},
|
|
1833
|
-
"agent:
|
|
1903
|
+
"agent:preview:send": {
|
|
1834
1904
|
"aliases": [],
|
|
1835
1905
|
"args": {},
|
|
1836
|
-
"description": "
|
|
1906
|
+
"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.",
|
|
1837
1907
|
"examples": [
|
|
1838
|
-
"
|
|
1839
|
-
"
|
|
1908
|
+
"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>",
|
|
1909
|
+
"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",
|
|
1910
|
+
"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"
|
|
1840
1911
|
],
|
|
1841
1912
|
"flags": {
|
|
1842
1913
|
"json": {
|
|
@@ -1871,11 +1942,34 @@
|
|
|
1871
1942
|
"multiple": false,
|
|
1872
1943
|
"type": "option"
|
|
1873
1944
|
},
|
|
1874
|
-
"
|
|
1875
|
-
"
|
|
1876
|
-
"
|
|
1945
|
+
"session-id": {
|
|
1946
|
+
"name": "session-id",
|
|
1947
|
+
"required": false,
|
|
1948
|
+
"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.",
|
|
1949
|
+
"hasDynamicHelp": false,
|
|
1950
|
+
"multiple": false,
|
|
1951
|
+
"type": "option"
|
|
1952
|
+
},
|
|
1953
|
+
"utterance": {
|
|
1954
|
+
"char": "u",
|
|
1955
|
+
"name": "utterance",
|
|
1877
1956
|
"required": true,
|
|
1878
|
-
"summary": "
|
|
1957
|
+
"summary": "Utterance to send to the agent, enclosed in double quotes.",
|
|
1958
|
+
"hasDynamicHelp": false,
|
|
1959
|
+
"multiple": false,
|
|
1960
|
+
"type": "option"
|
|
1961
|
+
},
|
|
1962
|
+
"api-name": {
|
|
1963
|
+
"char": "n",
|
|
1964
|
+
"name": "api-name",
|
|
1965
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
1966
|
+
"hasDynamicHelp": false,
|
|
1967
|
+
"multiple": false,
|
|
1968
|
+
"type": "option"
|
|
1969
|
+
},
|
|
1970
|
+
"authoring-bundle": {
|
|
1971
|
+
"name": "authoring-bundle",
|
|
1972
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1879
1973
|
"hasDynamicHelp": false,
|
|
1880
1974
|
"multiple": false,
|
|
1881
1975
|
"type": "option"
|
|
@@ -1883,39 +1977,68 @@
|
|
|
1883
1977
|
},
|
|
1884
1978
|
"hasDynamicHelp": true,
|
|
1885
1979
|
"hiddenAliases": [],
|
|
1886
|
-
"id": "agent:
|
|
1980
|
+
"id": "agent:preview:send",
|
|
1887
1981
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1888
1982
|
"pluginName": "@salesforce/plugin-agent",
|
|
1889
1983
|
"pluginType": "core",
|
|
1890
|
-
"state": "preview",
|
|
1891
1984
|
"strict": true,
|
|
1892
|
-
"summary": "
|
|
1985
|
+
"summary": "Send a message to an existing agent preview session.",
|
|
1893
1986
|
"enableJsonFlag": true,
|
|
1987
|
+
"requiresProject": true,
|
|
1988
|
+
"envVariablesSection": {
|
|
1989
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1990
|
+
"body": [
|
|
1991
|
+
{
|
|
1992
|
+
"name": "SF_TARGET_ORG",
|
|
1993
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1994
|
+
}
|
|
1995
|
+
]
|
|
1996
|
+
},
|
|
1997
|
+
"errorCodes": {
|
|
1998
|
+
"header": "ERROR CODES",
|
|
1999
|
+
"body": [
|
|
2000
|
+
{
|
|
2001
|
+
"name": "Succeeded (0)",
|
|
2002
|
+
"description": "Message sent successfully and agent response received."
|
|
2003
|
+
},
|
|
2004
|
+
{
|
|
2005
|
+
"name": "NotFound (2)",
|
|
2006
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
2007
|
+
},
|
|
2008
|
+
{
|
|
2009
|
+
"name": "PreviewSendFailed (4)",
|
|
2010
|
+
"description": "Failed to send message or receive response from the preview session."
|
|
2011
|
+
},
|
|
2012
|
+
{
|
|
2013
|
+
"name": "SessionAmbiguous (5)",
|
|
2014
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2015
|
+
}
|
|
2016
|
+
]
|
|
2017
|
+
},
|
|
1894
2018
|
"isESM": true,
|
|
1895
2019
|
"relativePath": [
|
|
1896
2020
|
"lib",
|
|
1897
2021
|
"commands",
|
|
1898
2022
|
"agent",
|
|
1899
|
-
"
|
|
1900
|
-
"
|
|
2023
|
+
"preview",
|
|
2024
|
+
"send.js"
|
|
1901
2025
|
],
|
|
1902
2026
|
"aliasPermutations": [],
|
|
1903
2027
|
"permutations": [
|
|
1904
|
-
"agent:
|
|
1905
|
-
"
|
|
1906
|
-
"
|
|
1907
|
-
"agent:
|
|
1908
|
-
"
|
|
1909
|
-
"
|
|
2028
|
+
"agent:preview:send",
|
|
2029
|
+
"preview:agent:send",
|
|
2030
|
+
"preview:send:agent",
|
|
2031
|
+
"agent:send:preview",
|
|
2032
|
+
"send:agent:preview",
|
|
2033
|
+
"send:preview:agent"
|
|
1910
2034
|
]
|
|
1911
2035
|
},
|
|
1912
|
-
"agent:
|
|
2036
|
+
"agent:preview:sessions": {
|
|
1913
2037
|
"aliases": [],
|
|
1914
2038
|
"args": {},
|
|
1915
|
-
"description": "
|
|
2039
|
+
"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.",
|
|
1916
2040
|
"examples": [
|
|
1917
|
-
"
|
|
1918
|
-
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
2041
|
+
"List all cached agent preview sessions:\n<%= config.bin %> <%= command.id %>"
|
|
1919
2042
|
],
|
|
1920
2043
|
"flags": {
|
|
1921
2044
|
"json": {
|
|
@@ -1932,69 +2055,53 @@
|
|
|
1932
2055
|
"hasDynamicHelp": false,
|
|
1933
2056
|
"multiple": false,
|
|
1934
2057
|
"type": "option"
|
|
1935
|
-
},
|
|
1936
|
-
"target-org": {
|
|
1937
|
-
"char": "o",
|
|
1938
|
-
"name": "target-org",
|
|
1939
|
-
"noCacheDefault": true,
|
|
1940
|
-
"required": true,
|
|
1941
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1942
|
-
"hasDynamicHelp": true,
|
|
1943
|
-
"multiple": false,
|
|
1944
|
-
"type": "option"
|
|
1945
|
-
},
|
|
1946
|
-
"api-version": {
|
|
1947
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1948
|
-
"name": "api-version",
|
|
1949
|
-
"hasDynamicHelp": false,
|
|
1950
|
-
"multiple": false,
|
|
1951
|
-
"type": "option"
|
|
1952
|
-
},
|
|
1953
|
-
"mcp-server-id": {
|
|
1954
|
-
"char": "i",
|
|
1955
|
-
"name": "mcp-server-id",
|
|
1956
|
-
"required": true,
|
|
1957
|
-
"summary": "The identifier of the MCP server to retrieve.",
|
|
1958
|
-
"hasDynamicHelp": false,
|
|
1959
|
-
"multiple": false,
|
|
1960
|
-
"type": "option"
|
|
1961
2058
|
}
|
|
1962
2059
|
},
|
|
1963
|
-
"hasDynamicHelp":
|
|
2060
|
+
"hasDynamicHelp": false,
|
|
1964
2061
|
"hiddenAliases": [],
|
|
1965
|
-
"id": "agent:
|
|
2062
|
+
"id": "agent:preview:sessions",
|
|
1966
2063
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1967
2064
|
"pluginName": "@salesforce/plugin-agent",
|
|
1968
2065
|
"pluginType": "core",
|
|
1969
|
-
"state": "preview",
|
|
1970
2066
|
"strict": true,
|
|
1971
|
-
"summary": "
|
|
2067
|
+
"summary": "List all known programmatic agent preview sessions.",
|
|
1972
2068
|
"enableJsonFlag": true,
|
|
2069
|
+
"requiresProject": true,
|
|
2070
|
+
"errorCodes": {
|
|
2071
|
+
"header": "ERROR CODES",
|
|
2072
|
+
"body": [
|
|
2073
|
+
{
|
|
2074
|
+
"name": "Succeeded (0)",
|
|
2075
|
+
"description": "Sessions listed successfully (or empty list if no active sessions)."
|
|
2076
|
+
}
|
|
2077
|
+
]
|
|
2078
|
+
},
|
|
1973
2079
|
"isESM": true,
|
|
1974
2080
|
"relativePath": [
|
|
1975
2081
|
"lib",
|
|
1976
2082
|
"commands",
|
|
1977
2083
|
"agent",
|
|
1978
|
-
"
|
|
1979
|
-
"
|
|
2084
|
+
"preview",
|
|
2085
|
+
"sessions.js"
|
|
1980
2086
|
],
|
|
1981
2087
|
"aliasPermutations": [],
|
|
1982
2088
|
"permutations": [
|
|
1983
|
-
"agent:
|
|
1984
|
-
"
|
|
1985
|
-
"
|
|
1986
|
-
"agent:
|
|
1987
|
-
"
|
|
1988
|
-
"
|
|
2089
|
+
"agent:preview:sessions",
|
|
2090
|
+
"preview:agent:sessions",
|
|
2091
|
+
"preview:sessions:agent",
|
|
2092
|
+
"agent:sessions:preview",
|
|
2093
|
+
"sessions:agent:preview",
|
|
2094
|
+
"sessions:preview:agent"
|
|
1989
2095
|
]
|
|
1990
2096
|
},
|
|
1991
|
-
"agent:
|
|
2097
|
+
"agent:preview:start": {
|
|
1992
2098
|
"aliases": [],
|
|
1993
2099
|
"args": {},
|
|
1994
|
-
"description": "
|
|
2100
|
+
"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.",
|
|
1995
2101
|
"examples": [
|
|
1996
|
-
"
|
|
1997
|
-
"
|
|
2102
|
+
"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",
|
|
2103
|
+
"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",
|
|
2104
|
+
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
1998
2105
|
],
|
|
1999
2106
|
"flags": {
|
|
2000
2107
|
"json": {
|
|
@@ -2029,70 +2136,131 @@
|
|
|
2029
2136
|
"multiple": false,
|
|
2030
2137
|
"type": "option"
|
|
2031
2138
|
},
|
|
2032
|
-
"
|
|
2033
|
-
"
|
|
2034
|
-
"
|
|
2139
|
+
"api-name": {
|
|
2140
|
+
"char": "n",
|
|
2141
|
+
"name": "api-name",
|
|
2142
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
2035
2143
|
"hasDynamicHelp": false,
|
|
2036
2144
|
"multiple": false,
|
|
2037
2145
|
"type": "option"
|
|
2038
2146
|
},
|
|
2039
|
-
"
|
|
2040
|
-
"name": "
|
|
2041
|
-
"summary": "
|
|
2147
|
+
"authoring-bundle": {
|
|
2148
|
+
"name": "authoring-bundle",
|
|
2149
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2042
2150
|
"hasDynamicHelp": false,
|
|
2043
2151
|
"multiple": false,
|
|
2044
|
-
"
|
|
2045
|
-
|
|
2152
|
+
"type": "option"
|
|
2153
|
+
},
|
|
2154
|
+
"use-live-actions": {
|
|
2155
|
+
"exclusive": [
|
|
2156
|
+
"simulate-actions"
|
|
2157
|
+
],
|
|
2158
|
+
"name": "use-live-actions",
|
|
2159
|
+
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
2160
|
+
"allowNo": false,
|
|
2161
|
+
"type": "boolean"
|
|
2162
|
+
},
|
|
2163
|
+
"simulate-actions": {
|
|
2164
|
+
"exclusive": [
|
|
2165
|
+
"use-live-actions"
|
|
2046
2166
|
],
|
|
2167
|
+
"name": "simulate-actions",
|
|
2168
|
+
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
2169
|
+
"allowNo": false,
|
|
2170
|
+
"type": "boolean"
|
|
2171
|
+
},
|
|
2172
|
+
"context-variables": {
|
|
2173
|
+
"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.",
|
|
2174
|
+
"name": "context-variables",
|
|
2175
|
+
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
2176
|
+
"delimiter": ",",
|
|
2177
|
+
"hasDynamicHelp": false,
|
|
2178
|
+
"multiple": true,
|
|
2047
2179
|
"type": "option"
|
|
2048
2180
|
},
|
|
2049
|
-
"
|
|
2050
|
-
"
|
|
2051
|
-
|
|
2181
|
+
"agent-json": {
|
|
2182
|
+
"dependsOn": [
|
|
2183
|
+
"authoring-bundle"
|
|
2184
|
+
],
|
|
2185
|
+
"hidden": true,
|
|
2186
|
+
"name": "agent-json",
|
|
2187
|
+
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
2052
2188
|
"hasDynamicHelp": false,
|
|
2053
2189
|
"multiple": false,
|
|
2054
|
-
"options": [
|
|
2055
|
-
"ACTIVE",
|
|
2056
|
-
"DISCONNECTED"
|
|
2057
|
-
],
|
|
2058
2190
|
"type": "option"
|
|
2059
2191
|
}
|
|
2060
2192
|
},
|
|
2061
2193
|
"hasDynamicHelp": true,
|
|
2062
2194
|
"hiddenAliases": [],
|
|
2063
|
-
"id": "agent:
|
|
2195
|
+
"id": "agent:preview:start",
|
|
2064
2196
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2065
2197
|
"pluginName": "@salesforce/plugin-agent",
|
|
2066
2198
|
"pluginType": "core",
|
|
2067
|
-
"state": "preview",
|
|
2068
2199
|
"strict": true,
|
|
2069
|
-
"summary": "
|
|
2200
|
+
"summary": "Start a programmatic agent preview session.",
|
|
2070
2201
|
"enableJsonFlag": true,
|
|
2202
|
+
"requiresProject": true,
|
|
2203
|
+
"envVariablesSection": {
|
|
2204
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2205
|
+
"body": [
|
|
2206
|
+
{
|
|
2207
|
+
"name": "SF_TARGET_ORG",
|
|
2208
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2209
|
+
}
|
|
2210
|
+
]
|
|
2211
|
+
},
|
|
2212
|
+
"errorCodes": {
|
|
2213
|
+
"header": "ERROR CODES",
|
|
2214
|
+
"body": [
|
|
2215
|
+
{
|
|
2216
|
+
"name": "Succeeded (0)",
|
|
2217
|
+
"description": "Preview session started successfully."
|
|
2218
|
+
},
|
|
2219
|
+
{
|
|
2220
|
+
"name": "Failed (1)",
|
|
2221
|
+
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
2222
|
+
},
|
|
2223
|
+
{
|
|
2224
|
+
"name": "NotFound (2)",
|
|
2225
|
+
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
2226
|
+
},
|
|
2227
|
+
{
|
|
2228
|
+
"name": "ServerError (3)",
|
|
2229
|
+
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
2230
|
+
},
|
|
2231
|
+
{
|
|
2232
|
+
"name": "PreviewStartFailed (4)",
|
|
2233
|
+
"description": "Preview session failed to start due to API or network errors."
|
|
2234
|
+
}
|
|
2235
|
+
]
|
|
2236
|
+
},
|
|
2071
2237
|
"isESM": true,
|
|
2072
2238
|
"relativePath": [
|
|
2073
2239
|
"lib",
|
|
2074
2240
|
"commands",
|
|
2075
2241
|
"agent",
|
|
2076
|
-
"
|
|
2077
|
-
"
|
|
2242
|
+
"preview",
|
|
2243
|
+
"start.js"
|
|
2078
2244
|
],
|
|
2079
2245
|
"aliasPermutations": [],
|
|
2080
2246
|
"permutations": [
|
|
2081
|
-
"agent:
|
|
2082
|
-
"
|
|
2083
|
-
"
|
|
2084
|
-
"agent:
|
|
2085
|
-
"
|
|
2086
|
-
"
|
|
2247
|
+
"agent:preview:start",
|
|
2248
|
+
"preview:agent:start",
|
|
2249
|
+
"preview:start:agent",
|
|
2250
|
+
"agent:start:preview",
|
|
2251
|
+
"start:agent:preview",
|
|
2252
|
+
"start:preview:agent"
|
|
2087
2253
|
]
|
|
2088
2254
|
},
|
|
2089
|
-
"agent:
|
|
2255
|
+
"agent:publish:authoring-bundle": {
|
|
2090
2256
|
"aliases": [],
|
|
2091
2257
|
"args": {},
|
|
2092
|
-
"description": "
|
|
2258
|
+
"description": "An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The metadata type contains two files: the standard metatada XML file and an Agent Script file (extension \".agent\") that fully describes the agent using the Agent Script language.\n\nWhen you publish an authoring bundle to your org, a number of things happen. First, this command validates that the Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent Script file to continue. Once the Agent Script file compiles, then it's published to the org, which in turn creates new associated metadata (Bot, BotVersion, GenAiX), or new versions of the metadata if the agent already exists. The new or updated metadata is retrieved back to your DX project; specify the --skip-retrieve flag to skip this step. Finally, the authoring bundle metadata (AiAuthoringBundle) is deployed to your org.\n\nThis command uses the API name of the authoring bundle.",
|
|
2093
2259
|
"examples": [
|
|
2094
|
-
"
|
|
2095
|
-
"
|
|
2260
|
+
"Publish an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
2261
|
+
"Publish an authoring bundle with API name MyAuthoringBundle to the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --target-org my-dev-org",
|
|
2262
|
+
"Publish with verbose output to see all retrieved and deployed metadata components:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --verbose",
|
|
2263
|
+
"Publish with concise output showing only essential information:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --concise"
|
|
2096
2264
|
],
|
|
2097
2265
|
"flags": {
|
|
2098
2266
|
"json": {
|
|
@@ -2127,114 +2295,96 @@
|
|
|
2127
2295
|
"multiple": false,
|
|
2128
2296
|
"type": "option"
|
|
2129
2297
|
},
|
|
2130
|
-
"
|
|
2131
|
-
"char": "
|
|
2132
|
-
"name": "
|
|
2133
|
-
"
|
|
2134
|
-
"summary": "ID of the MCP server to update.",
|
|
2135
|
-
"hasDynamicHelp": false,
|
|
2136
|
-
"multiple": false,
|
|
2137
|
-
"type": "option"
|
|
2138
|
-
},
|
|
2139
|
-
"label": {
|
|
2140
|
-
"name": "label",
|
|
2141
|
-
"summary": "New display label for the MCP server.",
|
|
2142
|
-
"hasDynamicHelp": false,
|
|
2143
|
-
"multiple": false,
|
|
2144
|
-
"type": "option"
|
|
2145
|
-
},
|
|
2146
|
-
"description": {
|
|
2147
|
-
"name": "description",
|
|
2148
|
-
"summary": "New description for the MCP server.",
|
|
2298
|
+
"api-name": {
|
|
2299
|
+
"char": "n",
|
|
2300
|
+
"name": "api-name",
|
|
2301
|
+
"summary": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
2149
2302
|
"hasDynamicHelp": false,
|
|
2150
2303
|
"multiple": false,
|
|
2151
2304
|
"type": "option"
|
|
2152
2305
|
},
|
|
2153
|
-
"
|
|
2154
|
-
"name": "
|
|
2155
|
-
"summary": "
|
|
2156
|
-
"
|
|
2157
|
-
"
|
|
2158
|
-
"type": "option"
|
|
2306
|
+
"skip-retrieve": {
|
|
2307
|
+
"name": "skip-retrieve",
|
|
2308
|
+
"summary": "Don't retrieve the metadata associated with the agent to your DX project.",
|
|
2309
|
+
"allowNo": false,
|
|
2310
|
+
"type": "boolean"
|
|
2159
2311
|
},
|
|
2160
|
-
"
|
|
2161
|
-
"
|
|
2162
|
-
"
|
|
2163
|
-
|
|
2164
|
-
"multiple": false,
|
|
2165
|
-
"options": [
|
|
2166
|
-
"OAUTH",
|
|
2167
|
-
"NO_AUTH"
|
|
2312
|
+
"verbose": {
|
|
2313
|
+
"char": "v",
|
|
2314
|
+
"exclusive": [
|
|
2315
|
+
"concise"
|
|
2168
2316
|
],
|
|
2169
|
-
"
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
"
|
|
2173
|
-
"summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
|
|
2174
|
-
"hasDynamicHelp": false,
|
|
2175
|
-
"multiple": false,
|
|
2176
|
-
"type": "option"
|
|
2177
|
-
},
|
|
2178
|
-
"client-id": {
|
|
2179
|
-
"name": "client-id",
|
|
2180
|
-
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
2181
|
-
"hasDynamicHelp": false,
|
|
2182
|
-
"multiple": false,
|
|
2183
|
-
"type": "option"
|
|
2184
|
-
},
|
|
2185
|
-
"client-secret": {
|
|
2186
|
-
"name": "client-secret",
|
|
2187
|
-
"summary": "OAuth client secret (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
2188
|
-
"hasDynamicHelp": false,
|
|
2189
|
-
"multiple": false,
|
|
2190
|
-
"type": "option"
|
|
2317
|
+
"name": "verbose",
|
|
2318
|
+
"summary": "Display detailed output showing all metadata components retrieved and deployed during the publish process.",
|
|
2319
|
+
"allowNo": false,
|
|
2320
|
+
"type": "boolean"
|
|
2191
2321
|
},
|
|
2192
|
-
"
|
|
2193
|
-
"
|
|
2194
|
-
|
|
2195
|
-
|
|
2196
|
-
"
|
|
2197
|
-
"
|
|
2322
|
+
"concise": {
|
|
2323
|
+
"exclusive": [
|
|
2324
|
+
"verbose"
|
|
2325
|
+
],
|
|
2326
|
+
"name": "concise",
|
|
2327
|
+
"summary": "Display minimal output with only essential information about the publish operation.",
|
|
2328
|
+
"allowNo": false,
|
|
2329
|
+
"type": "boolean"
|
|
2198
2330
|
}
|
|
2199
2331
|
},
|
|
2200
2332
|
"hasDynamicHelp": true,
|
|
2201
2333
|
"hiddenAliases": [],
|
|
2202
|
-
"id": "agent:
|
|
2334
|
+
"id": "agent:publish:authoring-bundle",
|
|
2203
2335
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2204
2336
|
"pluginName": "@salesforce/plugin-agent",
|
|
2205
2337
|
"pluginType": "core",
|
|
2206
|
-
"state": "preview",
|
|
2207
2338
|
"strict": true,
|
|
2208
|
-
"summary": "
|
|
2339
|
+
"summary": "Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.",
|
|
2209
2340
|
"enableJsonFlag": true,
|
|
2341
|
+
"requiresProject": true,
|
|
2342
|
+
"errorCodes": {
|
|
2343
|
+
"header": "ERROR CODES",
|
|
2344
|
+
"body": [
|
|
2345
|
+
{
|
|
2346
|
+
"name": "Succeeded (0)",
|
|
2347
|
+
"description": "Agent published successfully without errors."
|
|
2348
|
+
},
|
|
2349
|
+
{
|
|
2350
|
+
"name": "Failed (1)",
|
|
2351
|
+
"description": "Compilation errors found in the Agent Script file."
|
|
2352
|
+
}
|
|
2353
|
+
]
|
|
2354
|
+
},
|
|
2355
|
+
"FLAGGABLE_PROMPTS": {
|
|
2356
|
+
"api-name": {
|
|
2357
|
+
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
2358
|
+
"promptMessage": "API name of the authoring bundle to publish"
|
|
2359
|
+
}
|
|
2360
|
+
},
|
|
2210
2361
|
"isESM": true,
|
|
2211
2362
|
"relativePath": [
|
|
2212
2363
|
"lib",
|
|
2213
2364
|
"commands",
|
|
2214
2365
|
"agent",
|
|
2215
|
-
"
|
|
2216
|
-
"
|
|
2217
|
-
],
|
|
2366
|
+
"publish",
|
|
2367
|
+
"authoring-bundle.js"
|
|
2368
|
+
],
|
|
2218
2369
|
"aliasPermutations": [],
|
|
2219
2370
|
"permutations": [
|
|
2220
|
-
"agent:
|
|
2221
|
-
"
|
|
2222
|
-
"
|
|
2223
|
-
"agent:
|
|
2224
|
-
"
|
|
2225
|
-
"
|
|
2371
|
+
"agent:publish:authoring-bundle",
|
|
2372
|
+
"publish:agent:authoring-bundle",
|
|
2373
|
+
"publish:authoring-bundle:agent",
|
|
2374
|
+
"agent:authoring-bundle:publish",
|
|
2375
|
+
"authoring-bundle:agent:publish",
|
|
2376
|
+
"authoring-bundle:publish:agent"
|
|
2226
2377
|
]
|
|
2227
2378
|
},
|
|
2228
|
-
"agent:
|
|
2379
|
+
"agent:test:create": {
|
|
2229
2380
|
"aliases": [],
|
|
2230
2381
|
"args": {},
|
|
2231
|
-
"description": "
|
|
2382
|
+
"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.",
|
|
2232
2383
|
"examples": [
|
|
2233
|
-
"
|
|
2234
|
-
"
|
|
2235
|
-
"
|
|
2236
|
-
"
|
|
2237
|
-
"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>"
|
|
2384
|
+
"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 %>",
|
|
2385
|
+
"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",
|
|
2386
|
+
"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",
|
|
2387
|
+
"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"
|
|
2238
2388
|
],
|
|
2239
2389
|
"flags": {
|
|
2240
2390
|
"json": {
|
|
@@ -2252,6 +2402,20 @@
|
|
|
2252
2402
|
"multiple": false,
|
|
2253
2403
|
"type": "option"
|
|
2254
2404
|
},
|
|
2405
|
+
"api-name": {
|
|
2406
|
+
"name": "api-name",
|
|
2407
|
+
"summary": "API name of the new test; the API name must not exist in the org.",
|
|
2408
|
+
"hasDynamicHelp": false,
|
|
2409
|
+
"multiple": false,
|
|
2410
|
+
"type": "option"
|
|
2411
|
+
},
|
|
2412
|
+
"spec": {
|
|
2413
|
+
"name": "spec",
|
|
2414
|
+
"summary": "Path to the test spec YAML file.",
|
|
2415
|
+
"hasDynamicHelp": false,
|
|
2416
|
+
"multiple": false,
|
|
2417
|
+
"type": "option"
|
|
2418
|
+
},
|
|
2255
2419
|
"target-org": {
|
|
2256
2420
|
"char": "o",
|
|
2257
2421
|
"name": "target-org",
|
|
@@ -2269,65 +2433,40 @@
|
|
|
2269
2433
|
"multiple": false,
|
|
2270
2434
|
"type": "option"
|
|
2271
2435
|
},
|
|
2272
|
-
"
|
|
2273
|
-
"
|
|
2274
|
-
|
|
2275
|
-
],
|
|
2276
|
-
"name": "session-id",
|
|
2277
|
-
"required": false,
|
|
2278
|
-
"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.",
|
|
2279
|
-
"hasDynamicHelp": false,
|
|
2280
|
-
"multiple": false,
|
|
2281
|
-
"type": "option"
|
|
2282
|
-
},
|
|
2283
|
-
"api-name": {
|
|
2284
|
-
"char": "n",
|
|
2285
|
-
"exclusive": [
|
|
2286
|
-
"authoring-bundle"
|
|
2287
|
-
],
|
|
2288
|
-
"name": "api-name",
|
|
2289
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
2290
|
-
"hasDynamicHelp": false,
|
|
2291
|
-
"multiple": false,
|
|
2292
|
-
"type": "option"
|
|
2293
|
-
},
|
|
2294
|
-
"authoring-bundle": {
|
|
2295
|
-
"exclusive": [
|
|
2296
|
-
"api-name"
|
|
2297
|
-
],
|
|
2298
|
-
"name": "authoring-bundle",
|
|
2299
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2300
|
-
"hasDynamicHelp": false,
|
|
2301
|
-
"multiple": false,
|
|
2302
|
-
"type": "option"
|
|
2303
|
-
},
|
|
2304
|
-
"all": {
|
|
2305
|
-
"exclusive": [
|
|
2306
|
-
"session-id"
|
|
2307
|
-
],
|
|
2308
|
-
"name": "all",
|
|
2309
|
-
"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.",
|
|
2436
|
+
"preview": {
|
|
2437
|
+
"name": "preview",
|
|
2438
|
+
"summary": "Preview the test metadata file without deploying to your org.",
|
|
2310
2439
|
"allowNo": false,
|
|
2311
2440
|
"type": "boolean"
|
|
2312
2441
|
},
|
|
2313
|
-
"
|
|
2314
|
-
"
|
|
2315
|
-
"
|
|
2316
|
-
"summary": "Don't prompt for confirmation before ending sessions. Has an effect only when used with --all.",
|
|
2442
|
+
"force-overwrite": {
|
|
2443
|
+
"name": "force-overwrite",
|
|
2444
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test (based on API name) in your org.",
|
|
2317
2445
|
"allowNo": false,
|
|
2318
2446
|
"type": "boolean"
|
|
2447
|
+
},
|
|
2448
|
+
"test-runner": {
|
|
2449
|
+
"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.",
|
|
2450
|
+
"name": "test-runner",
|
|
2451
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2452
|
+
"hasDynamicHelp": false,
|
|
2453
|
+
"multiple": false,
|
|
2454
|
+
"options": [
|
|
2455
|
+
"agentforce-studio",
|
|
2456
|
+
"testing-center"
|
|
2457
|
+
],
|
|
2458
|
+
"type": "option"
|
|
2319
2459
|
}
|
|
2320
2460
|
},
|
|
2321
2461
|
"hasDynamicHelp": true,
|
|
2322
2462
|
"hiddenAliases": [],
|
|
2323
|
-
"id": "agent:
|
|
2463
|
+
"id": "agent:test:create",
|
|
2324
2464
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2325
2465
|
"pluginName": "@salesforce/plugin-agent",
|
|
2326
2466
|
"pluginType": "core",
|
|
2327
2467
|
"strict": true,
|
|
2328
|
-
"summary": "
|
|
2468
|
+
"summary": "Create an agent test in your org using a local test spec YAML file.",
|
|
2329
2469
|
"enableJsonFlag": true,
|
|
2330
|
-
"requiresProject": true,
|
|
2331
2470
|
"envVariablesSection": {
|
|
2332
2471
|
"header": "ENVIRONMENT VARIABLES",
|
|
2333
2472
|
"body": [
|
|
@@ -2342,27 +2481,19 @@
|
|
|
2342
2481
|
"body": [
|
|
2343
2482
|
{
|
|
2344
2483
|
"name": "Succeeded (0)",
|
|
2345
|
-
"description": "
|
|
2484
|
+
"description": "Test created and deployed successfully."
|
|
2346
2485
|
},
|
|
2347
2486
|
{
|
|
2348
|
-
"name": "
|
|
2349
|
-
"description": "
|
|
2487
|
+
"name": "Failed (1)",
|
|
2488
|
+
"description": "Test validation errors or metadata format issues."
|
|
2350
2489
|
},
|
|
2351
2490
|
{
|
|
2352
2491
|
"name": "NotFound (2)",
|
|
2353
|
-
"description": "
|
|
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."
|
|
2492
|
+
"description": "Test spec file not found or org connection failed."
|
|
2362
2493
|
},
|
|
2363
2494
|
{
|
|
2364
|
-
"name": "
|
|
2365
|
-
"description": "
|
|
2495
|
+
"name": "DeploymentFailed (4)",
|
|
2496
|
+
"description": "Deployment failed due to API or network errors."
|
|
2366
2497
|
}
|
|
2367
2498
|
]
|
|
2368
2499
|
},
|
|
@@ -2371,27 +2502,26 @@
|
|
|
2371
2502
|
"lib",
|
|
2372
2503
|
"commands",
|
|
2373
2504
|
"agent",
|
|
2374
|
-
"
|
|
2375
|
-
"
|
|
2505
|
+
"test",
|
|
2506
|
+
"create.js"
|
|
2376
2507
|
],
|
|
2377
2508
|
"aliasPermutations": [],
|
|
2378
2509
|
"permutations": [
|
|
2379
|
-
"agent:
|
|
2380
|
-
"
|
|
2381
|
-
"
|
|
2382
|
-
"agent:
|
|
2383
|
-
"
|
|
2384
|
-
"
|
|
2510
|
+
"agent:test:create",
|
|
2511
|
+
"test:agent:create",
|
|
2512
|
+
"test:create:agent",
|
|
2513
|
+
"agent:create:test",
|
|
2514
|
+
"create:agent:test",
|
|
2515
|
+
"create:test:agent"
|
|
2385
2516
|
]
|
|
2386
2517
|
},
|
|
2387
|
-
"agent:
|
|
2518
|
+
"agent:test:list": {
|
|
2388
2519
|
"aliases": [],
|
|
2389
2520
|
"args": {},
|
|
2390
|
-
"description": "
|
|
2521
|
+
"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.",
|
|
2391
2522
|
"examples": [
|
|
2392
|
-
"
|
|
2393
|
-
"
|
|
2394
|
-
"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"
|
|
2523
|
+
"List the agent tests in your default org:\n<%= config.bin %> <%= command.id %>",
|
|
2524
|
+
"List the agent tests in an org with alias \"my-org\"\"\n<%= config.bin %> <%= command.id %> --target-org my-org"
|
|
2395
2525
|
],
|
|
2396
2526
|
"flags": {
|
|
2397
2527
|
"json": {
|
|
@@ -2425,50 +2555,17 @@
|
|
|
2425
2555
|
"hasDynamicHelp": false,
|
|
2426
2556
|
"multiple": false,
|
|
2427
2557
|
"type": "option"
|
|
2428
|
-
},
|
|
2429
|
-
"session-id": {
|
|
2430
|
-
"name": "session-id",
|
|
2431
|
-
"required": false,
|
|
2432
|
-
"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.",
|
|
2433
|
-
"hasDynamicHelp": false,
|
|
2434
|
-
"multiple": false,
|
|
2435
|
-
"type": "option"
|
|
2436
|
-
},
|
|
2437
|
-
"utterance": {
|
|
2438
|
-
"char": "u",
|
|
2439
|
-
"name": "utterance",
|
|
2440
|
-
"required": true,
|
|
2441
|
-
"summary": "Utterance to send to the agent, enclosed in double quotes.",
|
|
2442
|
-
"hasDynamicHelp": false,
|
|
2443
|
-
"multiple": false,
|
|
2444
|
-
"type": "option"
|
|
2445
|
-
},
|
|
2446
|
-
"api-name": {
|
|
2447
|
-
"char": "n",
|
|
2448
|
-
"name": "api-name",
|
|
2449
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
2450
|
-
"hasDynamicHelp": false,
|
|
2451
|
-
"multiple": false,
|
|
2452
|
-
"type": "option"
|
|
2453
|
-
},
|
|
2454
|
-
"authoring-bundle": {
|
|
2455
|
-
"name": "authoring-bundle",
|
|
2456
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2457
|
-
"hasDynamicHelp": false,
|
|
2458
|
-
"multiple": false,
|
|
2459
|
-
"type": "option"
|
|
2460
2558
|
}
|
|
2461
2559
|
},
|
|
2462
2560
|
"hasDynamicHelp": true,
|
|
2463
2561
|
"hiddenAliases": [],
|
|
2464
|
-
"id": "agent:
|
|
2562
|
+
"id": "agent:test:list",
|
|
2465
2563
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2466
2564
|
"pluginName": "@salesforce/plugin-agent",
|
|
2467
2565
|
"pluginType": "core",
|
|
2468
2566
|
"strict": true,
|
|
2469
|
-
"summary": "
|
|
2567
|
+
"summary": "List the available agent tests in your org.",
|
|
2470
2568
|
"enableJsonFlag": true,
|
|
2471
|
-
"requiresProject": true,
|
|
2472
2569
|
"envVariablesSection": {
|
|
2473
2570
|
"header": "ENVIRONMENT VARIABLES",
|
|
2474
2571
|
"body": [
|
|
@@ -2483,19 +2580,11 @@
|
|
|
2483
2580
|
"body": [
|
|
2484
2581
|
{
|
|
2485
2582
|
"name": "Succeeded (0)",
|
|
2486
|
-
"description": "
|
|
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."
|
|
2583
|
+
"description": "Agent tests listed successfully."
|
|
2495
2584
|
},
|
|
2496
2585
|
{
|
|
2497
|
-
"name": "
|
|
2498
|
-
"description": "
|
|
2586
|
+
"name": "Failed (4)",
|
|
2587
|
+
"description": "Failed to retrieve agent tests due to API or network errors."
|
|
2499
2588
|
}
|
|
2500
2589
|
]
|
|
2501
2590
|
},
|
|
@@ -2504,88 +2593,27 @@
|
|
|
2504
2593
|
"lib",
|
|
2505
2594
|
"commands",
|
|
2506
2595
|
"agent",
|
|
2507
|
-
"
|
|
2508
|
-
"
|
|
2596
|
+
"test",
|
|
2597
|
+
"list.js"
|
|
2509
2598
|
],
|
|
2510
2599
|
"aliasPermutations": [],
|
|
2511
2600
|
"permutations": [
|
|
2512
|
-
"agent:
|
|
2513
|
-
"
|
|
2514
|
-
"
|
|
2515
|
-
"agent:
|
|
2516
|
-
"
|
|
2517
|
-
"
|
|
2601
|
+
"agent:test:list",
|
|
2602
|
+
"test:agent:list",
|
|
2603
|
+
"test:list:agent",
|
|
2604
|
+
"agent:list:test",
|
|
2605
|
+
"list:agent:test",
|
|
2606
|
+
"list:test:agent"
|
|
2518
2607
|
]
|
|
2519
2608
|
},
|
|
2520
|
-
"agent:
|
|
2609
|
+
"agent:test:results": {
|
|
2521
2610
|
"aliases": [],
|
|
2522
2611
|
"args": {},
|
|
2523
|
-
"description": "This command
|
|
2612
|
+
"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.",
|
|
2524
2613
|
"examples": [
|
|
2525
|
-
"
|
|
2526
|
-
|
|
2527
|
-
|
|
2528
|
-
"json": {
|
|
2529
|
-
"description": "Format output as json.",
|
|
2530
|
-
"helpGroup": "GLOBAL",
|
|
2531
|
-
"name": "json",
|
|
2532
|
-
"allowNo": false,
|
|
2533
|
-
"type": "boolean"
|
|
2534
|
-
},
|
|
2535
|
-
"flags-dir": {
|
|
2536
|
-
"helpGroup": "GLOBAL",
|
|
2537
|
-
"name": "flags-dir",
|
|
2538
|
-
"summary": "Import flag values from a directory.",
|
|
2539
|
-
"hasDynamicHelp": false,
|
|
2540
|
-
"multiple": false,
|
|
2541
|
-
"type": "option"
|
|
2542
|
-
}
|
|
2543
|
-
},
|
|
2544
|
-
"hasDynamicHelp": false,
|
|
2545
|
-
"hiddenAliases": [],
|
|
2546
|
-
"id": "agent:preview:sessions",
|
|
2547
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
2548
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
2549
|
-
"pluginType": "core",
|
|
2550
|
-
"strict": true,
|
|
2551
|
-
"summary": "List all known programmatic agent preview sessions.",
|
|
2552
|
-
"enableJsonFlag": true,
|
|
2553
|
-
"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
|
-
"isESM": true,
|
|
2564
|
-
"relativePath": [
|
|
2565
|
-
"lib",
|
|
2566
|
-
"commands",
|
|
2567
|
-
"agent",
|
|
2568
|
-
"preview",
|
|
2569
|
-
"sessions.js"
|
|
2570
|
-
],
|
|
2571
|
-
"aliasPermutations": [],
|
|
2572
|
-
"permutations": [
|
|
2573
|
-
"agent:preview:sessions",
|
|
2574
|
-
"preview:agent:sessions",
|
|
2575
|
-
"preview:sessions:agent",
|
|
2576
|
-
"agent:sessions:preview",
|
|
2577
|
-
"sessions:agent:preview",
|
|
2578
|
-
"sessions:preview:agent"
|
|
2579
|
-
]
|
|
2580
|
-
},
|
|
2581
|
-
"agent:preview:start": {
|
|
2582
|
-
"aliases": [],
|
|
2583
|
-
"args": {},
|
|
2584
|
-
"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.",
|
|
2585
|
-
"examples": [
|
|
2586
|
-
"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",
|
|
2587
|
-
"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",
|
|
2588
|
-
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
2614
|
+
"Get the results of an agent test run in your default org using its job ID:\n<%= config.bin %> <%= command.id %> --job-id 4KBfake0000003F4AQ",
|
|
2615
|
+
"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",
|
|
2616
|
+
"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"
|
|
2589
2617
|
],
|
|
2590
2618
|
"flags": {
|
|
2591
2619
|
"json": {
|
|
@@ -2620,70 +2648,67 @@
|
|
|
2620
2648
|
"multiple": false,
|
|
2621
2649
|
"type": "option"
|
|
2622
2650
|
},
|
|
2623
|
-
"
|
|
2624
|
-
"char": "
|
|
2625
|
-
"name": "
|
|
2626
|
-
"
|
|
2651
|
+
"job-id": {
|
|
2652
|
+
"char": "i",
|
|
2653
|
+
"name": "job-id",
|
|
2654
|
+
"required": true,
|
|
2655
|
+
"summary": "Job ID of the completed agent test run.",
|
|
2627
2656
|
"hasDynamicHelp": false,
|
|
2628
2657
|
"multiple": false,
|
|
2629
2658
|
"type": "option"
|
|
2630
2659
|
},
|
|
2631
|
-
"
|
|
2632
|
-
"name": "
|
|
2633
|
-
"summary": "
|
|
2660
|
+
"result-format": {
|
|
2661
|
+
"name": "result-format",
|
|
2662
|
+
"summary": "Format of the agent test run results.",
|
|
2663
|
+
"default": "human",
|
|
2634
2664
|
"hasDynamicHelp": false,
|
|
2635
2665
|
"multiple": false,
|
|
2636
|
-
"
|
|
2637
|
-
|
|
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"
|
|
2666
|
+
"options": [
|
|
2667
|
+
"json",
|
|
2668
|
+
"human",
|
|
2669
|
+
"junit",
|
|
2670
|
+
"tap"
|
|
2650
2671
|
],
|
|
2651
|
-
"
|
|
2652
|
-
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
2653
|
-
"allowNo": false,
|
|
2654
|
-
"type": "boolean"
|
|
2672
|
+
"type": "option"
|
|
2655
2673
|
},
|
|
2656
|
-
"
|
|
2657
|
-
"
|
|
2658
|
-
"
|
|
2659
|
-
"
|
|
2660
|
-
"
|
|
2674
|
+
"output-dir": {
|
|
2675
|
+
"char": "d",
|
|
2676
|
+
"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.",
|
|
2677
|
+
"name": "output-dir",
|
|
2678
|
+
"summary": "Directory to write the agent test results into.",
|
|
2661
2679
|
"hasDynamicHelp": false,
|
|
2662
|
-
"multiple":
|
|
2680
|
+
"multiple": false,
|
|
2663
2681
|
"type": "option"
|
|
2664
2682
|
},
|
|
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.",
|
|
2683
|
+
"test-runner": {
|
|
2684
|
+
"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.",
|
|
2685
|
+
"name": "test-runner",
|
|
2686
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2672
2687
|
"hasDynamicHelp": false,
|
|
2673
2688
|
"multiple": false,
|
|
2689
|
+
"options": [
|
|
2690
|
+
"agentforce-studio",
|
|
2691
|
+
"testing-center"
|
|
2692
|
+
],
|
|
2674
2693
|
"type": "option"
|
|
2694
|
+
},
|
|
2695
|
+
"verbose": {
|
|
2696
|
+
"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.",
|
|
2697
|
+
"name": "verbose",
|
|
2698
|
+
"summary": "Show generated data in the test results output.",
|
|
2699
|
+
"allowNo": false,
|
|
2700
|
+
"type": "boolean"
|
|
2675
2701
|
}
|
|
2676
2702
|
},
|
|
2677
2703
|
"hasDynamicHelp": true,
|
|
2678
2704
|
"hiddenAliases": [],
|
|
2679
|
-
"id": "agent:
|
|
2705
|
+
"id": "agent:test:results",
|
|
2680
2706
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2681
2707
|
"pluginName": "@salesforce/plugin-agent",
|
|
2682
2708
|
"pluginType": "core",
|
|
2683
2709
|
"strict": true,
|
|
2684
|
-
"summary": "
|
|
2710
|
+
"summary": "Get the results of a completed agent test run.",
|
|
2685
2711
|
"enableJsonFlag": true,
|
|
2686
|
-
"requiresProject": true,
|
|
2687
2712
|
"envVariablesSection": {
|
|
2688
2713
|
"header": "ENVIRONMENT VARIABLES",
|
|
2689
2714
|
"body": [
|
|
@@ -2698,23 +2723,15 @@
|
|
|
2698
2723
|
"body": [
|
|
2699
2724
|
{
|
|
2700
2725
|
"name": "Succeeded (0)",
|
|
2701
|
-
"description": "
|
|
2702
|
-
},
|
|
2703
|
-
{
|
|
2704
|
-
"name": "Failed (1)",
|
|
2705
|
-
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
2726
|
+
"description": "Results retrieved successfully. Test results (passed/failed) are in the output."
|
|
2706
2727
|
},
|
|
2707
2728
|
{
|
|
2708
2729
|
"name": "NotFound (2)",
|
|
2709
|
-
"description": "
|
|
2710
|
-
},
|
|
2711
|
-
{
|
|
2712
|
-
"name": "ServerError (3)",
|
|
2713
|
-
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
2730
|
+
"description": "Job ID not found or invalid."
|
|
2714
2731
|
},
|
|
2715
2732
|
{
|
|
2716
|
-
"name": "
|
|
2717
|
-
"description": "
|
|
2733
|
+
"name": "Failed (4)",
|
|
2734
|
+
"description": "Failed to retrieve results due to API or network errors."
|
|
2718
2735
|
}
|
|
2719
2736
|
]
|
|
2720
2737
|
},
|
|
@@ -2723,28 +2740,27 @@
|
|
|
2723
2740
|
"lib",
|
|
2724
2741
|
"commands",
|
|
2725
2742
|
"agent",
|
|
2726
|
-
"
|
|
2727
|
-
"
|
|
2743
|
+
"test",
|
|
2744
|
+
"results.js"
|
|
2728
2745
|
],
|
|
2729
2746
|
"aliasPermutations": [],
|
|
2730
2747
|
"permutations": [
|
|
2731
|
-
"agent:
|
|
2732
|
-
"
|
|
2733
|
-
"
|
|
2734
|
-
"agent:
|
|
2735
|
-
"
|
|
2736
|
-
"
|
|
2748
|
+
"agent:test:results",
|
|
2749
|
+
"test:agent:results",
|
|
2750
|
+
"test:results:agent",
|
|
2751
|
+
"agent:results:test",
|
|
2752
|
+
"results:agent:test",
|
|
2753
|
+
"results:test:agent"
|
|
2737
2754
|
]
|
|
2738
2755
|
},
|
|
2739
|
-
"agent:
|
|
2756
|
+
"agent:test:resume": {
|
|
2740
2757
|
"aliases": [],
|
|
2741
2758
|
"args": {},
|
|
2742
|
-
"description": "
|
|
2759
|
+
"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.",
|
|
2743
2760
|
"examples": [
|
|
2744
|
-
"
|
|
2745
|
-
"
|
|
2746
|
-
"
|
|
2747
|
-
"Publish with concise output showing only essential information:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --concise"
|
|
2761
|
+
"Resume an agent test in your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 4KBfake0000003F4AQ",
|
|
2762
|
+
"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",
|
|
2763
|
+
"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"
|
|
2748
2764
|
],
|
|
2749
2765
|
"flags": {
|
|
2750
2766
|
"json": {
|
|
@@ -2779,96 +2795,141 @@
|
|
|
2779
2795
|
"multiple": false,
|
|
2780
2796
|
"type": "option"
|
|
2781
2797
|
},
|
|
2782
|
-
"
|
|
2783
|
-
"char": "
|
|
2784
|
-
"name": "
|
|
2785
|
-
"summary": "
|
|
2798
|
+
"job-id": {
|
|
2799
|
+
"char": "i",
|
|
2800
|
+
"name": "job-id",
|
|
2801
|
+
"summary": "Job ID of the original agent test run.",
|
|
2786
2802
|
"hasDynamicHelp": false,
|
|
2787
2803
|
"multiple": false,
|
|
2788
2804
|
"type": "option"
|
|
2789
2805
|
},
|
|
2790
|
-
"
|
|
2791
|
-
"
|
|
2792
|
-
"
|
|
2806
|
+
"use-most-recent": {
|
|
2807
|
+
"char": "r",
|
|
2808
|
+
"name": "use-most-recent",
|
|
2809
|
+
"summary": "Use the job ID of the most recent agent test run.",
|
|
2793
2810
|
"allowNo": false,
|
|
2794
2811
|
"type": "boolean"
|
|
2795
2812
|
},
|
|
2796
|
-
"
|
|
2797
|
-
"char": "
|
|
2798
|
-
"
|
|
2799
|
-
|
|
2813
|
+
"wait": {
|
|
2814
|
+
"char": "w",
|
|
2815
|
+
"name": "wait",
|
|
2816
|
+
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
2817
|
+
"default": "5 minutes",
|
|
2818
|
+
"hasDynamicHelp": true,
|
|
2819
|
+
"multiple": false,
|
|
2820
|
+
"type": "option"
|
|
2821
|
+
},
|
|
2822
|
+
"result-format": {
|
|
2823
|
+
"name": "result-format",
|
|
2824
|
+
"summary": "Format of the agent test run results.",
|
|
2825
|
+
"default": "human",
|
|
2826
|
+
"hasDynamicHelp": false,
|
|
2827
|
+
"multiple": false,
|
|
2828
|
+
"options": [
|
|
2829
|
+
"json",
|
|
2830
|
+
"human",
|
|
2831
|
+
"junit",
|
|
2832
|
+
"tap"
|
|
2800
2833
|
],
|
|
2801
|
-
"
|
|
2802
|
-
"summary": "Display detailed output showing all metadata components retrieved and deployed during the publish process.",
|
|
2803
|
-
"allowNo": false,
|
|
2804
|
-
"type": "boolean"
|
|
2834
|
+
"type": "option"
|
|
2805
2835
|
},
|
|
2806
|
-
"
|
|
2807
|
-
"
|
|
2808
|
-
|
|
2836
|
+
"output-dir": {
|
|
2837
|
+
"char": "d",
|
|
2838
|
+
"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.",
|
|
2839
|
+
"name": "output-dir",
|
|
2840
|
+
"summary": "Directory to write the agent test results into.",
|
|
2841
|
+
"hasDynamicHelp": false,
|
|
2842
|
+
"multiple": false,
|
|
2843
|
+
"type": "option"
|
|
2844
|
+
},
|
|
2845
|
+
"test-runner": {
|
|
2846
|
+
"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.",
|
|
2847
|
+
"name": "test-runner",
|
|
2848
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2849
|
+
"hasDynamicHelp": false,
|
|
2850
|
+
"multiple": false,
|
|
2851
|
+
"options": [
|
|
2852
|
+
"agentforce-studio",
|
|
2853
|
+
"testing-center"
|
|
2809
2854
|
],
|
|
2810
|
-
"
|
|
2811
|
-
|
|
2855
|
+
"type": "option"
|
|
2856
|
+
},
|
|
2857
|
+
"verbose": {
|
|
2858
|
+
"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.",
|
|
2859
|
+
"name": "verbose",
|
|
2860
|
+
"summary": "Show generated data in the test results output.",
|
|
2812
2861
|
"allowNo": false,
|
|
2813
2862
|
"type": "boolean"
|
|
2814
2863
|
}
|
|
2815
2864
|
},
|
|
2816
2865
|
"hasDynamicHelp": true,
|
|
2817
2866
|
"hiddenAliases": [],
|
|
2818
|
-
"id": "agent:
|
|
2867
|
+
"id": "agent:test:resume",
|
|
2819
2868
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2820
2869
|
"pluginName": "@salesforce/plugin-agent",
|
|
2821
2870
|
"pluginType": "core",
|
|
2822
2871
|
"strict": true,
|
|
2823
|
-
"summary": "
|
|
2872
|
+
"summary": "Resume an agent test that you previously started in your org so you can view the test results.",
|
|
2824
2873
|
"enableJsonFlag": true,
|
|
2825
|
-
"
|
|
2874
|
+
"envVariablesSection": {
|
|
2875
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2876
|
+
"body": [
|
|
2877
|
+
{
|
|
2878
|
+
"name": "SF_TARGET_ORG",
|
|
2879
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2880
|
+
}
|
|
2881
|
+
]
|
|
2882
|
+
},
|
|
2826
2883
|
"errorCodes": {
|
|
2827
2884
|
"header": "ERROR CODES",
|
|
2828
2885
|
"body": [
|
|
2829
2886
|
{
|
|
2830
2887
|
"name": "Succeeded (0)",
|
|
2831
|
-
"description": "
|
|
2888
|
+
"description": "Test completed successfully (with test results in the output)."
|
|
2832
2889
|
},
|
|
2833
2890
|
{
|
|
2834
2891
|
"name": "Failed (1)",
|
|
2835
|
-
"description": "
|
|
2892
|
+
"description": "Tests encountered execution errors (test cases with ERROR status)."
|
|
2893
|
+
},
|
|
2894
|
+
{
|
|
2895
|
+
"name": "NotFound (2)",
|
|
2896
|
+
"description": "Job ID not found or invalid."
|
|
2897
|
+
},
|
|
2898
|
+
{
|
|
2899
|
+
"name": "OperationFailed (4)",
|
|
2900
|
+
"description": "Failed to poll test due to API or network errors."
|
|
2836
2901
|
}
|
|
2837
2902
|
]
|
|
2838
2903
|
},
|
|
2839
|
-
"FLAGGABLE_PROMPTS": {
|
|
2840
|
-
"api-name": {
|
|
2841
|
-
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
2842
|
-
"promptMessage": "API name of the authoring bundle to publish"
|
|
2843
|
-
}
|
|
2844
|
-
},
|
|
2845
2904
|
"isESM": true,
|
|
2846
2905
|
"relativePath": [
|
|
2847
2906
|
"lib",
|
|
2848
2907
|
"commands",
|
|
2849
2908
|
"agent",
|
|
2850
|
-
"
|
|
2851
|
-
"
|
|
2909
|
+
"test",
|
|
2910
|
+
"resume.js"
|
|
2852
2911
|
],
|
|
2853
2912
|
"aliasPermutations": [],
|
|
2854
2913
|
"permutations": [
|
|
2855
|
-
"agent:
|
|
2856
|
-
"
|
|
2857
|
-
"
|
|
2858
|
-
"agent:
|
|
2859
|
-
"
|
|
2860
|
-
"
|
|
2914
|
+
"agent:test:resume",
|
|
2915
|
+
"test:agent:resume",
|
|
2916
|
+
"test:resume:agent",
|
|
2917
|
+
"agent:resume:test",
|
|
2918
|
+
"resume:agent:test",
|
|
2919
|
+
"resume:test:agent"
|
|
2861
2920
|
]
|
|
2862
2921
|
},
|
|
2863
|
-
"agent:test:
|
|
2922
|
+
"agent:test:run-eval": {
|
|
2864
2923
|
"aliases": [],
|
|
2865
2924
|
"args": {},
|
|
2866
|
-
"description": "
|
|
2925
|
+
"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.",
|
|
2867
2926
|
"examples": [
|
|
2868
|
-
"
|
|
2869
|
-
"
|
|
2870
|
-
"
|
|
2871
|
-
"
|
|
2927
|
+
"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",
|
|
2928
|
+
"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",
|
|
2929
|
+
"Run tests using a JSON payload:\n<%= config.bin %> <%= command.id %> --spec specs/eval-payload.json --target-org my-org",
|
|
2930
|
+
"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",
|
|
2931
|
+
"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",
|
|
2932
|
+
"Pipe JSON payload from stdin (--spec flag is automatically populated from stdin):\n$ echo '{\"tests\":[...]}' | <%= config.bin %> <%= command.id %> --spec --target-org my-org"
|
|
2872
2933
|
],
|
|
2873
2934
|
"flags": {
|
|
2874
2935
|
"json": {
|
|
@@ -2886,20 +2947,6 @@
|
|
|
2886
2947
|
"multiple": false,
|
|
2887
2948
|
"type": "option"
|
|
2888
2949
|
},
|
|
2889
|
-
"api-name": {
|
|
2890
|
-
"name": "api-name",
|
|
2891
|
-
"summary": "API name of the new test; the API name must not exist in the org.",
|
|
2892
|
-
"hasDynamicHelp": false,
|
|
2893
|
-
"multiple": false,
|
|
2894
|
-
"type": "option"
|
|
2895
|
-
},
|
|
2896
|
-
"spec": {
|
|
2897
|
-
"name": "spec",
|
|
2898
|
-
"summary": "Path to the test spec YAML file.",
|
|
2899
|
-
"hasDynamicHelp": false,
|
|
2900
|
-
"multiple": false,
|
|
2901
|
-
"type": "option"
|
|
2902
|
-
},
|
|
2903
2950
|
"target-org": {
|
|
2904
2951
|
"char": "o",
|
|
2905
2952
|
"name": "target-org",
|
|
@@ -2917,39 +2964,61 @@
|
|
|
2917
2964
|
"multiple": false,
|
|
2918
2965
|
"type": "option"
|
|
2919
2966
|
},
|
|
2920
|
-
"
|
|
2921
|
-
"
|
|
2922
|
-
"
|
|
2923
|
-
"
|
|
2924
|
-
"
|
|
2967
|
+
"spec": {
|
|
2968
|
+
"char": "s",
|
|
2969
|
+
"name": "spec",
|
|
2970
|
+
"required": true,
|
|
2971
|
+
"summary": "Path to test spec file (YAML or JSON). Supports reading from stdin when piping content.",
|
|
2972
|
+
"hasDynamicHelp": false,
|
|
2973
|
+
"multiple": false,
|
|
2974
|
+
"type": "option"
|
|
2925
2975
|
},
|
|
2926
|
-
"
|
|
2927
|
-
"
|
|
2928
|
-
"
|
|
2929
|
-
"
|
|
2930
|
-
"
|
|
2976
|
+
"api-name": {
|
|
2977
|
+
"char": "n",
|
|
2978
|
+
"name": "api-name",
|
|
2979
|
+
"summary": "Agent API name (also called DeveloperName) used to resolve agent_id and agent_version_id. Auto-inferred from the YAML spec's subjectName.",
|
|
2980
|
+
"hasDynamicHelp": false,
|
|
2981
|
+
"multiple": false,
|
|
2982
|
+
"type": "option"
|
|
2931
2983
|
},
|
|
2932
|
-
"
|
|
2933
|
-
"
|
|
2934
|
-
"
|
|
2935
|
-
"
|
|
2984
|
+
"result-format": {
|
|
2985
|
+
"name": "result-format",
|
|
2986
|
+
"summary": "Format of the agent test run results.",
|
|
2987
|
+
"default": "human",
|
|
2936
2988
|
"hasDynamicHelp": false,
|
|
2937
2989
|
"multiple": false,
|
|
2938
2990
|
"options": [
|
|
2939
|
-
"
|
|
2940
|
-
"
|
|
2991
|
+
"json",
|
|
2992
|
+
"human",
|
|
2993
|
+
"junit",
|
|
2994
|
+
"tap"
|
|
2941
2995
|
],
|
|
2942
2996
|
"type": "option"
|
|
2997
|
+
},
|
|
2998
|
+
"batch-size": {
|
|
2999
|
+
"name": "batch-size",
|
|
3000
|
+
"summary": "Number of tests per API request (max 5).",
|
|
3001
|
+
"default": 5,
|
|
3002
|
+
"hasDynamicHelp": false,
|
|
3003
|
+
"multiple": false,
|
|
3004
|
+
"type": "option"
|
|
3005
|
+
},
|
|
3006
|
+
"no-normalize": {
|
|
3007
|
+
"name": "no-normalize",
|
|
3008
|
+
"summary": "Disable auto-normalization of field names and shorthand references.",
|
|
3009
|
+
"allowNo": false,
|
|
3010
|
+
"type": "boolean"
|
|
2943
3011
|
}
|
|
2944
3012
|
},
|
|
2945
3013
|
"hasDynamicHelp": true,
|
|
2946
3014
|
"hiddenAliases": [],
|
|
2947
|
-
"id": "agent:test:
|
|
3015
|
+
"id": "agent:test:run-eval",
|
|
2948
3016
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2949
3017
|
"pluginName": "@salesforce/plugin-agent",
|
|
2950
3018
|
"pluginType": "core",
|
|
3019
|
+
"state": "beta",
|
|
2951
3020
|
"strict": true,
|
|
2952
|
-
"summary": "
|
|
3021
|
+
"summary": "Run rich evaluation tests against an Agentforce agent.",
|
|
2953
3022
|
"enableJsonFlag": true,
|
|
2954
3023
|
"envVariablesSection": {
|
|
2955
3024
|
"header": "ENVIRONMENT VARIABLES",
|
|
@@ -2965,19 +3034,19 @@
|
|
|
2965
3034
|
"body": [
|
|
2966
3035
|
{
|
|
2967
3036
|
"name": "Succeeded (0)",
|
|
2968
|
-
"description": "Test
|
|
3037
|
+
"description": "Tests completed successfully. Test results (passed/failed) are in the JSON output."
|
|
2969
3038
|
},
|
|
2970
3039
|
{
|
|
2971
3040
|
"name": "Failed (1)",
|
|
2972
|
-
"description": "
|
|
3041
|
+
"description": "Tests encountered execution errors (tests couldn't run properly)."
|
|
2973
3042
|
},
|
|
2974
3043
|
{
|
|
2975
3044
|
"name": "NotFound (2)",
|
|
2976
|
-
"description": "
|
|
3045
|
+
"description": "Agent not found, spec file not found, or invalid agent name."
|
|
2977
3046
|
},
|
|
2978
3047
|
{
|
|
2979
|
-
"name": "
|
|
2980
|
-
"description": "
|
|
3048
|
+
"name": "OperationFailed (4)",
|
|
3049
|
+
"description": "Failed to execute tests due to API or network errors."
|
|
2981
3050
|
}
|
|
2982
3051
|
]
|
|
2983
3052
|
},
|
|
@@ -2987,25 +3056,26 @@
|
|
|
2987
3056
|
"commands",
|
|
2988
3057
|
"agent",
|
|
2989
3058
|
"test",
|
|
2990
|
-
"
|
|
3059
|
+
"run-eval.js"
|
|
2991
3060
|
],
|
|
2992
3061
|
"aliasPermutations": [],
|
|
2993
3062
|
"permutations": [
|
|
2994
|
-
"agent:test:
|
|
2995
|
-
"test:agent:
|
|
2996
|
-
"test:
|
|
2997
|
-
"agent:
|
|
2998
|
-
"
|
|
2999
|
-
"
|
|
3063
|
+
"agent:test:run-eval",
|
|
3064
|
+
"test:agent:run-eval",
|
|
3065
|
+
"test:run-eval:agent",
|
|
3066
|
+
"agent:run-eval:test",
|
|
3067
|
+
"run-eval:agent:test",
|
|
3068
|
+
"run-eval:test:agent"
|
|
3000
3069
|
]
|
|
3001
3070
|
},
|
|
3002
|
-
"agent:test:
|
|
3071
|
+
"agent:test:run": {
|
|
3003
3072
|
"aliases": [],
|
|
3004
3073
|
"args": {},
|
|
3005
|
-
"description": "
|
|
3074
|
+
"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.",
|
|
3006
3075
|
"examples": [
|
|
3007
|
-
"
|
|
3008
|
-
"
|
|
3076
|
+
"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",
|
|
3077
|
+
"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",
|
|
3078
|
+
"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"
|
|
3009
3079
|
],
|
|
3010
3080
|
"flags": {
|
|
3011
3081
|
"json": {
|
|
@@ -3039,108 +3109,23 @@
|
|
|
3039
3109
|
"hasDynamicHelp": false,
|
|
3040
3110
|
"multiple": false,
|
|
3041
3111
|
"type": "option"
|
|
3042
|
-
}
|
|
3043
|
-
},
|
|
3044
|
-
"hasDynamicHelp": true,
|
|
3045
|
-
"hiddenAliases": [],
|
|
3046
|
-
"id": "agent:test:list",
|
|
3047
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
3048
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
3049
|
-
"pluginType": "core",
|
|
3050
|
-
"strict": true,
|
|
3051
|
-
"summary": "List the available agent tests in your org.",
|
|
3052
|
-
"enableJsonFlag": true,
|
|
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
|
-
},
|
|
3075
|
-
"isESM": true,
|
|
3076
|
-
"relativePath": [
|
|
3077
|
-
"lib",
|
|
3078
|
-
"commands",
|
|
3079
|
-
"agent",
|
|
3080
|
-
"test",
|
|
3081
|
-
"list.js"
|
|
3082
|
-
],
|
|
3083
|
-
"aliasPermutations": [],
|
|
3084
|
-
"permutations": [
|
|
3085
|
-
"agent:test:list",
|
|
3086
|
-
"test:agent:list",
|
|
3087
|
-
"test:list:agent",
|
|
3088
|
-
"agent:list:test",
|
|
3089
|
-
"list:agent:test",
|
|
3090
|
-
"list:test:agent"
|
|
3091
|
-
]
|
|
3092
|
-
},
|
|
3093
|
-
"agent:test:results": {
|
|
3094
|
-
"aliases": [],
|
|
3095
|
-
"args": {},
|
|
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.",
|
|
3097
|
-
"examples": [
|
|
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"
|
|
3101
|
-
],
|
|
3102
|
-
"flags": {
|
|
3103
|
-
"json": {
|
|
3104
|
-
"description": "Format output as json.",
|
|
3105
|
-
"helpGroup": "GLOBAL",
|
|
3106
|
-
"name": "json",
|
|
3107
|
-
"allowNo": false,
|
|
3108
|
-
"type": "boolean"
|
|
3109
3112
|
},
|
|
3110
|
-
"
|
|
3111
|
-
"
|
|
3112
|
-
"name": "
|
|
3113
|
-
"summary": "
|
|
3113
|
+
"api-name": {
|
|
3114
|
+
"char": "n",
|
|
3115
|
+
"name": "api-name",
|
|
3116
|
+
"summary": "API name of the agent test to run; corresponds to the name of the AiEvaluationDefinition metadata component that implements the agent test.",
|
|
3114
3117
|
"hasDynamicHelp": false,
|
|
3115
3118
|
"multiple": false,
|
|
3116
3119
|
"type": "option"
|
|
3117
3120
|
},
|
|
3118
|
-
"
|
|
3119
|
-
"char": "
|
|
3120
|
-
"name": "
|
|
3121
|
-
"
|
|
3122
|
-
"required": true,
|
|
3123
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3121
|
+
"wait": {
|
|
3122
|
+
"char": "w",
|
|
3123
|
+
"name": "wait",
|
|
3124
|
+
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
3124
3125
|
"hasDynamicHelp": true,
|
|
3125
3126
|
"multiple": false,
|
|
3126
3127
|
"type": "option"
|
|
3127
3128
|
},
|
|
3128
|
-
"api-version": {
|
|
3129
|
-
"description": "Override the api version used for api requests made by this command",
|
|
3130
|
-
"name": "api-version",
|
|
3131
|
-
"hasDynamicHelp": false,
|
|
3132
|
-
"multiple": false,
|
|
3133
|
-
"type": "option"
|
|
3134
|
-
},
|
|
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"
|
|
3143
|
-
},
|
|
3144
3129
|
"result-format": {
|
|
3145
3130
|
"name": "result-format",
|
|
3146
3131
|
"summary": "Format of the agent test run results.",
|
|
@@ -3186,12 +3171,12 @@
|
|
|
3186
3171
|
},
|
|
3187
3172
|
"hasDynamicHelp": true,
|
|
3188
3173
|
"hiddenAliases": [],
|
|
3189
|
-
"id": "agent:test:
|
|
3174
|
+
"id": "agent:test:run",
|
|
3190
3175
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3191
3176
|
"pluginName": "@salesforce/plugin-agent",
|
|
3192
3177
|
"pluginType": "core",
|
|
3193
3178
|
"strict": true,
|
|
3194
|
-
"summary": "
|
|
3179
|
+
"summary": "Start an agent test in your org.",
|
|
3195
3180
|
"enableJsonFlag": true,
|
|
3196
3181
|
"envVariablesSection": {
|
|
3197
3182
|
"header": "ENVIRONMENT VARIABLES",
|
|
@@ -3207,16 +3192,20 @@
|
|
|
3207
3192
|
"body": [
|
|
3208
3193
|
{
|
|
3209
3194
|
"name": "Succeeded (0)",
|
|
3210
|
-
"description": "
|
|
3195
|
+
"description": "Test started successfully (without --wait), or test completed successfully (with --wait)."
|
|
3196
|
+
},
|
|
3197
|
+
{
|
|
3198
|
+
"name": "Failed (1)",
|
|
3199
|
+
"description": "Tests encountered execution errors (test cases with ERROR status when using --wait)."
|
|
3211
3200
|
},
|
|
3212
3201
|
{
|
|
3213
3202
|
"name": "NotFound (2)",
|
|
3214
|
-
"description": "
|
|
3203
|
+
"description": "Test definition not found or invalid test name."
|
|
3215
3204
|
},
|
|
3216
3205
|
{
|
|
3217
|
-
"name": "
|
|
3218
|
-
"description": "Failed to
|
|
3219
|
-
}
|
|
3206
|
+
"name": "OperationFailed (4)",
|
|
3207
|
+
"description": "Failed to start or poll test due to API or network errors."
|
|
3208
|
+
}
|
|
3220
3209
|
]
|
|
3221
3210
|
},
|
|
3222
3211
|
"isESM": true,
|
|
@@ -3225,26 +3214,29 @@
|
|
|
3225
3214
|
"commands",
|
|
3226
3215
|
"agent",
|
|
3227
3216
|
"test",
|
|
3228
|
-
"
|
|
3217
|
+
"run.js"
|
|
3229
3218
|
],
|
|
3230
3219
|
"aliasPermutations": [],
|
|
3231
3220
|
"permutations": [
|
|
3232
|
-
"agent:test:
|
|
3233
|
-
"test:agent:
|
|
3234
|
-
"test:
|
|
3235
|
-
"agent:
|
|
3236
|
-
"
|
|
3237
|
-
"
|
|
3221
|
+
"agent:test:run",
|
|
3222
|
+
"test:agent:run",
|
|
3223
|
+
"test:run:agent",
|
|
3224
|
+
"agent:run:test",
|
|
3225
|
+
"run:agent:test",
|
|
3226
|
+
"run:test:agent"
|
|
3238
3227
|
]
|
|
3239
3228
|
},
|
|
3240
|
-
"agent:
|
|
3229
|
+
"agent:trace:delete": {
|
|
3241
3230
|
"aliases": [],
|
|
3242
3231
|
"args": {},
|
|
3243
|
-
"description": "
|
|
3232
|
+
"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).",
|
|
3244
3233
|
"examples": [
|
|
3245
|
-
"
|
|
3246
|
-
"
|
|
3247
|
-
"
|
|
3234
|
+
"Delete all traces for all agents and sessions; prompt for confirmation:\n<%= config.bin %> <%= command.id %>",
|
|
3235
|
+
"Delete all traces for a specific agent:\n<%= config.bin %> <%= command.id %> --agent My_Agent",
|
|
3236
|
+
"Delete traces from a specific session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
3237
|
+
"Delete traces older than 7 days:\n<%= config.bin %> <%= command.id %> --older-than 7d",
|
|
3238
|
+
"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",
|
|
3239
|
+
"Delete all traces for all agents and sessions; don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --no-prompt"
|
|
3248
3240
|
],
|
|
3249
3241
|
"flags": {
|
|
3250
3242
|
"json": {
|
|
@@ -3262,126 +3254,51 @@
|
|
|
3262
3254
|
"multiple": false,
|
|
3263
3255
|
"type": "option"
|
|
3264
3256
|
},
|
|
3265
|
-
"
|
|
3266
|
-
"char": "
|
|
3267
|
-
"name": "
|
|
3268
|
-
"
|
|
3269
|
-
"required": true,
|
|
3270
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3271
|
-
"hasDynamicHelp": true,
|
|
3272
|
-
"multiple": false,
|
|
3273
|
-
"type": "option"
|
|
3274
|
-
},
|
|
3275
|
-
"api-version": {
|
|
3276
|
-
"description": "Override the api version used for api requests made by this command",
|
|
3277
|
-
"name": "api-version",
|
|
3278
|
-
"hasDynamicHelp": false,
|
|
3279
|
-
"multiple": false,
|
|
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",
|
|
3257
|
+
"agent": {
|
|
3258
|
+
"char": "a",
|
|
3259
|
+
"name": "agent",
|
|
3260
|
+
"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.",
|
|
3310
3261
|
"hasDynamicHelp": false,
|
|
3311
3262
|
"multiple": false,
|
|
3312
|
-
"options": [
|
|
3313
|
-
"json",
|
|
3314
|
-
"human",
|
|
3315
|
-
"junit",
|
|
3316
|
-
"tap"
|
|
3317
|
-
],
|
|
3318
3263
|
"type": "option"
|
|
3319
3264
|
},
|
|
3320
|
-
"
|
|
3321
|
-
"
|
|
3322
|
-
"
|
|
3323
|
-
"name": "output-dir",
|
|
3324
|
-
"summary": "Directory to write the agent test results into.",
|
|
3265
|
+
"session-id": {
|
|
3266
|
+
"name": "session-id",
|
|
3267
|
+
"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.",
|
|
3325
3268
|
"hasDynamicHelp": false,
|
|
3326
3269
|
"multiple": false,
|
|
3327
3270
|
"type": "option"
|
|
3328
3271
|
},
|
|
3329
|
-
"
|
|
3330
|
-
"
|
|
3331
|
-
"
|
|
3332
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3272
|
+
"older-than": {
|
|
3273
|
+
"name": "older-than",
|
|
3274
|
+
"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.",
|
|
3333
3275
|
"hasDynamicHelp": false,
|
|
3334
3276
|
"multiple": false,
|
|
3335
|
-
"options": [
|
|
3336
|
-
"agentforce-studio",
|
|
3337
|
-
"testing-center"
|
|
3338
|
-
],
|
|
3339
3277
|
"type": "option"
|
|
3340
3278
|
},
|
|
3341
|
-
"
|
|
3342
|
-
"
|
|
3343
|
-
"
|
|
3344
|
-
"summary": "Show generated data in the test results output.",
|
|
3279
|
+
"no-prompt": {
|
|
3280
|
+
"name": "no-prompt",
|
|
3281
|
+
"summary": "Skip the confirmation prompt and delete immediately.",
|
|
3345
3282
|
"allowNo": false,
|
|
3346
3283
|
"type": "boolean"
|
|
3347
3284
|
}
|
|
3348
3285
|
},
|
|
3349
|
-
"hasDynamicHelp":
|
|
3286
|
+
"hasDynamicHelp": false,
|
|
3350
3287
|
"hiddenAliases": [],
|
|
3351
|
-
"id": "agent:
|
|
3288
|
+
"id": "agent:trace:delete",
|
|
3352
3289
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3353
3290
|
"pluginName": "@salesforce/plugin-agent",
|
|
3354
3291
|
"pluginType": "core",
|
|
3355
3292
|
"strict": true,
|
|
3356
|
-
"summary": "
|
|
3293
|
+
"summary": "Delete trace files from an agent preview session.",
|
|
3357
3294
|
"enableJsonFlag": true,
|
|
3358
|
-
"
|
|
3359
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
3360
|
-
"body": [
|
|
3361
|
-
{
|
|
3362
|
-
"name": "SF_TARGET_ORG",
|
|
3363
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3364
|
-
}
|
|
3365
|
-
]
|
|
3366
|
-
},
|
|
3295
|
+
"requiresProject": true,
|
|
3367
3296
|
"errorCodes": {
|
|
3368
3297
|
"header": "ERROR CODES",
|
|
3369
3298
|
"body": [
|
|
3370
3299
|
{
|
|
3371
3300
|
"name": "Succeeded (0)",
|
|
3372
|
-
"description": "
|
|
3373
|
-
},
|
|
3374
|
-
{
|
|
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."
|
|
3301
|
+
"description": "Traces deleted successfully (or no traces matched)."
|
|
3385
3302
|
}
|
|
3386
3303
|
]
|
|
3387
3304
|
},
|
|
@@ -3390,30 +3307,31 @@
|
|
|
3390
3307
|
"lib",
|
|
3391
3308
|
"commands",
|
|
3392
3309
|
"agent",
|
|
3393
|
-
"
|
|
3394
|
-
"
|
|
3310
|
+
"trace",
|
|
3311
|
+
"delete.js"
|
|
3395
3312
|
],
|
|
3396
3313
|
"aliasPermutations": [],
|
|
3397
3314
|
"permutations": [
|
|
3398
|
-
"agent:
|
|
3399
|
-
"
|
|
3400
|
-
"
|
|
3401
|
-
"agent:
|
|
3402
|
-
"
|
|
3403
|
-
"
|
|
3315
|
+
"agent:trace:delete",
|
|
3316
|
+
"trace:agent:delete",
|
|
3317
|
+
"trace:delete:agent",
|
|
3318
|
+
"agent:delete:trace",
|
|
3319
|
+
"delete:agent:trace",
|
|
3320
|
+
"delete:trace:agent"
|
|
3404
3321
|
]
|
|
3405
3322
|
},
|
|
3406
|
-
"agent:
|
|
3323
|
+
"agent:trace:list": {
|
|
3407
3324
|
"aliases": [],
|
|
3408
3325
|
"args": {},
|
|
3409
|
-
"description": "
|
|
3326
|
+
"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.",
|
|
3410
3327
|
"examples": [
|
|
3411
|
-
"
|
|
3412
|
-
"
|
|
3413
|
-
"
|
|
3414
|
-
"
|
|
3415
|
-
"
|
|
3416
|
-
"
|
|
3328
|
+
"List all trace files for all agents and sessions:\n<%= config.bin %> <%= command.id %>",
|
|
3329
|
+
"List all trace files for a specific agent:\n<%= config.bin %> <%= command.id %> --agent My_Agent",
|
|
3330
|
+
"List trace files for a specific session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
3331
|
+
"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",
|
|
3332
|
+
"List trace files recorded on or after a specific UTC time:\n<%= config.bin %> <%= command.id %> --since 2026-04-20T14:00:00Z",
|
|
3333
|
+
"Filter by agent and date together:\n<%= config.bin %> <%= command.id %> --agent My_Agent --since 2026-04-20",
|
|
3334
|
+
"Return results as JSON:\n<%= config.bin %> <%= command.id %> --json"
|
|
3417
3335
|
],
|
|
3418
3336
|
"flags": {
|
|
3419
3337
|
"json": {
|
|
@@ -3431,106 +3349,46 @@
|
|
|
3431
3349
|
"multiple": false,
|
|
3432
3350
|
"type": "option"
|
|
3433
3351
|
},
|
|
3434
|
-
"
|
|
3435
|
-
"
|
|
3436
|
-
"
|
|
3437
|
-
"noCacheDefault": true,
|
|
3438
|
-
"required": true,
|
|
3439
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3440
|
-
"hasDynamicHelp": true,
|
|
3441
|
-
"multiple": false,
|
|
3442
|
-
"type": "option"
|
|
3443
|
-
},
|
|
3444
|
-
"api-version": {
|
|
3445
|
-
"description": "Override the api version used for api requests made by this command",
|
|
3446
|
-
"name": "api-version",
|
|
3447
|
-
"hasDynamicHelp": false,
|
|
3448
|
-
"multiple": false,
|
|
3449
|
-
"type": "option"
|
|
3450
|
-
},
|
|
3451
|
-
"spec": {
|
|
3452
|
-
"char": "s",
|
|
3453
|
-
"name": "spec",
|
|
3454
|
-
"required": true,
|
|
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.",
|
|
3352
|
+
"session-id": {
|
|
3353
|
+
"name": "session-id",
|
|
3354
|
+
"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.",
|
|
3464
3355
|
"hasDynamicHelp": false,
|
|
3465
3356
|
"multiple": false,
|
|
3466
3357
|
"type": "option"
|
|
3467
3358
|
},
|
|
3468
|
-
"
|
|
3469
|
-
"
|
|
3470
|
-
"
|
|
3471
|
-
"
|
|
3359
|
+
"agent": {
|
|
3360
|
+
"char": "a",
|
|
3361
|
+
"name": "agent",
|
|
3362
|
+
"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.",
|
|
3472
3363
|
"hasDynamicHelp": false,
|
|
3473
3364
|
"multiple": false,
|
|
3474
|
-
"options": [
|
|
3475
|
-
"json",
|
|
3476
|
-
"human",
|
|
3477
|
-
"junit",
|
|
3478
|
-
"tap"
|
|
3479
|
-
],
|
|
3480
3365
|
"type": "option"
|
|
3481
3366
|
},
|
|
3482
|
-
"
|
|
3483
|
-
"
|
|
3484
|
-
"
|
|
3485
|
-
"
|
|
3367
|
+
"since": {
|
|
3368
|
+
"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.",
|
|
3369
|
+
"name": "since",
|
|
3370
|
+
"summary": "Date used to filter the list of trace files; only those recorded on or after the date are listed.",
|
|
3486
3371
|
"hasDynamicHelp": false,
|
|
3487
3372
|
"multiple": false,
|
|
3488
3373
|
"type": "option"
|
|
3489
|
-
},
|
|
3490
|
-
"no-normalize": {
|
|
3491
|
-
"name": "no-normalize",
|
|
3492
|
-
"summary": "Disable auto-normalization of field names and shorthand references.",
|
|
3493
|
-
"allowNo": false,
|
|
3494
|
-
"type": "boolean"
|
|
3495
3374
|
}
|
|
3496
3375
|
},
|
|
3497
|
-
"hasDynamicHelp":
|
|
3376
|
+
"hasDynamicHelp": false,
|
|
3498
3377
|
"hiddenAliases": [],
|
|
3499
|
-
"id": "agent:
|
|
3378
|
+
"id": "agent:trace:list",
|
|
3500
3379
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3501
3380
|
"pluginName": "@salesforce/plugin-agent",
|
|
3502
3381
|
"pluginType": "core",
|
|
3503
|
-
"state": "beta",
|
|
3504
3382
|
"strict": true,
|
|
3505
|
-
"summary": "
|
|
3383
|
+
"summary": "List the available trace files that were recorded during all agent preview sessions.",
|
|
3506
3384
|
"enableJsonFlag": true,
|
|
3507
|
-
"
|
|
3508
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
3509
|
-
"body": [
|
|
3510
|
-
{
|
|
3511
|
-
"name": "SF_TARGET_ORG",
|
|
3512
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3513
|
-
}
|
|
3514
|
-
]
|
|
3515
|
-
},
|
|
3385
|
+
"requiresProject": true,
|
|
3516
3386
|
"errorCodes": {
|
|
3517
3387
|
"header": "ERROR CODES",
|
|
3518
3388
|
"body": [
|
|
3519
3389
|
{
|
|
3520
3390
|
"name": "Succeeded (0)",
|
|
3521
|
-
"description": "
|
|
3522
|
-
},
|
|
3523
|
-
{
|
|
3524
|
-
"name": "Failed (1)",
|
|
3525
|
-
"description": "Tests encountered execution errors (tests couldn't run properly)."
|
|
3526
|
-
},
|
|
3527
|
-
{
|
|
3528
|
-
"name": "NotFound (2)",
|
|
3529
|
-
"description": "Agent not found, spec file not found, or invalid agent name."
|
|
3530
|
-
},
|
|
3531
|
-
{
|
|
3532
|
-
"name": "OperationFailed (4)",
|
|
3533
|
-
"description": "Failed to execute tests due to API or network errors."
|
|
3391
|
+
"description": "Trace files listed successfully (or empty list if none found)."
|
|
3534
3392
|
}
|
|
3535
3393
|
]
|
|
3536
3394
|
},
|
|
@@ -3539,27 +3397,132 @@
|
|
|
3539
3397
|
"lib",
|
|
3540
3398
|
"commands",
|
|
3541
3399
|
"agent",
|
|
3542
|
-
"
|
|
3543
|
-
"
|
|
3400
|
+
"trace",
|
|
3401
|
+
"list.js"
|
|
3544
3402
|
],
|
|
3545
3403
|
"aliasPermutations": [],
|
|
3546
3404
|
"permutations": [
|
|
3547
|
-
"agent:
|
|
3548
|
-
"
|
|
3549
|
-
"
|
|
3550
|
-
"agent:
|
|
3551
|
-
"
|
|
3552
|
-
"
|
|
3405
|
+
"agent:trace:list",
|
|
3406
|
+
"trace:agent:list",
|
|
3407
|
+
"trace:list:agent",
|
|
3408
|
+
"agent:list:trace",
|
|
3409
|
+
"list:agent:trace",
|
|
3410
|
+
"list:trace:agent"
|
|
3553
3411
|
]
|
|
3554
3412
|
},
|
|
3555
|
-
"agent:
|
|
3413
|
+
"agent:trace:read": {
|
|
3556
3414
|
"aliases": [],
|
|
3557
3415
|
"args": {},
|
|
3558
|
-
"description": "
|
|
3416
|
+
"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.",
|
|
3559
3417
|
"examples": [
|
|
3560
|
-
"
|
|
3561
|
-
"
|
|
3562
|
-
"
|
|
3418
|
+
"Show a session trace summary for all turns in the session with the specified ID:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
3419
|
+
"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",
|
|
3420
|
+
"Drill into action execution across all turns:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension actions",
|
|
3421
|
+
"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",
|
|
3422
|
+
"Show all errors across the session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension errors",
|
|
3423
|
+
"Output raw trace JSON for custom parsing:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format raw",
|
|
3424
|
+
"Return results as JSON:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --json"
|
|
3425
|
+
],
|
|
3426
|
+
"flags": {
|
|
3427
|
+
"json": {
|
|
3428
|
+
"description": "Format output as json.",
|
|
3429
|
+
"helpGroup": "GLOBAL",
|
|
3430
|
+
"name": "json",
|
|
3431
|
+
"allowNo": false,
|
|
3432
|
+
"type": "boolean"
|
|
3433
|
+
},
|
|
3434
|
+
"flags-dir": {
|
|
3435
|
+
"helpGroup": "GLOBAL",
|
|
3436
|
+
"name": "flags-dir",
|
|
3437
|
+
"summary": "Import flag values from a directory.",
|
|
3438
|
+
"hasDynamicHelp": false,
|
|
3439
|
+
"multiple": false,
|
|
3440
|
+
"type": "option"
|
|
3441
|
+
},
|
|
3442
|
+
"session-id": {
|
|
3443
|
+
"char": "s",
|
|
3444
|
+
"name": "session-id",
|
|
3445
|
+
"required": true,
|
|
3446
|
+
"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",
|
|
3447
|
+
"hasDynamicHelp": false,
|
|
3448
|
+
"multiple": false,
|
|
3449
|
+
"type": "option"
|
|
3450
|
+
},
|
|
3451
|
+
"format": {
|
|
3452
|
+
"char": "f",
|
|
3453
|
+
"name": "format",
|
|
3454
|
+
"summary": "Output format of the trace data; specifies the level of detail you want in the trace files.",
|
|
3455
|
+
"default": "summary",
|
|
3456
|
+
"hasDynamicHelp": false,
|
|
3457
|
+
"multiple": false,
|
|
3458
|
+
"options": [
|
|
3459
|
+
"summary",
|
|
3460
|
+
"detail",
|
|
3461
|
+
"raw"
|
|
3462
|
+
],
|
|
3463
|
+
"type": "option"
|
|
3464
|
+
},
|
|
3465
|
+
"dimension": {
|
|
3466
|
+
"char": "d",
|
|
3467
|
+
"name": "dimension",
|
|
3468
|
+
"summary": "Dimension to drill into when using \"--format detail\"; used to filter and organize the trace data to answer a specific type of question.",
|
|
3469
|
+
"hasDynamicHelp": false,
|
|
3470
|
+
"multiple": false,
|
|
3471
|
+
"options": [
|
|
3472
|
+
"actions",
|
|
3473
|
+
"grounding",
|
|
3474
|
+
"routing",
|
|
3475
|
+
"errors"
|
|
3476
|
+
],
|
|
3477
|
+
"type": "option"
|
|
3478
|
+
},
|
|
3479
|
+
"turn": {
|
|
3480
|
+
"char": "t",
|
|
3481
|
+
"name": "turn",
|
|
3482
|
+
"summary": "Turn number for which you want trace data. A turn is a single utterance or response in a conversation, starting with 1.",
|
|
3483
|
+
"hasDynamicHelp": false,
|
|
3484
|
+
"multiple": false,
|
|
3485
|
+
"type": "option"
|
|
3486
|
+
}
|
|
3487
|
+
},
|
|
3488
|
+
"hasDynamicHelp": false,
|
|
3489
|
+
"hiddenAliases": [],
|
|
3490
|
+
"id": "agent:trace:read",
|
|
3491
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
3492
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
3493
|
+
"pluginType": "core",
|
|
3494
|
+
"strict": true,
|
|
3495
|
+
"summary": "Read trace files from an agent preview session.",
|
|
3496
|
+
"enableJsonFlag": true,
|
|
3497
|
+
"requiresProject": true,
|
|
3498
|
+
"isESM": true,
|
|
3499
|
+
"relativePath": [
|
|
3500
|
+
"lib",
|
|
3501
|
+
"commands",
|
|
3502
|
+
"agent",
|
|
3503
|
+
"trace",
|
|
3504
|
+
"read.js"
|
|
3505
|
+
],
|
|
3506
|
+
"aliasPermutations": [],
|
|
3507
|
+
"permutations": [
|
|
3508
|
+
"agent:trace:read",
|
|
3509
|
+
"trace:agent:read",
|
|
3510
|
+
"trace:read:agent",
|
|
3511
|
+
"agent:read:trace",
|
|
3512
|
+
"read:agent:trace",
|
|
3513
|
+
"read:trace:agent"
|
|
3514
|
+
]
|
|
3515
|
+
},
|
|
3516
|
+
"agent:generate:agent-spec": {
|
|
3517
|
+
"aliases": [],
|
|
3518
|
+
"args": {},
|
|
3519
|
+
"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.)",
|
|
3520
|
+
"examples": [
|
|
3521
|
+
"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.\"",
|
|
3522
|
+
"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",
|
|
3523
|
+
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
3524
|
+
"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\"",
|
|
3525
|
+
"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"
|
|
3563
3526
|
],
|
|
3564
3527
|
"flags": {
|
|
3565
3528
|
"json": {
|
|
@@ -3594,133 +3557,164 @@
|
|
|
3594
3557
|
"multiple": false,
|
|
3595
3558
|
"type": "option"
|
|
3596
3559
|
},
|
|
3597
|
-
"
|
|
3598
|
-
"
|
|
3599
|
-
"
|
|
3600
|
-
"summary": "API name of the agent test to run; corresponds to the name of the AiEvaluationDefinition metadata component that implements the agent test.",
|
|
3560
|
+
"type": {
|
|
3561
|
+
"name": "type",
|
|
3562
|
+
"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.",
|
|
3601
3563
|
"hasDynamicHelp": false,
|
|
3602
3564
|
"multiple": false,
|
|
3565
|
+
"options": [
|
|
3566
|
+
"customer",
|
|
3567
|
+
"internal"
|
|
3568
|
+
],
|
|
3603
3569
|
"type": "option"
|
|
3604
3570
|
},
|
|
3605
|
-
"
|
|
3606
|
-
"
|
|
3607
|
-
"
|
|
3608
|
-
"
|
|
3609
|
-
"hasDynamicHelp": true,
|
|
3571
|
+
"role": {
|
|
3572
|
+
"name": "role",
|
|
3573
|
+
"summary": "Role of the agent.",
|
|
3574
|
+
"hasDynamicHelp": false,
|
|
3610
3575
|
"multiple": false,
|
|
3611
3576
|
"type": "option"
|
|
3612
3577
|
},
|
|
3613
|
-
"
|
|
3614
|
-
"name": "
|
|
3615
|
-
"summary": "
|
|
3616
|
-
"
|
|
3578
|
+
"company-name": {
|
|
3579
|
+
"name": "company-name",
|
|
3580
|
+
"summary": "Name of your company.",
|
|
3581
|
+
"hasDynamicHelp": false,
|
|
3582
|
+
"multiple": false,
|
|
3583
|
+
"type": "option"
|
|
3584
|
+
},
|
|
3585
|
+
"company-description": {
|
|
3586
|
+
"name": "company-description",
|
|
3587
|
+
"summary": "Description of your company.",
|
|
3588
|
+
"hasDynamicHelp": false,
|
|
3589
|
+
"multiple": false,
|
|
3590
|
+
"type": "option"
|
|
3591
|
+
},
|
|
3592
|
+
"company-website": {
|
|
3593
|
+
"name": "company-website",
|
|
3594
|
+
"summary": "Website URL of your company.",
|
|
3595
|
+
"hasDynamicHelp": false,
|
|
3596
|
+
"multiple": false,
|
|
3597
|
+
"type": "option"
|
|
3598
|
+
},
|
|
3599
|
+
"max-topics": {
|
|
3600
|
+
"name": "max-topics",
|
|
3601
|
+
"summary": "Maximum number of topics to generate in the agent spec; default is 5.",
|
|
3602
|
+
"hasDynamicHelp": false,
|
|
3603
|
+
"multiple": false,
|
|
3604
|
+
"type": "option"
|
|
3605
|
+
},
|
|
3606
|
+
"agent-user": {
|
|
3607
|
+
"name": "agent-user",
|
|
3608
|
+
"summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
|
|
3609
|
+
"hasDynamicHelp": false,
|
|
3610
|
+
"multiple": false,
|
|
3611
|
+
"type": "option"
|
|
3612
|
+
},
|
|
3613
|
+
"enrich-logs": {
|
|
3614
|
+
"name": "enrich-logs",
|
|
3615
|
+
"summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
|
|
3617
3616
|
"hasDynamicHelp": false,
|
|
3618
3617
|
"multiple": false,
|
|
3619
3618
|
"options": [
|
|
3620
|
-
"
|
|
3621
|
-
"
|
|
3622
|
-
"junit",
|
|
3623
|
-
"tap"
|
|
3619
|
+
"true",
|
|
3620
|
+
"false"
|
|
3624
3621
|
],
|
|
3625
3622
|
"type": "option"
|
|
3626
3623
|
},
|
|
3627
|
-
"
|
|
3628
|
-
"
|
|
3629
|
-
"
|
|
3630
|
-
"name": "output-dir",
|
|
3631
|
-
"summary": "Directory to write the agent test results into.",
|
|
3624
|
+
"tone": {
|
|
3625
|
+
"name": "tone",
|
|
3626
|
+
"summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
|
|
3632
3627
|
"hasDynamicHelp": false,
|
|
3633
3628
|
"multiple": false,
|
|
3629
|
+
"options": [
|
|
3630
|
+
"formal",
|
|
3631
|
+
"casual",
|
|
3632
|
+
"neutral"
|
|
3633
|
+
],
|
|
3634
3634
|
"type": "option"
|
|
3635
3635
|
},
|
|
3636
|
-
"
|
|
3637
|
-
"
|
|
3638
|
-
"
|
|
3639
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3636
|
+
"spec": {
|
|
3637
|
+
"name": "spec",
|
|
3638
|
+
"summary": "Agent spec file, in YAML format, to use as input to the command.",
|
|
3640
3639
|
"hasDynamicHelp": false,
|
|
3641
3640
|
"multiple": false,
|
|
3642
|
-
"
|
|
3643
|
-
|
|
3644
|
-
|
|
3641
|
+
"type": "option"
|
|
3642
|
+
},
|
|
3643
|
+
"output-file": {
|
|
3644
|
+
"name": "output-file",
|
|
3645
|
+
"summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
|
|
3646
|
+
"default": "specs/agentSpec.yaml",
|
|
3647
|
+
"hasDynamicHelp": false,
|
|
3648
|
+
"multiple": false,
|
|
3649
|
+
"type": "option"
|
|
3650
|
+
},
|
|
3651
|
+
"full-interview": {
|
|
3652
|
+
"name": "full-interview",
|
|
3653
|
+
"summary": "Prompt for both required and optional flags.",
|
|
3654
|
+
"allowNo": false,
|
|
3655
|
+
"type": "boolean"
|
|
3656
|
+
},
|
|
3657
|
+
"prompt-template": {
|
|
3658
|
+
"name": "prompt-template",
|
|
3659
|
+
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
3660
|
+
"hasDynamicHelp": false,
|
|
3661
|
+
"multiple": false,
|
|
3662
|
+
"type": "option"
|
|
3663
|
+
},
|
|
3664
|
+
"grounding-context": {
|
|
3665
|
+
"dependsOn": [
|
|
3666
|
+
"prompt-template"
|
|
3645
3667
|
],
|
|
3668
|
+
"name": "grounding-context",
|
|
3669
|
+
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
3670
|
+
"hasDynamicHelp": false,
|
|
3671
|
+
"multiple": false,
|
|
3646
3672
|
"type": "option"
|
|
3647
3673
|
},
|
|
3648
|
-
"
|
|
3649
|
-
"
|
|
3650
|
-
"
|
|
3651
|
-
"summary": "Show generated data in the test results output.",
|
|
3674
|
+
"force-overwrite": {
|
|
3675
|
+
"name": "force-overwrite",
|
|
3676
|
+
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
3652
3677
|
"allowNo": false,
|
|
3653
3678
|
"type": "boolean"
|
|
3654
3679
|
}
|
|
3655
3680
|
},
|
|
3656
3681
|
"hasDynamicHelp": true,
|
|
3657
3682
|
"hiddenAliases": [],
|
|
3658
|
-
"id": "agent:
|
|
3683
|
+
"id": "agent:generate:agent-spec",
|
|
3659
3684
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3660
3685
|
"pluginName": "@salesforce/plugin-agent",
|
|
3661
3686
|
"pluginType": "core",
|
|
3662
3687
|
"strict": true,
|
|
3663
|
-
"summary": "
|
|
3688
|
+
"summary": "Generate an agent spec, which is a YAML file that captures what an agent can do.",
|
|
3664
3689
|
"enableJsonFlag": true,
|
|
3665
|
-
"
|
|
3666
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
3667
|
-
"body": [
|
|
3668
|
-
{
|
|
3669
|
-
"name": "SF_TARGET_ORG",
|
|
3670
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3671
|
-
}
|
|
3672
|
-
]
|
|
3673
|
-
},
|
|
3674
|
-
"errorCodes": {
|
|
3675
|
-
"header": "ERROR CODES",
|
|
3676
|
-
"body": [
|
|
3677
|
-
{
|
|
3678
|
-
"name": "Succeeded (0)",
|
|
3679
|
-
"description": "Test started successfully (without --wait), or test completed successfully (with --wait)."
|
|
3680
|
-
},
|
|
3681
|
-
{
|
|
3682
|
-
"name": "Failed (1)",
|
|
3683
|
-
"description": "Tests encountered execution errors (test cases with ERROR status when using --wait)."
|
|
3684
|
-
},
|
|
3685
|
-
{
|
|
3686
|
-
"name": "NotFound (2)",
|
|
3687
|
-
"description": "Test definition not found or invalid test name."
|
|
3688
|
-
},
|
|
3689
|
-
{
|
|
3690
|
-
"name": "OperationFailed (4)",
|
|
3691
|
-
"description": "Failed to start or poll test due to API or network errors."
|
|
3692
|
-
}
|
|
3693
|
-
]
|
|
3694
|
-
},
|
|
3690
|
+
"requiresProject": true,
|
|
3695
3691
|
"isESM": true,
|
|
3696
3692
|
"relativePath": [
|
|
3697
3693
|
"lib",
|
|
3698
3694
|
"commands",
|
|
3699
3695
|
"agent",
|
|
3700
|
-
"
|
|
3701
|
-
"
|
|
3696
|
+
"generate",
|
|
3697
|
+
"agent-spec.js"
|
|
3702
3698
|
],
|
|
3703
3699
|
"aliasPermutations": [],
|
|
3704
3700
|
"permutations": [
|
|
3705
|
-
"agent:
|
|
3706
|
-
"
|
|
3707
|
-
"
|
|
3708
|
-
"agent:
|
|
3709
|
-
"
|
|
3710
|
-
"
|
|
3701
|
+
"agent:generate:agent-spec",
|
|
3702
|
+
"generate:agent:agent-spec",
|
|
3703
|
+
"generate:agent-spec:agent",
|
|
3704
|
+
"agent:agent-spec:generate",
|
|
3705
|
+
"agent-spec:agent:generate",
|
|
3706
|
+
"agent-spec:generate:agent"
|
|
3711
3707
|
]
|
|
3712
3708
|
},
|
|
3713
|
-
"agent:
|
|
3709
|
+
"agent:generate:authoring-bundle": {
|
|
3714
3710
|
"aliases": [],
|
|
3715
3711
|
"args": {},
|
|
3716
|
-
"description": "
|
|
3712
|
+
"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.",
|
|
3717
3713
|
"examples": [
|
|
3718
|
-
"
|
|
3719
|
-
"
|
|
3720
|
-
"
|
|
3721
|
-
"
|
|
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"
|
|
3714
|
+
"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 %>",
|
|
3715
|
+
"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\"",
|
|
3716
|
+
"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\"",
|
|
3717
|
+
"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"
|
|
3724
3718
|
],
|
|
3725
3719
|
"flags": {
|
|
3726
3720
|
"json": {
|
|
@@ -3730,92 +3724,109 @@
|
|
|
3730
3724
|
"allowNo": false,
|
|
3731
3725
|
"type": "boolean"
|
|
3732
3726
|
},
|
|
3733
|
-
"flags-dir": {
|
|
3734
|
-
"helpGroup": "GLOBAL",
|
|
3735
|
-
"name": "flags-dir",
|
|
3736
|
-
"summary": "Import flag values from a directory.",
|
|
3727
|
+
"flags-dir": {
|
|
3728
|
+
"helpGroup": "GLOBAL",
|
|
3729
|
+
"name": "flags-dir",
|
|
3730
|
+
"summary": "Import flag values from a directory.",
|
|
3731
|
+
"hasDynamicHelp": false,
|
|
3732
|
+
"multiple": false,
|
|
3733
|
+
"type": "option"
|
|
3734
|
+
},
|
|
3735
|
+
"target-org": {
|
|
3736
|
+
"char": "o",
|
|
3737
|
+
"name": "target-org",
|
|
3738
|
+
"noCacheDefault": true,
|
|
3739
|
+
"required": true,
|
|
3740
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3741
|
+
"hasDynamicHelp": true,
|
|
3742
|
+
"multiple": false,
|
|
3743
|
+
"type": "option"
|
|
3744
|
+
},
|
|
3745
|
+
"api-name": {
|
|
3746
|
+
"name": "api-name",
|
|
3747
|
+
"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.",
|
|
3748
|
+
"hasDynamicHelp": false,
|
|
3749
|
+
"multiple": false,
|
|
3750
|
+
"type": "option"
|
|
3751
|
+
},
|
|
3752
|
+
"api-version": {
|
|
3753
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3754
|
+
"name": "api-version",
|
|
3737
3755
|
"hasDynamicHelp": false,
|
|
3738
3756
|
"multiple": false,
|
|
3739
3757
|
"type": "option"
|
|
3740
3758
|
},
|
|
3741
|
-
"
|
|
3742
|
-
"char": "
|
|
3743
|
-
"name": "
|
|
3744
|
-
"summary": "
|
|
3759
|
+
"spec": {
|
|
3760
|
+
"char": "f",
|
|
3761
|
+
"name": "spec",
|
|
3762
|
+
"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.",
|
|
3745
3763
|
"hasDynamicHelp": false,
|
|
3746
3764
|
"multiple": false,
|
|
3747
3765
|
"type": "option"
|
|
3748
3766
|
},
|
|
3749
|
-
"
|
|
3750
|
-
"name": "
|
|
3751
|
-
"summary": "
|
|
3767
|
+
"no-spec": {
|
|
3768
|
+
"name": "no-spec",
|
|
3769
|
+
"summary": "Skip prompting for an agent spec and use the default Agent Script boilerplate in the generated authoring bundle.",
|
|
3770
|
+
"allowNo": false,
|
|
3771
|
+
"type": "boolean"
|
|
3772
|
+
},
|
|
3773
|
+
"output-dir": {
|
|
3774
|
+
"char": "d",
|
|
3775
|
+
"name": "output-dir",
|
|
3776
|
+
"summary": "Directory where the authoring bundle files are generated.",
|
|
3752
3777
|
"hasDynamicHelp": false,
|
|
3753
3778
|
"multiple": false,
|
|
3754
3779
|
"type": "option"
|
|
3755
3780
|
},
|
|
3756
|
-
"
|
|
3757
|
-
"
|
|
3758
|
-
"
|
|
3781
|
+
"name": {
|
|
3782
|
+
"char": "n",
|
|
3783
|
+
"name": "name",
|
|
3784
|
+
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
3759
3785
|
"hasDynamicHelp": false,
|
|
3760
3786
|
"multiple": false,
|
|
3761
3787
|
"type": "option"
|
|
3762
3788
|
},
|
|
3763
|
-
"
|
|
3764
|
-
"name": "
|
|
3765
|
-
"summary": "
|
|
3789
|
+
"force-overwrite": {
|
|
3790
|
+
"name": "force-overwrite",
|
|
3791
|
+
"summary": "Overwrite the existing authoring bundle if one with the same API name already exists locally.",
|
|
3766
3792
|
"allowNo": false,
|
|
3767
3793
|
"type": "boolean"
|
|
3768
3794
|
}
|
|
3769
3795
|
},
|
|
3770
|
-
"hasDynamicHelp":
|
|
3796
|
+
"hasDynamicHelp": true,
|
|
3771
3797
|
"hiddenAliases": [],
|
|
3772
|
-
"id": "agent:
|
|
3798
|
+
"id": "agent:generate:authoring-bundle",
|
|
3773
3799
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3774
3800
|
"pluginName": "@salesforce/plugin-agent",
|
|
3775
3801
|
"pluginType": "core",
|
|
3776
3802
|
"strict": true,
|
|
3777
|
-
"summary": "
|
|
3803
|
+
"summary": "Generate an authoring bundle from an existing agent spec YAML file.",
|
|
3778
3804
|
"enableJsonFlag": true,
|
|
3779
3805
|
"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
3806
|
"isESM": true,
|
|
3790
3807
|
"relativePath": [
|
|
3791
3808
|
"lib",
|
|
3792
3809
|
"commands",
|
|
3793
3810
|
"agent",
|
|
3794
|
-
"
|
|
3795
|
-
"
|
|
3811
|
+
"generate",
|
|
3812
|
+
"authoring-bundle.js"
|
|
3796
3813
|
],
|
|
3797
3814
|
"aliasPermutations": [],
|
|
3798
3815
|
"permutations": [
|
|
3799
|
-
"agent:
|
|
3800
|
-
"
|
|
3801
|
-
"
|
|
3802
|
-
"agent:
|
|
3803
|
-
"
|
|
3804
|
-
"
|
|
3816
|
+
"agent:generate:authoring-bundle",
|
|
3817
|
+
"generate:agent:authoring-bundle",
|
|
3818
|
+
"generate:authoring-bundle:agent",
|
|
3819
|
+
"agent:authoring-bundle:generate",
|
|
3820
|
+
"authoring-bundle:agent:generate",
|
|
3821
|
+
"authoring-bundle:generate:agent"
|
|
3805
3822
|
]
|
|
3806
3823
|
},
|
|
3807
|
-
"agent:
|
|
3824
|
+
"agent:generate:template": {
|
|
3808
3825
|
"aliases": [],
|
|
3809
3826
|
"args": {},
|
|
3810
|
-
"description": "
|
|
3827
|
+
"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.",
|
|
3811
3828
|
"examples": [
|
|
3812
|
-
"
|
|
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"
|
|
3829
|
+
"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"
|
|
3819
3830
|
],
|
|
3820
3831
|
"flags": {
|
|
3821
3832
|
"json": {
|
|
@@ -3833,88 +3844,89 @@
|
|
|
3833
3844
|
"multiple": false,
|
|
3834
3845
|
"type": "option"
|
|
3835
3846
|
},
|
|
3836
|
-
"
|
|
3837
|
-
"
|
|
3838
|
-
"
|
|
3847
|
+
"api-version": {
|
|
3848
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3849
|
+
"name": "api-version",
|
|
3839
3850
|
"hasDynamicHelp": false,
|
|
3840
3851
|
"multiple": false,
|
|
3841
3852
|
"type": "option"
|
|
3842
3853
|
},
|
|
3843
|
-
"
|
|
3844
|
-
"char": "
|
|
3845
|
-
"name": "
|
|
3846
|
-
"
|
|
3854
|
+
"source-org": {
|
|
3855
|
+
"char": "s",
|
|
3856
|
+
"name": "source-org",
|
|
3857
|
+
"noCacheDefault": true,
|
|
3858
|
+
"required": true,
|
|
3859
|
+
"summary": "Username or alias of the namespaced scratch org that contains the agent which this template is based on.",
|
|
3860
|
+
"hasDynamicHelp": true,
|
|
3861
|
+
"multiple": false,
|
|
3862
|
+
"type": "option"
|
|
3863
|
+
},
|
|
3864
|
+
"agent-version": {
|
|
3865
|
+
"name": "agent-version",
|
|
3866
|
+
"required": true,
|
|
3867
|
+
"summary": "Version of the agent (BotVersion).",
|
|
3847
3868
|
"hasDynamicHelp": false,
|
|
3848
3869
|
"multiple": false,
|
|
3849
3870
|
"type": "option"
|
|
3850
3871
|
},
|
|
3851
|
-
"
|
|
3852
|
-
"
|
|
3853
|
-
"name": "
|
|
3854
|
-
"
|
|
3872
|
+
"agent-file": {
|
|
3873
|
+
"char": "f",
|
|
3874
|
+
"name": "agent-file",
|
|
3875
|
+
"required": true,
|
|
3876
|
+
"summary": "Path to an agent (Bot) metadata file.",
|
|
3877
|
+
"hasDynamicHelp": false,
|
|
3878
|
+
"multiple": false,
|
|
3879
|
+
"type": "option"
|
|
3880
|
+
},
|
|
3881
|
+
"output-dir": {
|
|
3882
|
+
"char": "r",
|
|
3883
|
+
"name": "output-dir",
|
|
3884
|
+
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
3855
3885
|
"hasDynamicHelp": false,
|
|
3856
3886
|
"multiple": false,
|
|
3857
3887
|
"type": "option"
|
|
3858
3888
|
}
|
|
3859
3889
|
},
|
|
3860
|
-
"hasDynamicHelp":
|
|
3890
|
+
"hasDynamicHelp": true,
|
|
3861
3891
|
"hiddenAliases": [],
|
|
3862
|
-
"id": "agent:
|
|
3892
|
+
"id": "agent:generate:template",
|
|
3863
3893
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3864
3894
|
"pluginName": "@salesforce/plugin-agent",
|
|
3865
3895
|
"pluginType": "core",
|
|
3866
3896
|
"strict": true,
|
|
3867
|
-
"summary": "
|
|
3897
|
+
"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.",
|
|
3868
3898
|
"enableJsonFlag": true,
|
|
3869
3899
|
"requiresProject": true,
|
|
3870
|
-
"errorCodes": {
|
|
3871
|
-
"header": "ERROR CODES",
|
|
3872
|
-
"body": [
|
|
3873
|
-
{
|
|
3874
|
-
"name": "Succeeded (0)",
|
|
3875
|
-
"description": "Trace files listed successfully (or empty list if none found)."
|
|
3876
|
-
}
|
|
3877
|
-
]
|
|
3878
|
-
},
|
|
3879
3900
|
"isESM": true,
|
|
3880
3901
|
"relativePath": [
|
|
3881
3902
|
"lib",
|
|
3882
3903
|
"commands",
|
|
3883
3904
|
"agent",
|
|
3884
|
-
"
|
|
3885
|
-
"
|
|
3905
|
+
"generate",
|
|
3906
|
+
"template.js"
|
|
3886
3907
|
],
|
|
3887
3908
|
"aliasPermutations": [],
|
|
3888
3909
|
"permutations": [
|
|
3889
|
-
"agent:
|
|
3890
|
-
"
|
|
3891
|
-
"
|
|
3892
|
-
"agent:
|
|
3893
|
-
"
|
|
3894
|
-
"
|
|
3910
|
+
"agent:generate:template",
|
|
3911
|
+
"generate:agent:template",
|
|
3912
|
+
"generate:template:agent",
|
|
3913
|
+
"agent:template:generate",
|
|
3914
|
+
"template:agent:generate",
|
|
3915
|
+
"template:generate:agent"
|
|
3895
3916
|
]
|
|
3896
3917
|
},
|
|
3897
|
-
"agent:
|
|
3918
|
+
"agent:generate:test-spec": {
|
|
3898
3919
|
"aliases": [],
|
|
3899
3920
|
"args": {},
|
|
3900
|
-
"description": "
|
|
3921
|
+
"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.",
|
|
3901
3922
|
"examples": [
|
|
3902
|
-
"
|
|
3903
|
-
"
|
|
3904
|
-
"
|
|
3905
|
-
"
|
|
3906
|
-
"
|
|
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"
|
|
3923
|
+
"Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
|
|
3924
|
+
"Generate an Agentforce Studio (NGT) test spec YAML file interactively:\n<%= config.bin %> <%= command.id %> --test-runner agentforce-studio",
|
|
3925
|
+
"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",
|
|
3926
|
+
"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",
|
|
3927
|
+
"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"
|
|
3909
3928
|
],
|
|
3910
3929
|
"flags": {
|
|
3911
|
-
"json": {
|
|
3912
|
-
"description": "Format output as json.",
|
|
3913
|
-
"helpGroup": "GLOBAL",
|
|
3914
|
-
"name": "json",
|
|
3915
|
-
"allowNo": false,
|
|
3916
|
-
"type": "boolean"
|
|
3917
|
-
},
|
|
3918
3930
|
"flags-dir": {
|
|
3919
3931
|
"helpGroup": "GLOBAL",
|
|
3920
3932
|
"name": "flags-dir",
|
|
@@ -3923,78 +3935,66 @@
|
|
|
3923
3935
|
"multiple": false,
|
|
3924
3936
|
"type": "option"
|
|
3925
3937
|
},
|
|
3926
|
-
"
|
|
3927
|
-
"char": "
|
|
3928
|
-
"name": "
|
|
3929
|
-
"
|
|
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",
|
|
3938
|
+
"from-definition": {
|
|
3939
|
+
"char": "d",
|
|
3940
|
+
"name": "from-definition",
|
|
3941
|
+
"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.",
|
|
3931
3942
|
"hasDynamicHelp": false,
|
|
3932
3943
|
"multiple": false,
|
|
3933
3944
|
"type": "option"
|
|
3934
3945
|
},
|
|
3935
|
-
"
|
|
3946
|
+
"force-overwrite": {
|
|
3947
|
+
"name": "force-overwrite",
|
|
3948
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test spec YAML file.",
|
|
3949
|
+
"allowNo": false,
|
|
3950
|
+
"type": "boolean"
|
|
3951
|
+
},
|
|
3952
|
+
"output-file": {
|
|
3936
3953
|
"char": "f",
|
|
3937
|
-
"name": "
|
|
3938
|
-
"summary": "
|
|
3939
|
-
"default": "summary",
|
|
3954
|
+
"name": "output-file",
|
|
3955
|
+
"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).",
|
|
3940
3956
|
"hasDynamicHelp": false,
|
|
3941
3957
|
"multiple": false,
|
|
3942
|
-
"options": [
|
|
3943
|
-
"summary",
|
|
3944
|
-
"detail",
|
|
3945
|
-
"raw"
|
|
3946
|
-
],
|
|
3947
3958
|
"type": "option"
|
|
3948
3959
|
},
|
|
3949
|
-
"
|
|
3950
|
-
"
|
|
3951
|
-
"name": "
|
|
3952
|
-
"summary": "
|
|
3960
|
+
"test-runner": {
|
|
3961
|
+
"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.",
|
|
3962
|
+
"name": "test-runner",
|
|
3963
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3953
3964
|
"hasDynamicHelp": false,
|
|
3954
3965
|
"multiple": false,
|
|
3955
3966
|
"options": [
|
|
3956
|
-
"
|
|
3957
|
-
"
|
|
3958
|
-
"routing",
|
|
3959
|
-
"errors"
|
|
3967
|
+
"agentforce-studio",
|
|
3968
|
+
"testing-center"
|
|
3960
3969
|
],
|
|
3961
3970
|
"type": "option"
|
|
3962
|
-
},
|
|
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.",
|
|
3967
|
-
"hasDynamicHelp": false,
|
|
3968
|
-
"multiple": false,
|
|
3969
|
-
"type": "option"
|
|
3970
3971
|
}
|
|
3971
3972
|
},
|
|
3972
3973
|
"hasDynamicHelp": false,
|
|
3973
3974
|
"hiddenAliases": [],
|
|
3974
|
-
"id": "agent:
|
|
3975
|
+
"id": "agent:generate:test-spec",
|
|
3975
3976
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3976
3977
|
"pluginName": "@salesforce/plugin-agent",
|
|
3977
3978
|
"pluginType": "core",
|
|
3978
3979
|
"strict": true,
|
|
3979
|
-
"summary": "
|
|
3980
|
-
"enableJsonFlag":
|
|
3981
|
-
"requiresProject": true,
|
|
3980
|
+
"summary": "Generate an agent test spec, which is a YAML file that lists the test cases for testing a specific agent.",
|
|
3981
|
+
"enableJsonFlag": false,
|
|
3982
3982
|
"isESM": true,
|
|
3983
3983
|
"relativePath": [
|
|
3984
3984
|
"lib",
|
|
3985
3985
|
"commands",
|
|
3986
3986
|
"agent",
|
|
3987
|
-
"
|
|
3988
|
-
"
|
|
3987
|
+
"generate",
|
|
3988
|
+
"test-spec.js"
|
|
3989
3989
|
],
|
|
3990
3990
|
"aliasPermutations": [],
|
|
3991
3991
|
"permutations": [
|
|
3992
|
-
"agent:
|
|
3993
|
-
"
|
|
3994
|
-
"
|
|
3995
|
-
"agent:
|
|
3996
|
-
"
|
|
3997
|
-
"
|
|
3992
|
+
"agent:generate:test-spec",
|
|
3993
|
+
"generate:agent:test-spec",
|
|
3994
|
+
"generate:test-spec:agent",
|
|
3995
|
+
"agent:test-spec:generate",
|
|
3996
|
+
"test-spec:agent:generate",
|
|
3997
|
+
"test-spec:generate:agent"
|
|
3998
3998
|
]
|
|
3999
3999
|
},
|
|
4000
4000
|
"agent:validate:authoring-bundle": {
|
|
@@ -4667,5 +4667,5 @@
|
|
|
4667
4667
|
]
|
|
4668
4668
|
}
|
|
4669
4669
|
},
|
|
4670
|
-
"version": "1.
|
|
4670
|
+
"version": "1.45.0"
|
|
4671
4671
|
}
|