Skip to main content

Usage

Access this class through the composio.customToolkits property:

Methods

create()

Creates a custom MCP toolkit and returns its generated slug. Experimental — custom toolkits are in pilot; shape may change. Set userId to 'all' to share the toolkit with every user in the project, or to a user ID to make it private to that user. appUrl, authSchemes and userId cannot change later: delete and re-create the toolkit instead. For a private toolkit, connectLink is where to send that user to connect.
Parameters Returns Promise<CustomToolkitCreateResponse> — The toolkit’s slug and, for a private toolkit, a connect link Example

delete()

Deletes a custom toolkit owned by the project, with its tools, auth configs and connected accounts. The credentials behind those connected accounts are revoked in background jobs (revokeJobIds). Experimental — custom toolkits are in pilot; shape may change. Composio-managed toolkits cannot be deleted; the API answers 403.
Parameters Returns Promise<CustomToolkitDeleteResponse> — What was deleted Example

sync()

Re-fetches the tool definitions of a custom toolkit from its remote MCP server. Call it when automatic sync fails or the remote tools change. Experimental — custom toolkits are in pilot; shape may change.
Parameters Returns Promise<CustomToolkitSyncResponse> — The toolkit version and number of tools synced Example

update()

Updates a custom toolkit’s name, logo or API key field copy. Omitted fields keep their current value. Experimental — custom toolkits are in pilot; shape may change. On a project with 2FA enabled, updating a private toolkit requires the userId it is private to.
Parameters Returns Promise<CustomToolkitUpdateResponse> — \{ success: true \} Example

upsert() (deprecated)

DeprecatedUse create() for a new toolkit and update(slug, ...) to change its name, logo or API key field. create() generates the slug, so store the slug it returns.
Creates a custom toolkit, or updates its display metadata (name, API key field copy) when the project already owns a toolkit with this slug. Experimental — custom toolkits are in pilot; shape may change. appUrl and authSchemes cannot change on an existing toolkit: re-sending them unchanged is a no-op, and changing them fails with a 409. Delete and re-register the toolkit instead, which revokes its connections.
Parameters Returns Promise<CustomToolkitUpsertResponse> — The toolkit’s slug Example