@eclipse-glsp-examples/workflow-server 2.7.0-next.7 → 2.7.0-next.9

package/src/common/mcp/workflow-mcp-model-serializer.ts

@@ -0,0 +1,187 @@
+/********************************************************************************
+ * Copyright (c) 2026 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { GModelElement } from '@eclipse-glsp/graph';
+import { Dimension, DefaultTypes } from '@eclipse-glsp/server';
+import { MarkdownMcpModelSerializer, SerializedElement } from '@eclipse-glsp/server-mcp';
+import { injectable } from 'inversify';
+import { ModelTypes } from '../util/model-types';
+
+/**
+ * As compared to the {@link MarkdownMcpModelSerializer}, this is a specific implementation and we
+ * know not only the structure of our graph but also each relevant attribute. This enables us to
+ * order them semantically so the produced serialization makes more sense if read with semantics
+ * mind. As LLMs (i.e., the MCP clients) work semantically, this is superior to a random ordering.
+ * Furthermore, including only the relevant information without redundancies decreases context size.
+ */
+@injectable()
+export class WorkflowMcpModelSerializer extends MarkdownMcpModelSerializer {
+    override prepareElement(element: GModelElement): Record<string, SerializedElement[]> {
+        // Pass the live parent's id so the input element gets `parentId` set even when the
+        // spread inside `flattenStructure` doesn't carry the (typically non-enumerable) `parent`
+        // reference. Without this, `query-elements` inspect on a single leaf drops `parentId`,
+        // creating an inconsistency with `diagram-model`.
+        const elements = this.flattenStructure(element as unknown as SerializedElement, element.parent?.id);
+
+        // Define the order of keys
+        const result: Record<string, SerializedElement[]> = {
+            [DefaultTypes.GRAPH]: [],
+            [ModelTypes.CATEGORY]: [],
+            [ModelTypes.AUTOMATED_TASK]: [],
+            [ModelTypes.MANUAL_TASK]: [],
+            [ModelTypes.FORK_NODE]: [],
+            [ModelTypes.JOIN_NODE]: [],
+            [ModelTypes.DECISION_NODE]: [],
+            [ModelTypes.MERGE_NODE]: [],
+            [DefaultTypes.EDGE]: [],
+            [ModelTypes.WEIGHTED_EDGE]: []
+        };
+        elements.forEach(serialized => {
+            this.combinePositionAndSize(serialized);
+
+            const adjustedElement = this.adjustElement(serialized);
+            if (!adjustedElement) {
+                return;
+            }
+
+            const type = serialized.type;
+            if (typeof type === 'string' && result[type]) {
+                result[type].push(adjustedElement);
+            }
+        });
+
+        return result;
+    }
+
+    private adjustElement(element: SerializedElement): SerializedElement | undefined {
+        const type = element.type;
+        switch (type) {
+            case ModelTypes.AUTOMATED_TASK:
+            case ModelTypes.MANUAL_TASK: {
+                const children = Array.isArray(element.children) ? (element.children as SerializedElement[]) : [];
+                const label = children.find(child => child.type === ModelTypes.LABEL_HEADING);
+                if (!label || !Dimension.is(label.size)) {
+                    return undefined;
+                }
+
+                // For tasks, the only content with impact on element size is the label
+                // Therefore, all other factors get integrated into the label size for the AI to do proper resizing operations
+                const labelSize = {
+                    // 10px padding right, 31px padding left (incl. icon)
+                    width: Math.trunc(label.size.width + 10 + 31),
+                    // 7px padding top and bottom each
+                    height: Math.trunc(label.size.height + 14)
+                };
+
+                // If the task lives inside a `STRUCTURE` (a layout-only wrapper), report the
+                // structure's parent as the logical parent. Falls back to the direct `parentId`
+                // when the task is at the root or the structure has no parent.
+                const liveParent = (element as { parent?: GModelElement }).parent;
+                const parentId = liveParent?.type === ModelTypes.STRUCTURE ? liveParent.parent?.id ?? element.parentId : element.parentId;
+                return {
+                    id: element.id,
+                    type,
+                    position: element.position,
+                    size: element.size,
+                    bounds: element.bounds,
+                    label: label.text,
+                    labelSize,
+                    parentId
+                };
+            }
+            case ModelTypes.CATEGORY: {
+                const children = Array.isArray(element.children) ? (element.children as SerializedElement[]) : [];
+                const header = children.find(child => child.type === ModelTypes.COMP_HEADER);
+                const headerChildren = header && Array.isArray(header.children) ? (header.children as SerializedElement[]) : [];
+                const label = headerChildren.find(child => child.type === ModelTypes.LABEL_HEADING);
+                if (!label || !Dimension.is(label.size)) {
+                    return undefined;
+                }
+
+                const labelSize = {
+                    width: Math.trunc(label.size.width + 20),
+                    height: Math.trunc(label.size.height + 20)
+                };
+
+                // `combinePositionAndSize` (in MarkdownMcpModelSerializer) omits `size`/`bounds`
+                // when an element has no explicit geometry yet, so the LLM doesn't try to "fix"
+                // placeholder bounds. Categories normally do have an explicit size in the model,
+                // but if a freshly created (or otherwise unsized) category lands here, skip the
+                // derived `usableSpaceSize` rather than crashing on `element.size.width`.
+                const usableSpaceSize = Dimension.is(element.size)
+                    ? {
+                          width: Math.trunc(Math.max(0, element.size.width - 10)),
+                          height: Math.trunc(Math.max(0, element.size.height - labelSize.height - 10))
+                      }
+                    : undefined;
+
+                return {
+                    id: element.id,
+                    type,
+                    isContainer: true,
+                    position: element.position,
+                    size: element.size,
+                    bounds: element.bounds,
+                    label: label.text,
+                    labelSize,
+                    usableSpaceSize,
+                    parentId: element.parentId
+                };
+            }
+            case ModelTypes.JOIN_NODE:
+            case ModelTypes.MERGE_NODE:
+            case ModelTypes.DECISION_NODE:
+            case ModelTypes.FORK_NODE: {
+                return {
+                    id: element.id,
+                    type,
+                    position: element.position,
+                    size: element.size,
+                    bounds: element.bounds,
+                    parentId: element.parentId
+                };
+            }
+            case DefaultTypes.EDGE: {
+                return {
+                    id: element.id,
+                    type,
+                    sourceId: element.sourceId,
+                    targetId: element.targetId,
+                    parentId: element.parentId
+                };
+            }
+            case ModelTypes.WEIGHTED_EDGE: {
+                return {
+                    id: element.id,
+                    type,
+                    sourceId: element.sourceId,
+                    targetId: element.targetId,
+                    probability: element.probability,
+                    parentId: element.parentId
+                };
+            }
+            case DefaultTypes.GRAPH: {
+                return {
+                    id: element.id,
+                    type,
+                    isContainer: true
+                };
+            }
+            default:
+                return undefined;
+        }
+    }
+}

package/src/common/mcp/workflow-mcp-module.ts

@@ -0,0 +1,54 @@
+/********************************************************************************
+ * Copyright (c) 2026 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { BindingTarget } from '@eclipse-glsp/server';
+import {
+    DefaultMcpDiagramModule,
+    DefaultMcpServerModule,
+    ElementTypesProvider,
+    McpLabelProvider,
+    McpModelSerializer
+} from '@eclipse-glsp/server-mcp';
+import { WorkflowElementTypesProvider } from './workflow-element-types-provider';
+import { WorkflowMcpLabelProvider } from './workflow-mcp-label-provider';
+import { WorkflowMcpModelSerializer } from './workflow-mcp-model-serializer';
+
+/**
+ * Workflow-specific server-scope MCP module. Currently no server-scope customizations beyond
+ * the defaults — every diagram-type-specific override lives on {@link WorkflowMcpDiagramModule}.
+ * Kept as the named entry point and as a hook for future server-scope extensions.
+ */
+export class WorkflowMcpServerModule extends DefaultMcpServerModule {}
+
+/**
+ * Workflow-specific diagram-scope MCP module — swaps in the workflow-aware
+ * {@link McpLabelProvider}, {@link McpModelSerializer}, and {@link ElementTypesProvider}.
+ * `LayoutMcpToolHandler` ships in the default tool set and self-skips when no `LayoutEngine`
+ * is bound, so workflow doesn't need to add it explicitly.
+ */
+export class WorkflowMcpDiagramModule extends DefaultMcpDiagramModule {
+    protected override bindLabelProvider(): BindingTarget<McpLabelProvider> {
+        return WorkflowMcpLabelProvider;
+    }
+
+    protected override bindModelSerializer(): BindingTarget<McpModelSerializer> {
+        return WorkflowMcpModelSerializer;
+    }
+
+    protected override bindElementTypesProvider(): BindingTarget<ElementTypesProvider> {
+        return WorkflowElementTypesProvider;
+    }
+}

