@salesforce/plugin-agent 2.0.2 → 2.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -41
- package/oclif.manifest.json +501 -501
- package/package.json +4 -4
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:generate:agent-spec": {
|
|
1749
1745
|
"aliases": [],
|
|
1750
1746
|
"args": {},
|
|
1751
|
-
"description": "
|
|
1747
|
+
"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.)",
|
|
1752
1748
|
"examples": [
|
|
1753
|
-
"
|
|
1754
|
-
"
|
|
1749
|
+
"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.\"",
|
|
1750
|
+
"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",
|
|
1751
|
+
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
1752
|
+
"Specify an existing agent spec file called \"specs/resortManagerAgent.yaml\", and then overwrite it with a new version that contains newly AI-generated topics based on the updated role information passed in with the --role flag:\n<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role \"Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly\"",
|
|
1753
|
+
"Specify that the conversational tone of the agent is formal and to attach the \"resortmanager@myorg.com\" username to it; be prompted for the required properties and use your default org:\n<%= config.bin %> <%= command.id %> --tone formal --agent-user resortmanager@myorg.com"
|
|
1755
1754
|
],
|
|
1756
1755
|
"flags": {
|
|
1757
1756
|
"json": {
|
|
@@ -1786,136 +1785,164 @@
|
|
|
1786
1785
|
"multiple": false,
|
|
1787
1786
|
"type": "option"
|
|
1788
1787
|
},
|
|
1789
|
-
"
|
|
1790
|
-
"
|
|
1791
|
-
"
|
|
1792
|
-
"required": true,
|
|
1793
|
-
"summary": "ID of the MCP server to delete.",
|
|
1788
|
+
"type": {
|
|
1789
|
+
"name": "type",
|
|
1790
|
+
"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.",
|
|
1794
1791
|
"hasDynamicHelp": false,
|
|
1795
1792
|
"multiple": false,
|
|
1793
|
+
"options": [
|
|
1794
|
+
"customer",
|
|
1795
|
+
"internal"
|
|
1796
|
+
],
|
|
1796
1797
|
"type": "option"
|
|
1797
1798
|
},
|
|
1798
|
-
"
|
|
1799
|
-
"name": "
|
|
1800
|
-
"summary": "
|
|
1801
|
-
"
|
|
1802
|
-
"
|
|
1803
|
-
|
|
1804
|
-
},
|
|
1805
|
-
"hasDynamicHelp": true,
|
|
1806
|
-
"hiddenAliases": [],
|
|
1807
|
-
"id": "agent:mcp:delete",
|
|
1808
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
1809
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1810
|
-
"pluginType": "core",
|
|
1811
|
-
"state": "preview",
|
|
1812
|
-
"strict": true,
|
|
1813
|
-
"summary": "Delete an MCP server from the API Catalog.",
|
|
1814
|
-
"enableJsonFlag": true,
|
|
1815
|
-
"isESM": true,
|
|
1816
|
-
"relativePath": [
|
|
1817
|
-
"lib",
|
|
1818
|
-
"commands",
|
|
1819
|
-
"agent",
|
|
1820
|
-
"mcp",
|
|
1821
|
-
"delete.js"
|
|
1822
|
-
],
|
|
1823
|
-
"aliasPermutations": [],
|
|
1824
|
-
"permutations": [
|
|
1825
|
-
"agent:mcp:delete",
|
|
1826
|
-
"mcp:agent:delete",
|
|
1827
|
-
"mcp:delete:agent",
|
|
1828
|
-
"agent:delete:mcp",
|
|
1829
|
-
"delete:agent:mcp",
|
|
1830
|
-
"delete:mcp:agent"
|
|
1831
|
-
]
|
|
1832
|
-
},
|
|
1833
|
-
"agent:mcp:fetch": {
|
|
1834
|
-
"aliases": [],
|
|
1835
|
-
"args": {},
|
|
1836
|
-
"description": "Performs a live fetch against the configured MCP server identified by its ID, returning the assets (MCP tools, prompts, and resources) it currently advertises along with their status and activation state. Use this to refresh the view of what an MCP server exposes before activating its assets as agent actions.",
|
|
1837
|
-
"examples": [
|
|
1838
|
-
"Fetch the assets advertised by an MCP server in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001",
|
|
1839
|
-
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
1840
|
-
],
|
|
1841
|
-
"flags": {
|
|
1842
|
-
"json": {
|
|
1843
|
-
"description": "Format output as json.",
|
|
1844
|
-
"helpGroup": "GLOBAL",
|
|
1845
|
-
"name": "json",
|
|
1846
|
-
"allowNo": false,
|
|
1847
|
-
"type": "boolean"
|
|
1799
|
+
"role": {
|
|
1800
|
+
"name": "role",
|
|
1801
|
+
"summary": "Role of the agent.",
|
|
1802
|
+
"hasDynamicHelp": false,
|
|
1803
|
+
"multiple": false,
|
|
1804
|
+
"type": "option"
|
|
1848
1805
|
},
|
|
1849
|
-
"
|
|
1850
|
-
"
|
|
1851
|
-
"
|
|
1852
|
-
"summary": "Import flag values from a directory.",
|
|
1806
|
+
"company-name": {
|
|
1807
|
+
"name": "company-name",
|
|
1808
|
+
"summary": "Name of your company.",
|
|
1853
1809
|
"hasDynamicHelp": false,
|
|
1854
1810
|
"multiple": false,
|
|
1855
1811
|
"type": "option"
|
|
1856
1812
|
},
|
|
1857
|
-
"
|
|
1858
|
-
"
|
|
1859
|
-
"
|
|
1860
|
-
"
|
|
1861
|
-
"required": true,
|
|
1862
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1863
|
-
"hasDynamicHelp": true,
|
|
1813
|
+
"company-description": {
|
|
1814
|
+
"name": "company-description",
|
|
1815
|
+
"summary": "Description of your company.",
|
|
1816
|
+
"hasDynamicHelp": false,
|
|
1864
1817
|
"multiple": false,
|
|
1865
1818
|
"type": "option"
|
|
1866
1819
|
},
|
|
1867
|
-
"
|
|
1868
|
-
"
|
|
1869
|
-
"
|
|
1820
|
+
"company-website": {
|
|
1821
|
+
"name": "company-website",
|
|
1822
|
+
"summary": "Website URL of your company.",
|
|
1870
1823
|
"hasDynamicHelp": false,
|
|
1871
1824
|
"multiple": false,
|
|
1872
1825
|
"type": "option"
|
|
1873
1826
|
},
|
|
1874
|
-
"
|
|
1875
|
-
"
|
|
1876
|
-
"
|
|
1877
|
-
"
|
|
1878
|
-
"
|
|
1827
|
+
"max-topics": {
|
|
1828
|
+
"name": "max-topics",
|
|
1829
|
+
"summary": "Maximum number of topics to generate in the agent spec; default is 5.",
|
|
1830
|
+
"hasDynamicHelp": false,
|
|
1831
|
+
"multiple": false,
|
|
1832
|
+
"type": "option"
|
|
1833
|
+
},
|
|
1834
|
+
"agent-user": {
|
|
1835
|
+
"name": "agent-user",
|
|
1836
|
+
"summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
|
|
1837
|
+
"hasDynamicHelp": false,
|
|
1838
|
+
"multiple": false,
|
|
1839
|
+
"type": "option"
|
|
1840
|
+
},
|
|
1841
|
+
"enrich-logs": {
|
|
1842
|
+
"name": "enrich-logs",
|
|
1843
|
+
"summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
|
|
1844
|
+
"hasDynamicHelp": false,
|
|
1845
|
+
"multiple": false,
|
|
1846
|
+
"options": [
|
|
1847
|
+
"true",
|
|
1848
|
+
"false"
|
|
1849
|
+
],
|
|
1850
|
+
"type": "option"
|
|
1851
|
+
},
|
|
1852
|
+
"tone": {
|
|
1853
|
+
"name": "tone",
|
|
1854
|
+
"summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
|
|
1879
1855
|
"hasDynamicHelp": false,
|
|
1880
1856
|
"multiple": false,
|
|
1857
|
+
"options": [
|
|
1858
|
+
"formal",
|
|
1859
|
+
"casual",
|
|
1860
|
+
"neutral"
|
|
1861
|
+
],
|
|
1881
1862
|
"type": "option"
|
|
1863
|
+
},
|
|
1864
|
+
"spec": {
|
|
1865
|
+
"name": "spec",
|
|
1866
|
+
"summary": "Agent spec file, in YAML format, to use as input to the command.",
|
|
1867
|
+
"hasDynamicHelp": false,
|
|
1868
|
+
"multiple": false,
|
|
1869
|
+
"type": "option"
|
|
1870
|
+
},
|
|
1871
|
+
"output-file": {
|
|
1872
|
+
"name": "output-file",
|
|
1873
|
+
"summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
|
|
1874
|
+
"default": "specs/agentSpec.yaml",
|
|
1875
|
+
"hasDynamicHelp": false,
|
|
1876
|
+
"multiple": false,
|
|
1877
|
+
"type": "option"
|
|
1878
|
+
},
|
|
1879
|
+
"full-interview": {
|
|
1880
|
+
"name": "full-interview",
|
|
1881
|
+
"summary": "Prompt for both required and optional flags.",
|
|
1882
|
+
"allowNo": false,
|
|
1883
|
+
"type": "boolean"
|
|
1884
|
+
},
|
|
1885
|
+
"prompt-template": {
|
|
1886
|
+
"name": "prompt-template",
|
|
1887
|
+
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
1888
|
+
"hasDynamicHelp": false,
|
|
1889
|
+
"multiple": false,
|
|
1890
|
+
"type": "option"
|
|
1891
|
+
},
|
|
1892
|
+
"grounding-context": {
|
|
1893
|
+
"dependsOn": [
|
|
1894
|
+
"prompt-template"
|
|
1895
|
+
],
|
|
1896
|
+
"name": "grounding-context",
|
|
1897
|
+
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
1898
|
+
"hasDynamicHelp": false,
|
|
1899
|
+
"multiple": false,
|
|
1900
|
+
"type": "option"
|
|
1901
|
+
},
|
|
1902
|
+
"force-overwrite": {
|
|
1903
|
+
"name": "force-overwrite",
|
|
1904
|
+
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
1905
|
+
"allowNo": false,
|
|
1906
|
+
"type": "boolean"
|
|
1882
1907
|
}
|
|
1883
1908
|
},
|
|
1884
1909
|
"hasDynamicHelp": true,
|
|
1885
1910
|
"hiddenAliases": [],
|
|
1886
|
-
"id": "agent:
|
|
1911
|
+
"id": "agent:generate:agent-spec",
|
|
1887
1912
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1888
1913
|
"pluginName": "@salesforce/plugin-agent",
|
|
1889
1914
|
"pluginType": "core",
|
|
1890
|
-
"state": "preview",
|
|
1891
1915
|
"strict": true,
|
|
1892
|
-
"summary": "
|
|
1916
|
+
"summary": "Generate an agent spec, which is a YAML file that captures what an agent can do.",
|
|
1893
1917
|
"enableJsonFlag": true,
|
|
1918
|
+
"requiresProject": true,
|
|
1894
1919
|
"isESM": true,
|
|
1895
1920
|
"relativePath": [
|
|
1896
1921
|
"lib",
|
|
1897
1922
|
"commands",
|
|
1898
1923
|
"agent",
|
|
1899
|
-
"
|
|
1900
|
-
"
|
|
1924
|
+
"generate",
|
|
1925
|
+
"agent-spec.js"
|
|
1901
1926
|
],
|
|
1902
1927
|
"aliasPermutations": [],
|
|
1903
1928
|
"permutations": [
|
|
1904
|
-
"agent:
|
|
1905
|
-
"
|
|
1906
|
-
"
|
|
1907
|
-
"agent:
|
|
1908
|
-
"
|
|
1909
|
-
"
|
|
1929
|
+
"agent:generate:agent-spec",
|
|
1930
|
+
"generate:agent:agent-spec",
|
|
1931
|
+
"generate:agent-spec:agent",
|
|
1932
|
+
"agent:agent-spec:generate",
|
|
1933
|
+
"agent-spec:agent:generate",
|
|
1934
|
+
"agent-spec:generate:agent"
|
|
1910
1935
|
]
|
|
1911
1936
|
},
|
|
1912
|
-
"agent:
|
|
1937
|
+
"agent:generate:authoring-bundle": {
|
|
1913
1938
|
"aliases": [],
|
|
1914
1939
|
"args": {},
|
|
1915
|
-
"description": "
|
|
1940
|
+
"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.",
|
|
1916
1941
|
"examples": [
|
|
1917
|
-
"
|
|
1918
|
-
"
|
|
1942
|
+
"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 %>",
|
|
1943
|
+
"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\"",
|
|
1944
|
+
"Generate an authoring bundle from the \"specs/agentSpec.yaml\" agent spec YAML file and give it the label \"My Authoring Bundle\"; use your default org:\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\"",
|
|
1945
|
+
"Similar to previous example, but generate the authoring bundle files in the \"other-package-dir/main/default\" package directory; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\" --output-dir other-package-dir/main/default --target-org my-dev-org"
|
|
1919
1946
|
],
|
|
1920
1947
|
"flags": {
|
|
1921
1948
|
"json": {
|
|
@@ -1943,6 +1970,13 @@
|
|
|
1943
1970
|
"multiple": false,
|
|
1944
1971
|
"type": "option"
|
|
1945
1972
|
},
|
|
1973
|
+
"api-name": {
|
|
1974
|
+
"name": "api-name",
|
|
1975
|
+
"summary": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name can't exist in the org.",
|
|
1976
|
+
"hasDynamicHelp": false,
|
|
1977
|
+
"multiple": false,
|
|
1978
|
+
"type": "option"
|
|
1979
|
+
},
|
|
1946
1980
|
"api-version": {
|
|
1947
1981
|
"description": "Override the api version used for api requests made by this command",
|
|
1948
1982
|
"name": "api-version",
|
|
@@ -1950,51 +1984,77 @@
|
|
|
1950
1984
|
"multiple": false,
|
|
1951
1985
|
"type": "option"
|
|
1952
1986
|
},
|
|
1953
|
-
"
|
|
1954
|
-
"char": "
|
|
1955
|
-
"name": "
|
|
1956
|
-
"
|
|
1957
|
-
"
|
|
1987
|
+
"spec": {
|
|
1988
|
+
"char": "f",
|
|
1989
|
+
"name": "spec",
|
|
1990
|
+
"summary": "Path to the agent spec YAML file. If you don't specify the flag, the command provides a list that you can choose from. Use the --no-spec flag to skip using an agent spec entirely.",
|
|
1991
|
+
"hasDynamicHelp": false,
|
|
1992
|
+
"multiple": false,
|
|
1993
|
+
"type": "option"
|
|
1994
|
+
},
|
|
1995
|
+
"no-spec": {
|
|
1996
|
+
"name": "no-spec",
|
|
1997
|
+
"summary": "Skip prompting for an agent spec and use the default Agent Script boilerplate in the generated authoring bundle.",
|
|
1998
|
+
"allowNo": false,
|
|
1999
|
+
"type": "boolean"
|
|
2000
|
+
},
|
|
2001
|
+
"output-dir": {
|
|
2002
|
+
"char": "d",
|
|
2003
|
+
"name": "output-dir",
|
|
2004
|
+
"summary": "Directory where the authoring bundle files are generated.",
|
|
2005
|
+
"hasDynamicHelp": false,
|
|
2006
|
+
"multiple": false,
|
|
2007
|
+
"type": "option"
|
|
2008
|
+
},
|
|
2009
|
+
"name": {
|
|
2010
|
+
"char": "n",
|
|
2011
|
+
"name": "name",
|
|
2012
|
+
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
1958
2013
|
"hasDynamicHelp": false,
|
|
1959
2014
|
"multiple": false,
|
|
1960
2015
|
"type": "option"
|
|
2016
|
+
},
|
|
2017
|
+
"force-overwrite": {
|
|
2018
|
+
"name": "force-overwrite",
|
|
2019
|
+
"summary": "Overwrite the existing authoring bundle if one with the same API name already exists locally.",
|
|
2020
|
+
"allowNo": false,
|
|
2021
|
+
"type": "boolean"
|
|
1961
2022
|
}
|
|
1962
2023
|
},
|
|
1963
2024
|
"hasDynamicHelp": true,
|
|
1964
2025
|
"hiddenAliases": [],
|
|
1965
|
-
"id": "agent:
|
|
2026
|
+
"id": "agent:generate:authoring-bundle",
|
|
1966
2027
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1967
2028
|
"pluginName": "@salesforce/plugin-agent",
|
|
1968
2029
|
"pluginType": "core",
|
|
1969
|
-
"state": "preview",
|
|
1970
2030
|
"strict": true,
|
|
1971
|
-
"summary": "
|
|
2031
|
+
"summary": "Generate an authoring bundle from an existing agent spec YAML file.",
|
|
1972
2032
|
"enableJsonFlag": true,
|
|
2033
|
+
"requiresProject": true,
|
|
1973
2034
|
"isESM": true,
|
|
1974
2035
|
"relativePath": [
|
|
1975
2036
|
"lib",
|
|
1976
2037
|
"commands",
|
|
1977
2038
|
"agent",
|
|
1978
|
-
"
|
|
1979
|
-
"
|
|
2039
|
+
"generate",
|
|
2040
|
+
"authoring-bundle.js"
|
|
1980
2041
|
],
|
|
1981
2042
|
"aliasPermutations": [],
|
|
1982
2043
|
"permutations": [
|
|
1983
|
-
"agent:
|
|
1984
|
-
"
|
|
1985
|
-
"
|
|
1986
|
-
"agent:
|
|
1987
|
-
"
|
|
1988
|
-
"
|
|
2044
|
+
"agent:generate:authoring-bundle",
|
|
2045
|
+
"generate:agent:authoring-bundle",
|
|
2046
|
+
"generate:authoring-bundle:agent",
|
|
2047
|
+
"agent:authoring-bundle:generate",
|
|
2048
|
+
"authoring-bundle:agent:generate",
|
|
2049
|
+
"authoring-bundle:generate:agent"
|
|
1989
2050
|
]
|
|
1990
2051
|
},
|
|
1991
|
-
"agent:
|
|
2052
|
+
"agent:generate:template": {
|
|
1992
2053
|
"aliases": [],
|
|
1993
2054
|
"args": {},
|
|
1994
|
-
"description": "
|
|
2055
|
+
"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.",
|
|
1995
2056
|
"examples": [
|
|
1996
|
-
"
|
|
1997
|
-
"List external MCP servers filtered by status and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json"
|
|
2057
|
+
"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"
|
|
1998
2058
|
],
|
|
1999
2059
|
"flags": {
|
|
2000
2060
|
"json": {
|
|
@@ -2012,16 +2072,6 @@
|
|
|
2012
2072
|
"multiple": false,
|
|
2013
2073
|
"type": "option"
|
|
2014
2074
|
},
|
|
2015
|
-
"target-org": {
|
|
2016
|
-
"char": "o",
|
|
2017
|
-
"name": "target-org",
|
|
2018
|
-
"noCacheDefault": true,
|
|
2019
|
-
"required": true,
|
|
2020
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2021
|
-
"hasDynamicHelp": true,
|
|
2022
|
-
"multiple": false,
|
|
2023
|
-
"type": "option"
|
|
2024
|
-
},
|
|
2025
2075
|
"api-version": {
|
|
2026
2076
|
"description": "Override the api version used for api requests made by this command",
|
|
2027
2077
|
"name": "api-version",
|
|
@@ -2029,79 +2079,82 @@
|
|
|
2029
2079
|
"multiple": false,
|
|
2030
2080
|
"type": "option"
|
|
2031
2081
|
},
|
|
2032
|
-
"
|
|
2033
|
-
"
|
|
2034
|
-
"
|
|
2082
|
+
"source-org": {
|
|
2083
|
+
"char": "s",
|
|
2084
|
+
"name": "source-org",
|
|
2085
|
+
"noCacheDefault": true,
|
|
2086
|
+
"required": true,
|
|
2087
|
+
"summary": "Username or alias of the namespaced scratch org that contains the agent which this template is based on.",
|
|
2088
|
+
"hasDynamicHelp": true,
|
|
2089
|
+
"multiple": false,
|
|
2090
|
+
"type": "option"
|
|
2091
|
+
},
|
|
2092
|
+
"agent-version": {
|
|
2093
|
+
"name": "agent-version",
|
|
2094
|
+
"required": true,
|
|
2095
|
+
"summary": "Version of the agent (BotVersion).",
|
|
2035
2096
|
"hasDynamicHelp": false,
|
|
2036
2097
|
"multiple": false,
|
|
2037
2098
|
"type": "option"
|
|
2038
2099
|
},
|
|
2039
|
-
"
|
|
2040
|
-
"
|
|
2041
|
-
"
|
|
2100
|
+
"agent-file": {
|
|
2101
|
+
"char": "f",
|
|
2102
|
+
"name": "agent-file",
|
|
2103
|
+
"required": true,
|
|
2104
|
+
"summary": "Path to an agent (Bot) metadata file.",
|
|
2042
2105
|
"hasDynamicHelp": false,
|
|
2043
2106
|
"multiple": false,
|
|
2044
|
-
"options": [
|
|
2045
|
-
"EXTERNAL"
|
|
2046
|
-
],
|
|
2047
2107
|
"type": "option"
|
|
2048
2108
|
},
|
|
2049
|
-
"
|
|
2050
|
-
"
|
|
2051
|
-
"
|
|
2109
|
+
"output-dir": {
|
|
2110
|
+
"char": "r",
|
|
2111
|
+
"name": "output-dir",
|
|
2112
|
+
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
2052
2113
|
"hasDynamicHelp": false,
|
|
2053
2114
|
"multiple": false,
|
|
2054
|
-
"options": [
|
|
2055
|
-
"ACTIVE",
|
|
2056
|
-
"DISCONNECTED"
|
|
2057
|
-
],
|
|
2058
2115
|
"type": "option"
|
|
2059
2116
|
}
|
|
2060
2117
|
},
|
|
2061
2118
|
"hasDynamicHelp": true,
|
|
2062
2119
|
"hiddenAliases": [],
|
|
2063
|
-
"id": "agent:
|
|
2120
|
+
"id": "agent:generate:template",
|
|
2064
2121
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2065
2122
|
"pluginName": "@salesforce/plugin-agent",
|
|
2066
2123
|
"pluginType": "core",
|
|
2067
|
-
"state": "preview",
|
|
2068
2124
|
"strict": true,
|
|
2069
|
-
"summary": "
|
|
2125
|
+
"summary": "Generate an agent template from an existing agent in your DX project so you can then package the template in a second-generation managed package.",
|
|
2070
2126
|
"enableJsonFlag": true,
|
|
2127
|
+
"requiresProject": true,
|
|
2071
2128
|
"isESM": true,
|
|
2072
2129
|
"relativePath": [
|
|
2073
2130
|
"lib",
|
|
2074
2131
|
"commands",
|
|
2075
2132
|
"agent",
|
|
2076
|
-
"
|
|
2077
|
-
"
|
|
2133
|
+
"generate",
|
|
2134
|
+
"template.js"
|
|
2078
2135
|
],
|
|
2079
2136
|
"aliasPermutations": [],
|
|
2080
2137
|
"permutations": [
|
|
2081
|
-
"agent:
|
|
2082
|
-
"
|
|
2083
|
-
"
|
|
2084
|
-
"agent:
|
|
2085
|
-
"
|
|
2086
|
-
"
|
|
2138
|
+
"agent:generate:template",
|
|
2139
|
+
"generate:agent:template",
|
|
2140
|
+
"generate:template:agent",
|
|
2141
|
+
"agent:template:generate",
|
|
2142
|
+
"template:agent:generate",
|
|
2143
|
+
"template:generate:agent"
|
|
2087
2144
|
]
|
|
2088
2145
|
},
|
|
2089
|
-
"agent:
|
|
2146
|
+
"agent:generate:test-spec": {
|
|
2090
2147
|
"aliases": [],
|
|
2091
2148
|
"args": {},
|
|
2092
|
-
"description": "
|
|
2149
|
+
"description": "The first step when using Salesforce CLI to create an agent test in your org is to use this interactive command to generate a local YAML-formatted test spec file. The test spec YAML file contains information about the agent being tested, such as its API name, and then one or more test cases. This command uses the metadata components in your DX project when prompting for information, such as the agent API name; it doesn't look in your org.\n\nTo generate a specific agent test case, this command prompts you for this information; when possible, the command provides a list of options for you to choose from:\n\n- Utterance: Natural language statement, question, or command used to test the agent.\n- Expected topic: API name of the topic you expect the agent to use when responding to the utterance.\n- Expected actions: One or more API names of the expection actions the agent takes.\n- Expected outcome: Natural language description of the outcome you expect.\n- (Optional) Custom evaluation: Test an agent's response for specific strings or numbers.\n- (Optional) Conversation history: Boilerplate for additional context you can add to the test in the form of a conversation history.\n\nYou can manually add contextVariables to test cases in the generated YAML file to inject contextual data (such as CaseId or RoutableId) into agent sessions. This is useful for testing agent behavior with different contextual information.\n\nWhen your test spec is ready, you then run the \"agent test create\" command to actually create the test in your org and synchronize the metadata with your DX project. The metadata type for an agent test is `AiEvaluationDefinition` (legacy testing-center) or `AiTestingDefinition` (Agentforce Studio / NGT), selected via --test-runner.\n\nIf you have an existing AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project, you can generate its equivalent YAML test spec file with the --from-definition flag. The runner is inferred from the file extension; pass --test-runner to override.",
|
|
2093
2150
|
"examples": [
|
|
2094
|
-
"
|
|
2095
|
-
"
|
|
2151
|
+
"Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
|
|
2152
|
+
"Generate an Agentforce Studio (NGT) test spec YAML file interactively:\n<%= config.bin %> <%= command.id %> --test-runner agentforce-studio",
|
|
2153
|
+
"Generate an agent test spec YAML file and specify a name for the new file; if the file exists, overwrite it without confirmation:\n<%= config.bin %> <%= command.id %> --output-file specs/Resort_Manager-new-version-testSpec.yaml --force-overwrite",
|
|
2154
|
+
"Generate an agent test spec YAML file from an existing AiEvaluationDefinition metadata XML file in your DX project:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml",
|
|
2155
|
+
"Generate an Agentforce Studio (NGT) test spec YAML file from an existing AiTestingDefinition metadata XML file:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiTestingDefinitions/Returns_Checkout_Tests.aiTestingDefinition-meta.xml"
|
|
2096
2156
|
],
|
|
2097
2157
|
"flags": {
|
|
2098
|
-
"json": {
|
|
2099
|
-
"description": "Format output as json.",
|
|
2100
|
-
"helpGroup": "GLOBAL",
|
|
2101
|
-
"name": "json",
|
|
2102
|
-
"allowNo": false,
|
|
2103
|
-
"type": "boolean"
|
|
2104
|
-
},
|
|
2105
2158
|
"flags-dir": {
|
|
2106
2159
|
"helpGroup": "GLOBAL",
|
|
2107
2160
|
"name": "flags-dir",
|
|
@@ -2110,119 +2163,66 @@
|
|
|
2110
2163
|
"multiple": false,
|
|
2111
2164
|
"type": "option"
|
|
2112
2165
|
},
|
|
2113
|
-
"
|
|
2114
|
-
"char": "
|
|
2115
|
-
"name": "
|
|
2116
|
-
"
|
|
2117
|
-
"required": true,
|
|
2118
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2119
|
-
"hasDynamicHelp": true,
|
|
2120
|
-
"multiple": false,
|
|
2121
|
-
"type": "option"
|
|
2122
|
-
},
|
|
2123
|
-
"api-version": {
|
|
2124
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2125
|
-
"name": "api-version",
|
|
2126
|
-
"hasDynamicHelp": false,
|
|
2127
|
-
"multiple": false,
|
|
2128
|
-
"type": "option"
|
|
2129
|
-
},
|
|
2130
|
-
"mcp-server-id": {
|
|
2131
|
-
"char": "i",
|
|
2132
|
-
"name": "mcp-server-id",
|
|
2133
|
-
"required": true,
|
|
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.",
|
|
2166
|
+
"from-definition": {
|
|
2167
|
+
"char": "d",
|
|
2168
|
+
"name": "from-definition",
|
|
2169
|
+
"summary": "Filepath to an AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project that you want to convert to a test spec YAML file.",
|
|
2142
2170
|
"hasDynamicHelp": false,
|
|
2143
2171
|
"multiple": false,
|
|
2144
2172
|
"type": "option"
|
|
2145
2173
|
},
|
|
2146
|
-
"
|
|
2147
|
-
"name": "
|
|
2148
|
-
"summary": "
|
|
2149
|
-
"
|
|
2150
|
-
"
|
|
2151
|
-
"type": "option"
|
|
2174
|
+
"force-overwrite": {
|
|
2175
|
+
"name": "force-overwrite",
|
|
2176
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test spec YAML file.",
|
|
2177
|
+
"allowNo": false,
|
|
2178
|
+
"type": "boolean"
|
|
2152
2179
|
},
|
|
2153
|
-
"
|
|
2154
|
-
"
|
|
2155
|
-
"
|
|
2180
|
+
"output-file": {
|
|
2181
|
+
"char": "f",
|
|
2182
|
+
"name": "output-file",
|
|
2183
|
+
"summary": "Name of the generated test spec YAML file. Default value is \"specs/<AGENT_API_NAME>-testSpec.yaml\" (legacy) or \"specs/<AGENT_API_NAME>-ngtTestSpec.yaml\" (Agentforce Studio).",
|
|
2156
2184
|
"hasDynamicHelp": false,
|
|
2157
2185
|
"multiple": false,
|
|
2158
2186
|
"type": "option"
|
|
2159
2187
|
},
|
|
2160
|
-
"
|
|
2161
|
-
"
|
|
2162
|
-
"
|
|
2188
|
+
"test-runner": {
|
|
2189
|
+
"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.",
|
|
2190
|
+
"name": "test-runner",
|
|
2191
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2163
2192
|
"hasDynamicHelp": false,
|
|
2164
2193
|
"multiple": false,
|
|
2165
2194
|
"options": [
|
|
2166
|
-
"
|
|
2167
|
-
"
|
|
2195
|
+
"agentforce-studio",
|
|
2196
|
+
"testing-center"
|
|
2168
2197
|
],
|
|
2169
2198
|
"type": "option"
|
|
2170
|
-
},
|
|
2171
|
-
"identity-provider": {
|
|
2172
|
-
"name": "identity-provider",
|
|
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"
|
|
2191
|
-
},
|
|
2192
|
-
"scope": {
|
|
2193
|
-
"name": "scope",
|
|
2194
|
-
"summary": "OAuth scope (required when --auth-type is OAUTH).",
|
|
2195
|
-
"hasDynamicHelp": false,
|
|
2196
|
-
"multiple": false,
|
|
2197
|
-
"type": "option"
|
|
2198
2199
|
}
|
|
2199
2200
|
},
|
|
2200
|
-
"hasDynamicHelp":
|
|
2201
|
+
"hasDynamicHelp": false,
|
|
2201
2202
|
"hiddenAliases": [],
|
|
2202
|
-
"id": "agent:
|
|
2203
|
+
"id": "agent:generate:test-spec",
|
|
2203
2204
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2204
2205
|
"pluginName": "@salesforce/plugin-agent",
|
|
2205
2206
|
"pluginType": "core",
|
|
2206
|
-
"state": "preview",
|
|
2207
2207
|
"strict": true,
|
|
2208
|
-
"summary": "
|
|
2209
|
-
"enableJsonFlag":
|
|
2208
|
+
"summary": "Generate an agent test spec, which is a YAML file that lists the test cases for testing a specific agent.",
|
|
2209
|
+
"enableJsonFlag": false,
|
|
2210
2210
|
"isESM": true,
|
|
2211
2211
|
"relativePath": [
|
|
2212
2212
|
"lib",
|
|
2213
2213
|
"commands",
|
|
2214
2214
|
"agent",
|
|
2215
|
-
"
|
|
2216
|
-
"
|
|
2215
|
+
"generate",
|
|
2216
|
+
"test-spec.js"
|
|
2217
2217
|
],
|
|
2218
2218
|
"aliasPermutations": [],
|
|
2219
2219
|
"permutations": [
|
|
2220
|
-
"agent:
|
|
2221
|
-
"
|
|
2222
|
-
"
|
|
2223
|
-
"agent:
|
|
2224
|
-
"
|
|
2225
|
-
"
|
|
2220
|
+
"agent:generate:test-spec",
|
|
2221
|
+
"generate:agent:test-spec",
|
|
2222
|
+
"generate:test-spec:agent",
|
|
2223
|
+
"agent:test-spec:generate",
|
|
2224
|
+
"test-spec:agent:generate",
|
|
2225
|
+
"test-spec:generate:agent"
|
|
2226
2226
|
]
|
|
2227
2227
|
},
|
|
2228
2228
|
"agent:preview:end": {
|
|
@@ -4667,5 +4667,5 @@
|
|
|
4667
4667
|
]
|
|
4668
4668
|
}
|
|
4669
4669
|
},
|
|
4670
|
-
"version": "2.0.
|
|
4670
|
+
"version": "2.0.3"
|
|
4671
4671
|
}
|