--- schema_version: "1" id: d7c035970f9355da6ca63c1a97139dd0a680775e0332036d44a909a99c7b31ce title: Getting Started with MuleSoft Platform MCP Server collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/mulesoft-mcp-server/getting-started-platform.md canonical_url: https://docs.mulesoft.com/mulesoft-mcp-server/getting-started-platform source_site: docs.mulesoft.com content_type: documentation content_hash: 0b5f06654c0db1e600eb0b055899ca53b8ed21a0456236e2cdb1c79ceaf8b04a description: MuleSoft Documentation Site latest: true --- --- product: MuleSoft MCP Servers --- # Getting Started with MuleSoft Platform MCP Server > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Scan, discover, govern, and monitor APIs, agents, MCP servers, and LLMs across your entire IT landscape from a single AI-accessible interface. MuleSoft Platform MCP Server gives AI tools governed access to your infrastructure to accelerate production-ready AI deployment. Connect your IDE in minutes using any MCP-compatible client. ## Create a Connected App Create a connected app that acts on your behalf so AI clients can access Anypoint Platform. After you create the app, copy the Client ID and Client Secret. You need these values when you configure your IDE. 1. In Anypoint Platform, [create a connected app that acts on behalf of a user](https://docs.mulesoft.com/access-management/creating-connected-apps-dev#create-connected-app). As part of the process, configure the app with the following settings: 1. Select the **Authorization Code** and **Refresh Token** grant types. 2. In **Redirect URIs**, enter the redirect URL for the AI client you plan to use. See [Configure Your IDE](#configure-your-ide) for the URL for each supported client. 3. Click **Add Scopes** and add these scopes: - Full Access (`full`) - Background Access (`offline_access`) You need these scopes to use the MCP server. 4. Copy the Client ID and Client Secret. Some tools require additional permission scopes. Refer to the [MuleSoft Platform MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform) for details on all MuleSoft Platform MCP Server tools. Only tools listed in the following tables require specific permission scopes. ### Exchange

To…	Required Permission	Associated Tools
View and download assets within a business group.	Exchange Viewer `read:exchange`	fetch_service_facets fetch_services list_agents list_apis list_llms list_mcp_servers search_assets_semantic search_global_assets search_global_content search_portfolio_services search_repository_knowledge view_agent_details view_api_version_details view_llm_details view_mcp_server_details
View, create, and download assets within a business group, including editing asset portal content in an existing asset version.	Exchange Contributor `edit:exchange`	get_mcp_server_state get_provision_status get_trusted_mcp_catalog provision_mcp_server resume_provision_job update_mcp_server

### API Manager

To…	Required Permission	Associated Tools
View API configurations and policies in the specified environment.	API Manager Environment Viewer `read:api_configuration` `read:api_policies`	check_guardrail_scope_targets fetch_automated_policy_template fetch_guardrail_ruleset get_policy_template_form list_governance_strategies list_provider_gateways prepare_automated_policy_creation prepare_guardrail_creation prepare_policy_creation view_api_instance_details view_api_instance_policies view_api_version_instances
View, create, modify, and delete APIs in the specified environment.	API Manager Environment Admin `manage:apis`	apply_policy_to_instance create_automated_policy_strategy delete_automated_policy_strategy

### Anypoint Monitoring

To…	Required Permission	Associated Tools
View but not modify content in Anypoint Monitoring.	Monitoring Viewer `view:monitoring`	fetch_monitoring_drill_down fetch_monitoring_instance fetch_monitoring_overview show_observability_performance view_api_instance_monitoring

### Governance

To…	Required Permission	Associated Tools
View reports.	Governance Viewer `view:ang_governance_profiles`	check_policy_conformance fetch_governance_service_report fetch_governance_services view_api_version_governance_report view_governance_report
Manage profiles and view reports.	Governance Administrator `admin:ang_governance_profiles`	create_guardrail delete_governance_strategy

### Runtime Manager

To…	Required Permission	Associated Tools
Create applications in a specific environment.	Manage Application Data `manage:application_data`	create_omni_gateway create_scanner get_omni_gateway_target_domains get_omni_gateway_usage_report list_omni_gateway_environments list_omni_gateway_targets list_scanner_providers test_scanner_connection

### Cost Management

