Merge branch 'latest' into W-20130245-troubleshoot-agent-networks-ie

IsaacEldridge · web-flow · commit d5dafda78d34 · 2026-01-30T12:06:37.000-08:00
diff --git a/modules/ROOT/assets/images/icon-gear.png b/modules/ROOT/assets/images/icon-gear.png
diff --git a/modules/ROOT/assets/images/icon-restart-mcp-server.png b/modules/ROOT/assets/images/icon-restart-mcp-server.png
diff --git a/modules/ROOT/assets/images/mcp-server-output-dropdown.png b/modules/ROOT/assets/images/mcp-server-output-dropdown.png
diff --git a/modules/ROOT/assets/images/mcp-server-settings.png b/modules/ROOT/assets/images/mcp-server-settings.png
diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc
@@ -112,6 +112,7 @@
 ** xref:troubleshoot-authentication-errors.adoc[]
 ** xref:troubleshoot-implementation-errors.adoc[]
 ** xref:troubleshoot-deploy-errors.adoc[]
+** xref:troubleshoot-mcp-server.adoc[]
 
 * xref:acb-reference.adoc[Reference]
 ** xref:ref-connectors.adoc[Connectors]
diff --git a/modules/ROOT/pages/a4d-mcp-server.adoc b/modules/ROOT/pages/a4d-mcp-server.adoc
@@ -1,92 +1,21 @@
 = Configure an MCP Server
 
+Add and manage MCP servers in Anypoint Code Builder to extend MuleSoft Dev Agent with tools for API design, integrations, governance, and agent networks. 
+
+== Use the MuleSoft MCP Server
+
 The MuleSoft MCP Server is integrated within Anypoint Code Builder and provides built-in tools to extend MuleSoft Dev Agent’s capabilities.
 
 You can use these tools to generate API specifications, create and deploy integrations, manage governance rulesets, and build Agent Fabric agent networks. You can also work with DataWeave and gain insights into the performance of your applications and APIs—all directly from Anypoint Code Builder.
 
 MuleSoft MCP Server tools are available in Anypoint Code Builder and are also supported when you use the Anypoint Extension Pack in compatible IDEs such as VS Code, Cursor, and Windsurf. 
 
