Management API
Update MCP Server Instance
Update an existing MCP server instance.
PUT
Overview
This endpoint updates an existing MCP server connection, allowing users to modify settings like access type, API key, and enable/disable status.
Prerequisites
- Valid OAuth Token - Bearer token with
mgmt.write
scope - Existing Connection - Valid MCP server connection ID
Request
Path Parameters
Parameter | Type | Required | Description |
---|---|---|---|
server_id | integer | Yes | The MCP server connection ID |
Headers
Header | Type | Required | Description |
---|---|---|---|
Authorization | string | Yes | Bearer token from OAuth authentication |
Content-Type | string | Yes | Must be application/json |
Request Body
Request Fields
Field | Type | Required | Description |
---|---|---|---|
agent_enabled | boolean | No | Whether the connection is enabled for agent use |
access_type | string | No | Access level: “read”, “write”, or “individual” |
api_key | string | No | Updated API key for the integration |
Access Types
read
- Read-only access to integration datawrite
- Full read/write access to integration dataindividual
- Custom access with specific tool selections
Response
Success Response (200 OK)
Response Fields
Field | Type | Description |
---|---|---|
success | boolean | Whether the request was successful |
data.id | integer | Unique identifier for the connection |
data.mcp_server_name | string | Human-readable name of the integration |
data.api_key_verification_status | string | API key validation status after update |
data.oauth2_client_id | string | OAuth2 client ID for MCP server communication |
data.oauth2_scopes | array | OAuth2 scopes granted for this connection |
data.agent_enabled | boolean | Whether the connection is enabled for agent use |
data.disabled_tools | array | List of disabled tool IDs |
data.created_at | string | ISO timestamp when connection was created |
Error Responses
Connection Not Found (404)
Bad Request (400)
Unauthorized (401)
Forbidden (403)
Internal Server Error (500)
Examples
Enable/Disable Connection
Update Access Type
Update API Key
Multiple Updates
Implementation Notes
Partial Updates
- Only provided fields are updated
- Omitted fields retain their current values
- Empty or null values are handled appropriately
API Key Verification
- When
api_key
is updated, verification status resets to “pending” - API key is validated asynchronously against the target integration
- Invalid API keys will be marked as “failed” after verification
Access Type Changes
- Changing access type may affect OAuth scopes
- Tool access permissions are updated accordingly
- Some access type changes may require re-authentication
Database Persistence
- All updates are immediately persisted to the database
- Changes are validated before being applied
- Database constraints are enforced
Related Endpoints
- Get Connection Details - Get current connection information
- Create Connection - Create a new connection
- Delete Connection - Delete a connection
- Get Connection Tools - List available tools
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Example:
"srv_123abc"
Body
application/json
Response
200 - application/json
MCP server connection updated successfully
The response is of type object
.