install_connector
Install a connector on a project — a pending installation with no credentials yet, which the creator connects from the dashboard.
Mark a project as running a connector. Installing opens a pending installation, the row the Connectors tab shows until the creator connects it; connecting needs a credential typed by a person, so no tool does it. Installing a connector that is already installed changes nothing and returns the existing installation. The REST twin is POST /v1/projects/{project}/connectors/{key}.
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.
Arguments
project_id*stringUUID of the project.
connector*stringThe connector key, as `list_connectors` returns it; only an `installable` card can be installed.
What it returns
{ "data": { "id": "3b8f0c6e-2d41-4a97-9e5f-1c7d6b2a8e40", "connector": "discord", "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13", "scope": "project", "role": "live", "state": "pending", "state_reason": null, "state_detail": null, "creator_actionable": false, "operational": false, "external_id": null, "display_name": null, "handle": null, "avatar_url": null, "health_checked_at": null, "connected_at": null, "verified_at": null, "revoked_at": null, "disconnected_at": null, "uninstalled_at": null, "created_at": "2026-09-12T10:05:00+00:00" }, "meta": {}}How it fails
AUTHENTICATION_REQUIREDno authenticated user on the request.
TOKEN_MISSING_ABILITYtoken lacks project-connector:create.
RESOURCE_NOT_FOUNDthe project is not visible to this token.
CONNECTOR_UNAVAILABLEthe key names no connector creators may install today (its card is not installable).
CONNECTOR_TIER_REQUIREDa second distinct connector on the project, and the project owner's plan lacks multi_connector (Growth).
Events emitted
connector.installedwhen a row is opened (or an uninstalled one brought back).
How is this guide?
Last updated on