-For more information about these tools and their parameters, see: xref:mulesoft-mcp-server::reference-mcp-tools.adoc[MuleSoft MCP Server Tool Reference].
-
-== Agent Network Development
-
-* `configure_agent_network_yaml` – Modify agent-network YAML configurations for Agent Fabric projects.
-* `create_agent_network_project` – Create and scaffold agent-network projects.
-* `deploy_agent_network` – Deploy an agent network to a runtime environment.
-* `publish_agent_network_assets` – Publish agent network assets to Anypoint Exchange for reuse.
-
-== Application Development
-
-* `create_and_manage_assets` – Create, update, and delete assets in Anypoint Exchange.
-* `create_and_manage_metadata` – Define, attach, and update metadata for Mule flow components.
-* `create_MCP_server` – Use the MCP Connector in a Mule project to create a MuleSoft MCP server.
-* `create_mule_project` – Create a Mule project structure in a given directory.
-* `generate_api_spec` – Use AI to generate, modify, or enhance an API specification.
-* `generate_mule_flow` – Generate or update Mule flows and integration logic from natural language prompts.
-* `generate_munit_test` - Generates MUnit test cases for Mule flows, one test scenario at a time, with support for mocks, assertions, and dependencies.
-* `get_topics_agent_actions_metadata_instructions` – Retrieve metadata and instructions for enabling topics and agent actions from an OpenAPI spec.
-* `implement_api_spec` - Use APIkit flows to implement an API specification in a new integration project. You can implement a specification from a local project or an Anypoint Exchange asset.
-* `mock_api_spec` – Mock an API specification to test endpoint functionality through a mocking service.
-* `modify_munit_test` - Modify or fix an existing MUnit test case, including updating assertions, mocks, payloads, and test logic.
-* `open_project` – Open or manage an existing API, Mule, or agent-network project.
-* `run_local_mule_application` – Run a Mule application locally, handling build and local runtime setup.
-* `search_asset` – Search for assets in Anypoint Exchange by using flexible filters and criteria.
-* `test_connection` – Validate connector configurations (such as HTTP or Salesforce connectors) in a Mule project.
-* `validate_project` – Validate the current project, such as an API spec or agent network project, before deploying or publishing.
-
-
-== Connector Development
-
-* `uc_create_connector_workflow` – Create a complete LinkWeave connector end-to-end with a guided workflow plan.
-* `uc_generate_api_spec` – Generate an OpenAPI 3.0 spec from use cases and API documentation.
-* `uc_generate_connector` – Generate a complete LinkWeave connector from an existing API spec.
-
-
-== DataWeave Development
-
-* `dataweave_create_documentation` – Generate DataWeave documentation for functions based on descriptions, parameters, and examples.
-* `dataweave_create_project` – Create a new DataWeave project and return the project location.
-* `dataweave_create_sample_data` – Create DataWeave input sample data for a given transformation file.
-* `dataweave_get_module_metadata` – Return functions, parameters, and types for a specific DataWeave module.
-* `dataweave_get_project_metadata` – Return metadata for a DataWeave project, including modules, functions, and supported data formats.
-* `dataweave_open_project` – Open a DataWeave project from a given URL in the current window or a new window.
-* `dataweave_run_script_tool` – Run a DataWeave transformation with sample data to validate the script output.
-
-
-== Application Management
-
-* `create_and_manage_api_instances` – Create and configure API instances in Anypoint API Manager.
-* `deploy_mule_application` – Deploy Mule applications to CloudHub 2.0 or Runtime Fabric with optional HA, security, and performance settings.
-* `list_api_instances` – List API instances in an environment and optionally include applied and available policies.
-* `list_applications` – List Mule applications in an environment and optionally include metrics and logs.
-* `update_mule_application` – Update a Mule application deployment configuration, including runtime version, replicas, and scaling options.
-
-
-=== Governance
-
-* `add_governance_ruleset` – Add a governance ruleset from Anypoint Exchange to your project.
-* `list_governance_rulesets` – List governance rulesets that apply to your project.
-* `validate_api_against_ruleset` – Validate an API spec against governance rulesets and rules.
-
-
-== Policy Management
-
-* `get_flex_gateway_policy_example` – Retrieve Flex Gateway policy examples to configure Rust-based custom policies.
-* `manage_api_instance_policy` – Apply or update policies on an API instance in API Manager.
-* `manage_flex_gateway_policy_project` – Guide the LLM in creating, configuring, building, and publishing Flex Gateway custom policy projects.
-
-
-== Usage and Insights
-
-* `get_platform_insights` – Get usage and operational insights for applications and APIs across your organization.
-* `get_reuse_metrics` – Get reuse metrics for assets across your organization to understand adoption and reduce duplication.
-
+For more information about the MuleSoft MCP Server tools and their parameters, see: xref:mulesoft-mcp-server::reference-mcp-tools.adoc[MuleSoft MCP Server Tool Reference].
 
 == Add and Manage Custom MCP Servers
 
 From the MuleSoft Dev Agent panel, you can add your own MCP server or manage connected MCP servers through the MCP Server settings.
 
-
 == Open MCP Server Settings
 
 . Open the MuleSoft Dev Agent panel in Anypoint Code Builder.
@@ -103,7 +32,6 @@ This opens the MCP Servers UI with three tabs:
 
 With these views, you can install new MCP servers, connect to remote MCP servers, and manage existing MCP servers.
 
-
 == Add an MCP Server
 
 You can add a custom MCP server by installing the server from the Marketplace, adding a remote MCP server, or manually editing the configuration file.
@@ -124,7 +52,6 @@ NOTE: Marketplace servers include community-provided MCP servers. Not all server
 . Click *Add Server* to connect to the remote instance.
 . (Optional) Select *Edit Configuration* to manually configure the MCP server by updating the `a4d_mcp_settings.json` file.
 
-
 === Manually Configure the JSON File
 
 If needed, you can configure MCP servers directly by editing the `a4d_mcp_settings.json` file:
@@ -145,7 +72,6 @@ Once an MCP server has been installed, you can manage it from the *Installed* ta
 . Toggle each MCP server on or off.
 . To restart a server, select *Restart Server* from its configuration panel.
 
-
 == Manage Tools for an MCP Server
 
 Each MCP server provides a set of tools that Dev Agent can use. The following steps show you how to work with an MCP server:
@@ -157,15 +83,13 @@ Each MCP server provides a set of tools that Dev Agent can use. The following st
 NOTE: Auto-approval for tools is available only if Auto-approve has been enabled in Dev Agent settings.
 . To auto-approve all tools from a server, scroll to the bottom of the list and enable *Auto-approve all tools*.
 
-
 == Configure Request Timeout
 
 Follow these steps to configure how long Dev Agent waits for a response from an MCP server:
 
 . In the server details panel, locate *Request Timeout*.
 . Select a timeout value.
 
-
 == Delete an MCP Server
 
 To remove an MCP server:
diff --git a/modules/ROOT/pages/des-create-api-specs.adoc b/modules/ROOT/pages/des-create-api-specs.adoc
@@ -4,7 +4,7 @@
 
 include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]
 
-Use Anypoint Code Builder to create, import, and test API specs before publishing to Anypoint Exchange:
+Use Anypoint Code Builder to create, import, and test API specs before publishing to Anypoint Exchange. You can start a new spec from the IDE or import an existing spec from MuleSoft Version Control System (VCS).
 
 . Create a API spec project in Anypoint Code Builder from the IDE or by importing the spec from MuleSoft VCS:
 
diff --git a/modules/ROOT/pages/int-create-secure-configs.adoc b/modules/ROOT/pages/int-create-secure-configs.adoc
@@ -7,7 +7,8 @@ include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]
 //LOGO (web, desktop, or both)
 // include::partial$acb-ide-logos.adoc[tags="both-ides"]
 
-Create properties that enable you to:
+Define configuration properties to secure and customize your Mule application configuration for different deployment environments.
+
 
 * Encrypt sensitive values used in your Mule application.
 * Define and use variables instead of literal strings when setting values in the configuration XML.
diff --git a/modules/ROOT/pages/int-migrate-studio-to-acb.adoc b/modules/ROOT/pages/int-migrate-studio-to-acb.adoc
@@ -1,4 +1,4 @@
-= Migrate Your Mule Project from Anypoint Studio to Anypoint Code Builder
+= Migrating Mule Projects from Anypoint Studio to Anypoint Code Builder
 :page-deployment-options: cloud-ide, desktop-ide
 
 Migrate your Mule project from Anypoint Studio to Anypoint Code Builder by creating a deployable Mule application archive (JAR file). 
diff --git a/modules/ROOT/pages/ref-components.adoc b/modules/ROOT/pages/ref-components.adoc
@@ -1,4 +1,3 @@
 = Core Processors
 
 include::anypoint-code-builder::partial$acb-component-info.adoc[tags="core-component-ref"]
