@salesforce/plugin-agent 1.42.1 → 1.43.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +476 -63
- package/lib/commands/agent/generate/test-spec.d.ts +9 -0
- package/lib/commands/agent/generate/test-spec.js +194 -11
- package/lib/commands/agent/generate/test-spec.js.map +1 -1
- package/lib/commands/agent/mcp/asset/list.d.ts +16 -0
- package/lib/commands/agent/mcp/asset/list.js +68 -0
- package/lib/commands/agent/mcp/asset/list.js.map +1 -0
- package/lib/commands/agent/mcp/asset/replace.d.ts +18 -0
- package/lib/commands/agent/mcp/asset/replace.js +95 -0
- package/lib/commands/agent/mcp/asset/replace.js.map +1 -0
- package/lib/commands/agent/mcp/create.d.ts +24 -0
- package/lib/commands/agent/mcp/create.js +112 -0
- package/lib/commands/agent/mcp/create.js.map +1 -0
- package/lib/commands/agent/mcp/delete.d.ts +19 -0
- package/lib/commands/agent/mcp/delete.js +65 -0
- package/lib/commands/agent/mcp/delete.js.map +1 -0
- package/lib/commands/agent/mcp/fetch.d.ts +16 -0
- package/lib/commands/agent/mcp/fetch.js +68 -0
- package/lib/commands/agent/mcp/fetch.js.map +1 -0
- package/lib/commands/agent/mcp/get.d.ts +16 -0
- package/lib/commands/agent/mcp/get.js +58 -0
- package/lib/commands/agent/mcp/get.js.map +1 -0
- package/lib/commands/agent/mcp/list.d.ts +18 -0
- package/lib/commands/agent/mcp/list.js +73 -0
- package/lib/commands/agent/mcp/list.js.map +1 -0
- package/lib/commands/agent/mcp/update.d.ts +24 -0
- package/lib/commands/agent/mcp/update.js +115 -0
- package/lib/commands/agent/mcp/update.js.map +1 -0
- package/lib/commands/agent/preview/start.d.ts +1 -0
- package/lib/commands/agent/preview/start.js +4 -1
- package/lib/commands/agent/preview/start.js.map +1 -1
- package/lib/commands/agent/preview.d.ts +1 -0
- package/lib/commands/agent/preview.js +4 -0
- package/lib/commands/agent/preview.js.map +1 -1
- package/lib/components/agent-preview-react.d.ts +2 -1
- package/lib/components/agent-preview-react.js +3 -3
- package/lib/components/agent-preview-react.js.map +1 -1
- package/lib/flags.d.ts +12 -1
- package/lib/flags.js +31 -0
- package/lib/flags.js.map +1 -1
- package/messages/agent.generate.test-spec.md +33 -5
- package/messages/agent.mcp.asset.list.md +25 -0
- package/messages/agent.mcp.asset.replace.md +49 -0
- package/messages/agent.mcp.create.md +61 -0
- package/messages/agent.mcp.delete.md +37 -0
- package/messages/agent.mcp.fetch.md +25 -0
- package/messages/agent.mcp.get.md +25 -0
- package/messages/agent.mcp.list.md +33 -0
- package/messages/agent.mcp.update.md +65 -0
- package/messages/shared.md +16 -0
- package/oclif.manifest.json +1750 -880
- package/package.json +14 -4
- package/schemas/agent-mcp-asset-list.json +65 -0
- package/schemas/agent-mcp-asset-replace.json +65 -0
- package/schemas/agent-mcp-create.json +144 -0
- package/schemas/agent-mcp-delete.json +22 -0
- package/schemas/agent-mcp-fetch.json +66 -0
- package/schemas/agent-mcp-get.json +86 -0
- package/schemas/agent-mcp-list.json +101 -0
- package/schemas/agent-mcp-update.json +86 -0
package/oclif.manifest.json
CHANGED
|
@@ -374,6 +374,15 @@
|
|
|
374
374
|
"allowNo": false,
|
|
375
375
|
"type": "boolean"
|
|
376
376
|
},
|
|
377
|
+
"context-variables": {
|
|
378
|
+
"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.",
|
|
379
|
+
"name": "context-variables",
|
|
380
|
+
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
381
|
+
"delimiter": ",",
|
|
382
|
+
"hasDynamicHelp": false,
|
|
383
|
+
"multiple": true,
|
|
384
|
+
"type": "option"
|
|
385
|
+
},
|
|
377
386
|
"agent-json": {
|
|
378
387
|
"dependsOn": [
|
|
379
388
|
"authoring-bundle"
|
|
@@ -1077,16 +1086,13 @@
|
|
|
1077
1086
|
"upload:adl:agent"
|
|
1078
1087
|
]
|
|
1079
1088
|
},
|
|
1080
|
-
"agent:
|
|
1089
|
+
"agent:mcp:create": {
|
|
1081
1090
|
"aliases": [],
|
|
1082
1091
|
"args": {},
|
|
1083
|
-
"description": "
|
|
1092
|
+
"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.",
|
|
1084
1093
|
"examples": [
|
|
1085
|
-
"
|
|
1086
|
-
"
|
|
1087
|
-
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
1088
|
-
"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\"",
|
|
1089
|
-
"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"
|
|
1094
|
+
"Create an MCP server with no authentication:\n<%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --target-org myOrg",
|
|
1095
|
+
"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"
|
|
1090
1096
|
],
|
|
1091
1097
|
"flags": {
|
|
1092
1098
|
"json": {
|
|
@@ -1121,164 +1127,113 @@
|
|
|
1121
1127
|
"multiple": false,
|
|
1122
1128
|
"type": "option"
|
|
1123
1129
|
},
|
|
1124
|
-
"
|
|
1125
|
-
"
|
|
1126
|
-
"
|
|
1127
|
-
"
|
|
1128
|
-
"
|
|
1129
|
-
"options": [
|
|
1130
|
-
"customer",
|
|
1131
|
-
"internal"
|
|
1132
|
-
],
|
|
1133
|
-
"type": "option"
|
|
1134
|
-
},
|
|
1135
|
-
"role": {
|
|
1136
|
-
"name": "role",
|
|
1137
|
-
"summary": "Role of the agent.",
|
|
1138
|
-
"hasDynamicHelp": false,
|
|
1139
|
-
"multiple": false,
|
|
1140
|
-
"type": "option"
|
|
1141
|
-
},
|
|
1142
|
-
"company-name": {
|
|
1143
|
-
"name": "company-name",
|
|
1144
|
-
"summary": "Name of your company.",
|
|
1145
|
-
"hasDynamicHelp": false,
|
|
1146
|
-
"multiple": false,
|
|
1147
|
-
"type": "option"
|
|
1148
|
-
},
|
|
1149
|
-
"company-description": {
|
|
1150
|
-
"name": "company-description",
|
|
1151
|
-
"summary": "Description of your company.",
|
|
1152
|
-
"hasDynamicHelp": false,
|
|
1153
|
-
"multiple": false,
|
|
1154
|
-
"type": "option"
|
|
1155
|
-
},
|
|
1156
|
-
"company-website": {
|
|
1157
|
-
"name": "company-website",
|
|
1158
|
-
"summary": "Website URL of your company.",
|
|
1130
|
+
"name": {
|
|
1131
|
+
"char": "n",
|
|
1132
|
+
"name": "name",
|
|
1133
|
+
"required": true,
|
|
1134
|
+
"summary": "Unique name of the MCP server.",
|
|
1159
1135
|
"hasDynamicHelp": false,
|
|
1160
1136
|
"multiple": false,
|
|
1161
1137
|
"type": "option"
|
|
1162
1138
|
},
|
|
1163
|
-
"
|
|
1164
|
-
"name": "
|
|
1165
|
-
"summary": "
|
|
1139
|
+
"label": {
|
|
1140
|
+
"name": "label",
|
|
1141
|
+
"summary": "Human-readable label for the MCP server.",
|
|
1166
1142
|
"hasDynamicHelp": false,
|
|
1167
1143
|
"multiple": false,
|
|
1168
1144
|
"type": "option"
|
|
1169
1145
|
},
|
|
1170
|
-
"
|
|
1171
|
-
"name": "
|
|
1172
|
-
"summary": "
|
|
1146
|
+
"description": {
|
|
1147
|
+
"name": "description",
|
|
1148
|
+
"summary": "Description of the MCP server.",
|
|
1173
1149
|
"hasDynamicHelp": false,
|
|
1174
1150
|
"multiple": false,
|
|
1175
1151
|
"type": "option"
|
|
1176
1152
|
},
|
|
1177
|
-
"
|
|
1178
|
-
"name": "
|
|
1179
|
-
"
|
|
1153
|
+
"server-url": {
|
|
1154
|
+
"name": "server-url",
|
|
1155
|
+
"required": true,
|
|
1156
|
+
"summary": "URL of the external MCP server.",
|
|
1180
1157
|
"hasDynamicHelp": false,
|
|
1181
1158
|
"multiple": false,
|
|
1182
|
-
"options": [
|
|
1183
|
-
"true",
|
|
1184
|
-
"false"
|
|
1185
|
-
],
|
|
1186
1159
|
"type": "option"
|
|
1187
1160
|
},
|
|
1188
|
-
"
|
|
1189
|
-
"name": "
|
|
1190
|
-
"summary": "
|
|
1161
|
+
"auth-type": {
|
|
1162
|
+
"name": "auth-type",
|
|
1163
|
+
"summary": "Authorization type to use when connecting to the MCP server.",
|
|
1164
|
+
"default": "NO_AUTH",
|
|
1191
1165
|
"hasDynamicHelp": false,
|
|
1192
1166
|
"multiple": false,
|
|
1193
1167
|
"options": [
|
|
1194
|
-
"
|
|
1195
|
-
"
|
|
1196
|
-
"neutral"
|
|
1168
|
+
"OAUTH",
|
|
1169
|
+
"NO_AUTH"
|
|
1197
1170
|
],
|
|
1198
1171
|
"type": "option"
|
|
1199
1172
|
},
|
|
1200
|
-
"
|
|
1201
|
-
"name": "
|
|
1202
|
-
"summary": "
|
|
1173
|
+
"identity-provider": {
|
|
1174
|
+
"name": "identity-provider",
|
|
1175
|
+
"summary": "Identity provider to use for OAuth authorization. Required when auth-type is OAUTH.",
|
|
1203
1176
|
"hasDynamicHelp": false,
|
|
1204
1177
|
"multiple": false,
|
|
1205
1178
|
"type": "option"
|
|
1206
1179
|
},
|
|
1207
|
-
"
|
|
1208
|
-
"name": "
|
|
1209
|
-
"summary": "
|
|
1210
|
-
"default": "specs/agentSpec.yaml",
|
|
1180
|
+
"client-id": {
|
|
1181
|
+
"name": "client-id",
|
|
1182
|
+
"summary": "OAuth client ID. Required when auth-type is OAUTH.",
|
|
1211
1183
|
"hasDynamicHelp": false,
|
|
1212
1184
|
"multiple": false,
|
|
1213
1185
|
"type": "option"
|
|
1214
1186
|
},
|
|
1215
|
-
"
|
|
1216
|
-
"name": "
|
|
1217
|
-
"summary": "
|
|
1218
|
-
"allowNo": false,
|
|
1219
|
-
"type": "boolean"
|
|
1220
|
-
},
|
|
1221
|
-
"prompt-template": {
|
|
1222
|
-
"name": "prompt-template",
|
|
1223
|
-
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
1187
|
+
"client-secret": {
|
|
1188
|
+
"name": "client-secret",
|
|
1189
|
+
"summary": "OAuth client secret. Required when auth-type is OAUTH. Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
1224
1190
|
"hasDynamicHelp": false,
|
|
1225
1191
|
"multiple": false,
|
|
1226
1192
|
"type": "option"
|
|
1227
1193
|
},
|
|
1228
|
-
"
|
|
1229
|
-
"
|
|
1230
|
-
|
|
1231
|
-
],
|
|
1232
|
-
"name": "grounding-context",
|
|
1233
|
-
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
1194
|
+
"scope": {
|
|
1195
|
+
"name": "scope",
|
|
1196
|
+
"summary": "OAuth scope to request. Required when auth-type is OAUTH.",
|
|
1234
1197
|
"hasDynamicHelp": false,
|
|
1235
1198
|
"multiple": false,
|
|
1236
1199
|
"type": "option"
|
|
1237
|
-
},
|
|
1238
|
-
"force-overwrite": {
|
|
1239
|
-
"name": "force-overwrite",
|
|
1240
|
-
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
1241
|
-
"allowNo": false,
|
|
1242
|
-
"type": "boolean"
|
|
1243
1200
|
}
|
|
1244
1201
|
},
|
|
1245
1202
|
"hasDynamicHelp": true,
|
|
1246
1203
|
"hiddenAliases": [],
|
|
1247
|
-
"id": "agent:
|
|
1204
|
+
"id": "agent:mcp:create",
|
|
1248
1205
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1249
1206
|
"pluginName": "@salesforce/plugin-agent",
|
|
1250
1207
|
"pluginType": "core",
|
|
1208
|
+
"state": "preview",
|
|
1251
1209
|
"strict": true,
|
|
1252
|
-
"summary": "
|
|
1210
|
+
"summary": "Create an MCP server in the API Catalog.",
|
|
1253
1211
|
"enableJsonFlag": true,
|
|
1254
|
-
"requiresProject": true,
|
|
1255
1212
|
"isESM": true,
|
|
1256
1213
|
"relativePath": [
|
|
1257
1214
|
"lib",
|
|
1258
1215
|
"commands",
|
|
1259
1216
|
"agent",
|
|
1260
|
-
"
|
|
1261
|
-
"
|
|
1217
|
+
"mcp",
|
|
1218
|
+
"create.js"
|
|
1262
1219
|
],
|
|
1263
1220
|
"aliasPermutations": [],
|
|
1264
1221
|
"permutations": [
|
|
1265
|
-
"agent:
|
|
1266
|
-
"
|
|
1267
|
-
"
|
|
1268
|
-
"agent:
|
|
1269
|
-
"
|
|
1270
|
-
"
|
|
1222
|
+
"agent:mcp:create",
|
|
1223
|
+
"mcp:agent:create",
|
|
1224
|
+
"mcp:create:agent",
|
|
1225
|
+
"agent:create:mcp",
|
|
1226
|
+
"create:agent:mcp",
|
|
1227
|
+
"create:mcp:agent"
|
|
1271
1228
|
]
|
|
1272
1229
|
},
|
|
1273
|
-
"agent:
|
|
1230
|
+
"agent:mcp:delete": {
|
|
1274
1231
|
"aliases": [],
|
|
1275
1232
|
"args": {},
|
|
1276
|
-
"description": "
|
|
1233
|
+
"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).",
|
|
1277
1234
|
"examples": [
|
|
1278
|
-
"
|
|
1279
|
-
"
|
|
1280
|
-
"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\"",
|
|
1281
|
-
"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"
|
|
1235
|
+
"Delete an MCP server, confirming interactively:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg",
|
|
1236
|
+
"Delete an MCP server without a confirmation prompt:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg --no-prompt"
|
|
1282
1237
|
],
|
|
1283
1238
|
"flags": {
|
|
1284
1239
|
"json": {
|
|
@@ -1306,13 +1261,6 @@
|
|
|
1306
1261
|
"multiple": false,
|
|
1307
1262
|
"type": "option"
|
|
1308
1263
|
},
|
|
1309
|
-
"api-name": {
|
|
1310
|
-
"name": "api-name",
|
|
1311
|
-
"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.",
|
|
1312
|
-
"hasDynamicHelp": false,
|
|
1313
|
-
"multiple": false,
|
|
1314
|
-
"type": "option"
|
|
1315
|
-
},
|
|
1316
1264
|
"api-version": {
|
|
1317
1265
|
"description": "Override the api version used for api requests made by this command",
|
|
1318
1266
|
"name": "api-version",
|
|
@@ -1320,77 +1268,57 @@
|
|
|
1320
1268
|
"multiple": false,
|
|
1321
1269
|
"type": "option"
|
|
1322
1270
|
},
|
|
1323
|
-
"
|
|
1324
|
-
"char": "
|
|
1325
|
-
"name": "
|
|
1326
|
-
"
|
|
1327
|
-
"
|
|
1328
|
-
"multiple": false,
|
|
1329
|
-
"type": "option"
|
|
1330
|
-
},
|
|
1331
|
-
"no-spec": {
|
|
1332
|
-
"name": "no-spec",
|
|
1333
|
-
"summary": "Skip prompting for an agent spec and use the default Agent Script boilerplate in the generated authoring bundle.",
|
|
1334
|
-
"allowNo": false,
|
|
1335
|
-
"type": "boolean"
|
|
1336
|
-
},
|
|
1337
|
-
"output-dir": {
|
|
1338
|
-
"char": "d",
|
|
1339
|
-
"name": "output-dir",
|
|
1340
|
-
"summary": "Directory where the authoring bundle files are generated.",
|
|
1341
|
-
"hasDynamicHelp": false,
|
|
1342
|
-
"multiple": false,
|
|
1343
|
-
"type": "option"
|
|
1344
|
-
},
|
|
1345
|
-
"name": {
|
|
1346
|
-
"char": "n",
|
|
1347
|
-
"name": "name",
|
|
1348
|
-
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
1271
|
+
"mcp-server-id": {
|
|
1272
|
+
"char": "i",
|
|
1273
|
+
"name": "mcp-server-id",
|
|
1274
|
+
"required": true,
|
|
1275
|
+
"summary": "ID of the MCP server to delete.",
|
|
1349
1276
|
"hasDynamicHelp": false,
|
|
1350
1277
|
"multiple": false,
|
|
1351
1278
|
"type": "option"
|
|
1352
1279
|
},
|
|
1353
|
-
"
|
|
1354
|
-
"name": "
|
|
1355
|
-
"summary": "
|
|
1280
|
+
"no-prompt": {
|
|
1281
|
+
"name": "no-prompt",
|
|
1282
|
+
"summary": "Skip the confirmation prompt and delete the MCP server immediately.",
|
|
1356
1283
|
"allowNo": false,
|
|
1357
1284
|
"type": "boolean"
|
|
1358
1285
|
}
|
|
1359
1286
|
},
|
|
1360
1287
|
"hasDynamicHelp": true,
|
|
1361
1288
|
"hiddenAliases": [],
|
|
1362
|
-
"id": "agent:
|
|
1289
|
+
"id": "agent:mcp:delete",
|
|
1363
1290
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1364
1291
|
"pluginName": "@salesforce/plugin-agent",
|
|
1365
1292
|
"pluginType": "core",
|
|
1293
|
+
"state": "preview",
|
|
1366
1294
|
"strict": true,
|
|
1367
|
-
"summary": "
|
|
1295
|
+
"summary": "Delete an MCP server from the API Catalog.",
|
|
1368
1296
|
"enableJsonFlag": true,
|
|
1369
|
-
"requiresProject": true,
|
|
1370
1297
|
"isESM": true,
|
|
1371
1298
|
"relativePath": [
|
|
1372
1299
|
"lib",
|
|
1373
1300
|
"commands",
|
|
1374
1301
|
"agent",
|
|
1375
|
-
"
|
|
1376
|
-
"
|
|
1302
|
+
"mcp",
|
|
1303
|
+
"delete.js"
|
|
1377
1304
|
],
|
|
1378
1305
|
"aliasPermutations": [],
|
|
1379
1306
|
"permutations": [
|
|
1380
|
-
"agent:
|
|
1381
|
-
"
|
|
1382
|
-
"
|
|
1383
|
-
"agent:
|
|
1384
|
-
"
|
|
1385
|
-
"
|
|
1307
|
+
"agent:mcp:delete",
|
|
1308
|
+
"mcp:agent:delete",
|
|
1309
|
+
"mcp:delete:agent",
|
|
1310
|
+
"agent:delete:mcp",
|
|
1311
|
+
"delete:agent:mcp",
|
|
1312
|
+
"delete:mcp:agent"
|
|
1386
1313
|
]
|
|
1387
1314
|
},
|
|
1388
|
-
"agent:
|
|
1315
|
+
"agent:mcp:fetch": {
|
|
1389
1316
|
"aliases": [],
|
|
1390
1317
|
"args": {},
|
|
1391
|
-
"description": "
|
|
1318
|
+
"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.",
|
|
1392
1319
|
"examples": [
|
|
1393
|
-
"
|
|
1320
|
+
"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",
|
|
1321
|
+
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
1394
1322
|
],
|
|
1395
1323
|
"flags": {
|
|
1396
1324
|
"json": {
|
|
@@ -1408,44 +1336,28 @@
|
|
|
1408
1336
|
"multiple": false,
|
|
1409
1337
|
"type": "option"
|
|
1410
1338
|
},
|
|
1411
|
-
"
|
|
1412
|
-
"
|
|
1413
|
-
"name": "
|
|
1414
|
-
"hasDynamicHelp": false,
|
|
1415
|
-
"multiple": false,
|
|
1416
|
-
"type": "option"
|
|
1417
|
-
},
|
|
1418
|
-
"source-org": {
|
|
1419
|
-
"char": "s",
|
|
1420
|
-
"name": "source-org",
|
|
1339
|
+
"target-org": {
|
|
1340
|
+
"char": "o",
|
|
1341
|
+
"name": "target-org",
|
|
1421
1342
|
"noCacheDefault": true,
|
|
1422
1343
|
"required": true,
|
|
1423
|
-
"summary": "Username or alias of the
|
|
1344
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1424
1345
|
"hasDynamicHelp": true,
|
|
1425
1346
|
"multiple": false,
|
|
1426
1347
|
"type": "option"
|
|
1427
1348
|
},
|
|
1428
|
-
"
|
|
1429
|
-
"
|
|
1430
|
-
"
|
|
1431
|
-
"summary": "Version of the agent (BotVersion).",
|
|
1349
|
+
"api-version": {
|
|
1350
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1351
|
+
"name": "api-version",
|
|
1432
1352
|
"hasDynamicHelp": false,
|
|
1433
1353
|
"multiple": false,
|
|
1434
1354
|
"type": "option"
|
|
1435
1355
|
},
|
|
1436
|
-
"
|
|
1437
|
-
"char": "
|
|
1438
|
-
"name": "
|
|
1356
|
+
"mcp-server-id": {
|
|
1357
|
+
"char": "i",
|
|
1358
|
+
"name": "mcp-server-id",
|
|
1439
1359
|
"required": true,
|
|
1440
|
-
"summary": "
|
|
1441
|
-
"hasDynamicHelp": false,
|
|
1442
|
-
"multiple": false,
|
|
1443
|
-
"type": "option"
|
|
1444
|
-
},
|
|
1445
|
-
"output-dir": {
|
|
1446
|
-
"char": "r",
|
|
1447
|
-
"name": "output-dir",
|
|
1448
|
-
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
1360
|
+
"summary": "ID of the MCP server to fetch assets from.",
|
|
1449
1361
|
"hasDynamicHelp": false,
|
|
1450
1362
|
"multiple": false,
|
|
1451
1363
|
"type": "option"
|
|
@@ -1453,42 +1365,48 @@
|
|
|
1453
1365
|
},
|
|
1454
1366
|
"hasDynamicHelp": true,
|
|
1455
1367
|
"hiddenAliases": [],
|
|
1456
|
-
"id": "agent:
|
|
1368
|
+
"id": "agent:mcp:fetch",
|
|
1457
1369
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1458
1370
|
"pluginName": "@salesforce/plugin-agent",
|
|
1459
1371
|
"pluginType": "core",
|
|
1372
|
+
"state": "preview",
|
|
1460
1373
|
"strict": true,
|
|
1461
|
-
"summary": "
|
|
1374
|
+
"summary": "Fetch the live assets (tools, prompts, resources) advertised by an MCP server.",
|
|
1462
1375
|
"enableJsonFlag": true,
|
|
1463
|
-
"requiresProject": true,
|
|
1464
1376
|
"isESM": true,
|
|
1465
1377
|
"relativePath": [
|
|
1466
1378
|
"lib",
|
|
1467
1379
|
"commands",
|
|
1468
1380
|
"agent",
|
|
1469
|
-
"
|
|
1470
|
-
"
|
|
1381
|
+
"mcp",
|
|
1382
|
+
"fetch.js"
|
|
1471
1383
|
],
|
|
1472
1384
|
"aliasPermutations": [],
|
|
1473
1385
|
"permutations": [
|
|
1474
|
-
"agent:
|
|
1475
|
-
"
|
|
1476
|
-
"
|
|
1477
|
-
"agent:
|
|
1478
|
-
"
|
|
1479
|
-
"
|
|
1386
|
+
"agent:mcp:fetch",
|
|
1387
|
+
"mcp:agent:fetch",
|
|
1388
|
+
"mcp:fetch:agent",
|
|
1389
|
+
"agent:fetch:mcp",
|
|
1390
|
+
"fetch:agent:mcp",
|
|
1391
|
+
"fetch:mcp:agent"
|
|
1480
1392
|
]
|
|
1481
1393
|
},
|
|
1482
|
-
"agent:
|
|
1394
|
+
"agent:mcp:get": {
|
|
1483
1395
|
"aliases": [],
|
|
1484
1396
|
"args": {},
|
|
1485
|
-
"description": "
|
|
1397
|
+
"description": "Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.",
|
|
1486
1398
|
"examples": [
|
|
1487
|
-
"
|
|
1488
|
-
"
|
|
1489
|
-
"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"
|
|
1399
|
+
"Get an MCP server by id in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001",
|
|
1400
|
+
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
1490
1401
|
],
|
|
1491
1402
|
"flags": {
|
|
1403
|
+
"json": {
|
|
1404
|
+
"description": "Format output as json.",
|
|
1405
|
+
"helpGroup": "GLOBAL",
|
|
1406
|
+
"name": "json",
|
|
1407
|
+
"allowNo": false,
|
|
1408
|
+
"type": "boolean"
|
|
1409
|
+
},
|
|
1492
1410
|
"flags-dir": {
|
|
1493
1411
|
"helpGroup": "GLOBAL",
|
|
1494
1412
|
"name": "flags-dir",
|
|
@@ -1497,65 +1415,68 @@
|
|
|
1497
1415
|
"multiple": false,
|
|
1498
1416
|
"type": "option"
|
|
1499
1417
|
},
|
|
1500
|
-
"
|
|
1501
|
-
"char": "
|
|
1502
|
-
"name": "
|
|
1503
|
-
"
|
|
1504
|
-
"
|
|
1418
|
+
"target-org": {
|
|
1419
|
+
"char": "o",
|
|
1420
|
+
"name": "target-org",
|
|
1421
|
+
"noCacheDefault": true,
|
|
1422
|
+
"required": true,
|
|
1423
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1424
|
+
"hasDynamicHelp": true,
|
|
1505
1425
|
"multiple": false,
|
|
1506
1426
|
"type": "option"
|
|
1507
1427
|
},
|
|
1508
|
-
"
|
|
1509
|
-
"
|
|
1510
|
-
"
|
|
1511
|
-
"allowNo": false,
|
|
1512
|
-
"type": "boolean"
|
|
1513
|
-
},
|
|
1514
|
-
"output-file": {
|
|
1515
|
-
"char": "f",
|
|
1516
|
-
"name": "output-file",
|
|
1517
|
-
"summary": "Name of the generated test spec YAML file. Default value is \"specs/<AGENT_API_NAME>-testSpec.yaml\".",
|
|
1428
|
+
"api-version": {
|
|
1429
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1430
|
+
"name": "api-version",
|
|
1518
1431
|
"hasDynamicHelp": false,
|
|
1519
1432
|
"multiple": false,
|
|
1520
1433
|
"type": "option"
|
|
1521
|
-
}
|
|
1434
|
+
},
|
|
1435
|
+
"mcp-server-id": {
|
|
1436
|
+
"char": "i",
|
|
1437
|
+
"name": "mcp-server-id",
|
|
1438
|
+
"required": true,
|
|
1439
|
+
"summary": "The identifier of the MCP server to retrieve.",
|
|
1440
|
+
"hasDynamicHelp": false,
|
|
1441
|
+
"multiple": false,
|
|
1442
|
+
"type": "option"
|
|
1443
|
+
}
|
|
1522
1444
|
},
|
|
1523
|
-
"hasDynamicHelp":
|
|
1445
|
+
"hasDynamicHelp": true,
|
|
1524
1446
|
"hiddenAliases": [],
|
|
1525
|
-
"id": "agent:
|
|
1447
|
+
"id": "agent:mcp:get",
|
|
1526
1448
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1527
1449
|
"pluginName": "@salesforce/plugin-agent",
|
|
1528
1450
|
"pluginType": "core",
|
|
1451
|
+
"state": "preview",
|
|
1529
1452
|
"strict": true,
|
|
1530
|
-
"summary": "
|
|
1531
|
-
"enableJsonFlag":
|
|
1453
|
+
"summary": "Get a single MCP server registered in the API Catalog.",
|
|
1454
|
+
"enableJsonFlag": true,
|
|
1532
1455
|
"isESM": true,
|
|
1533
1456
|
"relativePath": [
|
|
1534
1457
|
"lib",
|
|
1535
1458
|
"commands",
|
|
1536
1459
|
"agent",
|
|
1537
|
-
"
|
|
1538
|
-
"
|
|
1460
|
+
"mcp",
|
|
1461
|
+
"get.js"
|
|
1539
1462
|
],
|
|
1540
1463
|
"aliasPermutations": [],
|
|
1541
1464
|
"permutations": [
|
|
1542
|
-
"agent:
|
|
1543
|
-
"
|
|
1544
|
-
"
|
|
1545
|
-
"agent:
|
|
1546
|
-
"
|
|
1547
|
-
"
|
|
1465
|
+
"agent:mcp:get",
|
|
1466
|
+
"mcp:agent:get",
|
|
1467
|
+
"mcp:get:agent",
|
|
1468
|
+
"agent:get:mcp",
|
|
1469
|
+
"get:agent:mcp",
|
|
1470
|
+
"get:mcp:agent"
|
|
1548
1471
|
]
|
|
1549
1472
|
},
|
|
1550
|
-
"agent:
|
|
1473
|
+
"agent:mcp:list": {
|
|
1551
1474
|
"aliases": [],
|
|
1552
1475
|
"args": {},
|
|
1553
|
-
"description": "
|
|
1476
|
+
"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.",
|
|
1554
1477
|
"examples": [
|
|
1555
|
-
"
|
|
1556
|
-
"
|
|
1557
|
-
"Publish with verbose output to see all retrieved and deployed metadata components:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --verbose",
|
|
1558
|
-
"Publish with concise output showing only essential information:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --concise"
|
|
1478
|
+
"List all MCP servers in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
1479
|
+
"List external MCP servers filtered by status and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json"
|
|
1559
1480
|
],
|
|
1560
1481
|
"flags": {
|
|
1561
1482
|
"json": {
|
|
@@ -1590,96 +1511,70 @@
|
|
|
1590
1511
|
"multiple": false,
|
|
1591
1512
|
"type": "option"
|
|
1592
1513
|
},
|
|
1593
|
-
"
|
|
1594
|
-
"
|
|
1595
|
-
"
|
|
1596
|
-
"summary": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
1514
|
+
"label": {
|
|
1515
|
+
"name": "label",
|
|
1516
|
+
"summary": "Filter the MCP servers by label.",
|
|
1597
1517
|
"hasDynamicHelp": false,
|
|
1598
1518
|
"multiple": false,
|
|
1599
1519
|
"type": "option"
|
|
1600
1520
|
},
|
|
1601
|
-
"
|
|
1602
|
-
"name": "
|
|
1603
|
-
"summary": "
|
|
1604
|
-
"
|
|
1605
|
-
"
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
"char": "v",
|
|
1609
|
-
"exclusive": [
|
|
1610
|
-
"concise"
|
|
1521
|
+
"type": {
|
|
1522
|
+
"name": "type",
|
|
1523
|
+
"summary": "Filter the MCP servers by type.",
|
|
1524
|
+
"hasDynamicHelp": false,
|
|
1525
|
+
"multiple": false,
|
|
1526
|
+
"options": [
|
|
1527
|
+
"EXTERNAL"
|
|
1611
1528
|
],
|
|
1612
|
-
"
|
|
1613
|
-
"summary": "Display detailed output showing all metadata components retrieved and deployed during the publish process.",
|
|
1614
|
-
"allowNo": false,
|
|
1615
|
-
"type": "boolean"
|
|
1529
|
+
"type": "option"
|
|
1616
1530
|
},
|
|
1617
|
-
"
|
|
1618
|
-
"
|
|
1619
|
-
|
|
1531
|
+
"status": {
|
|
1532
|
+
"name": "status",
|
|
1533
|
+
"summary": "Filter the MCP servers by connection status. Only ACTIVE and DISCONNECTED are supported as filters.",
|
|
1534
|
+
"hasDynamicHelp": false,
|
|
1535
|
+
"multiple": false,
|
|
1536
|
+
"options": [
|
|
1537
|
+
"ACTIVE",
|
|
1538
|
+
"DISCONNECTED"
|
|
1620
1539
|
],
|
|
1621
|
-
"
|
|
1622
|
-
"summary": "Display minimal output with only essential information about the publish operation.",
|
|
1623
|
-
"allowNo": false,
|
|
1624
|
-
"type": "boolean"
|
|
1540
|
+
"type": "option"
|
|
1625
1541
|
}
|
|
1626
1542
|
},
|
|
1627
1543
|
"hasDynamicHelp": true,
|
|
1628
1544
|
"hiddenAliases": [],
|
|
1629
|
-
"id": "agent:
|
|
1545
|
+
"id": "agent:mcp:list",
|
|
1630
1546
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1631
1547
|
"pluginName": "@salesforce/plugin-agent",
|
|
1632
1548
|
"pluginType": "core",
|
|
1549
|
+
"state": "preview",
|
|
1633
1550
|
"strict": true,
|
|
1634
|
-
"summary": "
|
|
1551
|
+
"summary": "List the MCP servers registered in the API Catalog.",
|
|
1635
1552
|
"enableJsonFlag": true,
|
|
1636
|
-
"requiresProject": true,
|
|
1637
|
-
"errorCodes": {
|
|
1638
|
-
"header": "ERROR CODES",
|
|
1639
|
-
"body": [
|
|
1640
|
-
{
|
|
1641
|
-
"name": "Succeeded (0)",
|
|
1642
|
-
"description": "Agent published successfully without errors."
|
|
1643
|
-
},
|
|
1644
|
-
{
|
|
1645
|
-
"name": "Failed (1)",
|
|
1646
|
-
"description": "Compilation errors found in the Agent Script file."
|
|
1647
|
-
}
|
|
1648
|
-
]
|
|
1649
|
-
},
|
|
1650
|
-
"FLAGGABLE_PROMPTS": {
|
|
1651
|
-
"api-name": {
|
|
1652
|
-
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
1653
|
-
"promptMessage": "API name of the authoring bundle to publish"
|
|
1654
|
-
}
|
|
1655
|
-
},
|
|
1656
1553
|
"isESM": true,
|
|
1657
1554
|
"relativePath": [
|
|
1658
1555
|
"lib",
|
|
1659
1556
|
"commands",
|
|
1660
1557
|
"agent",
|
|
1661
|
-
"
|
|
1662
|
-
"
|
|
1558
|
+
"mcp",
|
|
1559
|
+
"list.js"
|
|
1663
1560
|
],
|
|
1664
1561
|
"aliasPermutations": [],
|
|
1665
1562
|
"permutations": [
|
|
1666
|
-
"agent:
|
|
1667
|
-
"
|
|
1668
|
-
"
|
|
1669
|
-
"agent:
|
|
1670
|
-
"
|
|
1671
|
-
"
|
|
1563
|
+
"agent:mcp:list",
|
|
1564
|
+
"mcp:agent:list",
|
|
1565
|
+
"mcp:list:agent",
|
|
1566
|
+
"agent:list:mcp",
|
|
1567
|
+
"list:agent:mcp",
|
|
1568
|
+
"list:mcp:agent"
|
|
1672
1569
|
]
|
|
1673
1570
|
},
|
|
1674
|
-
"agent:
|
|
1571
|
+
"agent:mcp:update": {
|
|
1675
1572
|
"aliases": [],
|
|
1676
1573
|
"args": {},
|
|
1677
|
-
"description": "
|
|
1574
|
+
"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.",
|
|
1678
1575
|
"examples": [
|
|
1679
|
-
"
|
|
1680
|
-
"
|
|
1681
|
-
"Preview what the agent test metadata (AiEvaluationDefinition) looks like without deploying it to your default org:\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview",
|
|
1682
|
-
"Author an Agentforce Studio (NGT) test from an NGT-shaped YAML; writes an AiTestingDefinition metadata file:\n<%= config.bin %> <%= command.id %> --spec specs/ReturnsCheckout.ngt.yaml --api-name Returns_Checkout --test-runner agentforce-studio --target-org my-org"
|
|
1576
|
+
"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",
|
|
1577
|
+
"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"
|
|
1683
1578
|
],
|
|
1684
1579
|
"flags": {
|
|
1685
1580
|
"json": {
|
|
@@ -1697,20 +1592,6 @@
|
|
|
1697
1592
|
"multiple": false,
|
|
1698
1593
|
"type": "option"
|
|
1699
1594
|
},
|
|
1700
|
-
"api-name": {
|
|
1701
|
-
"name": "api-name",
|
|
1702
|
-
"summary": "API name of the new test; the API name must not exist in the org.",
|
|
1703
|
-
"hasDynamicHelp": false,
|
|
1704
|
-
"multiple": false,
|
|
1705
|
-
"type": "option"
|
|
1706
|
-
},
|
|
1707
|
-
"spec": {
|
|
1708
|
-
"name": "spec",
|
|
1709
|
-
"summary": "Path to the test spec YAML file.",
|
|
1710
|
-
"hasDynamicHelp": false,
|
|
1711
|
-
"multiple": false,
|
|
1712
|
-
"type": "option"
|
|
1713
|
-
},
|
|
1714
1595
|
"target-org": {
|
|
1715
1596
|
"char": "o",
|
|
1716
1597
|
"name": "target-org",
|
|
@@ -1728,95 +1609,114 @@
|
|
|
1728
1609
|
"multiple": false,
|
|
1729
1610
|
"type": "option"
|
|
1730
1611
|
},
|
|
1731
|
-
"
|
|
1732
|
-
"
|
|
1733
|
-
"
|
|
1734
|
-
"
|
|
1735
|
-
"
|
|
1612
|
+
"mcp-server-id": {
|
|
1613
|
+
"char": "i",
|
|
1614
|
+
"name": "mcp-server-id",
|
|
1615
|
+
"required": true,
|
|
1616
|
+
"summary": "ID of the MCP server to update.",
|
|
1617
|
+
"hasDynamicHelp": false,
|
|
1618
|
+
"multiple": false,
|
|
1619
|
+
"type": "option"
|
|
1736
1620
|
},
|
|
1737
|
-
"
|
|
1738
|
-
"name": "
|
|
1739
|
-
"summary": "
|
|
1740
|
-
"
|
|
1741
|
-
"
|
|
1621
|
+
"label": {
|
|
1622
|
+
"name": "label",
|
|
1623
|
+
"summary": "New display label for the MCP server.",
|
|
1624
|
+
"hasDynamicHelp": false,
|
|
1625
|
+
"multiple": false,
|
|
1626
|
+
"type": "option"
|
|
1742
1627
|
},
|
|
1743
|
-
"
|
|
1744
|
-
"
|
|
1745
|
-
"
|
|
1746
|
-
"
|
|
1628
|
+
"description": {
|
|
1629
|
+
"name": "description",
|
|
1630
|
+
"summary": "New description for the MCP server.",
|
|
1631
|
+
"hasDynamicHelp": false,
|
|
1632
|
+
"multiple": false,
|
|
1633
|
+
"type": "option"
|
|
1634
|
+
},
|
|
1635
|
+
"server-url": {
|
|
1636
|
+
"name": "server-url",
|
|
1637
|
+
"summary": "New endpoint URL of the MCP server.",
|
|
1638
|
+
"hasDynamicHelp": false,
|
|
1639
|
+
"multiple": false,
|
|
1640
|
+
"type": "option"
|
|
1641
|
+
},
|
|
1642
|
+
"auth-type": {
|
|
1643
|
+
"name": "auth-type",
|
|
1644
|
+
"summary": "Authorization type to apply to the MCP server (OAUTH or NO_AUTH).",
|
|
1747
1645
|
"hasDynamicHelp": false,
|
|
1748
1646
|
"multiple": false,
|
|
1749
1647
|
"options": [
|
|
1750
|
-
"
|
|
1751
|
-
"
|
|
1648
|
+
"OAUTH",
|
|
1649
|
+
"NO_AUTH"
|
|
1752
1650
|
],
|
|
1753
1651
|
"type": "option"
|
|
1652
|
+
},
|
|
1653
|
+
"identity-provider": {
|
|
1654
|
+
"name": "identity-provider",
|
|
1655
|
+
"summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
|
|
1656
|
+
"hasDynamicHelp": false,
|
|
1657
|
+
"multiple": false,
|
|
1658
|
+
"type": "option"
|
|
1659
|
+
},
|
|
1660
|
+
"client-id": {
|
|
1661
|
+
"name": "client-id",
|
|
1662
|
+
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
1663
|
+
"hasDynamicHelp": false,
|
|
1664
|
+
"multiple": false,
|
|
1665
|
+
"type": "option"
|
|
1666
|
+
},
|
|
1667
|
+
"client-secret": {
|
|
1668
|
+
"name": "client-secret",
|
|
1669
|
+
"summary": "OAuth client secret (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
1670
|
+
"hasDynamicHelp": false,
|
|
1671
|
+
"multiple": false,
|
|
1672
|
+
"type": "option"
|
|
1673
|
+
},
|
|
1674
|
+
"scope": {
|
|
1675
|
+
"name": "scope",
|
|
1676
|
+
"summary": "OAuth scope (required when --auth-type is OAUTH).",
|
|
1677
|
+
"hasDynamicHelp": false,
|
|
1678
|
+
"multiple": false,
|
|
1679
|
+
"type": "option"
|
|
1754
1680
|
}
|
|
1755
1681
|
},
|
|
1756
1682
|
"hasDynamicHelp": true,
|
|
1757
1683
|
"hiddenAliases": [],
|
|
1758
|
-
"id": "agent:
|
|
1684
|
+
"id": "agent:mcp:update",
|
|
1759
1685
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1760
1686
|
"pluginName": "@salesforce/plugin-agent",
|
|
1761
1687
|
"pluginType": "core",
|
|
1688
|
+
"state": "preview",
|
|
1762
1689
|
"strict": true,
|
|
1763
|
-
"summary": "
|
|
1690
|
+
"summary": "Update an MCP server registered in the API Catalog.",
|
|
1764
1691
|
"enableJsonFlag": true,
|
|
1765
|
-
"envVariablesSection": {
|
|
1766
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1767
|
-
"body": [
|
|
1768
|
-
{
|
|
1769
|
-
"name": "SF_TARGET_ORG",
|
|
1770
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1771
|
-
}
|
|
1772
|
-
]
|
|
1773
|
-
},
|
|
1774
|
-
"errorCodes": {
|
|
1775
|
-
"header": "ERROR CODES",
|
|
1776
|
-
"body": [
|
|
1777
|
-
{
|
|
1778
|
-
"name": "Succeeded (0)",
|
|
1779
|
-
"description": "Test created and deployed successfully."
|
|
1780
|
-
},
|
|
1781
|
-
{
|
|
1782
|
-
"name": "Failed (1)",
|
|
1783
|
-
"description": "Test validation errors or metadata format issues."
|
|
1784
|
-
},
|
|
1785
|
-
{
|
|
1786
|
-
"name": "NotFound (2)",
|
|
1787
|
-
"description": "Test spec file not found or org connection failed."
|
|
1788
|
-
},
|
|
1789
|
-
{
|
|
1790
|
-
"name": "DeploymentFailed (4)",
|
|
1791
|
-
"description": "Deployment failed due to API or network errors."
|
|
1792
|
-
}
|
|
1793
|
-
]
|
|
1794
|
-
},
|
|
1795
1692
|
"isESM": true,
|
|
1796
1693
|
"relativePath": [
|
|
1797
1694
|
"lib",
|
|
1798
1695
|
"commands",
|
|
1799
1696
|
"agent",
|
|
1800
|
-
"
|
|
1801
|
-
"
|
|
1697
|
+
"mcp",
|
|
1698
|
+
"update.js"
|
|
1802
1699
|
],
|
|
1803
1700
|
"aliasPermutations": [],
|
|
1804
1701
|
"permutations": [
|
|
1805
|
-
"agent:
|
|
1806
|
-
"
|
|
1807
|
-
"
|
|
1808
|
-
"agent:
|
|
1809
|
-
"
|
|
1810
|
-
"
|
|
1702
|
+
"agent:mcp:update",
|
|
1703
|
+
"mcp:agent:update",
|
|
1704
|
+
"mcp:update:agent",
|
|
1705
|
+
"agent:update:mcp",
|
|
1706
|
+
"update:agent:mcp",
|
|
1707
|
+
"update:mcp:agent"
|
|
1811
1708
|
]
|
|
1812
1709
|
},
|
|
1813
|
-
"agent:
|
|
1710
|
+
"agent:generate:agent-spec": {
|
|
1814
1711
|
"aliases": [],
|
|
1815
1712
|
"args": {},
|
|
1816
|
-
"description": "
|
|
1713
|
+
"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.)",
|
|
1817
1714
|
"examples": [
|
|
1818
|
-
"
|
|
1819
|
-
"
|
|
1715
|
+
"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.\"",
|
|
1716
|
+
"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",
|
|
1717
|
+
"Be prompted for all required and optional agent properties; use your default org:\n<%= config.bin %> <%= command.id %> --full-interview",
|
|
1718
|
+
"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\"",
|
|
1719
|
+
"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"
|
|
1820
1720
|
],
|
|
1821
1721
|
"flags": {
|
|
1822
1722
|
"json": {
|
|
@@ -1850,65 +1750,614 @@
|
|
|
1850
1750
|
"hasDynamicHelp": false,
|
|
1851
1751
|
"multiple": false,
|
|
1852
1752
|
"type": "option"
|
|
1853
|
-
}
|
|
1854
|
-
|
|
1855
|
-
|
|
1856
|
-
|
|
1857
|
-
|
|
1858
|
-
|
|
1859
|
-
|
|
1860
|
-
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
|
-
|
|
1864
|
-
|
|
1865
|
-
"
|
|
1866
|
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
|
-
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
|
|
1878
|
-
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
|
|
1884
|
-
|
|
1885
|
-
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
|
-
|
|
1889
|
-
|
|
1753
|
+
},
|
|
1754
|
+
"type": {
|
|
1755
|
+
"name": "type",
|
|
1756
|
+
"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.",
|
|
1757
|
+
"hasDynamicHelp": false,
|
|
1758
|
+
"multiple": false,
|
|
1759
|
+
"options": [
|
|
1760
|
+
"customer",
|
|
1761
|
+
"internal"
|
|
1762
|
+
],
|
|
1763
|
+
"type": "option"
|
|
1764
|
+
},
|
|
1765
|
+
"role": {
|
|
1766
|
+
"name": "role",
|
|
1767
|
+
"summary": "Role of the agent.",
|
|
1768
|
+
"hasDynamicHelp": false,
|
|
1769
|
+
"multiple": false,
|
|
1770
|
+
"type": "option"
|
|
1771
|
+
},
|
|
1772
|
+
"company-name": {
|
|
1773
|
+
"name": "company-name",
|
|
1774
|
+
"summary": "Name of your company.",
|
|
1775
|
+
"hasDynamicHelp": false,
|
|
1776
|
+
"multiple": false,
|
|
1777
|
+
"type": "option"
|
|
1778
|
+
},
|
|
1779
|
+
"company-description": {
|
|
1780
|
+
"name": "company-description",
|
|
1781
|
+
"summary": "Description of your company.",
|
|
1782
|
+
"hasDynamicHelp": false,
|
|
1783
|
+
"multiple": false,
|
|
1784
|
+
"type": "option"
|
|
1785
|
+
},
|
|
1786
|
+
"company-website": {
|
|
1787
|
+
"name": "company-website",
|
|
1788
|
+
"summary": "Website URL of your company.",
|
|
1789
|
+
"hasDynamicHelp": false,
|
|
1790
|
+
"multiple": false,
|
|
1791
|
+
"type": "option"
|
|
1792
|
+
},
|
|
1793
|
+
"max-topics": {
|
|
1794
|
+
"name": "max-topics",
|
|
1795
|
+
"summary": "Maximum number of topics to generate in the agent spec; default is 5.",
|
|
1796
|
+
"hasDynamicHelp": false,
|
|
1797
|
+
"multiple": false,
|
|
1798
|
+
"type": "option"
|
|
1799
|
+
},
|
|
1800
|
+
"agent-user": {
|
|
1801
|
+
"name": "agent-user",
|
|
1802
|
+
"summary": "Username of a user in your org to assign to your agent; determines what your agent can access and do.",
|
|
1803
|
+
"hasDynamicHelp": false,
|
|
1804
|
+
"multiple": false,
|
|
1805
|
+
"type": "option"
|
|
1806
|
+
},
|
|
1807
|
+
"enrich-logs": {
|
|
1808
|
+
"name": "enrich-logs",
|
|
1809
|
+
"summary": "Adds agent conversation data to event logs so you can view all agent session activity in one place.",
|
|
1810
|
+
"hasDynamicHelp": false,
|
|
1811
|
+
"multiple": false,
|
|
1812
|
+
"options": [
|
|
1813
|
+
"true",
|
|
1814
|
+
"false"
|
|
1815
|
+
],
|
|
1816
|
+
"type": "option"
|
|
1817
|
+
},
|
|
1818
|
+
"tone": {
|
|
1819
|
+
"name": "tone",
|
|
1820
|
+
"summary": "Conversational style of the agent, such as how it expresses your brand personality in its messages through word choice, punctuation, and sentence structure.",
|
|
1821
|
+
"hasDynamicHelp": false,
|
|
1822
|
+
"multiple": false,
|
|
1823
|
+
"options": [
|
|
1824
|
+
"formal",
|
|
1825
|
+
"casual",
|
|
1826
|
+
"neutral"
|
|
1827
|
+
],
|
|
1828
|
+
"type": "option"
|
|
1829
|
+
},
|
|
1830
|
+
"spec": {
|
|
1831
|
+
"name": "spec",
|
|
1832
|
+
"summary": "Agent spec file, in YAML format, to use as input to the command.",
|
|
1833
|
+
"hasDynamicHelp": false,
|
|
1834
|
+
"multiple": false,
|
|
1835
|
+
"type": "option"
|
|
1836
|
+
},
|
|
1837
|
+
"output-file": {
|
|
1838
|
+
"name": "output-file",
|
|
1839
|
+
"summary": "Path for the generated YAML agent spec file; can be an absolute or relative path.",
|
|
1840
|
+
"default": "specs/agentSpec.yaml",
|
|
1841
|
+
"hasDynamicHelp": false,
|
|
1842
|
+
"multiple": false,
|
|
1843
|
+
"type": "option"
|
|
1844
|
+
},
|
|
1845
|
+
"full-interview": {
|
|
1846
|
+
"name": "full-interview",
|
|
1847
|
+
"summary": "Prompt for both required and optional flags.",
|
|
1848
|
+
"allowNo": false,
|
|
1849
|
+
"type": "boolean"
|
|
1850
|
+
},
|
|
1851
|
+
"prompt-template": {
|
|
1852
|
+
"name": "prompt-template",
|
|
1853
|
+
"summary": "API name of a customized prompt template to use instead of the default prompt template.",
|
|
1854
|
+
"hasDynamicHelp": false,
|
|
1855
|
+
"multiple": false,
|
|
1856
|
+
"type": "option"
|
|
1857
|
+
},
|
|
1858
|
+
"grounding-context": {
|
|
1859
|
+
"dependsOn": [
|
|
1860
|
+
"prompt-template"
|
|
1861
|
+
],
|
|
1862
|
+
"name": "grounding-context",
|
|
1863
|
+
"summary": "Context information and personalization that's added to your prompts when using a custom prompt template.",
|
|
1864
|
+
"hasDynamicHelp": false,
|
|
1865
|
+
"multiple": false,
|
|
1866
|
+
"type": "option"
|
|
1867
|
+
},
|
|
1868
|
+
"force-overwrite": {
|
|
1869
|
+
"name": "force-overwrite",
|
|
1870
|
+
"summary": "Don't prompt the user to confirm that an existing spec file will be overwritten.",
|
|
1871
|
+
"allowNo": false,
|
|
1872
|
+
"type": "boolean"
|
|
1873
|
+
}
|
|
1874
|
+
},
|
|
1875
|
+
"hasDynamicHelp": true,
|
|
1876
|
+
"hiddenAliases": [],
|
|
1877
|
+
"id": "agent:generate:agent-spec",
|
|
1878
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
1879
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
1880
|
+
"pluginType": "core",
|
|
1881
|
+
"strict": true,
|
|
1882
|
+
"summary": "Generate an agent spec, which is a YAML file that captures what an agent can do.",
|
|
1883
|
+
"enableJsonFlag": true,
|
|
1884
|
+
"requiresProject": true,
|
|
1885
|
+
"isESM": true,
|
|
1886
|
+
"relativePath": [
|
|
1887
|
+
"lib",
|
|
1888
|
+
"commands",
|
|
1889
|
+
"agent",
|
|
1890
|
+
"generate",
|
|
1891
|
+
"agent-spec.js"
|
|
1892
|
+
],
|
|
1893
|
+
"aliasPermutations": [],
|
|
1894
|
+
"permutations": [
|
|
1895
|
+
"agent:generate:agent-spec",
|
|
1896
|
+
"generate:agent:agent-spec",
|
|
1897
|
+
"generate:agent-spec:agent",
|
|
1898
|
+
"agent:agent-spec:generate",
|
|
1899
|
+
"agent-spec:agent:generate",
|
|
1900
|
+
"agent-spec:generate:agent"
|
|
1901
|
+
]
|
|
1902
|
+
},
|
|
1903
|
+
"agent:generate:authoring-bundle": {
|
|
1904
|
+
"aliases": [],
|
|
1905
|
+
"args": {},
|
|
1906
|
+
"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.",
|
|
1907
|
+
"examples": [
|
|
1908
|
+
"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 %>",
|
|
1909
|
+
"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\"",
|
|
1910
|
+
"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\"",
|
|
1911
|
+
"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"
|
|
1912
|
+
],
|
|
1913
|
+
"flags": {
|
|
1914
|
+
"json": {
|
|
1915
|
+
"description": "Format output as json.",
|
|
1916
|
+
"helpGroup": "GLOBAL",
|
|
1917
|
+
"name": "json",
|
|
1918
|
+
"allowNo": false,
|
|
1919
|
+
"type": "boolean"
|
|
1920
|
+
},
|
|
1921
|
+
"flags-dir": {
|
|
1922
|
+
"helpGroup": "GLOBAL",
|
|
1923
|
+
"name": "flags-dir",
|
|
1924
|
+
"summary": "Import flag values from a directory.",
|
|
1925
|
+
"hasDynamicHelp": false,
|
|
1926
|
+
"multiple": false,
|
|
1927
|
+
"type": "option"
|
|
1928
|
+
},
|
|
1929
|
+
"target-org": {
|
|
1930
|
+
"char": "o",
|
|
1931
|
+
"name": "target-org",
|
|
1932
|
+
"noCacheDefault": true,
|
|
1933
|
+
"required": true,
|
|
1934
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1935
|
+
"hasDynamicHelp": true,
|
|
1936
|
+
"multiple": false,
|
|
1937
|
+
"type": "option"
|
|
1938
|
+
},
|
|
1939
|
+
"api-name": {
|
|
1940
|
+
"name": "api-name",
|
|
1941
|
+
"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.",
|
|
1942
|
+
"hasDynamicHelp": false,
|
|
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
|
+
"spec": {
|
|
1954
|
+
"char": "f",
|
|
1955
|
+
"name": "spec",
|
|
1956
|
+
"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.",
|
|
1957
|
+
"hasDynamicHelp": false,
|
|
1958
|
+
"multiple": false,
|
|
1959
|
+
"type": "option"
|
|
1960
|
+
},
|
|
1961
|
+
"no-spec": {
|
|
1962
|
+
"name": "no-spec",
|
|
1963
|
+
"summary": "Skip prompting for an agent spec and use the default Agent Script boilerplate in the generated authoring bundle.",
|
|
1964
|
+
"allowNo": false,
|
|
1965
|
+
"type": "boolean"
|
|
1966
|
+
},
|
|
1967
|
+
"output-dir": {
|
|
1968
|
+
"char": "d",
|
|
1969
|
+
"name": "output-dir",
|
|
1970
|
+
"summary": "Directory where the authoring bundle files are generated.",
|
|
1971
|
+
"hasDynamicHelp": false,
|
|
1972
|
+
"multiple": false,
|
|
1973
|
+
"type": "option"
|
|
1974
|
+
},
|
|
1975
|
+
"name": {
|
|
1976
|
+
"char": "n",
|
|
1977
|
+
"name": "name",
|
|
1978
|
+
"summary": "Name (label) of the authoring bundle; if not specified, you're prompted for the name.",
|
|
1979
|
+
"hasDynamicHelp": false,
|
|
1980
|
+
"multiple": false,
|
|
1981
|
+
"type": "option"
|
|
1982
|
+
},
|
|
1983
|
+
"force-overwrite": {
|
|
1984
|
+
"name": "force-overwrite",
|
|
1985
|
+
"summary": "Overwrite the existing authoring bundle if one with the same API name already exists locally.",
|
|
1986
|
+
"allowNo": false,
|
|
1987
|
+
"type": "boolean"
|
|
1988
|
+
}
|
|
1989
|
+
},
|
|
1990
|
+
"hasDynamicHelp": true,
|
|
1991
|
+
"hiddenAliases": [],
|
|
1992
|
+
"id": "agent:generate:authoring-bundle",
|
|
1993
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
1994
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
1995
|
+
"pluginType": "core",
|
|
1996
|
+
"strict": true,
|
|
1997
|
+
"summary": "Generate an authoring bundle from an existing agent spec YAML file.",
|
|
1998
|
+
"enableJsonFlag": true,
|
|
1999
|
+
"requiresProject": true,
|
|
2000
|
+
"isESM": true,
|
|
2001
|
+
"relativePath": [
|
|
2002
|
+
"lib",
|
|
2003
|
+
"commands",
|
|
2004
|
+
"agent",
|
|
2005
|
+
"generate",
|
|
2006
|
+
"authoring-bundle.js"
|
|
2007
|
+
],
|
|
2008
|
+
"aliasPermutations": [],
|
|
2009
|
+
"permutations": [
|
|
2010
|
+
"agent:generate:authoring-bundle",
|
|
2011
|
+
"generate:agent:authoring-bundle",
|
|
2012
|
+
"generate:authoring-bundle:agent",
|
|
2013
|
+
"agent:authoring-bundle:generate",
|
|
2014
|
+
"authoring-bundle:agent:generate",
|
|
2015
|
+
"authoring-bundle:generate:agent"
|
|
2016
|
+
]
|
|
2017
|
+
},
|
|
2018
|
+
"agent:generate:template": {
|
|
2019
|
+
"aliases": [],
|
|
2020
|
+
"args": {},
|
|
2021
|
+
"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.",
|
|
2022
|
+
"examples": [
|
|
2023
|
+
"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"
|
|
2024
|
+
],
|
|
2025
|
+
"flags": {
|
|
2026
|
+
"json": {
|
|
2027
|
+
"description": "Format output as json.",
|
|
2028
|
+
"helpGroup": "GLOBAL",
|
|
2029
|
+
"name": "json",
|
|
2030
|
+
"allowNo": false,
|
|
2031
|
+
"type": "boolean"
|
|
2032
|
+
},
|
|
2033
|
+
"flags-dir": {
|
|
2034
|
+
"helpGroup": "GLOBAL",
|
|
2035
|
+
"name": "flags-dir",
|
|
2036
|
+
"summary": "Import flag values from a directory.",
|
|
2037
|
+
"hasDynamicHelp": false,
|
|
2038
|
+
"multiple": false,
|
|
2039
|
+
"type": "option"
|
|
2040
|
+
},
|
|
2041
|
+
"api-version": {
|
|
2042
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2043
|
+
"name": "api-version",
|
|
2044
|
+
"hasDynamicHelp": false,
|
|
2045
|
+
"multiple": false,
|
|
2046
|
+
"type": "option"
|
|
2047
|
+
},
|
|
2048
|
+
"source-org": {
|
|
2049
|
+
"char": "s",
|
|
2050
|
+
"name": "source-org",
|
|
2051
|
+
"noCacheDefault": true,
|
|
2052
|
+
"required": true,
|
|
2053
|
+
"summary": "Username or alias of the namespaced scratch org that contains the agent which this template is based on.",
|
|
2054
|
+
"hasDynamicHelp": true,
|
|
2055
|
+
"multiple": false,
|
|
2056
|
+
"type": "option"
|
|
2057
|
+
},
|
|
2058
|
+
"agent-version": {
|
|
2059
|
+
"name": "agent-version",
|
|
2060
|
+
"required": true,
|
|
2061
|
+
"summary": "Version of the agent (BotVersion).",
|
|
2062
|
+
"hasDynamicHelp": false,
|
|
2063
|
+
"multiple": false,
|
|
2064
|
+
"type": "option"
|
|
2065
|
+
},
|
|
2066
|
+
"agent-file": {
|
|
2067
|
+
"char": "f",
|
|
2068
|
+
"name": "agent-file",
|
|
2069
|
+
"required": true,
|
|
2070
|
+
"summary": "Path to an agent (Bot) metadata file.",
|
|
2071
|
+
"hasDynamicHelp": false,
|
|
2072
|
+
"multiple": false,
|
|
2073
|
+
"type": "option"
|
|
2074
|
+
},
|
|
2075
|
+
"output-dir": {
|
|
2076
|
+
"char": "r",
|
|
2077
|
+
"name": "output-dir",
|
|
2078
|
+
"summary": "Directory where the generated BotTemplate and GenAiPlannerBundle files are saved.",
|
|
2079
|
+
"hasDynamicHelp": false,
|
|
2080
|
+
"multiple": false,
|
|
2081
|
+
"type": "option"
|
|
2082
|
+
}
|
|
2083
|
+
},
|
|
2084
|
+
"hasDynamicHelp": true,
|
|
2085
|
+
"hiddenAliases": [],
|
|
2086
|
+
"id": "agent:generate:template",
|
|
2087
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
2088
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
2089
|
+
"pluginType": "core",
|
|
2090
|
+
"strict": true,
|
|
2091
|
+
"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.",
|
|
2092
|
+
"enableJsonFlag": true,
|
|
2093
|
+
"requiresProject": true,
|
|
2094
|
+
"isESM": true,
|
|
2095
|
+
"relativePath": [
|
|
2096
|
+
"lib",
|
|
2097
|
+
"commands",
|
|
1890
2098
|
"agent",
|
|
1891
|
-
"
|
|
1892
|
-
"
|
|
2099
|
+
"generate",
|
|
2100
|
+
"template.js"
|
|
2101
|
+
],
|
|
2102
|
+
"aliasPermutations": [],
|
|
2103
|
+
"permutations": [
|
|
2104
|
+
"agent:generate:template",
|
|
2105
|
+
"generate:agent:template",
|
|
2106
|
+
"generate:template:agent",
|
|
2107
|
+
"agent:template:generate",
|
|
2108
|
+
"template:agent:generate",
|
|
2109
|
+
"template:generate:agent"
|
|
2110
|
+
]
|
|
2111
|
+
},
|
|
2112
|
+
"agent:generate:test-spec": {
|
|
2113
|
+
"aliases": [],
|
|
2114
|
+
"args": {},
|
|
2115
|
+
"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.",
|
|
2116
|
+
"examples": [
|
|
2117
|
+
"Generate an agent test spec YAML file interactively:\n<%= config.bin %> <%= command.id %>",
|
|
2118
|
+
"Generate an Agentforce Studio (NGT) test spec YAML file interactively:\n<%= config.bin %> <%= command.id %> --test-runner agentforce-studio",
|
|
2119
|
+
"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",
|
|
2120
|
+
"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",
|
|
2121
|
+
"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"
|
|
2122
|
+
],
|
|
2123
|
+
"flags": {
|
|
2124
|
+
"flags-dir": {
|
|
2125
|
+
"helpGroup": "GLOBAL",
|
|
2126
|
+
"name": "flags-dir",
|
|
2127
|
+
"summary": "Import flag values from a directory.",
|
|
2128
|
+
"hasDynamicHelp": false,
|
|
2129
|
+
"multiple": false,
|
|
2130
|
+
"type": "option"
|
|
2131
|
+
},
|
|
2132
|
+
"from-definition": {
|
|
2133
|
+
"char": "d",
|
|
2134
|
+
"name": "from-definition",
|
|
2135
|
+
"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.",
|
|
2136
|
+
"hasDynamicHelp": false,
|
|
2137
|
+
"multiple": false,
|
|
2138
|
+
"type": "option"
|
|
2139
|
+
},
|
|
2140
|
+
"force-overwrite": {
|
|
2141
|
+
"name": "force-overwrite",
|
|
2142
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test spec YAML file.",
|
|
2143
|
+
"allowNo": false,
|
|
2144
|
+
"type": "boolean"
|
|
2145
|
+
},
|
|
2146
|
+
"output-file": {
|
|
2147
|
+
"char": "f",
|
|
2148
|
+
"name": "output-file",
|
|
2149
|
+
"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).",
|
|
2150
|
+
"hasDynamicHelp": false,
|
|
2151
|
+
"multiple": false,
|
|
2152
|
+
"type": "option"
|
|
2153
|
+
},
|
|
2154
|
+
"test-runner": {
|
|
2155
|
+
"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.",
|
|
2156
|
+
"name": "test-runner",
|
|
2157
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2158
|
+
"hasDynamicHelp": false,
|
|
2159
|
+
"multiple": false,
|
|
2160
|
+
"options": [
|
|
2161
|
+
"agentforce-studio",
|
|
2162
|
+
"testing-center"
|
|
2163
|
+
],
|
|
2164
|
+
"type": "option"
|
|
2165
|
+
}
|
|
2166
|
+
},
|
|
2167
|
+
"hasDynamicHelp": false,
|
|
2168
|
+
"hiddenAliases": [],
|
|
2169
|
+
"id": "agent:generate:test-spec",
|
|
2170
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
2171
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
2172
|
+
"pluginType": "core",
|
|
2173
|
+
"strict": true,
|
|
2174
|
+
"summary": "Generate an agent test spec, which is a YAML file that lists the test cases for testing a specific agent.",
|
|
2175
|
+
"enableJsonFlag": false,
|
|
2176
|
+
"isESM": true,
|
|
2177
|
+
"relativePath": [
|
|
2178
|
+
"lib",
|
|
2179
|
+
"commands",
|
|
2180
|
+
"agent",
|
|
2181
|
+
"generate",
|
|
2182
|
+
"test-spec.js"
|
|
2183
|
+
],
|
|
2184
|
+
"aliasPermutations": [],
|
|
2185
|
+
"permutations": [
|
|
2186
|
+
"agent:generate:test-spec",
|
|
2187
|
+
"generate:agent:test-spec",
|
|
2188
|
+
"generate:test-spec:agent",
|
|
2189
|
+
"agent:test-spec:generate",
|
|
2190
|
+
"test-spec:agent:generate",
|
|
2191
|
+
"test-spec:generate:agent"
|
|
2192
|
+
]
|
|
2193
|
+
},
|
|
2194
|
+
"agent:preview:end": {
|
|
2195
|
+
"aliases": [],
|
|
2196
|
+
"args": {},
|
|
2197
|
+
"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.",
|
|
2198
|
+
"examples": [
|
|
2199
|
+
"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",
|
|
2200
|
+
"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",
|
|
2201
|
+
"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",
|
|
2202
|
+
"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",
|
|
2203
|
+
"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>"
|
|
2204
|
+
],
|
|
2205
|
+
"flags": {
|
|
2206
|
+
"json": {
|
|
2207
|
+
"description": "Format output as json.",
|
|
2208
|
+
"helpGroup": "GLOBAL",
|
|
2209
|
+
"name": "json",
|
|
2210
|
+
"allowNo": false,
|
|
2211
|
+
"type": "boolean"
|
|
2212
|
+
},
|
|
2213
|
+
"flags-dir": {
|
|
2214
|
+
"helpGroup": "GLOBAL",
|
|
2215
|
+
"name": "flags-dir",
|
|
2216
|
+
"summary": "Import flag values from a directory.",
|
|
2217
|
+
"hasDynamicHelp": false,
|
|
2218
|
+
"multiple": false,
|
|
2219
|
+
"type": "option"
|
|
2220
|
+
},
|
|
2221
|
+
"target-org": {
|
|
2222
|
+
"char": "o",
|
|
2223
|
+
"name": "target-org",
|
|
2224
|
+
"noCacheDefault": true,
|
|
2225
|
+
"required": true,
|
|
2226
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2227
|
+
"hasDynamicHelp": true,
|
|
2228
|
+
"multiple": false,
|
|
2229
|
+
"type": "option"
|
|
2230
|
+
},
|
|
2231
|
+
"api-version": {
|
|
2232
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2233
|
+
"name": "api-version",
|
|
2234
|
+
"hasDynamicHelp": false,
|
|
2235
|
+
"multiple": false,
|
|
2236
|
+
"type": "option"
|
|
2237
|
+
},
|
|
2238
|
+
"session-id": {
|
|
2239
|
+
"exclusive": [
|
|
2240
|
+
"all"
|
|
2241
|
+
],
|
|
2242
|
+
"name": "session-id",
|
|
2243
|
+
"required": false,
|
|
2244
|
+
"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.",
|
|
2245
|
+
"hasDynamicHelp": false,
|
|
2246
|
+
"multiple": false,
|
|
2247
|
+
"type": "option"
|
|
2248
|
+
},
|
|
2249
|
+
"api-name": {
|
|
2250
|
+
"char": "n",
|
|
2251
|
+
"exclusive": [
|
|
2252
|
+
"authoring-bundle"
|
|
2253
|
+
],
|
|
2254
|
+
"name": "api-name",
|
|
2255
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
2256
|
+
"hasDynamicHelp": false,
|
|
2257
|
+
"multiple": false,
|
|
2258
|
+
"type": "option"
|
|
2259
|
+
},
|
|
2260
|
+
"authoring-bundle": {
|
|
2261
|
+
"exclusive": [
|
|
2262
|
+
"api-name"
|
|
2263
|
+
],
|
|
2264
|
+
"name": "authoring-bundle",
|
|
2265
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2266
|
+
"hasDynamicHelp": false,
|
|
2267
|
+
"multiple": false,
|
|
2268
|
+
"type": "option"
|
|
2269
|
+
},
|
|
2270
|
+
"all": {
|
|
2271
|
+
"exclusive": [
|
|
2272
|
+
"session-id"
|
|
2273
|
+
],
|
|
2274
|
+
"name": "all",
|
|
2275
|
+
"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.",
|
|
2276
|
+
"allowNo": false,
|
|
2277
|
+
"type": "boolean"
|
|
2278
|
+
},
|
|
2279
|
+
"no-prompt": {
|
|
2280
|
+
"char": "p",
|
|
2281
|
+
"name": "no-prompt",
|
|
2282
|
+
"summary": "Don't prompt for confirmation before ending sessions. Has an effect only when used with --all.",
|
|
2283
|
+
"allowNo": false,
|
|
2284
|
+
"type": "boolean"
|
|
2285
|
+
}
|
|
2286
|
+
},
|
|
2287
|
+
"hasDynamicHelp": true,
|
|
2288
|
+
"hiddenAliases": [],
|
|
2289
|
+
"id": "agent:preview:end",
|
|
2290
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
2291
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
2292
|
+
"pluginType": "core",
|
|
2293
|
+
"strict": true,
|
|
2294
|
+
"summary": "End an existing programmatic agent preview session and get trace location.",
|
|
2295
|
+
"enableJsonFlag": true,
|
|
2296
|
+
"requiresProject": true,
|
|
2297
|
+
"envVariablesSection": {
|
|
2298
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2299
|
+
"body": [
|
|
2300
|
+
{
|
|
2301
|
+
"name": "SF_TARGET_ORG",
|
|
2302
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2303
|
+
}
|
|
2304
|
+
]
|
|
2305
|
+
},
|
|
2306
|
+
"errorCodes": {
|
|
2307
|
+
"header": "ERROR CODES",
|
|
2308
|
+
"body": [
|
|
2309
|
+
{
|
|
2310
|
+
"name": "Succeeded (0)",
|
|
2311
|
+
"description": "Preview session ended successfully and traces saved."
|
|
2312
|
+
},
|
|
2313
|
+
{
|
|
2314
|
+
"name": "ExactlyOneRequired (2)",
|
|
2315
|
+
"description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
|
|
2316
|
+
},
|
|
2317
|
+
{
|
|
2318
|
+
"name": "NotFound (2)",
|
|
2319
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
2320
|
+
},
|
|
2321
|
+
{
|
|
2322
|
+
"name": "PreviewEndFailed (4)",
|
|
2323
|
+
"description": "Failed to end the preview session."
|
|
2324
|
+
},
|
|
2325
|
+
{
|
|
2326
|
+
"name": "PreviewEndPartialFailure (68)",
|
|
2327
|
+
"description": "With --all, one or more sessions failed to end while others succeeded."
|
|
2328
|
+
},
|
|
2329
|
+
{
|
|
2330
|
+
"name": "SessionAmbiguous (5)",
|
|
2331
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2332
|
+
}
|
|
2333
|
+
]
|
|
2334
|
+
},
|
|
2335
|
+
"isESM": true,
|
|
2336
|
+
"relativePath": [
|
|
2337
|
+
"lib",
|
|
2338
|
+
"commands",
|
|
2339
|
+
"agent",
|
|
2340
|
+
"preview",
|
|
2341
|
+
"end.js"
|
|
1893
2342
|
],
|
|
1894
2343
|
"aliasPermutations": [],
|
|
1895
2344
|
"permutations": [
|
|
1896
|
-
"agent:
|
|
1897
|
-
"
|
|
1898
|
-
"
|
|
1899
|
-
"agent:
|
|
1900
|
-
"
|
|
1901
|
-
"
|
|
2345
|
+
"agent:preview:end",
|
|
2346
|
+
"preview:agent:end",
|
|
2347
|
+
"preview:end:agent",
|
|
2348
|
+
"agent:end:preview",
|
|
2349
|
+
"end:agent:preview",
|
|
2350
|
+
"end:preview:agent"
|
|
1902
2351
|
]
|
|
1903
2352
|
},
|
|
1904
|
-
"agent:
|
|
2353
|
+
"agent:preview:send": {
|
|
1905
2354
|
"aliases": [],
|
|
1906
2355
|
"args": {},
|
|
1907
|
-
"description": "
|
|
2356
|
+
"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.",
|
|
1908
2357
|
"examples": [
|
|
1909
|
-
"
|
|
1910
|
-
"
|
|
1911
|
-
"
|
|
2358
|
+
"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>",
|
|
2359
|
+
"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",
|
|
2360
|
+
"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"
|
|
1912
2361
|
],
|
|
1913
2362
|
"flags": {
|
|
1914
2363
|
"json": {
|
|
@@ -1943,67 +2392,264 @@
|
|
|
1943
2392
|
"multiple": false,
|
|
1944
2393
|
"type": "option"
|
|
1945
2394
|
},
|
|
1946
|
-
"
|
|
1947
|
-
"
|
|
1948
|
-
"
|
|
2395
|
+
"session-id": {
|
|
2396
|
+
"name": "session-id",
|
|
2397
|
+
"required": false,
|
|
2398
|
+
"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.",
|
|
2399
|
+
"hasDynamicHelp": false,
|
|
2400
|
+
"multiple": false,
|
|
2401
|
+
"type": "option"
|
|
2402
|
+
},
|
|
2403
|
+
"utterance": {
|
|
2404
|
+
"char": "u",
|
|
2405
|
+
"name": "utterance",
|
|
1949
2406
|
"required": true,
|
|
1950
|
-
"summary": "
|
|
2407
|
+
"summary": "Utterance to send to the agent, enclosed in double quotes.",
|
|
1951
2408
|
"hasDynamicHelp": false,
|
|
1952
2409
|
"multiple": false,
|
|
1953
2410
|
"type": "option"
|
|
1954
2411
|
},
|
|
1955
|
-
"
|
|
1956
|
-
"
|
|
1957
|
-
"
|
|
1958
|
-
"
|
|
2412
|
+
"api-name": {
|
|
2413
|
+
"char": "n",
|
|
2414
|
+
"name": "api-name",
|
|
2415
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
1959
2416
|
"hasDynamicHelp": false,
|
|
1960
2417
|
"multiple": false,
|
|
1961
|
-
"options": [
|
|
1962
|
-
"json",
|
|
1963
|
-
"human",
|
|
1964
|
-
"junit",
|
|
1965
|
-
"tap"
|
|
1966
|
-
],
|
|
1967
2418
|
"type": "option"
|
|
1968
2419
|
},
|
|
1969
|
-
"
|
|
1970
|
-
"
|
|
1971
|
-
"
|
|
1972
|
-
"
|
|
1973
|
-
"
|
|
2420
|
+
"authoring-bundle": {
|
|
2421
|
+
"name": "authoring-bundle",
|
|
2422
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2423
|
+
"hasDynamicHelp": false,
|
|
2424
|
+
"multiple": false,
|
|
2425
|
+
"type": "option"
|
|
2426
|
+
}
|
|
2427
|
+
},
|
|
2428
|
+
"hasDynamicHelp": true,
|
|
2429
|
+
"hiddenAliases": [],
|
|
2430
|
+
"id": "agent:preview:send",
|
|
2431
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
2432
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
2433
|
+
"pluginType": "core",
|
|
2434
|
+
"strict": true,
|
|
2435
|
+
"summary": "Send a message to an existing agent preview session.",
|
|
2436
|
+
"enableJsonFlag": true,
|
|
2437
|
+
"requiresProject": true,
|
|
2438
|
+
"envVariablesSection": {
|
|
2439
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2440
|
+
"body": [
|
|
2441
|
+
{
|
|
2442
|
+
"name": "SF_TARGET_ORG",
|
|
2443
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2444
|
+
}
|
|
2445
|
+
]
|
|
2446
|
+
},
|
|
2447
|
+
"errorCodes": {
|
|
2448
|
+
"header": "ERROR CODES",
|
|
2449
|
+
"body": [
|
|
2450
|
+
{
|
|
2451
|
+
"name": "Succeeded (0)",
|
|
2452
|
+
"description": "Message sent successfully and agent response received."
|
|
2453
|
+
},
|
|
2454
|
+
{
|
|
2455
|
+
"name": "NotFound (2)",
|
|
2456
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
2457
|
+
},
|
|
2458
|
+
{
|
|
2459
|
+
"name": "PreviewSendFailed (4)",
|
|
2460
|
+
"description": "Failed to send message or receive response from the preview session."
|
|
2461
|
+
},
|
|
2462
|
+
{
|
|
2463
|
+
"name": "SessionAmbiguous (5)",
|
|
2464
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2465
|
+
}
|
|
2466
|
+
]
|
|
2467
|
+
},
|
|
2468
|
+
"isESM": true,
|
|
2469
|
+
"relativePath": [
|
|
2470
|
+
"lib",
|
|
2471
|
+
"commands",
|
|
2472
|
+
"agent",
|
|
2473
|
+
"preview",
|
|
2474
|
+
"send.js"
|
|
2475
|
+
],
|
|
2476
|
+
"aliasPermutations": [],
|
|
2477
|
+
"permutations": [
|
|
2478
|
+
"agent:preview:send",
|
|
2479
|
+
"preview:agent:send",
|
|
2480
|
+
"preview:send:agent",
|
|
2481
|
+
"agent:send:preview",
|
|
2482
|
+
"send:agent:preview",
|
|
2483
|
+
"send:preview:agent"
|
|
2484
|
+
]
|
|
2485
|
+
},
|
|
2486
|
+
"agent:preview:sessions": {
|
|
2487
|
+
"aliases": [],
|
|
2488
|
+
"args": {},
|
|
2489
|
+
"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.",
|
|
2490
|
+
"examples": [
|
|
2491
|
+
"List all cached agent preview sessions:\n<%= config.bin %> <%= command.id %>"
|
|
2492
|
+
],
|
|
2493
|
+
"flags": {
|
|
2494
|
+
"json": {
|
|
2495
|
+
"description": "Format output as json.",
|
|
2496
|
+
"helpGroup": "GLOBAL",
|
|
2497
|
+
"name": "json",
|
|
2498
|
+
"allowNo": false,
|
|
2499
|
+
"type": "boolean"
|
|
2500
|
+
},
|
|
2501
|
+
"flags-dir": {
|
|
2502
|
+
"helpGroup": "GLOBAL",
|
|
2503
|
+
"name": "flags-dir",
|
|
2504
|
+
"summary": "Import flag values from a directory.",
|
|
2505
|
+
"hasDynamicHelp": false,
|
|
2506
|
+
"multiple": false,
|
|
2507
|
+
"type": "option"
|
|
2508
|
+
}
|
|
2509
|
+
},
|
|
2510
|
+
"hasDynamicHelp": false,
|
|
2511
|
+
"hiddenAliases": [],
|
|
2512
|
+
"id": "agent:preview:sessions",
|
|
2513
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
2514
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
2515
|
+
"pluginType": "core",
|
|
2516
|
+
"strict": true,
|
|
2517
|
+
"summary": "List all known programmatic agent preview sessions.",
|
|
2518
|
+
"enableJsonFlag": true,
|
|
2519
|
+
"requiresProject": true,
|
|
2520
|
+
"errorCodes": {
|
|
2521
|
+
"header": "ERROR CODES",
|
|
2522
|
+
"body": [
|
|
2523
|
+
{
|
|
2524
|
+
"name": "Succeeded (0)",
|
|
2525
|
+
"description": "Sessions listed successfully (or empty list if no active sessions)."
|
|
2526
|
+
}
|
|
2527
|
+
]
|
|
2528
|
+
},
|
|
2529
|
+
"isESM": true,
|
|
2530
|
+
"relativePath": [
|
|
2531
|
+
"lib",
|
|
2532
|
+
"commands",
|
|
2533
|
+
"agent",
|
|
2534
|
+
"preview",
|
|
2535
|
+
"sessions.js"
|
|
2536
|
+
],
|
|
2537
|
+
"aliasPermutations": [],
|
|
2538
|
+
"permutations": [
|
|
2539
|
+
"agent:preview:sessions",
|
|
2540
|
+
"preview:agent:sessions",
|
|
2541
|
+
"preview:sessions:agent",
|
|
2542
|
+
"agent:sessions:preview",
|
|
2543
|
+
"sessions:agent:preview",
|
|
2544
|
+
"sessions:preview:agent"
|
|
2545
|
+
]
|
|
2546
|
+
},
|
|
2547
|
+
"agent:preview:start": {
|
|
2548
|
+
"aliases": [],
|
|
2549
|
+
"args": {},
|
|
2550
|
+
"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.",
|
|
2551
|
+
"examples": [
|
|
2552
|
+
"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",
|
|
2553
|
+
"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",
|
|
2554
|
+
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
2555
|
+
],
|
|
2556
|
+
"flags": {
|
|
2557
|
+
"json": {
|
|
2558
|
+
"description": "Format output as json.",
|
|
2559
|
+
"helpGroup": "GLOBAL",
|
|
2560
|
+
"name": "json",
|
|
2561
|
+
"allowNo": false,
|
|
2562
|
+
"type": "boolean"
|
|
2563
|
+
},
|
|
2564
|
+
"flags-dir": {
|
|
2565
|
+
"helpGroup": "GLOBAL",
|
|
2566
|
+
"name": "flags-dir",
|
|
2567
|
+
"summary": "Import flag values from a directory.",
|
|
2568
|
+
"hasDynamicHelp": false,
|
|
2569
|
+
"multiple": false,
|
|
2570
|
+
"type": "option"
|
|
2571
|
+
},
|
|
2572
|
+
"target-org": {
|
|
2573
|
+
"char": "o",
|
|
2574
|
+
"name": "target-org",
|
|
2575
|
+
"noCacheDefault": true,
|
|
2576
|
+
"required": true,
|
|
2577
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2578
|
+
"hasDynamicHelp": true,
|
|
2579
|
+
"multiple": false,
|
|
2580
|
+
"type": "option"
|
|
2581
|
+
},
|
|
2582
|
+
"api-version": {
|
|
2583
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2584
|
+
"name": "api-version",
|
|
2585
|
+
"hasDynamicHelp": false,
|
|
2586
|
+
"multiple": false,
|
|
2587
|
+
"type": "option"
|
|
2588
|
+
},
|
|
2589
|
+
"api-name": {
|
|
2590
|
+
"char": "n",
|
|
2591
|
+
"name": "api-name",
|
|
2592
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
2593
|
+
"hasDynamicHelp": false,
|
|
2594
|
+
"multiple": false,
|
|
2595
|
+
"type": "option"
|
|
2596
|
+
},
|
|
2597
|
+
"authoring-bundle": {
|
|
2598
|
+
"name": "authoring-bundle",
|
|
2599
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2600
|
+
"hasDynamicHelp": false,
|
|
2601
|
+
"multiple": false,
|
|
2602
|
+
"type": "option"
|
|
2603
|
+
},
|
|
2604
|
+
"use-live-actions": {
|
|
2605
|
+
"exclusive": [
|
|
2606
|
+
"simulate-actions"
|
|
2607
|
+
],
|
|
2608
|
+
"name": "use-live-actions",
|
|
2609
|
+
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
2610
|
+
"allowNo": false,
|
|
2611
|
+
"type": "boolean"
|
|
2612
|
+
},
|
|
2613
|
+
"simulate-actions": {
|
|
2614
|
+
"exclusive": [
|
|
2615
|
+
"use-live-actions"
|
|
2616
|
+
],
|
|
2617
|
+
"name": "simulate-actions",
|
|
2618
|
+
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
2619
|
+
"allowNo": false,
|
|
2620
|
+
"type": "boolean"
|
|
2621
|
+
},
|
|
2622
|
+
"context-variables": {
|
|
2623
|
+
"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.",
|
|
2624
|
+
"name": "context-variables",
|
|
2625
|
+
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
2626
|
+
"delimiter": ",",
|
|
1974
2627
|
"hasDynamicHelp": false,
|
|
1975
|
-
"multiple":
|
|
2628
|
+
"multiple": true,
|
|
1976
2629
|
"type": "option"
|
|
1977
2630
|
},
|
|
1978
|
-
"
|
|
1979
|
-
"
|
|
1980
|
-
|
|
1981
|
-
|
|
2631
|
+
"agent-json": {
|
|
2632
|
+
"dependsOn": [
|
|
2633
|
+
"authoring-bundle"
|
|
2634
|
+
],
|
|
2635
|
+
"hidden": true,
|
|
2636
|
+
"name": "agent-json",
|
|
2637
|
+
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
1982
2638
|
"hasDynamicHelp": false,
|
|
1983
2639
|
"multiple": false,
|
|
1984
|
-
"options": [
|
|
1985
|
-
"agentforce-studio",
|
|
1986
|
-
"testing-center"
|
|
1987
|
-
],
|
|
1988
2640
|
"type": "option"
|
|
1989
|
-
},
|
|
1990
|
-
"verbose": {
|
|
1991
|
-
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
1992
|
-
"name": "verbose",
|
|
1993
|
-
"summary": "Show generated data in the test results output.",
|
|
1994
|
-
"allowNo": false,
|
|
1995
|
-
"type": "boolean"
|
|
1996
2641
|
}
|
|
1997
2642
|
},
|
|
1998
2643
|
"hasDynamicHelp": true,
|
|
1999
2644
|
"hiddenAliases": [],
|
|
2000
|
-
"id": "agent:
|
|
2645
|
+
"id": "agent:preview:start",
|
|
2001
2646
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2002
2647
|
"pluginName": "@salesforce/plugin-agent",
|
|
2003
2648
|
"pluginType": "core",
|
|
2004
2649
|
"strict": true,
|
|
2005
|
-
"summary": "
|
|
2650
|
+
"summary": "Start a programmatic agent preview session.",
|
|
2006
2651
|
"enableJsonFlag": true,
|
|
2652
|
+
"requiresProject": true,
|
|
2007
2653
|
"envVariablesSection": {
|
|
2008
2654
|
"header": "ENVIRONMENT VARIABLES",
|
|
2009
2655
|
"body": [
|
|
@@ -2018,15 +2664,23 @@
|
|
|
2018
2664
|
"body": [
|
|
2019
2665
|
{
|
|
2020
2666
|
"name": "Succeeded (0)",
|
|
2021
|
-
"description": "
|
|
2667
|
+
"description": "Preview session started successfully."
|
|
2668
|
+
},
|
|
2669
|
+
{
|
|
2670
|
+
"name": "Failed (1)",
|
|
2671
|
+
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
2022
2672
|
},
|
|
2023
2673
|
{
|
|
2024
2674
|
"name": "NotFound (2)",
|
|
2025
|
-
"description": "
|
|
2675
|
+
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
2026
2676
|
},
|
|
2027
2677
|
{
|
|
2028
|
-
"name": "
|
|
2029
|
-
"description": "
|
|
2678
|
+
"name": "ServerError (3)",
|
|
2679
|
+
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
2680
|
+
},
|
|
2681
|
+
{
|
|
2682
|
+
"name": "PreviewStartFailed (4)",
|
|
2683
|
+
"description": "Preview session failed to start due to API or network errors."
|
|
2030
2684
|
}
|
|
2031
2685
|
]
|
|
2032
2686
|
},
|
|
@@ -2035,27 +2689,28 @@
|
|
|
2035
2689
|
"lib",
|
|
2036
2690
|
"commands",
|
|
2037
2691
|
"agent",
|
|
2038
|
-
"
|
|
2039
|
-
"
|
|
2692
|
+
"preview",
|
|
2693
|
+
"start.js"
|
|
2040
2694
|
],
|
|
2041
2695
|
"aliasPermutations": [],
|
|
2042
2696
|
"permutations": [
|
|
2043
|
-
"agent:
|
|
2044
|
-
"
|
|
2045
|
-
"
|
|
2046
|
-
"agent:
|
|
2047
|
-
"
|
|
2048
|
-
"
|
|
2697
|
+
"agent:preview:start",
|
|
2698
|
+
"preview:agent:start",
|
|
2699
|
+
"preview:start:agent",
|
|
2700
|
+
"agent:start:preview",
|
|
2701
|
+
"start:agent:preview",
|
|
2702
|
+
"start:preview:agent"
|
|
2049
2703
|
]
|
|
2050
2704
|
},
|
|
2051
|
-
"agent:
|
|
2705
|
+
"agent:publish:authoring-bundle": {
|
|
2052
2706
|
"aliases": [],
|
|
2053
2707
|
"args": {},
|
|
2054
|
-
"description": "
|
|
2708
|
+
"description": "An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The metadata type contains two files: the standard metatada XML file and an Agent Script file (extension \".agent\") that fully describes the agent using the Agent Script language.\n\nWhen you publish an authoring bundle to your org, a number of things happen. First, this command validates that the Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent Script file to continue. Once the Agent Script file compiles, then it's published to the org, which in turn creates new associated metadata (Bot, BotVersion, GenAiX), or new versions of the metadata if the agent already exists. The new or updated metadata is retrieved back to your DX project; specify the --skip-retrieve flag to skip this step. Finally, the authoring bundle metadata (AiAuthoringBundle) is deployed to your org.\n\nThis command uses the API name of the authoring bundle.",
|
|
2055
2709
|
"examples": [
|
|
2056
|
-
"
|
|
2057
|
-
"
|
|
2058
|
-
"
|
|
2710
|
+
"Publish an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
2711
|
+
"Publish an authoring bundle with API name MyAuthoringBundle to the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --target-org my-dev-org",
|
|
2712
|
+
"Publish with verbose output to see all retrieved and deployed metadata components:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --verbose",
|
|
2713
|
+
"Publish with concise output showing only essential information:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --concise"
|
|
2059
2714
|
],
|
|
2060
2715
|
"flags": {
|
|
2061
2716
|
"json": {
|
|
@@ -2090,141 +2745,96 @@
|
|
|
2090
2745
|
"multiple": false,
|
|
2091
2746
|
"type": "option"
|
|
2092
2747
|
},
|
|
2093
|
-
"
|
|
2094
|
-
"char": "
|
|
2095
|
-
"name": "
|
|
2096
|
-
"summary": "
|
|
2748
|
+
"api-name": {
|
|
2749
|
+
"char": "n",
|
|
2750
|
+
"name": "api-name",
|
|
2751
|
+
"summary": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
2097
2752
|
"hasDynamicHelp": false,
|
|
2098
2753
|
"multiple": false,
|
|
2099
2754
|
"type": "option"
|
|
2100
2755
|
},
|
|
2101
|
-
"
|
|
2102
|
-
"
|
|
2103
|
-
"
|
|
2104
|
-
"summary": "Use the job ID of the most recent agent test run.",
|
|
2756
|
+
"skip-retrieve": {
|
|
2757
|
+
"name": "skip-retrieve",
|
|
2758
|
+
"summary": "Don't retrieve the metadata associated with the agent to your DX project.",
|
|
2105
2759
|
"allowNo": false,
|
|
2106
2760
|
"type": "boolean"
|
|
2107
2761
|
},
|
|
2108
|
-
"
|
|
2109
|
-
"char": "
|
|
2110
|
-
"
|
|
2111
|
-
|
|
2112
|
-
"default": "5 minutes",
|
|
2113
|
-
"hasDynamicHelp": true,
|
|
2114
|
-
"multiple": false,
|
|
2115
|
-
"type": "option"
|
|
2116
|
-
},
|
|
2117
|
-
"result-format": {
|
|
2118
|
-
"name": "result-format",
|
|
2119
|
-
"summary": "Format of the agent test run results.",
|
|
2120
|
-
"default": "human",
|
|
2121
|
-
"hasDynamicHelp": false,
|
|
2122
|
-
"multiple": false,
|
|
2123
|
-
"options": [
|
|
2124
|
-
"json",
|
|
2125
|
-
"human",
|
|
2126
|
-
"junit",
|
|
2127
|
-
"tap"
|
|
2762
|
+
"verbose": {
|
|
2763
|
+
"char": "v",
|
|
2764
|
+
"exclusive": [
|
|
2765
|
+
"concise"
|
|
2128
2766
|
],
|
|
2129
|
-
"
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
"
|
|
2133
|
-
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
2134
|
-
"name": "output-dir",
|
|
2135
|
-
"summary": "Directory to write the agent test results into.",
|
|
2136
|
-
"hasDynamicHelp": false,
|
|
2137
|
-
"multiple": false,
|
|
2138
|
-
"type": "option"
|
|
2767
|
+
"name": "verbose",
|
|
2768
|
+
"summary": "Display detailed output showing all metadata components retrieved and deployed during the publish process.",
|
|
2769
|
+
"allowNo": false,
|
|
2770
|
+
"type": "boolean"
|
|
2139
2771
|
},
|
|
2140
|
-
"
|
|
2141
|
-
"
|
|
2142
|
-
|
|
2143
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2144
|
-
"hasDynamicHelp": false,
|
|
2145
|
-
"multiple": false,
|
|
2146
|
-
"options": [
|
|
2147
|
-
"agentforce-studio",
|
|
2148
|
-
"testing-center"
|
|
2772
|
+
"concise": {
|
|
2773
|
+
"exclusive": [
|
|
2774
|
+
"verbose"
|
|
2149
2775
|
],
|
|
2150
|
-
"
|
|
2151
|
-
|
|
2152
|
-
"verbose": {
|
|
2153
|
-
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
2154
|
-
"name": "verbose",
|
|
2155
|
-
"summary": "Show generated data in the test results output.",
|
|
2776
|
+
"name": "concise",
|
|
2777
|
+
"summary": "Display minimal output with only essential information about the publish operation.",
|
|
2156
2778
|
"allowNo": false,
|
|
2157
2779
|
"type": "boolean"
|
|
2158
2780
|
}
|
|
2159
2781
|
},
|
|
2160
2782
|
"hasDynamicHelp": true,
|
|
2161
2783
|
"hiddenAliases": [],
|
|
2162
|
-
"id": "agent:
|
|
2784
|
+
"id": "agent:publish:authoring-bundle",
|
|
2163
2785
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2164
2786
|
"pluginName": "@salesforce/plugin-agent",
|
|
2165
2787
|
"pluginType": "core",
|
|
2166
2788
|
"strict": true,
|
|
2167
|
-
"summary": "
|
|
2789
|
+
"summary": "Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.",
|
|
2168
2790
|
"enableJsonFlag": true,
|
|
2169
|
-
"
|
|
2170
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2171
|
-
"body": [
|
|
2172
|
-
{
|
|
2173
|
-
"name": "SF_TARGET_ORG",
|
|
2174
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2175
|
-
}
|
|
2176
|
-
]
|
|
2177
|
-
},
|
|
2791
|
+
"requiresProject": true,
|
|
2178
2792
|
"errorCodes": {
|
|
2179
2793
|
"header": "ERROR CODES",
|
|
2180
2794
|
"body": [
|
|
2181
2795
|
{
|
|
2182
2796
|
"name": "Succeeded (0)",
|
|
2183
|
-
"description": "
|
|
2797
|
+
"description": "Agent published successfully without errors."
|
|
2184
2798
|
},
|
|
2185
2799
|
{
|
|
2186
2800
|
"name": "Failed (1)",
|
|
2187
|
-
"description": "
|
|
2188
|
-
},
|
|
2189
|
-
{
|
|
2190
|
-
"name": "NotFound (2)",
|
|
2191
|
-
"description": "Job ID not found or invalid."
|
|
2192
|
-
},
|
|
2193
|
-
{
|
|
2194
|
-
"name": "OperationFailed (4)",
|
|
2195
|
-
"description": "Failed to poll test due to API or network errors."
|
|
2801
|
+
"description": "Compilation errors found in the Agent Script file."
|
|
2196
2802
|
}
|
|
2197
2803
|
]
|
|
2198
2804
|
},
|
|
2805
|
+
"FLAGGABLE_PROMPTS": {
|
|
2806
|
+
"api-name": {
|
|
2807
|
+
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
2808
|
+
"promptMessage": "API name of the authoring bundle to publish"
|
|
2809
|
+
}
|
|
2810
|
+
},
|
|
2199
2811
|
"isESM": true,
|
|
2200
2812
|
"relativePath": [
|
|
2201
2813
|
"lib",
|
|
2202
2814
|
"commands",
|
|
2203
2815
|
"agent",
|
|
2204
|
-
"
|
|
2205
|
-
"
|
|
2816
|
+
"publish",
|
|
2817
|
+
"authoring-bundle.js"
|
|
2206
2818
|
],
|
|
2207
2819
|
"aliasPermutations": [],
|
|
2208
2820
|
"permutations": [
|
|
2209
|
-
"agent:
|
|
2210
|
-
"
|
|
2211
|
-
"
|
|
2212
|
-
"agent:
|
|
2213
|
-
"
|
|
2214
|
-
"
|
|
2821
|
+
"agent:publish:authoring-bundle",
|
|
2822
|
+
"publish:agent:authoring-bundle",
|
|
2823
|
+
"publish:authoring-bundle:agent",
|
|
2824
|
+
"agent:authoring-bundle:publish",
|
|
2825
|
+
"authoring-bundle:agent:publish",
|
|
2826
|
+
"authoring-bundle:publish:agent"
|
|
2215
2827
|
]
|
|
2216
2828
|
},
|
|
2217
|
-
"agent:test:
|
|
2829
|
+
"agent:test:create": {
|
|
2218
2830
|
"aliases": [],
|
|
2219
2831
|
"args": {},
|
|
2220
|
-
"description": "
|
|
2832
|
+
"description": "To run this command, you must have an agent test spec file, which is a YAML file that lists the test cases for testing a specific agent. Use the \"agent generate test-spec\" CLI command to generate a test spec file. Then specify the file to this command with the --spec flag, or run this command with no flags to be prompted.\n\nWhen this command completes, your org contains the new agent test, which you can view and edit using the Testing Center UI (legacy) or Agentforce Studio (NGT). This command also retrieves the metadata component associated with the new test to your local Salesforce DX project and displays its filename. By default, the legacy AiEvaluationDefinition is created; use --test-runner agentforce-studio to author an AiTestingDefinition (NGT) instead.\n\nAfter you've created the test in the org, use the \"agent test run\" command to run it.",
|
|
2221
2833
|
"examples": [
|
|
2222
|
-
"
|
|
2223
|
-
"
|
|
2224
|
-
"
|
|
2225
|
-
"
|
|
2226
|
-
"Run tests with contextVariables to inject contextual data into agent sessions (add contextVariables to test cases in your YAML spec):\n<%= config.bin %> <%= command.id %> --spec specs/agent-with-context.yaml --target-org my-org",
|
|
2227
|
-
"Pipe JSON payload from stdin (--spec flag is automatically populated from stdin):\n$ echo '{\"tests\":[...]}' | <%= config.bin %> <%= command.id %> --spec --target-org my-org"
|
|
2834
|
+
"Create an agent test interactively and be prompted for the test spec and API name of the test in the org; use the default org:\n<%= config.bin %> <%= command.id %>",
|
|
2835
|
+
"Create an agent test and use flags to specify all required information; if a test with same API name already exists in the org, overwrite it without confirmation. Use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --force-overwrite --target-org my-org",
|
|
2836
|
+
"Preview what the agent test metadata (AiEvaluationDefinition) looks like without deploying it to your default org:\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview",
|
|
2837
|
+
"Author an Agentforce Studio (NGT) test from an NGT-shaped YAML; writes an AiTestingDefinition metadata file:\n<%= config.bin %> <%= command.id %> --spec specs/ReturnsCheckout.ngt.yaml --api-name Returns_Checkout --test-runner agentforce-studio --target-org my-org"
|
|
2228
2838
|
],
|
|
2229
2839
|
"flags": {
|
|
2230
2840
|
"json": {
|
|
@@ -2242,78 +2852,70 @@
|
|
|
2242
2852
|
"multiple": false,
|
|
2243
2853
|
"type": "option"
|
|
2244
2854
|
},
|
|
2245
|
-
"
|
|
2246
|
-
"
|
|
2247
|
-
"
|
|
2248
|
-
"noCacheDefault": true,
|
|
2249
|
-
"required": true,
|
|
2250
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2251
|
-
"hasDynamicHelp": true,
|
|
2252
|
-
"multiple": false,
|
|
2253
|
-
"type": "option"
|
|
2254
|
-
},
|
|
2255
|
-
"api-version": {
|
|
2256
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2257
|
-
"name": "api-version",
|
|
2855
|
+
"api-name": {
|
|
2856
|
+
"name": "api-name",
|
|
2857
|
+
"summary": "API name of the new test; the API name must not exist in the org.",
|
|
2258
2858
|
"hasDynamicHelp": false,
|
|
2259
2859
|
"multiple": false,
|
|
2260
2860
|
"type": "option"
|
|
2261
2861
|
},
|
|
2262
2862
|
"spec": {
|
|
2263
|
-
"char": "s",
|
|
2264
2863
|
"name": "spec",
|
|
2265
|
-
"
|
|
2266
|
-
"summary": "Path to test spec file (YAML or JSON). Supports reading from stdin when piping content.",
|
|
2267
|
-
"hasDynamicHelp": false,
|
|
2268
|
-
"multiple": false,
|
|
2269
|
-
"type": "option"
|
|
2270
|
-
},
|
|
2271
|
-
"api-name": {
|
|
2272
|
-
"char": "n",
|
|
2273
|
-
"name": "api-name",
|
|
2274
|
-
"summary": "Agent API name (also called DeveloperName) used to resolve agent_id and agent_version_id. Auto-inferred from the YAML spec's subjectName.",
|
|
2864
|
+
"summary": "Path to the test spec YAML file.",
|
|
2275
2865
|
"hasDynamicHelp": false,
|
|
2276
2866
|
"multiple": false,
|
|
2277
2867
|
"type": "option"
|
|
2278
2868
|
},
|
|
2279
|
-
"
|
|
2280
|
-
"
|
|
2281
|
-
"
|
|
2282
|
-
"
|
|
2283
|
-
"
|
|
2869
|
+
"target-org": {
|
|
2870
|
+
"char": "o",
|
|
2871
|
+
"name": "target-org",
|
|
2872
|
+
"noCacheDefault": true,
|
|
2873
|
+
"required": true,
|
|
2874
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2875
|
+
"hasDynamicHelp": true,
|
|
2284
2876
|
"multiple": false,
|
|
2285
|
-
"options": [
|
|
2286
|
-
"json",
|
|
2287
|
-
"human",
|
|
2288
|
-
"junit",
|
|
2289
|
-
"tap"
|
|
2290
|
-
],
|
|
2291
2877
|
"type": "option"
|
|
2292
2878
|
},
|
|
2293
|
-
"
|
|
2294
|
-
"
|
|
2295
|
-
"
|
|
2296
|
-
"default": 5,
|
|
2879
|
+
"api-version": {
|
|
2880
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2881
|
+
"name": "api-version",
|
|
2297
2882
|
"hasDynamicHelp": false,
|
|
2298
2883
|
"multiple": false,
|
|
2299
2884
|
"type": "option"
|
|
2300
2885
|
},
|
|
2301
|
-
"
|
|
2302
|
-
"name": "
|
|
2303
|
-
"summary": "
|
|
2886
|
+
"preview": {
|
|
2887
|
+
"name": "preview",
|
|
2888
|
+
"summary": "Preview the test metadata file without deploying to your org.",
|
|
2889
|
+
"allowNo": false,
|
|
2890
|
+
"type": "boolean"
|
|
2891
|
+
},
|
|
2892
|
+
"force-overwrite": {
|
|
2893
|
+
"name": "force-overwrite",
|
|
2894
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test (based on API name) in your org.",
|
|
2304
2895
|
"allowNo": false,
|
|
2305
2896
|
"type": "boolean"
|
|
2897
|
+
},
|
|
2898
|
+
"test-runner": {
|
|
2899
|
+
"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.",
|
|
2900
|
+
"name": "test-runner",
|
|
2901
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2902
|
+
"hasDynamicHelp": false,
|
|
2903
|
+
"multiple": false,
|
|
2904
|
+
"options": [
|
|
2905
|
+
"agentforce-studio",
|
|
2906
|
+
"testing-center"
|
|
2907
|
+
],
|
|
2908
|
+
"type": "option"
|
|
2306
2909
|
}
|
|
2307
2910
|
},
|
|
2308
2911
|
"hasDynamicHelp": true,
|
|
2309
2912
|
"hiddenAliases": [],
|
|
2310
|
-
"id": "agent:test:
|
|
2913
|
+
"id": "agent:test:create",
|
|
2311
2914
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2312
2915
|
"pluginName": "@salesforce/plugin-agent",
|
|
2313
2916
|
"pluginType": "core",
|
|
2314
|
-
"state": "beta",
|
|
2315
2917
|
"strict": true,
|
|
2316
|
-
"summary": "
|
|
2918
|
+
"summary": "Create an agent test in your org using a local test spec YAML file.",
|
|
2317
2919
|
"enableJsonFlag": true,
|
|
2318
2920
|
"envVariablesSection": {
|
|
2319
2921
|
"header": "ENVIRONMENT VARIABLES",
|
|
@@ -2329,19 +2931,19 @@
|
|
|
2329
2931
|
"body": [
|
|
2330
2932
|
{
|
|
2331
2933
|
"name": "Succeeded (0)",
|
|
2332
|
-
"description": "
|
|
2934
|
+
"description": "Test created and deployed successfully."
|
|
2333
2935
|
},
|
|
2334
2936
|
{
|
|
2335
2937
|
"name": "Failed (1)",
|
|
2336
|
-
"description": "
|
|
2938
|
+
"description": "Test validation errors or metadata format issues."
|
|
2337
2939
|
},
|
|
2338
2940
|
{
|
|
2339
2941
|
"name": "NotFound (2)",
|
|
2340
|
-
"description": "
|
|
2942
|
+
"description": "Test spec file not found or org connection failed."
|
|
2341
2943
|
},
|
|
2342
2944
|
{
|
|
2343
|
-
"name": "
|
|
2344
|
-
"description": "
|
|
2945
|
+
"name": "DeploymentFailed (4)",
|
|
2946
|
+
"description": "Deployment failed due to API or network errors."
|
|
2345
2947
|
}
|
|
2346
2948
|
]
|
|
2347
2949
|
},
|
|
@@ -2351,26 +2953,25 @@
|
|
|
2351
2953
|
"commands",
|
|
2352
2954
|
"agent",
|
|
2353
2955
|
"test",
|
|
2354
|
-
"
|
|
2956
|
+
"create.js"
|
|
2355
2957
|
],
|
|
2356
2958
|
"aliasPermutations": [],
|
|
2357
2959
|
"permutations": [
|
|
2358
|
-
"agent:test:
|
|
2359
|
-
"test:agent:
|
|
2360
|
-
"test:
|
|
2361
|
-
"agent:
|
|
2362
|
-
"
|
|
2363
|
-
"
|
|
2960
|
+
"agent:test:create",
|
|
2961
|
+
"test:agent:create",
|
|
2962
|
+
"test:create:agent",
|
|
2963
|
+
"agent:create:test",
|
|
2964
|
+
"create:agent:test",
|
|
2965
|
+
"create:test:agent"
|
|
2364
2966
|
]
|
|
2365
2967
|
},
|
|
2366
|
-
"agent:test:
|
|
2968
|
+
"agent:test:list": {
|
|
2367
2969
|
"aliases": [],
|
|
2368
2970
|
"args": {},
|
|
2369
|
-
"description": "
|
|
2971
|
+
"description": "The command outputs a table with the name (API name) of each test along with its unique ID, type ('agentforce-studio' or 'testing-center'), and the date it was created in the org.",
|
|
2370
2972
|
"examples": [
|
|
2371
|
-
"
|
|
2372
|
-
"
|
|
2373
|
-
"Start an agent test and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --output-dir ./test-results --result-format json"
|
|
2973
|
+
"List the agent tests in your default org:\n<%= config.bin %> <%= command.id %>",
|
|
2974
|
+
"List the agent tests in an org with alias \"my-org\"\"\n<%= config.bin %> <%= command.id %> --target-org my-org"
|
|
2374
2975
|
],
|
|
2375
2976
|
"flags": {
|
|
2376
2977
|
"json": {
|
|
@@ -2404,74 +3005,16 @@
|
|
|
2404
3005
|
"hasDynamicHelp": false,
|
|
2405
3006
|
"multiple": false,
|
|
2406
3007
|
"type": "option"
|
|
2407
|
-
},
|
|
2408
|
-
"api-name": {
|
|
2409
|
-
"char": "n",
|
|
2410
|
-
"name": "api-name",
|
|
2411
|
-
"summary": "API name of the agent test to run; corresponds to the name of the AiEvaluationDefinition metadata component that implements the agent test.",
|
|
2412
|
-
"hasDynamicHelp": false,
|
|
2413
|
-
"multiple": false,
|
|
2414
|
-
"type": "option"
|
|
2415
|
-
},
|
|
2416
|
-
"wait": {
|
|
2417
|
-
"char": "w",
|
|
2418
|
-
"name": "wait",
|
|
2419
|
-
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
2420
|
-
"hasDynamicHelp": true,
|
|
2421
|
-
"multiple": false,
|
|
2422
|
-
"type": "option"
|
|
2423
|
-
},
|
|
2424
|
-
"result-format": {
|
|
2425
|
-
"name": "result-format",
|
|
2426
|
-
"summary": "Format of the agent test run results.",
|
|
2427
|
-
"default": "human",
|
|
2428
|
-
"hasDynamicHelp": false,
|
|
2429
|
-
"multiple": false,
|
|
2430
|
-
"options": [
|
|
2431
|
-
"json",
|
|
2432
|
-
"human",
|
|
2433
|
-
"junit",
|
|
2434
|
-
"tap"
|
|
2435
|
-
],
|
|
2436
|
-
"type": "option"
|
|
2437
|
-
},
|
|
2438
|
-
"output-dir": {
|
|
2439
|
-
"char": "d",
|
|
2440
|
-
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
2441
|
-
"name": "output-dir",
|
|
2442
|
-
"summary": "Directory to write the agent test results into.",
|
|
2443
|
-
"hasDynamicHelp": false,
|
|
2444
|
-
"multiple": false,
|
|
2445
|
-
"type": "option"
|
|
2446
|
-
},
|
|
2447
|
-
"test-runner": {
|
|
2448
|
-
"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.",
|
|
2449
|
-
"name": "test-runner",
|
|
2450
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2451
|
-
"hasDynamicHelp": false,
|
|
2452
|
-
"multiple": false,
|
|
2453
|
-
"options": [
|
|
2454
|
-
"agentforce-studio",
|
|
2455
|
-
"testing-center"
|
|
2456
|
-
],
|
|
2457
|
-
"type": "option"
|
|
2458
|
-
},
|
|
2459
|
-
"verbose": {
|
|
2460
|
-
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
2461
|
-
"name": "verbose",
|
|
2462
|
-
"summary": "Show generated data in the test results output.",
|
|
2463
|
-
"allowNo": false,
|
|
2464
|
-
"type": "boolean"
|
|
2465
3008
|
}
|
|
2466
3009
|
},
|
|
2467
3010
|
"hasDynamicHelp": true,
|
|
2468
3011
|
"hiddenAliases": [],
|
|
2469
|
-
"id": "agent:test:
|
|
3012
|
+
"id": "agent:test:list",
|
|
2470
3013
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2471
3014
|
"pluginName": "@salesforce/plugin-agent",
|
|
2472
3015
|
"pluginType": "core",
|
|
2473
3016
|
"strict": true,
|
|
2474
|
-
"summary": "
|
|
3017
|
+
"summary": "List the available agent tests in your org.",
|
|
2475
3018
|
"enableJsonFlag": true,
|
|
2476
3019
|
"envVariablesSection": {
|
|
2477
3020
|
"header": "ENVIRONMENT VARIABLES",
|
|
@@ -2487,19 +3030,11 @@
|
|
|
2487
3030
|
"body": [
|
|
2488
3031
|
{
|
|
2489
3032
|
"name": "Succeeded (0)",
|
|
2490
|
-
"description": "
|
|
2491
|
-
},
|
|
2492
|
-
{
|
|
2493
|
-
"name": "Failed (1)",
|
|
2494
|
-
"description": "Tests encountered execution errors (test cases with ERROR status when using --wait)."
|
|
2495
|
-
},
|
|
2496
|
-
{
|
|
2497
|
-
"name": "NotFound (2)",
|
|
2498
|
-
"description": "Test definition not found or invalid test name."
|
|
3033
|
+
"description": "Agent tests listed successfully."
|
|
2499
3034
|
},
|
|
2500
3035
|
{
|
|
2501
|
-
"name": "
|
|
2502
|
-
"description": "Failed to
|
|
3036
|
+
"name": "Failed (4)",
|
|
3037
|
+
"description": "Failed to retrieve agent tests due to API or network errors."
|
|
2503
3038
|
}
|
|
2504
3039
|
]
|
|
2505
3040
|
},
|
|
@@ -2509,28 +3044,26 @@
|
|
|
2509
3044
|
"commands",
|
|
2510
3045
|
"agent",
|
|
2511
3046
|
"test",
|
|
2512
|
-
"
|
|
3047
|
+
"list.js"
|
|
2513
3048
|
],
|
|
2514
3049
|
"aliasPermutations": [],
|
|
2515
3050
|
"permutations": [
|
|
2516
|
-
"agent:test:
|
|
2517
|
-
"test:agent:
|
|
2518
|
-
"test:
|
|
2519
|
-
"agent:
|
|
2520
|
-
"
|
|
2521
|
-
"
|
|
3051
|
+
"agent:test:list",
|
|
3052
|
+
"test:agent:list",
|
|
3053
|
+
"test:list:agent",
|
|
3054
|
+
"agent:list:test",
|
|
3055
|
+
"list:agent:test",
|
|
3056
|
+
"list:test:agent"
|
|
2522
3057
|
]
|
|
2523
3058
|
},
|
|
2524
|
-
"agent:
|
|
3059
|
+
"agent:test:results": {
|
|
2525
3060
|
"aliases": [],
|
|
2526
3061
|
"args": {},
|
|
2527
|
-
"description": "
|
|
3062
|
+
"description": "This command requires a job ID, which the original \"agent test run\" command displays when it completes. You can also use the --use-most-recent flag to see results for the most recently run agent test.\n\nBy default, this command outputs test results in human-readable tables for each test case. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
2528
3063
|
"examples": [
|
|
2529
|
-
"
|
|
2530
|
-
"
|
|
2531
|
-
"
|
|
2532
|
-
"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",
|
|
2533
|
-
"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>"
|
|
3064
|
+
"Get the results of an agent test run in your default org using its job ID:\n<%= config.bin %> <%= command.id %> --job-id 4KBfake0000003F4AQ",
|
|
3065
|
+
"Get the results of the most recently run agent test in an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-org",
|
|
3066
|
+
"Get the results of the most recently run agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
2534
3067
|
],
|
|
2535
3068
|
"flags": {
|
|
2536
3069
|
"json": {
|
|
@@ -2565,65 +3098,67 @@
|
|
|
2565
3098
|
"multiple": false,
|
|
2566
3099
|
"type": "option"
|
|
2567
3100
|
},
|
|
2568
|
-
"
|
|
2569
|
-
"
|
|
2570
|
-
|
|
2571
|
-
|
|
2572
|
-
"
|
|
2573
|
-
"required": false,
|
|
2574
|
-
"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.",
|
|
3101
|
+
"job-id": {
|
|
3102
|
+
"char": "i",
|
|
3103
|
+
"name": "job-id",
|
|
3104
|
+
"required": true,
|
|
3105
|
+
"summary": "Job ID of the completed agent test run.",
|
|
2575
3106
|
"hasDynamicHelp": false,
|
|
2576
3107
|
"multiple": false,
|
|
2577
3108
|
"type": "option"
|
|
2578
3109
|
},
|
|
2579
|
-
"
|
|
2580
|
-
"
|
|
2581
|
-
"
|
|
2582
|
-
|
|
2583
|
-
],
|
|
2584
|
-
"name": "api-name",
|
|
2585
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
3110
|
+
"result-format": {
|
|
3111
|
+
"name": "result-format",
|
|
3112
|
+
"summary": "Format of the agent test run results.",
|
|
3113
|
+
"default": "human",
|
|
2586
3114
|
"hasDynamicHelp": false,
|
|
2587
3115
|
"multiple": false,
|
|
3116
|
+
"options": [
|
|
3117
|
+
"json",
|
|
3118
|
+
"human",
|
|
3119
|
+
"junit",
|
|
3120
|
+
"tap"
|
|
3121
|
+
],
|
|
2588
3122
|
"type": "option"
|
|
2589
3123
|
},
|
|
2590
|
-
"
|
|
2591
|
-
"
|
|
2592
|
-
|
|
2593
|
-
|
|
2594
|
-
"
|
|
2595
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
3124
|
+
"output-dir": {
|
|
3125
|
+
"char": "d",
|
|
3126
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
3127
|
+
"name": "output-dir",
|
|
3128
|
+
"summary": "Directory to write the agent test results into.",
|
|
2596
3129
|
"hasDynamicHelp": false,
|
|
2597
3130
|
"multiple": false,
|
|
2598
3131
|
"type": "option"
|
|
2599
3132
|
},
|
|
2600
|
-
"
|
|
2601
|
-
"
|
|
2602
|
-
|
|
3133
|
+
"test-runner": {
|
|
3134
|
+
"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.",
|
|
3135
|
+
"name": "test-runner",
|
|
3136
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3137
|
+
"hasDynamicHelp": false,
|
|
3138
|
+
"multiple": false,
|
|
3139
|
+
"options": [
|
|
3140
|
+
"agentforce-studio",
|
|
3141
|
+
"testing-center"
|
|
2603
3142
|
],
|
|
2604
|
-
"
|
|
2605
|
-
"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.",
|
|
2606
|
-
"allowNo": false,
|
|
2607
|
-
"type": "boolean"
|
|
3143
|
+
"type": "option"
|
|
2608
3144
|
},
|
|
2609
|
-
"
|
|
2610
|
-
"
|
|
2611
|
-
"name": "
|
|
2612
|
-
"summary": "
|
|
3145
|
+
"verbose": {
|
|
3146
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3147
|
+
"name": "verbose",
|
|
3148
|
+
"summary": "Show generated data in the test results output.",
|
|
2613
3149
|
"allowNo": false,
|
|
2614
3150
|
"type": "boolean"
|
|
2615
3151
|
}
|
|
2616
3152
|
},
|
|
2617
3153
|
"hasDynamicHelp": true,
|
|
2618
3154
|
"hiddenAliases": [],
|
|
2619
|
-
"id": "agent:
|
|
3155
|
+
"id": "agent:test:results",
|
|
2620
3156
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2621
3157
|
"pluginName": "@salesforce/plugin-agent",
|
|
2622
3158
|
"pluginType": "core",
|
|
2623
3159
|
"strict": true,
|
|
2624
|
-
"summary": "
|
|
3160
|
+
"summary": "Get the results of a completed agent test run.",
|
|
2625
3161
|
"enableJsonFlag": true,
|
|
2626
|
-
"requiresProject": true,
|
|
2627
3162
|
"envVariablesSection": {
|
|
2628
3163
|
"header": "ENVIRONMENT VARIABLES",
|
|
2629
3164
|
"body": [
|
|
@@ -2633,32 +3168,20 @@
|
|
|
2633
3168
|
}
|
|
2634
3169
|
]
|
|
2635
3170
|
},
|
|
2636
|
-
"errorCodes": {
|
|
2637
|
-
"header": "ERROR CODES",
|
|
2638
|
-
"body": [
|
|
2639
|
-
{
|
|
2640
|
-
"name": "Succeeded (0)",
|
|
2641
|
-
"description": "Preview session ended successfully and traces saved."
|
|
2642
|
-
},
|
|
2643
|
-
{
|
|
2644
|
-
"name": "ExactlyOneRequired (2)",
|
|
2645
|
-
"description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
|
|
2646
|
-
},
|
|
2647
|
-
{
|
|
2648
|
-
"name": "NotFound (2)",
|
|
2649
|
-
"description": "Agent not found, or no preview session exists for this agent."
|
|
2650
|
-
},
|
|
3171
|
+
"errorCodes": {
|
|
3172
|
+
"header": "ERROR CODES",
|
|
3173
|
+
"body": [
|
|
2651
3174
|
{
|
|
2652
|
-
"name": "
|
|
2653
|
-
"description": "
|
|
3175
|
+
"name": "Succeeded (0)",
|
|
3176
|
+
"description": "Results retrieved successfully. Test results (passed/failed) are in the output."
|
|
2654
3177
|
},
|
|
2655
3178
|
{
|
|
2656
|
-
"name": "
|
|
2657
|
-
"description": "
|
|
3179
|
+
"name": "NotFound (2)",
|
|
3180
|
+
"description": "Job ID not found or invalid."
|
|
2658
3181
|
},
|
|
2659
3182
|
{
|
|
2660
|
-
"name": "
|
|
2661
|
-
"description": "
|
|
3183
|
+
"name": "Failed (4)",
|
|
3184
|
+
"description": "Failed to retrieve results due to API or network errors."
|
|
2662
3185
|
}
|
|
2663
3186
|
]
|
|
2664
3187
|
},
|
|
@@ -2667,27 +3190,27 @@
|
|
|
2667
3190
|
"lib",
|
|
2668
3191
|
"commands",
|
|
2669
3192
|
"agent",
|
|
2670
|
-
"
|
|
2671
|
-
"
|
|
3193
|
+
"test",
|
|
3194
|
+
"results.js"
|
|
2672
3195
|
],
|
|
2673
3196
|
"aliasPermutations": [],
|
|
2674
3197
|
"permutations": [
|
|
2675
|
-
"agent:
|
|
2676
|
-
"
|
|
2677
|
-
"
|
|
2678
|
-
"agent:
|
|
2679
|
-
"
|
|
2680
|
-
"
|
|
3198
|
+
"agent:test:results",
|
|
3199
|
+
"test:agent:results",
|
|
3200
|
+
"test:results:agent",
|
|
3201
|
+
"agent:results:test",
|
|
3202
|
+
"results:agent:test",
|
|
3203
|
+
"results:test:agent"
|
|
2681
3204
|
]
|
|
2682
3205
|
},
|
|
2683
|
-
"agent:
|
|
3206
|
+
"agent:test:resume": {
|
|
2684
3207
|
"aliases": [],
|
|
2685
3208
|
"args": {},
|
|
2686
|
-
"description": "
|
|
3209
|
+
"description": "This command requires a job ID, which the original \"agent test run\" command displays when it completes. You can also use the --use-most-recent flag to see results for the most recently run agent test.\n\nUse the --wait flag to specify the number of minutes for this command to wait for the agent test to complete; if the test completes by the end of the wait time, the command displays the test results. If not, the CLI returns control of the terminal to you, and you must run \"agent test resume\" again.\n\nBy default, this command outputs test results in human-readable tables for each test case. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
2687
3210
|
"examples": [
|
|
2688
|
-
"
|
|
2689
|
-
"
|
|
2690
|
-
"
|
|
3211
|
+
"Resume an agent test in your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 4KBfake0000003F4AQ",
|
|
3212
|
+
"Resume the most recently-run agent test in an org with alias \"my-org\" org; wait 10 minutes for the tests to finish:\n<%= config.bin %> <%= command.id %> --use-most-recent --wait 10 --target-org my-org",
|
|
3213
|
+
"Resume the most recent agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
2691
3214
|
],
|
|
2692
3215
|
"flags": {
|
|
2693
3216
|
"json": {
|
|
@@ -2722,49 +3245,82 @@
|
|
|
2722
3245
|
"multiple": false,
|
|
2723
3246
|
"type": "option"
|
|
2724
3247
|
},
|
|
2725
|
-
"
|
|
2726
|
-
"
|
|
2727
|
-
"
|
|
2728
|
-
"summary": "
|
|
3248
|
+
"job-id": {
|
|
3249
|
+
"char": "i",
|
|
3250
|
+
"name": "job-id",
|
|
3251
|
+
"summary": "Job ID of the original agent test run.",
|
|
2729
3252
|
"hasDynamicHelp": false,
|
|
2730
3253
|
"multiple": false,
|
|
2731
3254
|
"type": "option"
|
|
2732
3255
|
},
|
|
2733
|
-
"
|
|
2734
|
-
"char": "
|
|
2735
|
-
"name": "
|
|
2736
|
-
"
|
|
2737
|
-
"
|
|
3256
|
+
"use-most-recent": {
|
|
3257
|
+
"char": "r",
|
|
3258
|
+
"name": "use-most-recent",
|
|
3259
|
+
"summary": "Use the job ID of the most recent agent test run.",
|
|
3260
|
+
"allowNo": false,
|
|
3261
|
+
"type": "boolean"
|
|
3262
|
+
},
|
|
3263
|
+
"wait": {
|
|
3264
|
+
"char": "w",
|
|
3265
|
+
"name": "wait",
|
|
3266
|
+
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
3267
|
+
"default": "5 minutes",
|
|
3268
|
+
"hasDynamicHelp": true,
|
|
3269
|
+
"multiple": false,
|
|
3270
|
+
"type": "option"
|
|
3271
|
+
},
|
|
3272
|
+
"result-format": {
|
|
3273
|
+
"name": "result-format",
|
|
3274
|
+
"summary": "Format of the agent test run results.",
|
|
3275
|
+
"default": "human",
|
|
2738
3276
|
"hasDynamicHelp": false,
|
|
2739
3277
|
"multiple": false,
|
|
3278
|
+
"options": [
|
|
3279
|
+
"json",
|
|
3280
|
+
"human",
|
|
3281
|
+
"junit",
|
|
3282
|
+
"tap"
|
|
3283
|
+
],
|
|
2740
3284
|
"type": "option"
|
|
2741
3285
|
},
|
|
2742
|
-
"
|
|
2743
|
-
"char": "
|
|
2744
|
-
"
|
|
2745
|
-
"
|
|
3286
|
+
"output-dir": {
|
|
3287
|
+
"char": "d",
|
|
3288
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
3289
|
+
"name": "output-dir",
|
|
3290
|
+
"summary": "Directory to write the agent test results into.",
|
|
2746
3291
|
"hasDynamicHelp": false,
|
|
2747
3292
|
"multiple": false,
|
|
2748
3293
|
"type": "option"
|
|
2749
3294
|
},
|
|
2750
|
-
"
|
|
2751
|
-
"
|
|
2752
|
-
"
|
|
3295
|
+
"test-runner": {
|
|
3296
|
+
"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.",
|
|
3297
|
+
"name": "test-runner",
|
|
3298
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2753
3299
|
"hasDynamicHelp": false,
|
|
2754
3300
|
"multiple": false,
|
|
3301
|
+
"options": [
|
|
3302
|
+
"agentforce-studio",
|
|
3303
|
+
"testing-center"
|
|
3304
|
+
],
|
|
2755
3305
|
"type": "option"
|
|
3306
|
+
},
|
|
3307
|
+
"verbose": {
|
|
3308
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3309
|
+
"name": "verbose",
|
|
3310
|
+
"summary": "Show generated data in the test results output.",
|
|
3311
|
+
"allowNo": false,
|
|
3312
|
+
"type": "boolean"
|
|
2756
3313
|
}
|
|
2757
3314
|
},
|
|
2758
3315
|
"hasDynamicHelp": true,
|
|
2759
3316
|
"hiddenAliases": [],
|
|
2760
|
-
"id": "agent:
|
|
3317
|
+
"id": "agent:test:resume",
|
|
2761
3318
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2762
3319
|
"pluginName": "@salesforce/plugin-agent",
|
|
2763
3320
|
"pluginType": "core",
|
|
2764
3321
|
"strict": true,
|
|
2765
|
-
"summary": "
|
|
3322
|
+
"summary": "Resume an agent test that you previously started in your org so you can view the test results.",
|
|
2766
3323
|
"enableJsonFlag": true,
|
|
2767
|
-
"requiresProject": true,
|
|
2768
3324
|
"envVariablesSection": {
|
|
2769
3325
|
"header": "ENVIRONMENT VARIABLES",
|
|
2770
3326
|
"body": [
|
|
@@ -2779,19 +3335,19 @@
|
|
|
2779
3335
|
"body": [
|
|
2780
3336
|
{
|
|
2781
3337
|
"name": "Succeeded (0)",
|
|
2782
|
-
"description": "
|
|
3338
|
+
"description": "Test completed successfully (with test results in the output)."
|
|
2783
3339
|
},
|
|
2784
3340
|
{
|
|
2785
|
-
"name": "
|
|
2786
|
-
"description": "
|
|
3341
|
+
"name": "Failed (1)",
|
|
3342
|
+
"description": "Tests encountered execution errors (test cases with ERROR status)."
|
|
2787
3343
|
},
|
|
2788
3344
|
{
|
|
2789
|
-
"name": "
|
|
2790
|
-
"description": "
|
|
3345
|
+
"name": "NotFound (2)",
|
|
3346
|
+
"description": "Job ID not found or invalid."
|
|
2791
3347
|
},
|
|
2792
3348
|
{
|
|
2793
|
-
"name": "
|
|
2794
|
-
"description": "
|
|
3349
|
+
"name": "OperationFailed (4)",
|
|
3350
|
+
"description": "Failed to poll test due to API or network errors."
|
|
2795
3351
|
}
|
|
2796
3352
|
]
|
|
2797
3353
|
},
|
|
@@ -2800,25 +3356,30 @@
|
|
|
2800
3356
|
"lib",
|
|
2801
3357
|
"commands",
|
|
2802
3358
|
"agent",
|
|
2803
|
-
"
|
|
2804
|
-
"
|
|
3359
|
+
"test",
|
|
3360
|
+
"resume.js"
|
|
2805
3361
|
],
|
|
2806
3362
|
"aliasPermutations": [],
|
|
2807
3363
|
"permutations": [
|
|
2808
|
-
"agent:
|
|
2809
|
-
"
|
|
2810
|
-
"
|
|
2811
|
-
"agent:
|
|
2812
|
-
"
|
|
2813
|
-
"
|
|
3364
|
+
"agent:test:resume",
|
|
3365
|
+
"test:agent:resume",
|
|
3366
|
+
"test:resume:agent",
|
|
3367
|
+
"agent:resume:test",
|
|
3368
|
+
"resume:agent:test",
|
|
3369
|
+
"resume:test:agent"
|
|
2814
3370
|
]
|
|
2815
3371
|
},
|
|
2816
|
-
"agent:
|
|
3372
|
+
"agent:test:run-eval": {
|
|
2817
3373
|
"aliases": [],
|
|
2818
3374
|
"args": {},
|
|
2819
|
-
"description": "
|
|
3375
|
+
"description": "Specify the tests you want to run with one of these inputs to the --spec flag:\n\n- YAML test spec generated by the `agent generate test-spec` CLI command\n- JSON payload\n\nWhen you provide a YAML test spec, this command automatically translates test cases into internal state-based evaluation framework calls and infers the agent name from the test spec's `subjectName` field. As a result, you can use the same test spec with both the `agent test run` and `agent test run-eval` commands. YAML test specs also support context variables, which allow you to inject contextual data (such as CaseId or RoutableId) into agent sessions for testing with different contexts.\n\nWhen you provide a JSON payload, it's sent directly to the evaluation framework with optional normalization. The normalizer auto-corrects common field name mistakes, converts shorthand references to JSONPath, and injects defaults. Use `--no-normalize` to disable this auto-normalization. JSON payloads can also include context_variables on agent.create_session steps for the same contextual testing capabilities as when you use a YAML test spec.\n\nThis command supports more than 8 evaluator types, including subagent routing assertions, action invocation checks, string/numeric assertions, semantic similarity scoring, and LLM-based quality ratings.",
|
|
2820
3376
|
"examples": [
|
|
2821
|
-
"
|
|
3377
|
+
"Run tests using a YAML test spec on the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --spec specs/my-agent-testSpec.yaml --target-org my-org",
|
|
3378
|
+
"Run tests using a YAML spec with explicit agent name override; use your default org:\n<%= config.bin %> <%= command.id %> --spec specs/my-agent-testSpec.yaml --api-name My_Agent",
|
|
3379
|
+
"Run tests using a JSON payload:\n<%= config.bin %> <%= command.id %> --spec specs/eval-payload.json --target-org my-org",
|
|
3380
|
+
"Run tests and output results in JUnit format; useful for continuous integration and deployment (CI/CD):\n<%= config.bin %> <%= command.id %> --spec specs/my-agent-testSpec.yaml --target-org my-org --result-format junit",
|
|
3381
|
+
"Run tests with contextVariables to inject contextual data into agent sessions (add contextVariables to test cases in your YAML spec):\n<%= config.bin %> <%= command.id %> --spec specs/agent-with-context.yaml --target-org my-org",
|
|
3382
|
+
"Pipe JSON payload from stdin (--spec flag is automatically populated from stdin):\n$ echo '{\"tests\":[...]}' | <%= config.bin %> <%= command.id %> --spec --target-org my-org"
|
|
2822
3383
|
],
|
|
2823
3384
|
"flags": {
|
|
2824
3385
|
"json": {
|
|
@@ -2835,24 +3396,107 @@
|
|
|
2835
3396
|
"hasDynamicHelp": false,
|
|
2836
3397
|
"multiple": false,
|
|
2837
3398
|
"type": "option"
|
|
3399
|
+
},
|
|
3400
|
+
"target-org": {
|
|
3401
|
+
"char": "o",
|
|
3402
|
+
"name": "target-org",
|
|
3403
|
+
"noCacheDefault": true,
|
|
3404
|
+
"required": true,
|
|
3405
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3406
|
+
"hasDynamicHelp": true,
|
|
3407
|
+
"multiple": false,
|
|
3408
|
+
"type": "option"
|
|
3409
|
+
},
|
|
3410
|
+
"api-version": {
|
|
3411
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3412
|
+
"name": "api-version",
|
|
3413
|
+
"hasDynamicHelp": false,
|
|
3414
|
+
"multiple": false,
|
|
3415
|
+
"type": "option"
|
|
3416
|
+
},
|
|
3417
|
+
"spec": {
|
|
3418
|
+
"char": "s",
|
|
3419
|
+
"name": "spec",
|
|
3420
|
+
"required": true,
|
|
3421
|
+
"summary": "Path to test spec file (YAML or JSON). Supports reading from stdin when piping content.",
|
|
3422
|
+
"hasDynamicHelp": false,
|
|
3423
|
+
"multiple": false,
|
|
3424
|
+
"type": "option"
|
|
3425
|
+
},
|
|
3426
|
+
"api-name": {
|
|
3427
|
+
"char": "n",
|
|
3428
|
+
"name": "api-name",
|
|
3429
|
+
"summary": "Agent API name (also called DeveloperName) used to resolve agent_id and agent_version_id. Auto-inferred from the YAML spec's subjectName.",
|
|
3430
|
+
"hasDynamicHelp": false,
|
|
3431
|
+
"multiple": false,
|
|
3432
|
+
"type": "option"
|
|
3433
|
+
},
|
|
3434
|
+
"result-format": {
|
|
3435
|
+
"name": "result-format",
|
|
3436
|
+
"summary": "Format of the agent test run results.",
|
|
3437
|
+
"default": "human",
|
|
3438
|
+
"hasDynamicHelp": false,
|
|
3439
|
+
"multiple": false,
|
|
3440
|
+
"options": [
|
|
3441
|
+
"json",
|
|
3442
|
+
"human",
|
|
3443
|
+
"junit",
|
|
3444
|
+
"tap"
|
|
3445
|
+
],
|
|
3446
|
+
"type": "option"
|
|
3447
|
+
},
|
|
3448
|
+
"batch-size": {
|
|
3449
|
+
"name": "batch-size",
|
|
3450
|
+
"summary": "Number of tests per API request (max 5).",
|
|
3451
|
+
"default": 5,
|
|
3452
|
+
"hasDynamicHelp": false,
|
|
3453
|
+
"multiple": false,
|
|
3454
|
+
"type": "option"
|
|
3455
|
+
},
|
|
3456
|
+
"no-normalize": {
|
|
3457
|
+
"name": "no-normalize",
|
|
3458
|
+
"summary": "Disable auto-normalization of field names and shorthand references.",
|
|
3459
|
+
"allowNo": false,
|
|
3460
|
+
"type": "boolean"
|
|
2838
3461
|
}
|
|
2839
3462
|
},
|
|
2840
|
-
"hasDynamicHelp":
|
|
3463
|
+
"hasDynamicHelp": true,
|
|
2841
3464
|
"hiddenAliases": [],
|
|
2842
|
-
"id": "agent:
|
|
3465
|
+
"id": "agent:test:run-eval",
|
|
2843
3466
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2844
3467
|
"pluginName": "@salesforce/plugin-agent",
|
|
2845
3468
|
"pluginType": "core",
|
|
3469
|
+
"state": "beta",
|
|
2846
3470
|
"strict": true,
|
|
2847
|
-
"summary": "
|
|
3471
|
+
"summary": "Run rich evaluation tests against an Agentforce agent.",
|
|
2848
3472
|
"enableJsonFlag": true,
|
|
2849
|
-
"
|
|
3473
|
+
"envVariablesSection": {
|
|
3474
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
3475
|
+
"body": [
|
|
3476
|
+
{
|
|
3477
|
+
"name": "SF_TARGET_ORG",
|
|
3478
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3479
|
+
}
|
|
3480
|
+
]
|
|
3481
|
+
},
|
|
2850
3482
|
"errorCodes": {
|
|
2851
3483
|
"header": "ERROR CODES",
|
|
2852
3484
|
"body": [
|
|
2853
3485
|
{
|
|
2854
3486
|
"name": "Succeeded (0)",
|
|
2855
|
-
"description": "
|
|
3487
|
+
"description": "Tests completed successfully. Test results (passed/failed) are in the JSON output."
|
|
3488
|
+
},
|
|
3489
|
+
{
|
|
3490
|
+
"name": "Failed (1)",
|
|
3491
|
+
"description": "Tests encountered execution errors (tests couldn't run properly)."
|
|
3492
|
+
},
|
|
3493
|
+
{
|
|
3494
|
+
"name": "NotFound (2)",
|
|
3495
|
+
"description": "Agent not found, spec file not found, or invalid agent name."
|
|
3496
|
+
},
|
|
3497
|
+
{
|
|
3498
|
+
"name": "OperationFailed (4)",
|
|
3499
|
+
"description": "Failed to execute tests due to API or network errors."
|
|
2856
3500
|
}
|
|
2857
3501
|
]
|
|
2858
3502
|
},
|
|
@@ -2861,27 +3505,27 @@
|
|
|
2861
3505
|
"lib",
|
|
2862
3506
|
"commands",
|
|
2863
3507
|
"agent",
|
|
2864
|
-
"
|
|
2865
|
-
"
|
|
3508
|
+
"test",
|
|
3509
|
+
"run-eval.js"
|
|
2866
3510
|
],
|
|
2867
3511
|
"aliasPermutations": [],
|
|
2868
3512
|
"permutations": [
|
|
2869
|
-
"agent:
|
|
2870
|
-
"
|
|
2871
|
-
"
|
|
2872
|
-
"agent:
|
|
2873
|
-
"
|
|
2874
|
-
"
|
|
3513
|
+
"agent:test:run-eval",
|
|
3514
|
+
"test:agent:run-eval",
|
|
3515
|
+
"test:run-eval:agent",
|
|
3516
|
+
"agent:run-eval:test",
|
|
3517
|
+
"run-eval:agent:test",
|
|
3518
|
+
"run-eval:test:agent"
|
|
2875
3519
|
]
|
|
2876
3520
|
},
|
|
2877
|
-
"agent:
|
|
3521
|
+
"agent:test:run": {
|
|
2878
3522
|
"aliases": [],
|
|
2879
3523
|
"args": {},
|
|
2880
|
-
"description": "
|
|
3524
|
+
"description": "Use the --api-name flag to specify the name of the agent test you want to run. Use the output of the \"agent test list\" command to get the names of all the available agent tests in your org.\n\nBy default, this command starts the agent test in your org, but it doesn't wait for the test to finish. Instead, it displays the \"agent test resume\" command, with a job ID, that you execute to see the results of the test run, and then returns control of the terminal window to you. Use the --wait flag to specify the number of minutes for the command to wait for the agent test to complete; if the test completes by the end of the wait time, the command displays the test results. If not, run \"agent test resume\".\n\nBy default, this command outputs test results in human-readable tables for each test case, if the test completes in time. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
2881
3525
|
"examples": [
|
|
2882
|
-
"Start
|
|
2883
|
-
"
|
|
2884
|
-
"Start
|
|
3526
|
+
"Start an agent test called Resort_Manager_Test for an agent in your default org, don't wait for the test to finish:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test",
|
|
3527
|
+
"Start an agent test for an agent in an org with alias \"my-org\" and wait for 10 minutes for the test to finish:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --target-org my-org",
|
|
3528
|
+
"Start an agent test and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --output-dir ./test-results --result-format json"
|
|
2885
3529
|
],
|
|
2886
3530
|
"flags": {
|
|
2887
3531
|
"json": {
|
|
@@ -2919,58 +3563,71 @@
|
|
|
2919
3563
|
"api-name": {
|
|
2920
3564
|
"char": "n",
|
|
2921
3565
|
"name": "api-name",
|
|
2922
|
-
"summary": "API name of the
|
|
3566
|
+
"summary": "API name of the agent test to run; corresponds to the name of the AiEvaluationDefinition metadata component that implements the agent test.",
|
|
2923
3567
|
"hasDynamicHelp": false,
|
|
2924
3568
|
"multiple": false,
|
|
2925
3569
|
"type": "option"
|
|
2926
3570
|
},
|
|
2927
|
-
"
|
|
2928
|
-
"
|
|
2929
|
-
"
|
|
2930
|
-
"
|
|
3571
|
+
"wait": {
|
|
3572
|
+
"char": "w",
|
|
3573
|
+
"name": "wait",
|
|
3574
|
+
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
3575
|
+
"hasDynamicHelp": true,
|
|
2931
3576
|
"multiple": false,
|
|
2932
3577
|
"type": "option"
|
|
2933
3578
|
},
|
|
2934
|
-
"
|
|
2935
|
-
"
|
|
2936
|
-
|
|
3579
|
+
"result-format": {
|
|
3580
|
+
"name": "result-format",
|
|
3581
|
+
"summary": "Format of the agent test run results.",
|
|
3582
|
+
"default": "human",
|
|
3583
|
+
"hasDynamicHelp": false,
|
|
3584
|
+
"multiple": false,
|
|
3585
|
+
"options": [
|
|
3586
|
+
"json",
|
|
3587
|
+
"human",
|
|
3588
|
+
"junit",
|
|
3589
|
+
"tap"
|
|
2937
3590
|
],
|
|
2938
|
-
"
|
|
2939
|
-
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
2940
|
-
"allowNo": false,
|
|
2941
|
-
"type": "boolean"
|
|
3591
|
+
"type": "option"
|
|
2942
3592
|
},
|
|
2943
|
-
"
|
|
2944
|
-
"
|
|
2945
|
-
|
|
2946
|
-
|
|
2947
|
-
"
|
|
2948
|
-
"
|
|
2949
|
-
"
|
|
2950
|
-
"type": "
|
|
3593
|
+
"output-dir": {
|
|
3594
|
+
"char": "d",
|
|
3595
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
3596
|
+
"name": "output-dir",
|
|
3597
|
+
"summary": "Directory to write the agent test results into.",
|
|
3598
|
+
"hasDynamicHelp": false,
|
|
3599
|
+
"multiple": false,
|
|
3600
|
+
"type": "option"
|
|
2951
3601
|
},
|
|
2952
|
-
"
|
|
2953
|
-
"
|
|
2954
|
-
|
|
2955
|
-
|
|
2956
|
-
"hidden": true,
|
|
2957
|
-
"name": "agent-json",
|
|
2958
|
-
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
3602
|
+
"test-runner": {
|
|
3603
|
+
"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.",
|
|
3604
|
+
"name": "test-runner",
|
|
3605
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2959
3606
|
"hasDynamicHelp": false,
|
|
2960
3607
|
"multiple": false,
|
|
3608
|
+
"options": [
|
|
3609
|
+
"agentforce-studio",
|
|
3610
|
+
"testing-center"
|
|
3611
|
+
],
|
|
2961
3612
|
"type": "option"
|
|
3613
|
+
},
|
|
3614
|
+
"verbose": {
|
|
3615
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3616
|
+
"name": "verbose",
|
|
3617
|
+
"summary": "Show generated data in the test results output.",
|
|
3618
|
+
"allowNo": false,
|
|
3619
|
+
"type": "boolean"
|
|
2962
3620
|
}
|
|
2963
3621
|
},
|
|
2964
3622
|
"hasDynamicHelp": true,
|
|
2965
3623
|
"hiddenAliases": [],
|
|
2966
|
-
"id": "agent:
|
|
3624
|
+
"id": "agent:test:run",
|
|
2967
3625
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2968
3626
|
"pluginName": "@salesforce/plugin-agent",
|
|
2969
3627
|
"pluginType": "core",
|
|
2970
3628
|
"strict": true,
|
|
2971
|
-
"summary": "Start
|
|
3629
|
+
"summary": "Start an agent test in your org.",
|
|
2972
3630
|
"enableJsonFlag": true,
|
|
2973
|
-
"requiresProject": true,
|
|
2974
3631
|
"envVariablesSection": {
|
|
2975
3632
|
"header": "ENVIRONMENT VARIABLES",
|
|
2976
3633
|
"body": [
|
|
@@ -2985,23 +3642,19 @@
|
|
|
2985
3642
|
"body": [
|
|
2986
3643
|
{
|
|
2987
3644
|
"name": "Succeeded (0)",
|
|
2988
|
-
"description": "
|
|
3645
|
+
"description": "Test started successfully (without --wait), or test completed successfully (with --wait)."
|
|
2989
3646
|
},
|
|
2990
3647
|
{
|
|
2991
3648
|
"name": "Failed (1)",
|
|
2992
|
-
"description": "
|
|
3649
|
+
"description": "Tests encountered execution errors (test cases with ERROR status when using --wait)."
|
|
2993
3650
|
},
|
|
2994
3651
|
{
|
|
2995
3652
|
"name": "NotFound (2)",
|
|
2996
|
-
"description": "
|
|
2997
|
-
},
|
|
2998
|
-
{
|
|
2999
|
-
"name": "ServerError (3)",
|
|
3000
|
-
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
3653
|
+
"description": "Test definition not found or invalid test name."
|
|
3001
3654
|
},
|
|
3002
3655
|
{
|
|
3003
|
-
"name": "
|
|
3004
|
-
"description": "
|
|
3656
|
+
"name": "OperationFailed (4)",
|
|
3657
|
+
"description": "Failed to start or poll test due to API or network errors."
|
|
3005
3658
|
}
|
|
3006
3659
|
]
|
|
3007
3660
|
},
|
|
@@ -3010,17 +3663,17 @@
|
|
|
3010
3663
|
"lib",
|
|
3011
3664
|
"commands",
|
|
3012
3665
|
"agent",
|
|
3013
|
-
"
|
|
3014
|
-
"
|
|
3666
|
+
"test",
|
|
3667
|
+
"run.js"
|
|
3015
3668
|
],
|
|
3016
3669
|
"aliasPermutations": [],
|
|
3017
3670
|
"permutations": [
|
|
3018
|
-
"agent:
|
|
3019
|
-
"
|
|
3020
|
-
"
|
|
3021
|
-
"agent:
|
|
3022
|
-
"
|
|
3023
|
-
"
|
|
3671
|
+
"agent:test:run",
|
|
3672
|
+
"test:agent:run",
|
|
3673
|
+
"test:run:agent",
|
|
3674
|
+
"agent:run:test",
|
|
3675
|
+
"run:agent:test",
|
|
3676
|
+
"run:test:agent"
|
|
3024
3677
|
]
|
|
3025
3678
|
},
|
|
3026
3679
|
"agent:trace:delete": {
|
|
@@ -3733,7 +4386,224 @@
|
|
|
3733
4386
|
"list:file:agent:adl",
|
|
3734
4387
|
"list:file:adl:agent"
|
|
3735
4388
|
]
|
|
4389
|
+
},
|
|
4390
|
+
"agent:mcp:asset:list": {
|
|
4391
|
+
"aliases": [],
|
|
4392
|
+
"args": {},
|
|
4393
|
+
"description": "Returns the assets discovered for the specified MCP server, including each asset's kind (MCP_TOOL, MCP_PROMPT, or MCP_RESOURCE), whether it is active, and whether it is available as an agent action.",
|
|
4394
|
+
"examples": [
|
|
4395
|
+
"List the assets for an MCP server in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001",
|
|
4396
|
+
"List the assets for an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
4397
|
+
],
|
|
4398
|
+
"flags": {
|
|
4399
|
+
"json": {
|
|
4400
|
+
"description": "Format output as json.",
|
|
4401
|
+
"helpGroup": "GLOBAL",
|
|
4402
|
+
"name": "json",
|
|
4403
|
+
"allowNo": false,
|
|
4404
|
+
"type": "boolean"
|
|
4405
|
+
},
|
|
4406
|
+
"flags-dir": {
|
|
4407
|
+
"helpGroup": "GLOBAL",
|
|
4408
|
+
"name": "flags-dir",
|
|
4409
|
+
"summary": "Import flag values from a directory.",
|
|
4410
|
+
"hasDynamicHelp": false,
|
|
4411
|
+
"multiple": false,
|
|
4412
|
+
"type": "option"
|
|
4413
|
+
},
|
|
4414
|
+
"target-org": {
|
|
4415
|
+
"char": "o",
|
|
4416
|
+
"name": "target-org",
|
|
4417
|
+
"noCacheDefault": true,
|
|
4418
|
+
"required": true,
|
|
4419
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
4420
|
+
"hasDynamicHelp": true,
|
|
4421
|
+
"multiple": false,
|
|
4422
|
+
"type": "option"
|
|
4423
|
+
},
|
|
4424
|
+
"api-version": {
|
|
4425
|
+
"description": "Override the api version used for api requests made by this command",
|
|
4426
|
+
"name": "api-version",
|
|
4427
|
+
"hasDynamicHelp": false,
|
|
4428
|
+
"multiple": false,
|
|
4429
|
+
"type": "option"
|
|
4430
|
+
},
|
|
4431
|
+
"mcp-server-id": {
|
|
4432
|
+
"char": "i",
|
|
4433
|
+
"name": "mcp-server-id",
|
|
4434
|
+
"required": true,
|
|
4435
|
+
"summary": "The ID of the MCP server whose assets you want to list.",
|
|
4436
|
+
"hasDynamicHelp": false,
|
|
4437
|
+
"multiple": false,
|
|
4438
|
+
"type": "option"
|
|
4439
|
+
}
|
|
4440
|
+
},
|
|
4441
|
+
"hasDynamicHelp": true,
|
|
4442
|
+
"hiddenAliases": [],
|
|
4443
|
+
"id": "agent:mcp:asset:list",
|
|
4444
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
4445
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
4446
|
+
"pluginType": "core",
|
|
4447
|
+
"state": "preview",
|
|
4448
|
+
"strict": true,
|
|
4449
|
+
"summary": "List the assets (tools, prompts, and resources) for an MCP server in the catalog.",
|
|
4450
|
+
"enableJsonFlag": true,
|
|
4451
|
+
"isESM": true,
|
|
4452
|
+
"relativePath": [
|
|
4453
|
+
"lib",
|
|
4454
|
+
"commands",
|
|
4455
|
+
"agent",
|
|
4456
|
+
"mcp",
|
|
4457
|
+
"asset",
|
|
4458
|
+
"list.js"
|
|
4459
|
+
],
|
|
4460
|
+
"aliasPermutations": [],
|
|
4461
|
+
"permutations": [
|
|
4462
|
+
"agent:mcp:asset:list",
|
|
4463
|
+
"mcp:agent:asset:list",
|
|
4464
|
+
"mcp:asset:agent:list",
|
|
4465
|
+
"mcp:asset:list:agent",
|
|
4466
|
+
"agent:asset:mcp:list",
|
|
4467
|
+
"asset:agent:mcp:list",
|
|
4468
|
+
"asset:mcp:agent:list",
|
|
4469
|
+
"asset:mcp:list:agent",
|
|
4470
|
+
"agent:asset:list:mcp",
|
|
4471
|
+
"asset:agent:list:mcp",
|
|
4472
|
+
"asset:list:agent:mcp",
|
|
4473
|
+
"asset:list:mcp:agent",
|
|
4474
|
+
"agent:mcp:list:asset",
|
|
4475
|
+
"mcp:agent:list:asset",
|
|
4476
|
+
"mcp:list:agent:asset",
|
|
4477
|
+
"mcp:list:asset:agent",
|
|
4478
|
+
"agent:list:mcp:asset",
|
|
4479
|
+
"list:agent:mcp:asset",
|
|
4480
|
+
"list:mcp:agent:asset",
|
|
4481
|
+
"list:mcp:asset:agent",
|
|
4482
|
+
"agent:list:asset:mcp",
|
|
4483
|
+
"list:agent:asset:mcp",
|
|
4484
|
+
"list:asset:agent:mcp",
|
|
4485
|
+
"list:asset:mcp:agent"
|
|
4486
|
+
]
|
|
4487
|
+
},
|
|
4488
|
+
"agent:mcp:asset:replace": {
|
|
4489
|
+
"aliases": [],
|
|
4490
|
+
"args": {},
|
|
4491
|
+
"description": "Replaces the full set of assets (tools, prompts, resources) for an MCP server with the asset items you supply. Provide the assets either inline with `--assets` (a JSON string, or `-` to read from stdin) or from a file with `--assets-file`. The JSON must be either an array of asset items or an object of the form `{ \"assets\": [...] }`. Each asset item may include `id`, `name`, `label`, `description`, `active`, and `kind`. This is a full replacement: existing assets not present in the supplied set are removed, so provide the complete desired asset set (read the current set first with `agent mcp asset list` or `agent mcp fetch`).",
|
|
4492
|
+
"examples": [
|
|
4493
|
+
"Replace the assets inline with a JSON string:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --assets '{\"assets\":[{\"name\":\"McpTool__add\",\"active\":true}]}' --target-org myOrg",
|
|
4494
|
+
"Replace the assets from a JSON file:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --assets-file ./assets.json --target-org myOrg",
|
|
4495
|
+
"Pipe the assets from stdin:\ncat assets.json | <%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --assets - --target-org myOrg"
|
|
4496
|
+
],
|
|
4497
|
+
"flags": {
|
|
4498
|
+
"json": {
|
|
4499
|
+
"description": "Format output as json.",
|
|
4500
|
+
"helpGroup": "GLOBAL",
|
|
4501
|
+
"name": "json",
|
|
4502
|
+
"allowNo": false,
|
|
4503
|
+
"type": "boolean"
|
|
4504
|
+
},
|
|
4505
|
+
"flags-dir": {
|
|
4506
|
+
"helpGroup": "GLOBAL",
|
|
4507
|
+
"name": "flags-dir",
|
|
4508
|
+
"summary": "Import flag values from a directory.",
|
|
4509
|
+
"hasDynamicHelp": false,
|
|
4510
|
+
"multiple": false,
|
|
4511
|
+
"type": "option"
|
|
4512
|
+
},
|
|
4513
|
+
"target-org": {
|
|
4514
|
+
"char": "o",
|
|
4515
|
+
"name": "target-org",
|
|
4516
|
+
"noCacheDefault": true,
|
|
4517
|
+
"required": true,
|
|
4518
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
4519
|
+
"hasDynamicHelp": true,
|
|
4520
|
+
"multiple": false,
|
|
4521
|
+
"type": "option"
|
|
4522
|
+
},
|
|
4523
|
+
"api-version": {
|
|
4524
|
+
"description": "Override the api version used for api requests made by this command",
|
|
4525
|
+
"name": "api-version",
|
|
4526
|
+
"hasDynamicHelp": false,
|
|
4527
|
+
"multiple": false,
|
|
4528
|
+
"type": "option"
|
|
4529
|
+
},
|
|
4530
|
+
"mcp-server-id": {
|
|
4531
|
+
"char": "i",
|
|
4532
|
+
"name": "mcp-server-id",
|
|
4533
|
+
"required": true,
|
|
4534
|
+
"summary": "ID of the MCP server whose assets you want to replace.",
|
|
4535
|
+
"hasDynamicHelp": false,
|
|
4536
|
+
"multiple": false,
|
|
4537
|
+
"type": "option"
|
|
4538
|
+
},
|
|
4539
|
+
"assets": {
|
|
4540
|
+
"exclusive": [
|
|
4541
|
+
"assets-file"
|
|
4542
|
+
],
|
|
4543
|
+
"name": "assets",
|
|
4544
|
+
"summary": "The desired asset allowlist as a JSON string (or \"-\" to read from stdin). Mutually exclusive with --assets-file.",
|
|
4545
|
+
"hasDynamicHelp": false,
|
|
4546
|
+
"multiple": false,
|
|
4547
|
+
"type": "option"
|
|
4548
|
+
},
|
|
4549
|
+
"assets-file": {
|
|
4550
|
+
"exclusive": [
|
|
4551
|
+
"assets"
|
|
4552
|
+
],
|
|
4553
|
+
"name": "assets-file",
|
|
4554
|
+
"summary": "Path to a JSON file containing the desired asset allowlist. Mutually exclusive with --assets.",
|
|
4555
|
+
"hasDynamicHelp": false,
|
|
4556
|
+
"multiple": false,
|
|
4557
|
+
"type": "option"
|
|
4558
|
+
}
|
|
4559
|
+
},
|
|
4560
|
+
"hasDynamicHelp": true,
|
|
4561
|
+
"hiddenAliases": [],
|
|
4562
|
+
"id": "agent:mcp:asset:replace",
|
|
4563
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
4564
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
4565
|
+
"pluginType": "core",
|
|
4566
|
+
"state": "preview",
|
|
4567
|
+
"strict": true,
|
|
4568
|
+
"summary": "Replace the asset set of an MCP server in the API Catalog.",
|
|
4569
|
+
"enableJsonFlag": true,
|
|
4570
|
+
"isESM": true,
|
|
4571
|
+
"relativePath": [
|
|
4572
|
+
"lib",
|
|
4573
|
+
"commands",
|
|
4574
|
+
"agent",
|
|
4575
|
+
"mcp",
|
|
4576
|
+
"asset",
|
|
4577
|
+
"replace.js"
|
|
4578
|
+
],
|
|
4579
|
+
"aliasPermutations": [],
|
|
4580
|
+
"permutations": [
|
|
4581
|
+
"agent:mcp:asset:replace",
|
|
4582
|
+
"mcp:agent:asset:replace",
|
|
4583
|
+
"mcp:asset:agent:replace",
|
|
4584
|
+
"mcp:asset:replace:agent",
|
|
4585
|
+
"agent:asset:mcp:replace",
|
|
4586
|
+
"asset:agent:mcp:replace",
|
|
4587
|
+
"asset:mcp:agent:replace",
|
|
4588
|
+
"asset:mcp:replace:agent",
|
|
4589
|
+
"agent:asset:replace:mcp",
|
|
4590
|
+
"asset:agent:replace:mcp",
|
|
4591
|
+
"asset:replace:agent:mcp",
|
|
4592
|
+
"asset:replace:mcp:agent",
|
|
4593
|
+
"agent:mcp:replace:asset",
|
|
4594
|
+
"mcp:agent:replace:asset",
|
|
4595
|
+
"mcp:replace:agent:asset",
|
|
4596
|
+
"mcp:replace:asset:agent",
|
|
4597
|
+
"agent:replace:mcp:asset",
|
|
4598
|
+
"replace:agent:mcp:asset",
|
|
4599
|
+
"replace:mcp:agent:asset",
|
|
4600
|
+
"replace:mcp:asset:agent",
|
|
4601
|
+
"agent:replace:asset:mcp",
|
|
4602
|
+
"replace:agent:asset:mcp",
|
|
4603
|
+
"replace:asset:agent:mcp",
|
|
4604
|
+
"replace:asset:mcp:agent"
|
|
4605
|
+
]
|
|
3736
4606
|
}
|
|
3737
4607
|
},
|
|
3738
|
-
"version": "1.
|
|
4608
|
+
"version": "1.43.0"
|
|
3739
4609
|
}
|