Merge pull request #74 from salesforcecli/js/edit-create-agent-messages

W-17684955: round 2 of edit of --help for agent create/generate spec commands

Author: shetzel

messages/agent.create.md

@@ -4,13 +4,13 @@ Create an agent in your org using a local agent spec file.
 
 # description
 
-Before you run this command, you must first generate an agent spec file by running the "agent generate spec" CLI command, which outputs a YAML file with the agent properties and list of AI-generated topics. Topics define the range of jobs the agent can handle. Then specify the generated agent spec file to this command using the --spec flag, along with the name (label) of the new agent using the --agent-name flag.
+To run this comand, 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 --agent-name flag. If you don't specify any of the required flags, the command prompts you.
 
-When this command finishes, your org contains the new agent, which you can then edit 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. This command also retrieves all the metadata files associated with the new agent to your local Salesforce DX project.
+When 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.
 
-Use the --preview flag to review what the agent looks like without actually saving it in your org. Rather, the command creates a JSON file with all the agent details in the current directory.
+Use 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.
 
-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>".
+To open the new agent in your org's Agent Builder UI, run this command: "sf org open agent --name <agent-api-name>".
 
 # flags.spec.summary
 
@@ -42,14 +42,18 @@ Missing required flags: %s
 
 # error.missingRequiredSpecProperties
 
-Missing required spec file properties: %s
+Your agent spec file is missing these required properties: %s.
 
 # examples
 
-- Create an agent called "ResortManager" in an org with alias "my-org" using the specified agent spec file:
+- Create an agent by being prompted for the required information, such as the agent spec file, agent name, and agent API name and then create it in your default org:
 
-  <%= config.bin %> <%= command.id %> --agent-name ResortManager --spec specs/resortManagerAgent.yaml --target-org my-org
+  <%= config.bin %> <%= command.id %>
 
-- Preview the creation of an agent called "ResortManager" and use your default org:
+- 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:
 
-  <%= config.bin %> <%= command.id %> --agent-name ResortManager --spec specs/resortManagerAgent.yaml --preview
+  <%= config.bin %> <%= command.id %> --agent-name "Resort Manager" --agent-api-name Resort_Manager --spec specs/resortManagerAgent.yaml --target-org my-org
+
+- Preview the creation of an agent named "Resort Manager" and use your default org:
+
+  <%= config.bin %> <%= command.id %> --agent-name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview

messages/agent.generate.agent-spec.md

@@ -4,19 +4,19 @@ Generate an agent spec, which is a YAML file that captures what an agent can do.
 
 # description
 
-Before you use Salesforce CLI to create an agent in your org, you must first generate an agent spec with 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.
+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.
 
-Use 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 information. Upon command execution, the large language model (LLM) associated with your org uses the information you provided 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 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 to your agent or change the description of a particular topic.
+Use 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.
 
-You can 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.
+You 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.
 
-You can also specify a custom prompt template that the agent uses, and ground the prompt template to add context and personalization to the agent's prompts.
+You 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.
 
 When 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.
 
 # flags.type.summary
 
-Type of agent to create.
+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.
 
 # flags.role.summary
 
@@ -92,7 +92,7 @@ Language the agent uses in conversations.
 
 # flags.no-prompt.summary
 
-Don't prompt the user to confirm spec file overwrite.
+Don't prompt the user to confirm that an existing spec file will be overwritten.
 
 # examples
 
@@ -104,9 +104,17 @@ Don't prompt the user to confirm spec file overwrite.
 
   <%= config.bin %> <%= command.id %> --max-topics 5 --output-file specs/resortManagerAgent.yaml --target-org my-org
 
+- Be prompted for all required and optional agent properties; use your default org:
+
+  <%= config.bin %> <%= command.id %> --full-interview
+
 - 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:
 
-  <%= 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" --target-org my-org
+  <%= 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"
+
+- 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:
+
+  <%= config.bin %> <%= command.id %> --tone formal --agent-user resortmanager@myorg.com
 
 # error.missingRequiredFlags