Skip to content

Commit d6c2934

Browse files
IsaacEldridgeIsaacEldridge
authored
Merge pull request #17 from mulesoft/W-20284621-Update-Getting-Started-ie
W-20284621 Update Getting Started
2 parents f05bb1d + 251243e commit d6c2934

File tree

2 files changed

+117
-35
lines changed

2 files changed

+117
-35
lines changed

‎modules/ROOT/pages/getting-started.adoc‎

Lines changed: 115 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,149 @@
11
= Getting Started with MuleSoft MCP Server
22

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

55
[IMPORTANT]
66
====
7-
If you have Anypoint Code Builder or Connector Builder, stop here. Don't perform these steps.
8-
9-
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.
10-
11-
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[].
7+
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[].
128
====
139

1410
== Before You Begin
15-
Before you install and use MuleSoft MCP Server, ensure you meet these prerequisites:
11+
Before you install and use MuleSoft MCP Server, ensure you have installed the following software:
1612

1713
* Anypoint Extension Pack version 1.10.0 or later
18-
* Git, if using MuleSoft VCS in Anypoint Code Builder
19-
* Node 20 or later. For more information, see link:https://nodejs.org/en/download[Download Node.js].
20-
* Organization administrator access (for xref:access-management::connected-apps-overview.adoc[creating a connected app])
21-
* 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[].
14+
* Git
15+
* Node.js 20 or later. Download https://nodejs.org/en/download[Node.js].
16+
17+
You also need permissions or access to perform these tasks:
18+
19+
* Organization administrator access: xref:access-management::connected-apps-overview.adoc[create a connected app]
20+
* xref:access-management::enabling-agentforce.adoc[Agentforce] access: run the `generate_mule_flow` and `generate_api_spec` tools .
21+
22+
23+
== Create a Connected App and Add OAuth Permission Scopes
24+
25+
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.
26+
27+
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.
28+
29+
See xref:access-management::permissions-by-product.adoc[] for details on permissions.
30+
31+
=== Anypoint Code Builder
32+
[cols="1,2,1"]
2233

34+
|===
35+
|To...|Required Permission |Associated Tool
2336

24-
== Set Up Authentication
25-
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].
37+
|Use natural language prompts to develop and generate flows using Agentforce for Anypoint Code Builder Generative Flows. |Mule Developer Generative AI User a|
2638

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

29-
=== Anypoint Code Builder
30-
* Mule Developer Generative AI User
42+
|===
3143

32-
=== Anypoint Monitoring
33-
* Monitoring Viewer
44+
=== Anypoint Monitoring
45+
[cols="1,2,1"]
3446

35-
=== API Manager
36-
* Manage APIs Configuration
37-
* Manage Policies
38-
* View APIs Configuration
39-
* View Policies
47+
|===
48+
|To...|Required Permission |Associated Tool
49+
50+
|View but not modify content in Anypoint Monitoring.|Monitoring Viewer a|
51+
52+
* xref:reference-mcp-tools.adoc#get-platform-insights[get_platform_insights]
53+
* xref:reference-mcp-tools.adoc#get-reuse-metrics[get_reuse_metrics]
54+
|===
55+
56+
=== API Manager
57+
[cols="1,2,1"]
58+
59+
|===
60+
|To...|Required Permission |Associated Tool
61+
62+
|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]
63+
64+
|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]
65+
66+
|View API configurations in the specified environment.|View APIs Configuration a|
67+
68+
* xref:reference-mcp-tools.adoc#list-api-instances[list_api_instances]
69+
* xref:reference-mcp-tools.adoc#get-platform-insights[get_platform_insights]
70+
* xref:reference-mcp-tools.adoc#get-reuse-metrics[get_reuse_metrics]
71+
72+
|View API configurations in the specified environment.|View API Configurations |xref:reference-mcp-tools.adoc#list-api-instances[list_api_instances]
73+
|===
4074

