elasticsearch-esql

Mon, 01 Jan 0001 00:00:00 +0000

About

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.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Elasticsearch

Parameters

name	type	required	description
query	string	false	The ES\|QL query to run. Can also be passed by parameters.
format	string	false	The format of the query. Default is json. Valid values are csv, json, tsv, txt, yaml, cbor, smile, or arrow.
timeout	integer	false	The timeout for the query in seconds. Default is 60 (1 minute).
parameters	parameters	false	List of parameters that will be used with the ES\|QL query. Only supports “string”, “integer”, “float”, “boolean”.

Example

kind: tool
name: query_my_index
type: 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

Tools on MCP Toolbox for Databases

elasticsearch-esql

About

Compatible Sources

Parameters

Example