Skip to content
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 115 additions & 35 deletions modules/ROOT/pages/getting-started.adoc
Original file line number Diff line number Diff line change
@@ -1,69 +1,149 @@
= Getting Started with MuleSoft MCP Server

Learn how to set up and configure MuleSoft MCP Server for your agent-ready IDE.
MuleSoft 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. Learn how to set up and configure MuleSoft MCP Server for your IDE.

[IMPORTANT]
====
If you have Anypoint Code Builder or Connector Builder, stop here. Don't perform these steps.

MuleSoft MCP Server is already installed and configured in MuleSoft Dev Agent in Anypoint Code Builder, and Connector Builder. Authentication happens via the logged-in user and MuleSoft Dev Agent assumes any permissions that the user has.

For more information about MuleSoft Dev Agent and Connector Builder, see xref:anypoint-code-builder::api-ai-create-spec.adoc[] and xref:connector-builder::index.adoc[].
If you have Anypoint Code Builder or Connector Builder, MuleSoft MCP Server is already installed and configured in MuleSoft Dev Agent. For more information, see xref:anypoint-code-builder::api-ai-create-spec.adoc[] and xref:connector-builder::index.adoc[].
====

== Before You Begin
Before you install and use MuleSoft MCP Server, ensure you meet these prerequisites:
Before you install and use MuleSoft MCP Server, ensure you have installed the following software:

* Anypoint Extension Pack version 1.10.0 or later
* Git, if using MuleSoft VCS in Anypoint Code Builder
* Node 20 or later. For more information, see link:https://nodejs.org/en/download[Download Node.js].
* Organization administrator access (for xref:access-management::connected-apps-overview.adoc[creating a connected app])
* To run the `generate_mule_flow` and `generate_api_spec` tools, enable Einstein in Access Management. For more information, see xref:access-management::enabling-einstein.adoc[].
* Git
* Node.js 20 or later. Download https://nodejs.org/en/download[Node.js].

You also need permissions or access to perform these tasks:

* Organization administrator access: xref:access-management::connected-apps-overview.adoc[create a connected app]
* xref:access-management::enabling-agentforce.adoc[Agentforce] access: run the `generate_mule_flow` and `generate_api_spec` tools .


== Create a Connected App and Add OAuth Permission Scopes

Using the steps in xref:access-management::creating-connected-apps-dev.adoc#create-connected-app-on-its-own-behalf[Create a Connected App That Acts on Its Own Behalf], create a connected app. When prompted, add these permission scopes that enable you to use specific MuleSoft MCP Server tools. Make sure that all business groups and relevant environments are selected for these scopes.

Refer to the xref:reference-mcp-tools.adoc[] for details on all MuleSoft MCP Server tools. Only tools listed in these tables require specific permission scopes.

See xref:access-management::permissions-by-product.adoc[] for details on permissions.

=== Anypoint Code Builder
[cols="1,2,1"]

|===
|To...|Required Permission |Associated Tool

== Set Up Authentication
Create a connected app that acts on its own behalf using the steps in xref:access-management::creating-connected-apps-dev.adoc#create-connected-app-on-its-own-behalf[Create a Connected App That Acts on Its Own Behalf].
|Use natural language prompts to develop and generate flows using Agentforce for Anypoint Code Builder Generative Flows. |Mule Developer Generative AI User a|

In step 6, add these scopes. Make sure that all business groups and relevant environments are selected for these scopes.
* xref:reference-mcp-tools.adoc#generate-mule-flow[generate_mule_flow]
* xref:reference-mcp-tools.adoc#generate-api-spec[generate_api_spec]

=== Anypoint Code Builder
* Mule Developer Generative AI User
|===

=== Anypoint Monitoring
* Monitoring Viewer
=== Anypoint Monitoring
[cols="1,2,1"]

=== API Manager
* Manage APIs Configuration
* Manage Policies
* View APIs Configuration
* View Policies
|===
|To...|Required Permission |Associated Tool

|View but not modify content in Anypoint Monitoring.|Monitoring Viewer a|

* xref:reference-mcp-tools.adoc#get-platform-insights[get_platform_insights]
* xref:reference-mcp-tools.adoc#get-reuse-metrics[get_reuse_metrics]
|===

=== API Manager
[cols="1,2,1"]

|===
|To...|Required Permission |Associated Tool

