Skip to content

Commit fff0d0c

Browse files
authored
Merge pull request #14 from mulesoft/W-20223234-connectorbuildermcptools-sg
W-20223234 connector builder mcp tools
2 parents 24512dc + d0a1ed5 commit fff0d0c

File tree

4 files changed

+175
-10
lines changed

4 files changed

+175
-10
lines changed

modules/ROOT/pages/getting-started.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@
33
Learn how to set up and configure MuleSoft MCP Server for your agent-ready IDE.
44

55
[IMPORTANT]
6-
If you have Anypoint Code Builder, stop here. Don't perform these steps. MuleSoft MCP Server is already installed and configured in MuleSoft Dev Agent in Anypoint Code Builder. Authentication happens through the user that's logged into Anypoint Code Builder. MuleSoft Dev Agent assumes any permissions that the user has. For more information about MuleSoft Dev Agent, see xref:anypoint-code-builder::api-ai-create-spec.adoc[Creating API Specs with MuleSoft Dev Agent].
6+
====
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[].
12+
====
713

814
== Before You Begin
915
Before you install and use MuleSoft MCP Server, ensure you meet these prerequisites:
@@ -196,5 +202,3 @@ Add this snippet to Zed `settings.json` where `ANYPOINT_REGION` (optional) is on
196202
== See Also
197203

198204
* xref:using-mulesoft-mcp-server.adoc[]
199-
200-

modules/ROOT/pages/index.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
= MuleSoft MCP Server Overview
22

3-
The Mulesoft MCP Server is a Model Context Protocol (MCP) implementation that facilitates interaction between large language models (LLMs) and the Mulesoft Anypoint Platform. Through natural language interactions, you can build agent networks, create and deploy Mule applications, create API specs, manage governance rulesets, get platform insights, and more.
3+
The Mulesoft MCP Server is a Model Context Protocol (MCP) implementation that facilitates interaction between large language models (LLMs) and the Mulesoft Anypoint Platform. Through natural language interactions, you can build agent networks, create and deploy Mule applications, build connectors, create API specs, manage governance rulesets, get platform insights, and more.
44

55
MuleSoft MCP Server acts as a bridge between AI-powered IDEs like Cursor, Windsurf, and VS Code and MuleSoft's platform services--enabling developers to build, deploy, and manage applications using natural language interactions in their editor.
66

7-
If you have Anypoint Code Builder desktop, the MuleSoft MCP Server is already included and configured.
7+
If you have Anypoint Code Builder desktop or Connector Builder, the MuleSoft MCP Server is already included and configured.
88

99
== Deployment Targets
1010
You can deploy applications to CloudHub 2.0 and Runtime Fabric only.

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

Lines changed: 157 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,135 +1,186 @@
11
= MuleSoft MCP Server Tool Reference
22

3-
MuleSoft MCP Server provides tools for developing agent networks, building applications, managing deployments, governing APIs, and more. Each tool accepts specific parameters to automate tasks across the Anypoint Platform. Use these tools to accelerate development workflows, streamline governance, and gain operational insights into your integrations.
3+
MuleSoft MCP Server provides tools for developing agent networks, building applications, creating connectors, managing deployments, governing APIs, and more. Each tool accepts specific parameters to automate tasks across the Anypoint Platform. Use these tools to accelerate development workflows, streamline governance, and gain operational insights into your integrations.
44

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

77
== Command Summary
88

9-
[%header,cols="1,2,1"]
9+
[%header,cols="1,2,1,1"]
1010
|===
11-
|Category |Tool |Anypoint Code Builder Only
11+
|Category |Tool |Anypoint Code Builder Only |Connector Builder Only
1212

1313
.4+s|Agent Network Development
1414
|<<configure-agent-network-yaml,configure_agent_network_yaml>>
1515
|Yes
16+
|No
1617

1718
|<<create-agent-network-project,create_agent_network_project>>
1819
|Yes
20+
|No
1921

2022
|<<deploy-agent-network,deploy_agent_network>>
2123
|Yes
24+
|No
2225

2326
|<<publish-agent-network-assets,publish_agent_network_assets>>
2427
|Yes
28+
|No
2529

2630
.14+s|Application Development
2731
|<<create-and-manage-assets,create_and_manage_assets>>
2832
|No
33+
|No
2934

3035
|<<create-and-manage-metadata,create_and_manage_metadata>>
3136
|Yes
37+
|No
3238

3339
|<<create-api-spec-project,create_api_spec_project>>
3440
|No
41+
|No
3542

3643
|<<create-mcp-server,create_MCP_server>>
3744
|No
45+
|No
3846

