Contact Us 1-800-596-4880
  1. Homepage
  2. MuleSoft MCP Servers

  3. Getting Started with MuleSoft DX MCP Server

Getting Started with MuleSoft DX MCP Server

MuleSoft DX MCP Server enables AI-powered development assistants in your IDE to interact with Anypoint Platform, helping you manage APIs, applications, and platform resources directly from your coding environment. Install prerequisites, create a connected app with the scopes your tools require, and register the server in the IDE so assistants can call Anypoint Platform with your environments and identities.

If you have Anypoint Code Builder or Connector Builder, MuleSoft DX MCP Server is already installed and configured in MuleSoft Vibes. For more information, see Creating API Specs with MuleSoft Vibes and Connector Builder Overview.

Before You Begin

Before you install and use MuleSoft DX MCP Server, ensure you have installed the following software:

  • Anypoint Extension Pack version 1.10.0 or later

  • Git

  • Node.js 20 or later. Download Node.js.

You also need permissions or access to perform these tasks:

Create a Connected App

Follow the steps in Create a Connected App That Acts on Its Own Behalf to create a connected app. Note the Client ID and Client Secret, as you need these to configure MuleSoft DX MCP Server in your IDE.

Additionally, when prompted, add the following permission scopes. These scopes enable you to use specific MuleSoft DX MCP Server tools.

Refer to the MuleSoft DX MCP Server Tool Reference for details on all MuleSoft DX MCP Server tools. Only tools listed in these tables require specific permission scopes.

Anypoint Code Builder

To…​ Required Permission Associated Tool

Use natural language prompts to develop and generate flows using Anypoint Code Builder Generative Flows.

Mule Developer Generative AI User
create:generations

Anypoint Monitoring

To…​ Required Permission Associated Tool

View but not modify content in Anypoint Monitoring.

Monitoring Viewer
view:monitoring

API Manager

To…​ Required Permission Associated Tool

View and modify API configurations in the specified environment.

Manage API Configuration
manage:api_configuration

create_and_manage_api_instances

View, create, modify, and delete API policies in the specified environment.

Manage Policies
manage:api_policies

manage_api_instance_policy

View API configurations in the specified environment.

View APIs Configuration
read:api_configuration

Exchange

To…​ Required Permission Associated Tool

  • View, create, and download assets within a business group.

  • Edit asset portal content in an existing asset version.

Exchange Administrator
manage:exchange

create_and_manage_assets

View, create, and download assets within a business group.

Exchange Contributor
edit:exchange

create_and_manage_assets

Create new assets within a business group’s catalog.

Exchange Creator
create:exchange

create_and_manage_assets

View and download assets within a business group.

Exchange Viewer
read:exchange

General

To…​ Required Permission Associated Tool

View organization information.

View Organization
read:organization

View connected applications.

View Connected Applications
read:orgconnapps

Runtime Manager

To…​ Required Permission Associated Tool

View applications in a specific environment.

Read Applications
read:applications

list_applications

Create applications in a specific environment.

Create Applications
create:applications

Query Runtime Fabric instances in the organization.

Read Runtime Fabrics
read:runtime_fabrics

View CloudHub and CloudHub 2.0 network resources.

CloudHub Network Viewer
read:cloudhub_networking

Usage

To…​ Required Permission Associated Tool

View usage reports.

Usage Viewer
view:metering

Install MuleSoft DX MCP Server

Install MuleSoft DX MCP Server and then configure it in your IDE by adding the appropriate configuration snippet with your connected app credentials.

To install with Node.js, run: npm install -g mulesoft-mcp-server.

Configure Your IDE

You can configure Claude Desktop, Cursor, Windsurf, Zed, and other IDEs to work with the MuleSoft DX MCP Server. After you add the configuration, verify it by checking that the server has started in the MCP section of your IDE.

For more information about Anypoint Platform regions, see Control Plane Hosting Options.

Claude Desktop

Add this snippet to claude_desktop_config.json where ANYPOINT_REGION (optional) is one of these values: PROD_US, PROD_EU, PROD_CA, or PROD_JP.

{
  "mcpServers": {
    "mulesoft": {
      "command": "npx",
      "args": ["-y", "mulesoft-mcp-server", "start"],
      "env": {
        "ANYPOINT_CLIENT_ID": "<YOUR_CLIENT_ID>",
        "ANYPOINT_CLIENT_SECRET": "<YOUR_CLIENT_SECRET>",
        "ANYPOINT_REGION": "<REGION_NAME>"
      }
    }
  }
}

