Skip to content

Commit 83dc50c

Browse files
ketkee-aryamanerhr323
authored andcommitted
update screenshots and minor cleanup (elastic#3468)
Linked to: elastic#3277 This PR only works on the Agent builder docs: Updates screenshots for 9.2 nav Does minor cleanup
1 parent d9e725f commit 83dc50c

File tree

5 files changed

+52
-53
lines changed

5 files changed

+52
-53
lines changed

solutions/search/agent-builder/agent-builder-agents.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ The default `Elastic AI Agent` is immutable and cannot be edited. To customize a
3232

3333
The **Agents** page provides a centralized view of all your agents. From this page you can:
3434

35-
- View all your agents with their names and labels
36-
- Search for specific agents using the search bar
37-
- Filter agents by labels using the **Labels** dropdown
38-
- Create new agents using the **+ New agent** button
39-
- Start chatting with an agent or perform other actions
35+
- View all your agents with their names and labels.
36+
- Search for specific agents using the search bar.
37+
- Filter agents by labels using the **Labels** dropdown.
38+
- Create new agents using the **+ New agent** button.
39+
- Start chatting with an agent or perform other actions:
4040
- **Elastic AI Agent**: you can **chat** or **clone** the default agent using the chat or clone buttons. The default agent cannot be edited directly.
4141
:::{image} images/chat-and-clone-buttons.png
4242
:alt: Chat with agent and clone agent buttons
@@ -76,13 +76,13 @@ Select the **New agent** button to being creating a new agent.
7676
Configure the essential agent settings in the **settings** tab:
7777

7878
1. Enter an **Agent ID**, a unique identifier for reference in code.
79-
1. Add **Custom instructions**.<br><br>Custom instructions define the agent's personality and determine how it interacts with users and perform tasks.
79+
2. Add **Custom instructions**.<br><br>Custom instructions define the agent's personality and determine how it interacts with users and performs tasks.
8080

8181
:::{note}
8282
Agent Builder adds your custom instructions to the system prompt to define the agent's behavior. The system prompt enables core features like visualization and citations.
8383
:::
84-
1. Set the **Display name** for users.
85-
1. Add a **Display description** to explain the agent's purpose.
84+
3. Set the **Display name** for users.
85+
4. Add a **Display description** to explain the agent's purpose.
8686

8787
::::
8888

@@ -98,8 +98,8 @@ Select the combination of built-in and custom tools available to the agent, base
9898

9999
Optionally customize the agent's appearance and organization:
100100

101-
- Add **Labels** to organize your agents
102-
- Select an **Avatar color** and **Avatar symbol** to help visually distinguish the agent
101+
- Add **Labels** to organize your agents.
102+
- Select an **Avatar color** and **Avatar symbol** to help visually distinguish the agent.
103103

104104
::::
105105

solutions/search/agent-builder/get-started.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Refer to the [overview page](../elastic-agent-builder.md) for the full list of A
1919
:::
2020
% TODO: Remove this tip when unhide pages
2121

22-
Learn how get started by enabling the {{agent-builder}} features and begin chatting with your data.
22+
Learn how to get started by enabling the {{agent-builder}} features and begin chatting with your data.
2323

2424
:::::{stepper}
2525
::::{step} Set up an Elastic deployment
@@ -39,10 +39,9 @@ You can set up a new [space](/deploy-manage/manage-spaces.md) to use the solutio
3939

4040
You can enable the features using the UI:
4141

42-
1. Navigate to **Stack Management > Settings**
43-
2. Find **AI > Agent Builder** in the left-hand navigation
44-
3. Toggle **{{agent-builder}}** to on
45-
4. Select **Save changes**
42+
1. Navigate to **Agent Builder** under **AI** using the navigation menu or the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
43+
2. Toggle **{{agent-builder}}** to on.
44+
3. Select **Save changes**.
4645

4746
Refresh the browser page and find **Agents** in the navigation menu to begin using the feature.
4847
You can also search for **Agent Builder** in the [global search bar](/explore-analyze/find-and-organize/find-apps-and-objects.md).
-8.18 KB
Loading

solutions/search/agent-builder/programmatic-access.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ These interfaces enable you to build integrations with other applications and ex
2222
Most users will probably want to integrate with Agent Builder using MCP or A2A, but you can also work programmatically with tools, agents, and conversations using the Kibana APIs.
2323
:::
2424

25-
- **[MCP server](mcp-server.md)**: A standardized interface that allows external MCP clients (such as Claude Desktop or Cursor) to access {{agent-builder}} tools
26-
- **[A2A server](a2a-server.md)**: Agent-to-agent communication endpoints that follow the A2A protocol specification, enabling external A2A clients to interact with {{agent-builder}} agents
27-
- **[Kibana API](kibana-api.md)**: RESTful APIs for working with {{agent-builder}} programmatically
25+
- **[MCP server](mcp-server.md)**: A standardized interface that allows external MCP clients (such as Claude Desktop or Cursor) to access {{agent-builder}} tools.
26+
- **[A2A server](a2a-server.md)**: Agent-to-agent communication endpoints that follow the A2A protocol specification, enabling external A2A clients to interact with {{agent-builder}} agents.
27+
- **[Kibana API](kibana-api.md)**: RESTful APIs for working with {{agent-builder}} programmatically.
2828

solutions/search/agent-builder/tools.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ Tool namespacing helps organize and identify tools by their source. Built-in too
6868

6969
You can extend the built-in tool catalog with your own custom tool definitions. Custom tools offer flexibility in how they interact with your data:
7070

71-
- **[Index search tools](tools/index-search-tools.md)**: Define tools that are scoped to a specific index or pattern, allowing the LLM to decide how to query those indices based on the user's request
72-
- **[ES|QL tools](tools/esql-tools.md)**: Define tools with explicit {{esql}} queries for precise, pre-defined data retrieval operations
71+
- **[Index search tools](tools/index-search-tools.md)**: Define tools that are scoped to a specific index or pattern, allowing the LLM to decide how to query those indices based on the user's request.
72+
- **[ES|QL tools](tools/esql-tools.md)**: Define tools with explicit {{esql}} queries for precise, pre-defined data retrieval operations.
7373

7474

7575
This flexibility allows you to create tools that match your specific use cases and data access patterns.
@@ -100,23 +100,23 @@ Providing clear, descriptive parameter names and descriptions helps agents prope
100100

101101
You can create custom tools to help agents interact with your data in specific ways. This section covers how to create and test tools in the UI
102102

103-
1. Navigate to the **Tools** page in Kibana
104-
2. Click **New tool**
103+
1. Navigate to the **Tools** section on the **Agents** page in Kibana.
104+
2. Click **New tool**.
105105

106106
:::{image} images/new-tool-button.png
107107
:alt: New tool button for creating custom tools
108108
:width: 150px
109109
:::
110110

111111
4. Fill in the required fields:
112-
- **Name**: Enter a descriptive name for your tool
113-
- **Description**: Write a clear explanation of what the tool does and when it should be used
114-
- **Tool type**: Choose either **[{{esql}}](tools/esql-tools.md)** or **[Index search](tools/index-search-tools.md)**
115-
- **Parameters**: For tools with {{esql}} queries, define any parameters your query needs
116-
- **Tags**: (Optional) Add labels to categorize and organize your tools
112+
- **Name**: Enter a descriptive name for your tool.
113+
- **Description**: Write a clear explanation of what the tool does and when it should be used.
114+
- **Tool type**: Choose either **[{{esql}}](tools/esql-tools.md)** or **[Index search](tools/index-search-tools.md).**
115+
- **Parameters**: For tools with {{esql}} queries, define any parameters your query needs.
116+
- **Tags**: (Optional) Add labels to categorize and organize your tools.
117117
5. Choose how to save your tool:
118-
- Click **Save** to create the tool
119-
- Click **Save and test** to create the tool and immediately open the testing interface
118+
- Select **Save** to create the tool.
119+
- Select **Save and test** to create the tool and immediately open the testing interface
120120

121121
:::{image} images/tool-save-save-and-test-buttons.png
122122
:alt: Save and Save and test buttons for tool creation
@@ -127,34 +127,34 @@ You can create custom tools to help agents interact with your data in specific w
127127

128128
Before assigning tools to agents, verify they work correctly by testing them. Testing helps ensure your tool returns useful results and handles parameters correctly.
129129

130-
If you didn't click **Save and test** immediately:
130+
If you didn't select **Save and test** immediately:
131131

132-
1. Find your tool in the Tools list
133-
2. Click the test icon (play button) associated with your tool
132+
1. Find your tool in the Tools list.
133+
2. Click the test icon (play button) associated with your tool.
134134

135135
:::{image} images/test-icon.png
136136
:alt: Test icon (play button) for running tool tests
137137
:width: 150px
138138
:::
139139
3. Enter test data based on your tool type:
140-
- **For {{esql}} tools with parameters**: Enter realistic test values for each parameter in the **Inputs** section
141-
- **For Index search tools**: Enter a sample search query to test the search functionality
142-
4. Click **Submit** to run the test
140+
- **For {{esql}} tools with parameters**: Enter realistic test values for each parameter in the **Inputs** section.
141+
- **For Index search tools**: Enter a sample search query to test the search functionality.
142+
4. Select **Submit** to run the test.
143143
5. Review the Response section to verify:
144-
- The tool executes without errors
145-
- Results are returned in the expected format
146-
- The data matches your expectations
147-
7. Now you can [assign the tool to an agent](#assign-tools-to-agents)
144+
- The tool executes without errors.
145+
- Results are returned in the expected format.
146+
- The data matches your expectations.
147+
6. Now you can [assign the tool to an agent](#assign-tools-to-agents).
148148

149149
### Best practices
150150

151-
1. **Write descriptive names**: Use clear, action-oriented names
152-
2. **Provide detailed descriptions**: Explain when and how the tool should be used
153-
3. **Limit scope**: Focus each tool on a specific task rather than creating overly complex tools
154-
4. **Use meaningful parameter names**: Choose names that clearly indicate what the parameter represents
155-
5. **Add comprehensive parameter descriptions**: Help the agent understand what values to use
156-
6. **Include `LIMIT` clauses in {{esql}} queries**: Prevent returning excessive results
157-
7. **Use appropriate tags**: Add relevant tags to make tools easier to find and organize
151+
1. **Write descriptive names**: Use clear, action-oriented names.
152+
2. **Provide detailed descriptions**: Explain when and how the tool should be used.
153+
3. **Limit scope**: Focus each tool on a specific task rather than creating overly complex tools.
154+
4. **Use meaningful parameter names**: Choose names that clearly indicate what the parameter represents.
155+
5. **Add comprehensive parameter descriptions**: Help the agent understand what values to use.
156+
6. **Include `LIMIT` clauses in {{esql}} queries**: Prevent returning excessive results.
157+
7. **Use appropriate tags**: Add relevant tags to make tools easier to find and organize.
158158
8. **Limit tool count**: More tools are not always better. Try to keep each agent focused with a limited number of relevant tools.
159159

160160
## Manage tools
@@ -179,17 +179,17 @@ Access the complete list of available tools from the **Tools** page in Kibana. T
179179
### Assign tools to agents
180180

181181
Tools must be assigned to agents before they can be used:
182-
1. Navigate to the agent configuration page
183-
2. Select the **Tools** tab
184-
3. Add the desired tools to the agent
185-
4. Save the agent configuration
182+
1. Navigate to the agent configuration page.
183+
2. Select the **Tools** tab.
184+
3. Add the desired tools to the agent.
185+
4. Save the agent configuration.
186186

187187
### Update and delete tools
188188

189189
Custom tools can be modified or removed as needed:
190-
1. From the Tools page, find the tool you want to modify
191-
2. Click the edit icon to update the tool or the delete icon to remove it
192-
3. For updates, modify the tool properties and save your changes
190+
1. From the Tools page, find the tool you want to modify.
191+
2. Select the edit icon to update the tool or the delete icon to remove it.
192+
3. For updates, modify the tool properties and save your changes.
193193

194194
Note that built-in tools cannot be modified or deleted.
195195

0 commit comments

Comments
 (0)