@salesforce/plugin-agent 1.5.1 → 1.5.2

package/README.md

@@ -71,15 +71,15 @@ sf plugins
 
 ## `sf agent create`
 
-Create an Agent from an agent spec.
+Create an agent in your org from a local agent spec file.
 
 ```
 USAGE
   $ sf agent create -o <value> -f <value> -n <value> [--json] [--flags-dir <value>] [--api-version <value>]
 
 FLAGS
-  -f, --job-spec=<value>     (required) The path to an agent spec file.
-  -n, --name=<value>         (required) The name of the agent.
+  -f, --job-spec=<value>     (required) Path to an agent spec file.
+  -n, --name=<value>         (required) API name of the new agent.
   -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
                              configuration variable is already set.
       --api-version=<value>  Override the api version used for api requests made by this command
@@ -89,27 +89,31 @@ GLOBAL FLAGS
   --json               Format output as json.
 
 DESCRIPTION
-  Create an Agent from an agent spec.
+  Create an agent in your org from a local agent spec file.
 
-  Create an Agent from an agent spec. Agent metadata is created in the target org and retrieved to the local project.
+  To generate an agent spec file, run the "agent generate spec" CLI command, which outputs a JSON file with the list of
+  jobs and descriptions that the new agent can perform. Then specify this generated spec file to the --job-spec flag of
+  this command, along with the name of the new agent.
 
-EXAMPLES
-  Create an Agent:
+  When this command finishes, your org contains the new agent, which you can then edit in the Agent Builder UI. The new
+  agent already has a list of topics and actions that were automatically created from the list of jobs in the provided
+  agent spec file. This command also retrieves all the metadata files associated with the new agent to your local DX
+  project.
 
-    $ sf agent create --spec ./agent-spec.json
+  To open the new agent in your org's Agent Builder UI, run this command: "sf org open agent --name
+  <api-name-of-your-agent>".
 
-FLAG DESCRIPTIONS
-  -f, --job-spec=<value>  The path to an agent spec file.
+EXAMPLES
+  Create an agent called "CustomerSupportAgent" in an org with alias "my-org" using the specified agent spec file:
 
-    The agent spec file defines job titles and descriptions for the agent and can be created using the `sf agent create
-    spec` command.
+    $ sf agent create --name CustomerSupportAgent --job-spec ./config/agentSpec.json --target-org my-org
 ```
 
-_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.1/src/commands/agent/create.ts)_
+_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.2/src/commands/agent/create.ts)_
 
 ## `sf agent generate spec`
 
