v1

latestOpenAPI 3.1.0Apache 2.02026-07-264001921002.3 KB
MCP

List MCP clients

Returns a paginated list of configured MCP clients with their tools and connection state. Supports case-insensitive name search and exact-match filtering by connection type, auth type, code-mode, and enabled/disabled status. Multi-value filters accept a comma-separated list and use OR semantics within a field.

get/api/mcp/clients

Query parameters

limitinteger

Maximum number of clients to return (1–100, default 25).

offsetinteger

Number of clients to skip.

searchstring

Case-insensitive search by client name.

serverstring

Filter to a single client by its exact client_id.

connection_typestring
Example:http,sse

Comma-separated connection types to include (OR semantics).

auth_typestring
Example:oauth,per_user_oauth

Comma-separated auth types to include (OR semantics).

statestring
Example:connected

Comma-separated runtime connection states to include (OR semantics), resolved against live engine state. connected matches clients the engine currently reports as connected; disconnected matches everything else.

all_virtual_keysboolean

When true, include clients that are open to all virtual keys (allow_on_all_virtual_keys). ORs with virtual_keys.

virtual_keysstring

Comma-separated virtual key IDs; includes clients explicitly assigned to any of them. ORs with all_virtual_keys.

code_modeboolean

Filter by code-mode clients. Omit for no filter.

disabledboolean

Filter by disabled status — true returns disabled clients, false returns enabled clients. Omit for no filter.

Response

Successful response

countinteger required

Number of clients returned in this page

total_countinteger required

Total number of clients matching the query (before pagination)

limitinteger required

Page size used for the response

offsetinteger required

Page offset used for the response