Generated banner for Kibana Agent Builder
Generated logo for Kibana Agent Builder

Kibana Agent Builder

ElasticOfficialCreated by elastic

  • Skill
  • Tool integration
  • Data and AI
  • Apache-2.0
  • No issues found

From the author

Create and manage Kibana Agent Builder agents and custom tools. Use when asked to create, update, delete, test, or inspect agents or tools in Agent Builder, or when the user wants to understand what agents or tools already exist.
— the description by elastic

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The kibana-agent-builder skill provides a structured interface for creating, updating, and managing custom AI agents and tools directly within Kibana. It enables users to ground LLM responses in Elasticsearch data by defining scoped index searches, parameterized ES|QL queries, and workflow integrations. The skill emphasizes a discovery-first approach, requiring users to list existing resources before performing write operations to ensure system integrity and avoid configuration conflicts.

What it does

  • Lists existing agents and custom tools to prevent duplicate resource creation.
  • Creates custom index search tools scoped to specific index patterns.
  • Defines parameterized ES|QL tools for fixed analytics and trend reporting.
  • Configures AI agents with custom instructions and curated toolsets.
  • Supports CRUD operations for both agents and tools via the elastic CLI.
  • Executes and validates tools to ensure correct query behavior before deployment.

When to use it

  • When you need to create a new AI agent grounded in specific Elasticsearch data.
  • When you want to define reusable tools for agents to perform searches or analytics.
  • When you need to inspect or modify existing agent configurations or tool definitions.
  • When you need to verify the existence of agents or tools before performing updates.

Advantages

  • Ensures agents are grounded in real-time data rather than relying on LLM memory.
  • Reduces noise and token costs by scoping index searches to specific patterns.
  • Provides a consistent, repeatable process for managing AI resources in Kibana.
  • Allows for complex analytics through parameterized ES|QL tool definitions.

Usage examples

“What agents are currently configured in Agent Builder?”
The agent will list all existing agents by ID and name, providing a clear overview of the current environment.
“Create a new tool to search the logs-app-* index.”
The agent will verify if the tool exists, then create an index_search tool scoped to the specified pattern.
“Create a sales-helper agent using the esql-sales-data tool.”
The agent will confirm the tool exists, check for agent name conflicts, and register the new agent with the specified toolset.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/elastic/kibana-agent-builder/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip kibana-agent-builder.zip -d .agents/skills

Documentation by elastic

Kibana Agent Builder

Create, inspect, update, delete, and test Agent Builder tools and agents. Ground LLM responses in Elasticsearch data through scoped search tools, parameterized ES|QL, and workflow integrations.

<!-- begin-partial: preamble -->

Environment Configuration

This skill executes Elasticsearch operations through the elastic CLI. If the elastic CLI is not installed, tell the user what it is needed for. Do not guess credentials, call the HTTP API directly, or attempt other workarounds.

This skill references operations in HTTP-shorthand form (e.g., GET /, GET /_cat/indices, GET /{index}/_mapping, GET /{index}/_settings/index.mode, POST /_query). The Operations table at the end of this document maps each shorthand to the equivalent elastic CLI command — always use the CLI rather than calling the HTTP API directly.

<!-- end-partial: preamble -->

Resource model

Agent Builder exposes three distinct resource kinds — do not conflate them:

KindPurposeTypical API
ToolReusable function an agent invokes to retrieve or act on data (index_search, esql, workflow)POST kbn:/api/agent_builder/tools
AgentLLM entity with instructions and a curated toolsetPOST kbn:/api/agent_builder/agents
Chat / conversationEphemeral messaging session with an existing agentPOST kbn:/api/agent_builder/converse/async

Creating a tool does not create an agent. Listing or chatting with an agent does not create a tool. When the user asks to "create an agent" or "create a tool," identify which resource they mean before calling a write API.

Built-in tools use the platform.core.* prefix (for example platform.core.search). Custom tools and agents are user-defined. Read architecture-guide.md for built-in tool inventory, context engineering, and security notes.

