Repository navigation
Rewrite the readme for users and move protocol details to docs - #49
Merged
Merged
Conversation
The readme mixed a short MCP primer with wire-level detail: JSON-RPC, Server-Sent Events, header names, the order of the access checks. It did not say how to build a server, where the token comes from or how to use progress and cancel in a tool VI. The readme now explains, from the user's side, what the toolkit can do, a quick start with the Simple example and Claude Desktop, how a VI becomes a tool, the palette VIs, prompts and resources, progress and cancel, asking the user, connecting clients, and who can connect: how to generate an access token, where to wire it and how Claude Desktop and Claude Code send it. It shows the block diagrams and front panels of the three examples (docs/images, rendered from the examples with Print.VI To HTML) and adds a troubleshooting list. The example path now matches the installed package (<LabVIEW>\examples\MCP Server\examples). docs/technical-details.md carries the rest: an MCP introduction with a sequence diagram, the transport and methods, both protocol eras, the schema and name rules, results, the elicitation round trip, progress streaming and cancellation, the access checks and curl examples. docs is excluded from the package, so neither file is installed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Tests✅ All 64 tests passed. Per-test results
Protocol tests✅ Protocol tester output (0 failed required checks)VI diff reportNo VI, VIM or CTL files changed in this pull request. Report for commit 55bfbb4. The installable test package is under Artifacts of this run once the build job has finished. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings the readme rewrite to
main. #48 was merged at 19:42, twenty minutes after #47, but its base was stillaccess-control-local-ip, so commit55bfbb4landed on that branch and not onmain. This pull request carries the same single commit; nothing changed in it.Changes
The same as #48:
readme.md(rewritten for users),docs/technical-details.md(new: MCP introduction and wire-level detail),docs/images/*.png(7 example screenshots),CLAUDE.md(docs/row).Verified
See #48: connector-pane names read from the VIs in LabVIEW 2026 64-bit, example install path checked in LabVIEW 2020 and 2026, the readme checked on GitHub (images, anchors, Mermaid).
Not verified
As in #48: the Claude Desktop token config was not run against a server with a token, and
docs/technical-details.mdwas not opened on GitHub.🤖 Generated with Claude Code