@salesforce/plugin-agent 2.0.3 → 2.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -41
- package/lib/commands/agent/test/resume.js +9 -6
- package/lib/commands/agent/test/resume.js.map +1 -1
- package/lib/commands/agent/test/run.js +9 -4
- package/lib/commands/agent/test/run.js.map +1 -1
- package/lib/testStages.js +4 -1
- package/lib/testStages.js.map +1 -1
- package/oclif.manifest.json +915 -915
- package/package.json +3 -3
package/oclif.manifest.json
CHANGED
|
@@ -1120,13 +1120,16 @@
|
|
|
1120
1120
|
"upload:adl:agent"
|
|
1121
1121
|
]
|
|
1122
1122
|
},
|
|
1123
|
-
"agent:
|
|
1123
|
+
"agent:generate:agent-spec": {
|
|
1124
1124
|
"aliases": [],
|
|
1125
1125
|
"args": {},
|
|
1126
|
-
"description": "
|
|
1126
|
+
"description": "An agent spec is a YAML-formatted file that contains basic information about the agent, such as its role, company description, and an AI-generated list of topics based on this information. Topics define the range of jobs your agent can handle.\n\nUse flags, such as --role and --company-description, to provide details about your company and the role that the agent plays in your company. If you prefer, you can also be prompted for the basic information; use --full-interview to be prompted for all required and optional properties. Upon command execution, the large language model (LLM) associated with your org uses the provided information to generate a list of topics for the agent. Because the LLM uses the company and role information to generate the topics, we recommend that you provide accurate, complete, and specific details so the LLM generates the best and most relevant topics. Once generated, you can edit the spec file; for example, you can remove topics that don't apply or change a topic's description.\n\nYou can also iterate the spec generation process by using the --spec flag to pass an existing agent spec file to this command, and then using the --role, --company-description, etc, flags to refine your agent properties. Iteratively improving the description of your agent allows the LLM to generate progressively better topics.\n\nYou can also specify other agent properties, such as a custom prompt template, how to ground the prompt template to add context to the agent's prompts, the tone of the prompts, and the username of a user in the org to assign to the agent.\n\nWhen your agent spec is ready, generate an authoring bundle from it by passing the spec file to the --spec flag of the \"agent generate authoring-bundle\" CLI command. An authoring bundle is a metadata type that contains an Agent Script file, which is the blueprint for an agent. (While not recommended, you can also use the agent spec file to immediately create an agent with the \"agent create\" command. We don't recommend this workflow because these types of agents don't use Agent Script, and are thus less flexible and more difficult to maintain.)",
|
|
1127
1127
|
"examples": [
|
|
1128
|
-
"
|
|
1129
|
-
"
|
|
1128
|
+
"Generate an agent spec in the default location and use flags to specify the agent properties, such as its role and your company details; use your default org:\n<%= config.bin %> <%= command.id %> --type customer --role \"Field customer complaints and manage employee schedules.\" --company-name \"Coral Cloud Resorts\" --company-description \"Provide customers with exceptional destination activities, unforgettable experiences, and reservation services.\"",
|
|
1129
|
+
"Generate an agent spec by being prompted for the required agent properties and generate a maxiumum of 5 topics; write the generated file to the \"specs/resortManagerSpec.yaml\" file and use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --max-topics 5 --output-file specs/resortManagerAgent.yaml --target-org my-org",
|
|
1130
|
+
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
1131
|
+
"Specify an existing agent spec file called \"specs/resortManagerAgent.yaml\", and then overwrite it with a new version that contains newly AI-generated topics based on the updated role information passed in with the --role flag:\n<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role \"Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly\"",
|
|
1132
|
+
"Specify that the conversational tone of the agent is formal and to attach the \"resortmanager@myorg.com\" username to it; be prompted for the required properties and use your default org:\n<%= config.bin %> <%= command.id %> --tone formal --agent-user resortmanager@myorg.com"
|
|
1130
1133
|
],
|
|
1131
1134
|
"flags": {
|
|
1132
1135
|
"json": {
|
|
@@ -1161,113 +1164,164 @@
|
|
|
1161
1164
|
"multiple": false,
|
|
1162
1165
|
"type": "option"
|
|
1163
1166
|
},
|
|
1164
|
-
"
|
|
1165
|
-
"
|
|
1166
|
-
"
|
|
1167
|
-
"required": true,
|
|
1168
|
-
"summary": "Unique name of the MCP server.",
|
|
1167
|
+
"type": {
|
|
1168
|
+
"name": "type",
|
|
1169
|
+
"summary": "Type of agent to create. Internal types are copilots used internally by your company and customer types are the agents you create for your customers.",
|
|
1169
1170
|
"hasDynamicHelp": false,
|
|
1170
1171
|
"multiple": false,
|
|
1172
|
+
"options": [
|
|
1173
|
+
"customer",
|
|
1174
|
+
"internal"
|
|
1175
|
+
],
|
|
1171
1176
|
"type": "option"
|
|
1172
1177
|
},
|
|
1173
|
-
"
|
|
1174
|
-
"name": "
|
|
1175
|
-
"summary": "
|
|
1178
|
+
"role": {
|
|
1179
|
+
"name": "role",
|
|
1180
|
+
"summary": "Role of the agent.",
|
|
1176
1181
|
"hasDynamicHelp": false,
|
|
1177
1182
|
"multiple": false,
|
|
1178
1183
|
"type": "option"
|
|
1179
1184
|
},
|
|
1180
|
-
"
|
|
1181
|
-
"name": "
|
|
1182
|
-
"summary": "
|
|
1185
|
+
"company-name": {
|
|
1186
|
+
"name": "company-name",
|
|
1187
|
+
"summary": "Name of your company.",
|
|
1183
1188
|
"hasDynamicHelp": false,
|
|
1184
1189
|
"multiple": false,
|
|
1185
1190
|
"type": "option"
|
|
1186
1191
|
},
|
|
1187
|
-
"
|
|
1188
|
-
"name": "
|
|
1189
|
-
"
|
|
1190
|
-
"summary": "URL of the external MCP server.",
|
|
1192
|
+
"company-description": {
|
|
1193
|
+
"name": "company-description",
|
|
1194
|
+
"summary": "Description of your company.",
|
|
1191
1195
|
"hasDynamicHelp": false,
|
|
1192
1196
|
"multiple": false,
|
|
1193
1197
|
"type": "option"
|
|
1194
1198
|
},
|
|
1195
|
-
"
|
|
1196
|
-
"name": "
|
|
1197
|
-
"summary": "
|
|
1198
|
-
"
|
|
1199
|
+
"company-website": {
|
|
1200
|
+
"name": "company-website",
|
|
1201
|
+
"summary": "Website URL of your company.",
|
|
1202
|
+
"hasDynamicHelp": false,
|
|
1203
|
+
"multiple": false,
|
|
1204
|
+
"type": "option"
|
|
1205
|
+
},
|
|
1206
|
+
"max-topics": {
|
|
1207
|
+
"name": "max-topics",
|
|
1208
|
+
"summary": "Maximum number of topics to generate in the agent spec; default is 5.",
|
|
1209
|
+
"hasDynamicHelp": false,
|
|
1210
|
+
"multiple": false,
|
|
1211
|
+
"type": "option"
|
|
1212
|
+
},
|
|
1213
|
+
"agent-user": {
|
|
1214
|
+
"name": "agent-user",
|
|
1215
|
+
"summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
|
|
1216
|
+
"hasDynamicHelp": false,
|
|
1217
|
+
"multiple": false,
|
|
1218
|
+
"type": "option"
|
|
1219
|
+
},
|
|
1220
|
+
"enrich-logs": {
|
|
1221
|
+
"name": "enrich-logs",
|
|
1222
|
+
"summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
|
|
1199
1223
|
"hasDynamicHelp": false,
|
|
1200
1224
|
"multiple": false,
|
|
1201
1225
|
"options": [
|
|
1202
|
-
"
|
|
1203
|
-
"
|
|
1226
|
+
"true",
|
|
1227
|
+
"false"
|
|
1204
1228
|
],
|
|
1205
1229
|
"type": "option"
|
|
1206
1230
|
},
|
|
1207
|
-
"
|
|
1208
|
-
"name": "
|
|
1209
|
-
"summary": "
|
|
1231
|
+
"tone": {
|
|
1232
|
+
"name": "tone",
|
|
1233
|
+
"summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
|
|
1210
1234
|
"hasDynamicHelp": false,
|
|
1211
1235
|
"multiple": false,
|
|
1236
|
+
"options": [
|
|
1237
|
+
"formal",
|
|
1238
|
+
"casual",
|
|
1239
|
+
"neutral"
|
|
1240
|
+
],
|
|
1212
1241
|
"type": "option"
|
|
1213
1242
|
},
|
|
1214
|
-
"
|
|
1215
|
-
"name": "
|
|
1216
|
-
"summary": "
|
|
1243
|
+
"spec": {
|
|
1244
|
+
"name": "spec",
|
|
1245
|
+
"summary": "Agent spec file, in YAML format, to use as input to the command.",
|
|
1217
1246
|
"hasDynamicHelp": false,
|
|
1218
1247
|
"multiple": false,
|
|
1219
1248
|
"type": "option"
|
|
1220
1249
|
},
|
|
1221
|
-
"
|
|
1222
|
-
"name": "
|
|
1223
|
-
"summary": "
|
|
1250
|
+
"output-file": {
|
|
1251
|
+
"name": "output-file",
|
|
1252
|
+
"summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
|
|
1253
|
+
"default": "specs/agentSpec.yaml",
|
|
1224
1254
|
"hasDynamicHelp": false,
|
|
1225
1255
|
"multiple": false,
|
|
1226
1256
|
"type": "option"
|
|
1227
1257
|
},
|
|
1228
|
-
"
|
|
1229
|
-
"name": "
|
|
1230
|
-
"summary": "
|
|
1258
|
+
"full-interview": {
|
|
1259
|
+
"name": "full-interview",
|
|
1260
|
+
"summary": "Prompt for both required and optional flags.",
|
|
1261
|
+
"allowNo": false,
|
|
1262
|
+
"type": "boolean"
|
|
1263
|
+
},
|
|
1264
|
+
"prompt-template": {
|
|
1265
|
+
"name": "prompt-template",
|
|
1266
|
+
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
1267
|
+
"hasDynamicHelp": false,
|
|
1268
|
+
"multiple": false,
|
|
1269
|
+
"type": "option"
|
|
1270
|
+
},
|
|
1271
|
+
"grounding-context": {
|
|
1272
|
+
"dependsOn": [
|
|
1273
|
+
"prompt-template"
|
|
1274
|
+
],
|
|
1275
|
+
"name": "grounding-context",
|
|
1276
|
+
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
1231
1277
|
"hasDynamicHelp": false,
|
|
1232
1278
|
"multiple": false,
|
|
1233
1279
|
"type": "option"
|
|
1280
|
+
},
|
|
1281
|
+
"force-overwrite": {
|
|
1282
|
+
"name": "force-overwrite",
|
|
1283
|
+
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
1284
|
+
"allowNo": false,
|
|
1285
|
+
"type": "boolean"
|
|
1234
1286
|
}
|
|
1235
1287
|
},
|
|
1236
1288
|
"hasDynamicHelp": true,
|
|
1237
1289
|
"hiddenAliases": [],
|
|
1238
|
-
"id": "agent:
|
|
1290
|
+
"id": "agent:generate:agent-spec",
|
|
1239
1291
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1240
1292
|
"pluginName": "@salesforce/plugin-agent",
|
|
1241
1293
|
"pluginType": "core",
|
|
1242
|
-
"state": "preview",
|
|
1243
1294
|
"strict": true,
|
|
1244
|
-
"summary": "
|
|
1295
|
+
"summary": "Generate an agent spec, which is a YAML file that captures what an agent can do.",
|
|
1245
1296
|
"enableJsonFlag": true,
|
|
1297
|
+
"requiresProject": true,
|
|
1246
1298
|
"isESM": true,
|
|
1247
1299
|
"relativePath": [
|
|
1248
1300
|
"lib",
|
|
1249
1301
|
"commands",
|
|
1250
1302
|
"agent",
|
|
1251
|
-
"
|
|
1252
|
-
"
|
|
1303
|
+
"generate",
|
|
1304
|
+
"agent-spec.js"
|
|
1253
1305
|
],
|
|
1254
1306
|
"aliasPermutations": [],
|
|
1255
1307
|
"permutations": [
|
|
1256
|
-
"agent:
|
|
1257
|
-
"
|
|
1258
|
-
"
|
|
1259
|
-
"agent:
|
|
1260
|
-
"
|
|
1261
|
-
"
|
|
1308
|
+
"agent:generate:agent-spec",
|
|
1309
|
+
"generate:agent:agent-spec",
|
|
1310
|
+
"generate:agent-spec:agent",
|
|
1311
|
+
"agent:agent-spec:generate",
|
|
1312
|
+
"agent-spec:agent:generate",
|
|
1313
|
+
"agent-spec:generate:agent"
|
|
1262
1314
|
]
|
|
1263
1315
|
},
|
|
1264
|
-
"agent:
|
|
1316
|
+
"agent:generate:authoring-bundle": {
|
|
1265
1317
|
"aliases": [],
|
|
1266
1318
|
"args": {},
|
|
1267
|
-
"description": "
|
|
1319
|
+
"description": "Authoring bundles are metadata components that contain an agent's Agent Script file. The Agent Script file is the agent's blueprint; it fully describes what the agent can do using the Agent Script language.\n\nUse this command to generate a new authoring bundle based on an agent spec YAML file, which you create with the \"agent generate agent-spec\" command. The agent spec YAML file is a high-level description of the agent; it describes its essence rather than exactly what it can do. The resulting Agent Script file is customized to reflect what's in the agent spec file. You can also create an authoring bundle without an agent spec file by specifying the \"--no-spec\" flag; in this case, the resulting Agent Script file is just the default boilerplate.\n\nThe metadata type for authoring bundles is aiAuthoringBundle, which consist of a standard \"<bundle-api-name>.bundle-meta.xml\" metadata file and the Agent Script file (with extension \".agent\"). When you run this command, the new authoring bundle is generated in the force-app/main/default/aiAuthoringBundles/<bundle-api-name> directory. Use the --output-dir flag to generate them elsewhere.\n\nAfter you generate the initial authoring bundle, code the Agent Script file so your agent behaves exactly as you want. The Agent Script file generated by this command is just a first draft of your agent! Interactively test the agent by conversing with it using the \"agent preview\" command. Then publish the agent to your org with the \"agent publish authoring-bundle\" command.\n\nThis command requires an org because it uses it to access an LLM for generating the Agent Script file.",
|
|
1268
1320
|
"examples": [
|
|
1269
|
-
"
|
|
1270
|
-
"
|
|
1321
|
+
"Generate an authoring bundle by being prompted for all required values, such as the agent spec YAML file, the bundle name, and the API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1322
|
+
"Generate an authoring bundle without using an agent spec file; give the bundle the label \"My Authoring Bundle\" and use your default org:\n<%= config.bin %> <%= command.id %> --no-spec --name \"My Authoring Bundle\"",
|
|
1323
|
+
"Generate an authoring bundle from the \"specs/agentSpec.yaml\" agent spec YAML file and give it the label \"My Authoring Bundle\"; use your default org:\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\"",
|
|
1324
|
+
"Similar to previous example, but generate the authoring bundle files in the \"other-package-dir/main/default\" package directory; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\" --output-dir other-package-dir/main/default --target-org my-dev-org"
|
|
1271
1325
|
],
|
|
1272
1326
|
"flags": {
|
|
1273
1327
|
"json": {
|
|
@@ -1295,6 +1349,13 @@
|
|
|
1295
1349
|
"multiple": false,
|
|
1296
1350
|
"type": "option"
|
|
1297
1351
|
},
|
|
1352
|
+
"api-name": {
|
|
1353
|
+
"name": "api-name",
|
|
1354
|
+
"summary": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name can't exist in the org.",
|
|
1355
|
+
"hasDynamicHelp": false,
|
|
1356
|
+
"multiple": false,
|
|
1357
|
+
"type": "option"
|
|
1358
|
+
},
|
|
1298
1359
|
"api-version": {
|
|
1299
1360
|
"description": "Override the api version used for api requests made by this command",
|
|
1300
1361
|
"name": "api-version",
|
|
@@ -1302,57 +1363,77 @@
|
|
|
1302
1363
|
"multiple": false,
|
|
1303
1364
|
"type": "option"
|
|
1304
1365
|
},
|
|
1305
|
-
"
|
|
1306
|
-
"char": "
|
|
1307
|
-
"name": "
|
|
1308
|
-
"
|
|
1309
|
-
"summary": "ID of the MCP server to delete.",
|
|
1366
|
+
"spec": {
|
|
1367
|
+
"char": "f",
|
|
1368
|
+
"name": "spec",
|
|
1369
|
+
"summary": "Path to the agent spec YAML file. If you don't specify the flag, the command provides a list that you can choose from. Use the --no-spec flag to skip using an agent spec entirely.",
|
|
1310
1370
|
"hasDynamicHelp": false,
|
|
1311
1371
|
"multiple": false,
|
|
1312
1372
|
"type": "option"
|
|
1313
1373
|
},
|
|
1314
|
-
"no-
|
|
1315
|
-
"name": "no-
|
|
1316
|
-
"summary": "Skip
|
|
1374
|
+
"no-spec": {
|
|
1375
|
+
"name": "no-spec",
|
|
1376
|
+
"summary": "Skip prompting for an agent spec and use the default Agent Script boilerplate in the generated authoring bundle.",
|
|
1377
|
+
"allowNo": false,
|
|
1378
|
+
"type": "boolean"
|
|
1379
|
+
},
|
|
1380
|
+
"output-dir": {
|
|
1381
|
+
"char": "d",
|
|
1382
|
+
"name": "output-dir",
|
|
1383
|
+
"summary": "Directory where the authoring bundle files are generated.",
|
|
1384
|
+
"hasDynamicHelp": false,
|
|
1385
|
+
"multiple": false,
|
|
1386
|
+
"type": "option"
|
|
1387
|
+
},
|
|
1388
|
+
"name": {
|
|
1389
|
+
"char": "n",
|
|
1390
|
+
"name": "name",
|
|
1391
|
+
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
1392
|
+
"hasDynamicHelp": false,
|
|
1393
|
+
"multiple": false,
|
|
1394
|
+
"type": "option"
|
|
1395
|
+
},
|
|
1396
|
+
"force-overwrite": {
|
|
1397
|
+
"name": "force-overwrite",
|
|
1398
|
+
"summary": "Overwrite the existing authoring bundle if one with the same API name already exists locally.",
|
|
1317
1399
|
"allowNo": false,
|
|
1318
1400
|
"type": "boolean"
|
|
1319
1401
|
}
|
|
1320
1402
|
},
|
|
1321
1403
|
"hasDynamicHelp": true,
|
|
1322
1404
|
"hiddenAliases": [],
|
|
1323
|
-
"id": "agent:
|
|
1405
|
+
"id": "agent:generate:authoring-bundle",
|
|
1324
1406
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1325
1407
|
"pluginName": "@salesforce/plugin-agent",
|
|
1326
1408
|
"pluginType": "core",
|
|
1327
|
-
"state": "preview",
|
|
1328
1409
|
"strict": true,
|
|
1329
|
-
"summary": "
|
|
1410
|
+
"summary": "Generate an authoring bundle from an existing agent spec YAML file.",
|
|
1330
1411
|
"enableJsonFlag": true,
|
|
1412
|
+
"requiresProject": true,
|
|
1331
1413
|
"isESM": true,
|
|
1332
1414
|
"relativePath": [
|
|
1333
1415
|
"lib",
|
|
1334
1416
|
"commands",
|
|
1335
1417
|
"agent",
|
|
1336
|
-
"
|
|
1337
|
-
"
|
|
1418
|
+
"generate",
|
|
1419
|
+
"authoring-bundle.js"
|
|
1338
1420
|
],
|
|
1339
1421
|
"aliasPermutations": [],
|
|
1340
1422
|
"permutations": [
|
|
1341
|
-
"agent:
|
|
1342
|
-
"
|
|
1343
|
-
"
|
|
1344
|
-
"agent:
|
|
1345
|
-
"
|
|
1346
|
-
"
|
|
1423
|
+
"agent:generate:authoring-bundle",
|
|
1424
|
+
"generate:agent:authoring-bundle",
|
|
1425
|
+
"generate:authoring-bundle:agent",
|
|
1426
|
+
"agent:authoring-bundle:generate",
|
|
1427
|
+
"authoring-bundle:agent:generate",
|
|
1428
|
+
"authoring-bundle:generate:agent"
|
|
1347
1429
|
]
|
|
1348
1430
|
},
|
|
1349
|
-
"agent:
|
|
1431
|
+
"agent:generate:template": {
|
|
1350
1432
|
"aliases": [],
|
|
1351
1433
|
"args": {},
|
|
1352
|
-
"description": "
|
|
1434
|
+
"description": "WARNING: This command doesn't work for agents that were created from an Agent Script file. In other words, you can't currently package an agent template for agents that use Agent Script.\n\nAt a high-level, agents are defined by the Bot, BotVersion, and GenAiPlannerBundle metadata types. The GenAiPlannerBundle type in turn defines the agent's topics and actions. This command uses the metadata files for these three types, located in your local DX project, to generate a BotTemplate metadata file for a specific agent (Bot). You then use the BotTemplate metadata file, along with the GenAiPlannerBundle metadata file that references the BotTemplate, to package the template in a managed package that you can share between orgs or on AppExchange.\n\nUse the --agent-file flag to specify the relative or full pathname of the Bot metadata file, such as force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml. A single Bot can have multiple BotVersions, so use the --agent-version flag to specify the version. The corresponding BotVersion metadata file must exist locally. For example, if you specify \"--agent-version 4\", then the file force-app/main/default/bots/My_Awesome_Agent/v4.botVersion-meta.xml must exist.\n\nThe new BotTemplate metadata file is generated in the \"botTemplates\" directory in the output directory specified with the --output-dir flag, and has the name <Agent_API_name>\\_v<Version>\\_Template.botTemplate-meta.xml, such as my-package/botTemplates/My_Awesome_Agent_v4_Template.botTemplate-meta.xml. The command displays the full pathname of the generated files when it completes.\n\nSee \"Develop and Package Agent Templates Using Scratch Orgs\" (https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/dev2gp_package_agent_templates.htm) for details about the complete process, which includes using a scratch org to create and test the agent, retrieving the agent metadata to your DX project, running this command to create the agent template, and then packaging the template.",
|
|
1353
1435
|
"examples": [
|
|
1354
|
-
"
|
|
1355
|
-
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
1436
|
+
"Generate an agent template from the My_Awesome_Agent Bot metadata file in your DX project and save the BotTemplate and GenAiPlannerBundle to the specified directory; use version 1 of the agent. The agent that the template is based on is in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --agent-file force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1 --output-dir my-package --source-org my-scratch-org"
|
|
1356
1437
|
],
|
|
1357
1438
|
"flags": {
|
|
1358
1439
|
"json": {
|
|
@@ -1370,16 +1451,6 @@
|
|
|
1370
1451
|
"multiple": false,
|
|
1371
1452
|
"type": "option"
|
|
1372
1453
|
},
|
|
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
1454
|
"api-version": {
|
|
1384
1455
|
"description": "Override the api version used for api requests made by this command",
|
|
1385
1456
|
"name": "api-version",
|
|
@@ -1387,90 +1458,37 @@
|
|
|
1387
1458
|
"multiple": false,
|
|
1388
1459
|
"type": "option"
|
|
1389
1460
|
},
|
|
1390
|
-
"
|
|
1391
|
-
"char": "
|
|
1392
|
-
"name": "
|
|
1461
|
+
"source-org": {
|
|
1462
|
+
"char": "s",
|
|
1463
|
+
"name": "source-org",
|
|
1464
|
+
"noCacheDefault": true,
|
|
1393
1465
|
"required": true,
|
|
1394
|
-
"summary": "
|
|
1395
|
-
"hasDynamicHelp":
|
|
1466
|
+
"summary": "Username or alias of the namespaced scratch org that contains the agent which this template is based on.",
|
|
1467
|
+
"hasDynamicHelp": true,
|
|
1396
1468
|
"multiple": false,
|
|
1397
1469
|
"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
1470
|
},
|
|
1444
|
-
"
|
|
1445
|
-
"
|
|
1446
|
-
"
|
|
1447
|
-
"summary": "
|
|
1471
|
+
"agent-version": {
|
|
1472
|
+
"name": "agent-version",
|
|
1473
|
+
"required": true,
|
|
1474
|
+
"summary": "Version of the agent (BotVersion).",
|
|
1448
1475
|
"hasDynamicHelp": false,
|
|
1449
1476
|
"multiple": false,
|
|
1450
1477
|
"type": "option"
|
|
1451
1478
|
},
|
|
1452
|
-
"
|
|
1453
|
-
"char": "
|
|
1454
|
-
"name": "
|
|
1455
|
-
"noCacheDefault": true,
|
|
1479
|
+
"agent-file": {
|
|
1480
|
+
"char": "f",
|
|
1481
|
+
"name": "agent-file",
|
|
1456
1482
|
"required": true,
|
|
1457
|
-
"summary": "
|
|
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",
|
|
1483
|
+
"summary": "Path to an agent (Bot) metadata file.",
|
|
1465
1484
|
"hasDynamicHelp": false,
|
|
1466
1485
|
"multiple": false,
|
|
1467
1486
|
"type": "option"
|
|
1468
1487
|
},
|
|
1469
|
-
"
|
|
1470
|
-
"char": "
|
|
1471
|
-
"name": "
|
|
1472
|
-
"
|
|
1473
|
-
"summary": "The identifier of the MCP server to retrieve.",
|
|
1488
|
+
"output-dir": {
|
|
1489
|
+
"char": "r",
|
|
1490
|
+
"name": "output-dir",
|
|
1491
|
+
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
1474
1492
|
"hasDynamicHelp": false,
|
|
1475
1493
|
"multiple": false,
|
|
1476
1494
|
"type": "option"
|
|
@@ -1478,48 +1496,44 @@
|
|
|
1478
1496
|
},
|
|
1479
1497
|
"hasDynamicHelp": true,
|
|
1480
1498
|
"hiddenAliases": [],
|
|
1481
|
-
"id": "agent:
|
|
1499
|
+
"id": "agent:generate:template",
|
|
1482
1500
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1483
1501
|
"pluginName": "@salesforce/plugin-agent",
|
|
1484
1502
|
"pluginType": "core",
|
|
1485
|
-
"state": "preview",
|
|
1486
1503
|
"strict": true,
|
|
1487
|
-
"summary": "
|
|
1504
|
+
"summary": "Generate an agent template from an existing agent in your DX project so you can then package the template in a second-generation managed package.",
|
|
1488
1505
|
"enableJsonFlag": true,
|
|
1506
|
+
"requiresProject": true,
|
|
1489
1507
|
"isESM": true,
|
|
1490
1508
|
"relativePath": [
|
|
1491
1509
|
"lib",
|
|
1492
1510
|
"commands",
|
|
1493
1511
|
"agent",
|
|
1494
|
-
"
|
|
1495
|
-
"
|
|
1512
|
+
"generate",
|
|
1513
|
+
"template.js"
|
|
1496
1514
|
],
|
|
1497
1515
|
"aliasPermutations": [],
|
|
1498
1516
|
"permutations": [
|
|
1499
|
-
"agent:
|
|
1500
|
-
"
|
|
1501
|
-
"
|
|
1502
|
-
"agent:
|
|
1503
|
-
"
|
|
1504
|
-
"
|
|
1517
|
+
"agent:generate:template",
|
|
1518
|
+
"generate:agent:template",
|
|
1519
|
+
"generate:template:agent",
|
|
1520
|
+
"agent:template:generate",
|
|
1521
|
+
"template:agent:generate",
|
|
1522
|
+
"template:generate:agent"
|
|
1505
1523
|
]
|
|
1506
1524
|
},
|
|
1507
|
-
"agent:
|
|
1525
|
+
"agent:generate:test-spec": {
|
|
1508
1526
|
"aliases": [],
|
|
1509
1527
|
"args": {},
|
|
1510
|
-
"description": "
|
|
1528
|
+
"description": "The first step when using Salesforce CLI to create an agent test in your org is to use this interactive command to generate a local YAML-formatted test spec file. The test spec YAML file contains information about the agent being tested, such as its API name, and then one or more test cases. This command uses the metadata components in your DX project when prompting for information, such as the agent API name; it doesn't look in your org.\n\nTo generate a specific agent test case, this command prompts you for this information; when possible, the command provides a list of options for you to choose from:\n\n- Utterance: Natural language statement, question, or command used to test the agent.\n- Expected topic: API name of the topic you expect the agent to use when responding to the utterance.\n- Expected actions: One or more API names of the expection actions the agent takes.\n- Expected outcome: Natural language description of the outcome you expect.\n- (Optional) Custom evaluation: Test an agent's response for specific strings or numbers.\n- (Optional) Conversation history: Boilerplate for additional context you can add to the test in the form of a conversation history.\n\nYou can manually add contextVariables to test cases in the generated YAML file to inject contextual data (such as CaseId or RoutableId) into agent sessions. This is useful for testing agent behavior with different contextual information.\n\nWhen your test spec is ready, you then run the \"agent test create\" command to actually create the test in your org and synchronize the metadata with your DX project. The metadata type for an agent test is `AiEvaluationDefinition` (legacy testing-center) or `AiTestingDefinition` (Agentforce Studio / NGT), selected via --test-runner.\n\nIf you have an existing AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project, you can generate its equivalent YAML test spec file with the --from-definition flag. The runner is inferred from the file extension; pass --test-runner to override.",
|
|
1511
1529
|
"examples": [
|
|
1512
|
-
"
|
|
1513
|
-
"
|
|
1530
|
+
"Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
|
|
1531
|
+
"Generate an Agentforce Studio (NGT) test spec YAML file interactively:\n<%= config.bin %> <%= command.id %> --test-runner agentforce-studio",
|
|
1532
|
+
"Generate an agent test spec YAML file and specify a name for the new file; if the file exists, overwrite it without confirmation:\n<%= config.bin %> <%= command.id %> --output-file specs/Resort_Manager-new-version-testSpec.yaml --force-overwrite",
|
|
1533
|
+
"Generate an agent test spec YAML file from an existing AiEvaluationDefinition metadata XML file in your DX project:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml",
|
|
1534
|
+
"Generate an Agentforce Studio (NGT) test spec YAML file from an existing AiTestingDefinition metadata XML file:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiTestingDefinitions/Returns_Checkout_Tests.aiTestingDefinition-meta.xml"
|
|
1514
1535
|
],
|
|
1515
1536
|
"flags": {
|
|
1516
|
-
"json": {
|
|
1517
|
-
"description": "Format output as json.",
|
|
1518
|
-
"helpGroup": "GLOBAL",
|
|
1519
|
-
"name": "json",
|
|
1520
|
-
"allowNo": false,
|
|
1521
|
-
"type": "boolean"
|
|
1522
|
-
},
|
|
1523
1537
|
"flags-dir": {
|
|
1524
1538
|
"helpGroup": "GLOBAL",
|
|
1525
1539
|
"name": "flags-dir",
|
|
@@ -1528,87 +1542,78 @@
|
|
|
1528
1542
|
"multiple": false,
|
|
1529
1543
|
"type": "option"
|
|
1530
1544
|
},
|
|
1531
|
-
"
|
|
1532
|
-
"char": "
|
|
1533
|
-
"name": "
|
|
1534
|
-
"
|
|
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",
|
|
1545
|
+
"from-definition": {
|
|
1546
|
+
"char": "d",
|
|
1547
|
+
"name": "from-definition",
|
|
1548
|
+
"summary": "Filepath to an AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project that you want to convert to a test spec YAML file.",
|
|
1544
1549
|
"hasDynamicHelp": false,
|
|
1545
1550
|
"multiple": false,
|
|
1546
1551
|
"type": "option"
|
|
1547
1552
|
},
|
|
1548
|
-
"
|
|
1549
|
-
"name": "
|
|
1550
|
-
"summary": "
|
|
1551
|
-
"
|
|
1552
|
-
"
|
|
1553
|
-
"type": "option"
|
|
1553
|
+
"force-overwrite": {
|
|
1554
|
+
"name": "force-overwrite",
|
|
1555
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test spec YAML file.",
|
|
1556
|
+
"allowNo": false,
|
|
1557
|
+
"type": "boolean"
|
|
1554
1558
|
},
|
|
1555
|
-
"
|
|
1556
|
-
"
|
|
1557
|
-
"
|
|
1559
|
+
"output-file": {
|
|
1560
|
+
"char": "f",
|
|
1561
|
+
"name": "output-file",
|
|
1562
|
+
"summary": "Name of the generated test spec YAML file. Default value is \"specs/<AGENT_API_NAME>-testSpec.yaml\" (legacy) or \"specs/<AGENT_API_NAME>-ngtTestSpec.yaml\" (Agentforce Studio).",
|
|
1558
1563
|
"hasDynamicHelp": false,
|
|
1559
1564
|
"multiple": false,
|
|
1560
|
-
"options": [
|
|
1561
|
-
"EXTERNAL"
|
|
1562
|
-
],
|
|
1563
1565
|
"type": "option"
|
|
1564
1566
|
},
|
|
1565
|
-
"
|
|
1566
|
-
"
|
|
1567
|
-
"
|
|
1567
|
+
"test-runner": {
|
|
1568
|
+
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
1569
|
+
"name": "test-runner",
|
|
1570
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
1568
1571
|
"hasDynamicHelp": false,
|
|
1569
1572
|
"multiple": false,
|
|
1570
1573
|
"options": [
|
|
1571
|
-
"
|
|
1572
|
-
"
|
|
1574
|
+
"agentforce-studio",
|
|
1575
|
+
"testing-center"
|
|
1573
1576
|
],
|
|
1574
1577
|
"type": "option"
|
|
1575
1578
|
}
|
|
1576
1579
|
},
|
|
1577
|
-
"hasDynamicHelp":
|
|
1580
|
+
"hasDynamicHelp": false,
|
|
1578
1581
|
"hiddenAliases": [],
|
|
1579
|
-
"id": "agent:
|
|
1582
|
+
"id": "agent:generate:test-spec",
|
|
1580
1583
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1581
1584
|
"pluginName": "@salesforce/plugin-agent",
|
|
1582
1585
|
"pluginType": "core",
|
|
1583
|
-
"state": "preview",
|
|
1584
1586
|
"strict": true,
|
|
1585
|
-
"summary": "
|
|
1586
|
-
"enableJsonFlag":
|
|
1587
|
+
"summary": "Generate an agent test spec, which is a YAML file that lists the test cases for testing a specific agent.",
|
|
1588
|
+
"enableJsonFlag": false,
|
|
1587
1589
|
"isESM": true,
|
|
1588
1590
|
"relativePath": [
|
|
1589
1591
|
"lib",
|
|
1590
1592
|
"commands",
|
|
1591
1593
|
"agent",
|
|
1592
|
-
"
|
|
1593
|
-
"
|
|
1594
|
+
"generate",
|
|
1595
|
+
"test-spec.js"
|
|
1594
1596
|
],
|
|
1595
1597
|
"aliasPermutations": [],
|
|
1596
1598
|
"permutations": [
|
|
1597
|
-
"agent:
|
|
1598
|
-
"
|
|
1599
|
-
"
|
|
1600
|
-
"agent:
|
|
1601
|
-
"
|
|
1602
|
-
"
|
|
1599
|
+
"agent:generate:test-spec",
|
|
1600
|
+
"generate:agent:test-spec",
|
|
1601
|
+
"generate:test-spec:agent",
|
|
1602
|
+
"agent:test-spec:generate",
|
|
1603
|
+
"test-spec:agent:generate",
|
|
1604
|
+
"test-spec:generate:agent"
|
|
1603
1605
|
]
|
|
1604
1606
|
},
|
|
1605
|
-
"agent:
|
|
1607
|
+
"agent:preview:end": {
|
|
1606
1608
|
"aliases": [],
|
|
1607
1609
|
"args": {},
|
|
1608
|
-
"description": "
|
|
1610
|
+
"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.",
|
|
1609
1611
|
"examples": [
|
|
1610
|
-
"
|
|
1611
|
-
"
|
|
1612
|
+
"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",
|
|
1613
|
+
"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",
|
|
1614
|
+
"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",
|
|
1615
|
+
"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",
|
|
1616
|
+
"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>"
|
|
1612
1617
|
],
|
|
1613
1618
|
"flags": {
|
|
1614
1619
|
"json": {
|
|
@@ -1643,114 +1648,129 @@
|
|
|
1643
1648
|
"multiple": false,
|
|
1644
1649
|
"type": "option"
|
|
1645
1650
|
},
|
|
1646
|
-
"
|
|
1647
|
-
"
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
"
|
|
1651
|
-
"
|
|
1652
|
-
"
|
|
1653
|
-
"type": "option"
|
|
1654
|
-
},
|
|
1655
|
-
"label": {
|
|
1656
|
-
"name": "label",
|
|
1657
|
-
"summary": "New display label for the MCP server.",
|
|
1651
|
+
"session-id": {
|
|
1652
|
+
"exclusive": [
|
|
1653
|
+
"all"
|
|
1654
|
+
],
|
|
1655
|
+
"name": "session-id",
|
|
1656
|
+
"required": false,
|
|
1657
|
+
"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.",
|
|
1658
1658
|
"hasDynamicHelp": false,
|
|
1659
1659
|
"multiple": false,
|
|
1660
1660
|
"type": "option"
|
|
1661
1661
|
},
|
|
1662
|
-
"
|
|
1663
|
-
"
|
|
1664
|
-
"
|
|
1662
|
+
"api-name": {
|
|
1663
|
+
"char": "n",
|
|
1664
|
+
"exclusive": [
|
|
1665
|
+
"authoring-bundle"
|
|
1666
|
+
],
|
|
1667
|
+
"name": "api-name",
|
|
1668
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
1665
1669
|
"hasDynamicHelp": false,
|
|
1666
1670
|
"multiple": false,
|
|
1667
1671
|
"type": "option"
|
|
1668
1672
|
},
|
|
1669
|
-
"
|
|
1670
|
-
"
|
|
1671
|
-
|
|
1673
|
+
"authoring-bundle": {
|
|
1674
|
+
"exclusive": [
|
|
1675
|
+
"api-name"
|
|
1676
|
+
],
|
|
1677
|
+
"name": "authoring-bundle",
|
|
1678
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1672
1679
|
"hasDynamicHelp": false,
|
|
1673
1680
|
"multiple": false,
|
|
1674
1681
|
"type": "option"
|
|
1675
1682
|
},
|
|
1676
|
-
"
|
|
1677
|
-
"
|
|
1678
|
-
|
|
1679
|
-
"hasDynamicHelp": false,
|
|
1680
|
-
"multiple": false,
|
|
1681
|
-
"options": [
|
|
1682
|
-
"OAUTH",
|
|
1683
|
-
"NO_AUTH"
|
|
1683
|
+
"all": {
|
|
1684
|
+
"exclusive": [
|
|
1685
|
+
"session-id"
|
|
1684
1686
|
],
|
|
1685
|
-
"
|
|
1687
|
+
"name": "all",
|
|
1688
|
+
"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.",
|
|
1689
|
+
"allowNo": false,
|
|
1690
|
+
"type": "boolean"
|
|
1686
1691
|
},
|
|
1687
|
-
"
|
|
1688
|
-
"
|
|
1689
|
-
"
|
|
1690
|
-
"
|
|
1691
|
-
"
|
|
1692
|
-
"type": "
|
|
1693
|
-
},
|
|
1694
|
-
"client-id": {
|
|
1695
|
-
"name": "client-id",
|
|
1696
|
-
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
1697
|
-
"hasDynamicHelp": false,
|
|
1698
|
-
"multiple": false,
|
|
1699
|
-
"type": "option"
|
|
1700
|
-
},
|
|
1701
|
-
"client-secret": {
|
|
1702
|
-
"name": "client-secret",
|
|
1703
|
-
"summary": "OAuth client secret (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
1704
|
-
"hasDynamicHelp": false,
|
|
1705
|
-
"multiple": false,
|
|
1706
|
-
"type": "option"
|
|
1707
|
-
},
|
|
1708
|
-
"scope": {
|
|
1709
|
-
"name": "scope",
|
|
1710
|
-
"summary": "OAuth scope (required when --auth-type is OAUTH).",
|
|
1711
|
-
"hasDynamicHelp": false,
|
|
1712
|
-
"multiple": false,
|
|
1713
|
-
"type": "option"
|
|
1692
|
+
"no-prompt": {
|
|
1693
|
+
"char": "p",
|
|
1694
|
+
"name": "no-prompt",
|
|
1695
|
+
"summary": "Don't prompt for confirmation before ending sessions. Has an effect only when used with --all.",
|
|
1696
|
+
"allowNo": false,
|
|
1697
|
+
"type": "boolean"
|
|
1714
1698
|
}
|
|
1715
1699
|
},
|
|
1716
1700
|
"hasDynamicHelp": true,
|
|
1717
1701
|
"hiddenAliases": [],
|
|
1718
|
-
"id": "agent:
|
|
1702
|
+
"id": "agent:preview:end",
|
|
1719
1703
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1720
1704
|
"pluginName": "@salesforce/plugin-agent",
|
|
1721
1705
|
"pluginType": "core",
|
|
1722
|
-
"state": "preview",
|
|
1723
1706
|
"strict": true,
|
|
1724
|
-
"summary": "
|
|
1707
|
+
"summary": "End an existing programmatic agent preview session and get trace location.",
|
|
1725
1708
|
"enableJsonFlag": true,
|
|
1709
|
+
"requiresProject": true,
|
|
1710
|
+
"envVariablesSection": {
|
|
1711
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1712
|
+
"body": [
|
|
1713
|
+
{
|
|
1714
|
+
"name": "SF_TARGET_ORG",
|
|
1715
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1716
|
+
}
|
|
1717
|
+
]
|
|
1718
|
+
},
|
|
1719
|
+
"errorCodes": {
|
|
1720
|
+
"header": "ERROR CODES",
|
|
1721
|
+
"body": [
|
|
1722
|
+
{
|
|
1723
|
+
"name": "Succeeded (0)",
|
|
1724
|
+
"description": "Preview session ended successfully and traces saved."
|
|
1725
|
+
},
|
|
1726
|
+
{
|
|
1727
|
+
"name": "ExactlyOneRequired (2)",
|
|
1728
|
+
"description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
|
|
1729
|
+
},
|
|
1730
|
+
{
|
|
1731
|
+
"name": "NotFound (2)",
|
|
1732
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
1733
|
+
},
|
|
1734
|
+
{
|
|
1735
|
+
"name": "PreviewEndFailed (4)",
|
|
1736
|
+
"description": "Failed to end the preview session."
|
|
1737
|
+
},
|
|
1738
|
+
{
|
|
1739
|
+
"name": "PreviewEndPartialFailure (68)",
|
|
1740
|
+
"description": "With --all, one or more sessions failed to end while others succeeded."
|
|
1741
|
+
},
|
|
1742
|
+
{
|
|
1743
|
+
"name": "SessionAmbiguous (5)",
|
|
1744
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
1745
|
+
}
|
|
1746
|
+
]
|
|
1747
|
+
},
|
|
1726
1748
|
"isESM": true,
|
|
1727
1749
|
"relativePath": [
|
|
1728
1750
|
"lib",
|
|
1729
1751
|
"commands",
|
|
1730
1752
|
"agent",
|
|
1731
|
-
"
|
|
1732
|
-
"
|
|
1753
|
+
"preview",
|
|
1754
|
+
"end.js"
|
|
1733
1755
|
],
|
|
1734
1756
|
"aliasPermutations": [],
|
|
1735
1757
|
"permutations": [
|
|
1736
|
-
"agent:
|
|
1737
|
-
"
|
|
1738
|
-
"
|
|
1739
|
-
"agent:
|
|
1740
|
-
"
|
|
1741
|
-
"
|
|
1758
|
+
"agent:preview:end",
|
|
1759
|
+
"preview:agent:end",
|
|
1760
|
+
"preview:end:agent",
|
|
1761
|
+
"agent:end:preview",
|
|
1762
|
+
"end:agent:preview",
|
|
1763
|
+
"end:preview:agent"
|
|
1742
1764
|
]
|
|
1743
1765
|
},
|
|
1744
|
-
"agent:
|
|
1766
|
+
"agent:preview:send": {
|
|
1745
1767
|
"aliases": [],
|
|
1746
1768
|
"args": {},
|
|
1747
|
-
"description": "
|
|
1769
|
+
"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.",
|
|
1748
1770
|
"examples": [
|
|
1749
|
-
"
|
|
1750
|
-
"
|
|
1751
|
-
"
|
|
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"
|
|
1771
|
+
"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>",
|
|
1772
|
+
"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",
|
|
1773
|
+
"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"
|
|
1754
1774
|
],
|
|
1755
1775
|
"flags": {
|
|
1756
1776
|
"json": {
|
|
@@ -1785,164 +1805,166 @@
|
|
|
1785
1805
|
"multiple": false,
|
|
1786
1806
|
"type": "option"
|
|
1787
1807
|
},
|
|
1788
|
-
"
|
|
1789
|
-
"name": "
|
|
1790
|
-
"
|
|
1791
|
-
"
|
|
1792
|
-
"multiple": false,
|
|
1793
|
-
"options": [
|
|
1794
|
-
"customer",
|
|
1795
|
-
"internal"
|
|
1796
|
-
],
|
|
1797
|
-
"type": "option"
|
|
1798
|
-
},
|
|
1799
|
-
"role": {
|
|
1800
|
-
"name": "role",
|
|
1801
|
-
"summary": "Role of the agent.",
|
|
1802
|
-
"hasDynamicHelp": false,
|
|
1803
|
-
"multiple": false,
|
|
1804
|
-
"type": "option"
|
|
1805
|
-
},
|
|
1806
|
-
"company-name": {
|
|
1807
|
-
"name": "company-name",
|
|
1808
|
-
"summary": "Name of your company.",
|
|
1809
|
-
"hasDynamicHelp": false,
|
|
1810
|
-
"multiple": false,
|
|
1811
|
-
"type": "option"
|
|
1812
|
-
},
|
|
1813
|
-
"company-description": {
|
|
1814
|
-
"name": "company-description",
|
|
1815
|
-
"summary": "Description of your company.",
|
|
1816
|
-
"hasDynamicHelp": false,
|
|
1817
|
-
"multiple": false,
|
|
1818
|
-
"type": "option"
|
|
1819
|
-
},
|
|
1820
|
-
"company-website": {
|
|
1821
|
-
"name": "company-website",
|
|
1822
|
-
"summary": "Website URL of your company.",
|
|
1823
|
-
"hasDynamicHelp": false,
|
|
1824
|
-
"multiple": false,
|
|
1825
|
-
"type": "option"
|
|
1826
|
-
},
|
|
1827
|
-
"max-topics": {
|
|
1828
|
-
"name": "max-topics",
|
|
1829
|
-
"summary": "Maximum number of topics to generate in the agent spec; default is 5.",
|
|
1830
|
-
"hasDynamicHelp": false,
|
|
1831
|
-
"multiple": false,
|
|
1832
|
-
"type": "option"
|
|
1833
|
-
},
|
|
1834
|
-
"agent-user": {
|
|
1835
|
-
"name": "agent-user",
|
|
1836
|
-
"summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
|
|
1808
|
+
"session-id": {
|
|
1809
|
+
"name": "session-id",
|
|
1810
|
+
"required": false,
|
|
1811
|
+
"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.",
|
|
1837
1812
|
"hasDynamicHelp": false,
|
|
1838
1813
|
"multiple": false,
|
|
1839
1814
|
"type": "option"
|
|
1840
1815
|
},
|
|
1841
|
-
"
|
|
1842
|
-
"
|
|
1843
|
-
"
|
|
1844
|
-
"
|
|
1845
|
-
"
|
|
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.",
|
|
1816
|
+
"utterance": {
|
|
1817
|
+
"char": "u",
|
|
1818
|
+
"name": "utterance",
|
|
1819
|
+
"required": true,
|
|
1820
|
+
"summary": "Utterance to send to the agent, enclosed in double quotes.",
|
|
1855
1821
|
"hasDynamicHelp": false,
|
|
1856
1822
|
"multiple": false,
|
|
1857
|
-
"options": [
|
|
1858
|
-
"formal",
|
|
1859
|
-
"casual",
|
|
1860
|
-
"neutral"
|
|
1861
|
-
],
|
|
1862
1823
|
"type": "option"
|
|
1863
1824
|
},
|
|
1864
|
-
"
|
|
1865
|
-
"
|
|
1866
|
-
"
|
|
1825
|
+
"api-name": {
|
|
1826
|
+
"char": "n",
|
|
1827
|
+
"name": "api-name",
|
|
1828
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
1867
1829
|
"hasDynamicHelp": false,
|
|
1868
1830
|
"multiple": false,
|
|
1869
1831
|
"type": "option"
|
|
1870
1832
|
},
|
|
1871
|
-
"
|
|
1872
|
-
"name": "
|
|
1873
|
-
"summary": "
|
|
1874
|
-
"default": "specs/agentSpec.yaml",
|
|
1833
|
+
"authoring-bundle": {
|
|
1834
|
+
"name": "authoring-bundle",
|
|
1835
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1875
1836
|
"hasDynamicHelp": false,
|
|
1876
1837
|
"multiple": false,
|
|
1877
1838
|
"type": "option"
|
|
1878
|
-
}
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
|
|
1839
|
+
}
|
|
1840
|
+
},
|
|
1841
|
+
"hasDynamicHelp": true,
|
|
1842
|
+
"hiddenAliases": [],
|
|
1843
|
+
"id": "agent:preview:send",
|
|
1844
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
1845
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
1846
|
+
"pluginType": "core",
|
|
1847
|
+
"strict": true,
|
|
1848
|
+
"summary": "Send a message to an existing agent preview session.",
|
|
1849
|
+
"enableJsonFlag": true,
|
|
1850
|
+
"requiresProject": true,
|
|
1851
|
+
"envVariablesSection": {
|
|
1852
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1853
|
+
"body": [
|
|
1854
|
+
{
|
|
1855
|
+
"name": "SF_TARGET_ORG",
|
|
1856
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1857
|
+
}
|
|
1858
|
+
]
|
|
1859
|
+
},
|
|
1860
|
+
"errorCodes": {
|
|
1861
|
+
"header": "ERROR CODES",
|
|
1862
|
+
"body": [
|
|
1863
|
+
{
|
|
1864
|
+
"name": "Succeeded (0)",
|
|
1865
|
+
"description": "Message sent successfully and agent response received."
|
|
1866
|
+
},
|
|
1867
|
+
{
|
|
1868
|
+
"name": "NotFound (2)",
|
|
1869
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
1870
|
+
},
|
|
1871
|
+
{
|
|
1872
|
+
"name": "PreviewSendFailed (4)",
|
|
1873
|
+
"description": "Failed to send message or receive response from the preview session."
|
|
1874
|
+
},
|
|
1875
|
+
{
|
|
1876
|
+
"name": "SessionAmbiguous (5)",
|
|
1877
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
1878
|
+
}
|
|
1879
|
+
]
|
|
1880
|
+
},
|
|
1881
|
+
"isESM": true,
|
|
1882
|
+
"relativePath": [
|
|
1883
|
+
"lib",
|
|
1884
|
+
"commands",
|
|
1885
|
+
"agent",
|
|
1886
|
+
"preview",
|
|
1887
|
+
"send.js"
|
|
1888
|
+
],
|
|
1889
|
+
"aliasPermutations": [],
|
|
1890
|
+
"permutations": [
|
|
1891
|
+
"agent:preview:send",
|
|
1892
|
+
"preview:agent:send",
|
|
1893
|
+
"preview:send:agent",
|
|
1894
|
+
"agent:send:preview",
|
|
1895
|
+
"send:agent:preview",
|
|
1896
|
+
"send:preview:agent"
|
|
1897
|
+
]
|
|
1898
|
+
},
|
|
1899
|
+
"agent:preview:sessions": {
|
|
1900
|
+
"aliases": [],
|
|
1901
|
+
"args": {},
|
|
1902
|
+
"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.",
|
|
1903
|
+
"examples": [
|
|
1904
|
+
"List all cached agent preview sessions:\n<%= config.bin %> <%= command.id %>"
|
|
1905
|
+
],
|
|
1906
|
+
"flags": {
|
|
1907
|
+
"json": {
|
|
1908
|
+
"description": "Format output as json.",
|
|
1909
|
+
"helpGroup": "GLOBAL",
|
|
1910
|
+
"name": "json",
|
|
1882
1911
|
"allowNo": false,
|
|
1883
1912
|
"type": "boolean"
|
|
1884
1913
|
},
|
|
1885
|
-
"
|
|
1886
|
-
"
|
|
1887
|
-
"
|
|
1888
|
-
"
|
|
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.",
|
|
1914
|
+
"flags-dir": {
|
|
1915
|
+
"helpGroup": "GLOBAL",
|
|
1916
|
+
"name": "flags-dir",
|
|
1917
|
+
"summary": "Import flag values from a directory.",
|
|
1898
1918
|
"hasDynamicHelp": false,
|
|
1899
1919
|
"multiple": false,
|
|
1900
1920
|
"type": "option"
|
|
1901
|
-
},
|
|
1902
|
-
"force-overwrite": {
|
|
1903
|
-
"name": "force-overwrite",
|
|
1904
|
-
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
1905
|
-
"allowNo": false,
|
|
1906
|
-
"type": "boolean"
|
|
1907
1921
|
}
|
|
1908
1922
|
},
|
|
1909
|
-
"hasDynamicHelp":
|
|
1923
|
+
"hasDynamicHelp": false,
|
|
1910
1924
|
"hiddenAliases": [],
|
|
1911
|
-
"id": "agent:
|
|
1925
|
+
"id": "agent:preview:sessions",
|
|
1912
1926
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1913
1927
|
"pluginName": "@salesforce/plugin-agent",
|
|
1914
1928
|
"pluginType": "core",
|
|
1915
1929
|
"strict": true,
|
|
1916
|
-
"summary": "
|
|
1930
|
+
"summary": "List all known programmatic agent preview sessions.",
|
|
1917
1931
|
"enableJsonFlag": true,
|
|
1918
1932
|
"requiresProject": true,
|
|
1933
|
+
"errorCodes": {
|
|
1934
|
+
"header": "ERROR CODES",
|
|
1935
|
+
"body": [
|
|
1936
|
+
{
|
|
1937
|
+
"name": "Succeeded (0)",
|
|
1938
|
+
"description": "Sessions listed successfully (or empty list if no active sessions)."
|
|
1939
|
+
}
|
|
1940
|
+
]
|
|
1941
|
+
},
|
|
1919
1942
|
"isESM": true,
|
|
1920
1943
|
"relativePath": [
|
|
1921
1944
|
"lib",
|
|
1922
1945
|
"commands",
|
|
1923
1946
|
"agent",
|
|
1924
|
-
"
|
|
1925
|
-
"
|
|
1947
|
+
"preview",
|
|
1948
|
+
"sessions.js"
|
|
1926
1949
|
],
|
|
1927
1950
|
"aliasPermutations": [],
|
|
1928
1951
|
"permutations": [
|
|
1929
|
-
"agent:
|
|
1930
|
-
"
|
|
1931
|
-
"
|
|
1932
|
-
"agent:
|
|
1933
|
-
"
|
|
1934
|
-
"
|
|
1952
|
+
"agent:preview:sessions",
|
|
1953
|
+
"preview:agent:sessions",
|
|
1954
|
+
"preview:sessions:agent",
|
|
1955
|
+
"agent:sessions:preview",
|
|
1956
|
+
"sessions:agent:preview",
|
|
1957
|
+
"sessions:preview:agent"
|
|
1935
1958
|
]
|
|
1936
1959
|
},
|
|
1937
|
-
"agent:
|
|
1960
|
+
"agent:preview:start": {
|
|
1938
1961
|
"aliases": [],
|
|
1939
1962
|
"args": {},
|
|
1940
|
-
"description": "
|
|
1963
|
+
"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.",
|
|
1941
1964
|
"examples": [
|
|
1942
|
-
"
|
|
1943
|
-
"
|
|
1944
|
-
"
|
|
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"
|
|
1965
|
+
"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",
|
|
1966
|
+
"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",
|
|
1967
|
+
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
1946
1968
|
],
|
|
1947
1969
|
"flags": {
|
|
1948
1970
|
"json": {
|
|
@@ -1970,91 +1992,136 @@
|
|
|
1970
1992
|
"multiple": false,
|
|
1971
1993
|
"type": "option"
|
|
1972
1994
|
},
|
|
1973
|
-
"api-
|
|
1974
|
-
"
|
|
1975
|
-
"
|
|
1995
|
+
"api-version": {
|
|
1996
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1997
|
+
"name": "api-version",
|
|
1976
1998
|
"hasDynamicHelp": false,
|
|
1977
1999
|
"multiple": false,
|
|
1978
2000
|
"type": "option"
|
|
1979
2001
|
},
|
|
1980
|
-
"api-
|
|
1981
|
-
"
|
|
1982
|
-
"name": "api-
|
|
2002
|
+
"api-name": {
|
|
2003
|
+
"char": "n",
|
|
2004
|
+
"name": "api-name",
|
|
2005
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
1983
2006
|
"hasDynamicHelp": false,
|
|
1984
2007
|
"multiple": false,
|
|
1985
2008
|
"type": "option"
|
|
1986
2009
|
},
|
|
1987
|
-
"
|
|
1988
|
-
"
|
|
1989
|
-
"
|
|
1990
|
-
"summary": "Path to the agent spec YAML file. If you don't specify the flag, the command provides a list that you can choose from. Use the --no-spec flag to skip using an agent spec entirely.",
|
|
2010
|
+
"authoring-bundle": {
|
|
2011
|
+
"name": "authoring-bundle",
|
|
2012
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1991
2013
|
"hasDynamicHelp": false,
|
|
1992
2014
|
"multiple": false,
|
|
1993
2015
|
"type": "option"
|
|
1994
2016
|
},
|
|
1995
|
-
"
|
|
1996
|
-
"
|
|
1997
|
-
|
|
2017
|
+
"use-live-actions": {
|
|
2018
|
+
"exclusive": [
|
|
2019
|
+
"simulate-actions"
|
|
2020
|
+
],
|
|
2021
|
+
"name": "use-live-actions",
|
|
2022
|
+
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
1998
2023
|
"allowNo": false,
|
|
1999
2024
|
"type": "boolean"
|
|
2000
2025
|
},
|
|
2001
|
-
"
|
|
2002
|
-
"
|
|
2003
|
-
|
|
2004
|
-
|
|
2026
|
+
"simulate-actions": {
|
|
2027
|
+
"exclusive": [
|
|
2028
|
+
"use-live-actions"
|
|
2029
|
+
],
|
|
2030
|
+
"name": "simulate-actions",
|
|
2031
|
+
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
2032
|
+
"allowNo": false,
|
|
2033
|
+
"type": "boolean"
|
|
2034
|
+
},
|
|
2035
|
+
"context-variables": {
|
|
2036
|
+
"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.",
|
|
2037
|
+
"name": "context-variables",
|
|
2038
|
+
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
2039
|
+
"delimiter": ",",
|
|
2005
2040
|
"hasDynamicHelp": false,
|
|
2006
|
-
"multiple":
|
|
2041
|
+
"multiple": true,
|
|
2007
2042
|
"type": "option"
|
|
2008
2043
|
},
|
|
2009
|
-
"
|
|
2010
|
-
"
|
|
2011
|
-
|
|
2012
|
-
|
|
2044
|
+
"agent-json": {
|
|
2045
|
+
"dependsOn": [
|
|
2046
|
+
"authoring-bundle"
|
|
2047
|
+
],
|
|
2048
|
+
"hidden": true,
|
|
2049
|
+
"name": "agent-json",
|
|
2050
|
+
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
2013
2051
|
"hasDynamicHelp": false,
|
|
2014
2052
|
"multiple": false,
|
|
2015
2053
|
"type": "option"
|
|
2016
|
-
},
|
|
2017
|
-
"force-overwrite": {
|
|
2018
|
-
"name": "force-overwrite",
|
|
2019
|
-
"summary": "Overwrite the existing authoring bundle if one with the same API name already exists locally.",
|
|
2020
|
-
"allowNo": false,
|
|
2021
|
-
"type": "boolean"
|
|
2022
2054
|
}
|
|
2023
2055
|
},
|
|
2024
2056
|
"hasDynamicHelp": true,
|
|
2025
2057
|
"hiddenAliases": [],
|
|
2026
|
-
"id": "agent:
|
|
2058
|
+
"id": "agent:preview:start",
|
|
2027
2059
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2028
2060
|
"pluginName": "@salesforce/plugin-agent",
|
|
2029
2061
|
"pluginType": "core",
|
|
2030
2062
|
"strict": true,
|
|
2031
|
-
"summary": "
|
|
2063
|
+
"summary": "Start a programmatic agent preview session.",
|
|
2032
2064
|
"enableJsonFlag": true,
|
|
2033
2065
|
"requiresProject": true,
|
|
2066
|
+
"envVariablesSection": {
|
|
2067
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2068
|
+
"body": [
|
|
2069
|
+
{
|
|
2070
|
+
"name": "SF_TARGET_ORG",
|
|
2071
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2072
|
+
}
|
|
2073
|
+
]
|
|
2074
|
+
},
|
|
2075
|
+
"errorCodes": {
|
|
2076
|
+
"header": "ERROR CODES",
|
|
2077
|
+
"body": [
|
|
2078
|
+
{
|
|
2079
|
+
"name": "Succeeded (0)",
|
|
2080
|
+
"description": "Preview session started successfully."
|
|
2081
|
+
},
|
|
2082
|
+
{
|
|
2083
|
+
"name": "Failed (1)",
|
|
2084
|
+
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
2085
|
+
},
|
|
2086
|
+
{
|
|
2087
|
+
"name": "NotFound (2)",
|
|
2088
|
+
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
2089
|
+
},
|
|
2090
|
+
{
|
|
2091
|
+
"name": "ServerError (3)",
|
|
2092
|
+
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
2093
|
+
},
|
|
2094
|
+
{
|
|
2095
|
+
"name": "PreviewStartFailed (4)",
|
|
2096
|
+
"description": "Preview session failed to start due to API or network errors."
|
|
2097
|
+
}
|
|
2098
|
+
]
|
|
2099
|
+
},
|
|
2034
2100
|
"isESM": true,
|
|
2035
2101
|
"relativePath": [
|
|
2036
2102
|
"lib",
|
|
2037
2103
|
"commands",
|
|
2038
2104
|
"agent",
|
|
2039
|
-
"
|
|
2040
|
-
"
|
|
2105
|
+
"preview",
|
|
2106
|
+
"start.js"
|
|
2041
2107
|
],
|
|
2042
2108
|
"aliasPermutations": [],
|
|
2043
2109
|
"permutations": [
|
|
2044
|
-
"agent:
|
|
2045
|
-
"
|
|
2046
|
-
"
|
|
2047
|
-
"agent:
|
|
2048
|
-
"
|
|
2049
|
-
"
|
|
2110
|
+
"agent:preview:start",
|
|
2111
|
+
"preview:agent:start",
|
|
2112
|
+
"preview:start:agent",
|
|
2113
|
+
"agent:start:preview",
|
|
2114
|
+
"start:agent:preview",
|
|
2115
|
+
"start:preview:agent"
|
|
2050
2116
|
]
|
|
2051
2117
|
},
|
|
2052
|
-
"agent:
|
|
2118
|
+
"agent:mcp:create": {
|
|
2053
2119
|
"aliases": [],
|
|
2054
2120
|
"args": {},
|
|
2055
|
-
"description": "
|
|
2121
|
+
"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.",
|
|
2056
2122
|
"examples": [
|
|
2057
|
-
"
|
|
2123
|
+
"Create an MCP server with no authentication:\n<%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --target-org myOrg",
|
|
2124
|
+
"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"
|
|
2058
2125
|
],
|
|
2059
2126
|
"flags": {
|
|
2060
2127
|
"json": {
|
|
@@ -2072,169 +2139,130 @@
|
|
|
2072
2139
|
"multiple": false,
|
|
2073
2140
|
"type": "option"
|
|
2074
2141
|
},
|
|
2075
|
-
"
|
|
2076
|
-
"
|
|
2077
|
-
"name": "
|
|
2078
|
-
"hasDynamicHelp": false,
|
|
2079
|
-
"multiple": false,
|
|
2080
|
-
"type": "option"
|
|
2081
|
-
},
|
|
2082
|
-
"source-org": {
|
|
2083
|
-
"char": "s",
|
|
2084
|
-
"name": "source-org",
|
|
2142
|
+
"target-org": {
|
|
2143
|
+
"char": "o",
|
|
2144
|
+
"name": "target-org",
|
|
2085
2145
|
"noCacheDefault": true,
|
|
2086
2146
|
"required": true,
|
|
2087
|
-
"summary": "Username or alias of the
|
|
2147
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2088
2148
|
"hasDynamicHelp": true,
|
|
2089
2149
|
"multiple": false,
|
|
2090
|
-
"type": "option"
|
|
2091
|
-
},
|
|
2092
|
-
"
|
|
2093
|
-
"
|
|
2094
|
-
"
|
|
2095
|
-
"summary": "Version of the agent (BotVersion).",
|
|
2096
|
-
"hasDynamicHelp": false,
|
|
2097
|
-
"multiple": false,
|
|
2098
|
-
"type": "option"
|
|
2099
|
-
},
|
|
2100
|
-
"agent-file": {
|
|
2101
|
-
"char": "f",
|
|
2102
|
-
"name": "agent-file",
|
|
2103
|
-
"required": true,
|
|
2104
|
-
"summary": "Path to an agent (Bot) metadata file.",
|
|
2105
|
-
"hasDynamicHelp": false,
|
|
2106
|
-
"multiple": false,
|
|
2107
|
-
"type": "option"
|
|
2108
|
-
},
|
|
2109
|
-
"output-dir": {
|
|
2110
|
-
"char": "r",
|
|
2111
|
-
"name": "output-dir",
|
|
2112
|
-
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
2113
|
-
"hasDynamicHelp": false,
|
|
2114
|
-
"multiple": false,
|
|
2115
|
-
"type": "option"
|
|
2116
|
-
}
|
|
2117
|
-
},
|
|
2118
|
-
"hasDynamicHelp": true,
|
|
2119
|
-
"hiddenAliases": [],
|
|
2120
|
-
"id": "agent:generate:template",
|
|
2121
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
2122
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
2123
|
-
"pluginType": "core",
|
|
2124
|
-
"strict": true,
|
|
2125
|
-
"summary": "Generate an agent template from an existing agent in your DX project so you can then package the template in a second-generation managed package.",
|
|
2126
|
-
"enableJsonFlag": true,
|
|
2127
|
-
"requiresProject": true,
|
|
2128
|
-
"isESM": true,
|
|
2129
|
-
"relativePath": [
|
|
2130
|
-
"lib",
|
|
2131
|
-
"commands",
|
|
2132
|
-
"agent",
|
|
2133
|
-
"generate",
|
|
2134
|
-
"template.js"
|
|
2135
|
-
],
|
|
2136
|
-
"aliasPermutations": [],
|
|
2137
|
-
"permutations": [
|
|
2138
|
-
"agent:generate:template",
|
|
2139
|
-
"generate:agent:template",
|
|
2140
|
-
"generate:template:agent",
|
|
2141
|
-
"agent:template:generate",
|
|
2142
|
-
"template:agent:generate",
|
|
2143
|
-
"template:generate:agent"
|
|
2144
|
-
]
|
|
2145
|
-
},
|
|
2146
|
-
"agent:generate:test-spec": {
|
|
2147
|
-
"aliases": [],
|
|
2148
|
-
"args": {},
|
|
2149
|
-
"description": "The first step when using Salesforce CLI to create an agent test in your org is to use this interactive command to generate a local YAML-formatted test spec file. The test spec YAML file contains information about the agent being tested, such as its API name, and then one or more test cases. This command uses the metadata components in your DX project when prompting for information, such as the agent API name; it doesn't look in your org.\n\nTo generate a specific agent test case, this command prompts you for this information; when possible, the command provides a list of options for you to choose from:\n\n- Utterance: Natural language statement, question, or command used to test the agent.\n- Expected topic: API name of the topic you expect the agent to use when responding to the utterance.\n- Expected actions: One or more API names of the expection actions the agent takes.\n- Expected outcome: Natural language description of the outcome you expect.\n- (Optional) Custom evaluation: Test an agent's response for specific strings or numbers.\n- (Optional) Conversation history: Boilerplate for additional context you can add to the test in the form of a conversation history.\n\nYou can manually add contextVariables to test cases in the generated YAML file to inject contextual data (such as CaseId or RoutableId) into agent sessions. This is useful for testing agent behavior with different contextual information.\n\nWhen your test spec is ready, you then run the \"agent test create\" command to actually create the test in your org and synchronize the metadata with your DX project. The metadata type for an agent test is `AiEvaluationDefinition` (legacy testing-center) or `AiTestingDefinition` (Agentforce Studio / NGT), selected via --test-runner.\n\nIf you have an existing AiEvaluationDefinition or AiTestingDefinition metadata XML file in your DX project, you can generate its equivalent YAML test spec file with the --from-definition flag. The runner is inferred from the file extension; pass --test-runner to override.",
|
|
2150
|
-
"examples": [
|
|
2151
|
-
"Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
|
|
2152
|
-
"Generate an Agentforce Studio (NGT) test spec YAML file interactively:\n<%= config.bin %> <%= command.id %> --test-runner agentforce-studio",
|
|
2153
|
-
"Generate an agent test spec YAML file and specify a name for the new file; if the file exists, overwrite it without confirmation:\n<%= config.bin %> <%= command.id %> --output-file specs/Resort_Manager-new-version-testSpec.yaml --force-overwrite",
|
|
2154
|
-
"Generate an agent test spec YAML file from an existing AiEvaluationDefinition metadata XML file in your DX project:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml",
|
|
2155
|
-
"Generate an Agentforce Studio (NGT) test spec YAML file from an existing AiTestingDefinition metadata XML file:\n<%= config.bin %> <%= command.id %> --from-definition force-app/main/default/aiTestingDefinitions/Returns_Checkout_Tests.aiTestingDefinition-meta.xml"
|
|
2156
|
-
],
|
|
2157
|
-
"flags": {
|
|
2158
|
-
"flags-dir": {
|
|
2159
|
-
"helpGroup": "GLOBAL",
|
|
2160
|
-
"name": "flags-dir",
|
|
2161
|
-
"summary": "Import flag values from a directory.",
|
|
2150
|
+
"type": "option"
|
|
2151
|
+
},
|
|
2152
|
+
"api-version": {
|
|
2153
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2154
|
+
"name": "api-version",
|
|
2162
2155
|
"hasDynamicHelp": false,
|
|
2163
2156
|
"multiple": false,
|
|
2164
2157
|
"type": "option"
|
|
2165
2158
|
},
|
|
2166
|
-
"
|
|
2167
|
-
"char": "
|
|
2168
|
-
"name": "
|
|
2169
|
-
"
|
|
2159
|
+
"name": {
|
|
2160
|
+
"char": "n",
|
|
2161
|
+
"name": "name",
|
|
2162
|
+
"required": true,
|
|
2163
|
+
"summary": "Unique name of the MCP server.",
|
|
2170
2164
|
"hasDynamicHelp": false,
|
|
2171
2165
|
"multiple": false,
|
|
2172
2166
|
"type": "option"
|
|
2173
2167
|
},
|
|
2174
|
-
"
|
|
2175
|
-
"name": "
|
|
2176
|
-
"summary": "
|
|
2177
|
-
"
|
|
2178
|
-
"
|
|
2168
|
+
"label": {
|
|
2169
|
+
"name": "label",
|
|
2170
|
+
"summary": "Human-readable label for the MCP server.",
|
|
2171
|
+
"hasDynamicHelp": false,
|
|
2172
|
+
"multiple": false,
|
|
2173
|
+
"type": "option"
|
|
2179
2174
|
},
|
|
2180
|
-
"
|
|
2181
|
-
"
|
|
2182
|
-
"
|
|
2183
|
-
"summary": "Name of the generated test spec YAML file. Default value is \"specs/<AGENT_API_NAME>-testSpec.yaml\" (legacy) or \"specs/<AGENT_API_NAME>-ngtTestSpec.yaml\" (Agentforce Studio).",
|
|
2175
|
+
"description": {
|
|
2176
|
+
"name": "description",
|
|
2177
|
+
"summary": "Description of the MCP server.",
|
|
2184
2178
|
"hasDynamicHelp": false,
|
|
2185
2179
|
"multiple": false,
|
|
2186
2180
|
"type": "option"
|
|
2187
2181
|
},
|
|
2188
|
-
"
|
|
2189
|
-
"
|
|
2190
|
-
"
|
|
2191
|
-
"summary": "
|
|
2182
|
+
"server-url": {
|
|
2183
|
+
"name": "server-url",
|
|
2184
|
+
"required": true,
|
|
2185
|
+
"summary": "URL of the external MCP server.",
|
|
2186
|
+
"hasDynamicHelp": false,
|
|
2187
|
+
"multiple": false,
|
|
2188
|
+
"type": "option"
|
|
2189
|
+
},
|
|
2190
|
+
"auth-type": {
|
|
2191
|
+
"name": "auth-type",
|
|
2192
|
+
"summary": "Authorization type to use when connecting to the MCP server.",
|
|
2193
|
+
"default": "NO_AUTH",
|
|
2192
2194
|
"hasDynamicHelp": false,
|
|
2193
2195
|
"multiple": false,
|
|
2194
2196
|
"options": [
|
|
2195
|
-
"
|
|
2196
|
-
"
|
|
2197
|
+
"OAUTH",
|
|
2198
|
+
"NO_AUTH"
|
|
2197
2199
|
],
|
|
2198
2200
|
"type": "option"
|
|
2201
|
+
},
|
|
2202
|
+
"identity-provider": {
|
|
2203
|
+
"name": "identity-provider",
|
|
2204
|
+
"summary": "Identity provider to use for OAuth authorization. Required when auth-type is OAUTH.",
|
|
2205
|
+
"hasDynamicHelp": false,
|
|
2206
|
+
"multiple": false,
|
|
2207
|
+
"type": "option"
|
|
2208
|
+
},
|
|
2209
|
+
"client-id": {
|
|
2210
|
+
"name": "client-id",
|
|
2211
|
+
"summary": "OAuth client ID. Required when auth-type is OAUTH.",
|
|
2212
|
+
"hasDynamicHelp": false,
|
|
2213
|
+
"multiple": false,
|
|
2214
|
+
"type": "option"
|
|
2215
|
+
},
|
|
2216
|
+
"client-secret": {
|
|
2217
|
+
"name": "client-secret",
|
|
2218
|
+
"summary": "OAuth client secret. Required when auth-type is OAUTH. Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
2219
|
+
"hasDynamicHelp": false,
|
|
2220
|
+
"multiple": false,
|
|
2221
|
+
"type": "option"
|
|
2222
|
+
},
|
|
2223
|
+
"scope": {
|
|
2224
|
+
"name": "scope",
|
|
2225
|
+
"summary": "OAuth scope to request. Required when auth-type is OAUTH.",
|
|
2226
|
+
"hasDynamicHelp": false,
|
|
2227
|
+
"multiple": false,
|
|
2228
|
+
"type": "option"
|
|
2199
2229
|
}
|
|
2200
2230
|
},
|
|
2201
|
-
"hasDynamicHelp":
|
|
2231
|
+
"hasDynamicHelp": true,
|
|
2202
2232
|
"hiddenAliases": [],
|
|
2203
|
-
"id": "agent:
|
|
2233
|
+
"id": "agent:mcp:create",
|
|
2204
2234
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2205
2235
|
"pluginName": "@salesforce/plugin-agent",
|
|
2206
2236
|
"pluginType": "core",
|
|
2237
|
+
"state": "preview",
|
|
2207
2238
|
"strict": true,
|
|
2208
|
-
"summary": "
|
|
2209
|
-
"enableJsonFlag":
|
|
2239
|
+
"summary": "Create an MCP server in the API Catalog.",
|
|
2240
|
+
"enableJsonFlag": true,
|
|
2210
2241
|
"isESM": true,
|
|
2211
2242
|
"relativePath": [
|
|
2212
2243
|
"lib",
|
|
2213
2244
|
"commands",
|
|
2214
2245
|
"agent",
|
|
2215
|
-
"
|
|
2216
|
-
"
|
|
2246
|
+
"mcp",
|
|
2247
|
+
"create.js"
|
|
2217
2248
|
],
|
|
2218
2249
|
"aliasPermutations": [],
|
|
2219
2250
|
"permutations": [
|
|
2220
|
-
"agent:
|
|
2221
|
-
"
|
|
2222
|
-
"
|
|
2223
|
-
"agent:
|
|
2224
|
-
"
|
|
2225
|
-
"
|
|
2251
|
+
"agent:mcp:create",
|
|
2252
|
+
"mcp:agent:create",
|
|
2253
|
+
"mcp:create:agent",
|
|
2254
|
+
"agent:create:mcp",
|
|
2255
|
+
"create:agent:mcp",
|
|
2256
|
+
"create:mcp:agent"
|
|
2226
2257
|
]
|
|
2227
2258
|
},
|
|
2228
|
-
"agent:
|
|
2259
|
+
"agent:mcp:delete": {
|
|
2229
2260
|
"aliases": [],
|
|
2230
2261
|
"args": {},
|
|
2231
|
-
"description": "
|
|
2262
|
+
"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).",
|
|
2232
2263
|
"examples": [
|
|
2233
|
-
"
|
|
2234
|
-
"
|
|
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>"
|
|
2264
|
+
"Delete an MCP server, confirming interactively:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg",
|
|
2265
|
+
"Delete an MCP server without a confirmation prompt:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg --no-prompt"
|
|
2238
2266
|
],
|
|
2239
2267
|
"flags": {
|
|
2240
2268
|
"json": {
|
|
@@ -2269,129 +2297,57 @@
|
|
|
2269
2297
|
"multiple": false,
|
|
2270
2298
|
"type": "option"
|
|
2271
2299
|
},
|
|
2272
|
-
"
|
|
2273
|
-
"
|
|
2274
|
-
|
|
2275
|
-
|
|
2276
|
-
"
|
|
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
|
+
"mcp-server-id": {
|
|
2301
|
+
"char": "i",
|
|
2302
|
+
"name": "mcp-server-id",
|
|
2303
|
+
"required": true,
|
|
2304
|
+
"summary": "ID of the MCP server to delete.",
|
|
2300
2305
|
"hasDynamicHelp": false,
|
|
2301
2306
|
"multiple": false,
|
|
2302
2307
|
"type": "option"
|
|
2303
2308
|
},
|
|
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
2309
|
"no-prompt": {
|
|
2314
|
-
"char": "p",
|
|
2315
2310
|
"name": "no-prompt",
|
|
2316
|
-
"summary": "
|
|
2311
|
+
"summary": "Skip the confirmation prompt and delete the MCP server immediately.",
|
|
2317
2312
|
"allowNo": false,
|
|
2318
2313
|
"type": "boolean"
|
|
2319
2314
|
}
|
|
2320
2315
|
},
|
|
2321
2316
|
"hasDynamicHelp": true,
|
|
2322
2317
|
"hiddenAliases": [],
|
|
2323
|
-
"id": "agent:
|
|
2318
|
+
"id": "agent:mcp:delete",
|
|
2324
2319
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2325
2320
|
"pluginName": "@salesforce/plugin-agent",
|
|
2326
2321
|
"pluginType": "core",
|
|
2322
|
+
"state": "preview",
|
|
2327
2323
|
"strict": true,
|
|
2328
|
-
"summary": "
|
|
2324
|
+
"summary": "Delete an MCP server from the API Catalog.",
|
|
2329
2325
|
"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
2326
|
"isESM": true,
|
|
2370
2327
|
"relativePath": [
|
|
2371
2328
|
"lib",
|
|
2372
2329
|
"commands",
|
|
2373
2330
|
"agent",
|
|
2374
|
-
"
|
|
2375
|
-
"
|
|
2331
|
+
"mcp",
|
|
2332
|
+
"delete.js"
|
|
2376
2333
|
],
|
|
2377
2334
|
"aliasPermutations": [],
|
|
2378
2335
|
"permutations": [
|
|
2379
|
-
"agent:
|
|
2380
|
-
"
|
|
2381
|
-
"
|
|
2382
|
-
"agent:
|
|
2383
|
-
"
|
|
2384
|
-
"
|
|
2336
|
+
"agent:mcp:delete",
|
|
2337
|
+
"mcp:agent:delete",
|
|
2338
|
+
"mcp:delete:agent",
|
|
2339
|
+
"agent:delete:mcp",
|
|
2340
|
+
"delete:agent:mcp",
|
|
2341
|
+
"delete:mcp:agent"
|
|
2385
2342
|
]
|
|
2386
2343
|
},
|
|
2387
|
-
"agent:
|
|
2344
|
+
"agent:mcp:fetch": {
|
|
2388
2345
|
"aliases": [],
|
|
2389
2346
|
"args": {},
|
|
2390
|
-
"description": "
|
|
2347
|
+
"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.",
|
|
2391
2348
|
"examples": [
|
|
2392
|
-
"
|
|
2393
|
-
"
|
|
2394
|
-
"Send a message to an agent using its authoring bundle API name; you get an error if the agent has more than one active session:\n<%= config.bin %> <%= command.id %> --utterance \"what can you help me with?\" --authoring-bundle My_Local_Agent"
|
|
2349
|
+
"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",
|
|
2350
|
+
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
2395
2351
|
],
|
|
2396
2352
|
"flags": {
|
|
2397
2353
|
"json": {
|
|
@@ -2421,39 +2377,16 @@
|
|
|
2421
2377
|
},
|
|
2422
2378
|
"api-version": {
|
|
2423
2379
|
"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.",
|
|
2380
|
+
"name": "api-version",
|
|
2450
2381
|
"hasDynamicHelp": false,
|
|
2451
2382
|
"multiple": false,
|
|
2452
2383
|
"type": "option"
|
|
2453
2384
|
},
|
|
2454
|
-
"
|
|
2455
|
-
"
|
|
2456
|
-
"
|
|
2385
|
+
"mcp-server-id": {
|
|
2386
|
+
"char": "i",
|
|
2387
|
+
"name": "mcp-server-id",
|
|
2388
|
+
"required": true,
|
|
2389
|
+
"summary": "ID of the MCP server to fetch assets from.",
|
|
2457
2390
|
"hasDynamicHelp": false,
|
|
2458
2391
|
"multiple": false,
|
|
2459
2392
|
"type": "option"
|
|
@@ -2461,68 +2394,39 @@
|
|
|
2461
2394
|
},
|
|
2462
2395
|
"hasDynamicHelp": true,
|
|
2463
2396
|
"hiddenAliases": [],
|
|
2464
|
-
"id": "agent:
|
|
2397
|
+
"id": "agent:mcp:fetch",
|
|
2465
2398
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2466
2399
|
"pluginName": "@salesforce/plugin-agent",
|
|
2467
2400
|
"pluginType": "core",
|
|
2401
|
+
"state": "preview",
|
|
2468
2402
|
"strict": true,
|
|
2469
|
-
"summary": "
|
|
2403
|
+
"summary": "Fetch the live assets (tools, prompts, resources) advertised by an MCP server.",
|
|
2470
2404
|
"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
2405
|
"isESM": true,
|
|
2503
2406
|
"relativePath": [
|
|
2504
2407
|
"lib",
|
|
2505
2408
|
"commands",
|
|
2506
2409
|
"agent",
|
|
2507
|
-
"
|
|
2508
|
-
"
|
|
2410
|
+
"mcp",
|
|
2411
|
+
"fetch.js"
|
|
2509
2412
|
],
|
|
2510
2413
|
"aliasPermutations": [],
|
|
2511
2414
|
"permutations": [
|
|
2512
|
-
"agent:
|
|
2513
|
-
"
|
|
2514
|
-
"
|
|
2515
|
-
"agent:
|
|
2516
|
-
"
|
|
2517
|
-
"
|
|
2415
|
+
"agent:mcp:fetch",
|
|
2416
|
+
"mcp:agent:fetch",
|
|
2417
|
+
"mcp:fetch:agent",
|
|
2418
|
+
"agent:fetch:mcp",
|
|
2419
|
+
"fetch:agent:mcp",
|
|
2420
|
+
"fetch:mcp:agent"
|
|
2518
2421
|
]
|
|
2519
2422
|
},
|
|
2520
|
-
"agent:
|
|
2423
|
+
"agent:mcp:get": {
|
|
2521
2424
|
"aliases": [],
|
|
2522
2425
|
"args": {},
|
|
2523
|
-
"description": "
|
|
2426
|
+
"description": "Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.",
|
|
2524
2427
|
"examples": [
|
|
2525
|
-
"
|
|
2428
|
+
"Get an MCP server by id in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001",
|
|
2429
|
+
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
2526
2430
|
],
|
|
2527
2431
|
"flags": {
|
|
2528
2432
|
"json": {
|
|
@@ -2539,53 +2443,69 @@
|
|
|
2539
2443
|
"hasDynamicHelp": false,
|
|
2540
2444
|
"multiple": false,
|
|
2541
2445
|
"type": "option"
|
|
2446
|
+
},
|
|
2447
|
+
"target-org": {
|
|
2448
|
+
"char": "o",
|
|
2449
|
+
"name": "target-org",
|
|
2450
|
+
"noCacheDefault": true,
|
|
2451
|
+
"required": true,
|
|
2452
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2453
|
+
"hasDynamicHelp": true,
|
|
2454
|
+
"multiple": false,
|
|
2455
|
+
"type": "option"
|
|
2456
|
+
},
|
|
2457
|
+
"api-version": {
|
|
2458
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2459
|
+
"name": "api-version",
|
|
2460
|
+
"hasDynamicHelp": false,
|
|
2461
|
+
"multiple": false,
|
|
2462
|
+
"type": "option"
|
|
2463
|
+
},
|
|
2464
|
+
"mcp-server-id": {
|
|
2465
|
+
"char": "i",
|
|
2466
|
+
"name": "mcp-server-id",
|
|
2467
|
+
"required": true,
|
|
2468
|
+
"summary": "The identifier of the MCP server to retrieve.",
|
|
2469
|
+
"hasDynamicHelp": false,
|
|
2470
|
+
"multiple": false,
|
|
2471
|
+
"type": "option"
|
|
2542
2472
|
}
|
|
2543
2473
|
},
|
|
2544
|
-
"hasDynamicHelp":
|
|
2474
|
+
"hasDynamicHelp": true,
|
|
2545
2475
|
"hiddenAliases": [],
|
|
2546
|
-
"id": "agent:
|
|
2476
|
+
"id": "agent:mcp:get",
|
|
2547
2477
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2548
2478
|
"pluginName": "@salesforce/plugin-agent",
|
|
2549
2479
|
"pluginType": "core",
|
|
2480
|
+
"state": "preview",
|
|
2550
2481
|
"strict": true,
|
|
2551
|
-
"summary": "
|
|
2482
|
+
"summary": "Get a single MCP server registered in the API Catalog.",
|
|
2552
2483
|
"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
2484
|
"isESM": true,
|
|
2564
2485
|
"relativePath": [
|
|
2565
2486
|
"lib",
|
|
2566
2487
|
"commands",
|
|
2567
2488
|
"agent",
|
|
2568
|
-
"
|
|
2569
|
-
"
|
|
2489
|
+
"mcp",
|
|
2490
|
+
"get.js"
|
|
2570
2491
|
],
|
|
2571
2492
|
"aliasPermutations": [],
|
|
2572
2493
|
"permutations": [
|
|
2573
|
-
"agent:
|
|
2574
|
-
"
|
|
2575
|
-
"
|
|
2576
|
-
"agent:
|
|
2577
|
-
"
|
|
2578
|
-
"
|
|
2494
|
+
"agent:mcp:get",
|
|
2495
|
+
"mcp:agent:get",
|
|
2496
|
+
"mcp:get:agent",
|
|
2497
|
+
"agent:get:mcp",
|
|
2498
|
+
"get:agent:mcp",
|
|
2499
|
+
"get:mcp:agent"
|
|
2579
2500
|
]
|
|
2580
2501
|
},
|
|
2581
|
-
"agent:
|
|
2502
|
+
"agent:mcp:list": {
|
|
2582
2503
|
"aliases": [],
|
|
2583
2504
|
"args": {},
|
|
2584
|
-
"description": "
|
|
2505
|
+
"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.",
|
|
2585
2506
|
"examples": [
|
|
2586
|
-
"
|
|
2587
|
-
"
|
|
2588
|
-
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
2507
|
+
"List all MCP servers in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
2508
|
+
"List external MCP servers filtered by status and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json"
|
|
2589
2509
|
],
|
|
2590
2510
|
"flags": {
|
|
2591
2511
|
"json": {
|
|
@@ -2620,131 +2540,70 @@
|
|
|
2620
2540
|
"multiple": false,
|
|
2621
2541
|
"type": "option"
|
|
2622
2542
|
},
|
|
2623
|
-
"
|
|
2624
|
-
"
|
|
2625
|
-
"
|
|
2626
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
2543
|
+
"label": {
|
|
2544
|
+
"name": "label",
|
|
2545
|
+
"summary": "Filter the MCP servers by label.",
|
|
2627
2546
|
"hasDynamicHelp": false,
|
|
2628
2547
|
"multiple": false,
|
|
2629
2548
|
"type": "option"
|
|
2630
2549
|
},
|
|
2631
|
-
"
|
|
2632
|
-
"name": "
|
|
2633
|
-
"summary": "
|
|
2550
|
+
"type": {
|
|
2551
|
+
"name": "type",
|
|
2552
|
+
"summary": "Filter the MCP servers by type.",
|
|
2634
2553
|
"hasDynamicHelp": false,
|
|
2635
2554
|
"multiple": false,
|
|
2636
|
-
"
|
|
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"
|
|
2555
|
+
"options": [
|
|
2556
|
+
"EXTERNAL"
|
|
2650
2557
|
],
|
|
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
2558
|
"type": "option"
|
|
2664
2559
|
},
|
|
2665
|
-
"
|
|
2666
|
-
"
|
|
2667
|
-
|
|
2668
|
-
],
|
|
2669
|
-
"hidden": true,
|
|
2670
|
-
"name": "agent-json",
|
|
2671
|
-
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
2560
|
+
"status": {
|
|
2561
|
+
"name": "status",
|
|
2562
|
+
"summary": "Filter the MCP servers by connection status. Only ACTIVE and DISCONNECTED are supported as filters.",
|
|
2672
2563
|
"hasDynamicHelp": false,
|
|
2673
2564
|
"multiple": false,
|
|
2565
|
+
"options": [
|
|
2566
|
+
"ACTIVE",
|
|
2567
|
+
"DISCONNECTED"
|
|
2568
|
+
],
|
|
2674
2569
|
"type": "option"
|
|
2675
2570
|
}
|
|
2676
2571
|
},
|
|
2677
2572
|
"hasDynamicHelp": true,
|
|
2678
2573
|
"hiddenAliases": [],
|
|
2679
|
-
"id": "agent:
|
|
2574
|
+
"id": "agent:mcp:list",
|
|
2680
2575
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2681
2576
|
"pluginName": "@salesforce/plugin-agent",
|
|
2682
2577
|
"pluginType": "core",
|
|
2578
|
+
"state": "preview",
|
|
2683
2579
|
"strict": true,
|
|
2684
|
-
"summary": "
|
|
2580
|
+
"summary": "List the MCP servers registered in the API Catalog.",
|
|
2685
2581
|
"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
2582
|
"isESM": true,
|
|
2722
2583
|
"relativePath": [
|
|
2723
2584
|
"lib",
|
|
2724
2585
|
"commands",
|
|
2725
2586
|
"agent",
|
|
2726
|
-
"
|
|
2727
|
-
"
|
|
2587
|
+
"mcp",
|
|
2588
|
+
"list.js"
|
|
2728
2589
|
],
|
|
2729
2590
|
"aliasPermutations": [],
|
|
2730
2591
|
"permutations": [
|
|
2731
|
-
"agent:
|
|
2732
|
-
"
|
|
2733
|
-
"
|
|
2734
|
-
"agent:
|
|
2735
|
-
"
|
|
2736
|
-
"
|
|
2592
|
+
"agent:mcp:list",
|
|
2593
|
+
"mcp:agent:list",
|
|
2594
|
+
"mcp:list:agent",
|
|
2595
|
+
"agent:list:mcp",
|
|
2596
|
+
"list:agent:mcp",
|
|
2597
|
+
"list:mcp:agent"
|
|
2737
2598
|
]
|
|
2738
2599
|
},
|
|
2739
|
-
"agent:
|
|
2600
|
+
"agent:mcp:update": {
|
|
2740
2601
|
"aliases": [],
|
|
2741
|
-
"args": {},
|
|
2742
|
-
"description": "
|
|
2743
|
-
"examples": [
|
|
2744
|
-
"
|
|
2745
|
-
"
|
|
2746
|
-
"Publish with verbose output to see all retrieved and deployed metadata components:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --verbose",
|
|
2747
|
-
"Publish with concise output showing only essential information:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --concise"
|
|
2602
|
+
"args": {},
|
|
2603
|
+
"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.",
|
|
2604
|
+
"examples": [
|
|
2605
|
+
"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",
|
|
2606
|
+
"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"
|
|
2748
2607
|
],
|
|
2749
2608
|
"flags": {
|
|
2750
2609
|
"json": {
|
|
@@ -2779,85 +2638,102 @@
|
|
|
2779
2638
|
"multiple": false,
|
|
2780
2639
|
"type": "option"
|
|
2781
2640
|
},
|
|
2782
|
-
"
|
|
2783
|
-
"char": "
|
|
2784
|
-
"name": "
|
|
2785
|
-
"
|
|
2641
|
+
"mcp-server-id": {
|
|
2642
|
+
"char": "i",
|
|
2643
|
+
"name": "mcp-server-id",
|
|
2644
|
+
"required": true,
|
|
2645
|
+
"summary": "ID of the MCP server to update.",
|
|
2786
2646
|
"hasDynamicHelp": false,
|
|
2787
2647
|
"multiple": false,
|
|
2788
2648
|
"type": "option"
|
|
2789
2649
|
},
|
|
2790
|
-
"
|
|
2791
|
-
"name": "
|
|
2792
|
-
"summary": "
|
|
2793
|
-
"
|
|
2794
|
-
"
|
|
2650
|
+
"label": {
|
|
2651
|
+
"name": "label",
|
|
2652
|
+
"summary": "New display label for the MCP server.",
|
|
2653
|
+
"hasDynamicHelp": false,
|
|
2654
|
+
"multiple": false,
|
|
2655
|
+
"type": "option"
|
|
2795
2656
|
},
|
|
2796
|
-
"
|
|
2797
|
-
"
|
|
2798
|
-
"
|
|
2799
|
-
|
|
2800
|
-
|
|
2801
|
-
"
|
|
2802
|
-
"summary": "Display detailed output showing all metadata components retrieved and deployed during the publish process.",
|
|
2803
|
-
"allowNo": false,
|
|
2804
|
-
"type": "boolean"
|
|
2657
|
+
"description": {
|
|
2658
|
+
"name": "description",
|
|
2659
|
+
"summary": "New description for the MCP server.",
|
|
2660
|
+
"hasDynamicHelp": false,
|
|
2661
|
+
"multiple": false,
|
|
2662
|
+
"type": "option"
|
|
2805
2663
|
},
|
|
2806
|
-
"
|
|
2807
|
-
"
|
|
2808
|
-
|
|
2664
|
+
"server-url": {
|
|
2665
|
+
"name": "server-url",
|
|
2666
|
+
"summary": "New endpoint URL of the MCP server.",
|
|
2667
|
+
"hasDynamicHelp": false,
|
|
2668
|
+
"multiple": false,
|
|
2669
|
+
"type": "option"
|
|
2670
|
+
},
|
|
2671
|
+
"auth-type": {
|
|
2672
|
+
"name": "auth-type",
|
|
2673
|
+
"summary": "Authorization type to apply to the MCP server (OAUTH or NO_AUTH).",
|
|
2674
|
+
"hasDynamicHelp": false,
|
|
2675
|
+
"multiple": false,
|
|
2676
|
+
"options": [
|
|
2677
|
+
"OAUTH",
|
|
2678
|
+
"NO_AUTH"
|
|
2809
2679
|
],
|
|
2810
|
-
"
|
|
2811
|
-
|
|
2812
|
-
|
|
2813
|
-
"
|
|
2680
|
+
"type": "option"
|
|
2681
|
+
},
|
|
2682
|
+
"identity-provider": {
|
|
2683
|
+
"name": "identity-provider",
|
|
2684
|
+
"summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
|
|
2685
|
+
"hasDynamicHelp": false,
|
|
2686
|
+
"multiple": false,
|
|
2687
|
+
"type": "option"
|
|
2688
|
+
},
|
|
2689
|
+
"client-id": {
|
|
2690
|
+
"name": "client-id",
|
|
2691
|
+
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
2692
|
+
"hasDynamicHelp": false,
|
|
2693
|
+
"multiple": false,
|
|
2694
|
+
"type": "option"
|
|
2695
|
+
},
|
|
2696
|
+
"client-secret": {
|
|
2697
|
+
"name": "client-secret",
|
|
2698
|
+
"summary": "OAuth client secret (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
2699
|
+
"hasDynamicHelp": false,
|
|
2700
|
+
"multiple": false,
|
|
2701
|
+
"type": "option"
|
|
2702
|
+
},
|
|
2703
|
+
"scope": {
|
|
2704
|
+
"name": "scope",
|
|
2705
|
+
"summary": "OAuth scope (required when --auth-type is OAUTH).",
|
|
2706
|
+
"hasDynamicHelp": false,
|
|
2707
|
+
"multiple": false,
|
|
2708
|
+
"type": "option"
|
|
2814
2709
|
}
|
|
2815
2710
|
},
|
|
2816
2711
|
"hasDynamicHelp": true,
|
|
2817
2712
|
"hiddenAliases": [],
|
|
2818
|
-
"id": "agent:
|
|
2713
|
+
"id": "agent:mcp:update",
|
|
2819
2714
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2820
2715
|
"pluginName": "@salesforce/plugin-agent",
|
|
2821
2716
|
"pluginType": "core",
|
|
2717
|
+
"state": "preview",
|
|
2822
2718
|
"strict": true,
|
|
2823
|
-
"summary": "
|
|
2719
|
+
"summary": "Update an MCP server registered in the API Catalog.",
|
|
2824
2720
|
"enableJsonFlag": true,
|
|
2825
|
-
"requiresProject": true,
|
|
2826
|
-
"errorCodes": {
|
|
2827
|
-
"header": "ERROR CODES",
|
|
2828
|
-
"body": [
|
|
2829
|
-
{
|
|
2830
|
-
"name": "Succeeded (0)",
|
|
2831
|
-
"description": "Agent published successfully without errors."
|
|
2832
|
-
},
|
|
2833
|
-
{
|
|
2834
|
-
"name": "Failed (1)",
|
|
2835
|
-
"description": "Compilation errors found in the Agent Script file."
|
|
2836
|
-
}
|
|
2837
|
-
]
|
|
2838
|
-
},
|
|
2839
|
-
"FLAGGABLE_PROMPTS": {
|
|
2840
|
-
"api-name": {
|
|
2841
|
-
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
2842
|
-
"promptMessage": "API name of the authoring bundle to publish"
|
|
2843
|
-
}
|
|
2844
|
-
},
|
|
2845
2721
|
"isESM": true,
|
|
2846
2722
|
"relativePath": [
|
|
2847
2723
|
"lib",
|
|
2848
2724
|
"commands",
|
|
2849
2725
|
"agent",
|
|
2850
|
-
"
|
|
2851
|
-
"
|
|
2726
|
+
"mcp",
|
|
2727
|
+
"update.js"
|
|
2852
2728
|
],
|
|
2853
2729
|
"aliasPermutations": [],
|
|
2854
2730
|
"permutations": [
|
|
2855
|
-
"agent:
|
|
2856
|
-
"
|
|
2857
|
-
"
|
|
2858
|
-
"agent:
|
|
2859
|
-
"
|
|
2860
|
-
"
|
|
2731
|
+
"agent:mcp:update",
|
|
2732
|
+
"mcp:agent:update",
|
|
2733
|
+
"mcp:update:agent",
|
|
2734
|
+
"agent:update:mcp",
|
|
2735
|
+
"update:agent:mcp",
|
|
2736
|
+
"update:mcp:agent"
|
|
2861
2737
|
]
|
|
2862
2738
|
},
|
|
2863
2739
|
"agent:test:create": {
|
|
@@ -3997,6 +3873,130 @@
|
|
|
3997
3873
|
"read:trace:agent"
|
|
3998
3874
|
]
|
|
3999
3875
|
},
|
|
3876
|
+
"agent:publish:authoring-bundle": {
|
|
3877
|
+
"aliases": [],
|
|
3878
|
+
"args": {},
|
|
3879
|
+
"description": "An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The metadata type contains two files: the standard metatada XML file and an Agent Script file (extension \".agent\") that fully describes the agent using the Agent Script language.\n\nWhen you publish an authoring bundle to your org, a number of things happen. First, this command validates that the Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent Script file to continue. Once the Agent Script file compiles, then it's published to the org, which in turn creates new associated metadata (Bot, BotVersion, GenAiX), or new versions of the metadata if the agent already exists. The new or updated metadata is retrieved back to your DX project; specify the --skip-retrieve flag to skip this step. Finally, the authoring bundle metadata (AiAuthoringBundle) is deployed to your org.\n\nThis command uses the API name of the authoring bundle.",
|
|
3880
|
+
"examples": [
|
|
3881
|
+
"Publish an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
3882
|
+
"Publish an authoring bundle with API name MyAuthoringBundle to the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --target-org my-dev-org",
|
|
3883
|
+
"Publish with verbose output to see all retrieved and deployed metadata components:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --verbose",
|
|
3884
|
+
"Publish with concise output showing only essential information:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --concise"
|
|
3885
|
+
],
|
|
3886
|
+
"flags": {
|
|
3887
|
+
"json": {
|
|
3888
|
+
"description": "Format output as json.",
|
|
3889
|
+
"helpGroup": "GLOBAL",
|
|
3890
|
+
"name": "json",
|
|
3891
|
+
"allowNo": false,
|
|
3892
|
+
"type": "boolean"
|
|
3893
|
+
},
|
|
3894
|
+
"flags-dir": {
|
|
3895
|
+
"helpGroup": "GLOBAL",
|
|
3896
|
+
"name": "flags-dir",
|
|
3897
|
+
"summary": "Import flag values from a directory.",
|
|
3898
|
+
"hasDynamicHelp": false,
|
|
3899
|
+
"multiple": false,
|
|
3900
|
+
"type": "option"
|
|
3901
|
+
},
|
|
3902
|
+
"target-org": {
|
|
3903
|
+
"char": "o",
|
|
3904
|
+
"name": "target-org",
|
|
3905
|
+
"noCacheDefault": true,
|
|
3906
|
+
"required": true,
|
|
3907
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3908
|
+
"hasDynamicHelp": true,
|
|
3909
|
+
"multiple": false,
|
|
3910
|
+
"type": "option"
|
|
3911
|
+
},
|
|
3912
|
+
"api-version": {
|
|
3913
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3914
|
+
"name": "api-version",
|
|
3915
|
+
"hasDynamicHelp": false,
|
|
3916
|
+
"multiple": false,
|
|
3917
|
+
"type": "option"
|
|
3918
|
+
},
|
|
3919
|
+
"api-name": {
|
|
3920
|
+
"char": "n",
|
|
3921
|
+
"name": "api-name",
|
|
3922
|
+
"summary": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
3923
|
+
"hasDynamicHelp": false,
|
|
3924
|
+
"multiple": false,
|
|
3925
|
+
"type": "option"
|
|
3926
|
+
},
|
|
3927
|
+
"skip-retrieve": {
|
|
3928
|
+
"name": "skip-retrieve",
|
|
3929
|
+
"summary": "Don't retrieve the metadata associated with the agent to your DX project.",
|
|
3930
|
+
"allowNo": false,
|
|
3931
|
+
"type": "boolean"
|
|
3932
|
+
},
|
|
3933
|
+
"verbose": {
|
|
3934
|
+
"char": "v",
|
|
3935
|
+
"exclusive": [
|
|
3936
|
+
"concise"
|
|
3937
|
+
],
|
|
3938
|
+
"name": "verbose",
|
|
3939
|
+
"summary": "Display detailed output showing all metadata components retrieved and deployed during the publish process.",
|
|
3940
|
+
"allowNo": false,
|
|
3941
|
+
"type": "boolean"
|
|
3942
|
+
},
|
|
3943
|
+
"concise": {
|
|
3944
|
+
"exclusive": [
|
|
3945
|
+
"verbose"
|
|
3946
|
+
],
|
|
3947
|
+
"name": "concise",
|
|
3948
|
+
"summary": "Display minimal output with only essential information about the publish operation.",
|
|
3949
|
+
"allowNo": false,
|
|
3950
|
+
"type": "boolean"
|
|
3951
|
+
}
|
|
3952
|
+
},
|
|
3953
|
+
"hasDynamicHelp": true,
|
|
3954
|
+
"hiddenAliases": [],
|
|
3955
|
+
"id": "agent:publish:authoring-bundle",
|
|
3956
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
3957
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
3958
|
+
"pluginType": "core",
|
|
3959
|
+
"strict": true,
|
|
3960
|
+
"summary": "Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.",
|
|
3961
|
+
"enableJsonFlag": true,
|
|
3962
|
+
"requiresProject": true,
|
|
3963
|
+
"errorCodes": {
|
|
3964
|
+
"header": "ERROR CODES",
|
|
3965
|
+
"body": [
|
|
3966
|
+
{
|
|
3967
|
+
"name": "Succeeded (0)",
|
|
3968
|
+
"description": "Agent published successfully without errors."
|
|
3969
|
+
},
|
|
3970
|
+
{
|
|
3971
|
+
"name": "Failed (1)",
|
|
3972
|
+
"description": "Compilation errors found in the Agent Script file."
|
|
3973
|
+
}
|
|
3974
|
+
]
|
|
3975
|
+
},
|
|
3976
|
+
"FLAGGABLE_PROMPTS": {
|
|
3977
|
+
"api-name": {
|
|
3978
|
+
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
3979
|
+
"promptMessage": "API name of the authoring bundle to publish"
|
|
3980
|
+
}
|
|
3981
|
+
},
|
|
3982
|
+
"isESM": true,
|
|
3983
|
+
"relativePath": [
|
|
3984
|
+
"lib",
|
|
3985
|
+
"commands",
|
|
3986
|
+
"agent",
|
|
3987
|
+
"publish",
|
|
3988
|
+
"authoring-bundle.js"
|
|
3989
|
+
],
|
|
3990
|
+
"aliasPermutations": [],
|
|
3991
|
+
"permutations": [
|
|
3992
|
+
"agent:publish:authoring-bundle",
|
|
3993
|
+
"publish:agent:authoring-bundle",
|
|
3994
|
+
"publish:authoring-bundle:agent",
|
|
3995
|
+
"agent:authoring-bundle:publish",
|
|
3996
|
+
"authoring-bundle:agent:publish",
|
|
3997
|
+
"authoring-bundle:publish:agent"
|
|
3998
|
+
]
|
|
3999
|
+
},
|
|
4000
4000
|
"agent:validate:authoring-bundle": {
|
|
4001
4001
|
"aliases": [],
|
|
4002
4002
|
"args": {},
|
|
@@ -4667,5 +4667,5 @@
|
|
|
4667
4667
|
]
|
|
4668
4668
|
}
|
|
4669
4669
|
},
|
|
4670
|
-
"version": "2.0.
|
|
4670
|
+
"version": "2.0.4"
|
|
4671
4671
|
}
|