---
schema_version: "1"
id: f62770df627aaa20dbe5b12ac0cb504348871b002addc70f9d76d18d1c090910
title: Base Connectivity
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/connector-builder/base-connectivity.md
canonical_url: https://docs.mulesoft.com/connector-builder/base-connectivity
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 7464e96ab8ad2ddef4b1304e13732cd20a2da413c77d9a33c7f1bb1488064450
description: MuleSoft Documentation Site
latest: true
---
---
product: Connector Builder
version: master
---

# Base Connectivity

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Learn how to generate the base connectivity for your connector. Base connectivity is the foundation
of your connector and it defines the basic structure of your connector.

The base connectivity includes:

- `{projectname}-connectivity-model`

  This is the canonical connectivity model (CCM). This package contains the code that directly
  reflects the structure of the API specification from which a project is generated. This is written
  in LinkWeave, and is the base from which all connectors will be built.

- `{projectname}-{platformname}-connector-model`

  This package represents a platform-specific connector (Anypoint Platform or Salesforce Flow) which
  takes the connectivity model as a base and adds customizations and transformations to address
  platform limitations or enhance the user experience. It also contains the `Connector.dwl` file,
  which defines the connector.

You can generate base connectivity either from an API specification (OAS 3.0), AI assistance
(available when using Cursor), or MCP tools (available when using Cursor).

## Generate Base Connectivity from an API Specification

1.  Open the Connector Builder extension in VS Code or Cursor.

2.  Select **New Project**.

3.  Enter the required information in **Project Details**.

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><p><strong>Connector Name</strong></p></td><td><p>Enter a name for your connector. The name must be lowercase, alphanumeric, and contain no spaces. The name can’t exceed 20 characters.</p></td></tr><tr><td><p><strong>Connector Description</strong></p></td><td><p>Enter a description for your connector.</p></td></tr></tbody></table>

4.  Optionally, expand **Advanced Settings** to override the Maven group ID, base package, and
    connector vendor defaults.

5.  Optionally, click **Select Icon** to upload an icon for your project.

6.  In **Connectivity Platforms**, select **Anypoint Platform**, **Salesforce Flow**, or both.

7.  Click **Next**.

8.  Click **Select API Spec** and then select the API specification (OAS 3.0) to upload to create
    your connector.

9.  Click **Open Spec**.

10. Select the API endpoints that you want your project to include.

11. Click **Next**.

12. Select the folder where your project is contained. A subfolder is automatically created within
    this folder.

13. Click **Select Containing Folder**. Your project is created, and VS Code opens the newly created
    project.

## Generate Base Connectivity with AI Assistance (Cursor)

1.  Open the Connector Builder extension in Cursor.

2.  Select **Settings** and ensure **Enable Ai Assisted Workflows** is enabled.

3.  Select **New Project**.

4.  Enter the required information in **Project Details**.

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><p><strong>Connector Name</strong></p></td><td><p>Enter a name for your connector. The name must be lowercase, alphanumeric, and contain no spaces. The name can’t exceed 20 characters.</p></td></tr><tr><td><p><strong>Connector Description</strong></p></td><td><p>Enter a description for your connector.</p></td></tr></tbody></table>

5.  Optionally, expand **Advanced Settings** to override the Maven group ID, base package, and
    connector vendor defaults.

6.  Optionally, click **Select Icon** to upload an icon for your project.

7.  In **Connectivity Platforms**, select **Anypoint Platform**, **Salesforce Flow**, or both.

8.  Click **Next**.

9.  In **Don’t have an API spec?**, click **Generate with AI**.

10. Enter the required information.

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><p><strong>Name of SaaS Platform</strong></p></td><td><p>Enter the name of the SaaS platform you want to create a connector for. The name can’t exceed 20 characters.</p></td></tr><tr><td><p><strong>Top Use Cases</strong></p></td><td><p>Enter the top use cases for the connector, from most important to least important. Use natural language to describe the use cases. Keep the use cases succinct, such as <code>List invoices</code>, <code>Create an invoice</code>, or <code>Create an order</code>. If you want full CRUD (Create, Read, Update, Delete) behavior, you must explicitly mention each one.</p></td></tr><tr><td><p><strong>Links to API Documentation</strong></p></td><td><p>Enter the URLs of the official API documentation or reference sources for the connector.</p></td></tr><tr><td><p><strong>Project Folder</strong></p></td><td><p>Select the root directory of your project. All project files will be created here (a subfolder will not be created in this case).</p></td></tr></tbody></table>

11. Click **Copy Prompt**. This copies a prepared prompt to your clipboard, which you can manually
    paste into the Cursor chat window.

12. Open the Cursor chat window (if not already open) and paste the copied prompt.

13. Optionally (but recommended), copy your provided URLs from the `apiDocs` section of the prompt
    and paste them just before the final line. Be sure to add an `@` symbol in front of each URL so
    that Cursor recognizes them as resources. When done correctly, the URLs are highlighted in blue.

14. Ensure you’re in Agent mode. You can optionally choose which LLM that Cursor sends your prompt
    to.

    > [!NOTE] Connector Builder has been tested with `claude-sonnet-4`. Each model performs
    > differently and might yield different results.

15. Click **Send**.

16. Wait for the agent to complete its work. AI by nature is non-deterministic, so running the same
    prompt multiple times might yield different results each time. The expected outcome is:

    - `{projectroot}/discovery/discovery.json` is generated, capturing the LLM’s recommendations for
      implementing the requested use cases.

    - `{projectroot}/discovery/{saasname}.yaml` is created, containing the discovered endpoints,
      required schemas, and related details.

    - The extension detects the new API specification and automatically generates a project based on
      it. This process may take several seconds.

    - Cursor closes and reopens in the root directory of the newly created project.

## Generate Base Connectivity with MCP Tools (Cursor)

1.  Open the Connector Builder extension in Cursor.

2.  Select **Settings** and ensure **Enable Mcp Tools** is enabled.

3.  Open the Cursor chat window (if not already open).

4.  Ask the agent to create a connector. For example, enter `Create an Eventbrite connector`. This
    calls the `uc_create_connector_workflow` MCP tool, which plans an end-to-end connector build and
    returns a numbered workflow plan for sequential execution.

5.  Enter the required inputs when prompted.

6.  Confirm your inputs. This calls the `uc_manage_api_spec` MCP tool, which researches the API and
    generates the API specification (OAS 3.0). The same tool also supports `type='research'` to
    produce only an `api-reference.md` research artifact, and `type='validate'` to validate an
    existing OpenAPI spec against a live API.

7.  Enter the required inputs when prompted. Note that the connector name can’t exceed 20
    characters.

8.  Confirm your inputs. Review the API specification and make any needed changes. Then, instruct
    the agent to continue.

9.  Enter the required inputs when prompted.

10. Confirm your inputs. This calls the `uc_generate_connector` MCP tool, which generates the
    connector layers. The tool supports multi-phase generation including `ccm` (Canonical
    Connectivity Model), `anypoint` (Anypoint connector module), and `flow` (Flow connector module).
    Your connector is now created.

For more information, see
[MuleSoft DX MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools).
