Skip to main content
PATCH
Update an external MCP server (admin)

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <token>. The token is either a user token / OAuth access token, or a service-account API key (cfk_...). A key is valid on every endpoint and acts as its service account, an organization member with per-store permissions. Refused keys answer 403 with Invalid API key., API key revoked., API key expired. or API key disabled..

Path Parameters

project_id
string<uuid>
required

UUID of the project

id
string<uuid>
required

Body

application/json

Editable fields for a server. url and auth_mode are immutable and cannot be changed after creation. The client secret is write-only.

name
string
is_enabled
boolean
enabled_for_chat
boolean
enabled_for_tasks
boolean
enabled_for_work_with_clara
boolean
enabled_tools
string[]
oauth_client_id
string
oauth_client_secret
string
write-only

Response

Updated

A knowledge-store-level external MCP server registration. Secrets are never returned.

id
string<uuid>
name
string
url
string

Immutable after creation.

auth_mode
enum<string>
Available options:
oauth,
api_key,
none
is_enabled
boolean
enabled_for_chat
boolean

Available to internal playground chat agents (default true).

enabled_for_tasks
boolean

Available to CMA Task agents (default true).

enabled_for_work_with_clara
boolean

Available to Work-with-Clara agents (default true).

tool_catalog
object[]

Synced tools; each is {name, description, annotations, input_schema}.

enabled_tools
string[]

Allowlist of tool names exposed to agents (all disabled by default).

oauth_client_id
string
last_synced_at
string<date-time> | null
last_sync_error
string
source_org_server
string<uuid> | null

The organization server this is a linked copy of.

source_status
object | null

Where a linked copy stands; null for the store's own server.

created_at
string<date-time>