To…	Required Permission	Associated Tools
Use the Cost Management experience.	API Manager: Manage Policies (`manage:api_policies`) API Manager: View APIs Configuration (`read:api_configuration`) API Manager: View Policies (`read:api_policies`) Anypoint Monitoring: Monitoring Viewer (`view:monitoring`) Exchange: Exchange Viewer (`read:exchange`) Anypoint Code Builder: Mule Developer Generative AI User (`create:generations`) (Optional)	create_model_wallet delete_model_wallet edit_model_wallet fetch_cost_instance_timeseries fetch_cost_instances fetch_cost_optimization_recommendations fetch_cost_overview fetch_model_wallet_details fetch_model_wallets

### General

To…	Required Permission	Associated Tools
View organization information.	organization_read (implicit) `read:organization`	get_business_group list_business_groups select_active_business_group select_active_environment select_active_provider select_api_version

## Configure Your IDE Configure Claude Desktop, Claude Code, ChatGPT, Cursor, Windsurf, or VS Code to work with MuleSoft Platform MCP Server. After you add the configuration, verify it by checking that the server has started in the MCP section of your IDE. > [!IMPORTANT] MuleSoft remote MCP servers currently only support manual client registration through > app creation and do not support other client registration methods such as Dynamic Client > Registration (DCR). ### Available Client Connections When configuring your AI tool, use the endpoint for your control plane. Use the `/mcp` path (Streamable HTTP). If the client does not connect, fall back to `/mcp/sse` (Server-Sent Events), which some older clients still require. For example, on US Cloud: - https://us1.omni.mulesoft.com/mcp - https://us1.omni.mulesoft.com/mcp/sse

Control Plane	URL
US Cloud	https://us1.omni.mulesoft.com (https://omni.mulesoft.com is an alias)
EU Cloud	https://eu1.omni.mulesoft.com
Canada Cloud	https://ca1.omni.mulesoft.com
Japan Cloud	https://jp1.omni.mulesoft.com
India Cloud	https://in1.omni.mulesoft.com
Australia Cloud	https://au1.omni.mulesoft.com

