@salesforce/plugin-agent 1.24.14-nga.0 → 1.24.14-nga.2

package/oclif.manifest.json

@@ -75,7 +75,7 @@
     "agent:create": {
       "aliases": [],
       "args": {},
-      "description": "To run this command, you must have an agent spec file, which is a YAML file that define the agent properties and contains a list of AI-generated topics. Topics define the range of jobs the agent can handle. Use the \"agent generate agent-spec\" CLI command to generate an agent spec file. Then specify the file to this command using the --spec flag, along with the name (label) of the new agent with the --name flag. If you don't specify any of the required flags, the command prompts you.\n\nWhen this command completes, your org contains the new agent, which you can then edit and customize in the Agent Builder UI. The new agent's topics are the same as the ones listed in the agent spec file. The agent might also have some AI-generated actions, or you can add them. This command also retrieves all the metadata files associated with the new agent to your local Salesforce DX project.\n\nUse the --preview flag to review what the agent looks like without actually saving it in your org. When previewing, the command creates a JSON file in the current directory with all the agent details. The name of the JSON file is the agent's API name and a timestamp.\n\nTo open the new agent in your org's Agent Builder UI, run this command: \"sf org open agent --api-name <api-name>\".",
+      "description": "NOTE: This command creates an agent that doesn't use Agent Script as its blueprint. We generally don't recommend you use this workflow to create an agent. Rather, use the \"agent generate|validate|publish authoring-bundle\" commands to author agents that use the Agent Script language. See \"Author an Agent\" (https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-nga-author-agent.html) for details.\n\nTo run this command, you must have an agent spec file, which is a YAML file that define the agent properties and contains a list of AI-generated topics. Topics define the range of jobs the agent can handle. Use the \"agent generate agent-spec\" CLI command to generate an agent spec file. Then specify the file to this command using the --spec flag, along with the name (label) of the new agent with the --name flag. If you don't specify any of the required flags, the command prompts you.\n\nWhen this command completes, your org contains the new agent, which you can then edit and customize in the Agent Builder UI. The new agent's topics are the same as the ones listed in the agent spec file. The agent might also have some AI-generated actions, or you can add them. This command also retrieves all the metadata files associated with the new agent to your local Salesforce DX project.\n\nUse the --preview flag to review what the agent looks like without actually saving it in your org. When previewing, the command creates a JSON file in the current directory with all the agent details. The name of the JSON file is the agent's API name and a timestamp.\n\nTo open the new agent in your org's Agent Builder UI, run this command: \"sf org open agent --api-name <api-name>\".",
       "examples": [
         "Create an agent by being prompted for the required information, such as the agent spec file and agent name, and then create it in your default org:\n<%= config.bin %> <%= command.id %>",
         "Create an agent by specifying the agent name, API name, and spec file with flags; use the org with alias \"my-org\"; the command fails if the API name is already being used in your org:\n<%= config.bin %> <%= command.id %> --name \"Resort Manager\" --api-name Resort_Manager --spec specs/resortManagerAgent.yaml --target-org my-org",
@@ -353,7 +353,7 @@
     "agent:generate:agent-spec": {
       "aliases": [],
       "args": {},
-      "description": "The first step in creating an agent in your org with Salesforce CLI is to generate an agent spec using this command. An agent spec is a YAML-formatted file that contains information about the agent, such as its role and company description, and then 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, you then create the agent in your org by running the \"agent create\" CLI command and specifying the spec with the --spec flag.",
+      "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.)",
       "examples": [
         "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.\"",
         "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",
@@ -546,10 +546,10 @@
     "agent:generate:authoring-bundle": {
       "aliases": [],
       "args": {},
-      "description": "Authoring bundles are metadata types that represent the next-gen Salesforce agents. Their exact metadata name is AiAuthoringBundle and they consist of a standard \"\\*-meta.xml\" metadata file and an agent file (with extension \".agent\") that fully describes the next-gen agent. Use this command to generate an authoring bundle based on an agent spec YAML file, which you create with the \"agent create agent-spec\" command.\n\nBy default, authoring bundles are generated in the force-app/main/default/aiAuthoringBundles/<api-name> directory. Use the --output-dir to generate them elsewhere.",
+      "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.\n\nThe metadata type for authoring bundles is aiAuthoringBundle, which consist of a standard \"<bundle-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-name> directory. Use the --output-dir flag to generate them elsewhere.\n\nAfter you generate the initial authoring bundle, vibe code (modify using natural language) the Agent Script file so your agent behaves exactly as you want. The generated Agent Script file is just a first draft of your agent! 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.",
       "examples": [
-        "Generate an authoring bundle from the \"specs/agentSpec.yaml\" agent spec YAML file and give it the label \"My Authoring Bundle\":\n<%= config.bin %> <%= command.id %> --spec-file specs/agentSpec.yaml --name \"My Authoring Bundle\"",
-        "Same as previous example, but generate the files in the other-package-dir/main/default/aiAuthoringBundles directory:\n<%= config.bin %> <%= command.id %> --spec-file specs/agentSpec.yaml --name \"My Authoring Bundle\" --output-dir other-package-dir/main/default/aiAuthoringBundles"
+        "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\"",
+        "Same as previous example, but generate the 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"
       ],
       "flags": {
         "json": {
@@ -622,8 +622,9 @@
       "pluginAlias": "@salesforce/plugin-agent",
       "pluginName": "@salesforce/plugin-agent",
       "pluginType": "core",
+      "state": "beta",
       "strict": true,
-      "summary": "Generate a local authoring bundle from an existing agent spec YAML file.",
+      "summary": "Generate an authoring bundle from an existing agent spec YAML file.",
       "enableJsonFlag": true,
       "requiresProject": true,
       "FLAGGABLE_PROMPTS": {
@@ -805,9 +806,9 @@
     "agent:publish:authoring-bundle": {
       "aliases": [],
       "args": {},
-      "description": "When you publish an authoring bundle to your org, a number of things happen. First, this command validates that the agent file (with extension \".agent\") successfully compiles. Then the authoring bundle metadata component is deployed to the org, and all associated metadata components, such as the Bot, BotVersion, and GenAiXXX components, are either created or updated. The org then creates a new next-gen agent based on the deployed authoring bundle and associated metadata. Finally, all the metadata associated with the new agent is retrieved back to your local DX project.\n\nAuthoring bundles are metadata types that represent the next-gen Salesforce agents. Their exact metadata name is AiAuthoringBundle and they consist of a standard \"\\*-meta.xml\" metadata file and an agent file (with extension \".agent\") that fully describes the next-gen agent.\n\nThis command requires the API name of the authoring bundle; if you don't provide it with the --api-name flag, the command prompts you for it.",
+      "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 the authoring bundle metadata component is deployed to the org, and all associated agent metadata components, such as the Bot, BotVersion, and GenAiXXX components, are either created or updated. The org then either creates a new agent based on the deployed authoring bundle, or creates a new version of the agent if it already existed. Finally, all the new or changed metadata components associated with the new agent are retrieved back to your local DX project.\n\nThis command uses the API name of the authoring bundle. If you don't provide an API name with the --api-name flag, the command searches the current DX project and outputs a list of authoring bundles that it found for you to choose from.",
       "examples": [
-        "Publish an authoring bundle with API name MyAuthoringBundle to the org with alias \"my-org\", resulting in a new agent named \"My Fab Agent\"::\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --agent-name \"My Fab Agent\" --target-org my-org"
+        "Publish an authoring bundle with API name MyAuthoringBundle to the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --target-org my-org"
       ],
       "flags": {
         "json": {
@@ -857,8 +858,9 @@
       "pluginAlias": "@salesforce/plugin-agent",
       "pluginName": "@salesforce/plugin-agent",
       "pluginType": "core",
+      "state": "beta",
       "strict": true,
-      "summary": "Publish an authoring bundle to your org, which results in a new next-gen agent.",
+      "summary": "Publish an authoring bundle to your org, which results in a new or updated agent.",
       "enableJsonFlag": true,
       "requiresProject": true,
       "FLAGGABLE_PROMPTS": {
@@ -885,6 +887,90 @@
         "authoring-bundle:publish:agent"
       ]
     },
+    "agent:validate:authoring-bundle": {
+      "aliases": [],
+      "args": {},
+      "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\nThis command validates that the Agent Script file in the authoring bundle compiles without errors so that you can later publish the bundle to your org. Use this command while you vibe code (modify with natural language) the Agent Script file to ensure that it's always valid. If the validation fails, the command outputs the list of syntax errors, a brief description of the error, and the location in the Agent Script file where the error occurred.\n\nThis command uses the API name of the authoring bundle. If you don't provide an API name with the --api-name flag, the command searches the current DX project and outputs a list of authoring bundles that it found for you to choose from.",
+      "examples": [
+        "Validate an authoring bundle with API name MyAuthoringBundle:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringBundle"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-name": {
+          "char": "n",
+          "name": "api-name",
+          "summary": "API name of the authoring bundle you want to validate.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "agent:validate:authoring-bundle",
+      "pluginAlias": "@salesforce/plugin-agent",
+      "pluginName": "@salesforce/plugin-agent",
+      "pluginType": "core",
+      "state": "beta",
+      "strict": true,
+      "summary": "Validate an authoring bundle to ensure its Agent Script file compiles successfully and can be used to publish an agent.",
+      "enableJsonFlag": true,
+      "requiresProject": true,
+      "FLAGGABLE_PROMPTS": {
+        "api-name": {
+          "message": "API name of the authoring bundle you want to validate.",
+          "promptMessage": "API name of the authoring bundle to validate"
+        }
+      },
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "agent",
+        "validate",
+        "authoring-bundle.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "agent:validate:authoring-bundle",
+        "validate:agent:authoring-bundle",
+        "validate:authoring-bundle:agent",
+        "agent:authoring-bundle:validate",
+        "authoring-bundle:agent:validate",
+        "authoring-bundle:validate:agent"
+      ]
+    },
     "agent:test:create": {
       "aliases": [],
       "args": {},
@@ -1398,90 +1484,7 @@
         "run:agent:test",
         "run:test:agent"
       ]
-    },
-    "agent:validate:authoring-bundle": {
-      "aliases": [],
-      "args": {},
-      "description": "Authoring bundles are metadata types that represent the next-gen Salesforce agents. Their exact metadata name is AiAuthoringBundle and they consist of a standard \"\\*-meta.xml\" metadata file and an agent file (with extension \".agent\") that fully describes the next-gen agent. Generate a local authoring bundle with the \"agent generate authoring-bundle\" command.\n\nThis command validates that the agent file (with extension \".agent\") that's part of the authoring bundle compiles without errors and can later be used to successfully create a next-gen agent.\n\nThis command requires the API name of the authoring bundle; if you don't provide it with the --api-name flag, the command prompts you for it.",
-      "examples": [
-        "Validate a local authoring bundle with API name MyAuthoringBundle:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringBundle"
-      ],
-      "flags": {
-        "json": {
-          "description": "Format output as json.",
-          "helpGroup": "GLOBAL",
-          "name": "json",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "flags-dir": {
-          "helpGroup": "GLOBAL",
-          "name": "flags-dir",
-          "summary": "Import flag values from a directory.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "target-org": {
-          "char": "o",
-          "name": "target-org",
-          "noCacheDefault": true,
-          "required": true,
-          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
-          "hasDynamicHelp": true,
-          "multiple": false,
-          "type": "option"
-        },
-        "api-version": {
-          "description": "Override the api version used for api requests made by this command",
-          "name": "api-version",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "api-name": {
-          "char": "n",
-          "name": "api-name",
-          "summary": "API name of the authoring bundle you want to validate.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": true,
-      "hiddenAliases": [],
-      "id": "agent:validate:authoring-bundle",
-      "pluginAlias": "@salesforce/plugin-agent",
-      "pluginName": "@salesforce/plugin-agent",
-      "pluginType": "core",
-      "strict": true,
-      "summary": "Validate a local authoring bundle to ensure it compiles successfully and can be used to create a next-gen agent.",
-      "enableJsonFlag": true,
-      "requiresProject": true,
-      "FLAGGABLE_PROMPTS": {
-        "api-name": {
-          "message": "API name of the authoring bundle you want to validate.",
-          "promptMessage": "API name of the authoring bundle to validate"
-        }
-      },
-      "isESM": true,
-      "relativePath": [
-        "lib",
-        "commands",
-        "agent",
-        "validate",
-        "authoring-bundle.js"
-      ],
-      "aliasPermutations": [],
-      "permutations": [
-        "agent:validate:authoring-bundle",
-        "validate:agent:authoring-bundle",
-        "validate:authoring-bundle:agent",
-        "agent:authoring-bundle:validate",
-        "authoring-bundle:agent:validate",
-        "authoring-bundle:validate:agent"
-      ]
     }
   },
-  "version": "1.24.14-nga.0"
+  "version": "1.24.14-nga.2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/plugin-agent",
     "description": "Commands to interact with Salesforce agents",
-    "version": "1.24.14-nga.0",
+    "version": "1.24.14-nga.2",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "dependencies": {
@@ -9,7 +9,7 @@
         "@inquirer/prompts": "^7.8.6",
         "@oclif/core": "^4",
         "@oclif/multi-stage-output": "^0.8.23",
-        "@salesforce/agents": "nga",
+        "@salesforce/agents": "0.18.3-nga.6",
         "@salesforce/core": "^8.23.1",
         "@salesforce/kit": "^3.2.3",
         "@salesforce/sf-plugins-core": "^12.2.4",
@@ -231,7 +231,7 @@
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.14-nga.0.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.14-nga.0.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.14-nga.2.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.24.14-nga.2.sig"
     }
 }