|View and modify API configurations in the specified environment.|Manage API Configuration|xref:reference-mcp-tools.adoc#create-and-manage-api-instances[create_and_manage_api_instances]

|View, create, modify, and delete API policies in the specified environment.|Manage Policies |xref:reference-mcp-tools.adoc#manage-api-instance-policy[manage_api_instance_policy]

|View API configurations in the specified environment.|View APIs Configuration a|

* xref:reference-mcp-tools.adoc#list-api-instances[list_api_instances]
* xref:reference-mcp-tools.adoc#get-platform-insights[get_platform_insights]
* xref:reference-mcp-tools.adoc#get-reuse-metrics[get_reuse_metrics]

|View API configurations in the specified environment.|View API Configurations |xref:reference-mcp-tools.adoc#list-api-instances[list_api_instances]
|===

=== Exchange
* Exchange Administrator
* Exchange Contributor
* Exchange Creator
* Exchange Viewer
[cols="1,2,1"]

|===
|To...|Required Permission |Associated Tool

a|
* View, create, and download assets within a business group.
* Edit asset portal content in an existing asset version.
|Exchange Administrator |xref:reference-mcp-tools.adoc#create-and-manage-assets[create_and_manage_assets]

|View, create, and download assets within a business group. |Exchange Contributor |xref:reference-mcp-tools.adoc#create-and-manage-assets[create_and_manage_assets]

|Create new assets within a business group's catalog.|Exchange Creator |xref:reference-mcp-tools.adoc#create-and-manage-assets[create_and_manage_assets]

|View and download assets within a business group.|Exchange Viewer |xref:reference-mcp-tools.adoc#search-asset[search_asset]
|===

=== General
* View Organization
* View Connected Applications
[cols="1,2,1"]

|===
|To...|Required Permission |Associated Tool

|View organization information.|View Organization |xref:reference-mcp-tools.adoc#get-platform-insights[get_platform_insights]

|View connected applications.|View Connected Applications |xref:reference-mcp-tools.adoc#get-reuse-metrics[get_reuse_metrics]
|===

=== Runtime Manager
* Read Applications
* Create Applications
* Read Runtime Fabrics
* Cloudhub Network Viewer
[cols="1,2,1"]

|===
|To...|Required Permission |Associated Tool

|View applications in a specific environment.|Read Applications |xref:reference-mcp-tools.adoc#list-applications[list_applications]

|Create applications in a specific environment.|Create Applications |xref:reference-mcp-tools.adoc#deploy-mule-application[deploy_mule_application]

|Query Runtime Fabric instances in the organization.|Read Runtime Fabrics a|

* xref:reference-mcp-tools.adoc#get-platform-insights[get_platform_insights]
* xref:reference-mcp-tools.adoc#get-reuse-metrics[get_reuse_metrics]

|View CloudHub and CloudHub 2.0 network resources.|CloudHub Network Viewer a|

* xref:reference-mcp-tools.adoc#get-platform-insights[get_platform_insights]
* xref:reference-mcp-tools.adoc#get-reuse-metrics[get_reuse_metrics]
|===

=== Usage
* Usage Viewer
[cols="1,2,1"]

|===
|To...|Required Permission |Associated Tool

|View usage reports.|Usage Viewer a|

* xref:reference-mcp-tools.adoc#get-platform-insights[get_platform_insights]
* xref:reference-mcp-tools.adoc#get-reuse-metrics[get_reuse_metrics]
|===

== Install MuleSoft MCP Server
To install the server with node, run:

To install the server with Node.js, run:
`npm install -g @mulesoft/mcp-server`

== Configure MuleSoft MCP Server
You can configure Claude Desktop, Cursor, Windsurf, Zed, and other IDEs to work with the MuleSoft MCP Server.

For more information about Anypoint Platform regional services, see xref:hosting-home::index.adoc#control-plane-hosting-options[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`.

Expand Down
2 changes: 2 additions & 0 deletions modules/ROOT/pages/reference-mcp-tools.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ MuleSoft MCP Server provides tools for developing agent networks, building appli

NOTE: Some MuleSoft MCP Server tools are available only in the Anypoint Code Builder IDE or Connector Builder.

See xref:getting-started.adoc#create-a-connected-app-and-add-oauth-permission-scopes[Add OAuth Permission Scopes] for details on which tools require specific permission scopes.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our editors would say "information about which tools"...


== Command Summary

[%header,cols="1,2,1,1"]
Expand Down