--- schema_version: "1" id: aa228d6323c718080a9ba5c138f7290e38c53e69c72fecfb529998f3e983e356 title: Getting Started collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/connector-builder/getting-started.md canonical_url: https://docs.mulesoft.com/connector-builder/getting-started source_site: docs.mulesoft.com content_type: documentation content_hash: 37e7a9605b6ab421af28037b51927931fff007c2a5f4dc522b22dd8df562690e description: MuleSoft Documentation Site latest: true --- --- product: Connector Builder version: master --- # Getting Started > For the full documentation index, see: https://docs.mulesoft.com/llms.txt 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) > [!NOTE] Windows 10 is deprecated on > [October 14, 2025](https://support.microsoft.com/en-us/windows/windows-10-support-has-ended-on-october-14-2025-2ca8b313-1946-43d3-b55c-2b95b107f281). ### 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](https://code.visualstudio.com/download) 1.99.3 and later, or [Cursor](https://cursor.com/docs) 1.5.9 and later Cursor offers several advantages: - AI assistance for [base connectivity](https://docs.mulesoft.com/connector-builder/base-connectivity#generate-base-connectivity-with-ai-assistance), [pagination](https://docs.mulesoft.com/connector-builder/pagination#define-pagination-with-ai-assistance), [generating tests](https://docs.mulesoft.com/connector-builder/testing-connectors#generate-tests-with-ai-assistance), and [running tests](https://docs.mulesoft.com/connector-builder/testing-connectors#run-tests-with-ai-assistance) - MCP tools for [base connectivity](https://docs.mulesoft.com/connector-builder/base-connectivity#generate-base-connectivity-with-mcp-tools), [connection profiles](https://docs.mulesoft.com/connector-builder/connections#list-connection-profiles-with-mcp-tools), [operations](https://docs.mulesoft.com/connector-builder/operations#manage-operations-with-mcp-tools), [pagination](https://docs.mulesoft.com/connector-builder/pagination#define-pagination-with-mcp-tools), [generating tests](https://docs.mulesoft.com/connector-builder/testing-connectors#generate-tests-with-mcp-tools), [packaging connectors](https://docs.mulesoft.com/connector-builder/packaging-connectors#package-connectors-with-mcp-tools), and [releasing connectors](https://docs.mulesoft.com/connector-builder/releasing-connectors#release-connectors-to-anypoint-platform-with-mcp-tools) - [Connector Builder VS Code extension](https://marketplace.visualstudio.com/items?itemName=salesforce.connectivity-tooling-ic-vscode-extension&ssr=false#version-history), any version except 1.4.0. Connector Builder 1.4.0 was a pre-release for Flow connectors only. - 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](#install-uc-builder). - [Anypoint Code Builder - Platform Extension](https://marketplace.visualstudio.com/items?itemName=salesforce.mule-dx-vscode) version 5.7.2 and later - [Anypoint Code Builder - DataWeave Extension](https://marketplace.visualstudio.com/items?itemName=salesforce.mule-dx-data-weave-client) version 2.10.6 and later - [Anypoint Code Builder - Dependencies Extension](https://marketplace.visualstudio.com/items?itemName=salesforce.mule-dx-dependencies) version 1.6.0 and later - Recommended software: - [Anypoint Extension Pack](https://marketplace.visualstudio.com/items?itemName=salesforce.mule-dx-extension-pack) - [Anypoint Code Builder - API Extension](https://marketplace.visualstudio.com/items?itemName=salesforce.mule-dx-api-component) - 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) > [!NOTE] When you author DataWeave transformations in Connector Builder, follow the guidelines in > [Secure Your Flow Connectors](https://developer.salesforce.com/docs/atlas.en-us.packagingGuide.meta/packagingGuide/secure_code_secure_your_flow_connectors.htm?_gl=1*1uebz97*_gcl_au*MTM3MjI0OTYwMi4xNzgyNzQ1NDg1&_ga=2.125517833.262923442.1782745486-378704745.1773886412). > 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](https://code.visualstudio.com/download) 1.99.3 and later, or [Cursor](https://cursor.com/docs) 1.5.9 and later Cursor offers several advantages: - AI assistance for [base connectivity](https://docs.mulesoft.com/connector-builder/base-connectivity#generate-base-connectivity-with-ai-assistance), [pagination](https://docs.mulesoft.com/connector-builder/pagination#define-pagination-with-ai-assistance), [generating tests](https://docs.mulesoft.com/connector-builder/testing-connectors#generate-tests-with-ai-assistance), and [running tests](https://docs.mulesoft.com/connector-builder/testing-connectors#run-tests-with-ai-assistance) - MCP tools for [base connectivity](https://docs.mulesoft.com/connector-builder/base-connectivity#generate-base-connectivity-with-mcp-tools), [connection profiles](https://docs.mulesoft.com/connector-builder/connections#list-connection-profiles-with-mcp-tools), [operations](https://docs.mulesoft.com/connector-builder/operations#manage-operations-with-mcp-tools), [pagination](https://docs.mulesoft.com/connector-builder/pagination#define-pagination-with-mcp-tools), [generating tests](https://docs.mulesoft.com/connector-builder/testing-connectors#generate-tests-with-mcp-tools), and [packaging connectors](https://docs.mulesoft.com/connector-builder/packaging-connectors#package-connectors-with-mcp-tools) - [Connector Builder VS Code extension](https://marketplace.visualstudio.com/items?itemName=salesforce.connectivity-tooling-ic-vscode-extension&ssr=false#version-history), version 1.4.0 and later. - 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 1. In VS Code, select the Extensions icon in the Activity Bar. 2. Search for `Connector Builder` in the marketplace. 3. Click **Install** on the extension. ### Install Connector Builder in Cursor 1. Go to **View** > **Command Palette**. 2. Enter `Preferences: Open User Settings`. 3. Go to **Features** > **Extensions** > **Gallery: Service Url**. 4. Enter `https://marketplace.visualstudio.com/_apis/public/gallery`. > [!NOTE] If you skip this step, you must install the dependent extensions manually. 5. Restart Cursor. 6. Go to **View** > **Extensions**. 7. Search for `Connector Builder` in the marketplace. 8. 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.