3947
|<<create-mule-project,create_mule_project>>
4048
|No
49+
|No
4150

4251
|<<generate-api-spec,generate_api_spec>>
4352
|No
53+
|No
4454

4555
|<<generate-mule-flow,generate_mule_flow>>
4656
|No
57+
|No
4758

4859
|<<get-topics-agent-actions-metadata-instructions,get_topics_agent_actions_metadata_instructions>>
4960
|Yes
61+
|No
5062

5163
|<<mock-api-spec,mock_api_spec>>
5264
|Yes
65+
|No
5366

5467
|<<open-project,open_project>>
5568
|Yes
69+
|No
5670

5771
|<<run-local-mule-application,run_local_mule_application>>
5872
|No
73+
|No
5974

6075
|<<search-asset,search_asset>>
6176
|No
77+
|No
6278

6379
|<<test-connection,test_connection>>
6480
|Yes
81+
|No
6582

6683
|<<validate-project,validate_project>>
6784
|Yes
85+
|No
86+
87+
.3+s|Connector Development
88+
|<<uc-create-connector-workflow,uc_create_connector_workflow>>
89+
|No
90+
|Yes
91+
92+
|<<uc-generate-api-spec,uc_generate_api_spec>>
93+
|No
94+
|Yes
95+
96+
|<<uc-generate-connector,uc_generate_connector>>
97+
|No
98+
|Yes
6899

69100
.7+s|DataWeave Development
70101
|<<dataweave-create-documentation,dataweave_create_documentation>>
71102
|No
103+
|No
72104

73105
|<<dataweave-create-project,dataweave_create_project>>
74106
|No
107+
|No
75108

76109
|<<dataweave-create-sample-data,dataweave_create_sample_data>>
77110
|No
111+
|No
78112

79113
|<<dataweave-get-module-metadata,dataweave_get_module_metadata>>
80114
|No
115+
|No
81116

82117
|<<dataweave-get-project-metadata,dataweave_get_project_metadata>>
83118
|No
119+
|No
84120

85121
|<<dataweave-open-project,dataweave_open_project>>
86122
|No
123+
|No
87124

88125
|<<dataweave-run-script-tool,dataweave_run_script_tool>>
89126
|No
127+
|No
90128

91129
.5+s|Application Management
92130
|<<create-and-manage-api-instances,create_and_manage_api_instances>>
93131
|No
132+
|No
94133

95134
|<<deploy-mule-application,deploy_mule_application>>
96135
|No
136+
|No
97137

98138
|<<list-api-instances,list_api_instances>>
99139
|No
140+
|No
100141

101142
|<<list-applications,list_applications>>
102143
|No
144+
|No
103145

104146
|<<update-mule-application,update_mule_application>>
105147
|No
148+
|No
106149

107150
.3+s|Governance
108151
|<<add-governance-ruleset,add_governance_ruleset>>
109152
|Yes
153+
|No
110154

111155
|<<list-governance-rulesets,list_governance_rulesets>>
112156
|Yes
157+
|No
113158

114159
|<<validate-api-against-ruleset,validate_api_against_ruleset>>
115160
|Yes
161+
|No
116162

117163
.3+s|Policy Management
118164
|<<get-flex-gateway-policy-example,get_flex_gateway_policy_example>>
119165
|No
166+
|No
120167

121168
|<<manage-api-instance-policy,manage_api_instance_policy>>
122169
|No
170+
|No
123171

124172
|<<manage-flex-gateway-policy-project,manage_flex_gateway_policy_project>>
125173
|No
174+
|No
126175

127176
.2+s|Usage and Insights
128177
|<<get-platform-insights,get_platform_insights>>
129178
|No
179+
|No
130180

131181
|<<get-reuse-metrics,get_reuse_metrics>>
132182
|No
183+
|No
133184

134185
|===
135186

@@ -1382,6 +1433,108 @@ Available only in Anypoint Code Builder.
13821433

13831434
|===
13841435

1436+
[[uc-create-connector-workflow]]
1437+
== uc_create_connector_workflow
1438+
1439+
Create a complete LinkWeave connector end-to-end with guided workflow planning. Supports two flows: generating an API spec from documentation, or using an existing API spec file. Returns a detailed workflow plan with numbered steps to execute sequentially.
1440+
1441+
Available only in Connector Builder.
1442+
1443+
[%header,cols="1,3a,1"]
1444+
|===
1445+
|Parameter |Description |Required?
1446+
1447+
|workflowCustomization
1448+
|Any specific workflow customizations, preferences, or requirements for the connector-creation process.
1449+
|No
1450+
1451+
|flow
1452+
|Flow selection. Valid values are:
1453+
1454+
* `generate-spec` to generate API spec from documentation
1455+
* `existing-spec` if user has an existing API spec file
1456+
* `auto-detect` to determine automatically
1457+
1458+
|No
1459+
1460+
|existingApiSpec
1461+
|Absolute path to existing API spec file (OpenAPI/Swagger YAML or JSON) if using `existing-spec` flow.
1462+
|No
1463+
1464+
|===
1465+
1466+
[[uc-generate-api-spec]]
1467+
== uc_generate_api_spec
1468+
1469+
Generate an OpenAPI 3.0 spec from use cases and API documentation. Analyzes documentation sources, discovers endpoints for the specified use cases, and creates both a `discovery.json` file and a complete OpenAPI YAML spec. If no parameters are used, the agent prompts for input.
1470+
1471+
Available only in Connector Builder.
1472+
1473+
[%header,cols="1,3a,1"]
1474+
|===
1475+
|Parameter |Description |Required?
1476+
1477+
|platform
1478+
|Name of the SaaS platform or service, for example, `Salesforce`, `ServiceNow`, `PayPal`, or `Stripe`.
1479+
|No
1480+
1481+
|useCases
1482+
|List of integration use cases, ordered by priority. Each use case describes a specific integration scenario, for example, `Sync customer data` or `Process invoices`. If specified, a minimum of one is required.
1483+
|No
1484+
1485+
|documentation
1486+
|List of official API documentation URLs. Must be valid URLs starting with `http://` or `https://`, for example, `\https://developers.stripe.com/api`. If specified, a minimum of one is required.
1487+
|No
1488+
1489+
|additionalRequirements
1490+
|Any additional requirements, constraints, or preferences for the API spec, for example, specific authentication methods, rate limiting considerations, and version preferences.
1491+
|No
1492+
1493+
|userConfirmed
1494+
|Confirmation that all provided information is correct and ready for processing.
1495+
|No
1496+
1497+
|===
1498+
1499+
[[uc-generate-connector]]
1500+
== uc_generate_connector
1501+
1502+
Generate a complete LinkWeave connector from an API spec. Supports flexible multi-phase generation including scaffolding, CCM (Canonical Connectivity Model), and Anypoint Connector. All endpoints from the API spec are used. Can execute phases individually or in combination.
1503+
1504+
Available only in Connector Builder.
1505+
1506+
[%header,cols="1,3a,1"]
1507+
|===
1508+
|Parameter |Description |Required?
1509+
1510+
|apiSpec
1511+
|Absolute path to the API spec file (OpenAPI/Swagger YAML or JSON).
1512+
|No
1513+
1514+
Required for `ccm` phase.
1515+
1516+
|projectName
1517+
|Name for the connector project.
1518+
|No
1519+
1520+
Required for `ccm` phase.
1521+
1522+
|description
1523+
|Description for the connector project.
1524+
|No
1525+
1526+
Required for `ccm` phase.
1527+
1528+
|phases
1529+
|Array of phases to execute - any combination of `ccm` and `anypoint`. Phases execute in order. Valid values are:
1530+
1531+
* `ccm` for Canonical Connectivity Model
1532+
* `anypoint` for Anypoint Connector
1533+
1534+
|No
1535+
1536+
|===
1537+
13851538
[[update-mule-application]]
13861539
== update_mule_application
13871540

@@ -1526,4 +1679,3 @@ Available only in Anypoint Code Builder.
15261679
== See Also
15271680

15281681
* xref:using-mulesoft-mcp-server.adoc[]
1529-

modules/ROOT/pages/using-mulesoft-mcp-server.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ Add a new broker for employee offboarding.
2828
|Create an integration project
2929
|Create a Mule project that creates an order in NetSuite every time an opportunity in Salesforce is updated to stage Closed Won.
3030

31+
|Create a connector using Connector Builder
32+
|Create an Eventbrite connector.
33+
3134
|Deploy an agent network instance
3235
|Deploy the hello-world-network project to staging.
3336

@@ -40,6 +43,12 @@ Add a new broker for employee offboarding.
4043
|Generate an MCP server using Anypoint connectors
4144
|Generate an MCP server that exposes 3 tools from the following operations: Workday - Absence Management - Get Time Off Plan Balances, Workday - Absence Management - Enter Time Off, and Google Calendar - Create Calendar Event.
4245

46+
|Generate an API spec for a connector using Connector Builder
47+
|Generate an API spec for Eventbrite.
48+
49+
|Generate a connector using Connector Builder
50+
|Generate an Anypoint connector for the current connector.
51+
4352
|List all policies
4453
|What policies do I have available?
4554

0 commit comments

Comments
 (0)