Skip to main content
PATCH
Update Mcp Server Instance

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

instance_id
string<uuid>
required
workspace
string
required

Slug of the workspace the request acts in

Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json

Patch payload for an MCP server instance. All fields optional — unset = unchanged.

context_secret
string | null

URL instances only. Shared secret (at least 32 characters) AgentArea signs each tool call's context token with, so the server can trust which task, workspace and end user the call is for. Write-only: stored in the secret manager; the instance's json_spec shows context_signing: true instead. Send null to remove it.

Required string length: 32 - 512
cost
Cost · object | null

What a call of this connection costs, set by a member on a connection the workspace pays for: a rate (per call or per unit), a field of the response, or free (wiki ADR-0038 §2.3). It wins over the connector's declaration. Send null to go back to the connector's.

description
string | null
json_spec
Json Spec · object
name
string
Required string length: 1 - 255

Response

Successful Response

created_at
string<date-time>
required
description
string | null
required
id
string<uuid>
required
json_spec
Json Spec · object
required
name
string
required
server_spec_id
string
required
transport
enum<string>
required

How a connection is reached: the instance's transport column, set once at creation.

Available options:
url,
docker,
command,
bundle
updated_at
string<date-time>
required
verification
Verification · object
required
auth_config_id
cost
Cost · object | null
events
Events · object | null
last_dispatch
Last Dispatch · object | null
managed_by
string | null
tools
Tools · object[] | null