Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions solutions/search/agent-builder/agent-builder-agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ The default `Elastic AI Agent` is immutable and cannot be edited. To customize a

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

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

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

:::{note}
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.
:::
1. Set the **Display name** for users.
1. Add a **Display description** to explain the agent's purpose.
3. Set the **Display name** for users.
4. Add a **Display description** to explain the agent's purpose.

::::

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

Optionally customize the agent's appearance and organization:

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

::::

Expand Down
9 changes: 4 additions & 5 deletions solutions/search/agent-builder/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Refer to the [overview page](../elastic-agent-builder.md) for the full list of A
:::
% TODO: Remove this tip when unhide pages

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

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

You can enable the features using the UI:

1. Navigate to **Stack Management > Settings**
2. Find **AI > Agent Builder** in the left-hand navigation
3. Toggle **{{agent-builder}}** to on
4. Select **Save changes**
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).
2. Toggle **{{agent-builder}}** to on.
3. Select **Save changes**.

Refresh the browser page and find **Agents** in the navigation menu to begin using the feature.
You can also search for **Agent Builder** in the [global search bar](/explore-analyze/find-and-organize/find-apps-and-objects.md).
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions solutions/search/agent-builder/programmatic-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ These interfaces enable you to build integrations with other applications and ex
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.
:::

- **[MCP server](mcp-server.md)**: A standardized interface that allows external MCP clients (such as Claude Desktop or Cursor) to access {{agent-builder}} tools
- **[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
- **[Kibana API](kibana-api.md)**: RESTful APIs for working with {{agent-builder}} programmatically
- **[MCP server](mcp-server.md)**: A standardized interface that allows external MCP clients (such as Claude Desktop or Cursor) to access {{agent-builder}} tools.
- **[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.
- **[Kibana API](kibana-api.md)**: RESTful APIs for working with {{agent-builder}} programmatically.

70 changes: 35 additions & 35 deletions solutions/search/agent-builder/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ Tool namespacing helps organize and identify tools by their source. Built-in too

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:

- **[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
- **[ES|QL tools](tools/esql-tools.md)**: Define tools with explicit {{esql}} queries for precise, pre-defined data retrieval operations
- **[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.
- **[ES|QL tools](tools/esql-tools.md)**: Define tools with explicit {{esql}} queries for precise, pre-defined data retrieval operations.


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

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

1. Navigate to the **Tools** page in Kibana
2. Click **New tool**
1. Navigate to the **Tools** section on the **Agents** page in Kibana.
2. Click **New tool**.

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

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

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

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

If you didn't click **Save and test** immediately:
If you didn't select **Save and test** immediately:

1. Find your tool in the Tools list
2. Click the test icon (play button) associated with your tool
1. Find your tool in the Tools list.
2. Click the test icon (play button) associated with your tool.

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

### Best practices

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

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

Tools must be assigned to agents before they can be used:
1. Navigate to the agent configuration page
2. Select the **Tools** tab
3. Add the desired tools to the agent
4. Save the agent configuration
1. Navigate to the agent configuration page.
2. Select the **Tools** tab.
3. Add the desired tools to the agent.
4. Save the agent configuration.

### Update and delete tools

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

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

Expand Down
Loading