Skip to content

Commit c47e027

Browse files
Merge branch 'latest' into W-21090962-update-titles-descriptions
2 parents 68c9ff1 + bb2d818 commit c47e027

10 files changed

Lines changed: 193 additions & 8 deletions
13.7 KB
Loading
10.8 KB
Loading
132 KB
Loading
18.7 KB
Loading

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@
112112
** xref:troubleshoot-authentication-errors.adoc[]
113113
** xref:troubleshoot-implementation-errors.adoc[]
114114
** xref:troubleshoot-deploy-errors.adoc[]
115+
** xref:troubleshoot-mcp-server.adoc[]
115116
116117
* xref:acb-reference.adoc[Reference]
117118
** xref:ref-connectors.adoc[Connectors]

modules/ROOT/pages/af-project-files.adoc

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -738,7 +738,7 @@ connections:
738738
ref:
739739
name: my-openAI
740740
spec:
741-
url: ${}
741+
url: https://api.openai.com/v1/
742742
configuration:
743743
apiKey: ${openai.apiKey}
744744
@@ -748,13 +748,21 @@ connections:
748748
name: talent-pool-mcp
749749
spec:
750750
url: https://talent-pool-mcp-server-inkbh1.paga8m.usa-w1.cloudhub.io/
751+
authentication:
752+
kind: apiKey
753+
apiKey: ${talentPool.apiKey} # Define variable in exchange.json
754+
headerName: X-MCP-API-Key # Optional, defaults to Authorization
751755
752756
slack-mcp:
753757
kind: mcp
754758
ref:
755759
name: slack-mcp
756760
spec:
757761
url: https://slack-mcp-server-inkbh1.paga8m.usa-w1.cloudhub.io/
762+
authentication:
763+
kind: apiKey
764+
apiKey: ${slack.apiKey} # Define variable in exchange.json
765+
headerName: X-API-Key
758766
----
759767

760768
The `connections` element has these properties.
@@ -847,41 +855,75 @@ Connection authentication is always expressed in accordance with https://swagger
847855

848856
These examples show how to define each type in YAML.
849857

858+
Both agents and MCP servers support the same authentication types with custom header capabilities API Key Authentication and Basic Authentication.
859+
860+
850861
[[basic-authentication]]
851-
==== Basic authentication
862+
==== Basic Authentication
852863

853864
[source,yaml]
854865
----
855866
authentication:
856-
type: basic
867+
Kind: basic
868+
username: "username"
869+
password: "password"
870+
----
871+
872+
Using custom header:
873+
874+
[source,yaml]
875+
----
876+
kind: basic
857877
username: "username"
858878
password: "password"
879+
headerName: X-API-Authorization # Custom header instead of default "Authorization"
859880
----
860881

861882
[[oauth-client-credentials]]
862-
==== OAuth 2.0 client credentials
883+
==== OAuth 2.0 Client Credentials
863884

864885
[source,yaml]
865886
----
866887
authentication:
867-
type: oauth2-client-credentials
888+
kind: oauth2-client-credentials
868889
clientId: "client_id"
869890
clientSecret: "client_secret"
870891
tokenUrl: "https://oauth.provider.com/token"
871892
scopes: ["read", "write"] # Optional
872893
----
873894

874895
[[anypoint-client-credentials]]
875-
==== Anypoint client credentials
896+
==== Anypoint Client Credentials
876897

877898
[source,yaml]
878899
----
879900
authentication:
880-
type: apikey-client-credentials
901+
kind: apikey-client-credentials
881902
clientId: "client_id"
882903
clientSecret: "client_secret"
883904
----
884905