-
diff --git a/modules/ROOT/pages/troubleshoot-mcp-server.adoc b/modules/ROOT/pages/troubleshoot-mcp-server.adoc
@@ -0,0 +1,94 @@
+= MCP Server Issues
+:page-deployment-options: cloud-ide, desktop-ide
+
+include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]
+
+When using the MuleSoft MCP Server in Anypoint Code Builder, you might encounter issues that prevent the server from functioning correctly. Follow these troubleshooting steps to diagnose and resolve common MCP server problems.
+
+[[verify-mcp-server]]
+== Verify the MCP Server Is Running
+
+If MuleSoft Dev Agent isn't responding to commands or tools aren't available, verify that the MuleSoft MCP Server is running:
+
+. Open the MuleSoft Dev Agent panel in Anypoint Code Builder.
+. Click *Manage MCP Servers*.
+. Click image:anypoint-code-builder::icon-gear.png["",18,18] (Settings) to open the MCP Server settings.
+. In the *Installed* tab, verify that the MuleSoft MCP Server is enabled (toggled on and marked in green).
++
+If the server is disabled, toggle it on to enable it.
++
+image:mcp-server-settings.png["The MCP server panel showing the Settings icon and the Enable toggle.",30%,30%]
+
+[[check-mcp-logs]]
+== Check MCP Server Logs
+
+When the MCP server isn't working as expected, check the logs to identify the cause:
+
+//step to open output panel:
+include::partial$acb-reusable-steps.adoc[tags="open-output-panel"]
+. From the dropdown list in the Output panel, select *Anypoint Code Builder - MCP Server*.
++
+image:mcp-server-output-dropdown.png["The outputs panel showing the MCP Server selected in the dropdown menu."]
+
+. Review the logged information for errors or warnings.
++
+The logs provide details about server operations, tool executions, and any errors that occur.
+
+You can also check the *Tasks* section in the Output panel for additional errors or warnings related to MCP server operations.
+
+[[restart-mcp-server]]
+== Restart the MCP Server
+
+If the MCP server stops responding or behaves unexpectedly, restart it:
+
+. Open the MuleSoft Dev Agent panel in Anypoint Code Builder.
+. Click *Manage MCP Servers*.
+. Click image:anypoint-code-builder::icon-gear.png["",18,18] (Settings) to open the MCP Server settings.
+. In the *Installed* tab, locate the MuleSoft MCP Server.
+. Click image:anypoint-code-builder::icon-restart-mcp-server.png["",18,18] (Restart Server).
++
+When the server restarts successfully, you see a confirmation message in the Output panel.
+
+If restarting doesn't resolve the issue, try disabling and then re-enabling the server.
+
+[[validate-mcp-server]]
+== Validate MCP Server Configuration
+
+You can validate whether the MCP server is running correctly by using third-party tools:
+
+. In the MCP Server settings, select *Configure MCP Servers* to view the server configuration.
+. Use an API client like Postman to send test requests to the MCP server endpoint.
+. Verify that the server responds correctly to your requests.
+
+If the server doesn't respond, check that the configuration in the `a4d_mcp_settings.json` file is correct.
+
+[[mcp-tools-unavailable]]
+== MCP Server Tools Are Unavailable
+
+If MCP server tools aren't appearing or aren't responding:
+
+. Verify that the MuleSoft MCP Server is enabled in the *Installed* tab of the MCP Server settings.
+. Check that the tools are enabled for the server:
++
+.. In the *Installed* tab, select the MuleSoft MCP Server to expand its details.
+.. Verify that the required tools are listed and enabled.
+. Restart the MCP server.
+. If the issue persists, check the MCP server logs for errors.
+
+[[mcp-timeout]]
+== MCP Server Request Timeout
+
+If requests to the MCP server are timing out:
+
+. Open the MCP Server settings.
+. In the *Installed* tab, select the MuleSoft MCP Server.
+. Locate the *Request Timeout* setting.
+. Increase the timeout value to allow more time for the server to respond.
+
+For complex operations, a longer timeout might be required.
+
+== See Also
+
+* xref:a4d-mcp-server.adoc[]
+* xref:troubleshooting.adoc[]
+* xref:troubleshoot-generative-ai.adoc[]
diff --git a/modules/ROOT/pages/troubleshoot-missing-features.adoc b/modules/ROOT/pages/troubleshoot-missing-features.adoc
@@ -63,7 +63,7 @@ Workspace: Configure Workspace Trust Settings
 ----
 . Review and adjust the workspace settings, as needed.
 
-== Incomplete Flow
+== Incomplete Flow or Corrupted XML
 
 If a flow lacks a component or contains only a trigger, such as an HTTP Listener operation or the Scheduler, an error similar to the following appears in the *Problems* panel and from the configuration XML: 
 
@@ -78,3 +78,4 @@ To address this issue, add processing components or connector operations to your
 // Pointer to component reference:
 include::partial$acb-component-info.adoc[tags="note-component-ref"]
 
+This error can also occur if XML tags in the configuration file are corrupted or not properly closed. If you've already added components and the error persists, check the configuration XML for unclosed tags. To prevent XML corruption, save your work frequently and use source control management (SCM) to back up your projects.
diff --git a/modules/ROOT/pages/troubleshoot-mule-runtime-errors.adoc b/modules/ROOT/pages/troubleshoot-mule-runtime-errors.adoc
@@ -61,3 +61,19 @@ This request is _not_ from MuleSoft or Anypoint Code Builder:
 image::troubleshoot-download-java-notification.png["Notification showing a request to download and install a JDK to compile a project"]
 
 Instead of using this feature, you can use the command *Download Mule Runtime and Java Versions*. See xref:anypoint-code-builder::int-versions.adoc[].
+
+[[reinstall-mule-runtime]]
+== Reinstall Mule Runtime
+
+If your Mule runtime installation becomes corrupted, you can force a reinstallation:
+
+. Close Anypoint Code Builder.
+. Navigate to your Mule runtimes directory: `${user.home}/AnypointCodeBuilder/runtimes`.
+. Remove or rename the folder for the runtime version you want to reinstall (for example, `mule-4.6.0`).
+. Open Anypoint Code Builder.
+. Select the Mule runtime version from *Project Properties*.
++
+The IDE downloads and reinstalls the selected version. For details on selecting versions, see xref:int-versions.adoc#project-version-mule-java[Select Mule and Java Versions for a Project].
+
+[NOTE]
+Your projects and other installed runtimes are not affected.
diff --git a/modules/ROOT/pages/troubleshooting.adoc b/modules/ROOT/pages/troubleshooting.adoc
@@ -7,14 +7,15 @@ include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]
 //LOGO (web, desktop, or both)
 // include::partial$acb-ide-logos.adoc[tags="both-ides"]
 
