Bank ConnectionsWriteDo not retry automatically
Create bank link
create_bank_linkInitiate a new bank connection for any supported provider. Pass a providerInstanceId (e.g. "plaid:us") to start the flow. Returns a ConnectionStart payload (Plaid Link token, portal popup URL, or OAuth redirect URL). The expectedPayloadKind field tells you what to pass to connect_bank. Use search_institutions first.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
providerInstanceId | string | required | Canonical provider instance ID, e.g. "plaid:us", "saltedge:uk" (UK), "saltedge:sandbox" (fake banks, non-prod), "saltedge:eu" (EEA — Germany, France, Spain, and 27 more), "snaptrade:default". Use search_institutions to find the right one. |
email | string | optional | User email address — required for SnapTrade and SaltEdge workspace registration. Not needed for Plaid. |
institutionId | string | optional | Pre-select a specific institution by provider ID (a way's providerInstitutionId from search_brands / get_brand). Omit to let the user search, or when the way's targeting is 'picker'. |
brandId | string | optional | The bank this connection is for, as returned by search_brands / get_brand (`key`). Required for a way whose targeting is 'picker' (it has no providerInstitutionId): the provider's own picker opens on its search and the user picks the bank there. Harmless alongside institutionId. |
countryCodes | string[] | optional | ISO 3166-1 alpha-2 country codes to scope the connection, e.g. ["AU"] or ["US"] |
redirectUri | string | optional | OAuth redirect URI for redirect-based flows |
brokerageSlug | string | optional | SnapTrade: brokerage slug to pre-select in the portal (skips the picker step) |
connectionType | "read" | "trade" | optional | SnapTrade: initial connection scope — defaults to "read" |
Example call
The tool call an MCP client sends (required arguments shown with placeholder values).
{"tool": "create_bank_link","arguments": {"providerInstanceId": "providerInstanceId_123"}}
Use this tool in
Claude CodeClaude DesktopClaude CoworkChatGPTCursorWindsurfVS Code CopilotOpenClawGeminiGrokMeta MuseHermes Agent