Download Claude Desktop.

Cline

Add this snippet to Cline config.json where ANYPOINT_REGION (optional) is one of these values: PROD_US, PROD_EU, PROD_CA, or PROD_JP.

{
  "mcpServers": {
    "mulesoft": {
      "command": "npx",
      "args": ["-y", "mulesoft-mcp-server", "start"],
      "env": {
        "ANYPOINT_CLIENT_ID": "<YOUR_CLIENT_ID>",
        "ANYPOINT_CLIENT_SECRET": "<YOUR_CLIENT_SECRET>",
        "ANYPOINT_REGION": "<REGION_NAME>"
      }
    }
  }
}

Download Cline.

Cursor

Add this snippet to Cursor mcp.json where ANYPOINT_REGION (optional) is one of these values: PROD_US, PROD_EU, PROD_CA, or PROD_JP.

{
  "mcpServers": {
    "mulesoft": {
      "command": "npx",
      "args": ["-y", "mulesoft-mcp-server", "start"],
      "env": {
        "ANYPOINT_CLIENT_ID": "<YOUR_CONNECTED_APP_CLIENT_ID>",
        "ANYPOINT_CLIENT_SECRET": "<YOUR_CONNECTED_APP_CLIENT_SECRET>",
        "ANYPOINT_REGION": "<REGION_NAME>"
      }
    }
  }
}

Download Cursor.

Trae

Add this snippet to Trae mcp_settings.json or .vscode/mcp.json where ANYPOINT_REGION (optional) is one of these values: PROD_US, PROD_EU, PROD_CA, or PROD_JP.

{
  "mcpServers": {
    "mulesoft": {
      "command": "npx",
      "args": ["-y", "mulesoft-mcp-server", "start"],
      "env": {
        "ANYPOINT_CLIENT_ID": "<YYOUR_CONNECTED_APP_CLIENT_ID>",
        "ANYPOINT_CLIENT_SECRET": "<YOUR_CONNECTED_APP_CLIENT_SECRET>",
        "ANYPOINT_REGION": "<REGION_NAME>"
      }
    }
  }
}

Download Trae.

VS Code

Add this snippet to VS Code settings.json or .vscode/mcp.json where (optional) ANYPOINT_REGION is one of these values: PROD_US, PROD_EU, PROD_CA, or PROD_JP.

{
  "mcp": {
    "servers": {
      "mulesoft": {
        "command": "npx",
        "args": ["-y", "mulesoft-mcp-server", "start"],
        "env": {
          "ANYPOINT_CLIENT_ID": "<YOUR_CONNECTED_APP_CLIENT_ID>",
          "ANYPOINT_CLIENT_SECRET": "<YOUR_CONNECTED_APP_CLIENT_SECRET>",
          "ANYPOINT_REGION": "<REGION_NAME>"
        }
      }
    }
  }
}

Download VS Code.

Windsurf

Add this snippet to Windsurf mcp_config.json where ANYPOINT_REGION (optional) is one of these values: PROD_US, PROD_EU, PROD_CA, or PROD_JP.

{
  "mcpServers": {
    "mulesoft": {
      "command": "npx",
      "args": ["-y", "mulesoft-mcp-server", "start"],
      "env": {
        "ANYPOINT_CLIENT_ID": "<YOUR_CONNECTED_APP_CLIENT_ID>",
        "ANYPOINT_CLIENT_SECRET": "<YOUR_CONNECTED_APP_CLIENT_SECRET>",
        "ANYPOINT_REGION": "<REGION_NAME>"
      }
    }
  }
}

Download Windsurf.

Zed

Add this snippet to Zed settings.json where ANYPOINT_REGION (optional) is one of these values: PROD_US, PROD_EU, PROD_CA, or PROD_JP.

{
  "context_servers": {
    "mulesoft": {
      "command": "npx",
      "args": ["-y", "mulesoft-mcp-server", "start"],
      "env": {
        "ANYPOINT_CLIENT_ID": "<YOUR_CONNECTED_APP_CLIENT_ID>",
        "ANYPOINT_CLIENT_SECRET": "<YOUR_CONNECTED_APP_CLIENT_SECRET>",
        "ANYPOINT_REGION": "<REGION_NAME>"
      }
    }
  }
}

Download Zed.

See Also