QPR ProcessAnalyzer as MCP Server - Revision history

MarHink: /* Example: Using MCP Inspector */

2026-04-09T14:21:36Z

Example: Using MCP Inspector

← Older revision		Revision as of 14:21, 9 April 2026
Line 103:		Line 103:
	*** Open Auth Settings		*** Open Auth Settings
	*** Click "Quick OAuth Flow"-button.		*** Click "Quick OAuth Flow"-button.
	**** If authentication has been configured correctly, a successful authentication message should be shown.		**** Perform OAuth authorization using the built-in OAuth provider.
			**** Provided that the authentication has been configured correctly, a successful authentication message should be shown.
	** Click Connect.		** Click Connect.
	* List and Call Tools: Once connected, you can list the available tools and call them. For example, to call a tool created for a parameterless QPR ProcessAnalyzer script having id 216, the client would send a JSON-RPC request like the one below:		* List and Call Tools: Once connected, you can list the available tools and call them. For example, to call a tool created for a parameterless QPR ProcessAnalyzer script having id 216, the client would send a JSON-RPC request like the one below:

MarHink: /* Connecting as an MCP Client */

2026-04-09T14:05:35Z

Connecting as an MCP Client

← Older revision		Revision as of 14:05, 9 April 2026
Line 88:		Line 88:
	* '''Type''': http.		* '''Type''': http.
	* '''Headers''': Clients must include the following headers in their requests:		* '''Headers''': Clients must include the following headers in their requests:
	** '''X-Mcp-Api-Key''': Used when authenticating with API key. The API key that is defined in the [[PA_Configuration_database_table#MCP_Server_Settings\|McpServerConfiguration]] setting in the ~~PA_Configuration~~ database table.		** '''X-Mcp-Api-Key''': Used when authenticating with API key. The API key that is defined in the [[PA_Configuration_database_table#MCP_Server_Settings\|McpServerConfiguration]] setting in the PA_CONFIGURATION database table.
	* '''Client ID''': Used when authenticating with OAuth 2.0. If the AcceptedAudiences value in the [[PA_Configuration_database_table#MCP_Server_Settings\|BuiltInOAuthServerConfiguration]] setting in the ~~PA_Configuration~~ database table is something else than null, the client ID has to match it. If the AcceptedAudiences value is null, the client ID must be created with [https://datatracker.ietf.org/doc/html/rfc7591 Dynamic Client Registration Protocol (DCR)]. This is often automatically done by MCP Client software.		* '''Client ID''': Used when authenticating with OAuth 2.0. If the AcceptedAudiences value in the [[PA_Configuration_database_table#MCP_Server_Settings\|BuiltInOAuthServerConfiguration]] setting in the PA_CONFIGURATION database table is something else than null, the client ID has to match it. If the AcceptedAudiences value is null, the client ID must be created with [https://datatracker.ietf.org/doc/html/rfc7591 Dynamic Client Registration Protocol (DCR)]. This is often automatically done by MCP Client software.

	=== Example: Using MCP Inspector ===		=== Example: Using MCP Inspector ===
	MCP Inspector is a standard client that can be used to test the connection and interact with the MCP tools.		MCP Inspector is a standard client that can be used to test the connection and interact with the MCP tools.

	Connect to Server: In MCP Inspector, provide the server's MCP endpoint URL (e.g., ~~http~~://your-pa-server/qprpa/api/mcp) ~~and select streamable-http~~ as the transport type.~~<br>~~		* Connect to Server:
	Authenticate: ~~Configure the necessary~~ authentication ~~header (e.g.~~, X-Mcp-Api-Key).~~<br>~~		** In MCP Inspector, provide the server's MCP endpoint URL (e.g., https://your-pa-server/qprpa/api/mcp)
	List and Call Tools: Once connected, you can list the available tools and call them. For example, to call a tool ~~named GetCurrentTime~~, the client would send a JSON-RPC request like the one below:		** Select Streamable HTTP as the transport type.
			** Select "Via Proxy" as connection type.
			* Authenticate:
			** If using API Key-based authentication, configure "X-Mcp-Api-Key" as additional custom header with the value specified in the [[PA_Configuration_database_table#MCP_Server_Settings\|McpServerConfiguration]] setting of the PA server.
			** If using OAuth, set one of the accepted audience values to Authentication/OAuth 2.0 Flow/Client ID (or leave it empty if DCR is enabled).
			*** Open Auth Settings
			*** Click "Quick OAuth Flow"-button.
			**** If authentication has been configured correctly, a successful authentication message should be shown.
			** Click Connect.
			* List and Call Tools: Once connected, you can list the available tools and call them. For example, to call a tool created for a parameterless QPR ProcessAnalyzer script having id 216, the client would send a JSON-RPC request like the one below:
	<pre>		<pre>
	{		{
	"method": "tools/call",		"method": "tools/call",
	"params": {		"params": {
	"name": "~~GetCurrentTime~~",		"name": "Script-216",
	"arguments": {},		"arguments": {},
	"_meta": {		"_meta": {
	"progressToken": 2		"progressToken": 0
	}		}
	},		}
	~~"jsonrpc": "2.0",~~
	~~"id": 2~~
	}		}

	</pre>		</pre>

	[[Category: QPR ProcessAnalyzer]]		[[Category: QPR ProcessAnalyzer]]
	[[Category: MCP]]		[[Category: MCP]]

MarHink: /* Connecting as an MCP Client */

2026-04-09T13:39:34Z

Connecting as an MCP Client

← Older revision		Revision as of 13:39, 9 April 2026
Line 89:		Line 89:
	* '''Headers''': Clients must include the following headers in their requests:		* '''Headers''': Clients must include the following headers in their requests:
	** '''X-Mcp-Api-Key''': Used when authenticating with API key. The API key that is defined in the [[PA_Configuration_database_table#MCP_Server_Settings\|McpServerConfiguration]] setting in the PA_Configuration database table.		** '''X-Mcp-Api-Key''': Used when authenticating with API key. The API key that is defined in the [[PA_Configuration_database_table#MCP_Server_Settings\|McpServerConfiguration]] setting in the PA_Configuration database table.
	** '''Client ID''': Used when authenticating with OAuth 2.0. If the AcceptedAudiences value in the [[PA_Configuration_database_table#MCP_Server_Settings\|BuiltInOAuthServerConfiguration]] setting in the PA_Configuration database table is something else than null, the client ID has to match it. If the AcceptedAudiences value is null, the client ID must be created with [https://datatracker.ietf.org/doc/html/rfc7591 Dynamic Client Registration Protocol (DCR)].		* '''Client ID''': Used when authenticating with OAuth 2.0. If the AcceptedAudiences value in the [[PA_Configuration_database_table#MCP_Server_Settings\|BuiltInOAuthServerConfiguration]] setting in the PA_Configuration database table is something else than null, the client ID has to match it. If the AcceptedAudiences value is null, the client ID must be created with [https://datatracker.ietf.org/doc/html/rfc7591 Dynamic Client Registration Protocol (DCR)]. This is often automatically done by MCP Client software.

	=== Example: Using MCP Inspector ===		=== Example: Using MCP Inspector ===

MarHink: /* OAuth 2.0 Authentication */

2026-04-09T12:13:58Z

OAuth 2.0 Authentication

← Older revision		Revision as of 12:13, 9 April 2026
Line 17:		Line 17:
	=== 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:		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 '''McpApiKey''' value in the [[PA_Configuration_database_table#MCP_Server_Settings\|McpServerConfiguration]] setting in the ~~PA_Configuration~~ database table as '''null'''.		* Set the '''McpApiKey''' value in the [[PA_Configuration_database_table#MCP_Server_Settings\|McpServerConfiguration]] setting in the PA_CONFIGURATION database table as '''null'''.
	* 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.		* 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.

MarHink: /* Authentication Methods */

2026-04-09T12:13:17Z

Authentication Methods

← Older revision		Revision as of 12:13, 9 April 2026
Line 18:		Line 18:
	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:		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 '''McpApiKey''' value in the [[PA_Configuration_database_table#MCP_Server_Settings\|McpServerConfiguration]] setting in the PA_Configuration database table as '''null'''.		* Set the '''McpApiKey''' value in the [[PA_Configuration_database_table#MCP_Server_Settings\|McpServerConfiguration]] setting in the PA_Configuration database table as '''null'''.
	* 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.		* 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.

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

TeeHiet: TK-63184

2026-04-09T11:18:46Z

TK-63184

← Older revision		Revision as of 11:18, 9 April 2026
Line 111:		Line 111:
	}		}
	</pre>		</pre>

			[[Category: QPR ProcessAnalyzer]]
			[[Category: MCP]]

TeeHiet: TK-63184

2026-04-09T11:17:54Z

TK-63184

← Older revision		Revision as of 11:17, 9 April 2026
Line 94:		Line 94:
	MCP Inspector is a standard client that can be used to test the connection and interact with the MCP tools.		MCP Inspector is a standard client that can be used to test the connection and interact with the MCP tools.

	Connect to Server: In MCP Inspector, provide the server's MCP endpoint URL (e.g., http://your-pa-server/qprpa/api/mcp) and select streamable-http as the transport type.		Connect to Server: In MCP Inspector, provide the server's MCP endpoint URL (e.g., http://your-pa-server/qprpa/api/mcp) and select streamable-http as the transport type.<br>
	Authenticate: Configure the necessary authentication header (e.g., X-Mcp-Api-Key).		Authenticate: Configure the necessary authentication header (e.g., X-Mcp-Api-Key).<br>
	List and Call Tools: Once connected, you can list the available tools and call them. For example, to call a tool named GetCurrentTime, the client would send a JSON-RPC request like the one below:		List and Call Tools: Once connected, you can list the available tools and call them. For example, to call a tool named GetCurrentTime, the client would send a JSON-RPC request like the one below:
	<pre>		<pre>

TeeHiet: TK-63184

2026-04-09T11:17:20Z

TK-63184

← Older revision		Revision as of 11:17, 9 April 2026
Line 94:		Line 94:
	MCP Inspector is a standard client that can be used to test the connection and interact with the MCP tools.		MCP Inspector is a standard client that can be used to test the connection and interact with the MCP tools.

	Connect to Server: In MCP Inspector, provide the server's MCP endpoint URL (e.g., http://~~localhost:5000~~/qprpa/api/mcp) and select streamable-http as the transport type.		Connect to Server: In MCP Inspector, provide the server's MCP endpoint URL (e.g., http://your-pa-server/qprpa/api/mcp) and select streamable-http as the transport type.
	Authenticate: Configure the necessary authentication header (e.g., X-Mcp-Api-Key).		Authenticate: Configure the necessary authentication header (e.g., X-Mcp-Api-Key).
	List and Call Tools: Once connected, you can list the available tools and call them. For example, to call a tool named GetCurrentTime, the client would send a JSON-RPC request like the one below:		List and Call Tools: Once connected, you can list the available tools and call them. For example, to call a tool named GetCurrentTime, the client would send a JSON-RPC request like the one below:

TeeHiet: TK-63184

2026-04-09T11:15:10Z

TK-63184

← Older revision		Revision as of 11:15, 9 April 2026
Line 80:		Line 80:
	# For the script to be used as an MCP tool, give it a name. This name is then used as the MCP tool name. It is important to ensure that every script intended for MCP use has a non-empty, valid name, as clients may fail to discover tools with invalid names.		# For the script to be used as an MCP tool, give it a name. This name is then used as the MCP tool name. It is important to ensure that every script intended for MCP use has a non-empty, valid name, as clients may fail to discover tools with invalid names.
	# Open the properties of the script.		# Open the properties of the script.
	# Switch to the MCP tab and select the '''MCP ~~Tool~~''' checkbox.		# Switch to the '''MCP''' tab and select the '''MCP tool''' checkbox.
	# Switch to the Description tab and provide a description. The description is added to the context of the client.		# Switch to the '''Description''' tab and provide a description. The description is added to the context of the client.

	== Connecting as an MCP Client ==		== Connecting as an MCP Client ==

TeeHiet: TK-63184

2026-04-09T11:14:14Z

TK-63184

← Older revision		Revision as of 11:14, 9 April 2026
Line 69:		Line 69:
	=== Oauth 2.0 and API Key Authentication ===		=== Oauth 2.0 and API Key Authentication ===
	This method combines both per-user authentication and static API key authentication. To use both OAuth 2.0 and API key Authentication:		This method combines both per-user authentication and static API key authentication. To use both OAuth 2.0 and API key Authentication:
	* Set the McpApiKey value in the [[PA_Configuration_database_table#MCP_Server_Settings\|McpServerConfiguration]] setting in the PA_Configuration database table. The MCP client using API key authentication must then include this key in the X-Mcp-Api-Key header of each request.		* Set the '''McpApiKey''' value in the [[PA_Configuration_database_table#MCP_Server_Settings\|McpServerConfiguration]] setting in the PA_Configuration database table. The MCP client using API key authentication 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.		* 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.
	* 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.		* 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.