Stages Documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
261:mcpserver [2026/04/15 10:21] – Policnik, Florian261:mcpserver [2026/05/07 10:33] (current) – Policnik, Florian
Line 4: Line 4:
  
 Through our MCP server, AI systems can access process data managed in Stages for various purposes and use cases. Through our MCP server, AI systems can access process data managed in Stages for various purposes and use cases.
 +
 +In the currently provided MCP solution Stages provides access to a **single workspace only**. In future versions of MCP support this limitation is going to be eliminated.
  
 ===== How it works ===== ===== How it works =====
  
-The Stages MCP server uses the [[261:collector_data_rest_api|Stages Collector Data API]]. Data that should be provided via MCP can be precisely defined and precalculated. The MCP server then connects the AI systems with the collected data. The MCP server adds context by providing the AI systems with domain-specific instructions.+The Stages MCP server uses the [[261:collector_data_rest_api|Stages Collector Data API]]. Data that should be provided via MCP need to be provided by one or multiple Stages Collector jobs. The MCP server then provides the AI-systems with the collected data.
  
 ===== How to get started ===== ===== How to get started =====
Line 17: Line 19:
 ==== Installation ===== ==== Installation =====
  
-  * In Stages go to Administration -> Jobs and create a job for MCP (e.g. "mcp") 
-  * Upload the ''mcp.js'' file to MCP job 
-  * Run the job once 
-  * Specify a cron expression to keep the data updated 
   * Stop Stages   * Stop Stages
-  * Activate [[261:api-tokens|API tokens in Stages]] and restart Stages+  * Activate [[261:api-tokens|API tokens in Stages]]
   * Add ''mcp-server.properties'' to the Stages conf folder   * Add ''mcp-server.properties'' to the Stages conf folder
   * Choose the right WAR file:   * Choose the right WAR file:
Line 29: Line 27:
     * Extract the WAR file to ''stages/tomcat/webapps/mcp''. Ensue that the folders ''META-INF'' and ''WEB-INF'' are directly in the ''mcp'' folder     * Extract the WAR file to ''stages/tomcat/webapps/mcp''. Ensue that the folders ''META-INF'' and ''WEB-INF'' are directly in the ''mcp'' folder
   * Start Stages   * Start Stages
 +  * Go to the Company workspace and add the workspace variable ''mcpDefaultWorkspace''. Set the value to the ID of the workspace that you want to access.
 +  * In Stages go to Administration -> Jobs and create a job for MCP (e.g. "mcp")
 +  * Upload the ''mcp.js'' file to MCP job
 +  * Run the job once
 +  * Specify a cron expression to keep the data updated
  
-If Stages is running, you can check the path "/mcp/status" on your Stages server to see if the MCP server is running. For example: ''<nowiki>https://stages.example.com/mcp/status</nowiki>''+If Stages is running, you can check the path ''/mcp/status'' on your Stages server to see if the MCP server is running. For example: ''<nowiki>https://stages.example.com/mcp/status</nowiki>''
  
 ==== Configure credentials ===== ==== Configure credentials =====
Line 40: Line 43:
   * Permission according to the data collector (e.g. Process Read)   * Permission according to the data collector (e.g. Process Read)
  
-The API token that was created must be provided to the MCP server via the header ''StagesToken''.+
  
 ==== Configure AI system ===== ==== Configure AI system =====
 +
 +Currently Stages MCP server supports Server-Sent Events (SSE) protocol. The endpoint is ''/mcp/sse'', e.g.:
 +
 +''<nowiki>https://stages.example.com/mcp/sse</nowiki>''
 +
 +The API token that was created must be provided to the MCP server via the header ''StagesToken''.
 +
  
 An example MCP configuration: An example MCP configuration: