Skip to content

Document Model Context Protocol (MCP) support#108

Merged
martin-fleck-at merged 3 commits into
masterfrom
issue-1673-mcp-protocol-docs
Jun 3, 2026
Merged

Document Model Context Protocol (MCP) support#108
martin-fleck-at merged 3 commits into
masterfrom
issue-1673-mcp-protocol-docs

Conversation

@martin-fleck-at
Copy link
Copy Markdown
Contributor

@martin-fleck-at martin-fleck-at commented Jun 2, 2026

  • Add an MCP documentation section covering enablement, architecture,
    tool-platform integration, and security, linking to the server-mcp docs
  • Include a high-level MCP architecture diagram (SVG)
  • Document the experimental mcpServer opt-in on InitializeParameters and
    the announced server URL on InitializeResult
  • Add the generic export pipeline (RequestExportAction/ExportResultAction
    with PNG support) and deprecate the SVG-only export actions
  • Add the OriginViewportAction and MoveViewportAction viewport actions
  • Add GetEditorContextAction/EditorContextResult and note server-to-client
    requests

Also: Sync protocol documentation with current GLSP client protocol

  • Replace the RequestExportSvgAction code block that wrongly showed the
    ExportSvgAction body and kind
  • Correct ChangeContainerOperation to extend Operation with a Point location
  • Type RejectAction.detail as string and RequestModelAction.options as Args
  • Renumber the duplicate 2.11.4 navigation action headings
  • Fix the SeverityLevel typo, the ActionMessage action field, and broken
    details/summary tags
  • Add fields that landed since the doc was written: RequestAction.timeout,
    Operation.args, EditorContext viewport/canvasBounds, ComputedBoundsAction
    layout/canvas/viewport, GLSPClient.onCurrentStateChanged, ghostElement
  • Note shutdownServer returns a promise-or-void and the protocol version
    is 1.0.0
  • Define the referenced LayoutData, ElementAndLayoutData and
    ExportSvgOptions types

Fixes #1673

- Replace the RequestExportSvgAction code block that wrongly showed the
  ExportSvgAction body and kind
- Correct ChangeContainerOperation to extend Operation with a Point location
- Type RejectAction.detail as string and RequestModelAction.options as Args
- Renumber the duplicate 2.11.4 navigation action headings
- Fix the SeverityLevel typo, the ActionMessage action field, and broken
  details/summary tags
- Add fields that landed since the doc was written: RequestAction.timeout,
  Operation.args, EditorContext viewport/canvasBounds, ComputedBoundsAction
  layout/canvas/viewport, GLSPClient.onCurrentStateChanged, ghostElement
- Note shutdownServer returns a promise-or-void and the protocol version
  is 1.0.0
- Define the referenced LayoutData, ElementAndLayoutData and
  ExportSvgOptions types

Relates to #1673
@tortmayr tortmayr closed this Jun 2, 2026
@tortmayr tortmayr reopened this Jun 2, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 2, 2026

🌐 Website preview: Removed (PR closed).

- Add an MCP documentation section covering enablement, architecture,
  tool-platform integration, and security, link to the server-mcp docs
- Include a high-level MCP architecture diagram (SVG)
- Document the experimental mcpServer opt-in on InitializeParameters
  and the announced server URL on InitializeResult
- Add the generic export pipeline with PNG support and deprecate the
  SVG-only export actions
- Add the OriginViewportAction and MoveViewportAction viewport actions
- Add GetEditorContextAction/EditorContextResult

Fixes eclipse-glsp/glsp#1673
@martin-fleck-at martin-fleck-at force-pushed the issue-1673-mcp-protocol-docs branch from b90724a to ada436d Compare June 3, 2026 07:50
@martin-fleck-at martin-fleck-at requested a review from tortmayr June 3, 2026 07:52
Copy link
Copy Markdown
Contributor

@tortmayr tortmayr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the thorough update.
Overall the doc changes look good to me.
I just have some minor comments inline

Comment thread content/documentation/mcp/content.md Outdated

In practice this lets an assistant answer questions about a diagram, suggest improvements, create or adjust elements from a natural-language request, or check the model for problems, all while the diagram stays open in the GLSP editor.

<small>*Experimental: MCP support is under active development and its configuration may still change. It is currently available for the [Node GLSP server](https://github.com/eclipse-glsp/glsp-server-node) only, with [Java server support](https://github.com/eclipse-glsp/glsp/issues/1672) planned.*</small>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the java server support really planned.
Right now its out of scope for u as default GLSP Team.
We are only doing it if we have a customer or other sponsor backing it, right?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right, we should not over-promise here.

Comment thread content/documentation/mcp/content.md Outdated

### Enabling MCP

MCP is opt-in and off by default.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This only covers the frontend side and makes it look like mcp servers are shipped by default and all an adopter as to do is to adapt the initialze message.

It misses that necessary integration of the dedicated mcp-server package in their backend.

I think this should be mentioned here.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general the how to integrate for the server side missing, ind is arguably the more important part 😉

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very true, in my mind I was only focussed on the client-side but obviously the server actually requires more focus, haha! Will fix it!


</details>

#### 2.8.4. Editor Context
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is currently grouped under client side actions which is missleading because its first and foremost a server side action.
Client can just query the editor context directly

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! I'll fix it!

- Replace the Java-server note with a Node-only statement, without a
  speculative roadmap
- Restructure Enabling MCP into a server step and a client step, each with
  a short code sample
- Describe what the server and session modules configure and that they
  bind into different scopes
- Document the mcpServer setup as a client-server handshake over initialize
  on the protocol page
- Move GetEditorContext out of the client-side actions into its own
  server-initiated section
- Correct the security note so only the default-on Host-header check is
  claimed, with Origin checking noted as off by default

Relates to eclipse-glsp/glsp#1673
@martin-fleck-at
Copy link
Copy Markdown
Contributor Author

@tortmayr I pushed an update that hopefully addresses your concerns!

@tortmayr tortmayr self-requested a review June 3, 2026 10:09
Copy link
Copy Markdown
Contributor

@tortmayr tortmayr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Changes look good to me 👍🏼

@martin-fleck-at martin-fleck-at merged commit c6063a6 into master Jun 3, 2026
2 checks passed
@martin-fleck-at martin-fleck-at deleted the issue-1673-mcp-protocol-docs branch June 3, 2026 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Protocol Documentation for Model Context Protocol (MCP) on Website

2 participants