Skip to main content
GET
/
api
/
mcp
/
clients
Error
A valid request URL is required to generate request examples
[
  {
    "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>"
        ]
      }
    ]
  }
]

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.

Response

Successful response

​
config
object

Full MCP client configuration (used in responses)

​
tools
object[]
​
state
enum<string>

Connection state of an MCP client:

  • connected: Client is connected and ready to use
  • disconnected: Client is not connected (will be auto-recovered by health monitor)
  • error: Client is in an unrecoverable error state
  • pending_tools: Connected but tools not yet populated (per-user OAuth clients)
  • disabled: Client has been intentionally disabled; no connection or workers are active
Available options:
connected,
disconnected,
error,
pending_tools,
disabled
​
vk_configs
object[]

Virtual key assignments for this MCP client