4175
=== Exchange
42-
* Exchange Administrator
43-
* Exchange Contributor
44-
* Exchange Creator
45-
* Exchange Viewer
76+
[cols="1,2,1"]
77+
78+
|===
79+
|To...|Required Permission |Associated Tool
80+
81+
a|
82+
* View, create, and download assets within a business group.
83+
* Edit asset portal content in an existing asset version.
84+
|Exchange Administrator |xref:reference-mcp-tools.adoc#create-and-manage-assets[create_and_manage_assets]
85+
86+
|View, create, and download assets within a business group. |Exchange Contributor |xref:reference-mcp-tools.adoc#create-and-manage-assets[create_and_manage_assets]
87+
88+
|Create new assets within a business group's catalog.|Exchange Creator |xref:reference-mcp-tools.adoc#create-and-manage-assets[create_and_manage_assets]
89+
90+
|View and download assets within a business group.|Exchange Viewer |xref:reference-mcp-tools.adoc#search-asset[search_asset]
91+
|===
4692

4793
=== General
48-
* View Organization
49-
* View Connected Applications
94+
[cols="1,2,1"]
95+
96+
|===
97+
|To...|Required Permission |Associated Tool
98+
99+
|View organization information.|View Organization |xref:reference-mcp-tools.adoc#get-platform-insights[get_platform_insights]
100+
101+
|View connected applications.|View Connected Applications |xref:reference-mcp-tools.adoc#get-reuse-metrics[get_reuse_metrics]
102+
|===
50103

51104
=== Runtime Manager
52-
* Read Applications
53-
* Create Applications
54-
* Read Runtime Fabrics
55-
* Cloudhub Network Viewer
105+
[cols="1,2,1"]
106+
107+
|===
108+
|To...|Required Permission |Associated Tool
109+
110+
|View applications in a specific environment.|Read Applications |xref:reference-mcp-tools.adoc#list-applications[list_applications]
111+
112+
|Create applications in a specific environment.|Create Applications |xref:reference-mcp-tools.adoc#deploy-mule-application[deploy_mule_application]
113+
114+
|Query Runtime Fabric instances in the organization.|Read Runtime Fabrics a|
115+
116+
* xref:reference-mcp-tools.adoc#get-platform-insights[get_platform_insights]
117+
* xref:reference-mcp-tools.adoc#get-reuse-metrics[get_reuse_metrics]
118+
119+
|View CloudHub and CloudHub 2.0 network resources.|CloudHub Network Viewer a|
120+
121+
* xref:reference-mcp-tools.adoc#get-platform-insights[get_platform_insights]
122+
* xref:reference-mcp-tools.adoc#get-reuse-metrics[get_reuse_metrics]
123+
|===
56124

57125
=== Usage
58-
* Usage Viewer
126+
[cols="1,2,1"]
127+
128+
|===
129+
|To...|Required Permission |Associated Tool
130+
131+
|View usage reports.|Usage Viewer a|
132+
133+
* xref:reference-mcp-tools.adoc#get-platform-insights[get_platform_insights]
134+
* xref:reference-mcp-tools.adoc#get-reuse-metrics[get_reuse_metrics]
135+
|===
59136

60137
== Install MuleSoft MCP Server
61-
To install the server with node, run:
138+
139+
To install the server with Node.js, run:
62140
`npm install -g @mulesoft/mcp-server`
63141

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

145+
For more information about Anypoint Platform regional services, see xref:hosting-home::index.adoc#control-plane-hosting-options[Control Plane Hosting Options].
146+
67147
=== Claude Desktop
68148
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`.
69149

‎modules/ROOT/pages/reference-mcp-tools.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ MuleSoft MCP Server provides tools for developing agent networks, building appli
44

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

7+
See xref:getting-started.adoc#create-a-connected-app-and-add-oauth-permission-scopes[Add OAuth Permission Scopes] for information about which tools require specific permission scopes.
8+
79
== Command Summary
810

911
[%header,cols="1,2,1,1"]

0 commit comments

Comments
 (0)