Process

  1. Classify the task. Decide whether the user needs a tool, an agent, or chat with an existing agent. If they ask what already exists ("what agents are there?", "list agents"), treat the request as read-only discovery — answer from live data before proposing any create, update, or delete.

  2. Discover existing resources before any write. When creating or updating:

    • Call GET kbn:/api/agent_builder/tools to list available tools (built-in and custom). Do not invent tool IDs.

    • Call GET kbn:/api/agent_builder/agents to list existing agents and avoid duplicate IDs or names.

    When the user only asks what agents exist, stop after GET kbn:/api/agent_builder/agents. Enumerate each agent's id and name. If the list is empty, say so plainly — do not fabricate agents. Only proceed to creation when the user explicitly asks to create one and you have confirmed the target id is unused.

  3. Choose the tool type (for tool tasks). Match intent to the narrowest tool type:

    • Open-ended search over a known index pattern → index_search with a specific pattern (for example customer-feedback-*), never * or all-indices scope unless the user explicitly requires it.

    • Fixed analytics, aggregations, or parameterized queries → esql with ?param placeholders and a params object (use {} when there are no parameters).

    • Multi-step automation beyond retrieval → workflow referencing an existing workflow id.

    For ES|QL syntax and query design, follow the elasticsearch-esql skill. For workflow YAML, follow the kibana-workflows skill.

  4. Build the tool payload. Required fields: id, type, description, configuration. Optional: tags.

    API constraints (violations return 400):

    • POST accepts only id, type, description, configuration, tags. name is not valid on tools.

    • Index search configuration uses "pattern", not "index".

    • ES|QL tools require "params" even when empty: "params": {}.

    • Each param accepts only type and description — not default or optional. Hard-code defaults in the query.

    • PUT on tools accepts only description, configuration, and tags. id and type are immutable.

    Index search example (scoped pattern):

    {
      "id": "customer_feedback_search",
      "type": "index_search",
      "description": "Searches customer feedback and support tickets in the customer-feedback indices.",
      "configuration": {
        "pattern": "customer-feedback-*"
      }
    }

    ES|QL example (parameterized, with LIMIT):

    {
      "id": "feedback_sentiment_trend",
      "type": "esql",
      "description": "Returns positive vs negative feedback counts by product category over a lookback window.",
      "configuration": {
        "query": "FROM customer-feedback-* | WHERE @timestamp >= NOW() - ?lookback_days::integer * 1d | STATS positive = COUNT(*) WHERE sentiment == \"positive\", negative = COUNT(*) WHERE sentiment == \"negative\" BY product_category | SORT negative DESC | LIMIT 20",
        "params": {
          "lookback_days": {
            "type": "integer",
            "description": "Number of days to look back, e.g. 7, 30, 90"
          }
        }
      }
    }
  5. Create and verify the tool. Call POST kbn:/api/agent_builder/tools with the payload. Confirm success by calling GET kbn:/api/agent_builder/tools/{toolId} and reporting the created id, type, description, and configuration back to the user — do not claim success without a live API response.

    Optionally validate ES|QL tools with POST kbn:/api/agent_builder/tools/_execute, passing tool_id and tool_params. Always include | LIMIT N in ES|QL queries to control token use.

  6. Build the agent payload (for agent tasks). Required fields: id, name, description, configuration. Configuration must include instructions and a tools array with tool_ids drawn from Step 2 — only IDs returned by GET kbn:/api/agent_builder/tools.

    Derive a stable id from the name (lowercase, hyphens, alphanumeric). Check Step 2's agent list for conflicts before posting.

    {
      "id": "customer-feedback-agent",
      "name": "Customer Feedback Analyst",
      "description": "Analyzes customer sentiment and feedback trends.",
      "configuration": {
        "instructions": "Always use tools to retrieve data. Never answer data questions from memory.",
        "tools": [
          {
            "tool_ids": ["customer_feedback_search", "platform.core.search"]
          }
        ]
      }
    }

    Agent update constraints: PUT accepts only description, configuration, and tags (plus avatar/labels when applicable). Do not send immutable fields like id, name, or type on update — they cause 400 errors.

  7. Create and verify the agent. Call POST kbn:/api/agent_builder/agents. Confirm with GET kbn:/api/agent_builder/agents or GET kbn:/api/agent_builder/agents/{agentId}. Report the live response.

  8. Update or delete (when requested). Confirm destructive actions with the user first.

    • Update tool: PUT kbn:/api/agent_builder/tools/{toolId}

    • Delete tool: DELETE kbn:/api/agent_builder/tools/{toolId}

    • Update agent: PUT kbn:/api/agent_builder/agents/{agentId}

    • Delete agent: DELETE kbn:/api/agent_builder/agents/{agentId}

  9. Chat (when requested). Chat is not agent or tool creation. Use POST kbn:/api/agent_builder/converse/async with an existing agent_id and user input. Expect multi-step reasoning and tool calls; allow sufficient time for streaming completion.

