@salesforce/plugin-agent 2.0.1 → 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 +751 -751
- 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
|
-
"End a preview session of an agent using its authoring bundle API name; you get an error if the agent has more than one active session.\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Local_Agent",
|
|
1131
|
-
"End all active preview sessions for a specific agent without prompting:\n<%= config.bin %> <%= command.id %> --all --authoring-bundle My_Local_Agent --target-org <target_org> --no-prompt",
|
|
1132
|
-
"End all active preview sessions across every agent in the local session cache for an org:\n<%= config.bin %> <%= command.id %> --all --target-org <target_org>"
|
|
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,129 +1161,113 @@
|
|
|
1164
1161
|
"multiple": false,
|
|
1165
1162
|
"type": "option"
|
|
1166
1163
|
},
|
|
1167
|
-
"
|
|
1168
|
-
"
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
"
|
|
1172
|
-
"required": false,
|
|
1173
|
-
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see the list of all sessions.",
|
|
1164
|
+
"name": {
|
|
1165
|
+
"char": "n",
|
|
1166
|
+
"name": "name",
|
|
1167
|
+
"required": true,
|
|
1168
|
+
"summary": "Unique name of the MCP server.",
|
|
1174
1169
|
"hasDynamicHelp": false,
|
|
1175
1170
|
"multiple": false,
|
|
1176
1171
|
"type": "option"
|
|
1177
1172
|
},
|
|
1178
|
-
"
|
|
1179
|
-
"
|
|
1180
|
-
"
|
|
1181
|
-
"authoring-bundle"
|
|
1182
|
-
],
|
|
1183
|
-
"name": "api-name",
|
|
1184
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
1173
|
+
"label": {
|
|
1174
|
+
"name": "label",
|
|
1175
|
+
"summary": "Human-readable label for the MCP server.",
|
|
1185
1176
|
"hasDynamicHelp": false,
|
|
1186
1177
|
"multiple": false,
|
|
1187
1178
|
"type": "option"
|
|
1188
1179
|
},
|
|
1189
|
-
"
|
|
1190
|
-
"
|
|
1191
|
-
|
|
1192
|
-
],
|
|
1193
|
-
"name": "authoring-bundle",
|
|
1194
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1180
|
+
"description": {
|
|
1181
|
+
"name": "description",
|
|
1182
|
+
"summary": "Description of the MCP server.",
|
|
1195
1183
|
"hasDynamicHelp": false,
|
|
1196
1184
|
"multiple": false,
|
|
1197
1185
|
"type": "option"
|
|
1198
1186
|
},
|
|
1199
|
-
"
|
|
1200
|
-
"
|
|
1201
|
-
|
|
1187
|
+
"server-url": {
|
|
1188
|
+
"name": "server-url",
|
|
1189
|
+
"required": true,
|
|
1190
|
+
"summary": "URL of the external MCP server.",
|
|
1191
|
+
"hasDynamicHelp": false,
|
|
1192
|
+
"multiple": false,
|
|
1193
|
+
"type": "option"
|
|
1194
|
+
},
|
|
1195
|
+
"auth-type": {
|
|
1196
|
+
"name": "auth-type",
|
|
1197
|
+
"summary": "Authorization type to use when connecting to the MCP server.",
|
|
1198
|
+
"default": "NO_AUTH",
|
|
1199
|
+
"hasDynamicHelp": false,
|
|
1200
|
+
"multiple": false,
|
|
1201
|
+
"options": [
|
|
1202
|
+
"OAUTH",
|
|
1203
|
+
"NO_AUTH"
|
|
1202
1204
|
],
|
|
1203
|
-
"
|
|
1204
|
-
"summary": "End all active preview sessions. Combine with --api-name or --authoring-bundle to limit to a specific agent, or use with only --target-org to end sessions for all agents found in the local session cache. Requires --target-org.",
|
|
1205
|
-
"allowNo": false,
|
|
1206
|
-
"type": "boolean"
|
|
1205
|
+
"type": "option"
|
|
1207
1206
|
},
|
|
1208
|
-
"
|
|
1209
|
-
"
|
|
1210
|
-
"
|
|
1211
|
-
"
|
|
1212
|
-
"
|
|
1213
|
-
"type": "
|
|
1207
|
+
"identity-provider": {
|
|
1208
|
+
"name": "identity-provider",
|
|
1209
|
+
"summary": "Identity provider to use for OAuth authorization. Required when auth-type is OAUTH.",
|
|
1210
|
+
"hasDynamicHelp": false,
|
|
1211
|
+
"multiple": false,
|
|
1212
|
+
"type": "option"
|
|
1213
|
+
},
|
|
1214
|
+
"client-id": {
|
|
1215
|
+
"name": "client-id",
|
|
1216
|
+
"summary": "OAuth client ID. Required when auth-type is OAUTH.",
|
|
1217
|
+
"hasDynamicHelp": false,
|
|
1218
|
+
"multiple": false,
|
|
1219
|
+
"type": "option"
|
|
1220
|
+
},
|
|
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.",
|
|
1224
|
+
"hasDynamicHelp": false,
|
|
1225
|
+
"multiple": false,
|
|
1226
|
+
"type": "option"
|
|
1227
|
+
},
|
|
1228
|
+
"scope": {
|
|
1229
|
+
"name": "scope",
|
|
1230
|
+
"summary": "OAuth scope to request. Required when auth-type is OAUTH.",
|
|
1231
|
+
"hasDynamicHelp": false,
|
|
1232
|
+
"multiple": false,
|
|
1233
|
+
"type": "option"
|
|
1214
1234
|
}
|
|
1215
1235
|
},
|
|
1216
1236
|
"hasDynamicHelp": true,
|
|
1217
1237
|
"hiddenAliases": [],
|
|
1218
|
-
"id": "agent:
|
|
1238
|
+
"id": "agent:mcp:create",
|
|
1219
1239
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1220
1240
|
"pluginName": "@salesforce/plugin-agent",
|
|
1221
1241
|
"pluginType": "core",
|
|
1242
|
+
"state": "preview",
|
|
1222
1243
|
"strict": true,
|
|
1223
|
-
"summary": "
|
|
1244
|
+
"summary": "Create an MCP server in the API Catalog.",
|
|
1224
1245
|
"enableJsonFlag": true,
|
|
1225
|
-
"requiresProject": true,
|
|
1226
|
-
"envVariablesSection": {
|
|
1227
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1228
|
-
"body": [
|
|
1229
|
-
{
|
|
1230
|
-
"name": "SF_TARGET_ORG",
|
|
1231
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1232
|
-
}
|
|
1233
|
-
]
|
|
1234
|
-
},
|
|
1235
|
-
"errorCodes": {
|
|
1236
|
-
"header": "ERROR CODES",
|
|
1237
|
-
"body": [
|
|
1238
|
-
{
|
|
1239
|
-
"name": "Succeeded (0)",
|
|
1240
|
-
"description": "Preview session ended successfully and traces saved."
|
|
1241
|
-
},
|
|
1242
|
-
{
|
|
1243
|
-
"name": "ExactlyOneRequired (2)",
|
|
1244
|
-
"description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
|
|
1245
|
-
},
|
|
1246
|
-
{
|
|
1247
|
-
"name": "NotFound (2)",
|
|
1248
|
-
"description": "Agent not found, or no preview session exists for this agent."
|
|
1249
|
-
},
|
|
1250
|
-
{
|
|
1251
|
-
"name": "PreviewEndFailed (4)",
|
|
1252
|
-
"description": "Failed to end the preview session."
|
|
1253
|
-
},
|
|
1254
|
-
{
|
|
1255
|
-
"name": "PreviewEndPartialFailure (68)",
|
|
1256
|
-
"description": "With --all, one or more sessions failed to end while others succeeded."
|
|
1257
|
-
},
|
|
1258
|
-
{
|
|
1259
|
-
"name": "SessionAmbiguous (5)",
|
|
1260
|
-
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
1261
|
-
}
|
|
1262
|
-
]
|
|
1263
|
-
},
|
|
1264
1246
|
"isESM": true,
|
|
1265
1247
|
"relativePath": [
|
|
1266
1248
|
"lib",
|
|
1267
1249
|
"commands",
|
|
1268
1250
|
"agent",
|
|
1269
|
-
"
|
|
1270
|
-
"
|
|
1251
|
+
"mcp",
|
|
1252
|
+
"create.js"
|
|
1271
1253
|
],
|
|
1272
1254
|
"aliasPermutations": [],
|
|
1273
1255
|
"permutations": [
|
|
1274
|
-
"agent:
|
|
1275
|
-
"
|
|
1276
|
-
"
|
|
1277
|
-
"agent:
|
|
1278
|
-
"
|
|
1279
|
-
"
|
|
1256
|
+
"agent:mcp:create",
|
|
1257
|
+
"mcp:agent:create",
|
|
1258
|
+
"mcp:create:agent",
|
|
1259
|
+
"agent:create:mcp",
|
|
1260
|
+
"create:agent:mcp",
|
|
1261
|
+
"create:mcp:agent"
|
|
1280
1262
|
]
|
|
1281
1263
|
},
|
|
1282
|
-
"agent:
|
|
1264
|
+
"agent:mcp:delete": {
|
|
1283
1265
|
"aliases": [],
|
|
1284
1266
|
"args": {},
|
|
1285
|
-
"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).",
|
|
1286
1268
|
"examples": [
|
|
1287
|
-
"
|
|
1288
|
-
"
|
|
1289
|
-
"Send a message to an agent using its authoring bundle API name; you get an error if the agent has more than one active session:\n<%= config.bin %> <%= command.id %> --utterance \"what can you help me with?\" --authoring-bundle My_Local_Agent"
|
|
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"
|
|
1290
1271
|
],
|
|
1291
1272
|
"flags": {
|
|
1292
1273
|
"json": {
|
|
@@ -1321,103 +1302,57 @@
|
|
|
1321
1302
|
"multiple": false,
|
|
1322
1303
|
"type": "option"
|
|
1323
1304
|
},
|
|
1324
|
-
"
|
|
1325
|
-
"
|
|
1326
|
-
"
|
|
1327
|
-
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see list of all sessions.",
|
|
1328
|
-
"hasDynamicHelp": false,
|
|
1329
|
-
"multiple": false,
|
|
1330
|
-
"type": "option"
|
|
1331
|
-
},
|
|
1332
|
-
"utterance": {
|
|
1333
|
-
"char": "u",
|
|
1334
|
-
"name": "utterance",
|
|
1305
|
+
"mcp-server-id": {
|
|
1306
|
+
"char": "i",
|
|
1307
|
+
"name": "mcp-server-id",
|
|
1335
1308
|
"required": true,
|
|
1336
|
-
"summary": "
|
|
1337
|
-
"hasDynamicHelp": false,
|
|
1338
|
-
"multiple": false,
|
|
1339
|
-
"type": "option"
|
|
1340
|
-
},
|
|
1341
|
-
"api-name": {
|
|
1342
|
-
"char": "n",
|
|
1343
|
-
"name": "api-name",
|
|
1344
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
1309
|
+
"summary": "ID of the MCP server to delete.",
|
|
1345
1310
|
"hasDynamicHelp": false,
|
|
1346
1311
|
"multiple": false,
|
|
1347
1312
|
"type": "option"
|
|
1348
1313
|
},
|
|
1349
|
-
"
|
|
1350
|
-
"name": "
|
|
1351
|
-
"summary": "
|
|
1352
|
-
"
|
|
1353
|
-
"
|
|
1354
|
-
"type": "option"
|
|
1314
|
+
"no-prompt": {
|
|
1315
|
+
"name": "no-prompt",
|
|
1316
|
+
"summary": "Skip the confirmation prompt and delete the MCP server immediately.",
|
|
1317
|
+
"allowNo": false,
|
|
1318
|
+
"type": "boolean"
|
|
1355
1319
|
}
|
|
1356
1320
|
},
|
|
1357
1321
|
"hasDynamicHelp": true,
|
|
1358
1322
|
"hiddenAliases": [],
|
|
1359
|
-
"id": "agent:
|
|
1323
|
+
"id": "agent:mcp:delete",
|
|
1360
1324
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1361
1325
|
"pluginName": "@salesforce/plugin-agent",
|
|
1362
1326
|
"pluginType": "core",
|
|
1327
|
+
"state": "preview",
|
|
1363
1328
|
"strict": true,
|
|
1364
|
-
"summary": "
|
|
1329
|
+
"summary": "Delete an MCP server from the API Catalog.",
|
|
1365
1330
|
"enableJsonFlag": true,
|
|
1366
|
-
"requiresProject": true,
|
|
1367
|
-
"envVariablesSection": {
|
|
1368
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1369
|
-
"body": [
|
|
1370
|
-
{
|
|
1371
|
-
"name": "SF_TARGET_ORG",
|
|
1372
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1373
|
-
}
|
|
1374
|
-
]
|
|
1375
|
-
},
|
|
1376
|
-
"errorCodes": {
|
|
1377
|
-
"header": "ERROR CODES",
|
|
1378
|
-
"body": [
|
|
1379
|
-
{
|
|
1380
|
-
"name": "Succeeded (0)",
|
|
1381
|
-
"description": "Message sent successfully and agent response received."
|
|
1382
|
-
},
|
|
1383
|
-
{
|
|
1384
|
-
"name": "NotFound (2)",
|
|
1385
|
-
"description": "Agent not found, or no preview session exists for this agent."
|
|
1386
|
-
},
|
|
1387
|
-
{
|
|
1388
|
-
"name": "PreviewSendFailed (4)",
|
|
1389
|
-
"description": "Failed to send message or receive response from the preview session."
|
|
1390
|
-
},
|
|
1391
|
-
{
|
|
1392
|
-
"name": "SessionAmbiguous (5)",
|
|
1393
|
-
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
1394
|
-
}
|
|
1395
|
-
]
|
|
1396
|
-
},
|
|
1397
1331
|
"isESM": true,
|
|
1398
1332
|
"relativePath": [
|
|
1399
1333
|
"lib",
|
|
1400
1334
|
"commands",
|
|
1401
1335
|
"agent",
|
|
1402
|
-
"
|
|
1403
|
-
"
|
|
1336
|
+
"mcp",
|
|
1337
|
+
"delete.js"
|
|
1404
1338
|
],
|
|
1405
1339
|
"aliasPermutations": [],
|
|
1406
1340
|
"permutations": [
|
|
1407
|
-
"agent:
|
|
1408
|
-
"
|
|
1409
|
-
"
|
|
1410
|
-
"agent:
|
|
1411
|
-
"
|
|
1412
|
-
"
|
|
1341
|
+
"agent:mcp:delete",
|
|
1342
|
+
"mcp:agent:delete",
|
|
1343
|
+
"mcp:delete:agent",
|
|
1344
|
+
"agent:delete:mcp",
|
|
1345
|
+
"delete:agent:mcp",
|
|
1346
|
+
"delete:mcp:agent"
|
|
1413
1347
|
]
|
|
1414
1348
|
},
|
|
1415
|
-
"agent:
|
|
1349
|
+
"agent:mcp:fetch": {
|
|
1416
1350
|
"aliases": [],
|
|
1417
1351
|
"args": {},
|
|
1418
|
-
"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.",
|
|
1419
1353
|
"examples": [
|
|
1420
|
-
"
|
|
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"
|
|
1421
1356
|
],
|
|
1422
1357
|
"flags": {
|
|
1423
1358
|
"json": {
|
|
@@ -1434,53 +1369,69 @@
|
|
|
1434
1369
|
"hasDynamicHelp": false,
|
|
1435
1370
|
"multiple": false,
|
|
1436
1371
|
"type": "option"
|
|
1372
|
+
},
|
|
1373
|
+
"target-org": {
|
|
1374
|
+
"char": "o",
|
|
1375
|
+
"name": "target-org",
|
|
1376
|
+
"noCacheDefault": true,
|
|
1377
|
+
"required": true,
|
|
1378
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1379
|
+
"hasDynamicHelp": true,
|
|
1380
|
+
"multiple": false,
|
|
1381
|
+
"type": "option"
|
|
1382
|
+
},
|
|
1383
|
+
"api-version": {
|
|
1384
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1385
|
+
"name": "api-version",
|
|
1386
|
+
"hasDynamicHelp": false,
|
|
1387
|
+
"multiple": false,
|
|
1388
|
+
"type": "option"
|
|
1389
|
+
},
|
|
1390
|
+
"mcp-server-id": {
|
|
1391
|
+
"char": "i",
|
|
1392
|
+
"name": "mcp-server-id",
|
|
1393
|
+
"required": true,
|
|
1394
|
+
"summary": "ID of the MCP server to fetch assets from.",
|
|
1395
|
+
"hasDynamicHelp": false,
|
|
1396
|
+
"multiple": false,
|
|
1397
|
+
"type": "option"
|
|
1437
1398
|
}
|
|
1438
1399
|
},
|
|
1439
|
-
"hasDynamicHelp":
|
|
1400
|
+
"hasDynamicHelp": true,
|
|
1440
1401
|
"hiddenAliases": [],
|
|
1441
|
-
"id": "agent:
|
|
1402
|
+
"id": "agent:mcp:fetch",
|
|
1442
1403
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1443
1404
|
"pluginName": "@salesforce/plugin-agent",
|
|
1444
1405
|
"pluginType": "core",
|
|
1406
|
+
"state": "preview",
|
|
1445
1407
|
"strict": true,
|
|
1446
|
-
"summary": "
|
|
1408
|
+
"summary": "Fetch the live assets (tools, prompts, resources) advertised by an MCP server.",
|
|
1447
1409
|
"enableJsonFlag": true,
|
|
1448
|
-
"requiresProject": true,
|
|
1449
|
-
"errorCodes": {
|
|
1450
|
-
"header": "ERROR CODES",
|
|
1451
|
-
"body": [
|
|
1452
|
-
{
|
|
1453
|
-
"name": "Succeeded (0)",
|
|
1454
|
-
"description": "Sessions listed successfully (or empty list if no active sessions)."
|
|
1455
|
-
}
|
|
1456
|
-
]
|
|
1457
|
-
},
|
|
1458
1410
|
"isESM": true,
|
|
1459
1411
|
"relativePath": [
|
|
1460
1412
|
"lib",
|
|
1461
1413
|
"commands",
|
|
1462
1414
|
"agent",
|
|
1463
|
-
"
|
|
1464
|
-
"
|
|
1415
|
+
"mcp",
|
|
1416
|
+
"fetch.js"
|
|
1465
1417
|
],
|
|
1466
1418
|
"aliasPermutations": [],
|
|
1467
1419
|
"permutations": [
|
|
1468
|
-
"agent:
|
|
1469
|
-
"
|
|
1470
|
-
"
|
|
1471
|
-
"agent:
|
|
1472
|
-
"
|
|
1473
|
-
"
|
|
1420
|
+
"agent:mcp:fetch",
|
|
1421
|
+
"mcp:agent:fetch",
|
|
1422
|
+
"mcp:fetch:agent",
|
|
1423
|
+
"agent:fetch:mcp",
|
|
1424
|
+
"fetch:agent:mcp",
|
|
1425
|
+
"fetch:mcp:agent"
|
|
1474
1426
|
]
|
|
1475
1427
|
},
|
|
1476
|
-
"agent:
|
|
1428
|
+
"agent:mcp:get": {
|
|
1477
1429
|
"aliases": [],
|
|
1478
1430
|
"args": {},
|
|
1479
|
-
"description": "
|
|
1431
|
+
"description": "Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.",
|
|
1480
1432
|
"examples": [
|
|
1481
|
-
"
|
|
1482
|
-
"
|
|
1483
|
-
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
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"
|
|
1484
1435
|
],
|
|
1485
1436
|
"flags": {
|
|
1486
1437
|
"json": {
|
|
@@ -1515,55 +1466,11 @@
|
|
|
1515
1466
|
"multiple": false,
|
|
1516
1467
|
"type": "option"
|
|
1517
1468
|
},
|
|
1518
|
-
"
|
|
1519
|
-
"char": "
|
|
1520
|
-
"name": "
|
|
1521
|
-
"
|
|
1522
|
-
"
|
|
1523
|
-
"multiple": false,
|
|
1524
|
-
"type": "option"
|
|
1525
|
-
},
|
|
1526
|
-
"authoring-bundle": {
|
|
1527
|
-
"name": "authoring-bundle",
|
|
1528
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1529
|
-
"hasDynamicHelp": false,
|
|
1530
|
-
"multiple": false,
|
|
1531
|
-
"type": "option"
|
|
1532
|
-
},
|
|
1533
|
-
"use-live-actions": {
|
|
1534
|
-
"exclusive": [
|
|
1535
|
-
"simulate-actions"
|
|
1536
|
-
],
|
|
1537
|
-
"name": "use-live-actions",
|
|
1538
|
-
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
1539
|
-
"allowNo": false,
|
|
1540
|
-
"type": "boolean"
|
|
1541
|
-
},
|
|
1542
|
-
"simulate-actions": {
|
|
1543
|
-
"exclusive": [
|
|
1544
|
-
"use-live-actions"
|
|
1545
|
-
],
|
|
1546
|
-
"name": "simulate-actions",
|
|
1547
|
-
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
1548
|
-
"allowNo": false,
|
|
1549
|
-
"type": "boolean"
|
|
1550
|
-
},
|
|
1551
|
-
"context-variables": {
|
|
1552
|
-
"description": "Sets variables on the agent preview session, mirroring what the in-org Agentforce Builder UI does when you override variables before sending a message. Specify this flag multiple times or use comma-separated values. Two namespaces are supported, distinguished by the name shape. Names pass through to the runtime verbatim — the CLI doesn't transform them.\n\nLinked context variables use the \"$Context.\" prefix. These map to externally-provided fields that the runtime resolves (declared in the bundle's globalConfiguration.contextVariables) and are read by live actions and topic-routing expressions via $Context.Name. Example: $Context.MyLinkedVar=some-value.\n\nState variables use the bare developerName, no prefix. These seed mutable agent state declared in agentVersion.stateVariables. Example: MyStateVar=some-value.\n\nBoth namespaces can be mixed in one value. Example: --context-variables '$Context.MyLinkedVar=foo,MyStateVar=bar'.\n\nTips: (1) Quote the whole value in single quotes so $Context isn't shell-expanded. (2) Names are sent verbatim — a bare name is treated as a state variable, not a linked context variable, so live actions that bind via $Context.Name will see null. (3) Type defaults to Text.",
|
|
1553
|
-
"name": "context-variables",
|
|
1554
|
-
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
1555
|
-
"delimiter": ",",
|
|
1556
|
-
"hasDynamicHelp": false,
|
|
1557
|
-
"multiple": true,
|
|
1558
|
-
"type": "option"
|
|
1559
|
-
},
|
|
1560
|
-
"agent-json": {
|
|
1561
|
-
"dependsOn": [
|
|
1562
|
-
"authoring-bundle"
|
|
1563
|
-
],
|
|
1564
|
-
"hidden": true,
|
|
1565
|
-
"name": "agent-json",
|
|
1566
|
-
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
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.",
|
|
1567
1474
|
"hasDynamicHelp": false,
|
|
1568
1475
|
"multiple": false,
|
|
1569
1476
|
"type": "option"
|
|
@@ -1571,73 +1478,39 @@
|
|
|
1571
1478
|
},
|
|
1572
1479
|
"hasDynamicHelp": true,
|
|
1573
1480
|
"hiddenAliases": [],
|
|
1574
|
-
"id": "agent:
|
|
1481
|
+
"id": "agent:mcp:get",
|
|
1575
1482
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1576
1483
|
"pluginName": "@salesforce/plugin-agent",
|
|
1577
1484
|
"pluginType": "core",
|
|
1485
|
+
"state": "preview",
|
|
1578
1486
|
"strict": true,
|
|
1579
|
-
"summary": "
|
|
1487
|
+
"summary": "Get a single MCP server registered in the API Catalog.",
|
|
1580
1488
|
"enableJsonFlag": true,
|
|
1581
|
-
"requiresProject": true,
|
|
1582
|
-
"envVariablesSection": {
|
|
1583
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1584
|
-
"body": [
|
|
1585
|
-
{
|
|
1586
|
-
"name": "SF_TARGET_ORG",
|
|
1587
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1588
|
-
}
|
|
1589
|
-
]
|
|
1590
|
-
},
|
|
1591
|
-
"errorCodes": {
|
|
1592
|
-
"header": "ERROR CODES",
|
|
1593
|
-
"body": [
|
|
1594
|
-
{
|
|
1595
|
-
"name": "Succeeded (0)",
|
|
1596
|
-
"description": "Preview session started successfully."
|
|
1597
|
-
},
|
|
1598
|
-
{
|
|
1599
|
-
"name": "Failed (1)",
|
|
1600
|
-
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
1601
|
-
},
|
|
1602
|
-
{
|
|
1603
|
-
"name": "NotFound (2)",
|
|
1604
|
-
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
1605
|
-
},
|
|
1606
|
-
{
|
|
1607
|
-
"name": "ServerError (3)",
|
|
1608
|
-
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
1609
|
-
},
|
|
1610
|
-
{
|
|
1611
|
-
"name": "PreviewStartFailed (4)",
|
|
1612
|
-
"description": "Preview session failed to start due to API or network errors."
|
|
1613
|
-
}
|
|
1614
|
-
]
|
|
1615
|
-
},
|
|
1616
1489
|
"isESM": true,
|
|
1617
1490
|
"relativePath": [
|
|
1618
1491
|
"lib",
|
|
1619
1492
|
"commands",
|
|
1620
1493
|
"agent",
|
|
1621
|
-
"
|
|
1622
|
-
"
|
|
1494
|
+
"mcp",
|
|
1495
|
+
"get.js"
|
|
1623
1496
|
],
|
|
1624
1497
|
"aliasPermutations": [],
|
|
1625
1498
|
"permutations": [
|
|
1626
|
-
"agent:
|
|
1627
|
-
"
|
|
1628
|
-
"
|
|
1629
|
-
"agent:
|
|
1630
|
-
"
|
|
1631
|
-
"
|
|
1499
|
+
"agent:mcp:get",
|
|
1500
|
+
"mcp:agent:get",
|
|
1501
|
+
"mcp:get:agent",
|
|
1502
|
+
"agent:get:mcp",
|
|
1503
|
+
"get:agent:mcp",
|
|
1504
|
+
"get:mcp:agent"
|
|
1632
1505
|
]
|
|
1633
1506
|
},
|
|
1634
|
-
"agent:mcp:
|
|
1507
|
+
"agent:mcp:list": {
|
|
1635
1508
|
"aliases": [],
|
|
1636
1509
|
"args": {},
|
|
1637
|
-
"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.",
|
|
1638
1511
|
"examples": [
|
|
1639
|
-
"
|
|
1640
|
-
"
|
|
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"
|
|
1641
1514
|
],
|
|
1642
1515
|
"flags": {
|
|
1643
1516
|
"json": {
|
|
@@ -1672,87 +1545,44 @@
|
|
|
1672
1545
|
"multiple": false,
|
|
1673
1546
|
"type": "option"
|
|
1674
1547
|
},
|
|
1675
|
-
"name": {
|
|
1676
|
-
"char": "n",
|
|
1677
|
-
"name": "name",
|
|
1678
|
-
"required": true,
|
|
1679
|
-
"summary": "Unique name of the MCP server.",
|
|
1680
|
-
"hasDynamicHelp": false,
|
|
1681
|
-
"multiple": false,
|
|
1682
|
-
"type": "option"
|
|
1683
|
-
},
|
|
1684
1548
|
"label": {
|
|
1685
1549
|
"name": "label",
|
|
1686
|
-
"summary": "
|
|
1687
|
-
"hasDynamicHelp": false,
|
|
1688
|
-
"multiple": false,
|
|
1689
|
-
"type": "option"
|
|
1690
|
-
},
|
|
1691
|
-
"description": {
|
|
1692
|
-
"name": "description",
|
|
1693
|
-
"summary": "Description of the MCP server.",
|
|
1694
|
-
"hasDynamicHelp": false,
|
|
1695
|
-
"multiple": false,
|
|
1696
|
-
"type": "option"
|
|
1697
|
-
},
|
|
1698
|
-
"server-url": {
|
|
1699
|
-
"name": "server-url",
|
|
1700
|
-
"required": true,
|
|
1701
|
-
"summary": "URL of the external MCP server.",
|
|
1550
|
+
"summary": "Filter the MCP servers by label.",
|
|
1702
1551
|
"hasDynamicHelp": false,
|
|
1703
1552
|
"multiple": false,
|
|
1704
1553
|
"type": "option"
|
|
1705
1554
|
},
|
|
1706
|
-
"
|
|
1707
|
-
"name": "
|
|
1708
|
-
"summary": "
|
|
1709
|
-
"default": "NO_AUTH",
|
|
1555
|
+
"type": {
|
|
1556
|
+
"name": "type",
|
|
1557
|
+
"summary": "Filter the MCP servers by type.",
|
|
1710
1558
|
"hasDynamicHelp": false,
|
|
1711
1559
|
"multiple": false,
|
|
1712
1560
|
"options": [
|
|
1713
|
-
"
|
|
1714
|
-
"NO_AUTH"
|
|
1561
|
+
"EXTERNAL"
|
|
1715
1562
|
],
|
|
1716
1563
|
"type": "option"
|
|
1717
1564
|
},
|
|
1718
|
-
"
|
|
1719
|
-
"name": "
|
|
1720
|
-
"summary": "
|
|
1721
|
-
"hasDynamicHelp": false,
|
|
1722
|
-
"multiple": false,
|
|
1723
|
-
"type": "option"
|
|
1724
|
-
},
|
|
1725
|
-
"client-id": {
|
|
1726
|
-
"name": "client-id",
|
|
1727
|
-
"summary": "OAuth client ID. Required when auth-type is OAUTH.",
|
|
1728
|
-
"hasDynamicHelp": false,
|
|
1729
|
-
"multiple": false,
|
|
1730
|
-
"type": "option"
|
|
1731
|
-
},
|
|
1732
|
-
"client-secret": {
|
|
1733
|
-
"name": "client-secret",
|
|
1734
|
-
"summary": "OAuth client secret. Required when auth-type is OAUTH. Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
1735
|
-
"hasDynamicHelp": false,
|
|
1736
|
-
"multiple": false,
|
|
1737
|
-
"type": "option"
|
|
1738
|
-
},
|
|
1739
|
-
"scope": {
|
|
1740
|
-
"name": "scope",
|
|
1741
|
-
"summary": "OAuth scope to request. Required when auth-type is OAUTH.",
|
|
1565
|
+
"status": {
|
|
1566
|
+
"name": "status",
|
|
1567
|
+
"summary": "Filter the MCP servers by connection status. Only ACTIVE and DISCONNECTED are supported as filters.",
|
|
1742
1568
|
"hasDynamicHelp": false,
|
|
1743
1569
|
"multiple": false,
|
|
1570
|
+
"options": [
|
|
1571
|
+
"ACTIVE",
|
|
1572
|
+
"DISCONNECTED"
|
|
1573
|
+
],
|
|
1744
1574
|
"type": "option"
|
|
1745
1575
|
}
|
|
1746
1576
|
},
|
|
1747
1577
|
"hasDynamicHelp": true,
|
|
1748
1578
|
"hiddenAliases": [],
|
|
1749
|
-
"id": "agent:mcp:
|
|
1579
|
+
"id": "agent:mcp:list",
|
|
1750
1580
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1751
1581
|
"pluginName": "@salesforce/plugin-agent",
|
|
1752
1582
|
"pluginType": "core",
|
|
1753
1583
|
"state": "preview",
|
|
1754
1584
|
"strict": true,
|
|
1755
|
-
"summary": "
|
|
1585
|
+
"summary": "List the MCP servers registered in the API Catalog.",
|
|
1756
1586
|
"enableJsonFlag": true,
|
|
1757
1587
|
"isESM": true,
|
|
1758
1588
|
"relativePath": [
|
|
@@ -1760,25 +1590,25 @@
|
|
|
1760
1590
|
"commands",
|
|
1761
1591
|
"agent",
|
|
1762
1592
|
"mcp",
|
|
1763
|
-
"
|
|
1593
|
+
"list.js"
|
|
1764
1594
|
],
|
|
1765
1595
|
"aliasPermutations": [],
|
|
1766
1596
|
"permutations": [
|
|
1767
|
-
"agent:mcp:
|
|
1768
|
-
"mcp:agent:
|
|
1769
|
-
"mcp:
|
|
1770
|
-
"agent:
|
|
1771
|
-
"
|
|
1772
|
-
"
|
|
1597
|
+
"agent:mcp:list",
|
|
1598
|
+
"mcp:agent:list",
|
|
1599
|
+
"mcp:list:agent",
|
|
1600
|
+
"agent:list:mcp",
|
|
1601
|
+
"list:agent:mcp",
|
|
1602
|
+
"list:mcp:agent"
|
|
1773
1603
|
]
|
|
1774
1604
|
},
|
|
1775
|
-
"agent:mcp:
|
|
1605
|
+
"agent:mcp:update": {
|
|
1776
1606
|
"aliases": [],
|
|
1777
1607
|
"args": {},
|
|
1778
|
-
"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.",
|
|
1779
1609
|
"examples": [
|
|
1780
|
-
"
|
|
1781
|
-
"
|
|
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"
|
|
1782
1612
|
],
|
|
1783
1613
|
"flags": {
|
|
1784
1614
|
"json": {
|
|
@@ -1817,171 +1647,67 @@
|
|
|
1817
1647
|
"char": "i",
|
|
1818
1648
|
"name": "mcp-server-id",
|
|
1819
1649
|
"required": true,
|
|
1820
|
-
"summary": "ID of the MCP server to
|
|
1650
|
+
"summary": "ID of the MCP server to update.",
|
|
1821
1651
|
"hasDynamicHelp": false,
|
|
1822
1652
|
"multiple": false,
|
|
1823
1653
|
"type": "option"
|
|
1824
1654
|
},
|
|
1825
|
-
"
|
|
1826
|
-
"name": "
|
|
1827
|
-
"summary": "
|
|
1828
|
-
"allowNo": false,
|
|
1829
|
-
"type": "boolean"
|
|
1830
|
-
}
|
|
1831
|
-
},
|
|
1832
|
-
"hasDynamicHelp": true,
|
|
1833
|
-
"hiddenAliases": [],
|
|
1834
|
-
"id": "agent:mcp:delete",
|
|
1835
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
1836
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1837
|
-
"pluginType": "core",
|
|
1838
|
-
"state": "preview",
|
|
1839
|
-
"strict": true,
|
|
1840
|
-
"summary": "Delete an MCP server from the API Catalog.",
|
|
1841
|
-
"enableJsonFlag": true,
|
|
1842
|
-
"isESM": true,
|
|
1843
|
-
"relativePath": [
|
|
1844
|
-
"lib",
|
|
1845
|
-
"commands",
|
|
1846
|
-
"agent",
|
|
1847
|
-
"mcp",
|
|
1848
|
-
"delete.js"
|
|
1849
|
-
],
|
|
1850
|
-
"aliasPermutations": [],
|
|
1851
|
-
"permutations": [
|
|
1852
|
-
"agent:mcp:delete",
|
|
1853
|
-
"mcp:agent:delete",
|
|
1854
|
-
"mcp:delete:agent",
|
|
1855
|
-
"agent:delete:mcp",
|
|
1856
|
-
"delete:agent:mcp",
|
|
1857
|
-
"delete:mcp:agent"
|
|
1858
|
-
]
|
|
1859
|
-
},
|
|
1860
|
-
"agent:mcp:fetch": {
|
|
1861
|
-
"aliases": [],
|
|
1862
|
-
"args": {},
|
|
1863
|
-
"description": "Performs a live fetch against the configured MCP server identified by its ID, returning the assets (MCP tools, prompts, and resources) it currently advertises along with their status and activation state. Use this to refresh the view of what an MCP server exposes before activating its assets as agent actions.",
|
|
1864
|
-
"examples": [
|
|
1865
|
-
"Fetch the assets advertised by an MCP server in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001",
|
|
1866
|
-
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
1867
|
-
],
|
|
1868
|
-
"flags": {
|
|
1869
|
-
"json": {
|
|
1870
|
-
"description": "Format output as json.",
|
|
1871
|
-
"helpGroup": "GLOBAL",
|
|
1872
|
-
"name": "json",
|
|
1873
|
-
"allowNo": false,
|
|
1874
|
-
"type": "boolean"
|
|
1875
|
-
},
|
|
1876
|
-
"flags-dir": {
|
|
1877
|
-
"helpGroup": "GLOBAL",
|
|
1878
|
-
"name": "flags-dir",
|
|
1879
|
-
"summary": "Import flag values from a directory.",
|
|
1655
|
+
"label": {
|
|
1656
|
+
"name": "label",
|
|
1657
|
+
"summary": "New display label for the MCP server.",
|
|
1880
1658
|
"hasDynamicHelp": false,
|
|
1881
1659
|
"multiple": false,
|
|
1882
1660
|
"type": "option"
|
|
1883
1661
|
},
|
|
1884
|
-
"
|
|
1885
|
-
"
|
|
1886
|
-
"
|
|
1887
|
-
"
|
|
1888
|
-
"required": true,
|
|
1889
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1890
|
-
"hasDynamicHelp": true,
|
|
1662
|
+
"description": {
|
|
1663
|
+
"name": "description",
|
|
1664
|
+
"summary": "New description for the MCP server.",
|
|
1665
|
+
"hasDynamicHelp": false,
|
|
1891
1666
|
"multiple": false,
|
|
1892
1667
|
"type": "option"
|
|
1893
1668
|
},
|
|
1894
|
-
"
|
|
1895
|
-
"
|
|
1896
|
-
"
|
|
1669
|
+
"server-url": {
|
|
1670
|
+
"name": "server-url",
|
|
1671
|
+
"summary": "New endpoint URL of the MCP server.",
|
|
1897
1672
|
"hasDynamicHelp": false,
|
|
1898
1673
|
"multiple": false,
|
|
1899
1674
|
"type": "option"
|
|
1900
1675
|
},
|
|
1901
|
-
"
|
|
1902
|
-
"
|
|
1903
|
-
"
|
|
1904
|
-
"required": true,
|
|
1905
|
-
"summary": "ID of the MCP server to fetch assets from.",
|
|
1676
|
+
"auth-type": {
|
|
1677
|
+
"name": "auth-type",
|
|
1678
|
+
"summary": "Authorization type to apply to the MCP server (OAUTH or NO_AUTH).",
|
|
1906
1679
|
"hasDynamicHelp": false,
|
|
1907
1680
|
"multiple": false,
|
|
1681
|
+
"options": [
|
|
1682
|
+
"OAUTH",
|
|
1683
|
+
"NO_AUTH"
|
|
1684
|
+
],
|
|
1908
1685
|
"type": "option"
|
|
1909
|
-
}
|
|
1910
|
-
},
|
|
1911
|
-
"hasDynamicHelp": true,
|
|
1912
|
-
"hiddenAliases": [],
|
|
1913
|
-
"id": "agent:mcp:fetch",
|
|
1914
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
1915
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1916
|
-
"pluginType": "core",
|
|
1917
|
-
"state": "preview",
|
|
1918
|
-
"strict": true,
|
|
1919
|
-
"summary": "Fetch the live assets (tools, prompts, resources) advertised by an MCP server.",
|
|
1920
|
-
"enableJsonFlag": true,
|
|
1921
|
-
"isESM": true,
|
|
1922
|
-
"relativePath": [
|
|
1923
|
-
"lib",
|
|
1924
|
-
"commands",
|
|
1925
|
-
"agent",
|
|
1926
|
-
"mcp",
|
|
1927
|
-
"fetch.js"
|
|
1928
|
-
],
|
|
1929
|
-
"aliasPermutations": [],
|
|
1930
|
-
"permutations": [
|
|
1931
|
-
"agent:mcp:fetch",
|
|
1932
|
-
"mcp:agent:fetch",
|
|
1933
|
-
"mcp:fetch:agent",
|
|
1934
|
-
"agent:fetch:mcp",
|
|
1935
|
-
"fetch:agent:mcp",
|
|
1936
|
-
"fetch:mcp:agent"
|
|
1937
|
-
]
|
|
1938
|
-
},
|
|
1939
|
-
"agent:mcp:get": {
|
|
1940
|
-
"aliases": [],
|
|
1941
|
-
"args": {},
|
|
1942
|
-
"description": "Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.",
|
|
1943
|
-
"examples": [
|
|
1944
|
-
"Get an MCP server by id in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001",
|
|
1945
|
-
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
1946
|
-
],
|
|
1947
|
-
"flags": {
|
|
1948
|
-
"json": {
|
|
1949
|
-
"description": "Format output as json.",
|
|
1950
|
-
"helpGroup": "GLOBAL",
|
|
1951
|
-
"name": "json",
|
|
1952
|
-
"allowNo": false,
|
|
1953
|
-
"type": "boolean"
|
|
1954
1686
|
},
|
|
1955
|
-
"
|
|
1956
|
-
"
|
|
1957
|
-
"
|
|
1958
|
-
"summary": "Import flag values from a directory.",
|
|
1687
|
+
"identity-provider": {
|
|
1688
|
+
"name": "identity-provider",
|
|
1689
|
+
"summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
|
|
1959
1690
|
"hasDynamicHelp": false,
|
|
1960
1691
|
"multiple": false,
|
|
1961
1692
|
"type": "option"
|
|
1962
1693
|
},
|
|
1963
|
-
"
|
|
1964
|
-
"
|
|
1965
|
-
"
|
|
1966
|
-
"
|
|
1967
|
-
"required": true,
|
|
1968
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1969
|
-
"hasDynamicHelp": true,
|
|
1694
|
+
"client-id": {
|
|
1695
|
+
"name": "client-id",
|
|
1696
|
+
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
1697
|
+
"hasDynamicHelp": false,
|
|
1970
1698
|
"multiple": false,
|
|
1971
1699
|
"type": "option"
|
|
1972
1700
|
},
|
|
1973
|
-
"
|
|
1974
|
-
"
|
|
1975
|
-
"
|
|
1701
|
+
"client-secret": {
|
|
1702
|
+
"name": "client-secret",
|
|
1703
|
+
"summary": "OAuth client secret (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
1976
1704
|
"hasDynamicHelp": false,
|
|
1977
1705
|
"multiple": false,
|
|
1978
1706
|
"type": "option"
|
|
1979
1707
|
},
|
|
1980
|
-
"
|
|
1981
|
-
"
|
|
1982
|
-
"
|
|
1983
|
-
"required": true,
|
|
1984
|
-
"summary": "The identifier of the MCP server to retrieve.",
|
|
1708
|
+
"scope": {
|
|
1709
|
+
"name": "scope",
|
|
1710
|
+
"summary": "OAuth scope (required when --auth-type is OAUTH).",
|
|
1985
1711
|
"hasDynamicHelp": false,
|
|
1986
1712
|
"multiple": false,
|
|
1987
1713
|
"type": "option"
|
|
@@ -1989,13 +1715,13 @@
|
|
|
1989
1715
|
},
|
|
1990
1716
|
"hasDynamicHelp": true,
|
|
1991
1717
|
"hiddenAliases": [],
|
|
1992
|
-
"id": "agent:mcp:
|
|
1718
|
+
"id": "agent:mcp:update",
|
|
1993
1719
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1994
1720
|
"pluginName": "@salesforce/plugin-agent",
|
|
1995
1721
|
"pluginType": "core",
|
|
1996
1722
|
"state": "preview",
|
|
1997
1723
|
"strict": true,
|
|
1998
|
-
"summary": "
|
|
1724
|
+
"summary": "Update an MCP server registered in the API Catalog.",
|
|
1999
1725
|
"enableJsonFlag": true,
|
|
2000
1726
|
"isESM": true,
|
|
2001
1727
|
"relativePath": [
|
|
@@ -2003,25 +1729,28 @@
|
|
|
2003
1729
|
"commands",
|
|
2004
1730
|
"agent",
|
|
2005
1731
|
"mcp",
|
|
2006
|
-
"
|
|
1732
|
+
"update.js"
|
|
2007
1733
|
],
|
|
2008
1734
|
"aliasPermutations": [],
|
|
2009
1735
|
"permutations": [
|
|
2010
|
-
"agent:mcp:
|
|
2011
|
-
"mcp:agent:
|
|
2012
|
-
"mcp:
|
|
2013
|
-
"agent:
|
|
2014
|
-
"
|
|
2015
|
-
"
|
|
1736
|
+
"agent:mcp:update",
|
|
1737
|
+
"mcp:agent:update",
|
|
1738
|
+
"mcp:update:agent",
|
|
1739
|
+
"agent:update:mcp",
|
|
1740
|
+
"update:agent:mcp",
|
|
1741
|
+
"update:mcp:agent"
|
|
2016
1742
|
]
|
|
2017
1743
|
},
|
|
2018
|
-
"agent:
|
|
1744
|
+
"agent:generate:agent-spec": {
|
|
2019
1745
|
"aliases": [],
|
|
2020
1746
|
"args": {},
|
|
2021
|
-
"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.)",
|
|
2022
1748
|
"examples": [
|
|
2023
|
-
"
|
|
2024
|
-
"
|
|
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"
|
|
2025
1754
|
],
|
|
2026
1755
|
"flags": {
|
|
2027
1756
|
"json": {
|
|
@@ -2056,260 +1785,20 @@
|
|
|
2056
1785
|
"multiple": false,
|
|
2057
1786
|
"type": "option"
|
|
2058
1787
|
},
|
|
2059
|
-
"label": {
|
|
2060
|
-
"name": "label",
|
|
2061
|
-
"summary": "Filter the MCP servers by label.",
|
|
2062
|
-
"hasDynamicHelp": false,
|
|
2063
|
-
"multiple": false,
|
|
2064
|
-
"type": "option"
|
|
2065
|
-
},
|
|
2066
1788
|
"type": {
|
|
2067
1789
|
"name": "type",
|
|
2068
|
-
"summary": "
|
|
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.",
|
|
2069
1791
|
"hasDynamicHelp": false,
|
|
2070
1792
|
"multiple": false,
|
|
2071
1793
|
"options": [
|
|
2072
|
-
"
|
|
1794
|
+
"customer",
|
|
1795
|
+
"internal"
|
|
2073
1796
|
],
|
|
2074
1797
|
"type": "option"
|
|
2075
1798
|
},
|
|
2076
|
-
"
|
|
2077
|
-
"name": "
|
|
2078
|
-
"summary": "
|
|
2079
|
-
"hasDynamicHelp": false,
|
|
2080
|
-
"multiple": false,
|
|
2081
|
-
"options": [
|
|
2082
|
-
"ACTIVE",
|
|
2083
|
-
"DISCONNECTED"
|
|
2084
|
-
],
|
|
2085
|
-
"type": "option"
|
|
2086
|
-
}
|
|
2087
|
-
},
|
|
2088
|
-
"hasDynamicHelp": true,
|
|
2089
|
-
"hiddenAliases": [],
|
|
2090
|
-
"id": "agent:mcp:list",
|
|
2091
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
2092
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
2093
|
-
"pluginType": "core",
|
|
2094
|
-
"state": "preview",
|
|
2095
|
-
"strict": true,
|
|
2096
|
-
"summary": "List the MCP servers registered in the API Catalog.",
|
|
2097
|
-
"enableJsonFlag": true,
|
|
2098
|
-
"isESM": true,
|
|
2099
|
-
"relativePath": [
|
|
2100
|
-
"lib",
|
|
2101
|
-
"commands",
|
|
2102
|
-
"agent",
|
|
2103
|
-
"mcp",
|
|
2104
|
-
"list.js"
|
|
2105
|
-
],
|
|
2106
|
-
"aliasPermutations": [],
|
|
2107
|
-
"permutations": [
|
|
2108
|
-
"agent:mcp:list",
|
|
2109
|
-
"mcp:agent:list",
|
|
2110
|
-
"mcp:list:agent",
|
|
2111
|
-
"agent:list:mcp",
|
|
2112
|
-
"list:agent:mcp",
|
|
2113
|
-
"list:mcp:agent"
|
|
2114
|
-
]
|
|
2115
|
-
},
|
|
2116
|
-
"agent:mcp:update": {
|
|
2117
|
-
"aliases": [],
|
|
2118
|
-
"args": {},
|
|
2119
|
-
"description": "Updates an existing MCP server in the API Catalog. Only the fields you provide are changed; omitted fields are left untouched. You can update the label, description, and server URL, and replace the authorization configuration. When setting `--auth-type OAUTH`, you must also provide `--identity-provider`, `--client-id`, `--client-secret`, and `--scope`. When setting `--auth-type NO_AUTH`, no authorization credentials are required. At least one updatable field must be supplied.",
|
|
2120
|
-
"examples": [
|
|
2121
|
-
"Update the label and description of an MCP server in the default target org:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --label \"Orders MCP\" --description \"Order tooling\" --target-org myOrg",
|
|
2122
|
-
"Update the server URL and switch the authorization to OAuth, piping the client secret from stdin and outputting as JSON:\ncat secret.txt | <%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --server-url https://mcp.example.com --auth-type OAUTH --identity-provider MyIdp --client-id abc --client-secret - --scope \"read write\" --target-org myOrg --json"
|
|
2123
|
-
],
|
|
2124
|
-
"flags": {
|
|
2125
|
-
"json": {
|
|
2126
|
-
"description": "Format output as json.",
|
|
2127
|
-
"helpGroup": "GLOBAL",
|
|
2128
|
-
"name": "json",
|
|
2129
|
-
"allowNo": false,
|
|
2130
|
-
"type": "boolean"
|
|
2131
|
-
},
|
|
2132
|
-
"flags-dir": {
|
|
2133
|
-
"helpGroup": "GLOBAL",
|
|
2134
|
-
"name": "flags-dir",
|
|
2135
|
-
"summary": "Import flag values from a directory.",
|
|
2136
|
-
"hasDynamicHelp": false,
|
|
2137
|
-
"multiple": false,
|
|
2138
|
-
"type": "option"
|
|
2139
|
-
},
|
|
2140
|
-
"target-org": {
|
|
2141
|
-
"char": "o",
|
|
2142
|
-
"name": "target-org",
|
|
2143
|
-
"noCacheDefault": true,
|
|
2144
|
-
"required": true,
|
|
2145
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2146
|
-
"hasDynamicHelp": true,
|
|
2147
|
-
"multiple": false,
|
|
2148
|
-
"type": "option"
|
|
2149
|
-
},
|
|
2150
|
-
"api-version": {
|
|
2151
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2152
|
-
"name": "api-version",
|
|
2153
|
-
"hasDynamicHelp": false,
|
|
2154
|
-
"multiple": false,
|
|
2155
|
-
"type": "option"
|
|
2156
|
-
},
|
|
2157
|
-
"mcp-server-id": {
|
|
2158
|
-
"char": "i",
|
|
2159
|
-
"name": "mcp-server-id",
|
|
2160
|
-
"required": true,
|
|
2161
|
-
"summary": "ID of the MCP server to update.",
|
|
2162
|
-
"hasDynamicHelp": false,
|
|
2163
|
-
"multiple": false,
|
|
2164
|
-
"type": "option"
|
|
2165
|
-
},
|
|
2166
|
-
"label": {
|
|
2167
|
-
"name": "label",
|
|
2168
|
-
"summary": "New display label for the MCP server.",
|
|
2169
|
-
"hasDynamicHelp": false,
|
|
2170
|
-
"multiple": false,
|
|
2171
|
-
"type": "option"
|
|
2172
|
-
},
|
|
2173
|
-
"description": {
|
|
2174
|
-
"name": "description",
|
|
2175
|
-
"summary": "New description for the MCP server.",
|
|
2176
|
-
"hasDynamicHelp": false,
|
|
2177
|
-
"multiple": false,
|
|
2178
|
-
"type": "option"
|
|
2179
|
-
},
|
|
2180
|
-
"server-url": {
|
|
2181
|
-
"name": "server-url",
|
|
2182
|
-
"summary": "New endpoint URL of the MCP server.",
|
|
2183
|
-
"hasDynamicHelp": false,
|
|
2184
|
-
"multiple": false,
|
|
2185
|
-
"type": "option"
|
|
2186
|
-
},
|
|
2187
|
-
"auth-type": {
|
|
2188
|
-
"name": "auth-type",
|
|
2189
|
-
"summary": "Authorization type to apply to the MCP server (OAUTH or NO_AUTH).",
|
|
2190
|
-
"hasDynamicHelp": false,
|
|
2191
|
-
"multiple": false,
|
|
2192
|
-
"options": [
|
|
2193
|
-
"OAUTH",
|
|
2194
|
-
"NO_AUTH"
|
|
2195
|
-
],
|
|
2196
|
-
"type": "option"
|
|
2197
|
-
},
|
|
2198
|
-
"identity-provider": {
|
|
2199
|
-
"name": "identity-provider",
|
|
2200
|
-
"summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
|
|
2201
|
-
"hasDynamicHelp": false,
|
|
2202
|
-
"multiple": false,
|
|
2203
|
-
"type": "option"
|
|
2204
|
-
},
|
|
2205
|
-
"client-id": {
|
|
2206
|
-
"name": "client-id",
|
|
2207
|
-
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
2208
|
-
"hasDynamicHelp": false,
|
|
2209
|
-
"multiple": false,
|
|
2210
|
-
"type": "option"
|
|
2211
|
-
},
|
|
2212
|
-
"client-secret": {
|
|
2213
|
-
"name": "client-secret",
|
|
2214
|
-
"summary": "OAuth client secret (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
2215
|
-
"hasDynamicHelp": false,
|
|
2216
|
-
"multiple": false,
|
|
2217
|
-
"type": "option"
|
|
2218
|
-
},
|
|
2219
|
-
"scope": {
|
|
2220
|
-
"name": "scope",
|
|
2221
|
-
"summary": "OAuth scope (required when --auth-type is OAUTH).",
|
|
2222
|
-
"hasDynamicHelp": false,
|
|
2223
|
-
"multiple": false,
|
|
2224
|
-
"type": "option"
|
|
2225
|
-
}
|
|
2226
|
-
},
|
|
2227
|
-
"hasDynamicHelp": true,
|
|
2228
|
-
"hiddenAliases": [],
|
|
2229
|
-
"id": "agent:mcp:update",
|
|
2230
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
2231
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
2232
|
-
"pluginType": "core",
|
|
2233
|
-
"state": "preview",
|
|
2234
|
-
"strict": true,
|
|
2235
|
-
"summary": "Update an MCP server registered in the API Catalog.",
|
|
2236
|
-
"enableJsonFlag": true,
|
|
2237
|
-
"isESM": true,
|
|
2238
|
-
"relativePath": [
|
|
2239
|
-
"lib",
|
|
2240
|
-
"commands",
|
|
2241
|
-
"agent",
|
|
2242
|
-
"mcp",
|
|
2243
|
-
"update.js"
|
|
2244
|
-
],
|
|
2245
|
-
"aliasPermutations": [],
|
|
2246
|
-
"permutations": [
|
|
2247
|
-
"agent:mcp:update",
|
|
2248
|
-
"mcp:agent:update",
|
|
2249
|
-
"mcp:update:agent",
|
|
2250
|
-
"agent:update:mcp",
|
|
2251
|
-
"update:agent:mcp",
|
|
2252
|
-
"update:mcp:agent"
|
|
2253
|
-
]
|
|
2254
|
-
},
|
|
2255
|
-
"agent:generate:agent-spec": {
|
|
2256
|
-
"aliases": [],
|
|
2257
|
-
"args": {},
|
|
2258
|
-
"description": "An agent spec is a YAML-formatted file that contains basic information about the agent, such as its role, company description, and an AI-generated list of topics based on this information. Topics define the range of jobs your agent can handle.\n\nUse flags, such as --role and --company-description, to provide details about your company and the role that the agent plays in your company. If you prefer, you can also be prompted for the basic information; use --full-interview to be prompted for all required and optional properties. Upon command execution, the large language model (LLM) associated with your org uses the provided information to generate a list of topics for the agent. Because the LLM uses the company and role information to generate the topics, we recommend that you provide accurate, complete, and specific details so the LLM generates the best and most relevant topics. Once generated, you can edit the spec file; for example, you can remove topics that don't apply or change a topic's description.\n\nYou can also iterate the spec generation process by using the --spec flag to pass an existing agent spec file to this command, and then using the --role, --company-description, etc, flags to refine your agent properties. Iteratively improving the description of your agent allows the LLM to generate progressively better topics.\n\nYou can also specify other agent properties, such as a custom prompt template, how to ground the prompt template to add context to the agent's prompts, the tone of the prompts, and the username of a user in the org to assign to the agent.\n\nWhen your agent spec is ready, generate an authoring bundle from it by passing the spec file to the --spec flag of the \"agent generate authoring-bundle\" CLI command. An authoring bundle is a metadata type that contains an Agent Script file, which is the blueprint for an agent. (While not recommended, you can also use the agent spec file to immediately create an agent with the \"agent create\" command. We don't recommend this workflow because these types of agents don't use Agent Script, and are thus less flexible and more difficult to maintain.)",
|
|
2259
|
-
"examples": [
|
|
2260
|
-
"Generate an agent spec in the default location and use flags to specify the agent properties, such as its role and your company details; use your default org:\n<%= config.bin %> <%= command.id %> --type customer --role \"Field customer complaints and manage employee schedules.\" --company-name \"Coral Cloud Resorts\" --company-description \"Provide customers with exceptional destination activities, unforgettable experiences, and reservation services.\"",
|
|
2261
|
-
"Generate an agent spec by being prompted for the required agent properties and generate a maxiumum of 5 topics; write the generated file to the \"specs/resortManagerSpec.yaml\" file and use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --max-topics 5 --output-file specs/resortManagerAgent.yaml --target-org my-org",
|
|
2262
|
-
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
2263
|
-
"Specify an existing agent spec file called \"specs/resortManagerAgent.yaml\", and then overwrite it with a new version that contains newly AI-generated topics based on the updated role information passed in with the --role flag:\n<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role \"Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly\"",
|
|
2264
|
-
"Specify that the conversational tone of the agent is formal and to attach the \"resortmanager@myorg.com\" username to it; be prompted for the required properties and use your default org:\n<%= config.bin %> <%= command.id %> --tone formal --agent-user resortmanager@myorg.com"
|
|
2265
|
-
],
|
|
2266
|
-
"flags": {
|
|
2267
|
-
"json": {
|
|
2268
|
-
"description": "Format output as json.",
|
|
2269
|
-
"helpGroup": "GLOBAL",
|
|
2270
|
-
"name": "json",
|
|
2271
|
-
"allowNo": false,
|
|
2272
|
-
"type": "boolean"
|
|
2273
|
-
},
|
|
2274
|
-
"flags-dir": {
|
|
2275
|
-
"helpGroup": "GLOBAL",
|
|
2276
|
-
"name": "flags-dir",
|
|
2277
|
-
"summary": "Import flag values from a directory.",
|
|
2278
|
-
"hasDynamicHelp": false,
|
|
2279
|
-
"multiple": false,
|
|
2280
|
-
"type": "option"
|
|
2281
|
-
},
|
|
2282
|
-
"target-org": {
|
|
2283
|
-
"char": "o",
|
|
2284
|
-
"name": "target-org",
|
|
2285
|
-
"noCacheDefault": true,
|
|
2286
|
-
"required": true,
|
|
2287
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2288
|
-
"hasDynamicHelp": true,
|
|
2289
|
-
"multiple": false,
|
|
2290
|
-
"type": "option"
|
|
2291
|
-
},
|
|
2292
|
-
"api-version": {
|
|
2293
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2294
|
-
"name": "api-version",
|
|
2295
|
-
"hasDynamicHelp": false,
|
|
2296
|
-
"multiple": false,
|
|
2297
|
-
"type": "option"
|
|
2298
|
-
},
|
|
2299
|
-
"type": {
|
|
2300
|
-
"name": "type",
|
|
2301
|
-
"summary": "Type of agent to create. Internal types are copilots used internally by your company and customer types are the agents you create for your customers.",
|
|
2302
|
-
"hasDynamicHelp": false,
|
|
2303
|
-
"multiple": false,
|
|
2304
|
-
"options": [
|
|
2305
|
-
"customer",
|
|
2306
|
-
"internal"
|
|
2307
|
-
],
|
|
2308
|
-
"type": "option"
|
|
2309
|
-
},
|
|
2310
|
-
"role": {
|
|
2311
|
-
"name": "role",
|
|
2312
|
-
"summary": "Role of the agent.",
|
|
1799
|
+
"role": {
|
|
1800
|
+
"name": "role",
|
|
1801
|
+
"summary": "Role of the agent.",
|
|
2313
1802
|
"hasDynamicHelp": false,
|
|
2314
1803
|
"multiple": false,
|
|
2315
1804
|
"type": "option"
|
|
@@ -2736,6 +2225,517 @@
|
|
|
2736
2225
|
"test-spec:generate:agent"
|
|
2737
2226
|
]
|
|
2738
2227
|
},
|
|
2228
|
+
"agent:preview:end": {
|
|
2229
|
+
"aliases": [],
|
|
2230
|
+
"args": {},
|
|
2231
|
+
"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.",
|
|
2232
|
+
"examples": [
|
|
2233
|
+
"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",
|
|
2234
|
+
"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",
|
|
2235
|
+
"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",
|
|
2236
|
+
"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",
|
|
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>"
|
|
2238
|
+
],
|
|
2239
|
+
"flags": {
|
|
2240
|
+
"json": {
|
|
2241
|
+
"description": "Format output as json.",
|
|
2242
|
+
"helpGroup": "GLOBAL",
|
|
2243
|
+
"name": "json",
|
|
2244
|
+
"allowNo": false,
|
|
2245
|
+
"type": "boolean"
|
|
2246
|
+
},
|
|
2247
|
+
"flags-dir": {
|
|
2248
|
+
"helpGroup": "GLOBAL",
|
|
2249
|
+
"name": "flags-dir",
|
|
2250
|
+
"summary": "Import flag values from a directory.",
|
|
2251
|
+
"hasDynamicHelp": false,
|
|
2252
|
+
"multiple": false,
|
|
2253
|
+
"type": "option"
|
|
2254
|
+
},
|
|
2255
|
+
"target-org": {
|
|
2256
|
+
"char": "o",
|
|
2257
|
+
"name": "target-org",
|
|
2258
|
+
"noCacheDefault": true,
|
|
2259
|
+
"required": true,
|
|
2260
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2261
|
+
"hasDynamicHelp": true,
|
|
2262
|
+
"multiple": false,
|
|
2263
|
+
"type": "option"
|
|
2264
|
+
},
|
|
2265
|
+
"api-version": {
|
|
2266
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2267
|
+
"name": "api-version",
|
|
2268
|
+
"hasDynamicHelp": false,
|
|
2269
|
+
"multiple": false,
|
|
2270
|
+
"type": "option"
|
|
2271
|
+
},
|
|
2272
|
+
"session-id": {
|
|
2273
|
+
"exclusive": [
|
|
2274
|
+
"all"
|
|
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.",
|
|
2310
|
+
"allowNo": false,
|
|
2311
|
+
"type": "boolean"
|
|
2312
|
+
},
|
|
2313
|
+
"no-prompt": {
|
|
2314
|
+
"char": "p",
|
|
2315
|
+
"name": "no-prompt",
|
|
2316
|
+
"summary": "Don't prompt for confirmation before ending sessions. Has an effect only when used with --all.",
|
|
2317
|
+
"allowNo": false,
|
|
2318
|
+
"type": "boolean"
|
|
2319
|
+
}
|
|
2320
|
+
},
|
|
2321
|
+
"hasDynamicHelp": true,
|
|
2322
|
+
"hiddenAliases": [],
|
|
2323
|
+
"id": "agent:preview:end",
|
|
2324
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
2325
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
2326
|
+
"pluginType": "core",
|
|
2327
|
+
"strict": true,
|
|
2328
|
+
"summary": "End an existing programmatic agent preview session and get trace location.",
|
|
2329
|
+
"enableJsonFlag": true,
|
|
2330
|
+
"requiresProject": true,
|
|
2331
|
+
"envVariablesSection": {
|
|
2332
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2333
|
+
"body": [
|
|
2334
|
+
{
|
|
2335
|
+
"name": "SF_TARGET_ORG",
|
|
2336
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2337
|
+
}
|
|
2338
|
+
]
|
|
2339
|
+
},
|
|
2340
|
+
"errorCodes": {
|
|
2341
|
+
"header": "ERROR CODES",
|
|
2342
|
+
"body": [
|
|
2343
|
+
{
|
|
2344
|
+
"name": "Succeeded (0)",
|
|
2345
|
+
"description": "Preview session ended successfully and traces saved."
|
|
2346
|
+
},
|
|
2347
|
+
{
|
|
2348
|
+
"name": "ExactlyOneRequired (2)",
|
|
2349
|
+
"description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
|
|
2350
|
+
},
|
|
2351
|
+
{
|
|
2352
|
+
"name": "NotFound (2)",
|
|
2353
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
2354
|
+
},
|
|
2355
|
+
{
|
|
2356
|
+
"name": "PreviewEndFailed (4)",
|
|
2357
|
+
"description": "Failed to end the preview session."
|
|
2358
|
+
},
|
|
2359
|
+
{
|
|
2360
|
+
"name": "PreviewEndPartialFailure (68)",
|
|
2361
|
+
"description": "With --all, one or more sessions failed to end while others succeeded."
|
|
2362
|
+
},
|
|
2363
|
+
{
|
|
2364
|
+
"name": "SessionAmbiguous (5)",
|
|
2365
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2366
|
+
}
|
|
2367
|
+
]
|
|
2368
|
+
},
|
|
2369
|
+
"isESM": true,
|
|
2370
|
+
"relativePath": [
|
|
2371
|
+
"lib",
|
|
2372
|
+
"commands",
|
|
2373
|
+
"agent",
|
|
2374
|
+
"preview",
|
|
2375
|
+
"end.js"
|
|
2376
|
+
],
|
|
2377
|
+
"aliasPermutations": [],
|
|
2378
|
+
"permutations": [
|
|
2379
|
+
"agent:preview:end",
|
|
2380
|
+
"preview:agent:end",
|
|
2381
|
+
"preview:end:agent",
|
|
2382
|
+
"agent:end:preview",
|
|
2383
|
+
"end:agent:preview",
|
|
2384
|
+
"end:preview:agent"
|
|
2385
|
+
]
|
|
2386
|
+
},
|
|
2387
|
+
"agent:preview:send": {
|
|
2388
|
+
"aliases": [],
|
|
2389
|
+
"args": {},
|
|
2390
|
+
"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.",
|
|
2391
|
+
"examples": [
|
|
2392
|
+
"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>",
|
|
2393
|
+
"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",
|
|
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"
|
|
2395
|
+
],
|
|
2396
|
+
"flags": {
|
|
2397
|
+
"json": {
|
|
2398
|
+
"description": "Format output as json.",
|
|
2399
|
+
"helpGroup": "GLOBAL",
|
|
2400
|
+
"name": "json",
|
|
2401
|
+
"allowNo": false,
|
|
2402
|
+
"type": "boolean"
|
|
2403
|
+
},
|
|
2404
|
+
"flags-dir": {
|
|
2405
|
+
"helpGroup": "GLOBAL",
|
|
2406
|
+
"name": "flags-dir",
|
|
2407
|
+
"summary": "Import flag values from a directory.",
|
|
2408
|
+
"hasDynamicHelp": false,
|
|
2409
|
+
"multiple": false,
|
|
2410
|
+
"type": "option"
|
|
2411
|
+
},
|
|
2412
|
+
"target-org": {
|
|
2413
|
+
"char": "o",
|
|
2414
|
+
"name": "target-org",
|
|
2415
|
+
"noCacheDefault": true,
|
|
2416
|
+
"required": true,
|
|
2417
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2418
|
+
"hasDynamicHelp": true,
|
|
2419
|
+
"multiple": false,
|
|
2420
|
+
"type": "option"
|
|
2421
|
+
},
|
|
2422
|
+
"api-version": {
|
|
2423
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2424
|
+
"name": "api-version",
|
|
2425
|
+
"hasDynamicHelp": false,
|
|
2426
|
+
"multiple": false,
|
|
2427
|
+
"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
|
+
}
|
|
2461
|
+
},
|
|
2462
|
+
"hasDynamicHelp": true,
|
|
2463
|
+
"hiddenAliases": [],
|
|
2464
|
+
"id": "agent:preview:send",
|
|
2465
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
2466
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
2467
|
+
"pluginType": "core",
|
|
2468
|
+
"strict": true,
|
|
2469
|
+
"summary": "Send a message to an existing agent preview session.",
|
|
2470
|
+
"enableJsonFlag": true,
|
|
2471
|
+
"requiresProject": true,
|
|
2472
|
+
"envVariablesSection": {
|
|
2473
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2474
|
+
"body": [
|
|
2475
|
+
{
|
|
2476
|
+
"name": "SF_TARGET_ORG",
|
|
2477
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2478
|
+
}
|
|
2479
|
+
]
|
|
2480
|
+
},
|
|
2481
|
+
"errorCodes": {
|
|
2482
|
+
"header": "ERROR CODES",
|
|
2483
|
+
"body": [
|
|
2484
|
+
{
|
|
2485
|
+
"name": "Succeeded (0)",
|
|
2486
|
+
"description": "Message sent successfully and agent response received."
|
|
2487
|
+
},
|
|
2488
|
+
{
|
|
2489
|
+
"name": "NotFound (2)",
|
|
2490
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
2491
|
+
},
|
|
2492
|
+
{
|
|
2493
|
+
"name": "PreviewSendFailed (4)",
|
|
2494
|
+
"description": "Failed to send message or receive response from the preview session."
|
|
2495
|
+
},
|
|
2496
|
+
{
|
|
2497
|
+
"name": "SessionAmbiguous (5)",
|
|
2498
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2499
|
+
}
|
|
2500
|
+
]
|
|
2501
|
+
},
|
|
2502
|
+
"isESM": true,
|
|
2503
|
+
"relativePath": [
|
|
2504
|
+
"lib",
|
|
2505
|
+
"commands",
|
|
2506
|
+
"agent",
|
|
2507
|
+
"preview",
|
|
2508
|
+
"send.js"
|
|
2509
|
+
],
|
|
2510
|
+
"aliasPermutations": [],
|
|
2511
|
+
"permutations": [
|
|
2512
|
+
"agent:preview:send",
|
|
2513
|
+
"preview:agent:send",
|
|
2514
|
+
"preview:send:agent",
|
|
2515
|
+
"agent:send:preview",
|
|
2516
|
+
"send:agent:preview",
|
|
2517
|
+
"send:preview:agent"
|
|
2518
|
+
]
|
|
2519
|
+
},
|
|
2520
|
+
"agent:preview:sessions": {
|
|
2521
|
+
"aliases": [],
|
|
2522
|
+
"args": {},
|
|
2523
|
+
"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.",
|
|
2524
|
+
"examples": [
|
|
2525
|
+
"List all cached agent preview sessions:\n<%= config.bin %> <%= command.id %>"
|
|
2526
|
+
],
|
|
2527
|
+
"flags": {
|
|
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"
|
|
2589
|
+
],
|
|
2590
|
+
"flags": {
|
|
2591
|
+
"json": {
|
|
2592
|
+
"description": "Format output as json.",
|
|
2593
|
+
"helpGroup": "GLOBAL",
|
|
2594
|
+
"name": "json",
|
|
2595
|
+
"allowNo": false,
|
|
2596
|
+
"type": "boolean"
|
|
2597
|
+
},
|
|
2598
|
+
"flags-dir": {
|
|
2599
|
+
"helpGroup": "GLOBAL",
|
|
2600
|
+
"name": "flags-dir",
|
|
2601
|
+
"summary": "Import flag values from a directory.",
|
|
2602
|
+
"hasDynamicHelp": false,
|
|
2603
|
+
"multiple": false,
|
|
2604
|
+
"type": "option"
|
|
2605
|
+
},
|
|
2606
|
+
"target-org": {
|
|
2607
|
+
"char": "o",
|
|
2608
|
+
"name": "target-org",
|
|
2609
|
+
"noCacheDefault": true,
|
|
2610
|
+
"required": true,
|
|
2611
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2612
|
+
"hasDynamicHelp": true,
|
|
2613
|
+
"multiple": false,
|
|
2614
|
+
"type": "option"
|
|
2615
|
+
},
|
|
2616
|
+
"api-version": {
|
|
2617
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2618
|
+
"name": "api-version",
|
|
2619
|
+
"hasDynamicHelp": false,
|
|
2620
|
+
"multiple": false,
|
|
2621
|
+
"type": "option"
|
|
2622
|
+
},
|
|
2623
|
+
"api-name": {
|
|
2624
|
+
"char": "n",
|
|
2625
|
+
"name": "api-name",
|
|
2626
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
2627
|
+
"hasDynamicHelp": false,
|
|
2628
|
+
"multiple": false,
|
|
2629
|
+
"type": "option"
|
|
2630
|
+
},
|
|
2631
|
+
"authoring-bundle": {
|
|
2632
|
+
"name": "authoring-bundle",
|
|
2633
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2634
|
+
"hasDynamicHelp": false,
|
|
2635
|
+
"multiple": false,
|
|
2636
|
+
"type": "option"
|
|
2637
|
+
},
|
|
2638
|
+
"use-live-actions": {
|
|
2639
|
+
"exclusive": [
|
|
2640
|
+
"simulate-actions"
|
|
2641
|
+
],
|
|
2642
|
+
"name": "use-live-actions",
|
|
2643
|
+
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
2644
|
+
"allowNo": false,
|
|
2645
|
+
"type": "boolean"
|
|
2646
|
+
},
|
|
2647
|
+
"simulate-actions": {
|
|
2648
|
+
"exclusive": [
|
|
2649
|
+
"use-live-actions"
|
|
2650
|
+
],
|
|
2651
|
+
"name": "simulate-actions",
|
|
2652
|
+
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
2653
|
+
"allowNo": false,
|
|
2654
|
+
"type": "boolean"
|
|
2655
|
+
},
|
|
2656
|
+
"context-variables": {
|
|
2657
|
+
"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.",
|
|
2658
|
+
"name": "context-variables",
|
|
2659
|
+
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
2660
|
+
"delimiter": ",",
|
|
2661
|
+
"hasDynamicHelp": false,
|
|
2662
|
+
"multiple": true,
|
|
2663
|
+
"type": "option"
|
|
2664
|
+
},
|
|
2665
|
+
"agent-json": {
|
|
2666
|
+
"dependsOn": [
|
|
2667
|
+
"authoring-bundle"
|
|
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.",
|
|
2672
|
+
"hasDynamicHelp": false,
|
|
2673
|
+
"multiple": false,
|
|
2674
|
+
"type": "option"
|
|
2675
|
+
}
|
|
2676
|
+
},
|
|
2677
|
+
"hasDynamicHelp": true,
|
|
2678
|
+
"hiddenAliases": [],
|
|
2679
|
+
"id": "agent:preview:start",
|
|
2680
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
2681
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
2682
|
+
"pluginType": "core",
|
|
2683
|
+
"strict": true,
|
|
2684
|
+
"summary": "Start a programmatic agent preview session.",
|
|
2685
|
+
"enableJsonFlag": true,
|
|
2686
|
+
"requiresProject": true,
|
|
2687
|
+
"envVariablesSection": {
|
|
2688
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2689
|
+
"body": [
|
|
2690
|
+
{
|
|
2691
|
+
"name": "SF_TARGET_ORG",
|
|
2692
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2693
|
+
}
|
|
2694
|
+
]
|
|
2695
|
+
},
|
|
2696
|
+
"errorCodes": {
|
|
2697
|
+
"header": "ERROR CODES",
|
|
2698
|
+
"body": [
|
|
2699
|
+
{
|
|
2700
|
+
"name": "Succeeded (0)",
|
|
2701
|
+
"description": "Preview session started successfully."
|
|
2702
|
+
},
|
|
2703
|
+
{
|
|
2704
|
+
"name": "Failed (1)",
|
|
2705
|
+
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
2706
|
+
},
|
|
2707
|
+
{
|
|
2708
|
+
"name": "NotFound (2)",
|
|
2709
|
+
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
2710
|
+
},
|
|
2711
|
+
{
|
|
2712
|
+
"name": "ServerError (3)",
|
|
2713
|
+
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
2714
|
+
},
|
|
2715
|
+
{
|
|
2716
|
+
"name": "PreviewStartFailed (4)",
|
|
2717
|
+
"description": "Preview session failed to start due to API or network errors."
|
|
2718
|
+
}
|
|
2719
|
+
]
|
|
2720
|
+
},
|
|
2721
|
+
"isESM": true,
|
|
2722
|
+
"relativePath": [
|
|
2723
|
+
"lib",
|
|
2724
|
+
"commands",
|
|
2725
|
+
"agent",
|
|
2726
|
+
"preview",
|
|
2727
|
+
"start.js"
|
|
2728
|
+
],
|
|
2729
|
+
"aliasPermutations": [],
|
|
2730
|
+
"permutations": [
|
|
2731
|
+
"agent:preview:start",
|
|
2732
|
+
"preview:agent:start",
|
|
2733
|
+
"preview:start:agent",
|
|
2734
|
+
"agent:start:preview",
|
|
2735
|
+
"start:agent:preview",
|
|
2736
|
+
"start:preview:agent"
|
|
2737
|
+
]
|
|
2738
|
+
},
|
|
2739
2739
|
"agent:publish:authoring-bundle": {
|
|
2740
2740
|
"aliases": [],
|
|
2741
2741
|
"args": {},
|
|
@@ -4667,5 +4667,5 @@
|
|
|
4667
4667
|
]
|
|
4668
4668
|
}
|
|
4669
4669
|
},
|
|
4670
|
-
"version": "2.0.
|
|
4670
|
+
"version": "2.0.3"
|
|
4671
4671
|
}
|