Skip to content

Update an MCP server

PATCH
/api/workspaces/{workspaceId}/mcp-servers/{id}
curl --request PATCH \
--url http://localhost:8080/api/workspaces/example/mcp-servers/example \
--header 'Content-Type: application/json' \
--cookie auth_session=<auth_session> \
--data '{ "name": "example", "description": "example", "url": "https://example.com", "writeScope": "read", "isActive": true, "toolPolicy": { "defaultRestriction": "always", "restrictions": { "additionalProperty": "always" } } }'
workspaceId
required
string
id
required
string
Media typeapplication/json
object
name
string
>= 1 characters <= 100 characters
description
string
<= 500 characters
url
string format: uri
writeScope
string
Allowed values: read write_safe write_destructive
isActive
boolean
toolPolicy
object
defaultRestriction
string
Allowed values: always ask block
restrictions
object
key
additional properties
string
Allowed values: always ask block

Successful response

Media typeapplication/json
object
success

Whether the request succeeded.

boolean
data

Endpoint-specific response payload.

message
string
error
string

Example

{
"message": "Operation completed",
"error": "Error message"
}

Invalid request

Media typeapplication/json
object
success
boolean
error
string

Example

{
"error": "Error message"
}

Internal server error

Media typeapplication/json
object
success
boolean
error
string

Example

{
"error": "Error message"
}