906+
[[api-key]]
907+
==== API Key Authentication
908+
909+
[source,yaml]
910+
----
911+
authentication:
912+
kind: api-key
913+
apiKey: ${agent.apiKey} # Define variable in exchange.json
914+
headerName: X-API-Key # Optional, defaults to Authorization
915+
----
916+
917+
Using custom header:
918+
919+
[source,yaml]
920+
----
921+
authentication:
922+
kind: apiKey
923+
apiKey: ${agent.apiKey}
924+
headerName: X-Custom-Auth-Token # Custom header name
925+
----
926+
885927
[[exchange-json-file-element]]
886928
== exchange.json File Element
887929

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
= MCP Server Issues
2+
:page-deployment-options: cloud-ide, desktop-ide
3+
4+
include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]
5+
6+
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.
7+
8+
[[verify-mcp-server]]
9+
== Verify the MCP Server Is Running
10+
11+
If MuleSoft Dev Agent isn't responding to commands or tools aren't available, verify that the MuleSoft MCP Server is running:
12+
13+
. Open the MuleSoft Dev Agent panel in Anypoint Code Builder.
14+
. Click *Manage MCP Servers*.
15+
. Click image:anypoint-code-builder::icon-gear.png["",18,18] (Settings) to open the MCP Server settings.
16+
. In the *Installed* tab, verify that the MuleSoft MCP Server is enabled (toggled on and marked in green).
17+
+
18+
If the server is disabled, toggle it on to enable it.
19+
+
20+
image:mcp-server-settings.png["The MCP server panel showing the Settings icon and the Enable toggle.",30%,30%]
21+
22+
[[check-mcp-logs]]
23+
== Check MCP Server Logs
24+
25+
When the MCP server isn't working as expected, check the logs to identify the cause:
26+
27+
//step to open output panel:
28+
include::partial$acb-reusable-steps.adoc[tags="open-output-panel"]
29+
. From the dropdown list in the Output panel, select *Anypoint Code Builder - MCP Server*.
30+
+
31+
image:mcp-server-output-dropdown.png["The outputs panel showing the MCP Server selected in the dropdown menu."]
32+
33+
. Review the logged information for errors or warnings.
34+
+
35+
The logs provide details about server operations, tool executions, and any errors that occur.
36+
37+
You can also check the *Tasks* section in the Output panel for additional errors or warnings related to MCP server operations.
38+
39+
[[restart-mcp-server]]
40+
== Restart the MCP Server
41+
42+
If the MCP server stops responding or behaves unexpectedly, restart it:
43+
44+
. Open the MuleSoft Dev Agent panel in Anypoint Code Builder.
45+
. Click *Manage MCP Servers*.
46+
. Click image:anypoint-code-builder::icon-gear.png["",18,18] (Settings) to open the MCP Server settings.
47+
. In the *Installed* tab, locate the MuleSoft MCP Server.
48+
. Click image:anypoint-code-builder::icon-restart-mcp-server.png["",18,18] (Restart Server).
49+
+
50+
When the server restarts successfully, you see a confirmation message in the Output panel.
51+
52+
If restarting doesn't resolve the issue, try disabling and then re-enabling the server.
53+
54+
[[validate-mcp-server]]
55+
== Validate MCP Server Configuration
56+
57+
You can validate whether the MCP server is running correctly by using third-party tools:
58+
59+
. In the MCP Server settings, select *Configure MCP Servers* to view the server configuration.
60+
. Use an API client like Postman to send test requests to the MCP server endpoint.
61+
. Verify that the server responds correctly to your requests.
62+
63+
If the server doesn't respond, check that the configuration in the `a4d_mcp_settings.json` file is correct.
64+
65+
[[mcp-tools-unavailable]]
66+
== MCP Server Tools Are Unavailable
67+
68+
If MCP server tools aren't appearing or aren't responding:
69+
70+
. Verify that the MuleSoft MCP Server is enabled in the *Installed* tab of the MCP Server settings.
71+
. Check that the tools are enabled for the server:
72+
+
73+
.. In the *Installed* tab, select the MuleSoft MCP Server to expand its details.
74+
.. Verify that the required tools are listed and enabled.
75+
. Restart the MCP server.
76+
. If the issue persists, check the MCP server logs for errors.
77+
78+
[[mcp-timeout]]
79+
== MCP Server Request Timeout
80+
81+
If requests to the MCP server are timing out:
82+
83+
. Open the MCP Server settings.
84+
. In the *Installed* tab, select the MuleSoft MCP Server.
85+
. Locate the *Request Timeout* setting.
86+
. Increase the timeout value to allow more time for the server to respond.
87+
88+
For complex operations, a longer timeout might be required.
89+
90+
== See Also
91+
92+
* xref:a4d-mcp-server.adoc[]
93+
* xref:troubleshooting.adoc[]
94+
* xref:troubleshoot-generative-ai.adoc[]

modules/ROOT/pages/troubleshoot-missing-features.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Workspace: Configure Workspace Trust Settings
6363
----
6464
. Review and adjust the workspace settings, as needed.
6565

66-
== Incomplete Flow
66+
== Incomplete Flow or Corrupted XML
6767

6868
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:
6969

@@ -78,3 +78,4 @@ To address this issue, add processing components or connector operations to your
7878
// Pointer to component reference:
7979
include::partial$acb-component-info.adoc[tags="note-component-ref"]
8080

81+
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.

modules/ROOT/pages/troubleshoot-mule-runtime-errors.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,19 @@ This request is _not_ from MuleSoft or Anypoint Code Builder:
6161
image::troubleshoot-download-java-notification.png["Notification showing a request to download and install a JDK to compile a project"]
6262

6363
Instead of using this feature, you can use the command *Download Mule Runtime and Java Versions*. See xref:anypoint-code-builder::int-versions.adoc[].
64+
65+
[[reinstall-mule-runtime]]
66+
== Reinstall Mule Runtime
67+
68+
If your Mule runtime installation becomes corrupted, you can force a reinstallation:
69+
70+
. Close Anypoint Code Builder.
71+
. Navigate to your Mule runtimes directory: `${user.home}/AnypointCodeBuilder/runtimes`.
72+
. Remove or rename the folder for the runtime version you want to reinstall (for example, `mule-4.6.0`).
73+
. Open Anypoint Code Builder.
74+
. Select the Mule runtime version from *Project Properties*.
75+
+
76+
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].
77+
78+
[NOTE]
79+
Your projects and other installed runtimes are not affected.

modules/ROOT/pages/troubleshooting.adoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Troubleshoot errors and warnings you encounter when using Anypoint Code Builder.
1515
* xref:troubleshoot-implementation-errors.adoc[]
1616
* xref:troubleshoot-mule-runtime-errors.adoc[]
1717
* xref:troubleshoot-loading-errors.adoc[]
18+
* xref:troubleshoot-mcp-server.adoc[]
1819
+
1920
For other issues and workarounds, see xref:acb-release-notes.adoc#known-issues[Known Issues] in the Anypoint Code Builder Release Notes.
2021
@@ -140,3 +141,33 @@ The configuration sidebar also displays validation messages at the node level.
140141
Field-level errors appear inline during component configuration.
141142

142143
Hover over a component with a red dot to view error details in the canvas.
144+
145+
[[clean-reinstall]]
146+
== Perform a Clean Reinstallation
147+
148+
If you experience persistent issues that other troubleshooting steps don't resolve, perform a clean reinstallation of Anypoint Extension Pack:
149+
150+
. Close VS Code completely.
151+
. Uninstall Anypoint Extension Pack:
152+
+
153+
.. Open VS Code.
154+
.. From the Activity Bar, open the *Extensions* panel.
155+
.. Find and select *Anypoint Extension Pack*.
156+
.. Click *Uninstall*.
157+
.. Close VS Code.
158+
. Delete the `anypoint-code-builder` folder from your user directory:
159+
+
160+
* Mac: `~/AnypointCodeBuilder`
161+
* Windows: `C:\Users\<username>\AnypointCodeBuilder`
162+
. Optionally, delete cached extension data from the VS Code extensions folder:
163+
+
164+
* Mac: `~/.vscode/extensions/`
165+
* Windows: `C:\Users\<username>\.vscode\extensions\`
166+
+
167+
Remove any folders starting with `salesforce.mule-dx-` or `mulesoftinc.mule-dx-`.
168+
. Reopen VS Code and reinstall Anypoint Extension Pack from the Extensions Marketplace.
169+
170+
[NOTE]
171+
--
172+
This procedure removes downloaded Mule runtimes and Java versions. You can re-download them after reinstalling.
173+
--

0 commit comments

Comments
 (0)