Skip to content

Commit c166401

Browse files
committed
added step-by-step agent management guides with screenshots, split programmatic access into separate API/MCP/A2A pages
**Major changes:** - Renamed "Conversations" to "Agent Chat" throughout - Expanded agent management section with detailed UI instructions and screenshots - Added comprehensive step-by-step agent creation guide with visual elements - Restructured getting started guide to be more user-friendly - Updated programmatic access to be overview-only, with separate dedicated pages for APIs, MCP, and A2A - Renamed system tools to "built-in tools" consistently - Updated API endpoints from `/api/chat/` to `/api/agent_builder/` - Enhanced tool configuration examples with better parameter descriptions - Added troubleshooting for SQL vs ES|QL syntax confusion - Removed self-deployment references (serverless/cloud only) - Updated model details (Claude Sonnet 3.7 via Elastic Inference Service) - Reorganized table of contents with new file structure for programmatic access **Key improvements:** - Better user onboarding flow - More detailed UI guidance with screenshots - Clearer separation between built-in and custom tools - Enhanced API documentation structure - More comprehensive limitations section
1 parent 641f8b1 commit c166401

File tree

11 files changed

+356
-189
lines changed

11 files changed

+356
-189
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
navigation_title: "A2A server"
3+
applies_to:
4+
stack: preview 9.2
5+
serverless:
6+
elasticsearch: preview
7+
---
8+
9+
# Agent-to-Agent (A2A) server
10+
11+
The [**Agent-to-Agent (A2A) server**](https://github.com/a2aproject/A2A) enables external A2A clients to communicate with {{agent-builder}} agents.
12+
13+
## Agent cards endpoint
14+
15+
Returns metadata for a specific agent. The `agentId` is a path parameter that corresponds to your agent IDs:
16+
17+
```
18+
GET /api/agent_builder/a2a/{agentId}.json
19+
```
20+
21+
## A2A protocol endpoint
22+
23+
Interact with agents following the A2A protocol specification:
24+
25+
```
26+
POST /api/agent_builder/a2a/{agentId}
27+
```
28+
29+
:::{important}
30+
Both A2A endpoints require API key authentication. For more information about the A2A protocol, see the [A2A protocol specification](https://a2aprotocol.ai/docs/guide/a2a-protocol-specification-python#protocol-flow-diagram).
31+
:::

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

Lines changed: 90 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,106 @@
22
navigation_title: "Agents"
33
applies_to:
44
stack: preview 9.2
5-
deployment:
6-
self: unavailable
75
serverless:
86
elasticsearch: preview
97
---
108

11-
# Agents
9+
# {{agent-builder}}: Agents
1210

13-
Agents are AI assistants that engage in natural language conversations with users and interact with your {{es}} data through tools. Each agent manages the conversation flow, interprets user requests, and provides responses based on its configured tools, instructions, and behavior settings.
11+
Agents engage in natural language conversations with users and interact with your {{es}} data through tools.
12+
Fundamentally, an agent is defined by its custom instructions and the set of tools it's assigned.
13+
14+
Each agent manages the conversation flow, interprets user requests, and provides responses based on its configured tools, instructions, and behavior settings.
1415

1516
## How agents work
1617

1718
When you ask a question to an agent, it analyzes your request, selects the most appropriate tool, and determines the right arguments to use. After receiving results, the agent evaluates the information and decides whether to use additional tools or formulate a response. This iterative process of tool selection, execution, and analysis continues until the agent can provide a complete answer.
1819

19-
{{agent-builder}} includes a default agent with access to all system tools. You can create specialized agents with custom instructions and selected tools to address specific use cases or workflows.
20+
{{agent-builder}} includes a default agent (named `Elastic AI Agent`) with access to all built-in tools. You can create specialized agents with custom instructions and selected tools to address specific use cases or workflows.
21+
22+
## Manage your agents
23+
24+
The **Agents** page provides a centralized view of all your agents. From this page you can:
25+
26+
- View all your agents with their names and labels
27+
- Search for specific agents using the search bar
28+
- Filter agents by labels using the **Labels** dropdown
29+
- Create new agents using the **+ New agent** button
30+
- Start chatting with an agent or perform other actions
31+
- **Elastic AI Agent**: you can **chat** or **clone** the default agent using the chat or clone buttons.
32+
:::{image} images/chat-and-clone-buttons.png
33+
:alt: Chat with agent and clone agent buttons
34+
:width: 120px
35+
:::
36+
- **Custom agents**: You can **chat**, **edit**, **clone**, or **delete** an agent from the management overview.
37+
:::{image} images/chat-edit-clone-delete.png
38+
:alt: Agent context menu showing Chat, Edit, Clone, and Delete options
39+
:width: 130px
40+
:::
41+
42+
## How to create a new agent
43+
44+
Follow these steps to create a new agent:
45+
46+
:::::{stepper}
47+
::::{step} Navigate to the Agents page
48+
49+
Navigate to the **Agents** page to access the agent management interface.
50+
51+
::::
52+
53+
::::{step} Create a new agent
54+
55+
Click the **New agent** button to start creating a new agent.
56+
57+
:::{image} images/new-agent-button.png
58+
:alt: Click the New agent button to create a new agent
59+
:width: 150px
60+
:::
61+
62+
63+
::::
64+
65+
::::{step} Configure essential settings
66+
67+
Configure the essential agent settings in the **settings** tab:
68+
69+
1. Enter an **Agent ID**, a unique identifier for reference in code.
70+
1. Add **Custom instructions**.<br><br>Custom instructions are appended to the system prompt that enables core agent features like visualization and citations. The custom instructions define the agent's personality and determine how it will interact with users and perform tasks.
71+
:::{note}
72+
Your custom instructions are added to the system prompt to define the agent's behavior. The system prompt enables core features like visualization and citations.
73+
:::
74+
75+
1. Set the **Display name** that users will see.
76+
1. Add a **Display description** to explain the agent's purpose
77+
78+
::::
79+
80+
::::{step} Assign tools
81+
82+
Switch to the **Tools** tab to assign [tools](tools.md) to your agent.
83+
84+
Select the combination of built-in and custom tools available to the agent, based on your use case.
85+
86+
::::
87+
88+
::::{step} Customize appearance (optional)
89+
90+
Optionally customize the agent's appearance and organization:
91+
92+
- Add **Labels** to organize your agents
93+
- Choose an **Avatar color** and **Avatar symbol** to help visually distinguish the agent
94+
95+
::::
96+
97+
::::{step} Save your changes
2098

21-
## Create a new agent
99+
Click **Save** to create your agent, or **Save and chat** to create the agent and immediately start a conversation with it.
22100

23-
To create a new agent:
101+
:::{image} images/save-and-chat-buttons.png
102+
:alt: Save and Save and chat buttons
103+
:width: 270px
104+
:::
24105

25-
1. Navigate to the Agents subpage under **Chat**
26-
2. Click the **New agent** button in the top right corner
27-
3. Configure the agent settings:
28-
- Enter an **Agent ID** - unique identifier for reference in code
29-
- Add **Custom instructions** (optional) to guide the agent's behavior
30-
- Add **Labels** (optional) to organize your agents
31-
- Set the **Display name** that users will see
32-
- Add a **Display description** to explain the agent's purpose
33-
- Choose an **Avatar color** and **Avatar symbol** (both optional)
34-
4. Switch to the **Tools** tab to assign [tools](tools.md) to the agent
35-
5. Click the **Save** button to create your agent
106+
::::
107+
:::::
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
navigation_title: "Agent Chat UI"
3+
applies_to:
4+
stack: preview 9.2
5+
serverless:
6+
elasticsearch: preview
7+
---
8+
9+
# {{agent-builder}}: Agent Chat UI
10+
11+
12+
The **Agent Chat** UI is the synchronous chat interface for interacting with agents through natural language. The chat UI enables real-time communication where you can ask questions, request data analysis, and receive immediate responses from your configured agents.
13+
Lines changed: 33 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,71 @@
11
---
2+
navigation_title: "Get started"
23
applies_to:
34
stack: preview 9.2
4-
deployment:
5-
self: unavailable
65
serverless:
76
elasticsearch: preview
87
---
98

10-
# Get started
9+
# Get started with {{agent-builder}}
1110

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

14-
{{agent-builder}} is disabled by default. Follow these steps to enable the features and start using Chat.
15-
1613
:::::{stepper}
17-
::::{step} Choose your deployment type
14+
::::{step} Set up an Elastic deployment
1815

19-
- **Option 1:** [{{es}} {{serverless-short}}](/solutions/search/serverless-elasticsearch-get-started.md)
20-
- **Option 2:** [{{ech}}](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md)
16+
If you don't already have an Elastic deployment, refer to [Choose your deployment type](/solutions/search/get-started.md#choose-your-deployment-type).
2117

22-
:::{tip}
23-
Not sure which deployment type to choose? Learn more in [Compare {{ech}} and {{serverless-short}}](/deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings.md).
18+
:::{note}
19+
For {{ech}} deployments, make sure you are using the solution navigation instead of classic navigation.
20+
You can set up a new [space](/deploy-manage/manage-spaces.md) to use the solution nav.
2421
:::
2522

2623
::::
2724

28-
::::{step} Enable features
25+
::::{step} Enable {{agent-builder}}
2926

30-
Choose your preferred method to enable the {{agent-builder}} features.
27+
{{agent-builder}} is disabled by default in the initial release, so you'll need to enable the feature to get started.
3128

32-
::::{tab-set}
29+
You can enable the features using the UI:
3330

34-
:::{tab-item} API
35-
:sync: api
31+
1. Navigate to **Stack Management > Settings**
32+
2. Find **AI > Agent Builder** in the left-hand navigation
33+
3. Toggle **{{agent-builder}}** to on
34+
4. Click **Save changes**
3635

37-
Run the following command in the Dev Tools [Console](/explore-analyze/query-filter/tools/console.md):
36+
Refresh the browser page and find **Agents** in the navigation menu to start using the feature.
37+
You can also search for **Agent Builder** in the [global search bar](/explore-analyze/find-and-organize/find-apps-and-objects.md).
3838

39-
```console
40-
POST kbn://internal/kibana/settings
41-
{
42-
"changes": {
43-
"agentBuilder:enabled": true
44-
}
45-
}
46-
```
4739

48-
:::
40+
::::
4941

50-
:::{tab-item} {{ech}} UI
51-
:sync: stack
52-
```{applies_to}
53-
serverless: unavailable
54-
```
42+
::::{step} Ingest some data
5543

56-
On {{ech}} deployments, you can also enable the features in **Advanced Settings**:
44+
Before you get started with agents, you need some data in your {{es}} cluster. Otherwise, you'll just be chatting to the underlying LLM without any retrieval-augmented context.
5745

58-
1. Access your Kibana settings through **Stack Management > Advanced Settings**.
59-
2. Enable the `agentBuilder` settings:
60-
```json
61-
uiSettings.overrides:
62-
agentBuilder:enabled: true
63-
```
46+
To learn about adding data for search use cases, go to [](/solutions/search/ingest-for-search.md).
47+
For a broader overview of ingestion options, go to [](/manage-data/ingest.md).
6448

49+
:::{tip}
50+
If you're not ready to add your own data, you can use the Elastic [sample data](/manage-data/ingest/sample-data.md) or create small data sets when you follow the instructions in the [quickstarts](/solutions/search/get-started/quickstarts.md).
51+
% TODO: we can link to a an agent builder tutorial if we add one in the docs
6552
:::
6653

6754
::::
6855

69-
::::
70-
7156
::::{step} Start chatting
7257

73-
Refresh the browser page and find **Chat/Conversations** in the navigation menu to start using the feature.
74-
You can also search for **Chat** in the [global search bar](/explore-analyze/find-and-organize/find-apps-and-objects.md).
58+
The **Agent Chat** UI provides a conversational interface where you can interact with agents and explore your data using natural language. {{agent-builder}} includes a default agent named `Elastic AI Agent` with access to all built-in tools, so you can start chatting immediately.
7559

76-
The Chat UI provides a conversational interface where you can interact with agents and explore your data using natural language. Learn more in [Conversations](conversations.md).
60+
Learn more in [Agent Chat](chat.md).
7761

78-
:::{note}
79-
For {{ech}} deployments, make sure you are using the solution navigation instead of classic navigation.
80-
You can set up a new [space](/deploy-manage/manage-spaces.md) to use the solution nav.
81-
:::
8262

8363
::::
64+
65+
::::{step} Start building agents and tools
66+
67+
Once you've tested the built-in **Elastic AI Agent** with the [built-in tools](tools.md#built-in-tools), you'll want to start [building your own agents](agent-builder-agents.md#create-a-new-agent) with custom instructions and creating your own [tools](tools.md) to assign them.
68+
69+
::::
70+
8471
:::::
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
navigation_title: "Kibana APIs"
3+
applies_to:
4+
stack: preview 9.2
5+
serverless:
6+
elasticsearch: preview
7+
---
8+
9+
# Work with {{agent-builder}} using the APIs
10+
11+
These APIs allow you to programmatically work with the {{agent-builder}} abstractions.
12+
13+
## API reference
14+
15+
For the full API documentation, refer to the [Kibana API reference](https://www.elastic.co/docs/api/doc/kibana/).
16+
17+
For information on generating API keys, see [API keys](https://www.elastic.co/docs/solutions/search/search-connection-details).
18+
19+
## Available APIs
20+
% TODO: we may remove this list once the API reference is live, but probably helpful in the short term
21+
22+
### Tools
23+
24+
List all tools
25+
: `GET kbn://api/agent_builder/tools`
26+
27+
Create a tool
28+
: `POST kbn://api/agent_builder/tools`
29+
30+
Get a tool by ID
31+
: `GET kbn://api/agent_builder/tools/{id}`
32+
33+
Delete a tool by ID
34+
: `DELETE kbn://api/agent_builder/tools/{id}`
35+
36+
Update a tool by ID
37+
: `PUT kbn://api/agent_builder/tools/{toolId}`
38+
39+
Execute a tool
40+
: `POST kbn://api/agent_builder/tools/_execute`
41+
42+
### Agents
43+
44+
List all agents
45+
: `GET kbn://api/agent_builder/agents`
46+
47+
Create an agent
48+
: `POST kbn://api/agent_builder/agents`
49+
50+
Get an agent by ID
51+
: `GET kbn://api/agent_builder/agents/{id}`
52+
53+
Update an agent by ID
54+
: `PUT kbn://api/agent_builder/agents/{id}`
55+
56+
Delete an agent by ID
57+
: `DELETE kbn://api/agent_builder/agents/{id}`
58+
59+
### Chat and Conversations
60+
61+
Chat with an agent
62+
: `POST kbn://api/agent_builder/converse`
63+
64+
Chat with an agent and stream events
65+
: `POST kbn://api/agent_builder/converse/async`
66+
67+
List conversations
68+
: `GET kbn://api/agent_builder/conversations`
69+
70+
Get conversation by ID
71+
: `GET kbn://api/agent_builder/conversations/{conversation_id}`
72+
73+
Delete conversation by ID
74+
: `DELETE kbn://api/agent_builder/conversations/{conversation_id}`
75+
76+
### MCP Server
77+
78+
Get MCP server configuration
79+
: `GET kbn://api/agent_builder/mcp`
80+
81+
Create or configure MCP server
82+
: `POST kbn://api/agent_builder/mcp`
83+
84+
Delete MCP server configuration
85+
: `DELETE kbn://api/agent_builder/mcp`
86+
87+
### A2A Protocol
88+
89+
Refer to [](a2a-server.md) for more information.
90+
91+
Get A2A agent card configuration
92+
: `GET kbn://api/agent_builder/a2a/{agentId}.json`
93+
94+
Execute A2A agent task
95+
: `POST kbn://api/agent_builder/a2a/{agentId}`
96+

0 commit comments

Comments
 (0)