AGagentarea
v1
protected
mcp-server-instances

Update Mcp Server Instance

Changed on
patch/v1/workspaces/{workspace}/mcp-server-instances/{instance_id}

Request

Path parameters

instance_idstring uuid required
workspacestring required

Slug of the workspace the request acts in

Request body

context_secretstring nullable

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.

costobject nullable

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.

descriptionstring nullable
json_specobject
namestring

Response

Successful Response

costobject nullable
created_atstring date-time required
descriptionstring nullable required
eventsobject nullable
idstring uuid required
is_ownerboolean
json_specobject required
last_dispatchobject nullable
managed_bystring nullable
namestring required
personalboolean
server_spec_idstring required
toolsobject[] nullable
transport'url' | 'docker' | 'command' | 'bundle' required

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

updated_atstring date-time required
verificationobject required

Changes

  • 4662804c264bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1d8a3995ec6cRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status