---
schema_version: "1"
id: 0e26cb3f79c58277a880e48d8099490eaf48b020eb251274952afacf5feaa51c
title: Getting Started with MuleSoft DX MCP Server
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/mulesoft-mcp-server/getting-started.md
canonical_url: https://docs.mulesoft.com/mulesoft-mcp-server/getting-started
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 0fdef22f0732e79f5901c6fbb8ad312e7d9910d191e170905df95e84169fcc4f
description: MuleSoft Documentation Site
latest: true
---
---
product: MuleSoft MCP Servers
---

# Getting Started with MuleSoft DX MCP Server

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

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.

> [!IMPORTANT] 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](https://docs.mulesoft.com/anypoint-code-builder/vibes-api-ai-create-spec) and
> [Connector Builder Overview](https://docs.mulesoft.com/connector-builder/).

## 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](https://nodejs.org/en/download).

You also need permissions or access to perform these tasks:

- Organization administrator access:
  [create a connected app](https://docs.mulesoft.com/access-management/connected-apps-overview)

- [Enabling or Disabling Generative AI for Anypoint Platform](https://docs.mulesoft.com/access-management/enabling-generative-ai)
  access to: run the `generate_mule_flow` and `generate_api_spec` tools.

## Create a Connected App

Follow the steps in
[Create a Connected App That Acts on Its Own Behalf](https://docs.mulesoft.com/access-management/creating-connected-apps-dev#create-connected-app-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.

For a connected app created in a child business group, assign the **View Organization** and **View
Connected Applications** permissions at the root organization. Assign the remaining permissions at
the organization, business group, or environment required by the tools that you use.

Refer to the [MuleSoft DX MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools) for details on all
MuleSoft DX MCP Server tools. Only tools listed in these tables require specific permission scopes.

### Anypoint Code Builder

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tool</th></tr></thead><tbody><tr><td><p>Use natural language prompts to develop and generate flows using Anypoint Code Builder Generative Flows.</p></td><td><p>Mule Developer Generative AI User<br><code>create:generations</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#generate-mule-flow">generate_mule_flow</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#generate-api-spec">generate_api_spec</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#create-mcp-server">create_MCP_server</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#generate-munit-test">generate_munit_test</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#modify-munit-test">modify_munit_test</a></p></li></ul></div></div></td></tr></tbody></table>

### Anypoint Monitoring

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tool</th></tr></thead><tbody><tr><td><p>View but not modify content in Anypoint Monitoring.</p></td><td><p>Monitoring Viewer<br><code>view:monitoring</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-platform-insights">get_platform_insights</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-reuse-metrics">get_reuse_metrics</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#list-applications">list_applications</a></p></li></ul></div></div></td></tr></tbody></table>

### API Manager

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tool</th></tr></thead><tbody><tr><td><p>View and modify API configurations in the specified environment.</p></td><td><p>Manage API Configuration<br><code>manage:api_configuration</code></p></td><td><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#create-and-manage-api-instances">create_and_manage_api_instances</a></p></td></tr><tr><td><p>View, create, modify, and delete API policies in the specified environment.</p></td><td><p>Manage Policies<br><code>manage:api_policies</code></p></td><td><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#manage-api-instance-policy">manage_api_instance_policy</a></p></td></tr><tr><td><p>View API configurations in the specified environment.</p></td><td><p>View APIs Configuration<br><code>read:api_configuration</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#list-api-instances">list_api_instances</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-platform-insights">get_platform_insights</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-reuse-metrics">get_reuse_metrics</a></p></li></ul></div></div></td></tr></tbody></table>

### Exchange

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tool</th></tr></thead><tbody><tr><td><div><div><ul><li><p>View, create, and download assets within a business group.</p></li><li><p>Edit asset portal content in an existing asset version.</p></li></ul></div></div></td><td><p>Exchange Administrator<br><code>manage:exchange</code></p></td><td><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#create-and-manage-assets">create_and_manage_assets</a></p></td></tr><tr><td><p>View, create, and download assets within a business group.</p></td><td><p>Exchange Contributor<br><code>edit:exchange</code></p></td><td><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#create-and-manage-assets">create_and_manage_assets</a></p></td></tr><tr><td><p>Create new assets within a business group’s catalog.</p></td><td><p>Exchange Creator<br><code>create:exchange</code></p></td><td><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#create-and-manage-assets">create_and_manage_assets</a></p></td></tr><tr><td><p>View and download assets within a business group.</p></td><td><p>Exchange Viewer<br><code>read:exchange</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#search-asset">search_asset</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#deploy-mule-application">deploy_mule_application</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#update-mule-application">update_mule_application</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#implement-api-spec">implement_api_spec</a></p></li></ul></div></div></td></tr></tbody></table>

### General

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tool</th></tr></thead><tbody><tr><td><p>View organization information.</p></td><td><p>View Organization<br><code>read:organization</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-platform-insights">get_platform_insights</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#update-mule-application">update_mule_application</a></p></li></ul></div></div></td></tr><tr><td><p>View connected applications.</p></td><td><p>View Connected Applications<br><code>read:orgconnapps</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-reuse-metrics">get_reuse_metrics</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#list-applications">list_applications</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#deploy-mule-application">deploy_mule_application</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#update-mule-application">update_mule_application</a></p></li></ul></div></div></td></tr></tbody></table>

### Runtime Manager

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tool</th></tr></thead><tbody><tr><td><p>View applications in a specific environment.</p></td><td><p>Read Applications<br><code>read:applications</code></p></td><td><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#list-applications">list_applications</a></p></td></tr><tr><td><p>Create applications in a specific environment.</p></td><td><p>Create Applications<br><code>create:applications</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#deploy-mule-application">deploy_mule_application</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#update-mule-application">update_mule_application</a></p></li></ul></div></div></td></tr><tr><td><p>Query Runtime Fabric instances in the organization.</p></td><td><p>Read Runtime Fabrics<br><code>read:runtime_fabrics</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-platform-insights">get_platform_insights</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-reuse-metrics">get_reuse_metrics</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#list-applications">list_applications</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#deploy-mule-application">deploy_mule_application</a></p></li></ul></div></div></td></tr><tr><td><p>View CloudHub and CloudHub 2.0 network resources.</p></td><td><p>CloudHub Network Viewer<br><code>read:cloudhub_networking</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-platform-insights">get_platform_insights</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-reuse-metrics">get_reuse_metrics</a></p></li></ul></div></div></td></tr></tbody></table>

### Usage

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tool</th></tr></thead><tbody><tr><td><p>View usage reports.</p></td><td><p>Usage Viewer<br><code>view:metering</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-platform-insights">get_platform_insights</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-reuse-metrics">get_reuse_metrics</a></p></li></ul></div></div></td></tr></tbody></table>

## 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](https://docs.mulesoft.com/hosting-home/#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](https://claude.com/download).

#### 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](https://cline.bot/).

#### 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](https://cursor.com/).

#### 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": "<YOUR\_CONNECTED\_APP\_CLIENT\_ID>", "ANYPOINT\_CLIENT\_SECRET":
"<YOUR\_CONNECTED\_APP\_CLIENT\_SECRET>", "ANYPOINT\_REGION": "<REGION\_NAME>" } } } }

Download [Trae](https://www.trae.ai/).

#### 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](https://code.visualstudio.com/).

#### 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](https://windsurf.com/).

#### 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](https://github.com/zed-industries/zed).

## See Also

- [Using MuleSoft DX MCP Server](https://docs.mulesoft.com/mulesoft-mcp-server/using-mulesoft-mcp-server)