update_connector_installation_settings
Change a project's connector installation settings, validated against the fields the connector declares.
Write the settings a connector declares for its installations. settings is an object keyed by the field names in the connector's settings_fields (read them with get_connector); every declared rule runs, a key the connector never declared is refused, and fields left out keep their value. The installation is returned without its settings, because a settings field may be a secret. The REST twin is PATCH /v1/projects/{project}/connectors/{key}/installation/settings.
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same action as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Fires one event
Delivered to every endpoint subscribed to it once the change is made.
Annotations
Sending the same arguments twice changes nothing the second time.
Arguments
project_id*stringUUID of the project.
connector*stringThe connector key, as `list_connectors` returns it.
settingsobjectoptionalThe fields to change, keyed by the names the connector declares in `settings_fields`; fields left out keep their value. Optional when `capabilities` is given.
capabilitiesobjectoptionalCapability switches to change, keyed by capability value (`messaging`, `broadcasts`, `support_relay`, `native_payments`, `recovery_*`) to true or false; switches left out keep their value. Optional when `settings` is given.
What it returns
The installation, as get_connector_installation renders it, capabilities included: every capability the connector declares with enabled and toggleable. Settings are never serialised.
How it fails
AUTHENTICATION_REQUIREDno authenticated user on the request.
TOKEN_MISSING_ABILITYtoken lacks project-connector:update.
RESOURCE_NOT_FOUNDthe project is not visible to this token, or context.reason is unknown_connector.
CONNECTOR_NOT_INSTALLEDthe project has no installation of the connector.
VALIDATION_FAILEDa key the connector does not declare, a declared rule failed, a capability it does not declare or cannot switch off, a switch that is not true or false, or neither settings nor capabilities given; context names the field or the capability.
Events emitted
connector.settings_updatednaming the fields and the switches (capabilities.<key>) that changed, only when something did.
How is this guide?
Last updated on