QPR ProcessAnalyzer as MCP Server - Revision history

Ollvihe: /* OAuth 2.0 Authentication */

2026-05-12T13:08:28Z

OAuth 2.0 Authentication

← Older revision		Revision as of 13:08, 12 May 2026
Line 15:		Line 15:

	=== OAuth 2.0 Authentication ===		=== OAuth 2.0 Authentication ===
	This method provides per-user authentication, allowing each MCP request to be authenticated against a specific QPR ProcessAnalyzer user. This is the recommended authentication method for MCP. To use OAuth 2.0 Authentication, set the [[PA_Configuration_database_table#~~MCP_Server_Settings~~\|BuiltInOAuthServerConfiguration]] value in the PA_CONFIGURATION database table with at least an '''AcceptedAudiences''' value other than the default.		This method provides per-user authentication, allowing each MCP request to be authenticated against a specific QPR ProcessAnalyzer user. This is the recommended authentication method for MCP. To use OAuth 2.0 Authentication, set the [[PA_Configuration_database_table#:~:text=BuiltInOAuthServerConfiguration\|BuiltInOAuthServerConfiguration]] value in the PA_CONFIGURATION database table with at least an '''AcceptedAudiences''' value other than the default.

	==== Setting up IIS to support OpenId Connect Discovery ====		==== Setting up IIS to support OpenId Connect Discovery ====

Ollvihe: /* Configuring MCP Server */

2026-04-28T08:47:44Z

Configuring MCP Server

← Older revision		Revision as of 08:47, 28 April 2026
Line 1:		Line 1:
	QPR ProcessAnalyzer can act as a Model Context Protocol (MCP) server, allowing external tools and applications to interact with its analysis capabilities through script-based tools.		QPR ProcessAnalyzer can act as a Model Context Protocol (MCP) server, allowing external tools and applications to interact with its analysis capabilities through script-based tools.

	== Configuring MCP Server ==		== Configuring MCP Server Overview ==
	The Model Context Protocol (MCP) is a standard for communication between modeling tools. By acting as an MCP server, QPR ProcessAnalyzer exposes its functionalities, which are implemented as [[Managing_Scripts\|scripts]], to any MCP-compliant client. This enables a wide range of integrations and automation possibilities.		The Model Context Protocol (MCP) is a standard for communication between modeling tools. By acting as an MCP server, QPR ProcessAnalyzer exposes its functionalities, which are implemented as [[Managing_Scripts\|scripts]], to any MCP-compliant client. This enables a wide range of integrations and automation possibilities.

Ollvihe: /* Configuring the MCP Server */

2026-04-28T08:47:16Z

Configuring the MCP Server

← Older revision		Revision as of 08:47, 28 April 2026
Line 1:		Line 1:
	QPR ProcessAnalyzer can act as a Model Context Protocol (MCP) server, allowing external tools and applications to interact with its analysis capabilities through script-based tools.		QPR ProcessAnalyzer can act as a Model Context Protocol (MCP) server, allowing external tools and applications to interact with its analysis capabilities through script-based tools.

	== Configuring ~~the~~ MCP Server ==		== Configuring MCP Server ==
	The Model Context Protocol (MCP) is a standard for communication between modeling tools. By acting as an MCP server, QPR ProcessAnalyzer exposes its functionalities, which are implemented as [[Managing_Scripts\|scripts]], to any MCP-compliant client. This enables a wide range of integrations and automation possibilities.		The Model Context Protocol (MCP) is a standard for communication between modeling tools. By acting as an MCP server, QPR ProcessAnalyzer exposes its functionalities, which are implemented as [[Managing_Scripts\|scripts]], to any MCP-compliant client. This enables a wide range of integrations and automation possibilities.

Ollvihe at 08:47, 28 April 2026

2026-04-28T08:47:09Z

← Older revision		Revision as of 08:47, 28 April 2026
Line 1:		Line 1:
	QPR ProcessAnalyzer can act as a Model Context Protocol (MCP) server, allowing external tools and applications to interact with its analysis capabilities through script-based tools.		QPR ProcessAnalyzer can act as a Model Context Protocol (MCP) server, allowing external tools and applications to interact with its analysis capabilities through script-based tools.

	== ~~Overview of~~ MCP Server ~~Functionality~~ ==		== Configuring the MCP Server ==
	The Model Context Protocol (MCP) is a standard for communication between modeling tools. By acting as an MCP server, QPR ProcessAnalyzer exposes its functionalities, which are implemented as [[Managing_Scripts\|scripts]], to any MCP-compliant client. This enables a wide range of integrations and automation possibilities.		The Model Context Protocol (MCP) is a standard for communication between modeling tools. By acting as an MCP server, QPR ProcessAnalyzer exposes its functionalities, which are implemented as [[Managing_Scripts\|scripts]], to any MCP-compliant client. This enables a wide range of integrations and automation possibilities.

Line 9:		Line 9:
	* Standardized Communication: Uses the MCP standard for interoperability with clients like MCP Inspector and Visual Studio Code.		* Standardized Communication: Uses the MCP standard for interoperability with clients like MCP Inspector and Visual Studio Code.

	~~== Configuring the MCP Server ==~~
	To enable and configure the MCP server functionality in QPR ProcessAnalyzer, a system administrator needs to adjust the McpServerConfiguration setting in the [[PA_Configuration_database_table\|PA Configuration Database Table]].		To enable and configure the MCP server functionality in QPR ProcessAnalyzer, a system administrator needs to adjust the McpServerConfiguration setting in the [[PA_Configuration_database_table\|PA Configuration Database Table]].

Ollvihe: /* Testing MCP tools in QPR ProcessAnalyzer */

2026-04-28T08:46:10Z

Testing MCP tools in QPR ProcessAnalyzer

@@ Line 65: / Line 65: @@
 * Set the '''McpApiKey''' value in the [[PA_Configuration_database_table#MCP_Server_Settings|McpServerConfiguration]] setting in the PA_Configuration database table. The MCP client must then include this key in the '''X-Mcp-Api-Key''' header of each request.
 * Create a user named "MCP Client" in QPR ProcessAnalyzer. All the MCP server operations are performed in the context of "MCP Client" user, i.e. the user can't see or modify anything the "MCP Client" user can't see or modify in any other way.
 == Testing MCP Client Connection ==

Ollvihe: /* Creating MCP Tools */

2026-04-28T08:45:56Z

Creating MCP Tools

@@ Line 66: / Line 66: @@
 * Create a user named "MCP Client" in QPR ProcessAnalyzer. All the MCP server operations are performed in the context of "MCP Client" user, i.e. the user can't see or modify anything the "MCP Client" user can't see or modify in any other way.
 == Testing MCP tools in QPR ProcessAnalyzer ==
 When developing MCP tools, it might be useful try test them in QPR ProcessAnalyzer before publishing as MCP tools. Scripts (used as MCP tools) can be called in the [[Navigation_Menu#Expression_Designer|Expression Designer]]. The following example expression calls a script with some parameters and shows the return value as json:

Ollvihe: /* Connecting as an MCP Client */

2026-04-27T22:35:12Z

Connecting as an MCP Client

← Older revision		Revision as of 22:35, 27 April 2026
Line 211:		Line 211:
	</syntaxhighlight>		</syntaxhighlight>

	== ~~Connecting as an~~ MCP Client ==		== Testing MCP Client Connection ==
	MCP clients can connect to the QPR ProcessAnalyzer server to discover and execute the available tools. The endpoint and connection details are:		MCP clients can connect to the QPR ProcessAnalyzer server to discover and execute the available tools. The endpoint and connection details are:
	* '''URL''': The primary MCP endpoint is located at /api/mcp relative to the QPR ProcessAnalyzer server URL (e.g., https://your-pa-server.com/qprpa/api/mcp).		* '''URL''': The primary MCP endpoint is located at /api/mcp relative to the QPR ProcessAnalyzer server URL (e.g., https://your-pa-server.com/qprpa/api/mcp).

TeeHiet: TK-64041

2026-04-27T12:13:40Z

TK-64041

← Older revision		Revision as of 12:13, 27 April 2026
Line 190:		Line 190:
	});		});
	return ToJson(returnValue);		return ToJson(returnValue);
	</syntaxhighlight>Now, if script having id 1 has the following script source code:<syntaxhighlight lang="typescript">		</syntaxhighlight>
			Now, if script having id 1 has the following script source code:<syntaxhighlight lang="typescript">
	#{		#{
	"string": stringParameter,		"string": stringParameter,
Line 199:		Line 200:
	}		}

	</syntaxhighlight>, and is configured as specified in the previous chapter, the result of expression will be the following valid JSON object as string:<syntaxhighlight lang="json">		</syntaxhighlight>
			and is configured as specified in the previous chapter, the result of expression will be the following valid JSON object as string:<syntaxhighlight lang="json">
	{		{
	"string": "hello",		"string": "hello",

MarHink: /* Testing MCP tools in QPR ProcessAnalyzer */

2026-04-27T12:08:38Z

Testing MCP tools in QPR ProcessAnalyzer

← Older revision		Revision as of 12:08, 27 April 2026
Line 199:		Line 199:
	}		}

	</syntaxhighlight>, and is configured as specified in the previous chapter, the result of ~~the script/tool call~~ will be the following valid JSON object:<syntaxhighlight lang="json">		</syntaxhighlight>, and is configured as specified in the previous chapter, the result of expression will be the following valid JSON object as string:<syntaxhighlight lang="json">
	{		{
	"string": "hello",		"string": "hello",

MarHink: /* Testing MCP tools in QPR ProcessAnalyzer */

2026-04-27T12:06:10Z

Testing MCP tools in QPR ProcessAnalyzer

@@ Line 176: / Line 176: @@
+   }
+}
-</syntaxhighlight>Now, if script has the following script source code:<syntaxhighlight lang="typescript">
+</syntaxhighlight>
 #{
    "string": stringParameter,
@@ Line 185: / Line 199: @@
+}
-</syntaxhighlight>, and if this script is called with parameters shown in the previous chapter, the result of the tool call will be the following valid JSON object:<syntaxhighlight lang="json">
+</syntaxhighlight>, and is configured as specified in the previous chapter, the result of the script/tool call will be the following valid JSON object:<syntaxhighlight lang="json">
+{
    "string": "hello",
@@ Line 193: / Line 207: @@
    "object": {"inner": "text"}
+}
 </syntaxhighlight>