Skip to content

Rewrite the readme for users and move protocol details to docs - #48

Merged
JanGoebel merged 1 commit into
access-control-local-ipfrom
readme-user-guide
Oct 30, 2026
Merged

JanGoebel merged 1 commit into
access-control-local-ipfrom
readme-user-guide

Conversation

@JanGoebel

@JanGoebel JanGoebel commented Oct 30, 2026 •

Copy link
Copy Markdown
Owner

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-ip and targets it. GitHub retargets it to main when #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 into Start.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: the docs/ row mentions the two new items.

Verified

  • Every input, output and default named in the readme was read from the VIs' connector panes in LabVIEW 2026 64-bit (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).
  • The example install path (<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.
  • The readme on GitHub (branch view): all 7 images load, every in-page anchor resolves, the Mermaid diagram renders.

Not verified

  • The Claude Desktop token config (mcp-remote ... --allow-http --header "Authorization:${AUTH_HEADER}") follows mcp-remote's documentation; it was not run against a server with a token.
  • Not checked how Claude Desktop or Claude Code display progress, or which clients support asking the user; the readme says "clients that support it".
  • docs/technical-details.md was not opened on GitHub; only the readme was.

Known rough edges

  • The front panels were printed with the examples stopped, so the graphs are empty. Screenshots of running examples, or of a chat, would show more.
  • The CI workflow runs only for pull requests into main, so this one has no checks until it is retargeted.

🤖 Generated with Claude Code

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>
@JanGoebel
JanGoebel merged commit 7d3327c into access-control-local-ip Oct 30, 2026
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.

2 participants