Skip to main content
GET
/
api
/
mcp
/
clients
Error
A valid request URL is required to generate request examples
{
  "clients": [
    {
      "config": {
        "client_id": "<string>",
        "name": "<string>",
        "is_code_mode_client": true,
        "connection_string": "<string>",
        "stdio_config": {
          "command": "<string>",
          "args": [
            "<string>"
          ],
          "envs": [
            "<string>"
          ]
        },
        "tls_config": {
          "insecure_skip_verify": true,
          "ca_cert_pem": "<string>"
        },
        "oauth_config_id": "<string>",
        "headers": {},
        "tools_to_execute": [
          "<string>"
        ],
        "tools_to_auto_execute": [
          "<string>"
        ],
        "tool_pricing": {},
        "allow_on_all_virtual_keys": false,
        "per_user_header_keys": [
          "<string>"
        ],
        "disabled": false
      },
      "tools": [
        {
          "name": "<string>",
          "description": "<string>",
          "parameters": {},
          "strict": true
        }
      ],
      "vk_configs": [
        {
          "virtual_key_id": "<string>",
          "virtual_key_name": "<string>",
          "tools_to_execute": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "count": 123,
  "total_count": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Query Parameters

limit
integer
default:25

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

Required range: 1 <= x <= 100
offset
integer

Number of clients to skip.

Required range: x >= 0

Case-insensitive search by client name.

server
string

Filter to a single client by its exact client_id.

connection_type
string

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

Example:

"http,sse"

auth_type
string

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

Example:

"oauth,per_user_oauth"

state
string

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.

Example:

"connected"

all_virtual_keys
boolean

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

virtual_keys
string

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

code_mode
boolean

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

disabled
boolean

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

Response

Successful response

Paginated list of MCP clients.

clients
object[]
required
count
integer
required

Number of clients returned in this page

total_count
integer<int64>
required

Total number of clients matching the query (before pagination)

limit
integer
required

Page size used for the response

offset
integer
required

Page offset used for the response