Skip to content

Commit 9fb4ff6

Browse files
Update agent.create.md
1 parent 6dc452e commit 9fb4ff6

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

messages/agent.create.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ Create an agent in your org using a local agent spec file.
44

55
# description
66

7-
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.
7+
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.
88

9-
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.
9+
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.
1010

11-
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.
11+
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.
1212

13-
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>".
13+
To open the new agent in your org's Agent Builder UI, run this command: "sf org open agent --name <agent-api-name>".
1414

1515
# flags.spec.summary
1616

@@ -42,14 +42,18 @@ Missing required flags: %s
4242

4343
# error.missingRequiredSpecProperties
4444

45-
Missing required spec file properties: %s
45+
Your agent spec file is missing these required properties: %s.
4646

4747
# examples
4848

49-
- Create an agent called "ResortManager" in an org with alias "my-org" using the specified agent spec file:
49+
- 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:
5050

51-
<%= config.bin %> <%= command.id %> --agent-name ResortManager --spec specs/resortManagerAgent.yaml --target-org my-org
51+
<%= config.bin %> <%= command.id %>
5252

53-
- Preview the creation of an agent called "ResortManager" and use your default org:
53+
- 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:
5454

55-
<%= config.bin %> <%= command.id %> --agent-name ResortManager --spec specs/resortManagerAgent.yaml --preview
55+
<%= config.bin %> <%= command.id %> --agent-name "Resort Manager" --agent-api-name Resort_Manager --spec specs/resortManagerAgent.yaml --target-org my-org
56+
57+
- Preview the creation of an agent named "Resort Manager" and use your default org:
58+
59+
<%= config.bin %> <%= command.id %> --agent-name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview

0 commit comments

Comments
 (0)