Skip to content

Update an MCP-client server registration

PATCH
/admin/ai/mcp-clients/{id}

Partial update — only the supplied fields mutate. Use this to flip enabled, change the URL after the server moves, rotate auth secrets, etc.

Requires mcp.client.admin.

id
required
string format: uuid

Partial-update payload for PATCH /admin/ai/mcp-clients/{id}. Omitted fields keep their existing value. Health-check fields are owned by the per-server poller and not editable here.

object
url
string
>= 1 characters
transport
string
Allowed values: http stdio
auth_kind
string
Allowed values: none bearer header mtls
auth_secret_ref
string
auth_header_name
string
privacy_class
string
Allowed values: local cloud
enabled
boolean
rate_limit_per_second
integer
>= 1
rate_limit_per_minute
integer
>= 1
health_check_interval_s
integer
>= 1

Updated

One registered MCP server. Each registration becomes one ai.Provider in the router; the operator-chosen name is the audit-dashboard identifier and the dispatcher slot key.

object
id
required
string format: uuid
name
required
string
>= 1 characters <= 128 characters
url
required
string
>= 1 characters
transport
required
string
Allowed values: http stdio
auth_kind
required
string
Allowed values: none bearer header mtls
auth_secret_ref
string
nullable
auth_header_name
string
nullable
privacy_class
required
string
Allowed values: local cloud
enabled
required
boolean
rate_limit_per_second
required
integer
>= 1
rate_limit_per_minute
required
integer
>= 1
health_check_interval_s
required
integer
>= 1
last_health_check_at
string format: date-time
nullable
last_health_status
string
nullable
Allowed values: healthy degraded unreachable
last_health_error
string
nullable
created_at
required
string format: date-time
updated_at
required
string format: date-time

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed