@salesforce/plugin-agent 1.44.4 → 1.44.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.
Files changed (3) hide show
  1. package/README.md +41 -41
  2. package/oclif.manifest.json +747 -747
  3. package/package.json +4 -4
@@ -1120,13 +1120,16 @@
1120
1120
  "upload:adl:agent"
1121
1121
  ]
1122
1122
  },
1123
- "agent:mcp:create": {
1123
+ "agent:generate:agent-spec": {
1124
1124
  "aliases": [],
1125
1125
  "args": {},
1126
- "description": "Registers an external Model Context Protocol (MCP) server with the API Catalog and discovers its assets (tools, prompts, and resources). Provide the server URL and, when the server requires it, OAuth authorization details. When the authorization type is OAUTH you must supply the identity provider, client ID, client secret, and scope.",
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
- "Create an MCP server with no authentication:\n<%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --target-org myOrg",
1129
- "Create an MCP server that uses OAuth authentication, piping the client secret from stdin to keep it out of shell history:\ncat secret.txt | <%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --auth-type OAUTH --identity-provider myIdp --client-id abc123 --client-secret - --scope \"read write\" --target-org myOrg"
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
- "name": {
1165
- "char": "n",
1166
- "name": "name",
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
- "label": {
1174
- "name": "label",
1175
- "summary": "Human-readable label for the MCP server.",
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
- "description": {
1181
- "name": "description",
1182
- "summary": "Description of the MCP server.",
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
- "server-url": {
1188
- "name": "server-url",
1189
- "required": true,
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
- "auth-type": {
1196
- "name": "auth-type",
1197
- "summary": "Authorization type to use when connecting to the MCP server.",
1198
- "default": "NO_AUTH",
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
- "OAUTH",
1203
- "NO_AUTH"
1226
+ "true",
1227
+ "false"
1204
1228
  ],
1205
1229
  "type": "option"
1206
1230
  },
1207
- "identity-provider": {
1208
- "name": "identity-provider",
1209
- "summary": "Identity provider to use for OAuth authorization. Required when auth-type is OAUTH.",
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
- "client-id": {
1215
- "name": "client-id",
1216
- "summary": "OAuth client ID. Required when auth-type is OAUTH.",
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
- "client-secret": {
1222
- "name": "client-secret",
1223
- "summary": "OAuth client secret. Required when auth-type is OAUTH. Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
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
- "scope": {
1229
- "name": "scope",
1230
- "summary": "OAuth scope to request. Required when auth-type is OAUTH.",
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:mcp:create",
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": "Create an MCP server in the API Catalog.",
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
- "mcp",
1252
- "create.js"
1303
+ "generate",
1304
+ "agent-spec.js"
1253
1305
  ],
1254
1306
  "aliasPermutations": [],
1255
1307
  "permutations": [
1256
- "agent:mcp:create",
1257
- "mcp:agent:create",
1258
- "mcp:create:agent",
1259
- "agent:create:mcp",
1260
- "create:agent:mcp",
1261
- "create:mcp:agent"
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:mcp:delete": {
1316
+ "agent:generate:authoring-bundle": {
1265
1317
  "aliases": [],
1266
1318
  "args": {},
1267
- "description": "Permanently removes an MCP (Model Context Protocol) server registration from the API Catalog, identified by its ID. By default you are prompted to confirm the deletion; pass --no-prompt to skip the confirmation (for example in scripts and CI).",
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
- "Delete an MCP server, confirming interactively:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg",
1270
- "Delete an MCP server without a confirmation prompt:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg --no-prompt"
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
- "mcp-server-id": {
1306
- "char": "i",
1307
- "name": "mcp-server-id",
1308
- "required": true,
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-prompt": {
1315
- "name": "no-prompt",
1316
- "summary": "Skip the confirmation prompt and delete the MCP server immediately.",
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:mcp:delete",
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": "Delete an MCP server from the API Catalog.",
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
- "mcp",
1337
- "delete.js"
1418
+ "generate",
1419
+ "authoring-bundle.js"
1338
1420
  ],
1339
1421
  "aliasPermutations": [],
1340
1422
  "permutations": [
1341
- "agent:mcp:delete",
1342
- "mcp:agent:delete",
1343
- "mcp:delete:agent",
1344
- "agent:delete:mcp",
1345
- "delete:agent:mcp",
1346
- "delete:mcp:agent"
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:mcp:fetch": {
1431
+ "agent:generate:template": {
1350
1432
  "aliases": [],
1351
1433
  "args": {},
1352
- "description": "Performs a live fetch against the configured MCP server identified by its ID, returning the assets (MCP tools, prompts, and resources) it currently advertises along with their status and activation state. Use this to refresh the view of what an MCP server exposes before activating its assets as agent actions.",
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
- "Fetch the assets advertised by an MCP server in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001",
1355
- "Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
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
- "mcp-server-id": {
1391
- "char": "i",
1392
- "name": "mcp-server-id",
1461
+ "source-org": {
1462
+ "char": "s",
1463
+ "name": "source-org",
1464
+ "noCacheDefault": true,
1393
1465
  "required": true,
1394
- "summary": "ID of the MCP server to fetch assets from.",
1395
- "hasDynamicHelp": false,
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
- "flags-dir": {
1445
- "helpGroup": "GLOBAL",
1446
- "name": "flags-dir",
1447
- "summary": "Import flag values from a directory.",
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
- "target-org": {
1453
- "char": "o",
1454
- "name": "target-org",
1455
- "noCacheDefault": true,
1479
+ "agent-file": {
1480
+ "char": "f",
1481
+ "name": "agent-file",
1456
1482
  "required": true,
1457
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1458
- "hasDynamicHelp": true,
1459
- "multiple": false,
1460
- "type": "option"
1461
- },
1462
- "api-version": {
1463
- "description": "Override the api version used for api requests made by this command",
1464
- "name": "api-version",
1483
+ "summary": "Path to an agent (Bot) metadata file.",
1465
1484
  "hasDynamicHelp": false,
1466
1485
  "multiple": false,
1467
1486
  "type": "option"
1468
1487
  },
1469
- "mcp-server-id": {
1470
- "char": "i",
1471
- "name": "mcp-server-id",
1472
- "required": true,
1473
- "summary": "The identifier of the MCP server to retrieve.",
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:mcp:get",
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": "Get a single MCP server registered in the API Catalog.",
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
- "mcp",
1495
- "get.js"
1512
+ "generate",
1513
+ "template.js"
1496
1514
  ],
1497
1515
  "aliasPermutations": [],
1498
1516
  "permutations": [
1499
- "agent:mcp:get",
1500
- "mcp:agent:get",
1501
- "mcp:get:agent",
1502
- "agent:get:mcp",
1503
- "get:agent:mcp",
1504
- "get:mcp:agent"
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:mcp:list": {
1525
+ "agent:generate:test-spec": {
1508
1526
  "aliases": [],
1509
1527
  "args": {},
1510
- "description": "Returns the Model Context Protocol (MCP) servers registered in the API Catalog, optionally filtered by label, type, or status. Use this to discover which MCP servers are available and inspect their server URLs and current status.",
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
- "List all MCP servers in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
1513
- "List external MCP servers filtered by status and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json"
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
- "target-org": {
1532
- "char": "o",
1533
- "name": "target-org",
1534
- "noCacheDefault": true,
1535
- "required": true,
1536
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1537
- "hasDynamicHelp": true,
1538
- "multiple": false,
1539
- "type": "option"
1540
- },
1541
- "api-version": {
1542
- "description": "Override the api version used for api requests made by this command",
1543
- "name": "api-version",
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
- "label": {
1549
- "name": "label",
1550
- "summary": "Filter the MCP servers by label.",
1551
- "hasDynamicHelp": false,
1552
- "multiple": false,
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
- "type": {
1556
- "name": "type",
1557
- "summary": "Filter the MCP servers by type.",
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
- "status": {
1566
- "name": "status",
1567
- "summary": "Filter the MCP servers by connection status. Only ACTIVE and DISCONNECTED are supported as filters.",
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
- "ACTIVE",
1572
- "DISCONNECTED"
1574
+ "agentforce-studio",
1575
+ "testing-center"
1573
1576
  ],
1574
1577
  "type": "option"
1575
1578
  }
1576
1579
  },
1577
- "hasDynamicHelp": true,
1580
+ "hasDynamicHelp": false,
1578
1581
  "hiddenAliases": [],
1579
- "id": "agent:mcp:list",
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": "List the MCP servers registered in the API Catalog.",
1586
- "enableJsonFlag": true,
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
- "mcp",
1593
- "list.js"
1594
+ "generate",
1595
+ "test-spec.js"
1594
1596
  ],
1595
1597
  "aliasPermutations": [],
1596
1598
  "permutations": [
1597
- "agent:mcp:list",
1598
- "mcp:agent:list",
1599
- "mcp:list:agent",
1600
- "agent:list:mcp",
1601
- "list:agent:mcp",
1602
- "list:mcp:agent"
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:update": {
1607
+ "agent:mcp:create": {
1606
1608
  "aliases": [],
1607
1609
  "args": {},
1608
- "description": "Updates an existing MCP server in the API Catalog. Only the fields you provide are changed; omitted fields are left untouched. You can update the label, description, and server URL, and replace the authorization configuration. When setting `--auth-type OAUTH`, you must also provide `--identity-provider`, `--client-id`, `--client-secret`, and `--scope`. When setting `--auth-type NO_AUTH`, no authorization credentials are required. At least one updatable field must be supplied.",
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
- "Update the label and description of an MCP server in the default target org:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --label \"Orders MCP\" --description \"Order tooling\" --target-org myOrg",
1611
- "Update the server URL and switch the authorization to OAuth, piping the client secret from stdin and outputting as JSON:\ncat secret.txt | <%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --server-url https://mcp.example.com --auth-type OAUTH --identity-provider MyIdp --client-id abc --client-secret - --scope \"read write\" --target-org myOrg --json"
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
- "mcp-server-id": {
1647
- "char": "i",
1648
- "name": "mcp-server-id",
1648
+ "name": {
1649
+ "char": "n",
1650
+ "name": "name",
1649
1651
  "required": true,
1650
- "summary": "ID of the MCP server to update.",
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": "New display label for the MCP server.",
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": "New description for the MCP server.",
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
- "summary": "New endpoint URL of the MCP server.",
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 apply to the MCP server (OAUTH or NO_AUTH).",
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 name for OAuth authorization (required when --auth-type is OAUTH).",
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 (required when --auth-type is OAUTH).",
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 (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
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 (required when --auth-type is OAUTH).",
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:update",
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": "Update an MCP server registered in the API Catalog.",
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
- "update.js"
1736
+ "create.js"
1733
1737
  ],
1734
1738
  "aliasPermutations": [],
1735
1739
  "permutations": [
1736
- "agent:mcp:update",
1737
- "mcp:agent:update",
1738
- "mcp:update:agent",
1739
- "agent:update:mcp",
1740
- "update:agent:mcp",
1741
- "update:mcp:agent"
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:preview:end": {
1748
+ "agent:mcp:delete": {
1745
1749
  "aliases": [],
1746
1750
  "args": {},
1747
- "description": "You must have previously started a programmatic agent preview session with the \"agent preview start\" command to then use this command to end it. This command also displays the local directory where the session trace files are stored.\n\nThe original \"agent preview start\" command outputs a session ID which you then use with the --session-id flag of this command to end the session. You don't have to specify the --session-id flag if an agent has only one active preview session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring bundle or the published agent, respectively. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.\n\nUse the --all flag to end all active preview sessions at once. You can combine --all with --api-name or --authoring-bundle to end only sessions for a specific agent, or use --all on its own to end every session across all agents in the project.",
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
- "End a preview session of a published agent by specifying its session ID and API name; use the default org:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --api-name My_Published_Agent",
1750
- "Similar to previous example, but don't specify a session ID; you get an error if the published agent has more than one active session. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent --target-org my-dev-org",
1751
- "End a preview session of an agent using its authoring bundle API name; you get an error if the agent has more than one active session.\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Local_Agent",
1752
- "End all active preview sessions for a specific agent without prompting:\n<%= config.bin %> <%= command.id %> --all --authoring-bundle My_Local_Agent --target-org <target_org> --no-prompt",
1753
- "End all active preview sessions across every agent in the local session cache for an org:\n<%= config.bin %> <%= command.id %> --all --target-org <target_org>"
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,129 +1786,57 @@
1785
1786
  "multiple": false,
1786
1787
  "type": "option"
1787
1788
  },
1788
- "session-id": {
1789
- "exclusive": [
1790
- "all"
1791
- ],
1792
- "name": "session-id",
1793
- "required": false,
1794
- "summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see the list of all sessions.",
1795
- "hasDynamicHelp": false,
1796
- "multiple": false,
1797
- "type": "option"
1798
- },
1799
- "api-name": {
1800
- "char": "n",
1801
- "exclusive": [
1802
- "authoring-bundle"
1803
- ],
1804
- "name": "api-name",
1805
- "summary": "API name of the activated published agent you want to preview.",
1806
- "hasDynamicHelp": false,
1807
- "multiple": false,
1808
- "type": "option"
1809
- },
1810
- "authoring-bundle": {
1811
- "exclusive": [
1812
- "api-name"
1813
- ],
1814
- "name": "authoring-bundle",
1815
- "summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
1789
+ "mcp-server-id": {
1790
+ "char": "i",
1791
+ "name": "mcp-server-id",
1792
+ "required": true,
1793
+ "summary": "ID of the MCP server to delete.",
1816
1794
  "hasDynamicHelp": false,
1817
1795
  "multiple": false,
1818
1796
  "type": "option"
1819
1797
  },
1820
- "all": {
1821
- "exclusive": [
1822
- "session-id"
1823
- ],
1824
- "name": "all",
1825
- "summary": "End all active preview sessions. Combine with --api-name or --authoring-bundle to limit to a specific agent, or use with only --target-org to end sessions for all agents found in the local session cache. Requires --target-org.",
1826
- "allowNo": false,
1827
- "type": "boolean"
1828
- },
1829
1798
  "no-prompt": {
1830
- "char": "p",
1831
1799
  "name": "no-prompt",
1832
- "summary": "Don't prompt for confirmation before ending sessions. Has an effect only when used with --all.",
1800
+ "summary": "Skip the confirmation prompt and delete the MCP server immediately.",
1833
1801
  "allowNo": false,
1834
1802
  "type": "boolean"
1835
1803
  }
1836
1804
  },
1837
1805
  "hasDynamicHelp": true,
1838
1806
  "hiddenAliases": [],
1839
- "id": "agent:preview:end",
1807
+ "id": "agent:mcp:delete",
1840
1808
  "pluginAlias": "@salesforce/plugin-agent",
1841
1809
  "pluginName": "@salesforce/plugin-agent",
1842
1810
  "pluginType": "core",
1811
+ "state": "preview",
1843
1812
  "strict": true,
1844
- "summary": "End an existing programmatic agent preview session and get trace location.",
1813
+ "summary": "Delete an MCP server from the API Catalog.",
1845
1814
  "enableJsonFlag": true,
1846
- "requiresProject": true,
1847
- "envVariablesSection": {
1848
- "header": "ENVIRONMENT VARIABLES",
1849
- "body": [
1850
- {
1851
- "name": "SF_TARGET_ORG",
1852
- "description": "Username or alias of your default org. Overrides the target-org configuration variable."
1853
- }
1854
- ]
1855
- },
1856
- "errorCodes": {
1857
- "header": "ERROR CODES",
1858
- "body": [
1859
- {
1860
- "name": "Succeeded (0)",
1861
- "description": "Preview session ended successfully and traces saved."
1862
- },
1863
- {
1864
- "name": "ExactlyOneRequired (2)",
1865
- "description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
1866
- },
1867
- {
1868
- "name": "NotFound (2)",
1869
- "description": "Agent not found, or no preview session exists for this agent."
1870
- },
1871
- {
1872
- "name": "PreviewEndFailed (4)",
1873
- "description": "Failed to end the preview session."
1874
- },
1875
- {
1876
- "name": "PreviewEndPartialFailure (68)",
1877
- "description": "With --all, one or more sessions failed to end while others succeeded."
1878
- },
1879
- {
1880
- "name": "SessionAmbiguous (5)",
1881
- "description": "Multiple preview sessions found; specify --session-id to choose one."
1882
- }
1883
- ]
1884
- },
1885
1815
  "isESM": true,
1886
1816
  "relativePath": [
1887
1817
  "lib",
1888
1818
  "commands",
1889
1819
  "agent",
1890
- "preview",
1891
- "end.js"
1820
+ "mcp",
1821
+ "delete.js"
1892
1822
  ],
1893
1823
  "aliasPermutations": [],
1894
1824
  "permutations": [
1895
- "agent:preview:end",
1896
- "preview:agent:end",
1897
- "preview:end:agent",
1898
- "agent:end:preview",
1899
- "end:agent:preview",
1900
- "end:preview:agent"
1825
+ "agent:mcp:delete",
1826
+ "mcp:agent:delete",
1827
+ "mcp:delete:agent",
1828
+ "agent:delete:mcp",
1829
+ "delete:agent:mcp",
1830
+ "delete:mcp:agent"
1901
1831
  ]
1902
1832
  },
1903
- "agent:preview:send": {
1833
+ "agent:mcp:fetch": {
1904
1834
  "aliases": [],
1905
1835
  "args": {},
1906
- "description": "You must have previously started a programmatic agent preview session with the \"agent preview start\" command to then use this command to send the agent a message (utterance). This command then displays the agent's response.\n\nThe original \"agent preview start\" command outputs a session ID which you then use with the --session-id flag of this command to send a message. You don't have to specify the --session-id flag if an agent has only one active preview session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.",
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.",
1907
1837
  "examples": [
1908
- "Send a message to an activated published agent using its API name and session ID; use the default org:\n<%= config.bin %> <%= command.id %> --utterance \"What can you help me with?\" --api-name My_Published_Agent --session-id <SESSION_ID>",
1909
- "Similar to previous example, but don't specify a session ID; you get an error if the agent has more than one active session. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --utterance \"What can you help me with?\" --api-name My_Published_Agent --target-org my-dev-org",
1910
- "Send a message to an agent using its authoring bundle API name; you get an error if the agent has more than one active session:\n<%= config.bin %> <%= command.id %> --utterance \"what can you help me with?\" --authoring-bundle My_Local_Agent"
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"
1911
1840
  ],
1912
1841
  "flags": {
1913
1842
  "json": {
@@ -1942,34 +1871,11 @@
1942
1871
  "multiple": false,
1943
1872
  "type": "option"
1944
1873
  },
1945
- "session-id": {
1946
- "name": "session-id",
1947
- "required": false,
1948
- "summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see list of all sessions.",
1949
- "hasDynamicHelp": false,
1950
- "multiple": false,
1951
- "type": "option"
1952
- },
1953
- "utterance": {
1954
- "char": "u",
1955
- "name": "utterance",
1874
+ "mcp-server-id": {
1875
+ "char": "i",
1876
+ "name": "mcp-server-id",
1956
1877
  "required": true,
1957
- "summary": "Utterance to send to the agent, enclosed in double quotes.",
1958
- "hasDynamicHelp": false,
1959
- "multiple": false,
1960
- "type": "option"
1961
- },
1962
- "api-name": {
1963
- "char": "n",
1964
- "name": "api-name",
1965
- "summary": "API name of the activated published agent you want to preview.",
1966
- "hasDynamicHelp": false,
1967
- "multiple": false,
1968
- "type": "option"
1969
- },
1970
- "authoring-bundle": {
1971
- "name": "authoring-bundle",
1972
- "summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
1878
+ "summary": "ID of the MCP server to fetch assets from.",
1973
1879
  "hasDynamicHelp": false,
1974
1880
  "multiple": false,
1975
1881
  "type": "option"
@@ -1977,68 +1883,39 @@
1977
1883
  },
1978
1884
  "hasDynamicHelp": true,
1979
1885
  "hiddenAliases": [],
1980
- "id": "agent:preview:send",
1886
+ "id": "agent:mcp:fetch",
1981
1887
  "pluginAlias": "@salesforce/plugin-agent",
1982
1888
  "pluginName": "@salesforce/plugin-agent",
1983
1889
  "pluginType": "core",
1890
+ "state": "preview",
1984
1891
  "strict": true,
1985
- "summary": "Send a message to an existing agent preview session.",
1892
+ "summary": "Fetch the live assets (tools, prompts, resources) advertised by an MCP server.",
1986
1893
  "enableJsonFlag": true,
1987
- "requiresProject": true,
1988
- "envVariablesSection": {
1989
- "header": "ENVIRONMENT VARIABLES",
1990
- "body": [
1991
- {
1992
- "name": "SF_TARGET_ORG",
1993
- "description": "Username or alias of your default org. Overrides the target-org configuration variable."
1994
- }
1995
- ]
1996
- },
1997
- "errorCodes": {
1998
- "header": "ERROR CODES",
1999
- "body": [
2000
- {
2001
- "name": "Succeeded (0)",
2002
- "description": "Message sent successfully and agent response received."
2003
- },
2004
- {
2005
- "name": "NotFound (2)",
2006
- "description": "Agent not found, or no preview session exists for this agent."
2007
- },
2008
- {
2009
- "name": "PreviewSendFailed (4)",
2010
- "description": "Failed to send message or receive response from the preview session."
2011
- },
2012
- {
2013
- "name": "SessionAmbiguous (5)",
2014
- "description": "Multiple preview sessions found; specify --session-id to choose one."
2015
- }
2016
- ]
2017
- },
2018
1894
  "isESM": true,
2019
1895
  "relativePath": [
2020
1896
  "lib",
2021
1897
  "commands",
2022
1898
  "agent",
2023
- "preview",
2024
- "send.js"
1899
+ "mcp",
1900
+ "fetch.js"
2025
1901
  ],
2026
1902
  "aliasPermutations": [],
2027
1903
  "permutations": [
2028
- "agent:preview:send",
2029
- "preview:agent:send",
2030
- "preview:send:agent",
2031
- "agent:send:preview",
2032
- "send:agent:preview",
2033
- "send:preview:agent"
1904
+ "agent:mcp:fetch",
1905
+ "mcp:agent:fetch",
1906
+ "mcp:fetch:agent",
1907
+ "agent:fetch:mcp",
1908
+ "fetch:agent:mcp",
1909
+ "fetch:mcp:agent"
2034
1910
  ]
2035
1911
  },
2036
- "agent:preview:sessions": {
1912
+ "agent:mcp:get": {
2037
1913
  "aliases": [],
2038
1914
  "args": {},
2039
- "description": "This command lists the agent preview sessions that were started with the \"agent preview start\" command and are still in the local cache. Use this command to discover specific session IDs that you can pass to the \"agent preview send\" or \"agent preview end\" commands with the --session-id flag.\n\nProgrammatic agent preview sessions can be started for both published activated agents and by using an agent's local authoring bundle, which contains its Agent Script file. In this command's output table, the Agent column contains either the API name of the authoring bundle or the published agent, whichever was used when starting the session. In the table, if the same API name has multiple rows with different session IDs, then it means that you previously started multiple preview sessions with the associated agent.",
1915
+ "description": "Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.",
2040
1916
  "examples": [
2041
- "List all cached agent preview sessions:\n<%= config.bin %> <%= command.id %>"
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"
2042
1919
  ],
2043
1920
  "flags": {
2044
1921
  "json": {
@@ -2055,53 +1932,69 @@
2055
1932
  "hasDynamicHelp": false,
2056
1933
  "multiple": false,
2057
1934
  "type": "option"
1935
+ },
1936
+ "target-org": {
1937
+ "char": "o",
1938
+ "name": "target-org",
1939
+ "noCacheDefault": true,
1940
+ "required": true,
1941
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1942
+ "hasDynamicHelp": true,
1943
+ "multiple": false,
1944
+ "type": "option"
1945
+ },
1946
+ "api-version": {
1947
+ "description": "Override the api version used for api requests made by this command",
1948
+ "name": "api-version",
1949
+ "hasDynamicHelp": false,
1950
+ "multiple": false,
1951
+ "type": "option"
1952
+ },
1953
+ "mcp-server-id": {
1954
+ "char": "i",
1955
+ "name": "mcp-server-id",
1956
+ "required": true,
1957
+ "summary": "The identifier of the MCP server to retrieve.",
1958
+ "hasDynamicHelp": false,
1959
+ "multiple": false,
1960
+ "type": "option"
2058
1961
  }
2059
1962
  },
2060
- "hasDynamicHelp": false,
1963
+ "hasDynamicHelp": true,
2061
1964
  "hiddenAliases": [],
2062
- "id": "agent:preview:sessions",
1965
+ "id": "agent:mcp:get",
2063
1966
  "pluginAlias": "@salesforce/plugin-agent",
2064
1967
  "pluginName": "@salesforce/plugin-agent",
2065
1968
  "pluginType": "core",
1969
+ "state": "preview",
2066
1970
  "strict": true,
2067
- "summary": "List all known programmatic agent preview sessions.",
1971
+ "summary": "Get a single MCP server registered in the API Catalog.",
2068
1972
  "enableJsonFlag": true,
2069
- "requiresProject": true,
2070
- "errorCodes": {
2071
- "header": "ERROR CODES",
2072
- "body": [
2073
- {
2074
- "name": "Succeeded (0)",
2075
- "description": "Sessions listed successfully (or empty list if no active sessions)."
2076
- }
2077
- ]
2078
- },
2079
1973
  "isESM": true,
2080
1974
  "relativePath": [
2081
1975
  "lib",
2082
1976
  "commands",
2083
1977
  "agent",
2084
- "preview",
2085
- "sessions.js"
1978
+ "mcp",
1979
+ "get.js"
2086
1980
  ],
2087
1981
  "aliasPermutations": [],
2088
1982
  "permutations": [
2089
- "agent:preview:sessions",
2090
- "preview:agent:sessions",
2091
- "preview:sessions:agent",
2092
- "agent:sessions:preview",
2093
- "sessions:agent:preview",
2094
- "sessions:preview:agent"
2095
- ]
2096
- },
2097
- "agent:preview:start": {
2098
- "aliases": [],
1983
+ "agent:mcp:get",
1984
+ "mcp:agent:get",
1985
+ "mcp:get:agent",
1986
+ "agent:get:mcp",
1987
+ "get:agent:mcp",
1988
+ "get:mcp:agent"
1989
+ ]
1990
+ },
1991
+ "agent:mcp:list": {
1992
+ "aliases": [],
2099
1993
  "args": {},
2100
- "description": "This command outputs a session ID that you then use with the \"agent preview send\" command to send an utterance to the agent. Use the \"agent preview sessions\" command to list all active sessions and the \"agent preview end\" command to end a specific session.\n\nIdentify the agent you want to start previewing with either the --authoring-bundle flag to specify a local authoring bundle's API name or --api-name to specify an activated published agent's API name. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.\n\nWhen starting a preview session with --authoring-bundle, you must explicitly specify the execution mode using one of these flags:\n\n- --use-live-actions: Executes real Apex classes, flows, and other actions in the org. This surfaces compile and validation errors during preview.\n- --simulate-actions: Uses AI to simulate action execution without calling real implementations.\n\nPublished agents (--api-name) always use live actions. The mode flags are optional and have no effect for published agents.",
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.",
2101
1995
  "examples": [
2102
- "Start a programmatic agent preview session by specifying an authoring bundle; use simulated actions. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --target-org my-dev-org --simulate-actions",
2103
- "Similar to previous example but use live actions and the default org:\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --use-live-actions",
2104
- "Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
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"
2105
1998
  ],
2106
1999
  "flags": {
2107
2000
  "json": {
@@ -2136,132 +2029,70 @@
2136
2029
  "multiple": false,
2137
2030
  "type": "option"
2138
2031
  },
2139
- "api-name": {
2140
- "char": "n",
2141
- "name": "api-name",
2142
- "summary": "API name of the activated published agent you want to preview.",
2032
+ "label": {
2033
+ "name": "label",
2034
+ "summary": "Filter the MCP servers by label.",
2143
2035
  "hasDynamicHelp": false,
2144
2036
  "multiple": false,
2145
2037
  "type": "option"
2146
2038
  },
2147
- "authoring-bundle": {
2148
- "name": "authoring-bundle",
2149
- "summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
2039
+ "type": {
2040
+ "name": "type",
2041
+ "summary": "Filter the MCP servers by type.",
2150
2042
  "hasDynamicHelp": false,
2151
2043
  "multiple": false,
2152
- "type": "option"
2153
- },
2154
- "use-live-actions": {
2155
- "exclusive": [
2156
- "simulate-actions"
2157
- ],
2158
- "name": "use-live-actions",
2159
- "summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
2160
- "allowNo": false,
2161
- "type": "boolean"
2162
- },
2163
- "simulate-actions": {
2164
- "exclusive": [
2165
- "use-live-actions"
2044
+ "options": [
2045
+ "EXTERNAL"
2166
2046
  ],
2167
- "name": "simulate-actions",
2168
- "summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
2169
- "allowNo": false,
2170
- "type": "boolean"
2171
- },
2172
- "context-variables": {
2173
- "description": "Sets variables on the agent preview session, mirroring what the in-org Agentforce Builder UI does when you override variables before sending a message. Specify this flag multiple times or use comma-separated values. Two namespaces are supported, distinguished by the name shape. Names pass through to the runtime verbatim — the CLI doesn't transform them.\n\nLinked context variables use the \"$Context.\" prefix. These map to externally-provided fields that the runtime resolves (declared in the bundle's globalConfiguration.contextVariables) and are read by live actions and topic-routing expressions via $Context.Name. Example: $Context.MyLinkedVar=some-value.\n\nState variables use the bare developerName, no prefix. These seed mutable agent state declared in agentVersion.stateVariables. Example: MyStateVar=some-value.\n\nBoth namespaces can be mixed in one value. Example: --context-variables '$Context.MyLinkedVar=foo,MyStateVar=bar'.\n\nTips: (1) Quote the whole value in single quotes so $Context isn't shell-expanded. (2) Names are sent verbatim — a bare name is treated as a state variable, not a linked context variable, so live actions that bind via $Context.Name will see null. (3) Type defaults to Text.",
2174
- "name": "context-variables",
2175
- "summary": "Session variables for the agent preview session, in the form Name=Value.",
2176
- "delimiter": ",",
2177
- "hasDynamicHelp": false,
2178
- "multiple": true,
2179
2047
  "type": "option"
2180
2048
  },
2181
- "agent-json": {
2182
- "dependsOn": [
2183
- "authoring-bundle"
2184
- ],
2185
- "hidden": true,
2186
- "name": "agent-json",
2187
- "summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
2049
+ "status": {
2050
+ "name": "status",
2051
+ "summary": "Filter the MCP servers by connection status. Only ACTIVE and DISCONNECTED are supported as filters.",
2188
2052
  "hasDynamicHelp": false,
2189
2053
  "multiple": false,
2054
+ "options": [
2055
+ "ACTIVE",
2056
+ "DISCONNECTED"
2057
+ ],
2190
2058
  "type": "option"
2191
2059
  }
2192
2060
  },
2193
2061
  "hasDynamicHelp": true,
2194
2062
  "hiddenAliases": [],
2195
- "id": "agent:preview:start",
2063
+ "id": "agent:mcp:list",
2196
2064
  "pluginAlias": "@salesforce/plugin-agent",
2197
2065
  "pluginName": "@salesforce/plugin-agent",
2198
2066
  "pluginType": "core",
2067
+ "state": "preview",
2199
2068
  "strict": true,
2200
- "summary": "Start a programmatic agent preview session.",
2069
+ "summary": "List the MCP servers registered in the API Catalog.",
2201
2070
  "enableJsonFlag": true,
2202
- "requiresProject": true,
2203
- "envVariablesSection": {
2204
- "header": "ENVIRONMENT VARIABLES",
2205
- "body": [
2206
- {
2207
- "name": "SF_TARGET_ORG",
2208
- "description": "Username or alias of your default org. Overrides the target-org configuration variable."
2209
- }
2210
- ]
2211
- },
2212
- "errorCodes": {
2213
- "header": "ERROR CODES",
2214
- "body": [
2215
- {
2216
- "name": "Succeeded (0)",
2217
- "description": "Preview session started successfully."
2218
- },
2219
- {
2220
- "name": "Failed (1)",
2221
- "description": "Agent Script compilation failed (syntax errors in the script)."
2222
- },
2223
- {
2224
- "name": "NotFound (2)",
2225
- "description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
2226
- },
2227
- {
2228
- "name": "ServerError (3)",
2229
- "description": "Compilation API returned HTTP 500 (server error during compilation)."
2230
- },
2231
- {
2232
- "name": "PreviewStartFailed (4)",
2233
- "description": "Preview session failed to start due to API or network errors."
2234
- }
2235
- ]
2236
- },
2237
2071
  "isESM": true,
2238
2072
  "relativePath": [
2239
2073
  "lib",
2240
2074
  "commands",
2241
2075
  "agent",
2242
- "preview",
2243
- "start.js"
2076
+ "mcp",
2077
+ "list.js"
2244
2078
  ],
2245
2079
  "aliasPermutations": [],
2246
2080
  "permutations": [
2247
- "agent:preview:start",
2248
- "preview:agent:start",
2249
- "preview:start:agent",
2250
- "agent:start:preview",
2251
- "start:agent:preview",
2252
- "start:preview:agent"
2081
+ "agent:mcp:list",
2082
+ "mcp:agent:list",
2083
+ "mcp:list:agent",
2084
+ "agent:list:mcp",
2085
+ "list:agent:mcp",
2086
+ "list:mcp:agent"
2253
2087
  ]
2254
2088
  },
2255
- "agent:generate:agent-spec": {
2089
+ "agent:mcp:update": {
2256
2090
  "aliases": [],
2257
2091
  "args": {},
2258
- "description": "An agent spec is a YAML-formatted file that contains basic information about the agent, such as its role, company description, and an AI-generated list of topics based on this information. Topics define the range of jobs your agent can handle.\n\nUse flags, such as --role and --company-description, to provide details about your company and the role that the agent plays in your company. If you prefer, you can also be prompted for the basic information; use --full-interview to be prompted for all required and optional properties. Upon command execution, the large language model (LLM) associated with your org uses the provided information to generate a list of topics for the agent. Because the LLM uses the company and role information to generate the topics, we recommend that you provide accurate, complete, and specific details so the LLM generates the best and most relevant topics. Once generated, you can edit the spec file; for example, you can remove topics that don't apply or change a topic's description.\n\nYou can also iterate the spec generation process by using the --spec flag to pass an existing agent spec file to this command, and then using the --role, --company-description, etc, flags to refine your agent properties. Iteratively improving the description of your agent allows the LLM to generate progressively better topics.\n\nYou can also specify other agent properties, such as a custom prompt template, how to ground the prompt template to add context to the agent's prompts, the tone of the prompts, and the username of a user in the org to assign to the agent.\n\nWhen your agent spec is ready, generate an authoring bundle from it by passing the spec file to the --spec flag of the \"agent generate authoring-bundle\" CLI command. An authoring bundle is a metadata type that contains an Agent Script file, which is the blueprint for an agent. (While not recommended, you can also use the agent spec file to immediately create an agent with the \"agent create\" command. We don't recommend this workflow because these types of agents don't use Agent Script, and are thus less flexible and more difficult to maintain.)",
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.",
2259
2093
  "examples": [
2260
- "Generate an agent spec in the default location and use flags to specify the agent properties, such as its role and your company details; use your default org:\n<%= config.bin %> <%= command.id %> --type customer --role \"Field customer complaints and manage employee schedules.\" --company-name \"Coral Cloud Resorts\" --company-description \"Provide customers with exceptional destination activities, unforgettable experiences, and reservation services.\"",
2261
- "Generate an agent spec by being prompted for the required agent properties and generate a maxiumum of 5 topics; write the generated file to the \"specs/resortManagerSpec.yaml\" file and use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --max-topics 5 --output-file specs/resortManagerAgent.yaml --target-org my-org",
2262
- "Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
2263
- "Specify an existing agent spec file called \"specs/resortManagerAgent.yaml\", and then overwrite it with a new version that contains newly AI-generated topics based on the updated role information passed in with the --role flag:\n<%= config.bin %> <%= command.id %> --spec specs/resortManagerAgent.yaml --output-file specs/resortManagerAgent.yaml --role \"Field customer complaints, manage employee schedules, and ensure all resort operations are running smoothly\"",
2264
- "Specify that the conversational tone of the agent is formal and to attach the \"resortmanager@myorg.com\" username to it; be prompted for the required properties and use your default org:\n<%= config.bin %> <%= command.id %> --tone formal --agent-user resortmanager@myorg.com"
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"
2265
2096
  ],
2266
2097
  "flags": {
2267
2098
  "json": {
@@ -2296,164 +2127,114 @@
2296
2127
  "multiple": false,
2297
2128
  "type": "option"
2298
2129
  },
2299
- "type": {
2300
- "name": "type",
2301
- "summary": "Type of agent to create. Internal types are copilots used internally by your company and customer types are the agents you create for your customers.",
2302
- "hasDynamicHelp": false,
2303
- "multiple": false,
2304
- "options": [
2305
- "customer",
2306
- "internal"
2307
- ],
2308
- "type": "option"
2309
- },
2310
- "role": {
2311
- "name": "role",
2312
- "summary": "Role of the agent.",
2313
- "hasDynamicHelp": false,
2314
- "multiple": false,
2315
- "type": "option"
2316
- },
2317
- "company-name": {
2318
- "name": "company-name",
2319
- "summary": "Name of your company.",
2320
- "hasDynamicHelp": false,
2321
- "multiple": false,
2322
- "type": "option"
2323
- },
2324
- "company-description": {
2325
- "name": "company-description",
2326
- "summary": "Description of your company.",
2327
- "hasDynamicHelp": false,
2328
- "multiple": false,
2329
- "type": "option"
2330
- },
2331
- "company-website": {
2332
- "name": "company-website",
2333
- "summary": "Website URL of your company.",
2130
+ "mcp-server-id": {
2131
+ "char": "i",
2132
+ "name": "mcp-server-id",
2133
+ "required": true,
2134
+ "summary": "ID of the MCP server to update.",
2334
2135
  "hasDynamicHelp": false,
2335
2136
  "multiple": false,
2336
2137
  "type": "option"
2337
2138
  },
2338
- "max-topics": {
2339
- "name": "max-topics",
2340
- "summary": "Maximum number of topics to generate in the agent spec; default is 5.",
2139
+ "label": {
2140
+ "name": "label",
2141
+ "summary": "New display label for the MCP server.",
2341
2142
  "hasDynamicHelp": false,
2342
2143
  "multiple": false,
2343
2144
  "type": "option"
2344
2145
  },
2345
- "agent-user": {
2346
- "name": "agent-user",
2347
- "summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
2146
+ "description": {
2147
+ "name": "description",
2148
+ "summary": "New description for the MCP server.",
2348
2149
  "hasDynamicHelp": false,
2349
2150
  "multiple": false,
2350
2151
  "type": "option"
2351
2152
  },
2352
- "enrich-logs": {
2353
- "name": "enrich-logs",
2354
- "summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
2153
+ "server-url": {
2154
+ "name": "server-url",
2155
+ "summary": "New endpoint URL of the MCP server.",
2355
2156
  "hasDynamicHelp": false,
2356
2157
  "multiple": false,
2357
- "options": [
2358
- "true",
2359
- "false"
2360
- ],
2361
2158
  "type": "option"
2362
2159
  },
2363
- "tone": {
2364
- "name": "tone",
2365
- "summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
2160
+ "auth-type": {
2161
+ "name": "auth-type",
2162
+ "summary": "Authorization type to apply to the MCP server (OAUTH or NO_AUTH).",
2366
2163
  "hasDynamicHelp": false,
2367
2164
  "multiple": false,
2368
2165
  "options": [
2369
- "formal",
2370
- "casual",
2371
- "neutral"
2166
+ "OAUTH",
2167
+ "NO_AUTH"
2372
2168
  ],
2373
2169
  "type": "option"
2374
2170
  },
2375
- "spec": {
2376
- "name": "spec",
2377
- "summary": "Agent spec file, in YAML format, to use as input to the command.",
2171
+ "identity-provider": {
2172
+ "name": "identity-provider",
2173
+ "summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
2378
2174
  "hasDynamicHelp": false,
2379
2175
  "multiple": false,
2380
2176
  "type": "option"
2381
2177
  },
2382
- "output-file": {
2383
- "name": "output-file",
2384
- "summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
2385
- "default": "specs/agentSpec.yaml",
2178
+ "client-id": {
2179
+ "name": "client-id",
2180
+ "summary": "OAuth client ID (required when --auth-type is OAUTH).",
2386
2181
  "hasDynamicHelp": false,
2387
2182
  "multiple": false,
2388
2183
  "type": "option"
2389
2184
  },
2390
- "full-interview": {
2391
- "name": "full-interview",
2392
- "summary": "Prompt for both required and optional flags.",
2393
- "allowNo": false,
2394
- "type": "boolean"
2395
- },
2396
- "prompt-template": {
2397
- "name": "prompt-template",
2398
- "summary": "API name of a customized prompt template to use instead of the default prompt template.",
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.",
2399
2188
  "hasDynamicHelp": false,
2400
2189
  "multiple": false,
2401
2190
  "type": "option"
2402
2191
  },
2403
- "grounding-context": {
2404
- "dependsOn": [
2405
- "prompt-template"
2406
- ],
2407
- "name": "grounding-context",
2408
- "summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
2192
+ "scope": {
2193
+ "name": "scope",
2194
+ "summary": "OAuth scope (required when --auth-type is OAUTH).",
2409
2195
  "hasDynamicHelp": false,
2410
2196
  "multiple": false,
2411
2197
  "type": "option"
2412
- },
2413
- "force-overwrite": {
2414
- "name": "force-overwrite",
2415
- "summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
2416
- "allowNo": false,
2417
- "type": "boolean"
2418
2198
  }
2419
2199
  },
2420
2200
  "hasDynamicHelp": true,
2421
2201
  "hiddenAliases": [],
2422
- "id": "agent:generate:agent-spec",
2202
+ "id": "agent:mcp:update",
2423
2203
  "pluginAlias": "@salesforce/plugin-agent",
2424
2204
  "pluginName": "@salesforce/plugin-agent",
2425
2205
  "pluginType": "core",
2206
+ "state": "preview",
2426
2207
  "strict": true,
2427
- "summary": "Generate an agent spec, which is a YAML file that captures what an agent can do.",
2208
+ "summary": "Update an MCP server registered in the API Catalog.",
2428
2209
  "enableJsonFlag": true,
2429
- "requiresProject": true,
2430
2210
  "isESM": true,
2431
2211
  "relativePath": [
2432
2212
  "lib",
2433
2213
  "commands",
2434
2214
  "agent",
2435
- "generate",
2436
- "agent-spec.js"
2215
+ "mcp",
2216
+ "update.js"
2437
2217
  ],
2438
2218
  "aliasPermutations": [],
2439
2219
  "permutations": [
2440
- "agent:generate:agent-spec",
2441
- "generate:agent:agent-spec",
2442
- "generate:agent-spec:agent",
2443
- "agent:agent-spec:generate",
2444
- "agent-spec:agent:generate",
2445
- "agent-spec:generate:agent"
2220
+ "agent:mcp:update",
2221
+ "mcp:agent:update",
2222
+ "mcp:update:agent",
2223
+ "agent:update:mcp",
2224
+ "update:agent:mcp",
2225
+ "update:mcp:agent"
2446
2226
  ]
2447
2227
  },
2448
- "agent:generate:authoring-bundle": {
2228
+ "agent:preview:end": {
2449
2229
  "aliases": [],
2450
2230
  "args": {},
2451
- "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.",
2231
+ "description": "You must have previously started a programmatic agent preview session with the \"agent preview start\" command to then use this command to end it. This command also displays the local directory where the session trace files are stored.\n\nThe original \"agent preview start\" command outputs a session ID which you then use with the --session-id flag of this command to end the session. You don't have to specify the --session-id flag if an agent has only one active preview session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring bundle or the published agent, respectively. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.\n\nUse the --all flag to end all active preview sessions at once. You can combine --all with --api-name or --authoring-bundle to end only sessions for a specific agent, or use --all on its own to end every session across all agents in the project.",
2452
2232
  "examples": [
2453
- "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 %>",
2454
- "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\"",
2455
- "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\"",
2456
- "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"
2233
+ "End a preview session of a published agent by specifying its session ID and API name; use the default org:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --api-name My_Published_Agent",
2234
+ "Similar to previous example, but don't specify a session ID; you get an error if the published agent has more than one active session. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent --target-org my-dev-org",
2235
+ "End a preview session of an agent using its authoring bundle API name; you get an error if the agent has more than one active session.\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Local_Agent",
2236
+ "End all active preview sessions for a specific agent without prompting:\n<%= config.bin %> <%= command.id %> --all --authoring-bundle My_Local_Agent --target-org <target_org> --no-prompt",
2237
+ "End all active preview sessions across every agent in the local session cache for an org:\n<%= config.bin %> <%= command.id %> --all --target-org <target_org>"
2457
2238
  ],
2458
2239
  "flags": {
2459
2240
  "json": {
@@ -2481,13 +2262,6 @@
2481
2262
  "multiple": false,
2482
2263
  "type": "option"
2483
2264
  },
2484
- "api-name": {
2485
- "name": "api-name",
2486
- "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.",
2487
- "hasDynamicHelp": false,
2488
- "multiple": false,
2489
- "type": "option"
2490
- },
2491
2265
  "api-version": {
2492
2266
  "description": "Override the api version used for api requests made by this command",
2493
2267
  "name": "api-version",
@@ -2495,77 +2269,129 @@
2495
2269
  "multiple": false,
2496
2270
  "type": "option"
2497
2271
  },
2498
- "spec": {
2499
- "char": "f",
2500
- "name": "spec",
2501
- "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.",
2272
+ "session-id": {
2273
+ "exclusive": [
2274
+ "all"
2275
+ ],
2276
+ "name": "session-id",
2277
+ "required": false,
2278
+ "summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see the list of all sessions.",
2502
2279
  "hasDynamicHelp": false,
2503
2280
  "multiple": false,
2504
2281
  "type": "option"
2505
2282
  },
2506
- "no-spec": {
2507
- "name": "no-spec",
2508
- "summary": "Skip prompting for an agent spec and use the default Agent Script boilerplate in the generated authoring bundle.",
2509
- "allowNo": false,
2510
- "type": "boolean"
2511
- },
2512
- "output-dir": {
2513
- "char": "d",
2514
- "name": "output-dir",
2515
- "summary": "Directory where the authoring bundle files are generated.",
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.",
2516
2290
  "hasDynamicHelp": false,
2517
2291
  "multiple": false,
2518
2292
  "type": "option"
2519
2293
  },
2520
- "name": {
2521
- "char": "n",
2522
- "name": "name",
2523
- "summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
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.",
2524
2300
  "hasDynamicHelp": false,
2525
2301
  "multiple": false,
2526
2302
  "type": "option"
2527
2303
  },
2528
- "force-overwrite": {
2529
- "name": "force-overwrite",
2530
- "summary": "Overwrite the existing authoring bundle if one with the same API name already exists locally.",
2304
+ "all": {
2305
+ "exclusive": [
2306
+ "session-id"
2307
+ ],
2308
+ "name": "all",
2309
+ "summary": "End all active preview sessions. Combine with --api-name or --authoring-bundle to limit to a specific agent, or use with only --target-org to end sessions for all agents found in the local session cache. Requires --target-org.",
2310
+ "allowNo": false,
2311
+ "type": "boolean"
2312
+ },
2313
+ "no-prompt": {
2314
+ "char": "p",
2315
+ "name": "no-prompt",
2316
+ "summary": "Don't prompt for confirmation before ending sessions. Has an effect only when used with --all.",
2531
2317
  "allowNo": false,
2532
2318
  "type": "boolean"
2533
2319
  }
2534
2320
  },
2535
2321
  "hasDynamicHelp": true,
2536
2322
  "hiddenAliases": [],
2537
- "id": "agent:generate:authoring-bundle",
2323
+ "id": "agent:preview:end",
2538
2324
  "pluginAlias": "@salesforce/plugin-agent",
2539
2325
  "pluginName": "@salesforce/plugin-agent",
2540
2326
  "pluginType": "core",
2541
2327
  "strict": true,
2542
- "summary": "Generate an authoring bundle from an existing agent spec YAML file.",
2328
+ "summary": "End an existing programmatic agent preview session and get trace location.",
2543
2329
  "enableJsonFlag": true,
2544
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
+ },
2545
2369
  "isESM": true,
2546
2370
  "relativePath": [
2547
2371
  "lib",
2548
2372
  "commands",
2549
2373
  "agent",
2550
- "generate",
2551
- "authoring-bundle.js"
2374
+ "preview",
2375
+ "end.js"
2552
2376
  ],
2553
2377
  "aliasPermutations": [],
2554
2378
  "permutations": [
2555
- "agent:generate:authoring-bundle",
2556
- "generate:agent:authoring-bundle",
2557
- "generate:authoring-bundle:agent",
2558
- "agent:authoring-bundle:generate",
2559
- "authoring-bundle:agent:generate",
2560
- "authoring-bundle:generate:agent"
2379
+ "agent:preview:end",
2380
+ "preview:agent:end",
2381
+ "preview:end:agent",
2382
+ "agent:end:preview",
2383
+ "end:agent:preview",
2384
+ "end:preview:agent"
2561
2385
  ]
2562
2386
  },
2563
- "agent:generate:template": {
2387
+ "agent:preview:send": {
2564
2388
  "aliases": [],
2565
2389
  "args": {},
2566
- "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.",
2390
+ "description": "You must have previously started a programmatic agent preview session with the \"agent preview start\" command to then use this command to send the agent a message (utterance). This command then displays the agent's response.\n\nThe original \"agent preview start\" command outputs a session ID which you then use with the --session-id flag of this command to send a message. You don't have to specify the --session-id flag if an agent has only one active preview session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.",
2567
2391
  "examples": [
2568
- "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"
2392
+ "Send a message to an activated published agent using its API name and session ID; use the default org:\n<%= config.bin %> <%= command.id %> --utterance \"What can you help me with?\" --api-name My_Published_Agent --session-id <SESSION_ID>",
2393
+ "Similar to previous example, but don't specify a session ID; you get an error if the agent has more than one active session. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --utterance \"What can you help me with?\" --api-name My_Published_Agent --target-org my-dev-org",
2394
+ "Send a message to an agent using its authoring bundle API name; you get an error if the agent has more than one active session:\n<%= config.bin %> <%= command.id %> --utterance \"what can you help me with?\" --authoring-bundle My_Local_Agent"
2569
2395
  ],
2570
2396
  "flags": {
2571
2397
  "json": {
@@ -2583,6 +2409,16 @@
2583
2409
  "multiple": false,
2584
2410
  "type": "option"
2585
2411
  },
2412
+ "target-org": {
2413
+ "char": "o",
2414
+ "name": "target-org",
2415
+ "noCacheDefault": true,
2416
+ "required": true,
2417
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2418
+ "hasDynamicHelp": true,
2419
+ "multiple": false,
2420
+ "type": "option"
2421
+ },
2586
2422
  "api-version": {
2587
2423
  "description": "Override the api version used for api requests made by this command",
2588
2424
  "name": "api-version",
@@ -2590,37 +2426,34 @@
2590
2426
  "multiple": false,
2591
2427
  "type": "option"
2592
2428
  },
2593
- "source-org": {
2594
- "char": "s",
2595
- "name": "source-org",
2596
- "noCacheDefault": true,
2597
- "required": true,
2598
- "summary": "Username or alias of the namespaced scratch org that contains the agent which this template is based on.",
2599
- "hasDynamicHelp": true,
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,
2600
2434
  "multiple": false,
2601
2435
  "type": "option"
2602
2436
  },
2603
- "agent-version": {
2604
- "name": "agent-version",
2437
+ "utterance": {
2438
+ "char": "u",
2439
+ "name": "utterance",
2605
2440
  "required": true,
2606
- "summary": "Version of the agent (BotVersion).",
2441
+ "summary": "Utterance to send to the agent, enclosed in double quotes.",
2607
2442
  "hasDynamicHelp": false,
2608
2443
  "multiple": false,
2609
2444
  "type": "option"
2610
2445
  },
2611
- "agent-file": {
2612
- "char": "f",
2613
- "name": "agent-file",
2614
- "required": true,
2615
- "summary": "Path to an agent (Bot) metadata file.",
2446
+ "api-name": {
2447
+ "char": "n",
2448
+ "name": "api-name",
2449
+ "summary": "API name of the activated published agent you want to preview.",
2616
2450
  "hasDynamicHelp": false,
2617
2451
  "multiple": false,
2618
2452
  "type": "option"
2619
2453
  },
2620
- "output-dir": {
2621
- "char": "r",
2622
- "name": "output-dir",
2623
- "summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
2454
+ "authoring-bundle": {
2455
+ "name": "authoring-bundle",
2456
+ "summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
2624
2457
  "hasDynamicHelp": false,
2625
2458
  "multiple": false,
2626
2459
  "type": "option"
@@ -2628,44 +2461,140 @@
2628
2461
  },
2629
2462
  "hasDynamicHelp": true,
2630
2463
  "hiddenAliases": [],
2631
- "id": "agent:generate:template",
2464
+ "id": "agent:preview:send",
2632
2465
  "pluginAlias": "@salesforce/plugin-agent",
2633
2466
  "pluginName": "@salesforce/plugin-agent",
2634
2467
  "pluginType": "core",
2635
2468
  "strict": true,
2636
- "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.",
2469
+ "summary": "Send a message to an existing agent preview session.",
2470
+ "enableJsonFlag": true,
2471
+ "requiresProject": true,
2472
+ "envVariablesSection": {
2473
+ "header": "ENVIRONMENT VARIABLES",
2474
+ "body": [
2475
+ {
2476
+ "name": "SF_TARGET_ORG",
2477
+ "description": "Username or alias of your default org. Overrides the target-org configuration variable."
2478
+ }
2479
+ ]
2480
+ },
2481
+ "errorCodes": {
2482
+ "header": "ERROR CODES",
2483
+ "body": [
2484
+ {
2485
+ "name": "Succeeded (0)",
2486
+ "description": "Message sent successfully and agent response received."
2487
+ },
2488
+ {
2489
+ "name": "NotFound (2)",
2490
+ "description": "Agent not found, or no preview session exists for this agent."
2491
+ },
2492
+ {
2493
+ "name": "PreviewSendFailed (4)",
2494
+ "description": "Failed to send message or receive response from the preview session."
2495
+ },
2496
+ {
2497
+ "name": "SessionAmbiguous (5)",
2498
+ "description": "Multiple preview sessions found; specify --session-id to choose one."
2499
+ }
2500
+ ]
2501
+ },
2502
+ "isESM": true,
2503
+ "relativePath": [
2504
+ "lib",
2505
+ "commands",
2506
+ "agent",
2507
+ "preview",
2508
+ "send.js"
2509
+ ],
2510
+ "aliasPermutations": [],
2511
+ "permutations": [
2512
+ "agent:preview:send",
2513
+ "preview:agent:send",
2514
+ "preview:send:agent",
2515
+ "agent:send:preview",
2516
+ "send:agent:preview",
2517
+ "send:preview:agent"
2518
+ ]
2519
+ },
2520
+ "agent:preview:sessions": {
2521
+ "aliases": [],
2522
+ "args": {},
2523
+ "description": "This command lists the agent preview sessions that were started with the \"agent preview start\" command and are still in the local cache. Use this command to discover specific session IDs that you can pass to the \"agent preview send\" or \"agent preview end\" commands with the --session-id flag.\n\nProgrammatic agent preview sessions can be started for both published activated agents and by using an agent's local authoring bundle, which contains its Agent Script file. In this command's output table, the Agent column contains either the API name of the authoring bundle or the published agent, whichever was used when starting the session. In the table, if the same API name has multiple rows with different session IDs, then it means that you previously started multiple preview sessions with the associated agent.",
2524
+ "examples": [
2525
+ "List all cached agent preview sessions:\n<%= config.bin %> <%= command.id %>"
2526
+ ],
2527
+ "flags": {
2528
+ "json": {
2529
+ "description": "Format output as json.",
2530
+ "helpGroup": "GLOBAL",
2531
+ "name": "json",
2532
+ "allowNo": false,
2533
+ "type": "boolean"
2534
+ },
2535
+ "flags-dir": {
2536
+ "helpGroup": "GLOBAL",
2537
+ "name": "flags-dir",
2538
+ "summary": "Import flag values from a directory.",
2539
+ "hasDynamicHelp": false,
2540
+ "multiple": false,
2541
+ "type": "option"
2542
+ }
2543
+ },
2544
+ "hasDynamicHelp": false,
2545
+ "hiddenAliases": [],
2546
+ "id": "agent:preview:sessions",
2547
+ "pluginAlias": "@salesforce/plugin-agent",
2548
+ "pluginName": "@salesforce/plugin-agent",
2549
+ "pluginType": "core",
2550
+ "strict": true,
2551
+ "summary": "List all known programmatic agent preview sessions.",
2637
2552
  "enableJsonFlag": true,
2638
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
+ },
2639
2563
  "isESM": true,
2640
2564
  "relativePath": [
2641
2565
  "lib",
2642
2566
  "commands",
2643
2567
  "agent",
2644
- "generate",
2645
- "template.js"
2568
+ "preview",
2569
+ "sessions.js"
2646
2570
  ],
2647
2571
  "aliasPermutations": [],
2648
2572
  "permutations": [
2649
- "agent:generate:template",
2650
- "generate:agent:template",
2651
- "generate:template:agent",
2652
- "agent:template:generate",
2653
- "template:agent:generate",
2654
- "template:generate:agent"
2573
+ "agent:preview:sessions",
2574
+ "preview:agent:sessions",
2575
+ "preview:sessions:agent",
2576
+ "agent:sessions:preview",
2577
+ "sessions:agent:preview",
2578
+ "sessions:preview:agent"
2655
2579
  ]
2656
2580
  },
2657
- "agent:generate:test-spec": {
2581
+ "agent:preview:start": {
2658
2582
  "aliases": [],
2659
2583
  "args": {},
2660
- "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.",
2584
+ "description": "This command outputs a session ID that you then use with the \"agent preview send\" command to send an utterance to the agent. Use the \"agent preview sessions\" command to list all active sessions and the \"agent preview end\" command to end a specific session.\n\nIdentify the agent you want to start previewing with either the --authoring-bundle flag to specify a local authoring bundle's API name or --api-name to specify an activated published agent's API name. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.\n\nWhen starting a preview session with --authoring-bundle, you must explicitly specify the execution mode using one of these flags:\n\n- --use-live-actions: Executes real Apex classes, flows, and other actions in the org. This surfaces compile and validation errors during preview.\n- --simulate-actions: Uses AI to simulate action execution without calling real implementations.\n\nPublished agents (--api-name) always use live actions. The mode flags are optional and have no effect for published agents.",
2661
2585
  "examples": [
2662
- "Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
2663
- "Generate an Agentforce Studio (NGT) test spec YAML file interactively:\n<%= config.bin %> <%= command.id %> --test-runner agentforce-studio",
2664
- "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",
2665
- "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",
2666
- "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"
2586
+ "Start a programmatic agent preview session by specifying an authoring bundle; use simulated actions. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --target-org my-dev-org --simulate-actions",
2587
+ "Similar to previous example but use live actions and the default org:\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --use-live-actions",
2588
+ "Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
2667
2589
  ],
2668
2590
  "flags": {
2591
+ "json": {
2592
+ "description": "Format output as json.",
2593
+ "helpGroup": "GLOBAL",
2594
+ "name": "json",
2595
+ "allowNo": false,
2596
+ "type": "boolean"
2597
+ },
2669
2598
  "flags-dir": {
2670
2599
  "helpGroup": "GLOBAL",
2671
2600
  "name": "flags-dir",
@@ -2674,66 +2603,137 @@
2674
2603
  "multiple": false,
2675
2604
  "type": "option"
2676
2605
  },
2677
- "from-definition": {
2678
- "char": "d",
2679
- "name": "from-definition",
2680
- "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.",
2606
+ "target-org": {
2607
+ "char": "o",
2608
+ "name": "target-org",
2609
+ "noCacheDefault": true,
2610
+ "required": true,
2611
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2612
+ "hasDynamicHelp": true,
2613
+ "multiple": false,
2614
+ "type": "option"
2615
+ },
2616
+ "api-version": {
2617
+ "description": "Override the api version used for api requests made by this command",
2618
+ "name": "api-version",
2681
2619
  "hasDynamicHelp": false,
2682
2620
  "multiple": false,
2683
2621
  "type": "option"
2684
2622
  },
2685
- "force-overwrite": {
2686
- "name": "force-overwrite",
2687
- "summary": "Don't prompt for confirmation when overwriting an existing test spec YAML file.",
2623
+ "api-name": {
2624
+ "char": "n",
2625
+ "name": "api-name",
2626
+ "summary": "API name of the activated published agent you want to preview.",
2627
+ "hasDynamicHelp": false,
2628
+ "multiple": false,
2629
+ "type": "option"
2630
+ },
2631
+ "authoring-bundle": {
2632
+ "name": "authoring-bundle",
2633
+ "summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
2634
+ "hasDynamicHelp": false,
2635
+ "multiple": false,
2636
+ "type": "option"
2637
+ },
2638
+ "use-live-actions": {
2639
+ "exclusive": [
2640
+ "simulate-actions"
2641
+ ],
2642
+ "name": "use-live-actions",
2643
+ "summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
2688
2644
  "allowNo": false,
2689
2645
  "type": "boolean"
2690
2646
  },
2691
- "output-file": {
2692
- "char": "f",
2693
- "name": "output-file",
2694
- "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).",
2647
+ "simulate-actions": {
2648
+ "exclusive": [
2649
+ "use-live-actions"
2650
+ ],
2651
+ "name": "simulate-actions",
2652
+ "summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
2653
+ "allowNo": false,
2654
+ "type": "boolean"
2655
+ },
2656
+ "context-variables": {
2657
+ "description": "Sets variables on the agent preview session, mirroring what the in-org Agentforce Builder UI does when you override variables before sending a message. Specify this flag multiple times or use comma-separated values. Two namespaces are supported, distinguished by the name shape. Names pass through to the runtime verbatim — the CLI doesn't transform them.\n\nLinked context variables use the \"$Context.\" prefix. These map to externally-provided fields that the runtime resolves (declared in the bundle's globalConfiguration.contextVariables) and are read by live actions and topic-routing expressions via $Context.Name. Example: $Context.MyLinkedVar=some-value.\n\nState variables use the bare developerName, no prefix. These seed mutable agent state declared in agentVersion.stateVariables. Example: MyStateVar=some-value.\n\nBoth namespaces can be mixed in one value. Example: --context-variables '$Context.MyLinkedVar=foo,MyStateVar=bar'.\n\nTips: (1) Quote the whole value in single quotes so $Context isn't shell-expanded. (2) Names are sent verbatim — a bare name is treated as a state variable, not a linked context variable, so live actions that bind via $Context.Name will see null. (3) Type defaults to Text.",
2658
+ "name": "context-variables",
2659
+ "summary": "Session variables for the agent preview session, in the form Name=Value.",
2660
+ "delimiter": ",",
2695
2661
  "hasDynamicHelp": false,
2696
- "multiple": false,
2662
+ "multiple": true,
2697
2663
  "type": "option"
2698
2664
  },
2699
- "test-runner": {
2700
- "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.",
2701
- "name": "test-runner",
2702
- "summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
2665
+ "agent-json": {
2666
+ "dependsOn": [
2667
+ "authoring-bundle"
2668
+ ],
2669
+ "hidden": true,
2670
+ "name": "agent-json",
2671
+ "summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
2703
2672
  "hasDynamicHelp": false,
2704
2673
  "multiple": false,
2705
- "options": [
2706
- "agentforce-studio",
2707
- "testing-center"
2708
- ],
2709
2674
  "type": "option"
2710
2675
  }
2711
2676
  },
2712
- "hasDynamicHelp": false,
2677
+ "hasDynamicHelp": true,
2713
2678
  "hiddenAliases": [],
2714
- "id": "agent:generate:test-spec",
2679
+ "id": "agent:preview:start",
2715
2680
  "pluginAlias": "@salesforce/plugin-agent",
2716
2681
  "pluginName": "@salesforce/plugin-agent",
2717
2682
  "pluginType": "core",
2718
2683
  "strict": true,
2719
- "summary": "Generate an agent test spec, which is a YAML file that lists the test cases for testing a specific agent.",
2720
- "enableJsonFlag": false,
2684
+ "summary": "Start a programmatic agent preview session.",
2685
+ "enableJsonFlag": true,
2686
+ "requiresProject": true,
2687
+ "envVariablesSection": {
2688
+ "header": "ENVIRONMENT VARIABLES",
2689
+ "body": [
2690
+ {
2691
+ "name": "SF_TARGET_ORG",
2692
+ "description": "Username or alias of your default org. Overrides the target-org configuration variable."
2693
+ }
2694
+ ]
2695
+ },
2696
+ "errorCodes": {
2697
+ "header": "ERROR CODES",
2698
+ "body": [
2699
+ {
2700
+ "name": "Succeeded (0)",
2701
+ "description": "Preview session started successfully."
2702
+ },
2703
+ {
2704
+ "name": "Failed (1)",
2705
+ "description": "Agent Script compilation failed (syntax errors in the script)."
2706
+ },
2707
+ {
2708
+ "name": "NotFound (2)",
2709
+ "description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
2710
+ },
2711
+ {
2712
+ "name": "ServerError (3)",
2713
+ "description": "Compilation API returned HTTP 500 (server error during compilation)."
2714
+ },
2715
+ {
2716
+ "name": "PreviewStartFailed (4)",
2717
+ "description": "Preview session failed to start due to API or network errors."
2718
+ }
2719
+ ]
2720
+ },
2721
2721
  "isESM": true,
2722
2722
  "relativePath": [
2723
2723
  "lib",
2724
2724
  "commands",
2725
2725
  "agent",
2726
- "generate",
2727
- "test-spec.js"
2726
+ "preview",
2727
+ "start.js"
2728
2728
  ],
2729
2729
  "aliasPermutations": [],
2730
2730
  "permutations": [
2731
- "agent:generate:test-spec",
2732
- "generate:agent:test-spec",
2733
- "generate:test-spec:agent",
2734
- "agent:test-spec:generate",
2735
- "test-spec:agent:generate",
2736
- "test-spec:generate:agent"
2731
+ "agent:preview:start",
2732
+ "preview:agent:start",
2733
+ "preview:start:agent",
2734
+ "agent:start:preview",
2735
+ "start:agent:preview",
2736
+ "start:preview:agent"
2737
2737
  ]
2738
2738
  },
2739
2739
  "agent:publish:authoring-bundle": {
@@ -4667,5 +4667,5 @@
4667
4667
  ]
4668
4668
  }
4669
4669
  },
4670
- "version": "1.44.4"
4670
+ "version": "1.44.5"
4671
4671
  }