Updates the name, description, or configuration of a custom MCP. Changing the configuration redeploys the service.
Endpoint
POST /api/v1/mcp/servers/{mcpCode}
Supports custom MCP only. Changing only the name or description does not redeploy the service. Submitting mcp_type and mcp_config together replaces the configuration and redeploys the service.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| mcpCode | string | Yes | MCP code |
| Field | Type | Required | Description |
|---|---|---|---|
| server_name | string | No | New name. Cannot be blank |
| description | string | No | New description. Cannot be blank |
| mcp_type | string | No | New service type. Must be submitted with mcp_config |
| mcp_config | object | No | New configuration. Must be submitted with mcp_type. Replaces the existing configuration entirely |
400.
Response
Returns a CreateResponse. Unassigned fields are omitted. When only the name or description is changed, status fields are not returned.
| Field | Type | Description |
|---|---|---|
| mcp_code | string | MCP code |
| server_name | string | Updated name |
| server_status | string | Redeployment status. Returned only when the configuration changes |
| server_status_text | string | Status text. Returned only when the configuration changes |
| activate_fail_reason | string | Deployment failure reason. Returned only when deployment fails |
Examples
Change the name and description
Change the configuration
Errors
| HTTP status | error_code | Description |
|---|---|---|
| 400 | InvalidParameter | The request body is empty, or mcp_type and mcp_config are not submitted together |
| 400 | OperationNotSupported | The service is an official MCP, or the service is running or deploying |
| 404 | McpServerNotFound | The MCP service does not exist or does not belong to the current workspace |
| 409 | McpServerBusy | Another operation is running on the MCP service |