Skip to content

Update the guides and the MCP server docs for the 2.0.0 release - #4713

Merged
marcschier merged 3 commits into
masterfrom
docs/update-guides-for-2.0.0
Oct 9, 2026
Merged

marcschier merged 3 commits into
masterfrom
docs/update-guides-for-2.0.0

Conversation

@marcschier

Copy link
Copy Markdown
Collaborator

Description

The packages on nuget.org are stable 2.0.0 now. The guides still told readers to use --prerelease and preview-only versions, and kept caveats that applied only to 2.0.0-preview.5 and earlier previews.

Getting started, Your first information model, and Source-generated data types:

  • Add the packages without --prerelease and name 2.0.0 as the verified version.
  • With 2.0.0, a client with no server reports BadNotConnected, so the troubleshooting row drops the preview.5 SocketException.
  • 2.0.0 generates code for methods that declare their arguments inline, so the tutorial drops the preview.5 workaround note and its troubleshooting row, and says both forms are possible.

MCP server (docs/McpServer.md and the tool's NuGet README tools/Opc.Ua.Mcp/McpREADME.md):

  • Install and run commands use the stable tool: dotnet tool exec OPCFoundation.NetStandard.Opc.Ua.Mcp, dnx …, and dotnet tool install --global …, without --prerelease or 2.0.0-preview.*.
  • The stable tool bundles Opc.Ua.Mcp.Robotics and Opc.Ua.Mcp.Vision, so the note that vision and vision,robotics need the current source is removed. The docs now state that only the standalone Mcp.Robotics and Mcp.Vision libraries are preview packages (2.0.0-preview.200).
  • Not changed: tools/Opc.Ua.Mcp/.mcp/server.json still declares "version": "1.0.0" and lists only the original profiles in its description.

Validation

Command Result
Getting started Route B, the first-model tutorial, and every troubleshooting row, run exactly as documented against the 2.0.0 packages Output matches the guides; 0 warnings
Native AOT publish of the Route B server and client 0 warnings; the native executables completed the trust flow and connected
dotnet tool exec OPCFoundation.NetStandard.Opc.Ua.Mcp -- --version, dnx OPCFoundation.NetStandard.Opc.Ua.Mcp -- --version, dotnet tool exec "OPCFoundation.NetStandard.Opc.Ua.Mcp@2.0.*" -- --version 2.0.0+bc5da1006… for each
dotnet tool install of OPCFoundation.NetStandard.Opc.Ua.Mcp without --prerelease (into a temporary tool path) Installs 2.0.0
dotnet tool exec of an uncached version with stdin redirected, as an MCP client launches it Runs without a confirmation prompt
MCP stdio initialize + tools/list against the 2.0.0 tool with --profile vision,robotics, vision, robotics, full 64, 26, 42, and 138 tools
Markdown link, anchor, contents, and fence checks over docs/ 0 issues

Related Issues

Checklist

  • I have signed the CLA and read the CONTRIBUTING doc.
  • I have added tests that prove my fix is effective or that my feature works and increased code coverage.
  • I have added all necessary documentation.
  • I have verified that my changes do not introduce (new) build or analyzer warnings.
  • I ran all tests locally using the UA.slnx solution against at least .net framework and .net 10, and all passed.
  • I fixed all failing and flaky tests in the CI pipelines and all CodeQL warnings.
  • I have addressed all PR feedback received.

marcschier and others added 2 commits October 9, 2026 10:01
The packages on nuget.org are stable 2.0.0 now, so the guides no longer
need `--prerelease`, and their preview.5 caveats no longer apply:

- Getting started, Your first information model, and Source-generated
  data types add the packages without `--prerelease` and name 2.0.0 as
  the verified version.
- With 2.0.0, a client with no server reports BadNotConnected, so the
  troubleshooting row drops the preview.5 SocketException.
- 2.0.0 generates code for methods that declare their arguments inline,
  so the tutorial drops the preview.5 workaround note and its
  troubleshooting row, and says both forms are possible.

Route B, the tutorial, and every troubleshooting row were rerun exactly
as documented against the 2.0.0 packages, with matching output and zero
warnings; the Native AOT publish of the Route B applications also
produced no warnings, and the native executables connected.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
OPCFoundation.NetStandard.Opc.Ua.Mcp 2.0.0 is on nuget.org, so the install
commands no longer need --prerelease or a 2.0.0-preview.* version. The
stable tool bundles Opc.Ua.Mcp.Robotics and Opc.Ua.Mcp.Vision, so the note
that vision and vision,robotics need the current source is obsolete. Only
the standalone Mcp.Robotics and Mcp.Vision libraries remain preview
packages (2.0.0-preview.200).

Updated docs/McpServer.md (install options, on-demand client
configuration, package status) and the tool's NuGet README
(tools/Opc.Ua.Mcp/McpREADME.md).

Verified against the published 2.0.0 tool (built from release/2.0 at
bc5da10): "dotnet tool exec OPCFoundation.NetStandard.Opc.Ua.Mcp",
"dnx OPCFoundation.NetStandard.Opc.Ua.Mcp", the "@2.0.*" form, and
"dotnet tool install" without --prerelease all resolve 2.0.0; an uncached
non-interactive "dotnet tool exec" runs without a prompt; tools/list over
MCP stdio returns 64 tools for --profile vision,robotics, 26 for vision,
42 for robotics and 138 for full.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@marcschier
marcschier marked this pull request as ready for review October 9, 2026 11:08
Copilot AI balanced review requested due to automatic review settings October 9, 2026 11:08

Copilot AI left a comment

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.

🟢 Approval recommended

The documentation consistently reflects the verified stable package and tool behavior.

0 open findings

What changed in this PR

Updates user guides and MCP documentation for the stable 2.0.0 release.

Changes:

  • Removes prerelease package flags and preview-version guidance.
  • Documents stable MCP tooling and bundled Vision/Robotics profiles.
  • Removes obsolete preview-specific troubleshooting and workarounds.
File Description
docs/​GettingStarted.md Updates package commands and troubleshooting for 2.0.0.
docs/​FirstModel.md Updates source-generation guidance for stable behavior.
docs/​SourceGeneratedDataTypes.md Removes the prerelease installation flag.
docs/​McpServer.md Documents stable tool installation and package status.
tools/​Opc.Ua.Mcp/​McpREADME.md Updates NuGet tool usage and profile availability.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

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.

3 participants