-Create an Agent spec.
+Generate an agent spec, which is the list of jobs that the agent performs.
 
 ```
 USAGE
@@ -118,37 +122,55 @@ USAGE
     [-f <value>]
 
 FLAGS
-  -d, --output-dir=<value>           [default: config] The location within the project where the agent spec will be
-                                     written.
-  -f, --file-name=<value>            [default: agentSpec.json] The name of the file to write the agent spec to.
+  -d, --output-dir=<value>           [default: config] Directory where the agent spec file is written; can be an
+                                     absolute or relative path.
+  -f, --file-name=<value>            [default: agentSpec.json] Name of the generated agent spec file.
   -o, --target-org=<value>           (required) Username or alias of the target org. Not required if the `target-org`
                                      configuration variable is already set.
-  -t, --type=<option>                The type of agent to create.
+  -t, --type=<option>                Type of agent to create.
                                      <options: customer|internal>
       --api-version=<value>          Override the api version used for api requests made by this command
-      --company-description=<value>  The description of the company, containing details to be used when generating agent
-                                     job descriptions.
-      --company-name=<value>         The name of the company.
-      --company-website=<value>      The website URL for the company.
-      --role=<value>                 The role of the agent.
+      --company-description=<value>  Description of your company.
+      --company-name=<value>         Name of your company.
+      --company-website=<value>      Website URL of your company.
+      --role=<value>                 Role of the agent.
 
 GLOBAL FLAGS
   --flags-dir=<value>  Import flag values from a directory.
   --json               Format output as json.
 
 DESCRIPTION
-  Create an Agent spec.
+  Generate an agent spec, which is the list of jobs that the agent performs.
+
+  When using Salesforce CLI to create an agent in your org, the first step is to generate the local JSON-formatted agent
+  spec file with this command.
 
-  Create an Agent spec, which is a list of job titles and descriptions that the agent performs.
+  An agent spec is a list of jobs and descriptions that capture what the agent can do. Use flags such as --role and
+  --company-description to provide details about your company and the role that the agent plays in your company; you can
+  also enter the information interactively if you prefer. When you then execute this command, the large language model
+  (LLM) associated with your org uses the information to generate the list of jobs that the agent most likely performs.
+  We recommend that you provide good details for --role, --company-description, etc, so that the LLM can generate the
+  best and most relevant list of jobs and descriptions. Once generated, you can edit the spec file; for example, you can
+  remove jobs that don't apply to your agent.
+
+  When your agent spec is ready, you then create the agent in your org by specifying the agent spec file to the
+  --job-spec flag of the "agent create" CLI command.
 
 EXAMPLES
-  Create an Agent spec in the default location:
+  Create an agent spec for your default org in the default location and use flags to specify the agent's role and your
+  company details:
+
+    $ sf agent generate spec --type customer --role "Assist users in navigating and managing bookings" \
+      --company-name "Coral Cloud" --company-description "Resort that manages guests and their reservations and \
+      experiences"
+
+  Create an agent spec by being prompted for role and company details interactively; write the generated file to the
+  "specs" directory and use the org with alias "my-org":
 
-    $ sf agent generate spec --type customer_facing --role Support --company-name "Coral Cloud" \
-      --company-description "A meaningful description"
+    $ sf agent generate spec --output-dir specs --target-org my-org
 ```
 
-_See code: [src/commands/agent/generate/spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.1/src/commands/agent/generate/spec.ts)_
+_See code: [src/commands/agent/generate/spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.2/src/commands/agent/generate/spec.ts)_
 
 ## `sf agent preview`
 
@@ -183,7 +205,7 @@ FLAG DESCRIPTIONS
     the API name of the agent? (TBD based on agents library)
 ```
 
-_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.1/src/commands/agent/preview.ts)_
+_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.2/src/commands/agent/preview.ts)_
 
 ## `sf agent test cancel`
 
@@ -215,7 +237,7 @@ EXAMPLES
     $ sf agent test cancel --job-id AiEvalId
 ```
 
-_See code: [src/commands/agent/test/cancel.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.1/src/commands/agent/test/cancel.ts)_
+_See code: [src/commands/agent/test/cancel.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.2/src/commands/agent/test/cancel.ts)_
 
 ## `sf agent test results`
 
@@ -254,7 +276,7 @@ FLAG DESCRIPTIONS
     results will not be written.
 ```
 
-_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.1/src/commands/agent/test/results.ts)_
+_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.2/src/commands/agent/test/results.ts)_
 
 ## `sf agent test resume`
 
@@ -302,7 +324,7 @@ FLAG DESCRIPTIONS
     If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
 ```
 
-_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.1/src/commands/agent/test/resume.ts)_
+_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.2/src/commands/agent/test/resume.ts)_
 
 ## `sf agent test run`
 
