@salesforce/plugin-agent 2.0.3 → 2.0.5
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 +496 -496
- package/package.json +4 -4
package/oclif.manifest.json
CHANGED
|
@@ -1120,13 +1120,16 @@
|
|
|
1120
1120
|
"upload:adl:agent"
|
|
1121
1121
|
]
|
|
1122
1122
|
},
|
|
1123
|
-
"agent:
|
|
1123
|
+
"agent: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,75 @@
|
|
|
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:mcp:
|
|
1607
|
+
"agent:mcp:create": {
|
|
1606
1608
|
"aliases": [],
|
|
1607
1609
|
"args": {},
|
|
1608
|
-
"description": "
|
|
1610
|
+
"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.",
|
|
1609
1611
|
"examples": [
|
|
1610
|
-
"
|
|
1611
|
-
"
|
|
1612
|
+
"Create an MCP server with no authentication:\n<%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --target-org myOrg",
|
|
1613
|
+
"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"
|
|
1612
1614
|
],
|
|
1613
1615
|
"flags": {
|
|
1614
1616
|
"json": {
|
|
@@ -1643,39 +1645,41 @@
|
|
|
1643
1645
|
"multiple": false,
|
|
1644
1646
|
"type": "option"
|
|
1645
1647
|
},
|
|
1646
|
-
"
|
|
1647
|
-
"char": "
|
|
1648
|
-
"name": "
|
|
1648
|
+
"name": {
|
|
1649
|
+
"char": "n",
|
|
1650
|
+
"name": "name",
|
|
1649
1651
|
"required": true,
|
|
1650
|
-
"summary": "
|
|
1652
|
+
"summary": "Unique name of the MCP server.",
|
|
1651
1653
|
"hasDynamicHelp": false,
|
|
1652
1654
|
"multiple": false,
|
|
1653
1655
|
"type": "option"
|
|
1654
1656
|
},
|
|
1655
1657
|
"label": {
|
|
1656
1658
|
"name": "label",
|
|
1657
|
-
"summary": "
|
|
1659
|
+
"summary": "Human-readable label for the MCP server.",
|
|
1658
1660
|
"hasDynamicHelp": false,
|
|
1659
1661
|
"multiple": false,
|
|
1660
1662
|
"type": "option"
|
|
1661
1663
|
},
|
|
1662
1664
|
"description": {
|
|
1663
1665
|
"name": "description",
|
|
1664
|
-
"summary": "
|
|
1666
|
+
"summary": "Description of the MCP server.",
|
|
1665
1667
|
"hasDynamicHelp": false,
|
|
1666
1668
|
"multiple": false,
|
|
1667
1669
|
"type": "option"
|
|
1668
1670
|
},
|
|
1669
1671
|
"server-url": {
|
|
1670
1672
|
"name": "server-url",
|
|
1671
|
-
"
|
|
1673
|
+
"required": true,
|
|
1674
|
+
"summary": "URL of the external MCP server.",
|
|
1672
1675
|
"hasDynamicHelp": false,
|
|
1673
1676
|
"multiple": false,
|
|
1674
1677
|
"type": "option"
|
|
1675
1678
|
},
|
|
1676
1679
|
"auth-type": {
|
|
1677
1680
|
"name": "auth-type",
|
|
1678
|
-
"summary": "Authorization type to
|
|
1681
|
+
"summary": "Authorization type to use when connecting to the MCP server.",
|
|
1682
|
+
"default": "NO_AUTH",
|
|
1679
1683
|
"hasDynamicHelp": false,
|
|
1680
1684
|
"multiple": false,
|
|
1681
1685
|
"options": [
|
|
@@ -1686,28 +1690,28 @@
|
|
|
1686
1690
|
},
|
|
1687
1691
|
"identity-provider": {
|
|
1688
1692
|
"name": "identity-provider",
|
|
1689
|
-
"summary": "Identity provider
|
|
1693
|
+
"summary": "Identity provider to use for OAuth authorization. Required when auth-type is OAUTH.",
|
|
1690
1694
|
"hasDynamicHelp": false,
|
|
1691
1695
|
"multiple": false,
|
|
1692
1696
|
"type": "option"
|
|
1693
1697
|
},
|
|
1694
1698
|
"client-id": {
|
|
1695
1699
|
"name": "client-id",
|
|
1696
|
-
"summary": "OAuth client ID
|
|
1700
|
+
"summary": "OAuth client ID. Required when auth-type is OAUTH.",
|
|
1697
1701
|
"hasDynamicHelp": false,
|
|
1698
1702
|
"multiple": false,
|
|
1699
1703
|
"type": "option"
|
|
1700
1704
|
},
|
|
1701
1705
|
"client-secret": {
|
|
1702
1706
|
"name": "client-secret",
|
|
1703
|
-
"summary": "OAuth client secret
|
|
1707
|
+
"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
1708
|
"hasDynamicHelp": false,
|
|
1705
1709
|
"multiple": false,
|
|
1706
1710
|
"type": "option"
|
|
1707
1711
|
},
|
|
1708
1712
|
"scope": {
|
|
1709
1713
|
"name": "scope",
|
|
1710
|
-
"summary": "OAuth scope
|
|
1714
|
+
"summary": "OAuth scope to request. Required when auth-type is OAUTH.",
|
|
1711
1715
|
"hasDynamicHelp": false,
|
|
1712
1716
|
"multiple": false,
|
|
1713
1717
|
"type": "option"
|
|
@@ -1715,13 +1719,13 @@
|
|
|
1715
1719
|
},
|
|
1716
1720
|
"hasDynamicHelp": true,
|
|
1717
1721
|
"hiddenAliases": [],
|
|
1718
|
-
"id": "agent:mcp:
|
|
1722
|
+
"id": "agent:mcp:create",
|
|
1719
1723
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1720
1724
|
"pluginName": "@salesforce/plugin-agent",
|
|
1721
1725
|
"pluginType": "core",
|
|
1722
1726
|
"state": "preview",
|
|
1723
1727
|
"strict": true,
|
|
1724
|
-
"summary": "
|
|
1728
|
+
"summary": "Create an MCP server in the API Catalog.",
|
|
1725
1729
|
"enableJsonFlag": true,
|
|
1726
1730
|
"isESM": true,
|
|
1727
1731
|
"relativePath": [
|
|
@@ -1729,28 +1733,25 @@
|
|
|
1729
1733
|
"commands",
|
|
1730
1734
|
"agent",
|
|
1731
1735
|
"mcp",
|
|
1732
|
-
"
|
|
1736
|
+
"create.js"
|
|
1733
1737
|
],
|
|
1734
1738
|
"aliasPermutations": [],
|
|
1735
1739
|
"permutations": [
|
|
1736
|
-
"agent:mcp:
|
|
1737
|
-
"mcp:agent:
|
|
1738
|
-
"mcp:
|
|
1739
|
-
"agent:
|
|
1740
|
-
"
|
|
1741
|
-
"
|
|
1740
|
+
"agent:mcp:create",
|
|
1741
|
+
"mcp:agent:create",
|
|
1742
|
+
"mcp:create:agent",
|
|
1743
|
+
"agent:create:mcp",
|
|
1744
|
+
"create:agent:mcp",
|
|
1745
|
+
"create:mcp:agent"
|
|
1742
1746
|
]
|
|
1743
1747
|
},
|
|
1744
|
-
"agent:
|
|
1748
|
+
"agent:mcp:delete": {
|
|
1745
1749
|
"aliases": [],
|
|
1746
1750
|
"args": {},
|
|
1747
|
-
"description": "
|
|
1751
|
+
"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).",
|
|
1748
1752
|
"examples": [
|
|
1749
|
-
"
|
|
1750
|
-
"
|
|
1751
|
-
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
1752
|
-
"Specify an existing agent spec file called \"specs/resortManagerAgent.yaml\", and then overwrite it with a new version that contains newly AI-generated topics based on the updated role information passed in with the --role flag:\n<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role \"Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly\"",
|
|
1753
|
-
"Specify that the conversational tone of the agent is formal and to attach the \"resortmanager@myorg.com\" username to it; be prompted for the required properties and use your default org:\n<%= config.bin %> <%= command.id %> --tone formal --agent-user resortmanager@myorg.com"
|
|
1753
|
+
"Delete an MCP server, confirming interactively:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg",
|
|
1754
|
+
"Delete an MCP server without a confirmation prompt:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg --no-prompt"
|
|
1754
1755
|
],
|
|
1755
1756
|
"flags": {
|
|
1756
1757
|
"json": {
|
|
@@ -1785,164 +1786,136 @@
|
|
|
1785
1786
|
"multiple": false,
|
|
1786
1787
|
"type": "option"
|
|
1787
1788
|
},
|
|
1788
|
-
"
|
|
1789
|
-
"
|
|
1790
|
-
"
|
|
1791
|
-
"
|
|
1792
|
-
"
|
|
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.",
|
|
1837
|
-
"hasDynamicHelp": false,
|
|
1838
|
-
"multiple": false,
|
|
1839
|
-
"type": "option"
|
|
1840
|
-
},
|
|
1841
|
-
"enrich-logs": {
|
|
1842
|
-
"name": "enrich-logs",
|
|
1843
|
-
"summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
|
|
1789
|
+
"mcp-server-id": {
|
|
1790
|
+
"char": "i",
|
|
1791
|
+
"name": "mcp-server-id",
|
|
1792
|
+
"required": true,
|
|
1793
|
+
"summary": "ID of the MCP server to delete.",
|
|
1844
1794
|
"hasDynamicHelp": false,
|
|
1845
1795
|
"multiple": false,
|
|
1846
|
-
"options": [
|
|
1847
|
-
"true",
|
|
1848
|
-
"false"
|
|
1849
|
-
],
|
|
1850
1796
|
"type": "option"
|
|
1851
1797
|
},
|
|
1852
|
-
"
|
|
1853
|
-
"name": "
|
|
1854
|
-
"summary": "
|
|
1855
|
-
"
|
|
1856
|
-
"
|
|
1857
|
-
|
|
1858
|
-
|
|
1859
|
-
|
|
1860
|
-
|
|
1861
|
-
|
|
1862
|
-
|
|
1798
|
+
"no-prompt": {
|
|
1799
|
+
"name": "no-prompt",
|
|
1800
|
+
"summary": "Skip the confirmation prompt and delete the MCP server immediately.",
|
|
1801
|
+
"allowNo": false,
|
|
1802
|
+
"type": "boolean"
|
|
1803
|
+
}
|
|
1804
|
+
},
|
|
1805
|
+
"hasDynamicHelp": true,
|
|
1806
|
+
"hiddenAliases": [],
|
|
1807
|
+
"id": "agent:mcp:delete",
|
|
1808
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
1809
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
1810
|
+
"pluginType": "core",
|
|
1811
|
+
"state": "preview",
|
|
1812
|
+
"strict": true,
|
|
1813
|
+
"summary": "Delete an MCP server from the API Catalog.",
|
|
1814
|
+
"enableJsonFlag": true,
|
|
1815
|
+
"isESM": true,
|
|
1816
|
+
"relativePath": [
|
|
1817
|
+
"lib",
|
|
1818
|
+
"commands",
|
|
1819
|
+
"agent",
|
|
1820
|
+
"mcp",
|
|
1821
|
+
"delete.js"
|
|
1822
|
+
],
|
|
1823
|
+
"aliasPermutations": [],
|
|
1824
|
+
"permutations": [
|
|
1825
|
+
"agent:mcp:delete",
|
|
1826
|
+
"mcp:agent:delete",
|
|
1827
|
+
"mcp:delete:agent",
|
|
1828
|
+
"agent:delete:mcp",
|
|
1829
|
+
"delete:agent:mcp",
|
|
1830
|
+
"delete:mcp:agent"
|
|
1831
|
+
]
|
|
1832
|
+
},
|
|
1833
|
+
"agent:mcp:fetch": {
|
|
1834
|
+
"aliases": [],
|
|
1835
|
+
"args": {},
|
|
1836
|
+
"description": "Performs a live fetch against the configured MCP server identified by its ID, returning the assets (MCP tools, prompts, and resources) it currently advertises along with their status and activation state. Use this to refresh the view of what an MCP server exposes before activating its assets as agent actions.",
|
|
1837
|
+
"examples": [
|
|
1838
|
+
"Fetch the assets advertised by an MCP server in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001",
|
|
1839
|
+
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
1840
|
+
],
|
|
1841
|
+
"flags": {
|
|
1842
|
+
"json": {
|
|
1843
|
+
"description": "Format output as json.",
|
|
1844
|
+
"helpGroup": "GLOBAL",
|
|
1845
|
+
"name": "json",
|
|
1846
|
+
"allowNo": false,
|
|
1847
|
+
"type": "boolean"
|
|
1863
1848
|
},
|
|
1864
|
-
"
|
|
1865
|
-
"
|
|
1866
|
-
"
|
|
1849
|
+
"flags-dir": {
|
|
1850
|
+
"helpGroup": "GLOBAL",
|
|
1851
|
+
"name": "flags-dir",
|
|
1852
|
+
"summary": "Import flag values from a directory.",
|
|
1867
1853
|
"hasDynamicHelp": false,
|
|
1868
1854
|
"multiple": false,
|
|
1869
1855
|
"type": "option"
|
|
1870
1856
|
},
|
|
1871
|
-
"
|
|
1872
|
-
"
|
|
1873
|
-
"
|
|
1874
|
-
"
|
|
1875
|
-
"
|
|
1857
|
+
"target-org": {
|
|
1858
|
+
"char": "o",
|
|
1859
|
+
"name": "target-org",
|
|
1860
|
+
"noCacheDefault": true,
|
|
1861
|
+
"required": true,
|
|
1862
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1863
|
+
"hasDynamicHelp": true,
|
|
1876
1864
|
"multiple": false,
|
|
1877
1865
|
"type": "option"
|
|
1878
1866
|
},
|
|
1879
|
-
"
|
|
1880
|
-
"
|
|
1881
|
-
"
|
|
1882
|
-
"allowNo": false,
|
|
1883
|
-
"type": "boolean"
|
|
1884
|
-
},
|
|
1885
|
-
"prompt-template": {
|
|
1886
|
-
"name": "prompt-template",
|
|
1887
|
-
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
1867
|
+
"api-version": {
|
|
1868
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1869
|
+
"name": "api-version",
|
|
1888
1870
|
"hasDynamicHelp": false,
|
|
1889
1871
|
"multiple": false,
|
|
1890
1872
|
"type": "option"
|
|
1891
1873
|
},
|
|
1892
|
-
"
|
|
1893
|
-
"
|
|
1894
|
-
|
|
1895
|
-
|
|
1896
|
-
"
|
|
1897
|
-
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
1874
|
+
"mcp-server-id": {
|
|
1875
|
+
"char": "i",
|
|
1876
|
+
"name": "mcp-server-id",
|
|
1877
|
+
"required": true,
|
|
1878
|
+
"summary": "ID of the MCP server to fetch assets from.",
|
|
1898
1879
|
"hasDynamicHelp": false,
|
|
1899
1880
|
"multiple": false,
|
|
1900
1881
|
"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
1882
|
}
|
|
1908
1883
|
},
|
|
1909
1884
|
"hasDynamicHelp": true,
|
|
1910
1885
|
"hiddenAliases": [],
|
|
1911
|
-
"id": "agent:
|
|
1886
|
+
"id": "agent:mcp:fetch",
|
|
1912
1887
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1913
1888
|
"pluginName": "@salesforce/plugin-agent",
|
|
1914
1889
|
"pluginType": "core",
|
|
1890
|
+
"state": "preview",
|
|
1915
1891
|
"strict": true,
|
|
1916
|
-
"summary": "
|
|
1892
|
+
"summary": "Fetch the live assets (tools, prompts, resources) advertised by an MCP server.",
|
|
1917
1893
|
"enableJsonFlag": true,
|
|
1918
|
-
"requiresProject": true,
|
|
1919
1894
|
"isESM": true,
|
|
1920
1895
|
"relativePath": [
|
|
1921
1896
|
"lib",
|
|
1922
1897
|
"commands",
|
|
1923
1898
|
"agent",
|
|
1924
|
-
"
|
|
1925
|
-
"
|
|
1899
|
+
"mcp",
|
|
1900
|
+
"fetch.js"
|
|
1926
1901
|
],
|
|
1927
1902
|
"aliasPermutations": [],
|
|
1928
1903
|
"permutations": [
|
|
1929
|
-
"agent:
|
|
1930
|
-
"
|
|
1931
|
-
"
|
|
1932
|
-
"agent:
|
|
1933
|
-
"
|
|
1934
|
-
"
|
|
1904
|
+
"agent:mcp:fetch",
|
|
1905
|
+
"mcp:agent:fetch",
|
|
1906
|
+
"mcp:fetch:agent",
|
|
1907
|
+
"agent:fetch:mcp",
|
|
1908
|
+
"fetch:agent:mcp",
|
|
1909
|
+
"fetch:mcp:agent"
|
|
1935
1910
|
]
|
|
1936
1911
|
},
|
|
1937
|
-
"agent:
|
|
1912
|
+
"agent:mcp:get": {
|
|
1938
1913
|
"aliases": [],
|
|
1939
1914
|
"args": {},
|
|
1940
|
-
"description": "
|
|
1915
|
+
"description": "Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.",
|
|
1941
1916
|
"examples": [
|
|
1942
|
-
"
|
|
1943
|
-
"
|
|
1944
|
-
"Generate an authoring bundle from the \"specs/agentSpec.yaml\" agent spec YAML file and give it the label \"My Authoring Bundle\"; use your default org:\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\"",
|
|
1945
|
-
"Similar to previous example, but generate the authoring bundle files in the \"other-package-dir/main/default\" package directory; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name \"My Authoring Bundle\" --output-dir other-package-dir/main/default --target-org my-dev-org"
|
|
1917
|
+
"Get an MCP server by id in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001",
|
|
1918
|
+
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
1946
1919
|
],
|
|
1947
1920
|
"flags": {
|
|
1948
1921
|
"json": {
|
|
@@ -1970,13 +1943,6 @@
|
|
|
1970
1943
|
"multiple": false,
|
|
1971
1944
|
"type": "option"
|
|
1972
1945
|
},
|
|
1973
|
-
"api-name": {
|
|
1974
|
-
"name": "api-name",
|
|
1975
|
-
"summary": "API name of the new authoring bundle; if not specified, the API name is derived from the authoring bundle name (label); the API name can't exist in the org.",
|
|
1976
|
-
"hasDynamicHelp": false,
|
|
1977
|
-
"multiple": false,
|
|
1978
|
-
"type": "option"
|
|
1979
|
-
},
|
|
1980
1946
|
"api-version": {
|
|
1981
1947
|
"description": "Override the api version used for api requests made by this command",
|
|
1982
1948
|
"name": "api-version",
|
|
@@ -1984,77 +1950,51 @@
|
|
|
1984
1950
|
"multiple": false,
|
|
1985
1951
|
"type": "option"
|
|
1986
1952
|
},
|
|
1987
|
-
"
|
|
1988
|
-
"char": "
|
|
1989
|
-
"name": "
|
|
1990
|
-
"
|
|
1991
|
-
"
|
|
1992
|
-
"multiple": false,
|
|
1993
|
-
"type": "option"
|
|
1994
|
-
},
|
|
1995
|
-
"no-spec": {
|
|
1996
|
-
"name": "no-spec",
|
|
1997
|
-
"summary": "Skip prompting for an agent spec and use the default Agent Script boilerplate in the generated authoring bundle.",
|
|
1998
|
-
"allowNo": false,
|
|
1999
|
-
"type": "boolean"
|
|
2000
|
-
},
|
|
2001
|
-
"output-dir": {
|
|
2002
|
-
"char": "d",
|
|
2003
|
-
"name": "output-dir",
|
|
2004
|
-
"summary": "Directory where the authoring bundle files are generated.",
|
|
2005
|
-
"hasDynamicHelp": false,
|
|
2006
|
-
"multiple": false,
|
|
2007
|
-
"type": "option"
|
|
2008
|
-
},
|
|
2009
|
-
"name": {
|
|
2010
|
-
"char": "n",
|
|
2011
|
-
"name": "name",
|
|
2012
|
-
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
1953
|
+
"mcp-server-id": {
|
|
1954
|
+
"char": "i",
|
|
1955
|
+
"name": "mcp-server-id",
|
|
1956
|
+
"required": true,
|
|
1957
|
+
"summary": "The identifier of the MCP server to retrieve.",
|
|
2013
1958
|
"hasDynamicHelp": false,
|
|
2014
1959
|
"multiple": false,
|
|
2015
1960
|
"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
1961
|
}
|
|
2023
1962
|
},
|
|
2024
1963
|
"hasDynamicHelp": true,
|
|
2025
1964
|
"hiddenAliases": [],
|
|
2026
|
-
"id": "agent:
|
|
1965
|
+
"id": "agent:mcp:get",
|
|
2027
1966
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2028
1967
|
"pluginName": "@salesforce/plugin-agent",
|
|
2029
1968
|
"pluginType": "core",
|
|
1969
|
+
"state": "preview",
|
|
2030
1970
|
"strict": true,
|
|
2031
|
-
"summary": "
|
|
1971
|
+
"summary": "Get a single MCP server registered in the API Catalog.",
|
|
2032
1972
|
"enableJsonFlag": true,
|
|
2033
|
-
"requiresProject": true,
|
|
2034
1973
|
"isESM": true,
|
|
2035
1974
|
"relativePath": [
|
|
2036
1975
|
"lib",
|
|
2037
1976
|
"commands",
|
|
2038
1977
|
"agent",
|
|
2039
|
-
"
|
|
2040
|
-
"
|
|
1978
|
+
"mcp",
|
|
1979
|
+
"get.js"
|
|
2041
1980
|
],
|
|
2042
1981
|
"aliasPermutations": [],
|
|
2043
1982
|
"permutations": [
|
|
2044
|
-
"agent:
|
|
2045
|
-
"
|
|
2046
|
-
"
|
|
2047
|
-
"agent:
|
|
2048
|
-
"
|
|
2049
|
-
"
|
|
1983
|
+
"agent:mcp:get",
|
|
1984
|
+
"mcp:agent:get",
|
|
1985
|
+
"mcp:get:agent",
|
|
1986
|
+
"agent:get:mcp",
|
|
1987
|
+
"get:agent:mcp",
|
|
1988
|
+
"get:mcp:agent"
|
|
2050
1989
|
]
|
|
2051
1990
|
},
|
|
2052
|
-
"agent:
|
|
1991
|
+
"agent:mcp:list": {
|
|
2053
1992
|
"aliases": [],
|
|
2054
1993
|
"args": {},
|
|
2055
|
-
"description": "
|
|
1994
|
+
"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.",
|
|
2056
1995
|
"examples": [
|
|
2057
|
-
"
|
|
1996
|
+
"List all MCP servers in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
1997
|
+
"List external MCP servers filtered by status and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json"
|
|
2058
1998
|
],
|
|
2059
1999
|
"flags": {
|
|
2060
2000
|
"json": {
|
|
@@ -2072,6 +2012,16 @@
|
|
|
2072
2012
|
"multiple": false,
|
|
2073
2013
|
"type": "option"
|
|
2074
2014
|
},
|
|
2015
|
+
"target-org": {
|
|
2016
|
+
"char": "o",
|
|
2017
|
+
"name": "target-org",
|
|
2018
|
+
"noCacheDefault": true,
|
|
2019
|
+
"required": true,
|
|
2020
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2021
|
+
"hasDynamicHelp": true,
|
|
2022
|
+
"multiple": false,
|
|
2023
|
+
"type": "option"
|
|
2024
|
+
},
|
|
2075
2025
|
"api-version": {
|
|
2076
2026
|
"description": "Override the api version used for api requests made by this command",
|
|
2077
2027
|
"name": "api-version",
|
|
@@ -2079,82 +2029,79 @@
|
|
|
2079
2029
|
"multiple": false,
|
|
2080
2030
|
"type": "option"
|
|
2081
2031
|
},
|
|
2082
|
-
"
|
|
2083
|
-
"
|
|
2084
|
-
"
|
|
2085
|
-
"noCacheDefault": true,
|
|
2086
|
-
"required": true,
|
|
2087
|
-
"summary": "Username or alias of the namespaced scratch org that contains the agent which this template is based on.",
|
|
2088
|
-
"hasDynamicHelp": true,
|
|
2089
|
-
"multiple": false,
|
|
2090
|
-
"type": "option"
|
|
2091
|
-
},
|
|
2092
|
-
"agent-version": {
|
|
2093
|
-
"name": "agent-version",
|
|
2094
|
-
"required": true,
|
|
2095
|
-
"summary": "Version of the agent (BotVersion).",
|
|
2032
|
+
"label": {
|
|
2033
|
+
"name": "label",
|
|
2034
|
+
"summary": "Filter the MCP servers by label.",
|
|
2096
2035
|
"hasDynamicHelp": false,
|
|
2097
2036
|
"multiple": false,
|
|
2098
2037
|
"type": "option"
|
|
2099
2038
|
},
|
|
2100
|
-
"
|
|
2101
|
-
"
|
|
2102
|
-
"
|
|
2103
|
-
"required": true,
|
|
2104
|
-
"summary": "Path to an agent (Bot) metadata file.",
|
|
2039
|
+
"type": {
|
|
2040
|
+
"name": "type",
|
|
2041
|
+
"summary": "Filter the MCP servers by type.",
|
|
2105
2042
|
"hasDynamicHelp": false,
|
|
2106
2043
|
"multiple": false,
|
|
2044
|
+
"options": [
|
|
2045
|
+
"EXTERNAL"
|
|
2046
|
+
],
|
|
2107
2047
|
"type": "option"
|
|
2108
2048
|
},
|
|
2109
|
-
"
|
|
2110
|
-
"
|
|
2111
|
-
"
|
|
2112
|
-
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
2049
|
+
"status": {
|
|
2050
|
+
"name": "status",
|
|
2051
|
+
"summary": "Filter the MCP servers by connection status. Only ACTIVE and DISCONNECTED are supported as filters.",
|
|
2113
2052
|
"hasDynamicHelp": false,
|
|
2114
2053
|
"multiple": false,
|
|
2054
|
+
"options": [
|
|
2055
|
+
"ACTIVE",
|
|
2056
|
+
"DISCONNECTED"
|
|
2057
|
+
],
|
|
2115
2058
|
"type": "option"
|
|
2116
2059
|
}
|
|
2117
2060
|
},
|
|
2118
2061
|
"hasDynamicHelp": true,
|
|
2119
2062
|
"hiddenAliases": [],
|
|
2120
|
-
"id": "agent:
|
|
2063
|
+
"id": "agent:mcp:list",
|
|
2121
2064
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2122
2065
|
"pluginName": "@salesforce/plugin-agent",
|
|
2123
2066
|
"pluginType": "core",
|
|
2067
|
+
"state": "preview",
|
|
2124
2068
|
"strict": true,
|
|
2125
|
-
"summary": "
|
|
2069
|
+
"summary": "List the MCP servers registered in the API Catalog.",
|
|
2126
2070
|
"enableJsonFlag": true,
|
|
2127
|
-
"requiresProject": true,
|
|
2128
2071
|
"isESM": true,
|
|
2129
2072
|
"relativePath": [
|
|
2130
2073
|
"lib",
|
|
2131
2074
|
"commands",
|
|
2132
2075
|
"agent",
|
|
2133
|
-
"
|
|
2134
|
-
"
|
|
2076
|
+
"mcp",
|
|
2077
|
+
"list.js"
|
|
2135
2078
|
],
|
|
2136
2079
|
"aliasPermutations": [],
|
|
2137
2080
|
"permutations": [
|
|
2138
|
-
"agent:
|
|
2139
|
-
"
|
|
2140
|
-
"
|
|
2141
|
-
"agent:
|
|
2142
|
-
"
|
|
2143
|
-
"
|
|
2081
|
+
"agent:mcp:list",
|
|
2082
|
+
"mcp:agent:list",
|
|
2083
|
+
"mcp:list:agent",
|
|
2084
|
+
"agent:list:mcp",
|
|
2085
|
+
"list:agent:mcp",
|
|
2086
|
+
"list:mcp:agent"
|
|
2144
2087
|
]
|
|
2145
2088
|
},
|
|
2146
|
-
"agent:
|
|
2089
|
+
"agent:mcp:update": {
|
|
2147
2090
|
"aliases": [],
|
|
2148
2091
|
"args": {},
|
|
2149
|
-
"description": "
|
|
2092
|
+
"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.",
|
|
2150
2093
|
"examples": [
|
|
2151
|
-
"
|
|
2152
|
-
"
|
|
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"
|
|
2094
|
+
"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",
|
|
2095
|
+
"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"
|
|
2156
2096
|
],
|
|
2157
2097
|
"flags": {
|
|
2098
|
+
"json": {
|
|
2099
|
+
"description": "Format output as json.",
|
|
2100
|
+
"helpGroup": "GLOBAL",
|
|
2101
|
+
"name": "json",
|
|
2102
|
+
"allowNo": false,
|
|
2103
|
+
"type": "boolean"
|
|
2104
|
+
},
|
|
2158
2105
|
"flags-dir": {
|
|
2159
2106
|
"helpGroup": "GLOBAL",
|
|
2160
2107
|
"name": "flags-dir",
|
|
@@ -2163,66 +2110,119 @@
|
|
|
2163
2110
|
"multiple": false,
|
|
2164
2111
|
"type": "option"
|
|
2165
2112
|
},
|
|
2166
|
-
"
|
|
2167
|
-
"char": "
|
|
2168
|
-
"name": "
|
|
2169
|
-
"
|
|
2113
|
+
"target-org": {
|
|
2114
|
+
"char": "o",
|
|
2115
|
+
"name": "target-org",
|
|
2116
|
+
"noCacheDefault": true,
|
|
2117
|
+
"required": true,
|
|
2118
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2119
|
+
"hasDynamicHelp": true,
|
|
2120
|
+
"multiple": false,
|
|
2121
|
+
"type": "option"
|
|
2122
|
+
},
|
|
2123
|
+
"api-version": {
|
|
2124
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2125
|
+
"name": "api-version",
|
|
2170
2126
|
"hasDynamicHelp": false,
|
|
2171
2127
|
"multiple": false,
|
|
2172
2128
|
"type": "option"
|
|
2173
2129
|
},
|
|
2174
|
-
"
|
|
2175
|
-
"
|
|
2176
|
-
"
|
|
2177
|
-
"
|
|
2178
|
-
"
|
|
2130
|
+
"mcp-server-id": {
|
|
2131
|
+
"char": "i",
|
|
2132
|
+
"name": "mcp-server-id",
|
|
2133
|
+
"required": true,
|
|
2134
|
+
"summary": "ID of the MCP server to update.",
|
|
2135
|
+
"hasDynamicHelp": false,
|
|
2136
|
+
"multiple": false,
|
|
2137
|
+
"type": "option"
|
|
2179
2138
|
},
|
|
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).",
|
|
2139
|
+
"label": {
|
|
2140
|
+
"name": "label",
|
|
2141
|
+
"summary": "New display label for the MCP server.",
|
|
2184
2142
|
"hasDynamicHelp": false,
|
|
2185
2143
|
"multiple": false,
|
|
2186
2144
|
"type": "option"
|
|
2187
2145
|
},
|
|
2188
|
-
"
|
|
2189
|
-
"
|
|
2190
|
-
"
|
|
2191
|
-
"
|
|
2146
|
+
"description": {
|
|
2147
|
+
"name": "description",
|
|
2148
|
+
"summary": "New description for the MCP server.",
|
|
2149
|
+
"hasDynamicHelp": false,
|
|
2150
|
+
"multiple": false,
|
|
2151
|
+
"type": "option"
|
|
2152
|
+
},
|
|
2153
|
+
"server-url": {
|
|
2154
|
+
"name": "server-url",
|
|
2155
|
+
"summary": "New endpoint URL of the MCP server.",
|
|
2156
|
+
"hasDynamicHelp": false,
|
|
2157
|
+
"multiple": false,
|
|
2158
|
+
"type": "option"
|
|
2159
|
+
},
|
|
2160
|
+
"auth-type": {
|
|
2161
|
+
"name": "auth-type",
|
|
2162
|
+
"summary": "Authorization type to apply to the MCP server (OAUTH or NO_AUTH).",
|
|
2192
2163
|
"hasDynamicHelp": false,
|
|
2193
2164
|
"multiple": false,
|
|
2194
2165
|
"options": [
|
|
2195
|
-
"
|
|
2196
|
-
"
|
|
2166
|
+
"OAUTH",
|
|
2167
|
+
"NO_AUTH"
|
|
2197
2168
|
],
|
|
2198
2169
|
"type": "option"
|
|
2170
|
+
},
|
|
2171
|
+
"identity-provider": {
|
|
2172
|
+
"name": "identity-provider",
|
|
2173
|
+
"summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
|
|
2174
|
+
"hasDynamicHelp": false,
|
|
2175
|
+
"multiple": false,
|
|
2176
|
+
"type": "option"
|
|
2177
|
+
},
|
|
2178
|
+
"client-id": {
|
|
2179
|
+
"name": "client-id",
|
|
2180
|
+
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
2181
|
+
"hasDynamicHelp": false,
|
|
2182
|
+
"multiple": false,
|
|
2183
|
+
"type": "option"
|
|
2184
|
+
},
|
|
2185
|
+
"client-secret": {
|
|
2186
|
+
"name": "client-secret",
|
|
2187
|
+
"summary": "OAuth client secret (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
2188
|
+
"hasDynamicHelp": false,
|
|
2189
|
+
"multiple": false,
|
|
2190
|
+
"type": "option"
|
|
2191
|
+
},
|
|
2192
|
+
"scope": {
|
|
2193
|
+
"name": "scope",
|
|
2194
|
+
"summary": "OAuth scope (required when --auth-type is OAUTH).",
|
|
2195
|
+
"hasDynamicHelp": false,
|
|
2196
|
+
"multiple": false,
|
|
2197
|
+
"type": "option"
|
|
2199
2198
|
}
|
|
2200
2199
|
},
|
|
2201
|
-
"hasDynamicHelp":
|
|
2200
|
+
"hasDynamicHelp": true,
|
|
2202
2201
|
"hiddenAliases": [],
|
|
2203
|
-
"id": "agent:
|
|
2202
|
+
"id": "agent:mcp:update",
|
|
2204
2203
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2205
2204
|
"pluginName": "@salesforce/plugin-agent",
|
|
2206
2205
|
"pluginType": "core",
|
|
2206
|
+
"state": "preview",
|
|
2207
2207
|
"strict": true,
|
|
2208
|
-
"summary": "
|
|
2209
|
-
"enableJsonFlag":
|
|
2208
|
+
"summary": "Update an MCP server registered in the API Catalog.",
|
|
2209
|
+
"enableJsonFlag": true,
|
|
2210
2210
|
"isESM": true,
|
|
2211
2211
|
"relativePath": [
|
|
2212
2212
|
"lib",
|
|
2213
2213
|
"commands",
|
|
2214
2214
|
"agent",
|
|
2215
|
-
"
|
|
2216
|
-
"
|
|
2215
|
+
"mcp",
|
|
2216
|
+
"update.js"
|
|
2217
2217
|
],
|
|
2218
2218
|
"aliasPermutations": [],
|
|
2219
2219
|
"permutations": [
|
|
2220
|
-
"agent:
|
|
2221
|
-
"
|
|
2222
|
-
"
|
|
2223
|
-
"agent:
|
|
2224
|
-
"
|
|
2225
|
-
"
|
|
2220
|
+
"agent:mcp:update",
|
|
2221
|
+
"mcp:agent:update",
|
|
2222
|
+
"mcp:update:agent",
|
|
2223
|
+
"agent:update:mcp",
|
|
2224
|
+
"update:agent:mcp",
|
|
2225
|
+
"update:mcp:agent"
|
|
2226
2226
|
]
|
|
2227
2227
|
},
|
|
2228
2228
|
"agent:preview:end": {
|
|
@@ -4667,5 +4667,5 @@
|
|
|
4667
4667
|
]
|
|
4668
4668
|
}
|
|
4669
4669
|
},
|
|
4670
|
-
"version": "2.0.
|
|
4670
|
+
"version": "2.0.5"
|
|
4671
4671
|
}
|