Repository navigation
Rewrite the readme for users and move protocol details to docs - #48
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>
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
The readme now describes the toolkit from the user's side: what you can do with it, how to get started, how to build a server, how to use progress, cancel and questions to the user in a tool VI, and how to set up and send an access token. Wire-level detail (JSON-RPC, SSE, headers, check order) moves to a new
docs/technical-details.md, which also introduces MCP. Screenshots of the three examples are included.Depends on #47: the access section describes the local-address check from that pull request, so this branch is based on
access-control-local-ipand targets it. GitHub retargets it tomainwhen #47 merges.Changes
readme.md(rewritten): what you can do · quick start (Simple example + Claude Desktop) · how a VI becomes a tool, with the Simple example's diagram and tool VI · building your own server and the palette VIs · inputs/outputs, title and annotations, errors · prompts and resources · progress and cancel · asking the user · connecting clients · who can connect: generating a token (PowerShell), wiring it intoStart.vi, sending it from Claude Desktop (mcp-remote --header) and Claude Code · examples with front panels and diagrams · troubleshooting.docs/technical-details.md(new): MCP roles and object kinds, a session sequence diagram, transport and methods, protocol versions, schema/data types/name rules/results, the elicitation round trip, progress streaming and cancellation, access checks in order, curl examples.docs/images/*.png(new, 7 files): block diagrams and front panels of the Simple, Datalogger and Full Featured examples, rendered with LabVIEW's Print.VI To HTML from this checkout.CLAUDE.md: thedocs/row mentions the two new items.Verified
Start.vi,Add Tool.vi,Add Prompt.vi,Add Resource (File).vi,Report Progress.vi,Cancel Requested.vi,Confirm With User.vi,Ask User.vi).<LabVIEW>\examples\MCP Server\examples\...) was checked against the installed packages in LabVIEW 2020 and 2026.docs/is in the package's exclusions, so neither file nor the images are installed.Not verified
mcp-remote ... --allow-http --header "Authorization:${AUTH_HEADER}") followsmcp-remote's documentation; it was not run against a server with a token.docs/technical-details.mdwas not opened on GitHub; only the readme was.Known rough edges
main, so this one has no checks until it is retargeted.🤖 Generated with Claude Code