You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/marketplace/genai/reference-guide/mcp-modules/mcp-client.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,6 @@ If the tool resides within the same Mendix application, you can integrate it wit
21
21
The current version has the following limitations:
22
22
23
23
* Tools and prompt messages can only return String content.
24
-
* Only HTTP+SSE transport is currently supported to communicate with MCP servers.
25
24
26
25
{{% alert color="info" %}}
27
26
Note that the MCP Client module is still in its early version, and newer versions may include breaking changes. Since both the open-source protocol and the Java SDK are still evolving and regularly updated, these changes may also affect this module.
@@ -52,7 +51,7 @@ See the **Example Implementations** folder inside the module containing example
52
51
53
52
#### Protocol Version
54
53
55
-
When creating an MCP client, specify a `ProtocolVersion`. On the official MCP documentation, you can review the differences between the protocol versions in the [changelog](https://modelcontextprotocol.io/specification/2025-03-26/changelog). The MCP Client module currently only supports `v2024-11-05`and the HTTP+SSE transport. MCP servers should support the same version as the client. Note that Mendix supports the capabilities provided by the MCP Java SDK.
54
+
When creating an MCP client, specify a `ProtocolVersion`. On the official MCP documentation, you can review the differences between the protocol versions in the [changelog](https://modelcontextprotocol.io/specification/2025-03-26/changelog). The MCP Client module currently only supports `v2024-11-05`with the HTTP+SSE transport and `v2025-03-25` with the Streamable HTTP transport, which is the new standard transport. MCP servers should support the same version as the client. Note that Mendix supports the capabilities provided by the MCP Java SDK.
56
55
57
56
### Discovering Resources {#discover-resources}
58
57
@@ -64,7 +63,7 @@ In general, prompts are often exposed to end-users in a chat to start or continu
64
63
65
64
To use a prompt from an MCP Server, you can use the `Get Prompt` action to receive one or multiple `PromptMessages` from the server associated with the `PromptResult` object. Similarly, to use a tool, you can use the `Call Tool` action to receive a `ToolResult` object that contains the return message of the tool.
66
65
67
-
For both actions, you can pass an `ArgumentCollection` if the prompt or tool requires arguments (the information is available from the [discovered resources](#discover-resources)). The actions `Initialize Argument Collection` and `Argument Collection: Add New Input` help you construct the input for those actions.
66
+
For both actions, you can pass an `ArgumentCollection` if the prompt or tool requires arguments (the information is available from the [discovered resources](#discover-resources)). The actions `Argument Collection: Initialize` and `Argument Collection: Add New Input` help you construct the input for those actions.
68
67
69
68
### Using MCP Client Module with GenAI Commons and Conversational UI {#use-with-genai-commons}
70
69
@@ -89,7 +88,7 @@ The **Documentation** pane displays the documentation for the currently selected
89
88
90
89
### MCP Client Cannot Connect to the MCP Server
91
90
92
-
There are several possible reasons why the client cannot connect to your server. First, check the MCP Client logs. Then, verify that the endpoint is set to the correct URL and that the server supports the same protocol version and transport method (HTTP + SSE) as the client. If authentication is required, make sure to pass the necessary information via HTTP headers.
91
+
There are several possible reasons why the client cannot connect to your server. First, check the MCP Client logs. Then, verify that the endpoint is set to the correct URL and that the server supports the same protocol version and transport method (HTTP + SSE or Streamable HTTP) as the client. If authentication is required, make sure to pass the necessary information via HTTP headers.
Copy file name to clipboardExpand all lines: content/en/docs/marketplace/genai/reference-guide/mcp-modules/mcp-server.md
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,9 +23,8 @@ The current version has the following limitations:
23
23
24
24
* Tools can only return String values, either directly as String type or using the `TextContent` entity.
25
25
* Prompts can only return a single message.
26
-
* The client connection remains active for only 15 minutes, as the Mendix runtime currently does not support async requests.
27
26
* Running an MCP Server is currently only supported on single-instance environments.
28
-
*The tool fails to return responses with large payloads to the client successfully. This issue is currently under investigation.
27
+
*For HTTP+SSE transport (protocol version `v2024-11-05`), tool execution with large payloads are not returned successfully
29
28
30
29
Note that the MCP Server module is still in its early version and latest versions may include breaking changes. Since both the open-source protocol and the Java SDK are still evolving and regularly updated, these changes may also affect this module.
31
30
@@ -39,7 +38,7 @@ If you start from a standard Mendix blank app, or have an existing project, you
39
38
40
39
### Create MCP Server {#create-server}
41
40
42
-
The `Create MCP Server` action initializes an MCP server in the Mendix runtime, creates and returns the `MCPServer` object. You can use the created `MCPServer` to add tools or prompts. The `Path` attribute determines how external systems can reach the MCP server, that means this value needs to be known to the the MCP Client (usually set in a configuration file). After the action gets triggered, the server becomes available for external clients to connect. As mentioned in the [limitations](#limitations) section above, the connection remains active for only 15 minutes.
41
+
The `Create MCP Server` action initializes an MCP server in the Mendix runtime, creates and returns the `MCPServer` object. You can use the created `MCPServer` to add tools or prompts. The `Path` attribute determines how external systems can reach the MCP server, that means this value needs to be known to the the MCP Client (usually set in a configuration file). After the action gets triggered, the server becomes available for external clients to connect. Note that the path cannot be `sse` nor `mcp` and cannot end on `/sse` nor `/mcp`, because those are reserved endpoints.
43
42
44
43
Based on your use case, this action can be triggered manually by an admin if wrapped around a microflow accessible in the UI, via an after start-up microflow, or by any other microflow such as a scheduled event.
45
44
@@ -62,7 +61,7 @@ The `User` returned in the microflow is used for all subsequent prompt and tool
62
61
63
62
#### Protocol Version
64
63
65
-
When creating an MCP server, you need to specify a `ProtocolVersion`. On the official MCP documentation, you can review the differences between the protocol versions in the [changelog](https://modelcontextprotocol.io/specification/2025-03-26/changelog). The MCP Server module currently only supports `v2024-11-05`and the HTTP+SSE transport. MCP Clients, that need to connect to a Mendix MCP server, should support the same version. Note that Mendix follows the offered capabilities of the MCP Java SDK.
64
+
When creating an MCP server, you need to specify a `ProtocolVersion`. On the official MCP documentation, you can review the differences between the protocol versions in the [changelog](https://modelcontextprotocol.io/specification/2025-03-26/changelog). The MCP Server module currently only supports `v2024-11-05`with the HTTP+SSE transport and `v2025-03-25` with the Streamable HTTP transport, which is the new standard transport. MCP Clients, that need to connect to a Mendix MCP server, should support the same version. Note that Mendix follows the offered capabilities of the MCP Java SDK.
66
65
67
66
### Add Tools
68
67
@@ -76,7 +75,7 @@ The selected microflow must adhere to the following principles:
76
75
For an example, see the `Example Implementations` folder inside of the module.
77
76
78
77
{{% alert color="warning" %}}
79
-
Function calling is a highly effective capability and should be used with caution.
78
+
Function / tool calling is a highly effective capability and should be used with caution.
80
79
81
80
Mendix strongly recommends keeping the user in the loop (such as by using confirmation logic which is integrated into many MCP clients), if the tool microflows have a potential impact on the real world on behalf of the end-user. Examples include sending emails, posting content online, or making purchases. In such cases, evaluate the use cases and implement security measures when exposing these tools to external AI systems via MCP.
0 commit comments