elasticsearch-esql

Execute ES|QL queries.

elasticsearch-esql

Execute ES|QL queries.

This tool allows you to execute ES|QL queries against your Elasticsearch cluster. You can use this to perform complex searches and aggregations.

See the official documentation for more information.

Example

tools:  query_my_index:  kind: elasticsearch-esql  source: elasticsearch-source  description: Use this tool to execute ES|QL queries.  query: |  FROM my-index  | KEEP *  | LIMIT ?limit  parameters:  - name: limit  type: integer  description: Limit the number of results.  required: true 

Parameters

nametyperequireddescription
querystringfalseThe ES|QL query to run. Can also be passed by parameters.
formatstringfalseThe format of the query. Default is json. Valid values are csv, json, tsv, txt, yaml, cbor, smile, or arrow.
timeoutintegerfalseThe timeout for the query in seconds. Default is 60 (1 minute).
parametersparametersfalseList of parameters that will be used with the ES|QL query.
Only supports “string”, “integer”, “float”, “boolean”.
Last modified November 7, 2025: chore(main): release 0.19.1 (#1901) (cd8d68d)