package/src/common/workflow-diagram-module.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022-2023 STMicroelectronics and others.
+ * Copyright (c) 2022-2026 STMicroelectronics and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -21,7 +21,7 @@ import {
     ContextMenuItemProvider,
     DiagramConfiguration,
     EdgeCreationChecker,
-    GLSPServer,
+    GLSPServerInitializer,
     GModelDiagramModule,
     InstanceMultiBinding,
     LabelEditValidator,
@@ -57,13 +57,13 @@ import { TaskEditContextActionProvider } from './taskedit/task-edit-context-prov
 import { TaskEditValidator } from './taskedit/task-edit-validator';
 import { WorkflowDiagramConfiguration } from './workflow-diagram-configuration';
 import { WorkflowEdgeCreationChecker } from './workflow-edge-creation-checker';
-import { WorkflowGLSPServer } from './workflow-glsp-server';
+import { CustomArgsInitContribution } from './workflow-glsp-server';
 import { WorkflowPopupFactory } from './workflow-popup-factory';
 
 @injectable()
 export class WorkflowServerModule extends ServerModule {
-    protected override bindGLSPServer(): BindingTarget<GLSPServer> {
-        return WorkflowGLSPServer;
+    protected override configureGLSPServerInitializers(binding: MultiBinding<GLSPServerInitializer>): void {
+        binding.add(CustomArgsInitContribution);
     }
 }
 

package/src/common/workflow-glsp-server.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022-2023 STMicroelectronics and others.
+ * Copyright (c) 2022-2026 STMicroelectronics and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -13,25 +13,32 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Args, ArgsUtil, DefaultGLSPServer, InitializeResult, Logger, MaybePromise } from '@eclipse-glsp/server';
+import {
+    ArgsUtil,
+    GLSPServer,
+    GLSPServerInitializer,
+    InitializeParameters,
+    InitializeResult,
+    Logger,
+    MaybePromise
+} from '@eclipse-glsp/server';
 import { inject, injectable } from 'inversify';
 
 @injectable()
-export class WorkflowGLSPServer extends DefaultGLSPServer {
+export class CustomArgsInitContribution implements GLSPServerInitializer {
     MESSAGE_KEY = 'message';
     TIMESTAMP_KEY = 'timestamp';
 
-    @inject(Logger)
-    protected override logger: Logger;
+    @inject(Logger) protected logger: Logger;
 
-    protected override handleInitializeArgs(result: InitializeResult, args: Args | undefined): MaybePromise<InitializeResult> {
-        if (!args) {
+    initializeServer(server: GLSPServer, params: InitializeParameters, result: InitializeResult): MaybePromise<InitializeResult> {
+        if (!params.args) {
             return result;
         }
-        const timestamp = ArgsUtil.get(args, this.TIMESTAMP_KEY);
-        const message = ArgsUtil.get(args, this.MESSAGE_KEY);
+        const timestamp = ArgsUtil.get(params.args, this.TIMESTAMP_KEY);
+        const message = ArgsUtil.get(params.args, this.MESSAGE_KEY);
 
-        this.logger.debug(`${timestamp}: ${message}`);
+        this.logger.info(`${timestamp}: ${message}`);
         return result;
     }
 }

package/src/node/app.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022-2024 STMicroelectronics and others.
+ * Copyright (c) 2022-2026 STMicroelectronics and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -15,11 +15,12 @@
  ********************************************************************************/
 import 'reflect-metadata';
 
-import { configureELKLayoutModule } from '@eclipse-glsp/layout-elk';
-import { createAppModule, GModelStorage, Logger, SocketServerLauncher, WebSocketServerLauncher } from '@eclipse-glsp/server/node';
+import { ElkLayoutModule } from '@eclipse-glsp/layout-elk';
+import { GModelStorage, Logger, SocketServerLauncher, WebSocketServerLauncher, createAppModule } from '@eclipse-glsp/server/node';
 import { Container } from 'inversify';
 
 import { WorkflowLayoutConfigurator } from '../common/layout/workflow-layout-configurator';
+import { WorkflowMcpDiagramModule, WorkflowMcpServerModule } from '../common/mcp/workflow-mcp-module';
 import { WorkflowDiagramModule, WorkflowServerModule } from '../common/workflow-diagram-module';
 import { createWorkflowCliParser } from './workflow-cli-parser';
 
@@ -38,16 +39,19 @@ async function launch(argv?: string[]): Promise<void> {
         logger.error('Uncaught exception:', error);
     });
 
-    const elkLayoutModule = configureELKLayoutModule({ algorithms: ['layered'], layoutConfigurator: WorkflowLayoutConfigurator });
-    const serverModule = new WorkflowServerModule().configureDiagramModule(new WorkflowDiagramModule(() => GModelStorage), elkLayoutModule);
-
+    const serverModule = new WorkflowServerModule().configureDiagramModule(
+        new WorkflowDiagramModule(() => GModelStorage),
+        new ElkLayoutModule({ algorithms: ['layered'], layoutConfigurator: WorkflowLayoutConfigurator }),
+        new WorkflowMcpDiagramModule()
+    );
+    const mcpServerModule = new WorkflowMcpServerModule();
     if (options.webSocket) {
         const launcher = appContainer.resolve(WebSocketServerLauncher);
-        launcher.configure(serverModule);
+        launcher.configure(serverModule, mcpServerModule);
         await launcher.start({ port: options.port, host: options.host, path: 'workflow' });
     } else {
         const launcher = appContainer.resolve(SocketServerLauncher);
-        launcher.configure(serverModule);
+        launcher.configure(serverModule, mcpServerModule);
         await launcher.start({ port: options.port, host: options.host });
     }
 }