|
1 | 1 | = MuleSoft MCP Server Tool Reference |
2 | 2 |
|
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. |
4 | 4 |
|
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. |
6 | 6 |
|
7 | 7 | == Command Summary |
8 | 8 |
|
9 | | -[%header,cols="1,2,1"] |
| 9 | +[%header,cols="1,2,1,1"] |
10 | 10 | |=== |
11 | | -|Category |Tool |Anypoint Code Builder Only |
| 11 | +|Category |Tool |Anypoint Code Builder Only |Connector Builder Only |
12 | 12 |
|
13 | 13 | .4+s|Agent Network Development |
14 | 14 | |<<configure-agent-network-yaml,configure_agent_network_yaml>> |
15 | 15 | |Yes |
| 16 | +|No |
16 | 17 |
|
17 | 18 | |<<create-agent-network-project,create_agent_network_project>> |
18 | 19 | |Yes |
| 20 | +|No |
19 | 21 |
|
20 | 22 | |<<deploy-agent-network,deploy_agent_network>> |
21 | 23 | |Yes |
| 24 | +|No |
22 | 25 |
|
23 | 26 | |<<publish-agent-network-assets,publish_agent_network_assets>> |
24 | 27 | |Yes |
| 28 | +|No |
25 | 29 |
|
26 | 30 | .14+s|Application Development |
27 | 31 | |<<create-and-manage-assets,create_and_manage_assets>> |
28 | 32 | |No |
| 33 | +|No |
29 | 34 |
|
30 | 35 | |<<create-and-manage-metadata,create_and_manage_metadata>> |
31 | 36 | |Yes |
| 37 | +|No |
32 | 38 |
|
33 | 39 | |<<create-api-spec-project,create_api_spec_project>> |
34 | 40 | |No |
| 41 | +|No |
35 | 42 |
|
36 | 43 | |<<create-mcp-server,create_MCP_server>> |
37 | 44 | |No |
| 45 | +|No |
38 | 46 |
|
39 | 47 | |<<create-mule-project,create_mule_project>> |
40 | 48 | |No |
| 49 | +|No |
41 | 50 |
|
42 | 51 | |<<generate-api-spec,generate_api_spec>> |
43 | 52 | |No |
| 53 | +|No |
44 | 54 |
|
45 | 55 | |<<generate-mule-flow,generate_mule_flow>> |
46 | 56 | |No |
| 57 | +|No |
47 | 58 |
|
48 | 59 | |<<get-topics-agent-actions-metadata-instructions,get_topics_agent_actions_metadata_instructions>> |
49 | 60 | |Yes |
| 61 | +|No |
50 | 62 |
|
51 | 63 | |<<mock-api-spec,mock_api_spec>> |
52 | 64 | |Yes |
| 65 | +|No |
53 | 66 |
|
54 | 67 | |<<open-project,open_project>> |
55 | 68 | |Yes |
| 69 | +|No |
56 | 70 |
|
57 | 71 | |<<run-local-mule-application,run_local_mule_application>> |
58 | 72 | |No |
| 73 | +|No |
59 | 74 |
|
60 | 75 | |<<search-asset,search_asset>> |
61 | 76 | |No |
| 77 | +|No |
62 | 78 |
|
63 | 79 | |<<test-connection,test_connection>> |
64 | 80 | |Yes |
| 81 | +|No |
65 | 82 |
|
66 | 83 | |<<validate-project,validate_project>> |
67 | 84 | |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 |
68 | 99 |
|
69 | 100 | .7+s|DataWeave Development |
70 | 101 | |<<dataweave-create-documentation,dataweave_create_documentation>> |
71 | 102 | |No |
| 103 | +|No |
72 | 104 |
|
73 | 105 | |<<dataweave-create-project,dataweave_create_project>> |
74 | 106 | |No |
| 107 | +|No |
75 | 108 |
|
76 | 109 | |<<dataweave-create-sample-data,dataweave_create_sample_data>> |
77 | 110 | |No |
| 111 | +|No |
78 | 112 |
|
79 | 113 | |<<dataweave-get-module-metadata,dataweave_get_module_metadata>> |
80 | 114 | |No |
| 115 | +|No |
81 | 116 |
|
82 | 117 | |<<dataweave-get-project-metadata,dataweave_get_project_metadata>> |
83 | 118 | |No |
| 119 | +|No |
84 | 120 |
|
85 | 121 | |<<dataweave-open-project,dataweave_open_project>> |
86 | 122 | |No |
| 123 | +|No |
87 | 124 |
|
88 | 125 | |<<dataweave-run-script-tool,dataweave_run_script_tool>> |
89 | 126 | |No |
| 127 | +|No |
90 | 128 |
|
91 | 129 | .5+s|Application Management |
92 | 130 | |<<create-and-manage-api-instances,create_and_manage_api_instances>> |
93 | 131 | |No |
| 132 | +|No |
94 | 133 |
|
95 | 134 | |<<deploy-mule-application,deploy_mule_application>> |
96 | 135 | |No |
| 136 | +|No |
97 | 137 |
|
98 | 138 | |<<list-api-instances,list_api_instances>> |
99 | 139 | |No |
| 140 | +|No |
100 | 141 |
|
101 | 142 | |<<list-applications,list_applications>> |
102 | 143 | |No |
| 144 | +|No |
103 | 145 |
|
104 | 146 | |<<update-mule-application,update_mule_application>> |
105 | 147 | |No |
| 148 | +|No |
106 | 149 |
|
107 | 150 | .3+s|Governance |
108 | 151 | |<<add-governance-ruleset,add_governance_ruleset>> |
109 | 152 | |Yes |
| 153 | +|No |
110 | 154 |
|
111 | 155 | |<<list-governance-rulesets,list_governance_rulesets>> |
112 | 156 | |Yes |
| 157 | +|No |
113 | 158 |
|
114 | 159 | |<<validate-api-against-ruleset,validate_api_against_ruleset>> |
115 | 160 | |Yes |
| 161 | +|No |
116 | 162 |
|
117 | 163 | .3+s|Policy Management |
118 | 164 | |<<get-flex-gateway-policy-example,get_flex_gateway_policy_example>> |
119 | 165 | |No |
| 166 | +|No |
120 | 167 |
|
121 | 168 | |<<manage-api-instance-policy,manage_api_instance_policy>> |
122 | 169 | |No |
| 170 | +|No |
123 | 171 |
|
124 | 172 | |<<manage-flex-gateway-policy-project,manage_flex_gateway_policy_project>> |
125 | 173 | |No |
| 174 | +|No |
126 | 175 |
|
127 | 176 | .2+s|Usage and Insights |
128 | 177 | |<<get-platform-insights,get_platform_insights>> |
129 | 178 | |No |
| 179 | +|No |
130 | 180 |
|
131 | 181 | |<<get-reuse-metrics,get_reuse_metrics>> |
132 | 182 | |No |
| 183 | +|No |
133 | 184 |
|
134 | 185 | |=== |
135 | 186 |
|
@@ -1382,6 +1433,108 @@ Available only in Anypoint Code Builder. |
1382 | 1433 |
|
1383 | 1434 | |=== |
1384 | 1435 |
|
| 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 | + |
1385 | 1538 | [[update-mule-application]] |
1386 | 1539 | == update_mule_application |
1387 | 1540 |
|
@@ -1526,4 +1679,3 @@ Available only in Anypoint Code Builder. |
1526 | 1679 | == See Also |
1527 | 1680 |
|
1528 | 1681 | * xref:using-mulesoft-mcp-server.adoc[] |
1529 | | - |
|
0 commit comments