Using Anypoint Studio to Configure MCP Connector 0.1.0-BETA - Mule 4

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files.

To add and configure a connector in Studio:

Create a Mule project.
Add the connector to your Mule project.
Configure a source for the connector’s flow.
Add a connector operation to the flow.
Configure a global element for the connector.
Configure the other connector fields.
Debug the app.
View the App Log.
Deploy the app.

If you are new to configuring connectors in Studio, see Using Anypoint Studio to Configure a Connector. If, after reading this topic, you need additional information about the connector fields, see the MCP Connector Reference.

Before You Begin

Add the -Dmule.http.service.implementation=NETTY property to your AnypointStudio.ini file.

On Mac OS:

Go to your /Applications folder, right-click the AnypointStudio package and select Show Package Contents.
Go to Contents > Eclipse, and open the AnypointStudio.ini file.

Add the -Dmule.http.service.implementation=NETTY property:

-Dorg.mule.tooling.runtime.args=-XX:-UseBiasedLocking,-Dfile.encoding=UTF-8,-XX:+UseG1GC,-XX:+UseStringDeduplication,-Dmule.deployment.forceParseConfigXmls=true,-Dmule.http.service.implementation=NETTY

On Windows:

Locate your AnypointStudio.ini file inside your Anypoint Studio installation directory.

Add the -Dmule.http.service.implementation=NETTY property:

-Dorg.mule.tooling.runtime.args=-XX:-UseBiasedLocking,-Dfile.encoding=UTF-8,-XX:+UseG1GC,-XX:+UseStringDeduplication,-Dmule.deployment.forceParseConfigXmls=true,-Dmule.http.service.implementation=NETTY

Create a Mule Project

In Studio, create a new Mule project in which to add and configure Anypoint Connector for MCP (MCP Connector):

In Studio, select File > New > Mule Project.
Enter a name for your Mule project and click Finish.

Add the Connector to Your Mule Project

Add MCP Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s pom.xml file:

In Mule Palette, click (X) Search in Exchange.
In Add Dependencies to Project, type mcp in the search field.
Click MCP Connector in Available modules.
Click Add.
Click Finish.

Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace.

Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources to use with MCP Connector:

On New Session Listener
Resource Listener
Tool Listener
HTTP > Listener

Initiates a flow each time it receives a request on the configured host and port
Scheduler

Initiates a flow when a time-based condition is met

For example, to configure an HTTP > Listener source, follow these steps:

In Mule Palette, select HTTP > Listener.
Drag Listener to the Studio canvas.
On the Listener configuration screen, optionally change the value of the Display Name field.
Specify a value for the Path field.
Click the plus sign (+) next to the Connector configuration field to configure a global element that can be used by all instances of the HTTP > Listener source in the app.
On the General tab, specify the connection information for the connector.
On the TLS tab, optionally specify the TLS information for the connector.
On the Advanced tab, optionally specify reconnection information, including a reconnection strategy.
Click Test Connection to confirm that Mule can connect with the specified server.
Click OK.

Add a Connector Operation to the Flow

When you add a connector operation to your flow, you are specifying an action for that connector to perform.

To add an operation for MCP Connector, follow these steps:

In Mule Palette, select MCP and then select the desired operation.
Drag the operation onto the Studio canvas, next to the source.

Configure a Global Element for the Connector

When you configure a connector, configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target MCP system.

You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see Anypoint Connector Configuration.

To configure the global element for MCP Connector, follow these steps:

Select the operation in the Studio canvas.
On the properties screen for the operation, click the Add (+) icon to access the global element configuration fields.
In the General tab, in Connection, select the authentication method to configure. The MCP protocol’s security is mostly based on the OAuth Authorization Code flow. To keep it compatible with different systems and uses, the connector also supports other authentication methods, including:

On the TLS tab, optionally specify the TLS information for the connector.
On the Advanced tab, optionally specify reconnection information, including a reconnection strategy.
Click Test Connection to confirm that Mule can connect with the specified server.
Click OK.

Basic Authentication

Enter the following information in the General tab of the Global Element Properties screen to configure Basic authentication:

Field User Action

Field	User Action
Name	Enter the configuration name.
Connection	Select Basic.
Session Token	Optionally enter the session token provided by Amazon Security Token Service (STS).
Access Key	Enter the access key provided by Amazon.
Secret Key	Enter the secret key provided by Amazon.
Try Default AWS Credentials Provider Chain	Set to `true` to obtain credentials from the AWS environment.
Region Endpoint	Select the region endpoint for the service.

Name

Enter the configuration name.

Connection

Select Basic.

Session Token

Optionally enter the session token provided by Amazon Security Token Service (STS).

Access Key

Enter the access key provided by Amazon.

Secret Key

Enter the secret key provided by Amazon.

Try Default AWS Credentials Provider Chain

Set to true to obtain credentials from the AWS environment.

Region Endpoint

Select the region endpoint for the service.

OAuth Authorization Code

Used when the client is acting on behalf of an enduser (human). For instance, an agent calls an MCP tool implemented by a SaaS system.

OAuth Client Credentials

Used for machine-to-machine authentication. The client application authenticates itself directly with the authorization server using its client ID and client secret, and receives an access token.

This is used when an application is accessing resources on its own behalf, not on behalf of a user.

Digest

An HTTP authentication scheme that uses a challenge-response mechanism to avoid sending passwords in plain text. It involves hashing the password and other information to verify the client’s identity.

NTLM

A Microsoft authentication protocol used primarily in Windows environments. It uses a challenge-response mechanism and is commonly used for network authentication.

Configure Additional Connector Fields

After you configure a global element for MCP Connector, configure the other required fields for the connector. The required fields vary depending on which connector operation you use.

Debug the App

Debug your Mule application using the embedded debugger in Studio.

Before debugging your app, add the -Dmule.http.service.implementation=NETTY property to your debug configuration.

See Logging and Debugging.

View the Application Log

To check for problems, you can view the app log as follows:

If you’re running the app from Anypoint Platform, the app log output is visible on the Anypoint Studio console window.
If you’re running the app using Mule from the command line, the app log output is visible in your operating system console.

Unless the log file path is customized in the app’s log file (log4j2.xml), you can also view the app log in the default location MULE_HOME/logs/<app-name>.log. You can configure the location of the log path in the app log file log4j2.xml.

Deploy the App

Before you deploy the app:

Add the -Dmule.http.service.implementation=NETTY property to your app in Runtime Manager for CloudHub 2 and Runtime Fabric deployments. For more information, see Deploying Apps to CloudHub 2.0 and Deploying Mule Apps to Runtime Fabric Using Runtime Manager.

For hybrid deployments, add the property to whatever you use to start Mule apps. For more information, see Deploy to Your Servers.