Get a tool by id

Server: https://{kibana_url}

GET /api/agent_builder/tools/{toolId}
GET /s/{space_id}/api/agent_builder/tools/{toolId}

Refer to Spaces for more information.

Get a specific tool by ID. Use this endpoint to retrieve the complete tool definition including its schema and configuration requirements. To learn more about Agent Builder tools, refer to the tools documentation.

[Required authorization] Route required privileges: agentBuilder:read.

Path Parameters

toolId string required: The unique identifier of the tool to retrieve.

Response

200

Indicates a successful response

application/json

Examples

Example response returning built-in platform.core.search tool

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/agent_builder/tools/{toolId}

curl Shell

curl \
  -X GET "https://${KIBANA_URL}/api/agent_builder/tools/{toolId}" \
  -H "Authorization: ApiKey ${API_KEY}"

Response

{
  "configuration": {},
  "description": "A powerful tool for searching and analyzing data within your Elasticsearch cluster.\nIt supports both full-text relevance searches and structured analytical queries.\n\nUse this tool for any query that involves finding documents, counting, aggregating, or summarizing data from a known index.\n\nExamples of queries:\n- \u0022find articles about serverless architecture\u0022\n- \u0022search for support tickets mentioning \u0027billing issue\u0027 or \u0027refund request\u0027\u0022\n- \u0022what is our policy on parental leave?\u0022\n- \u0022list all products where the category is \u0027electronics\u0027\u0022\n- \u0022show me the last 5 documents from that index\u0022\n- \u0022show me the sales over the last year break down by month\u0022\n\nNote:\n- The \u0027index\u0027 parameter can be used to specify which index to search against.\n If not provided, the tool will decide itself which is the best index to use.\n- It is perfectly fine not to specify the \u0027index\u0027 parameter. It should only be specified when you already\n know about the index and fields you want to search on, e.g. if the user explicitly specified it.",
  "id": "platform.core.search",
  "readonly": true,
  "schema": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "additionalProperties": false,
    "type": "object",
    "properties": {
      "index": {
        "description": "(optional) Index to search against. If not provided, will automatically select the best index to use based on the query.",
        "type": "string"
      },
      "query": {
        "description": "A natural language query expressing the search request",
        "type": "string"
      }
    },
    "required": [
      "query"
    ]
  },
  "tags": [],
  "type": "builtin"
}