Guidelines

  • Discover before create. Always list agents (and tools when relevant) before creating resources. When asked "what agents exist?", answer that question first — read-only — even if the user also mentions wanting a new agent later.

  • Scope index search narrowly. Prefer customer-feedback-* over *. Broad patterns increase noise, token cost, and RBAC surface area.

  • Write descriptive tool descriptions. The agent selects tools based on descriptions alone — include when to use each tool and example trigger phrases.

  • Minimize toolsets. Every assigned tool adds tokens to the agent system prompt on every turn.

  • Validate ES|QL before deployment. Execute the tool after creation when parameters or query shape are non-trivial.

  • Use aggregations and KEEP. Prefer summary stats over raw document dumps for analytics questions.

Examples

Create an index search tool (eval pattern)

User: "Create a custom Agent Builder tool that searches the customer-feedback-* index. Use the tool id 'eval-feedback-search'."

  1. List tools — confirm eval-feedback-search does not already exist.

  2. Choose index_search scoped to customer-feedback-* (not *).

  3. POST the tool with id, description, and configuration.pattern.

  4. GET the tool by id and confirm creation to the user.

Answer "what agents already exist?" before creating

User: "I want to create a new agent in Kibana Agent Builder. What agents already exist?"

  1. Call GET kbn:/api/agent_builder/agents — read-only.

  2. Enumerate existing agent ids and names (or state that none exist).

  3. Do not create, update, or delete anything in this step.

  4. Only if the user then asks to create, pick an unused id informed by the list above.

Create an agent after discovery

User: "Create a sales-helper agent using the esql-sales-data tool."

  1. List tools — confirm esql-sales-data exists.

  2. List agents — confirm no conflicting id.

  3. POST agent with instructions and selected tool IDs.

  4. GET agent to verify and report back.

References

  • architecture-guide.md — Built-in tools, context engineering, token optimization, MCP/A2A integration, permissions

  • use-cases.md — Playbooks for customer feedback, marketing campaign, and contract analysis agents with example tool and agent payloads

Operations

HTTP API (shorthand)elastic CLI command
GET kbn:/api/agent_builder/toolselastic kb agent-builder get-agent-builder-tools
POST kbn:/api/agent_builder/toolselastic kb agent-builder post-agent-builder-tools --id '<id>' --type '<type>' --description '<desc>' --configuration '<json>'
GET kbn:/api/agent_builder/tools/{toolId}elastic kb agent-builder get-agent-builder-tools-toolid --tool-id '<toolId>'
PUT kbn:/api/agent_builder/tools/{toolId}elastic kb agent-builder put-agent-builder-tools-toolid --tool-id '<toolId>' [--description '<desc>'] [--configuration '<json>']
DELETE kbn:/api/agent_builder/tools/{toolId}elastic kb agent-builder delete-agent-builder-tools-toolid --tool-id '<toolId>' [--force]
POST kbn:/api/agent_builder/tools/_executeelastic kb agent-builder post-agent-builder-tools-execute --tool-id '<toolId>' --tool-params '<json>'
GET kbn:/api/agent_builder/agentselastic kb agent-builder get-agent-builder-agents
POST kbn:/api/agent_builder/agentselastic kb agent-builder post-agent-builder-agents --id '<id>' --name '<name>' --description '<desc>' --configuration '<json>'
GET kbn:/api/agent_builder/agents/{agentId}elastic kb agent-builder get-agent-builder-agents-id --id '<agentId>'
PUT kbn:/api/agent_builder/agents/{agentId}elastic kb agent-builder put-agent-builder-agents-id --id '<agentId>' [--description '<desc>'] [--configuration '<json>']
DELETE kbn:/api/agent_builder/agents/{agentId}elastic kb agent-builder delete-agent-builder-agents-id --id '<agentId>'
POST kbn:/api/agent_builder/converse/asyncelastic kb agent-builder post-agent-builder-converse-async --agent-id '<agentId>' --input '<message>'

Files

LICENSE

                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright 2026 Elasticsearch BV

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
elastic
Publisher
Elastic (Official)
Source
elastic/agent-skills · skills/kibana/kibana-agent-builder · commit 09d879d
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced
Also distributed in
elastic/agent-skills

AutoGineer is not affiliated with or endorsed by elastic.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download kibana-agent-builder.zip