-Troubleshoot errors and warnings you receive when using Anypoint Code Builder:
+Troubleshoot errors and warnings you encounter when using Anypoint Code Builder.
 
 * xref:troubleshoot-missing-features.adoc[]
 * xref:troubleshoot-authentication-errors.adoc[]
 * xref:troubleshoot-deploy-errors.adoc[]
 * xref:troubleshoot-implementation-errors.adoc[]
 * xref:troubleshoot-mule-runtime-errors.adoc[]
 * xref:troubleshoot-loading-errors.adoc[]
+* xref:troubleshoot-mcp-server.adoc[]
 +
 For other issues and workarounds, see xref:acb-release-notes.adoc#known-issues[Known Issues] in the Anypoint Code Builder Release Notes.
 
@@ -140,3 +141,33 @@ The configuration sidebar also displays validation messages at the node level.
 Field-level errors appear inline during component configuration.
 
 Hover over a component with a red dot to view error details in the canvas.
+
+[[clean-reinstall]]
+== Perform a Clean Reinstallation
+
+If you experience persistent issues that other troubleshooting steps don't resolve, perform a clean reinstallation of Anypoint Extension Pack:
+
+. Close VS Code completely.
+. Uninstall Anypoint Extension Pack:
++
+.. Open VS Code.
+.. From the Activity Bar, open the *Extensions* panel.
+.. Find and select *Anypoint Extension Pack*.
+.. Click *Uninstall*.
+.. Close VS Code.
+. Delete the `anypoint-code-builder` folder from your user directory:
++
+* Mac: `~/AnypointCodeBuilder`
+* Windows: `C:\Users\<username>\AnypointCodeBuilder`
+. Optionally, delete cached extension data from the VS Code extensions folder:
++
+* Mac: `~/.vscode/extensions/`
+* Windows: `C:\Users\<username>\.vscode\extensions\`
++
+Remove any folders starting with `salesforce.mule-dx-` or `mulesoftinc.mule-dx-`.
+. Reopen VS Code and reinstall Anypoint Extension Pack from the Extensions Marketplace.
+
+[NOTE]
+--
+This procedure removes downloaded Mule runtimes and Java versions. You can re-download them after reinstalling.
+--
diff --git a/modules/ROOT/pages/tut-af-amflights-overview.adoc b/modules/ROOT/pages/tut-af-amflights-overview.adoc
@@ -2,7 +2,7 @@
 :page-deployment-options: cloud-ide, desktop-ide
 :page-pagination: next
 
-Use Anypoint Code Builder to create and implement an API specification that returns flight information from a MySQL database: 
+Use Anypoint Code Builder to create and implement an API specification that returns flight information from a MySQL database.
 
 . xref:tut-af-design-am-flights-api.adoc[]:
 
diff --git a/modules/ROOT/pages/tutorials.adoc b/modules/ROOT/pages/tutorials.adoc
@@ -7,6 +7,8 @@ include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]
 //LOGO (web, desktop, or both)
 // include::partial$acb-ide-logos.adoc[tags="both-ides"]
 
+Follow these hands-on tutorials to learn how to design, implement, and integrate APIs using Anypoint Code Builder.
+
 * xref:tut-af-amflights-overview.adoc[]: 
 +
 Use Anypoint Code Builder to design and implement an API specification example called American Flights API that returns flight information from a MySQL database.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-= Migrate Your Mule Project from Anypoint Studio to Anypoint Code Builder`
	`1`	`+= Migrating Mule Projects from Anypoint Studio to Anypoint Code Builder`
`2`	`2`	`:page-deployment-options: cloud-ide, desktop-ide`
`3`	`3`
`4`	`4`	`Migrate your Mule project from Anypoint Studio to Anypoint Code Builder by creating a deployable Mule application archive (JAR file).`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`	`1`	`= Core Processors`
`2`	`2`
`3`	`3`	`include::anypoint-code-builder::partial$acb-component-info.adoc[tags="core-component-ref"]`
`4`		`-`