Skip to main content
GET
List tools
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/tools/list pages active tools by default. Set status=deprecated to read deprecated tools. Optional search, repeated risk, and toolSet filters narrow the page, as do repeated category (internal, external) and source (code, workspace, marketplace, custom, anthropic, template, discovered) values, like the Console’s tool catalog filters. Follow meta.nextCursor while meta.hasMore is true. sort orders the page by name (the default, A to Z), or newest first by createdAt or updatedAt. A cursor is valid only for the sort that issued it; a cursor from another sort is 400 bad_request. There is no usage sort: which agents use a tool is listAgents, and the most used tools are listMostUsed. The catalog read is bounded to 5,000 stored rows. meta.partial is true when that bound is reached or stored rows cannot be projected into the catalog; pagination covers only the returned catalog.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 50
cursor
string
status
enum<string>
default:active
Available options:
active,
deprecated
Minimum string length: 1
risk
enum<string>[]
Available options:
read,
write,
financial,
destructive
toolSet
string
Minimum string length: 1
category
enum<string>[]
Available options:
internal,
external
source
enum<string>[]
Available options:
code,
workspace,
marketplace,
custom,
anthropic,
template,
discovered
sort
enum<string>
default:name
Available options:
name,
createdAt,
updatedAt

Response

Tool list

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.