From db0fae078d9773586e559b7e70a5e9d4b98d44f9 Mon Sep 17 00:00:00 2001 From: Liam Sommer Date: Thu, 27 Aug 2026 12:11:57 +0200 Subject: [PATCH 1/4] added published mcp service docs --- .../genai/v2/reference-guide/agent-editor.md | 20 +++++++++++++++++++ .../reference-guide/mcp-modules/mcp-server.md | 4 ++++ 2 files changed, 24 insertions(+) diff --git a/content/en/docs/genai/v2/reference-guide/agent-editor.md b/content/en/docs/genai/v2/reference-guide/agent-editor.md index 60eaff72bbd..5bfe176b2d5 100644 --- a/content/en/docs/genai/v2/reference-guide/agent-editor.md +++ b/content/en/docs/genai/v2/reference-guide/agent-editor.md @@ -71,6 +71,8 @@ Depending on the LLM and Knowledge bases used in your setup, you need to install * [Mendix Cloud GenAI Connector](https://marketplace.mendix.com/link/component/239449) for Mendix Cloud GenAI resources (text generation and knowledge bases) * [OpenAI Connector](https://marketplace.mendix.com/link/component/220472) for Azure AI Foundry resources (text generation model deployments supporting chat completions) +If you configure [published MCP services](#published-mcp-service), install the [MCP Server](https://marketplace.mendix.com/link/component/240380) module. + In addition, ensure the following widgets are available in your app: * [Events Widget](https://marketplace.mendix.com/link/component/224259) @@ -276,11 +278,29 @@ To change any agentic logic, update the Agent documents (and related documents) Use version control to view and restore previous agent versions. This lets you inspect earlier committed states of the Agent document and related documents, compare changes over time, and restore configurations as needed. +## Configuring Published MCP Service {#published-mcp-service} + +You can publish MCP services from Agent Editor to expose tools from your app to external agents and other MCP clients. This configuration uses the [MCP Server module](/agents/agents-kit-2/reference-guide/mcp-modules/mcp-server/). For detailed information about securing an MCP server, see the MCP Server module documentation. + +To create a published MCP service, right-click the module or folder where you want to create the document in the **App Explorer**, then select **Add other** > **Published MCP Service**. + +In the published MCP service document, configure the following fields: + +* **Name**: Enter the name of the MCP service. +* **Description**: Describe the MCP service so MCP clients can identify its purpose. +* **Version** (optional): Enter a version for the MCP service. +* **Endpoint**: Enter the path to append to the app URL. External MCP clients use the resulting endpoint to connect to the service. +* **Protocol version**: Select the MCP protocol version that connecting clients must support. +* **Requires authentication**: Select whether MCP clients must be authenticated. When authentication is required, select a microflow that authorizes incoming requests. The microflow input can only be `System.HttpRequest` and `MCPServer`, and its output must be `System.User`. + +To add tools, click **New** in the **Tools** section and select a microflow. Enter a **Name** and **Description** for the tool so external agents can determine when to use it. Optionally, provide a schema that matches the microflow input parameters. If you leave **Schema** empty, the schema gets extracted from the selected microflow. + ## Known Limitations {#limitations} * Currently, Agent Editor supports Mendix Cloud GenAI and Azure AI Foundry for text generation models and Mendix Cloud GenAI for knowledge bases. Support for other providers, such as OpenAI and Amazon Bedrock, is planned for a future release. * Support for Mac users is limited. Some functionalities might not work, such as doing a test call for Model documents. Mendix recommends using Studio Pro on Windows to use all features of Agent Editor. * MCP tool support is limited to whole-server integration. Selecting individual tools from a consumed MCP service to be added to an agent is not yet supported. That also means that the tool choice option `Tool` can only refer to a microflow tool currently. +* Published MCP services support tools only. Adding prompts is not currently supported. * If a document referenced by an Agent document is excluded, Studio Pro shows a consistency error. These consistency errors may not be resolved automatically when you include the excluded document again. Resolve this by synchronizing the app directory (F4) or by making a small change in any agent-related document (for example, add a character to a system prompt and remove it again). * The extension creates a `/agenteditor` log folder in the app directory. This folder is not excluded from version control automatically when you include the module from Marketplace. Add this folder to `.gitignore` manually, as described in the [First-time setup](#setup) section. * Streaming and user permissions for tools and knowledge bases can be configured, but these settings are not reflected in the playground in Studio Pro. They are applied at runtime when calling an agent defined in Studio Pro. diff --git a/content/en/docs/genai/v2/reference-guide/mcp-modules/mcp-server.md b/content/en/docs/genai/v2/reference-guide/mcp-modules/mcp-server.md index 43f563ab018..d80788b3523 100644 --- a/content/en/docs/genai/v2/reference-guide/mcp-modules/mcp-server.md +++ b/content/en/docs/genai/v2/reference-guide/mcp-modules/mcp-server.md @@ -19,6 +19,10 @@ The [MCP Server](https://marketplace.mendix.com/link/component/240380) module pr To use function calling within the same Mendix application and integrating to an LLM, consider [function calling](/agents/function-calling/). +{{% alert color="info" %}} +Agent Editor provides a simplified Studio Pro configuration experience for publishing MCP services. This configuration uses the MCP Server module to expose tools to external MCP clients. For more information, see [Configuring Published MCP Service](/agents/agents-kit-2/reference-guide/agent-editor/#published-mcp-service). +{{% /alert %}} + ### Limitations {#limitations} The current version has the following limitations: From f45f83e17af4a3c5c581d54cec85c47be58cf09f Mon Sep 17 00:00:00 2001 From: Liam Sommer Date: Thu, 27 Aug 2026 12:19:46 +0200 Subject: [PATCH 2/4] removed description field --- content/en/docs/genai/v2/reference-guide/agent-editor.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/en/docs/genai/v2/reference-guide/agent-editor.md b/content/en/docs/genai/v2/reference-guide/agent-editor.md index 5bfe176b2d5..7672f812af0 100644 --- a/content/en/docs/genai/v2/reference-guide/agent-editor.md +++ b/content/en/docs/genai/v2/reference-guide/agent-editor.md @@ -287,7 +287,6 @@ To create a published MCP service, right-click the module or folder where you wa In the published MCP service document, configure the following fields: * **Name**: Enter the name of the MCP service. -* **Description**: Describe the MCP service so MCP clients can identify its purpose. * **Version** (optional): Enter a version for the MCP service. * **Endpoint**: Enter the path to append to the app URL. External MCP clients use the resulting endpoint to connect to the service. * **Protocol version**: Select the MCP protocol version that connecting clients must support. From 92cc421c6da65cd8266e3a6338c4d79691efb028 Mon Sep 17 00:00:00 2001 From: Tina Engel Date: Fri, 28 Aug 2026 08:07:07 +0200 Subject: [PATCH 3/4] additions for published MCP service document in agent editor --- .../genai/v2/reference-guide/agent-editor.md | 27 +++++++++++-------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/content/en/docs/genai/v2/reference-guide/agent-editor.md b/content/en/docs/genai/v2/reference-guide/agent-editor.md index 7672f812af0..90403ad003d 100644 --- a/content/en/docs/genai/v2/reference-guide/agent-editor.md +++ b/content/en/docs/genai/v2/reference-guide/agent-editor.md @@ -71,7 +71,7 @@ Depending on the LLM and Knowledge bases used in your setup, you need to install * [Mendix Cloud GenAI Connector](https://marketplace.mendix.com/link/component/239449) for Mendix Cloud GenAI resources (text generation and knowledge bases) * [OpenAI Connector](https://marketplace.mendix.com/link/component/220472) for Azure AI Foundry resources (text generation model deployments supporting chat completions) -If you configure [published MCP services](#published-mcp-service), install the [MCP Server](https://marketplace.mendix.com/link/component/240380) module. +If you configure [Published MCP services](#published-mcp-service), install the [MCP Server](https://marketplace.mendix.com/link/component/240380) module. In addition, ensure the following widgets are available in your app: @@ -278,21 +278,26 @@ To change any agentic logic, update the Agent documents (and related documents) Use version control to view and restore previous agent versions. This lets you inspect earlier committed states of the Agent document and related documents, compare changes over time, and restore configurations as needed. -## Configuring Published MCP Service {#published-mcp-service} +## Configuring Published MCP Services {#published-mcp-service} -You can publish MCP services from Agent Editor to expose tools from your app to external agents and other MCP clients. This configuration uses the [MCP Server module](/agents/agents-kit-2/reference-guide/mcp-modules/mcp-server/). For detailed information about securing an MCP server, see the MCP Server module documentation. +You can publish an MCP server from Agent Editor to expose tools from your app to external agents and other MCP clients. This configuration uses the [MCP Server module](/agents/agents-kit-2/reference-guide/mcp-modules/mcp-server/). For detailed information about securing an MCP server, see the MCP Server module documentation. -To create a published MCP service, right-click the module or folder where you want to create the document in the **App Explorer**, then select **Add other** > **Published MCP Service**. +To create a published MCP service, right-click the module or folder where you want to create the document in the **App Explorer**, then select **Add other** > **Published MCP service**. -In the published MCP service document, configure the following fields: +In the published MCP service document, configure the following inputs:: * **Name**: Enter the name of the MCP service. -* **Version** (optional): Enter a version for the MCP service. -* **Endpoint**: Enter the path to append to the app URL. External MCP clients use the resulting endpoint to connect to the service. -* **Protocol version**: Select the MCP protocol version that connecting clients must support. -* **Requires authentication**: Select whether MCP clients must be authenticated. When authentication is required, select a microflow that authorizes incoming requests. The microflow input can only be `System.HttpRequest` and `MCPServer`, and its output must be `System.User`. - -To add tools, click **New** in the **Tools** section and select a microflow. Enter a **Name** and **Description** for the tool so external agents can determine when to use it. Optionally, provide a schema that matches the microflow input parameters. If you leave **Schema** empty, the schema gets extracted from the selected microflow. +* **Version**: Enter a version for the MCP service in semantic versoning format. This defaults to `1.0.0`. +* **Endpoint**: Enter the path to append to the app URL. External MCP clients use the resulting endpoint to connect to the service. Endpoint path may only contain lowercase letters, numbers, hyphens, underscores, and forward slashes. +* **Protocol version**: Select the MCP protocol version that connecting clients must support. This defaults to `v2025_03_26`. +* **Requires authentication**: Select whether MCP clients must be authenticated. It is recommended to setup authentication if the Mendix application is reachable outside of your local environment. If set to "No", the MCP service will be accessible by anyone without authentication. When authentication is required, select a microflow that authenticates incoming requests. The microflow input can only be `System.HttpRequest` and/or `MCPServer.MCcperver`, and it's output must be `System.User`. Return empty if authentication failed. + +To add tools, click **New** in the **Tools** section and configure the following inputs: +* **Microflow**: Input parameters can only be primitives and/or `MCPServer.Tool`. Return type must be a String or `MCPServer.TextContent`. +* **Name**: The name of the tool needs to be unique within the same server. Tool name may only contain ASCII letters, numbers, underscores, hyphens, and dots. +* **Description**: A description of the tool so external agents can determine when to use it. +* **Title**: Optionally, provide a human-readable **Title** of the tool for display purpose. +* **Schema**: Optionally provide a schema that matches the microflow input parameters. If you leave the schema empty, it gets extracted the microflow's input parameters and all parameters will be set as required. ## Known Limitations {#limitations} From 05514dc4b8cef387f15b0b66234364f4f0697397 Mon Sep 17 00:00:00 2001 From: Tina Engel Date: Fri, 28 Aug 2026 08:12:30 +0200 Subject: [PATCH 4/4] small fix --- content/en/docs/genai/v2/reference-guide/agent-editor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/genai/v2/reference-guide/agent-editor.md b/content/en/docs/genai/v2/reference-guide/agent-editor.md index 90403ad003d..21cd280b8ac 100644 --- a/content/en/docs/genai/v2/reference-guide/agent-editor.md +++ b/content/en/docs/genai/v2/reference-guide/agent-editor.md @@ -294,7 +294,7 @@ In the published MCP service document, configure the following inputs:: To add tools, click **New** in the **Tools** section and configure the following inputs: * **Microflow**: Input parameters can only be primitives and/or `MCPServer.Tool`. Return type must be a String or `MCPServer.TextContent`. -* **Name**: The name of the tool needs to be unique within the same server. Tool name may only contain ASCII letters, numbers, underscores, hyphens, and dots. +* **Name**: The name of the tool needs to be unique within the same published MCP service. Tool name may only contain ASCII letters, numbers, underscores, hyphens, and dots. * **Description**: A description of the tool so external agents can determine when to use it. * **Title**: Optionally, provide a human-readable **Title** of the tool for display purpose. * **Schema**: Optionally provide a schema that matches the microflow input parameters. If you leave the schema empty, it gets extracted the microflow's input parameters and all parameters will be set as required.