@@ -353,6 +375,6 @@ FLAG DESCRIPTIONS
     If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
 ```
 
-_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.1/src/commands/agent/test/run.ts)_
+_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.5.2/src/commands/agent/test/run.ts)_
 
 <!-- commandsstop -->

package/lib/commands/agent/create.js

@@ -25,7 +25,6 @@ export default class AgentCreate extends SfCommand {
             char: 'f',
             required: true,
             summary: messages.getMessage('flags.job-spec.summary'),
-            description: messages.getMessage('flags.job-spec.description'),
         }),
         name: Flags.string({
             char: 'n',

package/lib/commands/agent/create.js.map

@@ -1 +1 @@
-{"version":3,"file":"create.js","sourceRoot":"","sources":["../../../src/commands/agent/create.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAqB,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAE1F,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,cAAc,CAAC,CAAC;AAOnF,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,SAA4B;IAC5D,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,CAAU,eAAe,GAAG,IAAI,CAAC;IACvC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC;IAEtB,MAAM,CAAU,KAAK,GAAG;QAC7B,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;QACpC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC;YACrB,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YACtD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,4BAA4B,CAAC;SAC/D,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;SACnD,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,gBAAgB,GAAG,WAAW,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QACxD,MAAM,GAAG,GAAG,IAAI,gBAAgB,CAAC;YAC/B,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE;YAC/B,KAAK,EAAE,YAAY,KAAK,CAAC,IAAI,QAAQ;YACrC,MAAM,EAAE;gBACN,gBAAgB;gBAChB,2BAA2B;gBAC3B,2BAA2B;gBAC3B,uBAAuB;gBACvB,2BAA2B;aAC5B;SACF,CAAC,CAAC;QAEH,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC3B,MAAM,WAAW,GAAG;YAClB,GAAI,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAuB;YAChF,IAAI,EAAE,KAAK,CAAC,IAAI;SACjB,CAAC;QAEF,sDAAsD;QACtD,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,0BAA0B,CAAC,eAAe,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,CAAC;QACpH,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,0BAA0B,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC5E,sDAAsD;QACtD,GAAG,CAAC,IAAI,CAAC,2BAA2B,CAAC,CACtC,CAAC;QACF,sDAAsD;QACtD,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,0BAA0B,CAAC,gBAAgB,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC;QACjH,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC7E,sDAAsD;QACtD,GAAG,CAAC,IAAI,CAAC,2BAA2B,CAAC,CACtC,CAAC;QAEF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,OAAQ,CAAC,CAAC;QAChG,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAEhD,GAAG,CAAC,IAAI,EAAE,CAAC;QAEX,IAAI,CAAC,GAAG,CACN,OAAO,CAAC,SAAS;YACf,CAAC,CAAC,QAAQ,CACN,OAAO,EACP,wBAAwB,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,IAAI,gBAAgB,GAAG,CAClG;YACH,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,0BAA0B,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,YAAY,IAAI,EAAE,EAAE,CAAC,CAC3F,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,OAAO,QAAQ,CAAC,KAAK,EAAE,4BAA4B,KAAK,CAAC,IAAI,EAAE,CAAC,oCAAoC,CAAC,CAAC;QAE/G,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;IAC1C,CAAC"}
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../../../src/commands/agent/create.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAqB,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAE1F,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,cAAc,CAAC,CAAC;AAOnF,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,SAA4B;IAC5D,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,CAAU,eAAe,GAAG,IAAI,CAAC;IACvC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC;IAEtB,MAAM,CAAU,KAAK,GAAG;QAC7B,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;QACpC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC;YACrB,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;SACvD,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;SACnD,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,gBAAgB,GAAG,WAAW,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QACxD,MAAM,GAAG,GAAG,IAAI,gBAAgB,CAAC;YAC/B,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE;YAC/B,KAAK,EAAE,YAAY,KAAK,CAAC,IAAI,QAAQ;YACrC,MAAM,EAAE;gBACN,gBAAgB;gBAChB,2BAA2B;gBAC3B,2BAA2B;gBAC3B,uBAAuB;gBACvB,2BAA2B;aAC5B;SACF,CAAC,CAAC;QAEH,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC3B,MAAM,WAAW,GAAG;YAClB,GAAI,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAuB;YAChF,IAAI,EAAE,KAAK,CAAC,IAAI;SACjB,CAAC;QAEF,sDAAsD;QACtD,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,0BAA0B,CAAC,eAAe,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,CAAC;QACpH,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,0BAA0B,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC5E,sDAAsD;QACtD,GAAG,CAAC,IAAI,CAAC,2BAA2B,CAAC,CACtC,CAAC;QACF,sDAAsD;QACtD,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,0BAA0B,CAAC,gBAAgB,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC;QACjH,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC7E,sDAAsD;QACtD,GAAG,CAAC,IAAI,CAAC,2BAA2B,CAAC,CACtC,CAAC;QAEF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,OAAQ,CAAC,CAAC;QAChG,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAEhD,GAAG,CAAC,IAAI,EAAE,CAAC;QAEX,IAAI,CAAC,GAAG,CACN,OAAO,CAAC,SAAS;YACf,CAAC,CAAC,QAAQ,CACN,OAAO,EACP,wBAAwB,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,IAAI,gBAAgB,GAAG,CAClG;YACH,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,0BAA0B,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,YAAY,IAAI,EAAE,EAAE,CAAC,CAC3F,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,OAAO,QAAQ,CAAC,KAAK,EAAE,4BAA4B,KAAK,CAAC,IAAI,EAAE,CAAC,oCAAoC,CAAC,CAAC;QAE/G,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;IAC1C,CAAC"}

package/messages/agent.create.md

@@ -1,25 +1,25 @@
 # summary
 
-Create an Agent from an agent spec.
+Create an agent in your org from a local agent spec file.
 
 # description
 
-Create an Agent from an agent spec. Agent metadata is created in the target org and retrieved to the local project.
+To generate an agent spec file, run the "agent generate spec" CLI command, which outputs a JSON file with the list of jobs and descriptions that the new agent can perform. Then specify this generated spec file to the --job-spec flag of this command, along with the name of the new agent.
 
-# flags.job-spec.summary
+When this command finishes, your org contains the new agent, which you can then edit in the Agent Builder UI. The new agent already has a list of topics and actions that were automatically created from the list of jobs in the provided agent spec file. This command also retrieves all the metadata files associated with the new agent to your local DX project.
 
-The path to an agent spec file.
+To open the new agent in your org's Agent Builder UI, run this command: "sf org open agent --name <api-name-of-your-agent>". 
 
-# flags.job-spec.description
+# flags.job-spec.summary
 
-The agent spec file defines job titles and descriptions for the agent and can be created using the `sf agent create spec` command.
+Path to an agent spec file.
 
 # flags.name.summary
 
-The name of the agent.
+API name of the new agent.
 
 # examples
 
-- Create an Agent:
+- Create an agent called "CustomerSupportAgent" in an org with alias "my-org" using the specified agent spec file:
 
-  <%= config.bin %> <%= command.id %> --spec ./agent-spec.json
+  <%= config.bin %> <%= command.id %> --name CustomerSupportAgent --job-spec ./config/agentSpec.json --target-org my-org

package/messages/agent.generate.spec.md

@@ -1,41 +1,49 @@
 # summary
 
-Create an Agent spec.
+Generate an agent spec, which is the list of jobs that the agent performs.
 
 # description
 
-Create an Agent spec, which is a list of job titles and descriptions that the agent performs.
+When using Salesforce CLI to create an agent in your org, the first step is to generate the local JSON-formatted agent spec file with this command.
+
+An agent spec is a list of jobs and descriptions that capture what the agent can do. Use flags such as --role and --company-description to provide details about your company and the role that the agent plays in your company; you can also enter the information interactively if you prefer. When you then execute this command, the large language model (LLM) associated with your org uses the information to generate the list of jobs that the agent most likely performs. We recommend that you provide good details for --role, --company-description, etc, so that the LLM can generate the best and most relevant list of jobs and descriptions. Once generated, you can edit the spec file; for example, you can remove jobs that don't apply to your agent.
+
+When your agent spec is ready, you then create the agent in your org by specifying the agent spec file to the --job-spec flag of the "agent create" CLI command.
 
 # flags.type.summary
 
-The type of agent to create.
+Type of agent to create.
 
 # flags.role.summary
 
-The role of the agent.
+Role of the agent.
 
 # flags.company-name.summary
 
-The name of the company.
+Name of your company.
 
 # flags.company-description.summary
 
-The description of the company, containing details to be used when generating agent job descriptions.
+Description of your company.
 
 # flags.company-website.summary
 
-The website URL for the company.
+Website URL of your company.
 
 # flags.output-dir.summary
 
-The location within the project where the agent spec will be written.
+Directory where the agent spec file is written; can be an absolute or relative path.
 
 # flags.file-name.summary
 
-The name of the file to write the agent spec to.
+Name of the generated agent spec file.
 
 # examples
 
-- Create an Agent spec in the default location:
+- Create an agent spec for your default org in the default location and use flags to specify the agent's role and your company details:
+
+  <%= config.bin %> <%= command.id %> --type customer --role "Assist users in navigating and managing bookings" --company-name "Coral Cloud" --company-description "Resort that manages guests and their reservations and experiences"
+
+- Create an agent spec by being prompted for role and company details interactively; write the generated file to the "specs" directory and use the org with alias "my-org":
 
-  <%= config.bin %> <%= command.id %> --type customer_facing --role Support --company-name "Coral Cloud" --company-description "A meaningful description"
+  <%= config.bin %> <%= command.id %> --output-dir specs --target-org my-org

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@salesforce/plugin-agent",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@salesforce/plugin-agent",
-      "version": "1.5.1",
+      "version": "1.5.2",
       "license": "BSD-3-Clause",
       "dependencies": {
         "@inquirer/figures": "^1.0.7",

package/oclif.manifest.json

@@ -3,9 +3,9 @@
     "agent:create": {
       "aliases": [],
       "args": {},
-      "description": "Create an Agent from an agent spec. Agent metadata is created in the target org and retrieved to the local project.",
+      "description": "To generate an agent spec file, run the \"agent generate spec\" CLI command, which outputs a JSON file with the list of jobs and descriptions that the new agent can perform. Then specify this generated spec file to the --job-spec flag of this command, along with the name of the new agent.\n\nWhen this command finishes, your org contains the new agent, which you can then edit in the Agent Builder UI. The new agent already has a list of topics and actions that were automatically created from the list of jobs in the provided agent spec file. This command also retrieves all the metadata files associated with the new agent to your local DX project.\n\nTo open the new agent in your org's Agent Builder UI, run this command: \"sf org open agent --name <api-name-of-your-agent>\".",
       "examples": [
-        "Create an Agent:\n<%= config.bin %> <%= command.id %> --spec ./agent-spec.json"
+        "Create an agent called \"CustomerSupportAgent\" in an org with alias \"my-org\" using the specified agent spec file:\n<%= config.bin %> <%= command.id %> --name CustomerSupportAgent --job-spec ./config/agentSpec.json --target-org my-org"
       ],
       "flags": {
         "json": {
@@ -42,10 +42,9 @@
         },
         "job-spec": {
           "char": "f",
-          "description": "The agent spec file defines job titles and descriptions for the agent and can be created using the `sf agent create spec` command.",
           "name": "job-spec",
           "required": true,
-          "summary": "The path to an agent spec file.",
+          "summary": "Path to an agent spec file.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -54,7 +53,7 @@
           "char": "n",
           "name": "name",
           "required": true,
-          "summary": "The name of the agent.",
+          "summary": "API name of the new agent.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -68,7 +67,7 @@
       "pluginType": "core",
       "state": "beta",
       "strict": true,
-      "summary": "Create an Agent from an agent spec.",
+      "summary": "Create an agent in your org from a local agent spec file.",
       "enableJsonFlag": true,
       "requiresProject": true,
       "isESM": true,
@@ -155,9 +154,10 @@
     "agent:generate:spec": {
       "aliases": [],
       "args": {},
-      "description": "Create an Agent spec, which is a list of job titles and descriptions that the agent performs.",
+      "description": "When using Salesforce CLI to create an agent in your org, the first step is to generate the local JSON-formatted agent spec file with this command.\n\nAn agent spec is a list of jobs and descriptions that capture what the agent can do. Use flags such as --role and --company-description to provide details about your company and the role that the agent plays in your company; you can also enter the information interactively if you prefer. When you then execute this command, the large language model (LLM) associated with your org uses the information to generate the list of jobs that the agent most likely performs. We recommend that you provide good details for --role, --company-description, etc, so that the LLM can generate the best and most relevant list of jobs and descriptions. Once generated, you can edit the spec file; for example, you can remove jobs that don't apply to your agent.\n\nWhen your agent spec is ready, you then create the agent in your org by specifying the agent spec file to the --job-spec flag of the \"agent create\" CLI command.",
       "examples": [
-        "Create an Agent spec in the default location:\n<%= config.bin %> <%= command.id %> --type customer_facing --role Support --company-name \"Coral Cloud\" --company-description \"A meaningful description\""
+        "Create an agent spec for your default org in the default location and use flags to specify the agent's role and your company details:\n<%= config.bin %> <%= command.id %> --type customer --role \"Assist users in navigating and managing bookings\" --company-name \"Coral Cloud\" --company-description \"Resort that manages guests and their reservations and experiences\"",
+        "Create an agent spec by being prompted for role and company details interactively; write the generated file to the \"specs\" directory and use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --output-dir specs --target-org my-org"
       ],
       "flags": {
         "json": {
@@ -195,7 +195,7 @@
         "type": {
           "char": "t",
           "name": "type",
-          "summary": "The type of agent to create.",
+          "summary": "Type of agent to create.",
           "hasDynamicHelp": false,
           "multiple": false,
           "options": [
@@ -206,28 +206,28 @@
         },
         "role": {
           "name": "role",
-          "summary": "The role of the agent.",
+          "summary": "Role of the agent.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "company-name": {
           "name": "company-name",
-          "summary": "The name of the company.",
+          "summary": "Name of your company.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "company-description": {
           "name": "company-description",
-          "summary": "The description of the company, containing details to be used when generating agent job descriptions.",
+          "summary": "Description of your company.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "company-website": {
           "name": "company-website",
-          "summary": "The website URL for the company.",
+          "summary": "Website URL of your company.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -235,7 +235,7 @@
         "output-dir": {
           "char": "d",
           "name": "output-dir",
-          "summary": "The location within the project where the agent spec will be written.",
+          "summary": "Directory where the agent spec file is written; can be an absolute or relative path.",
           "default": "config",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -244,7 +244,7 @@
         "file-name": {
           "char": "f",
           "name": "file-name",
-          "summary": "The name of the file to write the agent spec to.",
+          "summary": "Name of the generated agent spec file.",
           "default": "agentSpec.json",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -259,7 +259,7 @@
       "pluginType": "core",
       "state": "beta",
       "strict": true,
-      "summary": "Create an Agent spec.",
+      "summary": "Generate an agent spec, which is the list of jobs that the agent performs.",
       "enableJsonFlag": true,
       "requiresProject": true,
       "isESM": true,
@@ -691,5 +691,5 @@
       ]
     }
   },
-  "version": "1.5.1"
+  "version": "1.5.2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/plugin-agent",
     "description": "Commands to interact with Salesforce agents",
-    "version": "1.5.1",
+    "version": "1.5.2",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "dependencies": {
@@ -221,7 +221,7 @@
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.5.1.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.5.1.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.5.2.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-agent/1.5.2.sig"
     }
 }