v2

latestOpenAPI 3.0.02026-08-051996591.2 MB

Tools

List tools

Lists all tools available to the authenticated user. Supports filtering and pagination. Tools represent capabilities that agents can invoke during a session, including built-in system tools and user-defined Lambda tools. Use filters to locate tools by name, type, status, or tool server.

get/v2/tools

Query parameters

filterstring

Example:rag.*

A regular expression against tool names and descriptions to filter the results.

type'mcp' | 'lambda' | 'client'

Example:mcp

Filter tools by type.

enabledboolean

Example:true

Filter tools by enabled status.

categorystring[]

Filter tools by category. Pass one or more category values to include only those categories. When omitted, the response excludes tools in the "experimental" category by default. To include experimental tools, explicitly pass category=experimental.

[
  "retrieval",
  "utilities"
]

tool_server_idstring

Example:tsr_rag_search

Filter tools by the tool server they belong to.

limitinteger

The maximum number of tools to return in the list.

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

List of available tools.

Example response

{
  "tools": [
    {
      "id": "tol_123e4567-e89b-12d3-a456-426614174000",
      "default_output_transform": ".results | map({title, url})",
      "default_input_transform": ".args + { auth: (\"Bearer \" + .agent.secrets.token) }",
      "default_argument_override": {
        "max_results": 10
      },
      "lineage": "corpora_search",
      "version": "2026-02-23",
      "tool_groups": [
        "document_ingestion"
      ],
      "type": "dynamic_vectara"
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}