Install from npm in the README, now that there is a package to install - #23
Merged
Merged
Conversation
0.1.0 is on the registry, so level 1 no longer opens with a clone of this repository. `npx --yes @abap2ui5/mcp-server` is the command, and the checkout is named for what it is actually still needed for - working ON the server. The client-registration snippets follow: npx as the default shape, `node /path/to/server.mjs` as the alternative. Verified against the published package rather than assumed, because the bin is `abap2ui5-mcp` and the package is `@abap2ui5/mcp-server` - npx has to fall back to "this package has exactly one binary" to resolve that, and if it did not, every command in this README and the VS Code extension's fallback would be wrong. It does: the handshake returns abap2ui5 0.1.0 and lists 14 tools. The ~45 MB install, 19 MB of it the Playwright driver only run_app imports, is now stated where a reader first pays it instead of only in RELEASING.md. CHANGELOG: 0.1.0 keeps a date and loses the future tense - the paragraph under it still said nothing had been published, under the heading for the thing that was. A fresh Unreleased opens above it. npm run check is added while here - CI runs the test suite and nothing else, so that is what it is. Every repository in the ecosystem answers to that name now. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PLDFPfAK1MGq6qHeC6KKWH
#22 moved the three setup levels into the documentation page and left a Quick start here. That is the better shape and it wins the conflict wholesale; what survives from this branch is only the substance - level 1 no longer clones this repository, because npx now has a package to fetch. The three-level detail this README used to carry is in abap2UI5/docs (advanced/mcp_server), so the npm install has to be said there too. Separate repository, separate pull request.
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.
Description
@abap2ui5/mcp-server@0.1.0is on the registry, so the documentation can stop asking for a clone of this repository.npx --yes @abap2ui5/mcp-server; the checkout is named for what it is still actually needed for — working on the server. The linter clone stays, becauseAI_VIEW_CHECK_HOMEneeds it.node /path/to/server.mjsas the alternative rather than the other way round.run_appimports — is now stated where a reader first pays it, instead of only inRELEASING.md.Verified against the published package rather than assumed. The bin is
abap2ui5-mcpand the package is@abap2ui5/mcp-server, so npx has to fall back to "this package has exactly one binary" to resolve it — if it did not, every command in this README and the VS Code extension's fallback would be wrong:CHANGELOG
0.1.0gets its release date and loses the future tense — the paragraph under it still said nothing had been published, under the heading for the thing that was. A fresh## Unreleasedopens above it.npm run checkCI here runs the test suite and nothing else, so that is what it is. abap2UI5#2640 gates the rule that every repository in the ecosystem answers to
checkandtest.RELEASING.mdThe two "after a release" items are done; they stay as the checklist for the release after a rename, which is when they come back.
How to test
# pass 54 / # fail 0 / # skipped 0.Checklist
npm run checkpassesGenerated by Claude Code