Getting Started

Learn about Connector Builder prerequisites, installations, and upgrades.

Prerequisites

To create connectors with Connector Builder, your system must meet these prerequisites.

OS Platforms

Your OS must be one of these:

macOS (Intel or Apple Silicon) versions with Apple security update support. This is typically the latest release and the two previous versions.
Windows 10 or 11 (64-bit)

Windows 10 is deprecated on October 14, 2025.

Hardware

Minimum system requirements:
- 10 GB of free storage space
- 8 GB of RAM
Recommended system requirements:
- 20 GB of free storage space
- 16 GB of RAM

Software

Anypoint Connectors

Required software:
- VS Code 1.99.3 and later, or Cursor 1.5.9 and later
  
  Cursor offers several advantages:
  - AI assistance for base connectivity, pagination, generating tests, and running tests
  - MCP tools for base connectivity, connection profiles, operations, pagination, generating tests, packaging connectors, and releasing connectors
- Connector Builder VS Code extension, any version except 1.4.0 (1.4.0 is exclusively for Flow connectors)
- Dependent VS Code extensions
  
  You must have these dependent extensions if you use your connector in Anypoint Code Builder or Anypoint Studio. If you use VS Code, the latest versions of these extensions are automatically installed when you install the Connector Builder extension. If you use Cursor, you must update your user settings, and then install the Connector Builder extension to have the latest versions of these extensions automatically installed. For more information, see Install Connector Builder.
  - Anypoint Code Builder - Platform Extension version 5.7.2 and later
  - Anypoint Code Builder - DataWeave Extension version 2.10.6 and later
  - Anypoint Code Builder - Dependencies Extension version 1.6.0 and later
Recommended software:
- Anypoint Extension Pack
- Anypoint Code Builder - API Extension
- Anypoint Studio or Anypoint Code Builder

Flow Connectors

Customer Requirements

To install and use a custom Flow connector, a customer org needs:

Edition: Enterprise, Unlimited, or Developer.
MuleSoft for Flow add-on, which provides the runtime that executes connector operations. Each operation consumes Automation Credits.
User permissions required to configure a connection and use connectors in Flow:
- To create, view, edit, and delete MuleSoft for Flow: Integration connections: Manage Integration Connections
- To open, edit, create, activate or deactivate a flow using all flow types, elements, and features available in Flow Builder, including Einstein and Agentforce for Flow: Manage Flow
- To create and edit External System Change-Triggered flows in the Automation app, regardless of sharing settings: Manage Flow OR Create or Edit Flows AND View Flows, View All Non-Admin Flows
- To create and edit External System Change-Triggered flows owned by or shared with you with Read/Write access in the Automation app: Create or Edit Flows AND View Flows
- To use MuleSoft for Flow: Integration templates: Create or Edit Flows OR View Flows

Partner Requirements (For ISVs Publishing to AgentExchange)

When you author DataWeave transformations in Connector Builder, follow the guidelines in Secure Coding for Custom Flow Connectors. The AgentExchange Security Review checks for the issues described there, so addressing them during authoring avoids submission rejection later.

To build and deploy a custom Flow connector for AgentExchange, you need:

VS Code 1.99.3 and later, or Cursor 1.5.9 and later

Cursor offers several advantages:
- AI assistance for base connectivity, pagination, generating tests, and running tests
- MCP tools for base connectivity, connection profiles, operations, pagination, generating tests, and packaging connectors
Connector Builder VS Code extension: 1.4.0 (pre-release). This version is exclusively for Flow connectors and is required to build, deploy, and test Flow connectors.
A Dev Hub-enabled org for development and packaging.
Salesforce CLI (sf) installed locally.
The ExternalConnectivity org permission on your scratch org. This permission lets you build, deploy, and test custom Flow connectors in that org.
The MuleSoft for Flow add-on enabled on your dev hub org. The add-on provides the runtime that executes connector operations. Without it, you can deploy the connector metadata but you can’t exercise the connector end-to-end against the external system.
Registration as a partner under the AgentExchange Partner Program and access to Partner Console.

Install Connector Builder

Install Connector Builder in VS Code or Cursor.

Install Connector Builder in VS Code

In VS Code, select the Extensions icon in the Activity Bar.
Search for Connector Builder in the marketplace.
Click Install on the extension.

Install Connector Builder in Cursor

Go to View > Command Palette.
Enter Preferences: Open User Settings.
Go to Features > Extensions > Gallery: Service Url.
Enter https://marketplace.visualstudio.com/_apis/public/gallery.

If you skip this step, you must install the dependent extensions manually.
Restart Cursor.
Go to View > Extensions.
Search for Connector Builder in the marketplace.
Click Install on the extension.

Upgrade Connector Builder

To ensure you’re using the latest version of Connector Builder, select the Connector Builder extension in VS Code or Cursor and then select the Auto Update checkbox.