For more information about Anypoint Platform regions, see [Control Plane Hosting Options](https://docs.mulesoft.com/hosting-home/#control-plane-hosting-options). ### Claude Desktop In Claude Desktop: 1. Click **Customize** > **Connectors**. 2. Click the add (+) icon, and then click **Browse Connectors**. 3. Search for "MuleSoft" and then add the connector. 4. Enter the Client ID and Client Secret from your connected app. In your connected app: 1. Log in to Anypoint Platform, and open your connected app. 2. In the **Redirect URLs** field, enter `https://claude.ai/api/mcp/auth_callback`. 3. To apply changes, click **Continue**. Download [Claude Desktop](https://claude.com/download). ### Claude Code In your terminal, run the following command, replacing `` with a fixed port number (for example, `32493`): ```bash MCP_CLIENT_SECRET= claude mcp add \ --transport http \ --callback-port \ --client-id \ --client-secret \ mulesoft-platform https://omni.mulesoft.com/mcp ``` Using a fixed callback port ensures the redirect URL remains consistent across sessions. Without a fixed port, Claude Code assigns a random port for each authentication request, which causes authorization to fail because the connected app requires an exact URL match. In your connected app: 1. Log in to Anypoint Platform, and open your connected app. 2. In the **Redirect URLs** field, enter `http://localhost:/callback`, using the same port number you specified in the command (for example, `http://localhost:32493/callback`). 3. To apply changes, click **Continue**. Install [Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview). ### ChatGPT In ChatGPT: 1. Click **Apps** > **Settings.** 2. Click the settings icon, click **Create App**, and configure the following: 1. Name the connection, and enter the **Remote Universal URL**, for example, `https://omni.mulesoft.com/mcp`. 3. In **OAuth** > **Advanced settings** > **Client registration**, configure the following: 1. Enter the Client ID and Client Secret from your connected app. 2. Copy the Callback URL. In your connected app: 1. Log in to Anypoint Platform, and open your connected app. 2. In the redirect URLs field, enter the Callback URL value you copied. 3. To apply changes, click **Continue**. Download [ChatGPT](https://chatgpt.com/download/). ### Cursor In Cursor: 1. Click **Settings** > **Tools and MCPs** > **Add a Custom MCP Server**. 2. Add the following code snippet, replacing `` with a fixed port number (for example, `32493`): ```json { "mcpServers": { "mulesoft-platform": { "command": "npx", "args": [ "-y", "mcp-remote@latest", "https://omni.mulesoft.com/mcp", "", "--static-oauth-client-info", "{\"client_id\":\"YOUR_CLIENT_ID\",\"client_secret\":\"YOUR_CLIENT_SECRET\"}" ] } } } ``` Using a fixed port ensures the redirect URL remains consistent across sessions. Without a fixed port, Cursor assigns a random port for each authentication request, which causes authorization to fail because the connected app requires an exact URL match. In your connected app: 1. Log in to Anypoint Platform, and open your connected app. 2. In the **Redirect URLs** field, enter `http://localhost:/oauth/callback`, using the same port number you specified in the configuration (for example, `http://localhost:32493/oauth/callback`). 3. To apply changes, click **Continue**. Download [Cursor](https://cursor.com/). ### Windsurf In Windsurf: 1. Click **Settings** > **Cascade** > **Open MCP Registry**. 2. Click the settings icon and in `~/.codeium/windsurf/mcp_config.json` add the following code snippet, replacing `` with a fixed port number (for example, `32493`): ```json { "mcpServers": { "mulesoft-platform": { "command": "npx", "args": [ "-y", "mcp-remote@latest", "https://omni.mulesoft.com/mcp", "", "--static-oauth-client-info", "{\"client_id\":\"YOUR_CLIENT_ID\",\"client_secret\":\"YOUR_CLIENT_SECRET\"}" ] } } } ``` Using a fixed port ensures the redirect URL remains consistent across sessions. Without a fixed port, Windsurf assigns a random port for each authentication request, which causes authorization to fail because the connected app requires an exact URL match. In your connected app: 1. Log in to Anypoint Platform, and open your connected app. 2. In the **Redirect URLs** field, enter `http://localhost:/oauth/callback`, using the same port number you specified in the configuration (for example, `http://localhost:32493/oauth/callback`). 3. To apply changes, click **Continue**. Download [Windsurf](https://windsurf.com/). ### VS Code In VS Code: 1. In your user profile, configure a custom MCP server in the `mcp.json` file. Alternatively, run `MCP: Add Server` in the Command Palette (Shift+Cmd+P) to add a server through a guided flow. Replace `` with a fixed port number (for example, `32493`): ```json { "servers": { "mulesoft-platform": { "type": "stdio", "command": "npx", "args": [ "-y", "mcp-remote@latest", "https://omni.mulesoft.com/mcp", "", "--static-oauth-client-info", "{\"client_id\":\"YOUR_CLIENT_ID\",\"client_secret\":\"YOUR_CLIENT_SECRET\"}" ] } } } ``` Using a fixed port ensures the redirect URL remains consistent across sessions. Without a fixed port, VS Code assigns a random port for each authentication request, which causes authorization to fail because the connected app requires an exact URL match. In your connected app: 1. Log in to Anypoint Platform, and open your connected app. 2. In the **Redirect URLs** field, enter `http://localhost:/oauth/callback`, using the same port number you specified in the configuration (for example, `http://localhost:32493/oauth/callback`). 3. To apply changes, click **Continue**. 4. To run the server, click **Start**. 5. When prompted, enter the Client ID and Client Secret from your connected app. Download [VS Code](https://code.visualstudio.com/). ## Troubleshooting Resolve authentication and connection issues with these troubleshooting steps. ### Authentication Failure To resolve authentication issues, follow these troubleshooting steps. - Try logging out of your Anypoint Platform account and logging back in. - If you encounter an authorization error: - Add the correct redirect URL to your connected app. - Add the necessary permissions scopes to your connected app. - If you encounter a permissions-related error when attempting to authorize, add these permission scopes to your connected app: - Full Access (`full`) - Background Access (`offline_access`) - If authorization fails due to a redirect URL mismatch: - IDE-based clients (Claude Code, Cursor, Windsurf, VS Code) use a localhost callback URL with a port number. If the port changes between sessions, the redirect URL no longer matches the one registered in your connected app. To prevent this, configure a fixed callback port as described in [Configure Your IDE](#configure-your-ide). Then add the matching localhost URL to your connected app’s redirect URLs (for example, `http://localhost:32493/oauth/callback`). ### Connection Issues If your MCP client can’t reach the server or fails to establish a session, verify these settings. - Ensure your MCP client supports Streamable HTTP transport. - Check that your client can handle OAuth authentication flows. - Verify the MCP server URL is [https://omni.mulesoft.com/mcp](https://omni.mulesoft.com/mcp). ## See Also - [Using MuleSoft Platform MCP Server](https://docs.mulesoft.com/mulesoft-mcp-server/using-mulesoft-platform-mcp-server)